Resource URL: /platform/<<version=3>>/protocols/smb/settings/share

    Overview: This resource applies the standard settings pattern to share SMB
              settings.

     Methods: GET, PUT

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

Method GET: List all settings.

       URL: GET /platform/<<version=3>>/protocols/smb/settings/share

Query arguments:
 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.
zone=<string> Zone which contains these share settings.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "settings": {
      "required": true, 
      "type": "object", 
      "properties": {
        "file_create_mode": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Unix umask or mode bits.", 
          "maximum": 511
        }, 
        "ntfs_acl_support": {
          "type": "boolean", 
          "description": "Support NTFS ACLs on files and directories."
        }, 
        "file_filtering_enabled": {
          "type": "boolean", 
          "description": "Enables file filtering on the share."
        }, 
        "directory_create_mask": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Unix umask or mode bits.", 
          "maximum": 511
        }, 
        "ca_write_integrity": {
          "enum": [
            "none", 
            "write-read-coherent", 
            "full"
          ], 
          "type": "string", 
          "description": "Specify the level of write-integrity on continuously available shares."
        }, 
        "file_create_mask": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Unix umask or mode bits.", 
          "maximum": 511
        }, 
        "access_based_enumeration_root_only": {
          "type": "boolean", 
          "description": "Access-based enumeration on only the root directory of the share."
        }, 
        "hide_dot_files": {
          "type": "boolean", 
          "description": "Hide files and directories that begin with a period '.'."
        }, 
        "create_permissions": {
          "enum": [
            "default acl", 
            "inherit mode bits", 
            "use create mask and mode"
          ], 
          "type": "string", 
          "description": "Set the create permissions for new files and directories in share."
        }, 
        "strict_locking": {
          "type": "boolean", 
          "description": "Specifies whether byte range locks contend against SMB I/O."
        }, 
        "zone": {
          "type": "string", 
          "description": "Name of the access zone in which to update settings"
        }, 
        "mangle_map": {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Character mangle map."
        }, 
        "file_filter_type": {
          "enum": [
            "deny", 
            "allow"
          ], 
          "type": "string", 
          "description": "Specifies if filter list is for deny or allow. Default is deny."
        }, 
        "file_filter_extensions": {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies the list of file extensions."
        }, 
        "directory_create_mode": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Unix umask or mode bits.", 
          "maximum": 511
        }, 
        "impersonate_guest": {
          "enum": [
            "always", 
            "bad user", 
            "never"
          ], 
          "type": "string", 
          "description": "Specify the condition in which user access is done as the guest account."
        }, 
        "allow_delete_readonly": {
          "type": "boolean", 
          "description": "Allow deletion of read-only files in the share."
        }, 
        "ca_timeout": {
          "minimum": 2, 
          "type": "integer", 
          "description": "Persistent open timeout for the share."
        }, 
        "access_based_enumeration": {
          "type": "boolean", 
          "description": "Only enumerate files and folders the requesting user has access to."
        }, 
        "allow_execute_always": {
          "type": "boolean", 
          "description": "Allows users to execute files they have read rights for."
        }, 
        "csc_policy": {
          "enum": [
            "manual", 
            "documents", 
            "programs", 
            "none"
          ], 
          "type": "string", 
          "description": "Client-side caching policy for the shares."
        }, 
        "host_acl": {
          "items": {
            "type": "string", 
            "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '<IP-range|subnet|fqdn>]."
          }, 
          "type": "array", 
          "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry."
        }, 
        "change_notify": {
          "enum": [
            "all", 
            "norecurse", 
            "none"
          ], 
          "type": "string", 
          "description": "Specify level of change notification alerts on the share."
        }, 
        "impersonate_user": {
          "type": "string", 
          "description": "User account to be used as guest account."
        }, 
        "mangle_byte_start": {
          "minimum": 256, 
          "type": "integer", 
          "description": "Specifies the wchar_t starting point for automatic byte mangling.", 
          "maximum": 65535
        }, 
        "oplocks": {
          "type": "boolean", 
          "description": "Allow oplock requests."
        }, 
        "strict_flush": {
          "type": "boolean", 
          "description": "Handle SMB flush operations."
        }, 
        "strict_ca_lockout": {
          "type": "boolean", 
          "description": "Specifies if persistent opens would do strict lockout on the share."
        }
      }
    }
  }
}

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

Method PUT: Modify one or more settings.

       URL: PUT /platform/<<version=3>>/protocols/smb/settings/share

Query arguments:
zone=<string> Zone which contains these share settings.

PUT request body schema:
{
  "required": true, 
  "type": "object", 
  "properties": {
    "file_create_mode": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Unix umask or mode bits.", 
          "maximum": 511
        }
      ]
    }, 
    "ntfs_acl_support": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Support NTFS ACLs on files and directories."
        }
      ]
    }, 
    "file_filtering_enabled": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Enables file filtering on the share."
        }
      ]
    }, 
    "directory_create_mask": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Unix umask or mode bits.", 
          "maximum": 511
        }
      ]
    }, 
    "ca_write_integrity": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "none", 
            "write-read-coherent", 
            "full"
          ], 
          "type": "string", 
          "description": "Specify the level of write-integrity on continuously available shares."
        }
      ]
    }, 
    "file_create_mask": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Unix umask or mode bits.", 
          "maximum": 511
        }
      ]
    }, 
    "access_based_enumeration_root_only": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Access-based enumeration on only the root directory of the share."
        }
      ]
    }, 
    "hide_dot_files": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Hide files and directories that begin with a period '.'."
        }
      ]
    }, 
    "create_permissions": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "default acl", 
            "inherit mode bits", 
            "use create mask and mode"
          ], 
          "type": "string", 
          "description": "Set the create permissions for new files and directories in share."
        }
      ]
    }, 
    "strict_locking": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Specifies whether byte range locks contend against SMB I/O."
        }
      ]
    }, 
    "zone": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Name of the access zone in which to update settings"
        }
      ]
    }, 
    "mangle_map": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Character mangle map."
        }
      ]
    }, 
    "file_filter_type": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "deny", 
            "allow"
          ], 
          "type": "string", 
          "description": "Specifies if filter list is for deny or allow. Default is deny."
        }
      ]
    }, 
    "file_filter_extensions": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string"
          }, 
          "type": "array", 
          "description": "Specifies the list of file extensions."
        }
      ]
    }, 
    "directory_create_mode": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Unix umask or mode bits.", 
          "maximum": 511
        }
      ]
    }, 
    "impersonate_guest": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "always", 
            "bad user", 
            "never"
          ], 
          "type": "string", 
          "description": "Specify the condition in which user access is done as the guest account."
        }
      ]
    }, 
    "allow_delete_readonly": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Allow deletion of read-only files in the share."
        }
      ]
    }, 
    "ca_timeout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 2, 
          "type": "integer", 
          "description": "Persistent open timeout for the share."
        }
      ]
    }, 
    "access_based_enumeration": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Only enumerate files and folders the requesting user has access to."
        }
      ]
    }, 
    "allow_execute_always": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Allows users to execute files they have read rights for."
        }
      ]
    }, 
    "csc_policy": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "manual", 
            "documents", 
            "programs", 
            "none"
          ], 
          "type": "string", 
          "description": "Client-side caching policy for the shares."
        }
      ]
    }, 
    "host_acl": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "items": {
            "type": "string", 
            "description": "<'allow:'|'deny:'><'ALL'|IP-range|subnet|fqdn>[' EXCEPT '<IP-range|subnet|fqdn>]."
          }, 
          "type": "array", 
          "description": "An ACL expressing which hosts are allowed access. A deny clause must be the final entry."
        }
      ]
    }, 
    "change_notify": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "all", 
            "norecurse", 
            "none"
          ], 
          "type": "string", 
          "description": "Specify level of change notification alerts on the share."
        }
      ]
    }, 
    "impersonate_user": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "User account to be used as guest account."
        }
      ]
    }, 
    "mangle_byte_start": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 256, 
          "type": "integer", 
          "description": "Specifies the wchar_t starting point for automatic byte mangling.", 
          "maximum": 65535
        }
      ]
    }, 
    "oplocks": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Allow oplock requests."
        }
      ]
    }, 
    "strict_flush": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Handle SMB flush operations."
        }
      ]
    }, 
    "strict_ca_lockout": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Specifies if persistent opens would do strict lockout on the share."
        }
      ]
    }
  }
}

There is no response body for this method.
