Resource URL: /platform/<<version=1>>/protocols/smb/settings/global

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

     Methods: GET, PUT

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

Method GET: List all settings.

       URL: GET /platform/<<version=1>>/protocols/smb/settings/global

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.

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": {
          "required": true, 
          "type": "object", 
          "properties": {
            "support_multichannel": {
              "type": "boolean", 
              "description": "Support multichannel."
            }, 
            "audit_logon": {
              "enum": [
                "all", 
                "success", 
                "failure", 
                "none"
              ], 
              "type": "string", 
              "description": "Specify the level of logon audit events to log."
            }, 
            "service": {
              "type": "boolean", 
              "description": "Specify whether service is enabled."
            }, 
            "srv_num_workers": {
              "minimum": 0, 
              "type": "integer", 
              "description": "Set the maximum number of SRV service worker threads.", 
              "maximum": 1024
            }, 
            "onefs_cpu_multiplier": {
              "minimum": 1, 
              "type": "integer", 
              "description": "Specify the number of OneFS driver worker threads per CPU.", 
              "maximum": 4
            }, 
            "support_smb2": {
              "type": "boolean", 
              "description": "Support the SMB2 protocol on the server."
            }, 
            "dot_snap_accessible_root": {
              "type": "boolean", 
              "description": "Allow access to the .snapshot directory in the root of the share."
            }, 
            "server_string": {
              "type": "string", 
              "description": "Provides a description of the server."
            }, 
            "require_security_signatures": {
              "type": "boolean", 
              "description": "Indicates whether the server requires signed SMB packets."
            }, 
            "audit_fileshare": {
              "enum": [
                "all", 
                "success", 
                "failure", 
                "none"
              ], 
              "type": "string", 
              "description": "Specify level of file share audit events to log."
            }, 
            "access_based_share_enum": {
              "type": "boolean", 
              "description": "Only enumerate files and folders the requesting user has access to."
            }, 
            "dot_snap_visible_child": {
              "type": "boolean", 
              "description": "Show .snapshot directories in share subdirectories."
            }, 
            "audit_global_sacl": {
              "description": "Specifies a list of permissions to audit.", 
              "minItems": 0, 
              "items": {
                "type": "object", 
                "description": "Specifies properties for a SACL Access Control Entry.", 
                "properties": {
                  "flags": {
                    "enum": [
                      "successful", 
                      "failed"
                    ], 
                    "type": "string", 
                    "description": "Determines if audit is performed on success or failure.", 
                    "required": true
                  }, 
                  "permission": {
                    "description": "Specifies the array of filesystem rights that are governed.", 
                    "minItems": 0, 
                    "items": {
                      "enum": [
                        "generic_all", 
                        "generic_read", 
                        "generic_write", 
                        "generic_exec", 
                        "std_delete", 
                        "std_read_dac", 
                        "std_write_dac", 
                        "std_write_owner", 
                        "std_synchronize", 
                        "std_required", 
                        "list", 
                        "add_file", 
                        "add_subdir", 
                        "delete_child", 
                        "traverse", 
                        "dir_read_attr", 
                        "dir_write_attr", 
                        "dir_read_ext_attr", 
                        "dir_write_ext_attr", 
                        "dir_gen_read", 
                        "dir_gen_write", 
                        "dir_gen_execute", 
                        "dir_gen_all", 
                        "file_read", 
                        "file_write", 
                        "append", 
                        "execute", 
                        "delete_child", 
                        "file_read_attr", 
                        "file_write_attr", 
                        "file_read_ext_attr", 
                        "file_write_ext_attr", 
                        "file_gen_read", 
                        "file_gen_write", 
                        "file_gen_execute", 
                        "file_gen_all", 
                        "modify", 
                        "object_inherit", 
                        "container_inherit", 
                        "no_prop_inherit", 
                        "inherit_only", 
                        "inherited_ace"
                      ], 
                      "type": "string", 
                      "description": "Specifies filesystem access permissions."
                    }, 
                    "required": true, 
                    "maxItems": 4294967295, 
                    "uniqueItems": true, 
                    "type": "array"
                  }
                }
              }, 
              "maxItems": 4294967295, 
              "uniqueItems": true, 
              "type": "array"
            }, 
            "enable_security_signatures": {
              "type": "boolean", 
              "description": "Indicates whether the server supports signed SMB packets."
            }, 
            "dot_snap_accessible_child": {
              "type": "boolean", 
              "description": "Allow access to .snapshot directories in share subdirectories."
            }, 
            "srv_cpu_multiplier": {
              "minimum": 1, 
              "type": "integer", 
              "description": "Specify the number of SRV service worker threads per CPU.", 
              "maximum": 8
            }, 
            "guest_user": {
              "type": "string", 
              "description": "Specifies the fully-qualified user to use for guest access."
            }, 
            "dot_snap_visible_root": {
              "type": "boolean", 
              "description": "Show the .snapshot directory in the root of a share."
            }, 
            "ignore_eas": {
              "type": "boolean", 
              "description": "Specify whether to ignore EAs on files."
            }, 
            "onefs_num_workers": {
              "minimum": 0, 
              "type": "integer", 
              "description": "Set the maximum number of OneFS driver worker threads.", 
              "maximum": 1024
            }, 
            "support_netbios": {
              "type": "boolean", 
              "description": "Support NetBIOS."
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify one or more settings.

       URL: PUT /platform/<<version=1>>/protocols/smb/settings/global

There are no query arguments for this method.

PUT request body schema:
{
  "required": true, 
  "type": "object", 
  "properties": {
    "support_multichannel": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Support multichannel."
        }
      ]
    }, 
    "audit_logon": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "all", 
            "success", 
            "failure", 
            "none"
          ], 
          "type": "string", 
          "description": "Specify the level of logon audit events to log."
        }
      ]
    }, 
    "service": {
      "type": "boolean", 
      "description": "Specify whether service is enabled."
    }, 
    "srv_num_workers": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Set the maximum number of SRV service worker threads.", 
          "maximum": 1024
        }
      ]
    }, 
    "onefs_cpu_multiplier": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 1, 
          "type": "integer", 
          "description": "Specify the number of OneFS driver worker threads per CPU.", 
          "maximum": 4
        }
      ]
    }, 
    "support_smb2": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Support the SMB2 protocol on the server."
        }
      ]
    }, 
    "dot_snap_accessible_root": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Allow access to the .snapshot directory in the root of the share."
        }
      ]
    }, 
    "server_string": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Provides a description of the server."
        }
      ]
    }, 
    "require_security_signatures": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Indicates whether the server requires signed SMB packets."
        }
      ]
    }, 
    "audit_fileshare": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "enum": [
            "all", 
            "success", 
            "failure", 
            "none"
          ], 
          "type": "string", 
          "description": "Specify level of file share audit events to log."
        }
      ]
    }, 
    "access_based_share_enum": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Only enumerate files and folders the requesting user has access to."
        }
      ]
    }, 
    "dot_snap_visible_child": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Show .snapshot directories in share subdirectories."
        }
      ]
    }, 
    "audit_global_sacl": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "description": "Specifies a list of permissions to audit.", 
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies properties for a SACL Access Control Entry.", 
            "properties": {
              "flags": {
                "enum": [
                  "successful", 
                  "failed"
                ], 
                "type": "string", 
                "description": "Determines if audit is performed on success or failure.", 
                "required": true
              }, 
              "permission": {
                "description": "Specifies the array of filesystem rights that are governed.", 
                "minItems": 0, 
                "items": {
                  "enum": [
                    "generic_all", 
                    "generic_read", 
                    "generic_write", 
                    "generic_exec", 
                    "std_delete", 
                    "std_read_dac", 
                    "std_write_dac", 
                    "std_write_owner", 
                    "std_synchronize", 
                    "std_required", 
                    "list", 
                    "add_file", 
                    "add_subdir", 
                    "delete_child", 
                    "traverse", 
                    "dir_read_attr", 
                    "dir_write_attr", 
                    "dir_read_ext_attr", 
                    "dir_write_ext_attr", 
                    "dir_gen_read", 
                    "dir_gen_write", 
                    "dir_gen_execute", 
                    "dir_gen_all", 
                    "file_read", 
                    "file_write", 
                    "append", 
                    "execute", 
                    "delete_child", 
                    "file_read_attr", 
                    "file_write_attr", 
                    "file_read_ext_attr", 
                    "file_write_ext_attr", 
                    "file_gen_read", 
                    "file_gen_write", 
                    "file_gen_execute", 
                    "file_gen_all", 
                    "modify", 
                    "object_inherit", 
                    "container_inherit", 
                    "no_prop_inherit", 
                    "inherit_only", 
                    "inherited_ace"
                  ], 
                  "type": "string", 
                  "description": "Specifies filesystem access permissions."
                }, 
                "required": true, 
                "maxItems": 4294967295, 
                "uniqueItems": true, 
                "type": "array"
              }
            }
          }, 
          "maxItems": 4294967295, 
          "uniqueItems": true, 
          "type": "array"
        }
      ]
    }, 
    "enable_security_signatures": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Indicates whether the server supports signed SMB packets."
        }
      ]
    }, 
    "dot_snap_accessible_child": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Allow access to .snapshot directories in share subdirectories."
        }
      ]
    }, 
    "srv_cpu_multiplier": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 1, 
          "type": "integer", 
          "description": "Specify the number of SRV service worker threads per CPU.", 
          "maximum": 8
        }
      ]
    }, 
    "guest_user": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Specifies the fully-qualified user to use for guest access."
        }
      ]
    }, 
    "dot_snap_visible_root": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Show the .snapshot directory in the root of a share."
        }
      ]
    }, 
    "ignore_eas": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Specify whether to ignore EAs on files."
        }
      ]
    }, 
    "onefs_num_workers": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "minimum": 0, 
          "type": "integer", 
          "description": "Set the maximum number of OneFS driver worker threads.", 
          "maximum": 1024
        }
      ]
    }, 
    "support_netbios": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "Support NetBIOS."
        }
      ]
    }
  }
}

There is no JSON response body for this method.
