APIs in Category: vserver
Cluster-Mode API version 1.15

 
vserver-create
vserver-destroy
vserver-get-iter
vserver-modify
vserver-modify-iter
vserver-rename
vserver-start
vserver-stop
This set of ZAPIs allows to manage a Vserver.

NetApp Manage ONTAP
 
vserver-create [top]

Create a new vserver.
Input Name Range Type Description
antivirus-on-access-policy antivirus-policy
optional
Antivirus policy. default: default
comment string
optional
Comment.
language language-code
optional
Specifies the language to use for the Vserver. Default: C. Available language codes are: 'C' .............. POSIX 'ar' ............. Arabic 'cs' ............. Czech 'da' ............. Danish 'de' ............. German 'en' ............. English 'en_US' .......... English (US) 'es' ............. Spanish 'fi' ............. Finnish 'fr' ............. French 'he' ............. Hebrew 'hr' ............. Croatian 'hu' ............. Hungarian 'it' ............. Italian 'ja' ............. Japanese euc-j* 'ja_v1' .......... Japanese euc-j 'ja_JP.PCK' ...... Japanese PCK (sjis)* 'ja_JP.932' ...... Japanese cp932* 'ja_JP.PCK_v2' .... Japanese PCK (sjis) 'ko' ............. Korean 'no' ............. Norwegian 'nl' ............. Dutch 'pl' ............. Polish 'pt' ............. Portuguese 'ro' ............. Romanian 'ru' ............. Russian 'sk' ............. Slovak 'sl' ............. Slovenian 'sv' ............. Swedish 'tr' ............. Turkish 'zh' ............. Simplified Chinese 'zh.GBK' ......... Simplified Chinese (GBK) 'zh_TW' .......... Traditional Chinese euc-tw 'zh_TW.BIG5' ..... Traditional Chinese Big 5 To use UTF-8 as the NFS character set, append '.UTF-8'.
name-mapping-switch nmswitch[]
optional
Name Mapping switch configuration details for the Vserver. Possible values: 'file', 'ldap'. default: file Possible values:
  • "file" ,
  • "ldap"
name-server-switch nsswitch[]
Name Server switch configuration details for the Vserver. Possible values: 'nis', 'file', 'ldap'. Possible values:
  • "nis" ,
  • "file" ,
  • "ldap"
quota-policy string
optional
Quota policy. default: default
return-record boolean
optional
If set to true, returns the vserver on successful creation. Default: false
root-volume volume-name
Root volume of the Vserver.
root-volume-aggregate aggr-name
The aggregate on which the root volume will be created.
root-volume-security-style string
Security Style of the root volume. Possible values: 'unix', 'ntfs', 'mixed'.
snapshot-policy snapshot-policy
optional
Snapshot policy setting. default: default
vserver-name string
Name of the Vserver.
 
Output Name Range Type Description
result vserver-info
optional
The vserver created (keys or the entire object if requested)
 Errno  Description
 EINTERNALERROR
 EVSERVERNAMEEXISTS
 EINVALIDINPUTERROR

 
vserver-destroy [top]
Destroys the Vserver and its objects. All volumes and mirrors belonging to the Vserver must be deleted using other APIs before destroying the Vserver. EVOLEXISTS is returned if the Vserver is found to have any volumes or mirrors. This APIS removes all other objects of this Vserver including its network Interfaces, routes, configurations, admin login accounts and roles.
Input Name Range Type Description
vserver-name string
Name of the Vserver.
 Errno  Description
 EINTERNALERROR
 EVSERVERNOTFOUND
 EOPNOTSUPPORTED
 EVOLEXISTS

 
vserver-get-iter [top]
Display information about Vservers. Information about Admin Vserver, Node Vserver, and Cluster Vservers is displayed. If the ZAPI is issued to the Cluster LIF with no Vserver specified as input, then information about all Vservers is shown. If the request is sent to the Vserver LIF, then information about that Vserver is shown.
Input Name Range Type Description
desired-attributes vserver-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 vserver-info
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver object. All vserver 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 vserver-info[]
optional
The list of attributes of vserver objects.
next-tag string
optional
Tag for the next call. Not present when there are no more vserver objects to return.
num-records [0..100] integer
The number of records returned in this call.
 Errno  Description
 EINTERNALERROR
 EVSERVERNOTFOUND

 
