APIs in Category: vserver-peer | Vserver API version 1.21

vserver-peer-get vserver-peer-get-iter | Vserver peering provides a mechanism to setup relationships between two Vservers. Relationship thus created can be used by cluster administrator to setup application (SnapMirror) relationships or delegate these to Vserver administrator. This set of APIs allow to create and manage Vserver peer relationships.

NetApp Manage ONTAP

vserver-peer-get | [top]

> Display information about Vserver peer relationships. Displays the local Vserver, peer Vserver and the state of the peering relationship.

> Input Name | Range | Type | Description
> desired-attributes |  | vserver-peer-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.
> peer-vserver |  | string | Specifies name of the peer Vserver in the relationship
> Output Name | Range | Type | Description
> attributes |  | vserver-peer-info | The attributes of the vserver-peer.

> Errno | Description
> EVSERVERNOTFOUND |  |
> EPEERVSERVERNOTFOUND |  |
> EINTERNALERROR |  |

vserver-peer-get-iter | [top]

> Display information about Vserver peer relationships. If the API is issued to the Cluster LIF, 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-peer-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..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | vserver-peer-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-peer object. All vserver-peer 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-peer-info[] optional | The list of attributes of vserver-peer objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more vserver-peer objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EVSERVERNOTFOUND |  |
> E_PEERVSERVER_NOT_FOUND |  |
> EINTERNALERROR |  |

Element definition: vserver-peer-info | [top]

> Contains information about the Vserver peer relationship(s). 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
> applications |  | vserver-peer-application[] optional | Applications which can make use of the peering relationship. This value is not shown and cannot be set in desired-attributes when the API is issued on Vserver LIF. Attributes: non-creatable, non-modifiable Possible values: "snapmirror"
> peer-cluster |  | string optional | Specifies name of the peer Cluster. If peer Cluster is not given, it considers local Cluster. This value is not shown and cannot be set in desired-attributes when the API is issued on Vserver LIF. Attributes: non-creatable, non-modifiable
> peer-state |  | vserver-peer-state optional | State of the Vserver peer relationship Attributes: non-creatable, non-modifiable Possible values: "peered" - Vserver peer relationship is established and the respective applications can use peer relationship, "pending" - Vserver peer relationship is initiated in the peer Cluster and local cluster needs to accept the request, "initializing" - Communicating to the peer cluster for initializing the peering relationship, "initiated" - Relationship initiated in local Cluster, "rejected" - Relationship initiated and peer Cluster rejected the same, "suspended" - Relationship got suspended, should not initiate any data transfers , "deleted" - Relationship got deleted on peer Cluster
> peer-vserver |  | string optional | Specifies name of the peer Vserver in the relationship Attributes: key, non-creatable, non-modifiable
> vserver |  | string optional | Specifies name of the local Vserver in the relationship Attributes: key, non-creatable, non-modifiable

Element definition: vserver-peer-application | [top]

> Application using the Vserver peering relationship Possible values: "snapmirror"

> [none]

Element definition: vserver-peer-state | [top]

> peered|pending|initializing|initiated|rejected|suspended|deleted Possible values: "peered" - Vserver peer relationship is established and the respective applications can use peer relationship, "pending" - Vserver peer relationship is initiated in the peer Cluster and local cluster needs to accept the request, "initializing" - Communicating to the peer cluster for initializing the peering relationship, "initiated" - Relationship initiated in local Cluster, "rejected" - Relationship initiated and peer Cluster rejected the same, "suspended" - Relationship got suspended, should not initiate any data transfers , "deleted" - Relationship got deleted on peer Cluster

> [none]