REST API reference
Retrieve cluster peers
Suggest changes
PDFs
GET /cluster/peers
Introduced In: 9.6
Retrieves the collection of cluster peers.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
fields |
array[string] |
query |
False |
Specify the fields to return. |
max_records |
integer |
query |
False |
Limit the number of records returned. |
return_records |
boolean |
query |
False |
The default is true for GET calls. When set to false, only the number of records is returned.
|
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.
|
order_by |
array[string] |
query |
False |
Order results by specified fields and optional [asc |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records |
records |
array[cluster_peer] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"records": [
{
"_links": {
"interfaces": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"authentication": {
"expiry_time": "P1DT2H3M4S or '2017-01-25T11:20:13Z'",
"in_use": "string",
"passphrase": "string",
"state": "string"
},
"encryption": {
"proposed": "string",
"state": "string"
},
"initial_allowed_svms": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
],
"ipspace": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "exchange",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"local_network": {
"broadcast_domain": "bd1",
"gateway": "10.1.1.1",
"interfaces": [
{
"ip_address": "10.10.10.7"
}
],
"netmask": "255.255.0.0"
},
"name": "cluster2",
"peer_applications": [
"snapmirror",
"flexcache"
],
"remote": {
"ip_addresses": [
"10.10.10.7"
],
"name": "cluster2",
"serial_number": "4048820-60-9"
},
"status": {
"state": "available",
"update_time": "2017-01-25T11:20:13Z"
},
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412",
"version": {
"full": "NetApp Release 9.4.0: Sun Nov 05 18:20:57 UTC 2017",
"generation": 9,
"major": 4,
"minor": 0
}
}
]
}Error
Status: Default, Error| Name | Type | Description |
|---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
interfaces |
||
self |
authentication
| Name | Type | Description |
|---|---|---|
expiry_time |
string |
The time when the passphrase will expire, in ISO 8601 duration format or date and time format. The default is 1 hour. |
generate_passphrase |
boolean |
Auto generate a passphrase when true. |
in_use |
string |
|
passphrase |
string |
A password to authenticate the cluster peer relationship. |
state |
string |
encryption
| Name | Type | Description |
|---|---|---|
proposed |
string |
|
state |
string |
_links
| Name | Type | Description |
|---|---|---|
self |
initial_allowed_svms
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
ipspace
The IPspace of the local intercluster LIFs.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
IPspace name |
uuid |
string |
IPspace UUID |
interfaces
| Name | Type | Description |
|---|---|---|
ip_address |
string |
IPv4 or IPv6 address |
local_network
Cluster peering requires an intercluster LIF on each local node. These can be optionally created by specifying a list of IP addresses corresponding to each node.
| Name | Type | Description |
|---|---|---|
broadcast_domain |
string |
Broadcast domain that is in use within the IPspace. |
gateway |
string |
The IPv4 or IPv6 address of the default router. |
interfaces |
array[interfaces] |
|
netmask |
string |
IPv4 mask or netmask length. |
remote
| Name | Type | Description |
|---|---|---|
ip_addresses |
array[string] |
The IPv4 addresses, IPv6 addresses, or hostnames of the peers. |
name |
string |
The name of the remote cluster. |
serial_number |
string |
The serial number of the remote cluster. |
status
| Name | Type | Description |
|---|---|---|
state |
string |
|
update_time |
string |
The last time the state was updated. |
version
This returns the cluster version information. When the cluster has more than one node, the cluster version is equivalent to the lowest of generation, major, and minor versions on all nodes.
| Name | Type | Description |
|---|---|---|
full |
string |
The full cluster version string. |
generation |
integer |
The generation portion of the version. |
major |
integer |
The major portion of the version. |
minor |
integer |
The minor portion of the version. |
cluster_peer
| Name | Type | Description |
|---|---|---|
_links |
||
authentication |
||
encryption |
||
initial_allowed_svms |
array[initial_allowed_svms] |
The local SVMs allowed to peer with the peer cluster's SVMs. This list can be modified until the remote cluster accepts this cluster peering relationship. |
ipspace |
The IPspace of the local intercluster LIFs. |
|
local_network |
Cluster peering requires an intercluster LIF on each local node. These can be optionally created by specifying a list of IP addresses corresponding to each node. |
|
name |
string |
Optional name for the cluster peer relationship. By default, it is the name of the remote cluster. |
peer_applications |
array[string] |
Peering applications against which allowed SVMs are configured. |
remote |
||
status |
||
uuid |
string |
UUID of the cluster peer relationship. For anonymous cluster peer offers, the UUID will change when the remote cluster accepts the relationship. |
version |
This returns the cluster version information. When the cluster has more than one node, the cluster version is equivalent to the lowest of generation, major, and minor versions on all nodes. |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |