Skip to content

failoverGroupHosts

Get all hosts for a given failover group.

Arguments

Argument Type Description
first Int Returns the first n elements from the list.
after String An opaque cursor returned from a previous query's endCursor field. Pass this value verbatim to retrieve the next page of results.
last Int Returns the last n elements from the list.
before String An opaque cursor returned from a previous query's startCursor field. Pass this value verbatim to retrieve the previous page of results.
failoverGroupId (required) UUID! Failover group ID to get hosts for.
filter FailoverGroupHostFilter Filters to apply to the query.

Returns

FailoverGroupHostConnection!

Sample

query FailoverGroupHosts($failoverGroupId: UUID!) {
  failoverGroupHosts(
    failoverGroupId: $failoverGroupId
    first: 10
  ) {
    nodes {
      activeClusterUuid
      counterpartIds
      hostId
      hostName
      hostStatus
      hostType
      numberOfObjects
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}
{
  "failoverGroupId": "00000000-0000-0000-0000-000000000000"
}
{
  "data": {
    "failoverGroupHosts": {
      "nodes": [
        [
          {
            "activeClusterUuid": "00000000-0000-0000-0000-000000000000",
            "counterpartIds": [
              "00000000-0000-0000-0000-000000000000"
            ],
            "hostId": "00000000-0000-0000-0000-000000000000",
            "hostName": "example-string",
            "hostStatus": "FAILOVER_GROUP_STATUS_DELETING",
            "hostType": "HOST_REGISTER_OS_TYPE_AIX"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}