Resource URL: /platform/<<version=3>>/sync/policies

    Overview: This resource applies the standard collection pattern to OneFS
              SyncIQ policies.

     Methods: GET, POST, DELETE

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

Method GET: List all SyncIQ policies.

       URL: GET /platform/<<version=3>>/sync/policies

Query arguments:
  sort=<string> The field that will be used for sorting.
   scope=<enum> Where <enum> is one of user, default, effective.  If specified
                as "effective" or not specified, all fields are returned.  If
                specified as "user", only fields with non-default values are
                shown.  If specified as "default", the original values are
                returned.
limit=<integer> Return no more than this many results at once (see resume).
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.
resume=<string> Continue returning results from previous call using this token
                (token should come from the previous call, resume cannot be
                used with other options).

GET response body schema:
{
  "type": "object", 
  "properties": {
    "total": {
      "type": "integer", 
      "description": "Total number of items available."
    }, 
    "policies": {
      "items": {
        "type": "object", 
        "properties": {
          "next_run": {
            "type": [
              "integer", 
              "null"
            ], 
            "description": "This is the next time a job is scheduled to run for this policy in Unix epoch seconds.  This field is null if the job is not scheduled."
          }, 
          "disable_stf": {
            "type": "boolean", 
            "description": "NOTE: This field should not be changed without the help of Isilon support.  Enable/disable the 6.5+ STF based data transfer and uses only treewalk."
          }, 
          "source_root_path": {
            "required": true, 
            "type": "string", 
            "description": "The root directory on the source cluster the files will be synced from.  Modifying this field will result in a full synchronization of all data."
          }, 
          "changelist": {
            "type": "boolean", 
            "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation."
          }, 
          "snapshot_sync_pattern": {
            "type": "string", 
            "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\")."
          }, 
          "disable_fofb": {
            "type": "boolean", 
            "description": "NOTE: This field should not be changed without the help of Isilon support.  Enable/disable sync failover/failback."
          }, 
          "restrict_target_network": {
            "type": "boolean", 
            "description": "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."
          }, 
          "disable_file_split": {
            "type": "boolean", 
            "description": "NOTE: This field should not be changed without the help of Isilon support.  If true, the 7.2+ file splitting capability will be disabled."
          }, 
          "last_success": {
            "minimum": 0, 
            "type": [
              "integer", 
              "null"
            ], 
            "description": "Timestamp of last known successfully completed synchronization.  Value is null if the policy has never completed successfully.", 
            "required": true
          }, 
          "id": {
            "required": true, 
            "type": "string", 
            "description": "The system ID given to this sync policy."
          }, 
          "source_snapshot_archive": {
            "type": "boolean", 
            "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync."
          }, 
          "target_host": {
            "required": true, 
            "type": "string", 
            "description": "Hostname or IP address of sync target cluster.  Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association."
          }, 
          "skip_lookup": {
            "type": "boolean", 
            "description": "Skip DNS lookup of target IPs."
          }, 
          "log_removed_files": {
            "type": "boolean", 
            "description": "If true, the system will log any files or directories that are deleted due to a sync."
          }, 
          "log_level": {
            "enum": [
              "fatal", 
              "error", 
              "notice", 
              "info", 
              "copy", 
              "debug", 
              "trace"
            ], 
            "type": "string", 
            "description": "Severity an event must reach before it is logged."
          }, 
          "job_delay": {
            "minimum": 0, 
            "type": [
              "integer", 
              "null"
            ], 
            "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds)."
          }, 
          "report_max_count": {
            "minimum": 1, 
            "type": "integer", 
            "description": "Maximum number of policy reports that will be stored on the system.", 
            "maximum": 2000
          }, 
          "priority": {
            "type": "integer", 
            "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0."
          }, 
          "force_interface": {
            "type": "boolean", 
            "description": "NOTE: This field should not be changed without the help of Isilon support.  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.  If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set."
          }, 
          "workers_per_node": {
            "minimum": 1, 
            "type": "integer", 
            "description": "The number of worker threads on a node performing a sync.", 
            "maximum": 20
          }, 
          "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."
              }
            }
          }, 
          "target_compare_initial_sync": {
            "type": "boolean", 
            "description": "If true, the target creates diffs against the original sync."
          }, 
          "accelerated_failback": {
            "type": "boolean", 
            "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations."
          }, 
          "target_snapshot_archive": {
            "type": "boolean", 
            "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions."
          }, 
          "report_max_age": {
            "minimum": 0, 
            "type": "integer", 
            "description": "Length of time (in seconds) a policy report will be stored."
          }, 
          "description": {
            "type": "string", 
            "description": "User-assigned description of this sync policy."
          }, 
          "schedule": {
            "required": true, 
            "type": "string", 
            "description": "The schedule on which new jobs will be run for this policy."
          }, 
          "skip_when_source_unmodified": {
            "type": "boolean", 
            "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed."
          }, 
          "password_set": {
            "type": "boolean", 
            "description": "Indicates if a password is set for accessing the target cluster. Password value is not shown with GET."
          }, 
          "source_snapshot_expiration": {
            "minimum": 0, 
            "type": "integer", 
            "description": "The length of time in seconds to keep snapshots on the source cluster."
          }, 
          "cloud_deep_copy": {
            "enum": [
              "deny", 
              "allow", 
              "force"
            ], 
            "type": "string", 
            "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files."
          }, 
          "has_sync_state": {
            "type": "boolean", 
            "description": "This field is false if the policy is in its initial sync state and true otherwise.  Setting this field to false will reset the policy's sync state."
          }, 
          "rpo_alert": {
            "minimum": 0, 
            "type": [
              "integer", 
              "null"
            ], 
            "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts."
          }, 
          "snapshot_sync_existing": {
            "type": "boolean", 
            "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken)."
          }, 
          "target_snapshot_alias": {
            "type": "string", 
            "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value."
          }, 
          "last_started": {
            "minimum": 0, 
            "type": [
              "integer", 
              "null"
            ], 
            "description": "The most recent time a job was started for this policy.  Value is null if the policy has never been run."
          }, 
          "target_snapshot_expiration": {
            "minimum": 0, 
            "type": "integer", 
            "description": "The length of time in seconds to keep snapshots on the target cluster."
          }, 
          "name": {
            "required": true, 
            "type": "string", 
            "description": "User-assigned name of this sync policy."
          }, 
          "expected_dataloss": {
            "type": "boolean", 
            "description": "NOTE: This field should not be changed without the help of Isilon support.  Continue sending files even with the corrupted filesystem."
          }, 
          "last_job_state": {
            "type": "string", 
            "description": "This is the state of the most recent job for this policy."
          }, 
          "check_integrity": {
            "type": "boolean", 
            "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received."
          }, 
          "enabled": {
            "required": true, 
            "type": "boolean", 
            "description": "If true, jobs will be automatically run based on this policy, according to its schedule."
          }, 
          "target_path": {
            "required": true, 
            "type": "string", 
            "description": "Absolute filesystem path on the target cluster for the sync destination."
          }, 
          "file_matching_pattern": {
            "required": false, 
            "type": "object", 
            "description": "A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties.  Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.", 
            "properties": {
              "or_criteria": {
                "items": {
                  "type": "object", 
                  "properties": {
                    "and_criteria": {
                      "items": {
                        "type": "object", 
                        "description": "An object describing one criterion for finding a matching file, for example \"size is greater than or equal to 10KB\". Note: For time types (accessed_*, birth_*, and changed_*), operator is not required (it is implicitly ==).  For the value, you can use a relative date and time, such as \"two weeks ago\", or specific date and time, such as \"January 1, 2012.\"  Time settings are based on a 24-hour clock.", 
                        "properties": {
                          "whole_word": {
                            "type": "boolean", 
                            "description": "If true, the attribute must match the entire word.  Default is true."
                          }, 
                          "value": {
                            "type": [
                              "string", 
                              "integer"
                            ], 
                            "description": "The value to compare the specified attribute of each file to."
                          }, 
                          "case_sensitive": {
                            "type": "boolean", 
                            "description": "If true, the value comparison will be case sensitive.  Default is true."
                          }, 
                          "field": {
                            "type": "string", 
                            "description": "The name of the file attribute to match on (only required if this is a custom_attribute type criterion).  Default is an empty string \"\"."
                          }, 
                          "attribute_exists": {
                            "type": "boolean", 
                            "description": "For \"custom_attribute\" type criteria.  The file will match as long as the attribute named by \"field\" exists.  Default is true."
                          }, 
                          "operator": {
                            "enum": [
                              "==", 
                              "!=", 
                              ">", 
                              ">=", 
                              "<", 
                              "<=", 
                              "!"
                            ], 
                            "type": "string", 
                            "description": "How to compare the specified attribute of each file to the specified value."
                          }, 
                          "type": {
                            "enum": [
                              "name", 
                              "path", 
                              "accessed_time", 
                              "accessed_before", 
                              "accessed_after", 
                              "birth_time", 
                              "birth_before", 
                              "birth_after", 
                              "changed_time", 
                              "changed_before", 
                              "changed_after", 
                              "size", 
                              "file_type", 
                              "posix_regex_name", 
                              "user_name", 
                              "user_id", 
                              "group_name", 
                              "group_id", 
                              "no_user", 
                              "no_group"
                            ], 
                            "type": "string", 
                            "description": "The type of this criterion, that is, which file attribute to match on.", 
                            "required": true
                          }
                        }
                      }, 
                      "type": "array", 
                      "description": "An array containing individual file criterion objects each describing one criterion.  These are logically AND'ed together to form a set of criteria."
                    }
                  }
                }, 
                "type": "array", 
                "description": "An array containing objects with \"and_criteria\" properties, each set of and_criteria will be logically OR'ed together to create the full file matching pattern."
              }
            }
          }, 
          "target_snapshot_pattern": {
            "type": "string", 
            "description": "The name pattern for snapshots taken on the target cluster after the sync completes.  A value of @DEFAULT will reset this field to the default creation value."
          }, 
          "burst_mode": {
            "type": "boolean", 
            "description": "NOTE: This field should not be changed without the help of Isilon support.  Enable/disable UDP-based data transfer."
          }, 
          "target_detect_modifications": {
            "type": "boolean", 
            "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs."
          }, 
          "action": {
            "enum": [
              "copy", 
              "sync"
            ], 
            "type": "string", 
            "description": "If 'copy', source files will be copied to the target cluster.  If 'sync', the target directory will be made an image of the source directory:  Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", 
            "required": false
          }, 
          "source_snapshot_pattern": {
            "type": "string", 
            "description": "The name pattern for snapshots taken on the source cluster before a sync."
          }, 
          "conflicted": {
            "type": "boolean", 
            "description": "NOTE: This field should not be changed without the help of Isilon support.  If true, the most recent run of this policy encountered an error and this policy will not start any more scheduled jobs until this field is manually set back to 'false'."
          }, 
          "source_include_directories": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Directories that will be included in the sync.  Modifying this field will result in a full synchronization of all data."
          }, 
          "source_exclude_directories": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "Directories that will be excluded from the sync.  Modifying this field will result in a full synchronization of all data."
          }
        }
      }, 
      "type": "array"
    }, 
    "resume": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
    }
  }
}

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

Method POST: Create a SyncIQ policy.

        URL: POST /platform/<<version=3>>/sync/policies

There are no query arguments for this method.

Required POST request body fields:
source_root_path, target_host, name, target_path, action

POST request body schema:
{
  "type": "object", 
  "properties": {
    "disable_stf": {
      "type": "boolean", 
      "description": "NOTE: This field should not be changed without the help of Isilon support.  Enable/disable the 6.5+ STF based data transfer and uses only treewalk."
    }, 
    "source_root_path": {
      "required": true, 
      "type": "string", 
      "description": "The root directory on the source cluster the files will be synced from.  Modifying this field will result in a full synchronization of all data."
    }, 
    "changelist": {
      "type": "boolean", 
      "description": "If true, retain previous source snapshot and incremental repstate, both of which are required for changelist creation."
    }, 
    "snapshot_sync_pattern": {
      "type": "string", 
      "description": "The naming pattern that a snapshot must match to trigger a sync when the schedule is when-snapshot-taken (default is \"*\")."
    }, 
    "disable_fofb": {
      "type": "boolean", 
      "description": "NOTE: This field should not be changed without the help of Isilon support.  Enable/disable sync failover/failback."
    }, 
    "restrict_target_network": {
      "type": "boolean", 
      "description": "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."
    }, 
    "disable_file_split": {
      "type": "boolean", 
      "description": "NOTE: This field should not be changed without the help of Isilon support.  If true, the 7.2+ file splitting capability will be disabled."
    }, 
    "report_max_count": {
      "minimum": 1, 
      "type": "integer", 
      "description": "Maximum number of policy reports that will be stored on the system.", 
      "maximum": 2000
    }, 
    "source_snapshot_archive": {
      "type": "boolean", 
      "description": "If true, archival snapshots of the source data will be taken on the source cluster before a sync."
    }, 
    "target_host": {
      "required": true, 
      "type": "string", 
      "description": "Hostname or IP address of sync target cluster.  Modifying the target cluster host can result in the policy being unrunnable if the new target does not match the current target association."
    }, 
    "skip_lookup": {
      "type": "boolean", 
      "description": "Skip DNS lookup of target IPs."
    }, 
    "log_removed_files": {
      "type": "boolean", 
      "description": "If true, the system will log any files or directories that are deleted due to a sync."
    }, 
    "rpo_alert": {
      "minimum": 0, 
      "type": [
        "integer", 
        "null"
      ], 
      "description": "If --schedule is set to a time/date, an alert is created if the specified RPO for this policy is exceeded. The default value is 0, which will not generate RPO alerts."
    }, 
    "log_level": {
      "enum": [
        "fatal", 
        "error", 
        "notice", 
        "info", 
        "copy", 
        "debug", 
        "trace"
      ], 
      "type": "string", 
      "description": "Severity an event must reach before it is logged."
    }, 
    "job_delay": {
      "minimum": 0, 
      "type": [
        "integer", 
        "null"
      ], 
      "description": "If --schedule is set to When-Source-Modified, the duration to wait after a modification is made before starting a job (default is 0 seconds)."
    }, 
    "priority": {
      "type": "integer", 
      "description": "Determines the priority level of a policy. Policies with higher priority will have precedence to run over lower priority policies. Valid range is [0, 1]. Default is 0."
    }, 
    "force_interface": {
      "type": "boolean", 
      "description": "NOTE: This field should not be changed without the help of Isilon support.  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.  If you enable this option, the net.inet.ip.choose_ifa_by_ipsrc sysctl should be set."
    }, 
    "workers_per_node": {
      "minimum": 1, 
      "type": "integer", 
      "description": "The number of worker threads on a node performing a sync.", 
      "maximum": 20
    }, 
    "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."
        }
      }
    }, 
    "target_compare_initial_sync": {
      "type": "boolean", 
      "description": "If true, the target creates diffs against the original sync."
    }, 
    "accelerated_failback": {
      "type": "boolean", 
      "description": "If set to true, SyncIQ will perform failback configuration tasks during the next job run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations."
    }, 
    "target_snapshot_archive": {
      "type": "boolean", 
      "description": "If true, archival snapshots of the target data will be taken on the target cluster after successful sync completions."
    }, 
    "report_max_age": {
      "minimum": 0, 
      "type": "integer", 
      "description": "Length of time (in seconds) a policy report will be stored."
    }, 
    "description": {
      "type": "string", 
      "description": "User-assigned description of this sync policy."
    }, 
    "schedule": {
      "type": "string", 
      "description": "The schedule on which new jobs will be run for this policy."
    }, 
    "skip_when_source_unmodified": {
      "type": "boolean", 
      "description": "If true and --schedule is set to a time/date, the policy will not run if no changes have been made to the contents of the source directory since the last job successfully completed."
    }, 
    "source_snapshot_expiration": {
      "minimum": 0, 
      "type": "integer", 
      "description": "The length of time in seconds to keep snapshots on the source cluster."
    }, 
    "cloud_deep_copy": {
      "enum": [
        "deny", 
        "allow", 
        "force"
      ], 
      "type": "string", 
      "description": "If set to deny, replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files."
    }, 
    "password": {
      "type": "string", 
      "description": "The password for the target cluster.  This field is not readable."
    }, 
    "snapshot_sync_existing": {
      "type": "boolean", 
      "description": "If true, snapshot-triggered syncs will include snapshots taken before policy creation time (requires --schedule when-snapshot-taken)."
    }, 
    "target_snapshot_alias": {
      "type": "string", 
      "description": "The alias of the snapshot taken on the target cluster after the sync completes. A value of @DEFAULT will reset this field to the default creation value."
    }, 
    "target_snapshot_expiration": {
      "minimum": 0, 
      "type": "integer", 
      "description": "The length of time in seconds to keep snapshots on the target cluster."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "User-assigned name of this sync policy."
    }, 
    "expected_dataloss": {
      "type": "boolean", 
      "description": "NOTE: This field should not be changed without the help of Isilon support.  Continue sending files even with the corrupted filesystem."
    }, 
    "check_integrity": {
      "type": "boolean", 
      "description": "If true, the sync target performs cyclic redundancy checks (CRC) on the data as it is received."
    }, 
    "enabled": {
      "type": "boolean", 
      "description": "If true, jobs will be automatically run based on this policy, according to its schedule."
    }, 
    "target_path": {
      "required": true, 
      "type": "string", 
      "description": "Absolute filesystem path on the target cluster for the sync destination."
    }, 
    "file_matching_pattern": {
      "required": false, 
      "type": "object", 
      "description": "A file matching pattern, organized as an OR'ed set of AND'ed file criteria, for example ((a AND b) OR (x AND y)) used to define a set of files with specific properties.  Policies of type 'sync' cannot use 'path' or time criteria in their matching patterns, but policies of type 'copy' can use all listed criteria.", 
      "properties": {
        "or_criteria": {
          "items": {
            "type": "object", 
            "properties": {
              "and_criteria": {
                "items": {
                  "type": "object", 
                  "description": "An object describing one criterion for finding a matching file, for example \"size is greater than or equal to 10KB\". Note: For time types (accessed_*, birth_*, and changed_*), operator is not required (it is implicitly ==).  For the value, you can use a relative date and time, such as \"two weeks ago\", or specific date and time, such as \"January 1, 2012.\"  Time settings are based on a 24-hour clock.", 
                  "properties": {
                    "whole_word": {
                      "type": "boolean", 
                      "description": "If true, the attribute must match the entire word.  Default is true."
                    }, 
                    "value": {
                      "type": [
                        "string", 
                        "integer"
                      ], 
                      "description": "The value to compare the specified attribute of each file to."
                    }, 
                    "case_sensitive": {
                      "type": "boolean", 
                      "description": "If true, the value comparison will be case sensitive.  Default is true."
                    }, 
                    "field": {
                      "type": "string", 
                      "description": "The name of the file attribute to match on (only required if this is a custom_attribute type criterion).  Default is an empty string \"\"."
                    }, 
                    "attribute_exists": {
                      "type": "boolean", 
                      "description": "For \"custom_attribute\" type criteria.  The file will match as long as the attribute named by \"field\" exists.  Default is true."
                    }, 
                    "operator": {
                      "enum": [
                        "==", 
                        "!=", 
                        ">", 
                        ">=", 
                        "<", 
                        "<=", 
                        "!"
                      ], 
                      "type": "string", 
                      "description": "How to compare the specified attribute of each file to the specified value."
                    }, 
                    "type": {
                      "enum": [
                        "name", 
                        "path", 
                        "accessed_time", 
                        "accessed_before", 
                        "accessed_after", 
                        "birth_time", 
                        "birth_before", 
                        "birth_after", 
                        "changed_time", 
                        "changed_before", 
                        "changed_after", 
                        "size", 
                        "file_type", 
                        "posix_regex_name", 
                        "user_name", 
                        "user_id", 
                        "group_name", 
                        "group_id", 
                        "no_user", 
                        "no_group"
                      ], 
                      "type": "string", 
                      "description": "The type of this criterion, that is, which file attribute to match on.", 
                      "required": true
                    }
                  }
                }, 
                "type": "array", 
                "description": "An array containing individual file criterion objects each describing one criterion.  These are logically AND'ed together to form a set of criteria."
              }
            }
          }, 
          "type": "array", 
          "description": "An array containing objects with \"and_criteria\" properties, each set of and_criteria will be logically OR'ed together to create the full file matching pattern."
        }
      }
    }, 
    "target_snapshot_pattern": {
      "type": "string", 
      "description": "The name pattern for snapshots taken on the target cluster after the sync completes.  A value of @DEFAULT will reset this field to the default creation value."
    }, 
    "burst_mode": {
      "type": "boolean", 
      "description": "NOTE: This field should not be changed without the help of Isilon support.  Enable/disable UDP-based data transfer."
    }, 
    "target_detect_modifications": {
      "type": "boolean", 
      "description": "If true, target cluster will detect if files have been changed on the target by legacy tree walk syncs."
    }, 
    "action": {
      "enum": [
        "copy", 
        "sync"
      ], 
      "type": "string", 
      "description": "If 'copy', source files will be copied to the target cluster.  If 'sync', the target directory will be made an image of the source directory:  Files and directories that have been deleted on the source, have been moved within the target directory, or no longer match the selection criteria will be deleted from the target directory.", 
      "required": true
    }, 
    "source_snapshot_pattern": {
      "type": "string", 
      "description": "The name pattern for snapshots taken on the source cluster before a sync."
    }, 
    "source_include_directories": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Directories that will be included in the sync.  Modifying this field will result in a full synchronization of all data."
    }, 
    "source_exclude_directories": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Directories that will be excluded from the sync.  Modifying this field will result in a full synchronization of all data."
    }
  }
}

POST response body schema:
{
  "type": "object", 
  "properties": {
    "id": {
      "required": true, 
      "type": "string", 
      "description": "ID of created item that can be used to refer to item in the collection-item resource path."
    }
  }
}

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

Method DELETE: Delete all SyncIQ policies.

          URL: DELETE /platform/<<version=3>>/sync/policies

Query arguments:
local_only=<boolean> Skip deleting the policy association on the target.
     force=<boolean> Ignore any running jobs when preparing to delete a policy.

There is no response body for this method.