vserver-modify [top]
Modify the attributes of vserver object.
Input Name Range Type Description
aggr-list aggr-name[]
optional
The list of aggregates assigned for volume operations. These aggregates could be shared for use with other Vservers.
allowed-protocols protocol[]
optional
Allowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. Possible values:
  • "nfs" - NFS protocol,
  • "cifs" - CIFS protocol,
  • "fcp" - FCP protocol,
  • "iscsi" - iSCSI protocol
antivirus-on-access-policy antivirus-policy
optional
Antivirus policy. default: default
comment string
optional
Comment.
disallowed-protocols protocol[]
optional
Disallowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. Possible values:
  • "nfs" - NFS protocol,
  • "cifs" - CIFS protocol,
  • "fcp" - FCP protocol,
  • "iscsi" - iSCSI protocol
max-volumes [0..2^32-1] integer
optional
The maximum number of volumes that can be created on the Vserver.
name-mapping-switch nmswitch[]
optional
Name Mapping switch configuration details for the Vserver. Possible values: 'file', 'ldap'. default: file Possible values:
  • "file" ,
  • "ldap"
name-server-switch nsswitch[]
optional
Name Server switch configuration details for the Vserver. Possible values: 'nis', 'file', 'ldap'. Possible values:
  • "nis" ,
  • "file" ,
  • "ldap"
quota-policy string
optional
Quota policy. default: default
snapshot-policy snapshot-policy
optional
Snapshot policy setting. default: default
state vsadminstate
optional
State of the Virtual Server. This field represents the data serving ability of a Vserver, hence is applicable only for Cluster Vservers. Possible values:
  • "running" ,
  • "stopped" ,
  • "starting" ,
  • "stopping"
vserver-name string
Name of the Vserver.
 Errno  Description
 EINTERNALERROR
 EVSERVERNOTFOUND
 EINVALIDINPUTERROR

 
vserver-modify-iter [top]
Modify the attributes of vserver or a group of vserver objects.
Input Name Range Type Description
attributes vserver-info
Specify at least one modifiable element. Do not specify any other element.
continue-on-failure boolean
optional
This input element is useful when multiple vserver objects match a given query. If set to true, the API will continue modifying the next matching vserver even when modification of a previous vserver fails. If set to false, the API will return on the first failure. Default: false
max-failure-count [1..2^32-1] integer
optional
When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed modify operations before the server gives up and returns. If set, the API will continue modifying the next matching vserver even when the modification of a previous matching vserver fails, and do so until the total number of objects failed to be modified reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed modify operations. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
max-records [1..100] integer
optional
The maximum number of objects to be modified in this call. Default: 20
query vserver-info
If modifying a specific vserver, this input element must specify all keys. If modifying vserver objects based on query, this input element must specify a query.
return-failure-list boolean
optional
If set to true, the API will return the list of vserver objects (just keys) that were not modified due to some error. If set to false, the list of vserver objects not modified will not be returned. Default: true
return-success-list boolean
optional
If set to true, the API will return the list of vserver objects (just keys) that were successfully updated. If set to false, the list of vserver objects modified will not be returned. Default: true
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
failure-list vserver-modify-iter-info[]
optional
Information about vserver objects that were not modified due to some error. This element will be returned only if input element 'return-failure-list' is true.
next-tag string
optional
Tag for the next call. Not present when there are no more matching vserver objects to be modified.
num-failed [0..100] integer
optional
Number of vserver objects that matched the query, but were not modified due to some error.
num-succeeded [0..100] integer
optional
The number of vserver objects that matched the query and were successfully updated.
success-list vserver-modify-iter-info[]
optional
The vserver objects that were successfully updated. This element will be returned only if input element 'return-success-list' is true
 Errno  Description
 EINTERNALERROR
 EVSERVERNOTFOUND
 EINVALIDINPUTERROR

 
vserver-rename [top]
Rename a Vserver
Input Name Range Type Description
new-name string
New Vserver name
vserver-name string
Vserver
 Errno  Description
 EVSERVERNOTFOUND
 EINTERNALERROR
 EVSERVERNAMEEXISTS
 EINVALIDINPUTERROR

 
vserver-start [top]
Start a Vserver
Input Name Range Type Description
vserver-name string
Name of the Vserver.
 Errno  Description
 EVSERVERNOTFOUND
 EINTERNALERROR
 EOPNOTSUPPORTED
 EVSERVERALREADYSTARTED

 
