APIs in Category: vserver
Vserver API version 1.15

 
vserver-get
vserver-get-iter
This set of ZAPIs allows to manage a Vserver.

NetApp Manage ONTAP
 
vserver-get [top]

Get the attributes of the vserver.
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.
 
Output Name Range Type Description
attributes vserver-info
The attributes of the vserver.
 Errno  Description
 EINTERNALERROR
 EVSERVERNOTFOUND

 
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

 
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: 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]