Resource URL: /platform/<<version=3>>/sync/settings/advanced

    Overview: This resource represents the global settings for SyncIQ.

     Methods: GET, PUT

********************************************************************************

Method GET: Retrieve the global SyncIQ settings.

       URL: GET /platform/<<version=3>>/sync/settings/advanced

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "description": "These are advanced settings for SyncIQ, they are for Isilon Support use only.", 
          "properties": {
            "max_wperpolicy": {
              "minimum": -1, 
              "type": "integer", 
              "description": "Max total number of workers for a single policy across all nodes. Ignored for clusters small enough that the policy's workers-per-node dominates.", 
              "maximum": 2147483647
            }, 
            "max_concurrent_jobs": {
              "minimum": 1, 
              "type": "integer", 
              "description": "The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.", 
              "maximum": 99
            }, 
            "bwt": {
              "type": "object", 
              "description": "Settings for bandwidth throttle.", 
              "properties": {
                "max_workers_per_node": {
                  "minimum": -1, 
                  "type": "integer", 
                  "description": "Sets the max workers allowed per node. Set to -1 to have SyncIQ determine the value automatically.", 
                  "maximum": 2147483647
                }, 
                "max_workers_per_cluster": {
                  "minimum": -1, 
                  "type": "integer", 
                  "description": "Sets the max workers allowed per cluster. Set to -1 to have SyncIQ determine the value automatically.", 
                  "maximum": 2147483647
                }, 
                "set_workers_per_node": {
                  "minimum": -1, 
                  "type": "integer", 
                  "description": "Override calculations and force this many workers per node. Set to -1 to disable. This is still bound by max_workers_per_node.", 
                  "maximum": 2147483647
                }, 
                "workers_per_node_per_job": {
                  "minimum": -1, 
                  "type": "integer", 
                  "description": "Set the number of workers per node for each job.", 
                  "maximum": 2147483647
                }, 
                "workers_per_cpu": {
                  "minimum": -1, 
                  "type": "integer", 
                  "description": "Set the maximum workers per CPU.", 
                  "maximum": 99
                }
              }
            }, 
            "skip_work_host": {
              "type": "boolean", 
              "description": "Set to True to disable worker pools. This setting should not be changed without first consulting Isilon Support."
            }
          }
        }
      }
    }
  ]
}

********************************************************************************

Method PUT: Modify the global SyncIQ settings.  All input fields are optional,
            but one or more must be supplied.

       URL: PUT /platform/<<version=3>>/sync/settings/advanced

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "These are advanced settings for SyncIQ, they are for Isilon Support use only.", 
  "properties": {
    "max_wperpolicy": {
      "minimum": -1, 
      "type": "integer", 
      "description": "Max total number of workers for a single policy across all nodes. Ignored for clusters small enough that the policy's workers-per-node dominates.", 
      "maximum": 2147483647
    }, 
    "max_concurrent_jobs": {
      "minimum": 1, 
      "type": "integer", 
      "description": "The max concurrent jobs that SyncIQ can support. This number is based on the size of the current cluster and the current SyncIQ worker throttle rule.", 
      "maximum": 99
    }, 
    "bwt": {
      "type": "object", 
      "description": "Settings for bandwidth throttle.", 
      "properties": {
        "max_workers_per_node": {
          "minimum": -1, 
          "type": "integer", 
          "description": "Sets the max workers allowed per node. Set to -1 to have SyncIQ determine the value automatically.", 
          "maximum": 2147483647
        }, 
        "max_workers_per_cluster": {
          "minimum": -1, 
          "type": "integer", 
          "description": "Sets the max workers allowed per cluster. Set to -1 to have SyncIQ determine the value automatically.", 
          "maximum": 2147483647
        }, 
        "set_workers_per_node": {
          "minimum": -1, 
          "type": "integer", 
          "description": "Override calculations and force this many workers per node. Set to -1 to disable. This is still bound by max_workers_per_node.", 
          "maximum": 2147483647
        }, 
        "workers_per_node_per_job": {
          "minimum": -1, 
          "type": "integer", 
          "description": "Set the number of workers per node for each job.", 
          "maximum": 2147483647
        }, 
        "workers_per_cpu": {
          "minimum": -1, 
          "type": "integer", 
          "description": "Set the maximum workers per CPU.", 
          "maximum": 99
        }
      }
    }, 
    "skip_work_host": {
      "type": "boolean", 
      "description": "Set to True to disable worker pools. This setting should not be changed without first consulting Isilon Support."
    }
  }
}

There is no JSON response body for this method.
