Resource URL: /platform/<<version=1>>/sync/settings

    Overview: This resource represents the global settings for SyncIQ.

     Methods: GET, PUT

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

Method GET: Retrieve the global SyncIQ settings.

       URL: GET /platform/<<version=1>>/sync/settings

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"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "settings": {
          "type": "object", 
          "description": "Global SyncIQ settings.", 
          "properties": {
            "report_email": {
              "description": "Email sync reports to these addresses.", 
              "minItems": 0, 
              "items": {
                "minLength": 0, 
                "type": "string", 
                "maxLength": 255
              }, 
              "required": true, 
              "maxItems": 18446744073709551615, 
              "uniqueItems": true, 
              "type": "array"
            }, 
            "service": {
              "enum": [
                "on", 
                "off", 
                "paused"
              ], 
              "type": "string", 
              "description": "Specifies if the SyncIQ service currently on, paused, or off.  If paused, all sync jobs will be paused.  If turned off, all jobs will be canceled.", 
              "required": true
            }, 
            "source_network": {
              "required": true, 
              "type": [
                "object", 
                "null"
              ], 
              "description": "Restricts replication policies on the local cluster to running on the specified subnet and pool.", 
              "properties": {
                "subnet": {
                  "required": true, 
                  "type": "string", 
                  "description": "The subnet to restrict replication policies to."
                }, 
                "pool": {
                  "required": true, 
                  "type": "string", 
                  "description": "The pool to restrict replication policies to."
                }
              }
            }, 
            "burst_memory_constraint": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "The per-worker burst socket memory constraint, in bytes.", 
              "maximum": 18446744073709551615
            }, 
            "burst_socket_buffer_size": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "The per-worker burst socket buffer coalesced data, in bytes.", 
              "maximum": 18446744073709551615
            }, 
            "restrict_target_network": {
              "required": true, 
              "type": "boolean", 
              "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation.  If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone.  If you specify false, replication policies are not restricted to specific nodes on the target cluster."
            }, 
            "force_interface": {
              "required": true, 
              "type": "boolean", 
              "description": "NOTE: This field should not be changed without the help of Isilon support.  Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation.  Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet."
            }, 
            "tw_chkpt_interval": {
              "minimum": 0, 
              "type": "integer", 
              "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint.", 
              "required": false
            }, 
            "report_max_count": {
              "required": true, 
              "minimum": 1, 
              "type": "integer", 
              "description": "The default maximum number of reports to retain for a policy.", 
              "maximum": 2000
            }, 
            "report_max_age": {
              "required": true, 
              "minimum": 0, 
              "type": "integer", 
              "description": "The default length of time (in seconds) a policy report will be stored.", 
              "maximum": 18446744073709551615
            }
          }
        }
      }
    }
  ]
}

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

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

       URL: PUT /platform/<<version=1>>/sync/settings

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Global SyncIQ settings.", 
  "properties": {
    "report_email": {
      "description": "Email sync reports to these addresses.", 
      "minItems": 0, 
      "items": {
        "minLength": 0, 
        "type": "string", 
        "maxLength": 255
      }, 
      "maxItems": 18446744073709551615, 
      "uniqueItems": true, 
      "type": "array"
    }, 
    "service": {
      "enum": [
        "on", 
        "off", 
        "paused"
      ], 
      "type": "string", 
      "description": "Specifies if the SyncIQ service currently on, paused, or off.  If paused, all sync jobs will be paused.  If turned off, all jobs will be canceled."
    }, 
    "source_network": {
      "type": [
        "object", 
        "null"
      ], 
      "description": "Restricts replication policies on the local cluster to running on the specified subnet and pool.", 
      "properties": {
        "subnet": {
          "required": true, 
          "type": "string", 
          "description": "The subnet to restrict replication policies to."
        }, 
        "pool": {
          "required": true, 
          "type": "string", 
          "description": "The pool to restrict replication policies to."
        }
      }
    }, 
    "burst_memory_constraint": {
      "minimum": 0, 
      "type": "integer", 
      "description": "The per-worker burst socket memory constraint, in bytes.", 
      "maximum": 18446744073709551615
    }, 
    "burst_socket_buffer_size": {
      "minimum": 0, 
      "type": "integer", 
      "description": "The per-worker burst socket buffer coalesced data, in bytes.", 
      "maximum": 18446744073709551615
    }, 
    "restrict_target_network": {
      "type": "boolean", 
      "description": "Default for the \"restrict_target_network\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation.  If you specify true, and you specify a SmartConnect zone in the \"target_host\" field, replication policies will connect only to nodes in the specified SmartConnect zone.  If you specify false, replication policies are not restricted to specific nodes on the target cluster."
    }, 
    "force_interface": {
      "type": "boolean", 
      "description": "NOTE: This field should not be changed without the help of Isilon support.  Default for the \"force_interface\" property that will be applied to each new sync policy unless otherwise specified at the time of policy creation.  Determines whether data is sent only through the subnet and pool specified in the \"source_network\" field. This option can be useful if there are multiple interfaces for the given source subnet."
    }, 
    "tw_chkpt_interval": {
      "minimum": 0, 
      "type": "integer", 
      "description": "The interval (in seconds) in which treewalk syncs are forced to checkpoint."
    }, 
    "report_max_count": {
      "minimum": 1, 
      "type": "integer", 
      "description": "The default maximum number of reports to retain for a policy.", 
      "maximum": 2000
    }, 
    "report_max_age": {
      "minimum": 0, 
      "type": "integer", 
      "description": "The default length of time (in seconds) a policy report will be stored.", 
      "maximum": 18446744073709551615
    }
  }
}

There is no JSON response body for this method.
