|
APIs in Category: exports |
Cluster-Mode API version 1.15 |
export-policy-get-iter |
This set of ZAPIs allows managing Export policies and rules for NFSv2, NFSv3, NFSv4, CIFS and FlexCache protocols. Contains methods to create, modify, delete and obtain information about Export policies and rules in a cluster. |
| export-policy-get-iter | [top] |
Get a group of Export policy configurations.
Input Name Range Type Description desired-attributes export-policy-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20 query export-policy-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the Export policy configuration. object. All Export policy configuration. objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list export-policy-info[]
optional
The list of attributes of Export policy configuration. objects. next-tag string
optional
Tag for the next call. Not present when there are no more Export policy configuration. objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| export-rule-get-create-defaults | [top] |
Obtain the default values for Export rule configuration
Input Name Range Type Description attributes export-rule-info
optional
Optionally specify the value for attributes if available. The default values for some attributes may depend on the values specified for some other attribute. Output Name Range Type Description defaults export-rule-info
The default attributes for the Export rule configuration..
| export-rule-get-iter | [top] |
Get a group of Export rule configurations.
Input Name Range Type Description desired-attributes export-rule-info
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned. max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20 query export-rule-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the Export rule configuration. object. All Export rule configuration. objects matching this query up to 'max-records' will be returned. tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Output Name Range Type Description attributes-list export-rule-info[]
optional
The list of attributes of Export rule configuration. objects. next-tag string
optional
Tag for the next call. Not present when there are no more Export rule configuration. objects to return. num-records [0..100] integer
The number of records returned in this call.
Errno Description EINTERNALERROR
| Element definition: export-policy-info | [top] |
Information about the Export policy configuration. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Name Range Type Description policy-id [0..2^64-1] integer
optional
Export policy id. Attributes: non-creatable, non-modifiable policy-name string
optional
Export policy name. Attributes: key, required-for-create, non-modifiable vserver string
optional
Vserver name. Attributes: key, non-creatable, non-modifiable
| Element definition: export-rule-info | [top] |
Information about the Export rule configuration. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.
When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.
Name Range Type Description anonymous-user-id string
optional
User name or ID to which anonymous users are mapped. Default value is '65534'. Attributes: optional-for-create, modifiable client-match string
optional
Client match specification for Export rule. The clients specified are enforced with this Export rule. The rule with the higher rule index value takes precedence. Attributes: required-for-create, modifiable export-chown-mode string
optional
Change ownership mode. Possible values are 'restricted', 'unrestricted'. Default value is 'restricted'. Attributes: optional-for-create, modifiable export-ntfs-unix-security-ops string
optional
Ignore/Fail unix security operations on NTFS volumes. Possible values are 'ignore', 'fail'. Default value is 'fail'. Attributes: optional-for-create, modifiable is-allow-dev-is-enabled boolean
optional
If 'true', the NFS server will allow creation of devices. Default value is 'true'. Attributes: optional-for-create, modifiable is-allow-set-uid-enabled boolean
optional
If 'true', NFS server will honor SetUID bits in SETATTR operation. Default value is 'true'. Attributes: optional-for-create, modifiable policy-name string
optional
Export policy name. Attributes: key, required-for-create, non-modifiable protocol access-protocol[]
optional
Client access protocol. Default value is 'any'. Attributes: optional-for-create, modifiable Possible values:
- "any" - Any,
- "nfs2" - NFS Version 2,
- "nfs3" - NFS Version 3,
- "nfs" - Any Version of NFS,
- "cifs" - CIFS,
- "nfs4" - NFS Version 4,
- "flexcache" - Flexcache
ro-rule security-flavor[]
optional
Rule for read-only access. Attributes: required-for-create, modifiable Possible values:
- "any" - Any,
- "none" - Anonymous Access Allowed If Security Type Not Already Listed,
- "never" - Never,
- "krb5" - Kerberos 5 Authentication,
- "ntlm" - CIFS NTLM,
- "sys" - NFS AUTH_SYS,
- "spinauth" - SpinAuth
rule-index [0..2^32-1] integer
optional
Export rule index. Attributes: key, optional-for-create, non-modifiable rw-rule security-flavor[]
optional
Rule for read-write access. Attributes: required-for-create, modifiable Possible values:
- "any" - Any,
- "none" - Anonymous Access Allowed If Security Type Not Already Listed,
- "never" - Never,
- "krb5" - Kerberos 5 Authentication,
- "ntlm" - CIFS NTLM,
- "sys" - NFS AUTH_SYS,
- "spinauth" - SpinAuth
super-user-security security-flavor[]
optional
Security flavors for the superuser. Default value is 'never'. Attributes: optional-for-create, modifiable Possible values:
- "any" - Any,
- "none" - Anonymous Access Allowed If Security Type Not Already Listed,
- "never" - Never,
- "krb5" - Kerberos 5 Authentication,
- "ntlm" - CIFS NTLM,
- "sys" - NFS AUTH_SYS,
- "spinauth" - SpinAuth
vserver-name string
optional
Vserver name. Attributes: key, non-creatable, non-modifiable
| Element definition: access-protocol | [top] |
any|nfs2|nfs3|nfs|cifs|nfs4|flexcache Possible values:
- "any" - Any,
- "nfs2" - NFS Version 2,
- "nfs3" - NFS Version 3,
- "nfs" - Any Version of NFS,
- "cifs" - CIFS,
- "nfs4" - NFS Version 4,
- "flexcache" - Flexcache
[none]
| Element definition: security-flavor | [top] |
any|none|never|krb5|ntlm|sys Possible values:
- "any" - Any,
- "none" - Anonymous Access Allowed If Security Type Not Already Listed,
- "never" - Never,
- "krb5" - Kerberos 5 Authentication,
- "ntlm" - CIFS NTLM,
- "sys" - NFS AUTH_SYS,
- "spinauth" - SpinAuth
[none]