REST API reference
Retrieve diagnostic operation results for a MetroCluster configuration
Suggest changes
PDFs
GET /cluster/metrocluster/diagnostics
Introduced In: 9.8
Retrieves the results of a completed diagnostic operation for the MetroCluster configuration.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
component |
string |
query |
False |
MetroCluster diagnostic component name |
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 |
|---|---|---|
components |
array[metrocluster_diag_component] |
Example response
{
"components": [
{
"aggregates": [
{
"aggregate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "aggr1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"check": "string",
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"details": "string",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"state": "string"
}
],
"clusters": [
{
"check": "string",
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"details": "string",
"state": "string",
"timestamp": "2016-03-10T14:35:16-08:00"
}
],
"connections": [
{
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"config_error_info": "string",
"config_state": "string",
"destination_address": "10.10.10.7",
"dr_group": {
"id": 0
},
"home_port": "string",
"mtu_error_details": "string",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"partner_cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"partner_node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"partner_type": "string",
"ping_error_details": "string",
"relationship_type": "string",
"source_address": "10.10.10.7",
"state": "string",
"storage_error_details": "string"
}
],
"details": "string",
"lifs": [
{
"check": "string",
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"details": "string",
"lif": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"ip": {
"address": "10.10.10.7"
},
"name": "lif1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"state": "string",
"vserver": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
],
"nodes": [
{
"check": "string",
"cluster": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cluster1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"details": "string",
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"state": "string"
}
],
"state": "string",
"timestamp": "2016-03-10T14:35:16-08:00",
"type": "string",
"volumes": [
{
"check": "string",
"details": "string",
"state": "string",
"volume": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "volume1",
"uuid": "028baa66-41bd-11e9-81d5-00a0986138f7"
},
"vserver": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
]
}
]
}Error
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
2427132 |
MetroCluster is not configured on this cluster. |
Definitions
See Definitions
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
| Name | Type | Description |
|---|---|---|
self |
aggregate
Aggregate
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
cluster
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
node
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
metrocluster_diag_component_aggr
| Name | Type | Description |
|---|---|---|
aggregate |
Aggregate |
|
check |
string |
Type of check run on the component. |
cluster |
||
details |
string |
Additional information or recovery steps to take. |
node |
||
state |
string |
Status of the diagnostic operation on this component. |
metrocluster_diag_component_cluster
| Name | Type | Description |
|---|---|---|
check |
string |
Type of check run on the component. |
cluster |
||
details |
string |
Additional information or recovery steps to take. |
state |
string |
Status of the diagnostic operation on this component. |
timestamp |
string |
Time of the most recent check. |
dr_group
DR group reference.
| Name | Type | Description |
|---|---|---|
id |
integer |
DR Group ID |
partner_cluster
Partner Cluster information
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
partner_node
Partner Node information
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
metrocluster_diag_component_connection
| Name | Type | Description |
|---|---|---|
cluster |
||
config_error_info |
string |
Configuration error information. |
config_state |
string |
Configuration state of the connection. |
destination_address |
string |
Destination IP Address |
dr_group |
DR group reference. |
|
home_port |
string |
Home port |
mtu_error_details |
string |
Additional information or recovery steps associated with mtu size errors. |
node |
||
partner_cluster |
Partner Cluster information |
|
partner_node |
Partner Node information |
|
partner_type |
string |
Partner's assigned role in a DR group. |
ping_error_details |
string |
Additional information or recovery steps associated with ping errors. |
relationship_type |
string |
This node's assigned role in a DR group. |
source_address |
string |
Source IP Address |
state |
string |
Status of diagnostic operation on this component. |
storage_error_details |
string |
Additional information or recovery steps associated with storage errors. |
ip
IP information
| Name | Type | Description |
|---|---|---|
address |
string |
IPv4 or IPv6 address |
lif
| Name | Type | Description |
|---|---|---|
_links |
||
ip |
IP information |
|
name |
string |
The name of the interface. |
uuid |
string |
The UUID that uniquely identifies the interface. |
vserver
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
metrocluster_diag_component_lif
| Name | Type | Description |
|---|---|---|
check |
string |
Type of check run on the component. |
cluster |
||
details |
string |
Additional information or recovery steps to take. |
lif |
||
state |
string |
Status of the diagnostic operation on this component. |
vserver |
metrocluster_diag_component_node
| Name | Type | Description |
|---|---|---|
check |
string |
Type of check run on the component. |
cluster |
||
details |
string |
Additional information or recovery steps to take. |
node |
||
state |
string |
Status of the diagnostic operation on this component. |
volume
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
The name of the volume. |
uuid |
string |
Unique identifier for the volume. This corresponds to the instance-uuid that is exposed in the CLI and ONTAPI. It does not change due to a volume move.
|
metrocluster_diag_component_volume
| Name | Type | Description |
|---|---|---|
check |
string |
Type of check run on the component. |
details |
string |
Additional information or recovery steps to take. |
state |
string |
Status of diagnostic operation on this component. |
volume |
||
vserver |
metrocluster_diag_component
| Name | Type | Description |
|---|---|---|
aggregates |
This object contains details of the aggregate checks when the state associated with the check is "warning". |
|
clusters |
This object contains details of the cluster checks when the state associated with the check is "warning". |
|
connections |
This object contains details of the connections checks the state associated with the check is "warning". |
|
details |
string |
Additional information or recovery steps to take. |
lifs |
This object contains details of the interface checks when the state associated with the check is "warning". |
|
nodes |
This object contains details of the node checks when the state associated with the check is "warning". |
|
state |
string |
Status of diagnostic operation for this component. |
timestamp |
string |
Time of the most recent diagnostic operation for this component |
type |
string |
MetroCluster diagnostic component name |
volumes |
This object contains details of the volume checks when the state associated with the check is "warning". |