Retrieve information about a MetroCluster interconnect for a partner type and adapter
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /cluster/metrocluster/interconnects/{node.uuid}/{partner_type}/{adapter}
Introduced In: 9.8
Retrieves information about a MetroCluster Interconnect for a specific partner type and adapter.
Related ONTAP Commands
-
metrocluster interconnect show
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
node.uuid |
string |
path |
True |
Node UUID |
partner_type |
string |
path |
True |
DR Partner type |
adapter |
string |
path |
True |
Interconnect adapter. |
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
adapter |
string |
Adapter |
interfaces |
array[interfaces] |
List of objects which contain interface information such as its IP address, netmask and gateway. |
node |
||
partner_type |
string |
Partner type |
state |
string |
Adapter status |
type |
string |
Adapter type |
vlan_id |
integer |
VLAN ID |
Example response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"adapter": "string",
"interfaces": [
{
"address": "10.10.10.7",
"gateway": "10.1.1.1",
"netmask": "24"
}
],
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"partner_type": "string",
"state": "string",
"type": "string",
"vlan_id": 0
}
Error
Status: Default
ONTAP 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. |
2427132 |
MetroCluster is not configured on this cluster. |
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 |
interfaces
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. |
_links
Name | Type | Description |
---|---|---|
self |
node
Name | Type | Description |
---|---|---|
_links |
||
name |
string |
|
uuid |
string |
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. |