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

cluster-peer-create cluster-peer-delete cluster-peer-get cluster-peer-get-iter cluster-peer-health-info-get cluster-peer-health-info-get-iter cluster-peer-modify cluster-peer-ping-iter | This set of ZAPIs allows management of cluster peer relationships. Cluster peer relationships are required to allow multiple Data ONTAP clusters to exchange data with other Data ONTAP clusters and request operations to be executed by other Data ONTAP clusters.

NetApp Manage ONTAP

cluster-peer-create | [top]

> Create a cluster peer relationship

> Input Name | Range | Type | Description
> password |  | string optional | The password required to authenticate with the peer cluster. This value is only used at peer creation time and not stored.
> peer-addresses |  | remote-inet-address[] | The remote intercluster addresses and hostnames of the peer cluster.
> timeout | [25..180] | integer optional | The timeout for operations in the peer cluster in seconds. Default: 15
> user-name |  | string optional | The user name required to authenticate with the peer cluster. This value is only used at peer creation time and not stored.

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

cluster-peer-delete | [top]

> Delete a cluster peer relationship

> Input Name | Range | Type | Description
> cluster-name |  | string | The name of the peer cluster.

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

cluster-peer-get | [top]

> Return the specified peer cluster relationship information

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

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

cluster-peer-get-iter | [top]

> Returns a list of cluster peer relationships

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

> Errno | Description
> EINTERNALERROR |  |

cluster-peer-health-info-get | [top]

> Get the health of the specified peer node

> Input Name | Range | Type | Description
> desired-attributes |  | cluster-peer-health-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.
> destination-cluster |  | cluster-name | The name of the peer cluster.
> destination-node |  | peer-node-name | The name of the node in the peer cluster.
> originating-node |  | node-name | The name of the local node.
> Output Name | Range | Type | Description
> attributes |  | cluster-peer-health-info | The attributes of the cluster-peer.

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

cluster-peer-health-info-get-iter | [top]

> Get the health of all local and peer nodes sequentially

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

> Errno | Description
> EINTERNALERROR |  |

cluster-peer-modify | [top]

> Modifies a cluster peer relationship

> Input Name | Range | Type | Description
> cluster-name |  | string | The name of the peer cluster to modify.
> peer-addresses |  | remote-inet-address[] optional | The Remote IP address or host name of the peer cluster. If not specified, the peer-addresses are not modified.
> timeout |  | integer optional | The timeout for operations in the peer cluster in seconds. If not specified, the timeout is not modified.

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

cluster-peer-ping-iter | [top]

> Ping the specified peer nodes. Ping operations take place between a node in a cluster and a node in a remote cluster. The originating node is the node which initiates the ping operation and the destination cluster and node specify the remote node which is the target of the ping.

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

> Errno | Description
> EINTERNALERROR |  |

Element definition: cluster-name | [top]

> Name of the Peer Cluster

> [none]

Element definition: cluster-peer-health-info | [top]

> Cluster Peer Health Info 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
> bypass-cache |  | boolean optional | When false, do not use cached results. Cached results may not be current, but may be retrieved quickly. Attributes: non-creatable, non-modifiable
> data-ping |  | peer-ping-status optional | The status of Data Ping operation. Possible values are (interface-reachable, unreachable). Attributes: non-creatable, non-modifiable Possible values: "unknown_node" - Unknown Node, "internal_error" - Internal Error, "unreachable" - Unreachable, "session_reachable" - Session Reachable, "interface_reachable" - Interface Reachable
> destination-cluster |  | cluster-name optional | The name of the peer cluster. Attributes: key, non-creatable, non-modifiable
> destination-cluster-uuid |  | string optional | The UUID of the peer cluster. Attributes: non-creatable, non-modifiable
> destination-node |  | peer-node-name optional | The name of the node in the peer cluster. Attributes: key, non-creatable, non-modifiable
> icmp-ping |  | peer-ping-status optional | The status of ICMP Ping operation. Possible values are (interface-reachable, unreachable). Attributes: non-creatable, non-modifiable Possible values: "unknown_node" - Unknown Node, "internal_error" - Internal Error, "unreachable" - Unreachable, "session_reachable" - Session Reachable, "interface_reachable" - Interface Reachable
> is-cluster-healthy |  | boolean optional | The status of peer cluster health. Attributes: non-creatable, non-modifiable
> is-destination-node-available |  | boolean optional | True implies that the destination node is available for intercluster communication. Attributes: non-creatable, non-modifiable
> is-node-healthy |  | boolean optional | The RDB health of the node. True means the node is in quorum. Attributes: non-creatable, non-modifiable
> originating-node |  | node-name optional | The name of the local node. Attributes: key, non-creatable, non-modifiable

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

> Contains information about the cluster 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
> active-addresses |  | remote-inet-address[] optional | The Active IP addresses of the peer cluster. Attributes: non-creatable, non-modifiable
> availability |  | cluster-peer-avail optional | The status of the peer cluster connection. Attributes: non-creatable, non-modifiable Possible values: "unavailable" , "available"
> cluster-name |  | string optional | The name of the peer cluster. Attributes: key, non-creatable, non-modifiable
> cluster-uuid |  | string optional | The UUID of the peer cluster. Attributes: non-creatable, non-modifiable
> peer-addresses |  | remote-inet-address[] optional | The Remote IP address or host name of the peer cluster. Attributes: non-creatable, modifiable
> remote-cluster-name |  | string optional | The current name of the peer cluster. Attributes: non-creatable, non-modifiable
> serial-number |  | cluster-serial-number optional | This is an assigned serial number of peer cluster. It is assigned at the time of cluster create. Attributes: non-creatable, non-modifiable
> timeout | [25..180] | integer optional | The timeout for operations in the peer cluster in seconds. Default: 15 Attributes: non-creatable, modifiable

Element definition: cluster-peer-ping-info | [top]

> Cluster Peer Ping Configuration 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
> count | [1..255] | integer optional | The total number of times to ping. Attributes: key, non-creatable, non-modifiable
> current-count | [0..2^32-1] | integer optional | The current ping count. Attributes: key, non-creatable, non-modifiable
> destination-address |  | ip-address optional | The active IP address of the node. Attributes: key, non-creatable, non-modifiable
> destination-cluster |  | cluster-name optional | The name of the destination cluster. Attributes: key, non-creatable, non-modifiable
> destination-cluster-uuid |  | string optional | The UUID of the destination cluster. Attributes: non-creatable, non-modifiable
> destination-node |  | string optional | The name of the destination node. Attributes: key, non-creatable, non-modifiable
> originating-node |  | node-name optional | The name of the originating node. Attributes: key, non-creatable, non-modifiable
> ping-status |  | peer-ping-status optional | The status of the ping operation. Attributes: non-creatable, non-modifiable Possible values: "unknown_node" - Unknown Node, "internal_error" - Internal Error, "unreachable" - Unreachable, "session_reachable" - Session Reachable, "interface_reachable" - Interface Reachable
> round-trip | [0..2^64-1] | integer optional | The roundtrip response time of ping operation in microseconds. Attributes: non-creatable, non-modifiable
> time-to-live | [0..2^32-1] | integer optional | The Time to Live (remaining hops). Attributes: non-creatable, non-modifiable
> timeout | [0..2^32-1] | integer optional | The timeout to use when pinging the peer cluster in seconds. Default: 15 Attributes: non-creatable, non-modifiable
> type |  | peer-ping-protocol optional | The network protocol to use when performing the ping operation. Attributes: non-creatable, non-modifiable Possible values: "data" - Data Ping, "icmp" - ICMP Ping

Element definition: node-name | [top]

> The node's name

> [none]

Element definition: peer-node-name | [top]

> The name of a node in a peer cluster

> [none]

Element definition: remote-inet-address | [top]

> IPv4 Address or Host Name

> [none]

Element definition: cluster-name | [top]

> Name of the Peer Cluster

> [none]

Element definition: cluster-peer-avail | [top]

> The availability of the peer cluster. Possible values: "unavailable" , "available"

> [none]

Element definition: cluster-serial-number | [top]

> Assigned Cluster serial-number during cluster create

> [none]

Element definition: ip-address | [top]

> IPv4 and IPv6 address

> [none]

Element definition: peer-ping-protocol | [top]

> The network protocol to use when performing the ping operation. Possible values: "data" - Data Ping, "icmp" - ICMP Ping

> [none]

Element definition: peer-ping-status | [top]

> The status of the ping operation. Possible values: "unknown_node" - Unknown Node, "internal_error" - Internal Error, "unreachable" - Unreachable, "session_reachable" - Session Reachable, "interface_reachable" - Interface Reachable

> [none]