vserver-stop [top]
Stop a Vserver
Input Name Range Type Description
vserver-name string
Name of the Vserver.
 Errno  Description
 EVSERVERNOTFOUND
 EINTERNALERROR
 EOPNOTSUPPORTED
 EVSERVERNOTRUNNING

 
Element definition: aggr-name [top]
Name of the aggregate
[none]

 
Element definition: antivirus-policy [top]
Antivirus Policy
[none]

 
Element definition: language-code [top]
Language Code.

The following are the possible language codes along with their names:

  • 'C' ... POSIX,
  • 'ar' ... Arabic,
  • 'cs' ... Czech,
  • 'da' ... Danish,
  • 'de' ... German,
  • 'en' ... English,
  • 'en_US' ... English (US),
  • 'es' ... Spanish,
  • 'fi' ... Finnish,
  • 'fr' ... French,
  • 'he' ... Hebrew,
  • 'hr' ... Croatian,
  • 'hu' ... Hungarian,
  • 'it' ... Italian,
  • 'ja' ... Japanese euc-j*,
  • 'ja_v1' ... Japanese euc-j,
  • 'ja_JP.PCK' ... Japanese PCK (sjis)*,
  • 'ja_JP.932' ... Japanese cp932*,
  • 'ja_JP.PCK_v2' ... Japanese PCK (sjis),
  • 'ko' ... Korean,
  • 'no' ... Norwegian,
  • 'nl' ... Dutch,
  • 'pl' ... Polish,
  • 'pt' ... Portuguese,
  • 'ro' ... Romanian,
  • 'ru' ... Russian,
  • 'sk' ... Slovak,
  • 'sl' ... Slovenian,
  • 'sv' ... Swedish,
  • 'tr' ... Turkish,
  • 'zh' ... Simplified Chinese,
  • 'zh.GBK' ... Simplified Chinese (GBK),
  • 'zh_TW' ... Traditional Chinese euc-tw,
  • 'zh_TW.BIG5' ... Traditional Chinese Big 5

To use UTF-8 as the NFS character set, append '.UTF-8' to the language code.

[none]

 
Element definition: nmswitch [top]
file|ldap Possible values:
  • "file" ,
  • "ldap"
[none]

 
Element definition: nsswitch [top]
nis|file|ldap Possible values:
  • "nis" ,
  • "file" ,
  • "ldap"
[none]

 
Element definition: protocol [top]
Vserver protocols. Possible values:
  • "nfs" - NFS protocol,
  • "cifs" - CIFS protocol,
  • "fcp" - FCP protocol,
  • "iscsi" - iSCSI protocol
[none]

 
Element definition: snapshot-policy [top]
Snapshot Policy
[none]

 
Element definition: volume-name [top]
The name of the volume.

Volume names can contain letters, numbers, and the underscore character (_). The first character must be a letter or an underscore. When creating a Cluster-Mode volume, the user can specify at most 203 characters. If the prefix '/vol/' appears in the volume name, it is striped out and the characters that follow the prefix constitute the actual volume name.

Volume names are scoped by their owning Vserver in a cluster, with each Vserver's volume namespace being totally independent. Thus, any Vserver 'S' in a cluster cannot have two volumes with the same name 'V'. However, two different Vservers in the same cluster can each have a volume named 'V'.

For example, any given Vserver in a cluster can only have at most one volume named 'vol0'. However, two different Vservers S1 and S2 in the cluster may each have a volume named 'vol0'.

[none]

 
Element definition: vsadminstate [top]
vserver state Possible values:
  • "running" ,
  • "stopped" ,
  • "starting" ,
  • "stopping"
[none]

 
Element definition: vserver-info [top]
Vserver Information 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
aggr-list aggr-name[]
optional
The list of aggregates assigned for volume operations. These aggregates could be shared for use with other Vservers. Attributes: non-creatable, modifiable
allowed-protocols protocol[]
optional
Allowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. Attributes: non-creatable, modifiable Possible values:
  • "nfs" - NFS protocol,
  • "cifs" - CIFS protocol,
  • "fcp" - FCP protocol,
  • "iscsi" - iSCSI protocol
