APIs in Category: vserver |
API version 6.1 |
vserver-iter |
vserver-iter | [top] |
Iterates through list of Vservers
Input Name Range Type Description max-records integer
optional
The maximum number of records per return batch the caller wants to receive. The server may return smaller batch sizes based on performance constraints. If this field is not provided, then the server will return default number of records based on server performance. resource-filter resource-key
optional
Resource by which to filter the result set. Any resource-filters specified in the first call must be included in subsequent calls. The allowed object types for this argument are: If resource-filter identifies a vserver, that single vserver will be returned. If resource-filter resolves to more than one vserver, all of them will be returned. If no resource-filter is provided, all vservers will be listed.
- cluster
- vserver
tag string
optional
Specify the tag from the last call. It is not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call. Any resource-filters specified in the first call must be included in subsequent calls. Output Name Range Type Description next-tag string
optional
Tag for the next call. Not present when there are no more objects to return. num-records integer
The number of records returned in this call. records vserver-info[]
optional
The list of records.
Element definition: resource-key | [top] |
A self-describing string identifier for a managed resource.
[none]
Element definition: vserver-info | [top] |
Vserver's information.
Name Range Type Description aggr-list resource-key[]
The list of aggregates assigned for volume operations. These aggregates could be shared for use with other Vservers. cifs-domain-info cifs-domain-info
optional
CIFS domain information of the Vserver. cluster-name string
Name of the cluster where the Vserver is present. cluster-resource-key resource-key
Resource key of the cluster where the Vserver is present. dns-domains dns-domain-name[]
optional
An array of dns domain names for the Vserver. is-dns-enabled boolean
optional
Specifies if dns service is enabled for the Vserver. is-kerberos-enabled boolean
optional
Specifies if Kerberos security is enabled for the Vserver. is-ldap-client-enabled boolean
optional
Specifies if LDAP client configuration is enabled for the Vserver. is-nis-enabled boolean
optional
Specifies if nis service is enabled for the Vserver. is-repository boolean
Specifies if the Vserver contains Infinite Volume. name-server-switches name-server-switch[]
An array of name server switch configuration details for the Vserver. nis-domain-name string
optional
Active nis domain name for the Vserver. root-volume-name string
Name of the Vserver root volume. service-statuses vserver-service-status[]
List of services and their statuses. vserver-name string
Name of the Vserver. Length: [1..255] vserver-resource-key resource-key
Resource key of the Vserver. vserver-state string
Current state of the Vserver. Possible values: "running", "stopped", "starting" or "stopping". vserver-status obj-status
Current status of the Vserver based on all events.
Element definition: cifs-domain-info | [top] |
Details of the cifs domain.
Name Range Type Description cifs-dns-domain-name string
Specifies the CIFS DNS domain name. Maximum length: 255 characters. */ cifs-domain-name string
Specifies the NETBIOS name of the cifs domain. Maximum length: 255 characters.
Element definition: dns-domain-name | [top] |
DNS domain name for the Vserver.
[none]
Element definition: name-server-switch | [top] |
Name server switch configuration details for the Vserver
[none]
Element definition: obj-status | [top] |
A status value which can be associated with an object. This typedef is an alias for the builtin ZAPI type string. The severity associated with an event has this type. Possible values are: 'normal', 'warning', 'error', 'critical'.
In some contexts, it is important that severities are ordered (as above). For example, an alert might be triggered if an event with a given severity "or worse" occurs. In this example, worse means "after" in the list above.
- normal: An object has normal status when it is working within the thresholds specified.
- warning: An object has the warning status when an event related to the object occurred that an administrator should know about. The event will not cause service disruption.
- error: An object has error status when it does not cause any service disruption, but it may affect performance.
- critical: An object has critical status when it is still performing, but service disruption may occur if corrective action is not taken immediately.
[none]
Element definition: resource-key | [top] |
A self-describing string identifier for a managed resource.
[none]
Element definition: vserver-service-status | [top] |
Status indicating whether a service is up or down.
Name Range Type Description service string
optional
Name of the service. Possible values: "nfs", "cifs", "iscsi" or "fcp". status string
optional
Indicates whether the service is up or not. Possible values: "up", "down".