APIs in Category: vserver-peer-transition | Cluster-Mode API version 1.21

vserver-peer-transition-create vserver-peer-transition-destroy vserver-peer-transition-destroy-iter vserver-peer-transition-get vserver-peer-transition-get-iter vserver-peer-transition-modify | transition peer provides mechanism to setup relationships between a Data ONTAP 7-Mode system and a Data ONTAP Cluster-Mode Vserver. This relationship can be used by Cluster Admin to setup Snapmirror transition relationships or delegating these to Vserver Admin. These set of ZAPIs allow either to create or manage transition peer relationships.

NetApp Manage ONTAP

vserver-peer-transition-create | [top]

> Create a new transition peer relationship between a Data ONTAP 7-Mode system and a Data ONTAP Cluster-Mode Vserver

> Input Name | Range | Type | Description
> local-vserver |  | vserver-name | Local Vserver name
> multi-path-address |  | string optional | Additional address for source 7-Mode system
> return-record |  | boolean optional | If set to true, returns the vserver-peer-transition on successful creation. Default: false
> src-filer-name |  | string | Source 7-Mode system
> Output Name | Range | Type | Description
> result |  | vserver-peer-transition-info optional | The vserver-peer-transition created (keys or the entire object if requested)

> Errno | Description
> E_DUPLICATE_PEER_VSERVER_NAME_VSERVER |  |
> E_PEERVSERVER_SAME_LOCALVSERVER |  |

vserver-peer-transition-destroy | [top]

> Deletes a transition peer relationship

> Input Name | Range | Type | Description
> local-vserver |  | vserver-name | Local Vserver name
> src-filer-name |  | string | Source 7-Mode system

> Errno | Description
> E_PEER_RELATIONSHIP_IN_USE |  |

vserver-peer-transition-destroy-iter | [top]

> Deletes multiple transition peer relationship

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple vserver-peer-transition objects match a given query. If set to true, the API will continue deleting the next matching vserver-peer-transition even when the deletion of a previous vserver-peer-transition 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 deletions before the server gives up and returns. If set, the API will continue deleting the next matching vserver-peer-transition even when the deletion of a previous matching vserver-peer-transition fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of vserver-peer-transition objects to delete in this call. Default: 20
> query |  | vserver-peer-transition-info | If deleting a specific vserver-peer-transition, this input element must specify all keys. If deleting multiple vserver-peer-transition 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-peer-transition objects (just keys) that were not deleted due to some error. If set to false, the list of vserver-peer-transition objects not deleted will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of vserver-peer-transition objects (just keys) that were successfully deleted. If set to false, the list of vserver-peer-transition objects deleted 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-peer-transition-destroy-iter-info[] optional | Information about vserver-peer-transition objects that were not deleted 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-peer-transition objects to be deleted.
> num-failed | [0..2^32-1] | integer optional | Number of vserver-peer-transition objects that matched the query, but were not deleted due to some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of vserver-peer-transition objects that matched the query and were successfully deleted.
> success-list |  | vserver-peer-transition-destroy-iter-info[] optional | The vserver-peer-transition objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> E_PEER_RELATIONSHIP_IN_USE |  |

vserver-peer-transition-get | [top]

> Gets a transition peer relationship.

> Input Name | Range | Type | Description
> desired-attributes |  | vserver-peer-transition-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.
> local-vserver |  | vserver-name | Local Vserver name
> src-filer-name |  | string | Source 7-Mode system
> Output Name | Range | Type | Description
> attributes |  | vserver-peer-transition-info | The attributes of the vserver-peer-transition.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

vserver-peer-transition-get-iter | [top]

> Gets list of transition peer relationship.

> Input Name | Range | Type | Description
> desired-attributes |  | vserver-peer-transition-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-transition-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the vserver-peer-transition object. All vserver-peer-transition 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-transition-info[] optional | The list of attributes of vserver-peer-transition objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more vserver-peer-transition objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

vserver-peer-transition-modify | [top]

> Modifies a transition peer relationship

> Input Name | Range | Type | Description
> local-vserver |  | vserver-name | Local Vserver name
> multi-path-address |  | string optional | Additional address for source 7-Mode system
> src-filer-name |  | string | Source 7-Mode system

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]

Element definition: vserver-peer-transition-destroy-iter-info | [top]

> Information about the deletion operation that was attempted/performed against vserver-peer-transition object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the deletion operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> vserver-peer-transition-key |  | vserver-peer-transition-info | The keys for the vserver-peer-transition object to which the deletion applies.

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

> Information about the transition peer. 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
> local-vserver |  | vserver-name optional | Local Vserver name Attributes: key, required-for-create, non-modifiable
> multi-path-address |  | string optional | Additional address for source 7-Mode system Attributes: optional-for-create, modifiable
> src-filer-name |  | string optional | Source 7-Mode system Attributes: key, required-for-create, non-modifiable

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]