Created
August 23, 2016 13:54
-
-
Save akutz/c2d28ec238ced982fcf4415a13ca3def to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"type": "object", | |
"properties": { | |
"exports": { | |
"items": { | |
"type": "object", | |
"description": "Specifies configuration values for NFS exports.", | |
"properties": { | |
"encoding": { | |
"type": "string", | |
"description": "Specifies the default character set encoding of the clients connecting to the export, unless otherwise specified." | |
}, | |
"map_retry": { | |
"type": "boolean", | |
"description": "Determines whether searches for users specified in 'map_all', 'map_root' or 'map_nonroot' are retried if the search fails." | |
}, | |
"security_flavors": { | |
"items": { | |
"enum": [ | |
"unix", | |
"krb5", | |
"krb5i", | |
"krb5p" | |
], | |
"type": "string", | |
"description": "Specifies the authentication types that are supported for this export." | |
}, | |
"type": "array", | |
"description": "Specifies the authentication types that are supported for this export." | |
}, | |
"write_unstable_reply": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the stability disposition returned when an NFSv3+ unstable write is processed." | |
}, | |
"write_filesync_reply": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the stability disposition returned when an NFSv3+ filesync write is processed." | |
}, | |
"conflicting_paths": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Reports the paths that conflict with another export." | |
}, | |
"readdirplus_prefetch": { | |
"type": "integer", | |
"description": "Sets the number of directory entries that are prefetched when a 'readdirplus' request is processed. (Deprecated.)" | |
}, | |
"block_size": { | |
"type": "integer", | |
"description": "Specifies the block size returned by the NFS statfs procedure." | |
}, | |
"write_transfer_size": { | |
"type": "integer", | |
"description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"id": { | |
"type": "integer", | |
"description": "Specifies the system-assigned ID for the export. This ID is returned when an export is created through the POST method." | |
}, | |
"description": { | |
"type": "string", | |
"description": "Specifies the user-defined string that is used to identify the export." | |
}, | |
"max_file_size": { | |
"type": "integer", | |
"description": "Specifies the maximum file size for any file accessed from the export. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"paths": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Specifies the paths under /ifs that are exported." | |
}, | |
"write_unstable_action": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the action to be taken when an NFSv3+ unstable write is requested." | |
}, | |
"zone": { | |
"type": "string", | |
"description": "Specifies the zone in which the export is valid." | |
}, | |
"name_max_size": { | |
"type": "integer", | |
"description": "Specifies the reported maximum length of a file name. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"can_set_time": { | |
"type": "boolean", | |
"description": "True if the client can set file times through the NFS set attribute request. This parameter does not affect server behavior, but is included to accommoate legacy client requirements." | |
}, | |
"read_transfer_multiple": { | |
"type": "integer", | |
"description": "Specifies the preferred multiple size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"return_32bit_file_ids": { | |
"type": "boolean", | |
"description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values." | |
}, | |
"map_all": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "User and group mapping.", | |
"properties": { | |
"primary_group": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies persona properties for the primary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"enabled": { | |
"type": "boolean", | |
"description": "True if the user mapping is applied." | |
}, | |
"secondary_groups": { | |
"items": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
] | |
}, | |
"type": "array", | |
"description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"user": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies the name of the privilege." | |
} | |
} | |
} | |
], | |
"description": "Specifies the users and groups to which non-root and root clients are mapped." | |
}, | |
"all_dirs": { | |
"type": "boolean", | |
"description": "True if all directories under the specified paths are mountable." | |
}, | |
"setattr_asynchronous": { | |
"type": "boolean", | |
"description": "True if set attribute operations execute asynchronously." | |
}, | |
"map_failure": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "User and group mapping.", | |
"properties": { | |
"primary_group": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies persona properties for the primary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"enabled": { | |
"type": "boolean", | |
"description": "True if the user mapping is applied." | |
}, | |
"secondary_groups": { | |
"items": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
] | |
}, | |
"type": "array", | |
"description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"user": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies the name of the privilege." | |
} | |
} | |
} | |
], | |
"description": "Specifies the users and groups to which clients should be mapped to if authentication fails." | |
}, | |
"link_max": { | |
"type": "integer", | |
"description": "Specifies the reported maximum number of links to a file. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"write_datasync_reply": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the stability disposition returned when an NFSv3+ datasync write is processed." | |
}, | |
"no_truncate": { | |
"type": "boolean", | |
"description": "True if long file names result in an error. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"time_delta": { | |
"type": "number", | |
"description": "Specifies the resolution of all time values that are returned to the clients" | |
}, | |
"read_only_clients": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Specifies the clients with read-only access to the export." | |
}, | |
"read_write_clients": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Specifies the clients with both read and write access to the export, even when the export is set to read-only." | |
}, | |
"snapshot": { | |
"type": "string", | |
"description": "Specifies the snapshot for all mounts." | |
}, | |
"read_only": { | |
"type": "boolean", | |
"description": "True if the export is set to read-only." | |
}, | |
"map_lookup_uid": { | |
"type": "boolean", | |
"description": "True if incoming user IDs (UIDs) are mapped to users in the OneFS user database. When set to false, incoming UIDs are applied directly to file operations." | |
}, | |
"chown_restricted": { | |
"type": "boolean", | |
"description": "True if the superuser can change file ownership. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"write_datasync_action": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the action to be taken when an NFSv3+ datasync write is requested." | |
}, | |
"read_transfer_size": { | |
"type": "integer", | |
"description": "Specifies the preferred size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"write_transfer_multiple": { | |
"type": "integer", | |
"description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"map_full": { | |
"type": "boolean", | |
"description": "True if user mappings query the OneFS user database. When set to false, user mappings only query local authentication." | |
}, | |
"read_transfer_max_size": { | |
"type": "integer", | |
"description": "Specifies the maximum buffer size that clients should use on NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"map_root": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "User and group mapping.", | |
"properties": { | |
"primary_group": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies persona properties for the primary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"enabled": { | |
"type": "boolean", | |
"description": "True if the user mapping is applied." | |
}, | |
"secondary_groups": { | |
"items": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
] | |
}, | |
"type": "array", | |
"description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"user": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies the name of the privilege." | |
} | |
} | |
} | |
], | |
"description": "Specifies the users and groups to which root clients are mapped." | |
}, | |
"map_non_root": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "User and group mapping.", | |
"properties": { | |
"primary_group": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies persona properties for the primary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"enabled": { | |
"type": "boolean", | |
"description": "True if the user mapping is applied." | |
}, | |
"secondary_groups": { | |
"items": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
] | |
}, | |
"type": "array", | |
"description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"user": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies the name of the privilege." | |
} | |
} | |
} | |
], | |
"description": "Specifies the users and groups to which non-root clients are mapped." | |
}, | |
"symlinks": { | |
"type": "boolean", | |
"description": "True if symlinks are supported. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"commit_asynchronous": { | |
"type": "boolean", | |
"description": "True if NFS commit requests execute asynchronously." | |
}, | |
"write_filesync_action": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the action to be taken when an NFSv3+ filesync write is requested." | |
}, | |
"case_insensitive": { | |
"type": "boolean", | |
"description": "True if the case is ignored for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"clients": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Specifies the clients with root access to the export." | |
}, | |
"readdirplus": { | |
"type": "boolean", | |
"description": "True if 'readdirplus' requests are enabled. Enabling this property might improve network performance and is only available for NFSv3." | |
}, | |
"write_transfer_max_size": { | |
"type": "integer", | |
"description": "Specifies the maximum buffer size that clients should use on NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"root_clients": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Clients that have root access to the export." | |
}, | |
"directory_transfer_size": { | |
"type": "integer", | |
"description": "Specifies the preferred size for directory read operations. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"unresolved_clients": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Reports clients that cannot be resolved." | |
}, | |
"case_preserving": { | |
"type": "boolean", | |
"description": "True if the case is preserved for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
} | |
} | |
}, | |
"type": "array" | |
}, | |
"total": { | |
"type": "integer", | |
"description": "Total number of items available." | |
}, | |
"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)." | |
} | |
} | |
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"type": "object", | |
"description": "Specifies configuration values for NFS exports.", | |
"properties": { | |
"encoding": { | |
"type": "string", | |
"description": "Specifies the default character set encoding of the clients connecting to the export, unless otherwise specified." | |
}, | |
"map_retry": { | |
"type": "boolean", | |
"description": "Determines whether searches for users specified in 'map_all', 'map_root' or 'map_nonroot' are retried if the search fails." | |
}, | |
"security_flavors": { | |
"items": { | |
"enum": [ | |
"unix", | |
"krb5", | |
"krb5i", | |
"krb5p" | |
], | |
"type": "string", | |
"description": "Specifies the authentication types that are supported for this export." | |
}, | |
"type": "array", | |
"description": "Specifies the authentication types that are supported for this export." | |
}, | |
"write_unstable_reply": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the stability disposition returned when an NFSv3+ unstable write is processed." | |
}, | |
"write_filesync_reply": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the stability disposition returned when an NFSv3+ filesync write is processed." | |
}, | |
"readdirplus_prefetch": { | |
"type": "integer", | |
"description": "Sets the number of directory entries that are prefetched when a 'readdirplus' request is processed. (Deprecated.)" | |
}, | |
"block_size": { | |
"type": "integer", | |
"description": "Specifies the block size returned by the NFS statfs procedure." | |
}, | |
"write_transfer_size": { | |
"type": "integer", | |
"description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"map_all": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "User and group mapping.", | |
"properties": { | |
"primary_group": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies persona properties for the primary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"enabled": { | |
"type": "boolean", | |
"description": "True if the user mapping is applied." | |
}, | |
"secondary_groups": { | |
"items": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
] | |
}, | |
"type": "array", | |
"description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"user": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies the name of the privilege." | |
} | |
} | |
} | |
], | |
"description": "Specifies the users and groups to which non-root and root clients are mapped." | |
}, | |
"description": { | |
"type": "string", | |
"description": "Specifies the user-defined string that is used to identify the export." | |
}, | |
"max_file_size": { | |
"type": "integer", | |
"description": "Specifies the maximum file size for any file accessed from the export. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"paths": { | |
"items": { | |
"type": "string" | |
}, | |
"required": true, | |
"type": "array", | |
"description": "Specifies the paths under /ifs that are exported." | |
}, | |
"write_unstable_action": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the action to be taken when an NFSv3+ unstable write is requested." | |
}, | |
"zone": { | |
"type": "string", | |
"description": "Specifies the zone in which the export is valid." | |
}, | |
"name_max_size": { | |
"type": "integer", | |
"description": "Specifies the reported maximum length of a file name. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"can_set_time": { | |
"type": "boolean", | |
"description": "True if the client can set file times through the NFS set attribute request. This parameter does not affect server behavior, but is included to accommoate legacy client requirements." | |
}, | |
"read_transfer_multiple": { | |
"type": "integer", | |
"description": "Specifies the preferred multiple size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"return_32bit_file_ids": { | |
"type": "boolean", | |
"description": "Limits the size of file identifiers returned by NFSv3+ to 32-bit values." | |
}, | |
"write_transfer_multiple": { | |
"type": "integer", | |
"description": "Specifies the preferred multiple size for NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"all_dirs": { | |
"type": "boolean", | |
"description": "True if all directories under the specified paths are mountable." | |
}, | |
"setattr_asynchronous": { | |
"type": "boolean", | |
"description": "True if set attribute operations execute asynchronously." | |
}, | |
"map_failure": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "User and group mapping.", | |
"properties": { | |
"primary_group": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies persona properties for the primary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"enabled": { | |
"type": "boolean", | |
"description": "True if the user mapping is applied." | |
}, | |
"secondary_groups": { | |
"items": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
] | |
}, | |
"type": "array", | |
"description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"user": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies the name of the privilege." | |
} | |
} | |
} | |
], | |
"description": "Specifies the users and groups to which clients should be mapped to if authentication fails." | |
}, | |
"link_max": { | |
"type": "integer", | |
"description": "Specifies the reported maximum number of links to a file. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"write_datasync_reply": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the stability disposition returned when an NFSv3+ datasync write is processed." | |
}, | |
"no_truncate": { | |
"type": "boolean", | |
"description": "True if long file names result in an error. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"time_delta": { | |
"type": "number", | |
"description": "Specifies the resolution of all time values that are returned to the clients" | |
}, | |
"read_only_clients": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Specifies the clients with read-only access to the export." | |
}, | |
"read_write_clients": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Specifies the clients with both read and write access to the export, even when the export is set to read-only." | |
}, | |
"snapshot": { | |
"type": "string", | |
"description": "Specifies the snapshot for all mounts." | |
}, | |
"read_only": { | |
"type": "boolean", | |
"description": "True if the export is set to read-only." | |
}, | |
"map_lookup_uid": { | |
"type": "boolean", | |
"description": "True if incoming user IDs (UIDs) are mapped to users in the OneFS user database. When set to false, incoming UIDs are applied directly to file operations." | |
}, | |
"chown_restricted": { | |
"type": "boolean", | |
"description": "True if the superuser can change file ownership. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"write_datasync_action": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the action to be taken when an NFSv3+ datasync write is requested." | |
}, | |
"read_transfer_size": { | |
"type": "integer", | |
"description": "Specifies the preferred size for NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"map_full": { | |
"type": "boolean", | |
"description": "True if user mappings query the OneFS user database. When set to false, user mappings only query local authentication." | |
}, | |
"read_transfer_max_size": { | |
"type": "integer", | |
"description": "Specifies the maximum buffer size that clients should use on NFS read requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"map_root": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "User and group mapping.", | |
"properties": { | |
"primary_group": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies persona properties for the primary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"enabled": { | |
"type": "boolean", | |
"description": "True if the user mapping is applied." | |
}, | |
"secondary_groups": { | |
"items": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
] | |
}, | |
"type": "array", | |
"description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"user": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies the name of the privilege." | |
} | |
} | |
} | |
], | |
"description": "Specifies the users and groups to which root clients are mapped." | |
}, | |
"map_non_root": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "User and group mapping.", | |
"properties": { | |
"primary_group": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies persona properties for the primary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"enabled": { | |
"type": "boolean", | |
"description": "True if the user mapping is applied." | |
}, | |
"secondary_groups": { | |
"items": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
] | |
}, | |
"type": "array", | |
"description": "Specifies persona properties for the secondary user group. A persona consists of either a type and name, or an ID." | |
}, | |
"user": { | |
"type": [ | |
{ | |
"type": "object", | |
"description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", | |
"properties": { | |
"type": { | |
"enum": [ | |
"user", | |
"group", | |
"wellknown" | |
], | |
"type": "string", | |
"description": "Specifies the type of persona, which must be combined with a name." | |
}, | |
"id": { | |
"type": "string", | |
"description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'." | |
}, | |
"name": { | |
"type": "string", | |
"description": "Specifies the persona name, which must be combined with a type." | |
} | |
} | |
} | |
], | |
"description": "Specifies the name of the privilege." | |
} | |
} | |
} | |
], | |
"description": "Specifies the users and groups to which non-root clients are mapped." | |
}, | |
"symlinks": { | |
"type": "boolean", | |
"description": "True if symlinks are supported. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"commit_asynchronous": { | |
"type": "boolean", | |
"description": "True if NFS commit requests execute asynchronously." | |
}, | |
"write_filesync_action": { | |
"type": [ | |
{ | |
"enum": [ | |
"DATASYNC", | |
"FILESYNC", | |
"UNSTABLE" | |
], | |
"type": "string", | |
"description": "Specifies the synchronization type." | |
} | |
], | |
"description": "Specifies the action to be taken when an NFSv3+ filesync write is requested." | |
}, | |
"case_insensitive": { | |
"type": "boolean", | |
"description": "True if the case is ignored for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
}, | |
"clients": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Specifies the clients with root access to the export." | |
}, | |
"readdirplus": { | |
"type": "boolean", | |
"description": "True if 'readdirplus' requests are enabled. Enabling this property might improve network performance and is only available for NFSv3." | |
}, | |
"write_transfer_max_size": { | |
"type": "integer", | |
"description": "Specifies the maximum buffer size that clients should use on NFS write requests. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"root_clients": { | |
"items": { | |
"type": "string" | |
}, | |
"type": "array", | |
"description": "Clients that have root access to the export." | |
}, | |
"directory_transfer_size": { | |
"type": "integer", | |
"description": "Specifies the preferred size for directory read operations. This value is used to advise the client of optimal settings for the server, but is not enforced." | |
}, | |
"case_preserving": { | |
"type": "boolean", | |
"description": "True if the case is preserved for file names. This parameter does not affect server behavior, but is included to accommodate legacy client requirements." | |
} | |
} | |
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{ | |
"type": "object", | |
"properties": { | |
"id": { | |
"required": true, | |
"type": "integer", | |
"description": "ID of created item that can be used to refer to item in the collection-item resource path." | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment