Skip to main content

Cluster MetroCluster interconnects endpoint overview

Contributors
PDFs

Overview

You can use this API to retrieve and display relevant information pertaining to MetroCluster interconnect status. The /cluster/metrocluster/interconnects endpoint returns a list of all the interconnects in MetroCluster and their status. Each individual interconnect can be queried individually using the /cluster/metrocluster/interconnects/{node.uuid}/{partner_type}/{adapter} endpoint. You can also use this API to modify relevant information related to MetroCluster interconnect. These include address, netmask, and gateway. Modify a MetroCluster interconnect using the /cluster/metrocluster/interconnects/{node.uuid}/{partner_type}/{adapter} endpoint.

Examples

Retrieving MetroCluster interconnects

GET https://<mgmt-ip>/api/cluster/metrocluster/interconnects
{
  "records": [
      {
          "node": {
              "name": "cluster1_01",
              "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                  }
              }
          },
          "partner_type": "ha",
          "adapter": "e0f",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/ha/e0f"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_01",
              "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                  }
              }
          },
          "partner_type": "ha",
          "adapter": "e0g",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/ha/e0g"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_01",
              "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                  }
              }
          },
          "partner_type": "dr",
          "adapter": "e0f",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/dr/e0f"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_01",
              "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                  }
              }
          },
          "partner_type": "dr",
          "adapter": "e0g",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/dr/e0g"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_01",
              "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                  }
              }
          },
          "partner_type": "aux",
          "adapter": "e0f",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/aux/e0f"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_01",
              "uuid": "6fead8fe-8d81-11e9-b5a9-005056826931",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/6fead8fe-8d81-11e9-b5a9-005056826931"
                  }
              }
          },
          "partner_type": "aux",
          "adapter": "e0g",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/6fead8fe-8d81-11e9-b5a9-005056826931/aux/e0g"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_02",
              "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                  }
              }
          },
          "partner_type": "ha",
          "adapter": "e0f",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/ha/e0f"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_02",
              "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                  }
              }
          },
          "partner_type": "ha",
          "adapter": "e0g",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/ha/e0g"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_02",
              "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                  }
              }
          },
          "partner_type": "dr",
          "adapter": "e0f",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/dr/e0f"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_02",
              "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                  }
              }
          },
          "partner_type": "dr",
          "adapter": "e0g",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/dr/e0g"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_02",
              "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                  }
              }
          },
          "partner_type": "aux",
          "adapter": "e0f",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/aux/e0f"
              }
          }
      },
      {
          "node": {
              "name": "cluster1_02",
              "uuid": "f5435191-8d81-11e9-9d4b-00505682dc8b",
              "_links": {
                  "self": {
                      "href": "/api/cluster/nodes/f5435191-8d81-11e9-9d4b-00505682dc8b"
                  }
              }
          },
          "partner_type": "aux",
          "adapter": "e0g",
          "_links": {
              "self": {
                  "href": "/api/cluster/metrocluster/interconnects/f5435191-8d81-11e9-9d4b-00505682dc8b/aux/e0g"
              }
          }
      }
  ],
  "num_records": 12,
  "_links": {
      "self": {
          "href": "/api/cluster/metrocluster/interconnects"
      }
  }
}

Retrieves information about a specific MetroCluster interconnect

https://<mgmt-ip>/api/cluster/metrocluster/interconnects/774b4fbc-86f9-11e9-9051-005056825c71/aux/e0f
{
  "node": {
      "name": "cluster1_01",
      "uuid": "46147363-9857-11e9-9a55-005056828eb9",
      "_links": {
          "self": {
              "href": "/api/cluster/nodes/46147363-9857-11e9-9a55-005056828eb9"
          }
      }
  },
  "partner_type": "aux",
  "adapter": "e0f",
  "state": "up",
  "type": "iwarp",
  "interfaces": [
    {
      "address": "10.2.3.5",
      "netmask": "255.255.255.0"
    }
  ],
  "mirror": {
      "state": "online",
      "enabled": true
  },
  "multipath_policy": "static_map",
  "_links": {
      "self": {
          "href": "/api/cluster/metrocluster/interconnects/46147363-9857-11e9-9a55-005056828eb9/ha/e0f"
      }
  }
}

This example shows how to modify the network address assigned to the home port. Fields required: address.

curl -X PATCH https://<mgmt-ip>/api/cluster/metrocluster/interconnects/3e1bfd38-ffd2-11eb-bcb7-005056aceaa9/ha/e0g -d '{"interfaces": [{"address": "1.2.3.4"}]}'

PATCH Response

HTTP/1.1 200 OK
Cache-Control: no-cache,no-store,must-revalidate
Connection: close
Date: Fri, 20 Aug 2021 21:58:36 GMT
Server: libzapid-httpd
Content-Length: 3
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
{
}

This example shows how to modify the netmask assigned to the interface. Be sure to change to a valid subnet. Fields required: netmask.

curl -X PATCH https://<mgmt-ip>/api/cluster/metrocluster/interconnects/3e1bfd38-ffd2-11eb-bcb7-005056aceaa9/ha/e0g -d '{"interfaces": [{"netmask": "2.2.2.2"}]}'

PATCH Response

HTTP/1.1 200 OK
Cache-Control: no-cache,no-store,must-revalidate
Connection: close
Date: Fri, 20 Aug 2021 22:11:35 GMT
Server: libzapid-httpd
Content-Length: 3
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
{
}

This example shows how to modify the gateway assigned to the interface. Please make sure to update it on the switch/router first. Assuming it is a new one, the new gateway and IP address must reside in the same subnet range as the interface IP address. Fields required: gateway.

curl -X PATCH https://<mgmt-ip>/api/cluster/metrocluster/interconnects/3e1bfd38-ffd2-11eb-bcb7-005056aceaa9/ha/e0g -d '{"interfaces": [{"gateway": "1.2.3.4"}]}'

PATCH Response

HTTP/1.1 200 OK
Cache-Control: no-cache,no-store,must-revalidate
Connection: close
Date: Fri, 20 Aug 2021 22:11:35 GMT
Server: libzapid-httpd
Content-Length: 3
Content-Type: application/hal+json
X-Content-Type-Options: nosniff
{
}