Retrieve MetroCluster status and configuration details
Suggest changes
PDFs
GET /cluster/metrocluster
Introduced In: 9.8
Retrieves MetroCluster status and configuration details.
Related ONTAP commands * metrocluster show * metrocluster node show
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
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 |
desc] direction. Default direction is 'asc' for ascending. |
fields |
array[string] |
query |
False |
Response
Status: 200, Ok| Name | Type | Description |
|---|---|---|
_links |
||
enabled |
boolean |
|
local |
||
remote |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"local": {
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"configuration_state": "string",
"mode": "string"
},
"remote": {
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"configuration_state": "string",
"mode": "string"
}
}Error
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
2425734 |
An internal error occurred. Wait a few minutes, and try the operation again. For further assistance, contact technical support. |
| 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 |
self_link
| Name | Type | Description |
|---|---|---|
self |
_links
| Name | Type | Description |
|---|---|---|
self |
node
Local node of the DR Group.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
partner
Partner node of the DR Group.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
dr_pairs
| Name | Type | Description |
|---|---|---|
node |
Local node of the DR Group. |
|
partner |
Partner node of the DR Group. |
cluster
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
local
| Name | Type | Description |
|---|---|---|
cluster |
||
configuration_state |
string |
Indicates the state of the local cluster configuration. |
mode |
string |
Specifies the mode of operation of the local cluster. |
partner_cluster_reachable |
boolean |
Specifies whether the partner cluster is reachable from the local cluster. |
periodic_check_enabled |
boolean |
Indicates whether or not a periodic check is enabled on the local cluster. |
ipv4_interface
Object to setup an interface along with its default router.
| Name | Type | Description |
|---|---|---|
address |
string |
IPv4 or IPv6 address |
gateway |
string |
The IPv4 or IPv6 address of the default router. |
netmask |
string |
Input as netmask length (16) or IPv4 mask (255.255.0.0). For IPv6, the default value is 64 with a valid range of 1 to 127. Output is always netmask length. |
l3_config
| Name | Type | Description |
|---|---|---|
ipv4_interface |
Object to setup an interface along with its default router. |
node
Node information
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
mccip_ports
Port configuration specification. l3_config information is only needed when configuring a MetroCluster IP for use in a layer 3 network.
| Name | Type | Description |
|---|---|---|
l3_config |
||
name |
string |
Port name |
node |
Node information |
|
uuid |
string |
Port UUID |
vlan_id |
integer |
VLAN ID |
dr_group
DR group reference.
| Name | Type | Description |
|---|---|---|
id |
integer |
DR Group ID |
peer_cluster
The peer cluster that the mediator service is used for.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
mediator
Mediator information
| Name | Type | Description |
|---|---|---|
dr_group |
DR group reference. |
|
ip_address |
string |
The IP address of the mediator. |
peer_cluster |
The peer cluster that the mediator service is used for. |
|
port |
integer |
The REST server's port number on the mediator. |
reachable |
boolean |
Indicates the connectivity status of the mediator. |
uuid |
string |
The unique identifier for the mediator service. |
partner_cluster
Partner cluster information.
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
remote
| Name | Type | Description |
|---|---|---|
cluster |
||
configuration_state |
string |
Indicates the state of the remote cluster configuration. |
mode |
string |
Specifies the mode of operation of the remote cluster. |
periodic_check_enabled |
boolean |
Indicates whether or not a periodic check is enabled on the remote cluster. |
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. |