antivirus-on-access-policy antivirus-policy
optional
Antivirus policy. default: default Attributes: optional-for-create, modifiable
comment string
optional
Comment. Attributes: optional-for-create, modifiable
disallowed-protocols protocol[]
optional
Disallowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. Attributes: non-creatable, modifiable Possible values:
  • "nfs" - NFS protocol,
  • "cifs" - CIFS protocol,
  • "fcp" - FCP protocol,
  • "iscsi" - iSCSI protocol
language language-code
optional
Specifies the language to use for the Vserver. Default: C. Available language codes are: 'C' .............. POSIX 'ar' ............. Arabic 'cs' ............. Czech 'da' ............. Danish 'de' ............. German 'en' ............. English 'en_US' .......... English (US) 'es' ............. Spanish 'fi' ............. Finnish 'fr' ............. French 'he' ............. Hebrew 'hr' ............. Croatian 'hu' ............. Hungarian 'it' ............. Italian 'ja' ............. Japanese euc-j* 'ja_v1' .......... Japanese euc-j 'ja_JP.PCK' ...... Japanese PCK (sjis)* 'ja_JP.932' ...... Japanese cp932* 'ja_JP.PCK_v2' .... Japanese PCK (sjis) 'ko' ............. Korean 'no' ............. Norwegian 'nl' ............. Dutch 'pl' ............. Polish 'pt' ............. Portuguese 'ro' ............. Romanian 'ru' ............. Russian 'sk' ............. Slovak 'sl' ............. Slovenian 'sv' ............. Swedish 'tr' ............. Turkish 'zh' ............. Simplified Chinese 'zh.GBK' ......... Simplified Chinese (GBK) 'zh_TW' .......... Traditional Chinese euc-tw 'zh_TW.BIG5' ..... Traditional Chinese Big 5 To use UTF-8 as the NFS character set, append '.UTF-8'. Attributes: optional-for-create, non-modifiable
ldap-domain string
optional
LDAP client configuration details. Attributes: non-creatable, non-modifiable
max-volumes [0..2^32-1] integer
optional
The maximum number of volumes that can be created on the Vserver. Attributes: non-creatable, modifiable
name-mapping-switch nmswitch[]
optional
Name Mapping switch configuration details for the Vserver. Possible values: 'file', 'ldap'. default: file Attributes: optional-for-create, modifiable Possible values:
  • "file" ,
  • "ldap"
name-server-switch nsswitch[]
optional
Name Server switch configuration details for the Vserver. Possible values: 'nis', 'file', 'ldap'. Attributes: required-for-create, modifiable Possible values:
  • "nis" ,
  • "file" ,
  • "ldap"
nis-domain nis-domain
optional
NIS domain configuration details for the Vserver. Attributes: non-creatable, non-modifiable
quota-policy string
optional
Quota policy. default: default Attributes: optional-for-create, modifiable
root-volume volume-name
optional
Root volume of the Vserver. Attributes: required-for-create, non-modifiable
root-volume-aggregate aggr-name
optional
The aggregate on which the root volume will be created. Attributes: required-for-create, non-modifiable
root-volume-security-style string
optional
Security Style of the root volume. Possible values: 'unix', 'ntfs', 'mixed'. Attributes: required-for-create, non-modifiable
snapshot-policy snapshot-policy
optional
Snapshot policy setting. default: default Attributes: optional-for-create, modifiable
state vsadminstate
optional
State of the Virtual Server. This field represents the data serving ability of a Vserver, hence is applicable only for Cluster Vservers. Attributes: non-creatable, modifiable Possible values:
  • "running" ,
  • "stopped" ,
  • "starting" ,
  • "stopping"
uuid uuid
optional
Universal unique identifier (UUID) for the Vserver. Attributes: non-creatable, non-modifiable
vserver-aggr-info-list vserver-aggr-info[]
optional
List of aggregates assigned to the Vserver with aggregate name and available size.
vserver-name string
optional
Name of the Vserver. Attributes: key, non-creatable, non-modifiable
vserver-type string
optional
Type of the Vserver. Type of the data serving Vservers could be either 'cluster' or 'data'. Possible values: 'cluster', 'data', 'admin' and 'node'. Attributes: non-creatable, non-modifiable

 
Element definition: vserver-modify-iter-info [top]
Information about the modify operation that was attempted/performed against vserver object.
Name Range Type Description
error-code [0..2^32-1] integer
optional
Error code, if the modify operation caused an error.
error-message string
optional
Error description, if the modify operation caused an error.
vserver-key vserver-info
The keys for the vserver object to which the modify operation applies.

 
Element definition: aggr-name [top]
Name of the aggregate
[none]

 
Element definition: antivirus-policy [top]
Antivirus Policy
[none]

 
Element definition: language-code [top]
Language Code.

The following are the possible language codes along with their names:

  • 'C' ... POSIX,
  • 'ar' ... Arabic,
  • 'cs' ... Czech,
  • 'da' ... Danish,
  • 'de' ... German,
  • 'en' ... English,
  • 'en_US' ... English (US),
  • 'es' ... Spanish,
  • 'fi' ... Finnish,
  • 'fr' ... French,
  • 'he' ... Hebrew,
  • 'hr' ... Croatian,
  • 'hu' ... Hungarian,
  • 'it' ... Italian,
  • 'ja' ... Japanese euc-j*,
  • 'ja_v1' ... Japanese euc-j,
  • 'ja_JP.PCK' ... Japanese PCK (sjis)*,
  • 'ja_JP.932' ... Japanese cp932*,
  • 'ja_JP.PCK_v2' ... Japanese PCK (sjis),
  • 'ko' ... Korean,
  • 'no' ... Norwegian,
  • 'nl' ... Dutch,
  • 'pl' ... Polish,
  • 'pt' ... Portuguese,
  • 'ro' ... Romanian,
  • 'ru' ... Russian,
  • 'sk' ... Slovak,
  • 'sl' ... Slovenian,
  • 'sv' ... Swedish,
  • 'tr' ... Turkish,
  • 'zh' ... Simplified Chinese,
  • 'zh.GBK' ... Simplified Chinese (GBK),
  • 'zh_TW' ... Traditional Chinese euc-tw,
  • 'zh_TW.BIG5' ... Traditional Chinese Big 5

To use UTF-8 as the NFS character set, append '.UTF-8' to the language code.

[none]

 
Element definition: nis-domain [top]
NIS Domain
[none]

 
Element definition: nmswitch [top]
file|ldap Possible values:
  • "file" ,
  • "ldap"
[none]

 
Element definition: nsswitch [top]
nis|file|ldap Possible values:
  • "nis" ,
  • "file" ,
  • "ldap"
[none]

 
Element definition: protocol [top]
Vserver protocols. Possible values:
  • "nfs" - NFS protocol,
  • "cifs" - CIFS protocol,
  • "fcp" - FCP protocol,
  • "iscsi" - iSCSI protocol
[none]

 
Element definition: snapshot-policy [top]
Snapshot Policy
[none]

 
Element definition: uuid [top]
The 128-bit universally-unique identifier (UUID).

UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.

[none]

 
Element definition: volume-name [top]
The name of the volume.

Volume names can contain letters, numbers, and the underscore character (_). The first character must be a letter or an underscore. When creating a Cluster-Mode volume, the user can specify at most 203 characters. If the prefix '/vol/' appears in the volume name, it is striped out and the characters that follow the prefix constitute the actual volume name.

Volume names are scoped by their owning Vserver in a cluster, with each Vserver's volume namespace being totally independent. Thus, any Vserver 'S' in a cluster cannot have two volumes with the same name 'V'. However, two different Vservers in the same cluster can each have a volume named 'V'.

For example, any given Vserver in a cluster can only have at most one volume named 'vol0'. However, two different Vservers S1 and S2 in the cluster may each have a volume named 'vol0'.

[none]

 
Element definition: vsadminstate [top]
vserver state Possible values:
  • "running" ,
  • "stopped" ,
  • "starting" ,
  • "stopping"
[none]

 
Element definition: vserver-aggr-info [top]
Assigned aggregate name and available size.
Name Range Type Description
aggr-availsize size
optional
Assigned aggregate available size. Attributes: non-creatable, non-modifiable
aggr-name aggr-name
optional
Assigned aggregate name. Attributes: non-creatable, modifiable

 
Element definition: vserver-info [top]
Vserver Information 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
aggr-list aggr-name[]
optional
The list of aggregates assigned for volume operations. These aggregates could be shared for use with other Vservers. Attributes: non-creatable, modifiable
allowed-protocols protocol[]
optional
Allowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. Attributes: non-creatable, modifiable Possible values:
  • "nfs" - NFS protocol,
  • "cifs" - CIFS protocol,
  • "fcp" - FCP protocol,
  • "iscsi" - iSCSI protocol
antivirus-on-access-policy antivirus-policy
optional
Antivirus policy. default: default Attributes: optional-for-create, modifiable
comment string
optional
Comment. Attributes: optional-for-create, modifiable
disallowed-protocols protocol[]
optional
Disallowed Protocols. If conflicting entries are provided as input to allowed-protocols and disallowed-protocols list, then those entries will become part of the disallowed-protocols list. Attributes: non-creatable, modifiable Possible values:
  • "nfs" - NFS protocol,
  • "cifs" - CIFS protocol,
  • "fcp" - FCP protocol,
  • "iscsi" - iSCSI protocol
language language-code
optional
Specifies the language to use for the Vserver. Default: C. Available language codes are: 'C' .............. POSIX 'ar' ............. Arabic 'cs' ............. Czech 'da' ............. Danish 'de' ............. German 'en' ............. English 'en_US' .......... English (US) 'es' ............. Spanish 'fi' ............. Finnish 'fr' ............. French 'he' ............. Hebrew 'hr' ............. Croatian 'hu' ............. Hungarian 'it' ............. Italian 'ja' ............. Japanese euc-j* 'ja_v1' .......... Japanese euc-j 'ja_JP.PCK' ...... Japanese PCK (sjis)* 'ja_JP.932' ...... Japanese cp932* 'ja_JP.PCK_v2' .... Japanese PCK (sjis) 'ko' ............. Korean 'no' ............. Norwegian 'nl' ............. Dutch 'pl' ............. Polish 'pt' ............. Portuguese 'ro' ............. Romanian 'ru' ............. Russian 'sk' ............. Slovak 'sl' ............. Slovenian 'sv' ............. Swedish 'tr' ............. Turkish 'zh' ............. Simplified Chinese 'zh.GBK' ......... Simplified Chinese (GBK) 'zh_TW' .......... Traditional Chinese euc-tw 'zh_TW.BIG5' ..... Traditional Chinese Big 5 To use UTF-8 as the NFS character set, append '.UTF-8'. Attributes: optional-for-create, non-modifiable
ldap-domain string
optional
LDAP client configuration details. Attributes: non-creatable, non-modifiable
max-volumes [0..2^32-1] integer
optional
The maximum number of volumes that can be created on the Vserver. Attributes: non-creatable, modifiable
name-mapping-switch nmswitch[]
optional
Name Mapping switch configuration details for the Vserver. Possible values: 'file', 'ldap'. default: file Attributes: optional-for-create, modifiable Possible values:
  • "file" ,
  • "ldap"
name-server-switch nsswitch[]
optional
Name Server switch configuration details for the Vserver. Possible values: 'nis', 'file', 'ldap'. Attributes: required-for-create, modifiable Possible values:
  • "nis" ,
  • "file" ,
  • "ldap"
nis-domain nis-domain
optional
NIS domain configuration details for the Vserver. Attributes: non-creatable, non-modifiable
quota-policy string
optional
Quota policy. default: default Attributes: optional-for-create, modifiable
root-volume volume-name
optional
Root volume of the Vserver. Attributes: required-for-create, non-modifiable
root-volume-aggregate aggr-name
optional
The aggregate on which the root volume will be created. Attributes: required-for-create, non-modifiable
root-volume-security-style string
optional
Security Style of the root volume. Possible values: 'unix', 'ntfs', 'mixed'. Attributes: required-for-create, non-modifiable
snapshot-policy snapshot-policy
optional
Snapshot policy setting. default: default Attributes: optional-for-create, modifiable
state vsadminstate
optional
State of the Virtual Server. This field represents the data serving ability of a Vserver, hence is applicable only for Cluster Vservers. Attributes: non-creatable, modifiable Possible values:
  • "running" ,
  • "stopped" ,
  • "starting" ,
  • "stopping"
uuid uuid
optional
Universal unique identifier (UUID) for the Vserver. Attributes: non-creatable, non-modifiable
vserver-aggr-info-list vserver-aggr-info[]
optional
List of aggregates assigned to the Vserver with aggregate name and available size.
vserver-name string
optional
Name of the Vserver. Attributes: key, non-creatable, non-modifiable
vserver-type string
optional
Type of the Vserver. Type of the data serving Vservers could be either 'cluster' or 'data'. Possible values: 'cluster', 'data', 'admin' and 'node'. Attributes: non-creatable, non-modifiable

 
Element definition: aggr-name [top]
Name of the aggregate
[none]

 
Element definition: antivirus-policy [top]
Antivirus Policy
[none]

 
Element definition: language-code [top]
Language Code.

The following are the possible language codes along with their names:

  • 'C' ... POSIX,
  • 'ar' ... Arabic,
  • 'cs' ... Czech,
  • 'da' ... Danish,
  • 'de' ... German,
  • 'en' ... English,
  • 'en_US' ... English (US),
  • 'es' ... Spanish,
  • 'fi' ... Finnish,
  • 'fr' ... French,
  • 'he' ... Hebrew,
  • 'hr' ... Croatian,
  • 'hu' ... Hungarian,
  • 'it' ... Italian,
  • 'ja' ... Japanese euc-j*,
  • 'ja_v1' ... Japanese euc-j,
  • 'ja_JP.PCK' ... Japanese PCK (sjis)*,
  • 'ja_JP.932' ... Japanese cp932*,
  • 'ja_JP.PCK_v2' ... Japanese PCK (sjis),
  • 'ko' ... Korean,
  • 'no' ... Norwegian,
  • 'nl' ... Dutch,
  • 'pl' ... Polish,
  • 'pt' ... Portuguese,
  • 'ro' ... Romanian,
  • 'ru' ... Russian,
  • 'sk' ... Slovak,
  • 'sl' ... Slovenian,
  • 'sv' ... Swedish,
  • 'tr' ... Turkish,
  • 'zh' ... Simplified Chinese,
  • 'zh.GBK' ... Simplified Chinese (GBK),
  • 'zh_TW' ... Traditional Chinese euc-tw,
  • 'zh_TW.BIG5' ... Traditional Chinese Big 5

To use UTF-8 as the NFS character set, append '.UTF-8' to the language code.

[none]

 
Element definition: nis-domain [top]
NIS Domain
[none]

 
Element definition: nmswitch [top]
file|ldap Possible values:
  • "file" ,
  • "ldap"
[none]

 
Element definition: nsswitch [top]
nis|file|ldap Possible values:
  • "nis" ,
  • "file" ,
  • "ldap"
[none]

 
Element definition: protocol [top]
Vserver protocols. Possible values:
  • "nfs" - NFS protocol,
  • "cifs" - CIFS protocol,
  • "fcp" - FCP protocol,
  • "iscsi" - iSCSI protocol
[none]

 
Element definition: size [top]
Size in bytes Range : [0..2^63-1].
[none]

 
Element definition: snapshot-policy [top]
Snapshot Policy
[none]

 
Element definition: uuid [top]
The 128-bit universally-unique identifier (UUID).

UUIDs are formatted as 36-character strings. These strings are composed of 32 hexadecimal characters broken up into five groupings separated by '-'s.The first grouping has 8 hex characters, the second through fourth groupings have four hex characters each, and the fifth and final grouping has 12 hex characters. Note that a leading '0x' is not used.

[none]

 
Element definition: volume-name [top]
The name of the volume.

Volume names can contain letters, numbers, and the underscore character (_). The first character must be a letter or an underscore. When creating a Cluster-Mode volume, the user can specify at most 203 characters. If the prefix '/vol/' appears in the volume name, it is striped out and the characters that follow the prefix constitute the actual volume name.

Volume names are scoped by their owning Vserver in a cluster, with each Vserver's volume namespace being totally independent. Thus, any Vserver 'S' in a cluster cannot have two volumes with the same name 'V'. However, two different Vservers in the same cluster can each have a volume named 'V'.

For example, any given Vserver in a cluster can only have at most one volume named 'vol0'. However, two different Vservers S1 and S2 in the cluster may each have a volume named 'vol0'.

[none]

 
Element definition: vsadminstate [top]
vserver state Possible values:
  • "running" ,
  • "stopped" ,
  • "starting" ,
  • "stopping"
[none]

 
Element definition: vserver-aggr-info [top]
Assigned aggregate name and available size.
Name Range Type Description
aggr-availsize size
optional
Assigned aggregate available size. Attributes: non-creatable, non-modifiable
aggr-name aggr-name
optional
Assigned aggregate name. Attributes: non-creatable, modifiable

 
Element definition: aggr-name [top]
Name of the aggregate
[none]

 
Element definition: size [top]
Size in bytes Range : [0..2^63-1].
[none]