Skip to content

failoverGroupWorkloads

Retrieves workloads within a failover group for high-availability management.

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 workloads for.
filter FailoverGroupWorkloadFilter Filters to apply to the query.

Returns

FailoverGroupWorkloadConnection!

Sample

query FailoverGroupWorkloads($failoverGroupId: UUID!) {
  failoverGroupWorkloads(
    failoverGroupId: $failoverGroupId
    first: 10
  ) {
    nodes {
      counterpartIds
      hostIds
      hostNames
      location
      locationId
      managedObjectType
      name
      primaryClusterUuid
      status
      statusMessage
      workloadId
      workloadType
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "failoverGroupId": "00000000-0000-0000-0000-000000000000"
}

{
  "data": {
    "failoverGroupWorkloads": {
      "nodes": [
        [
          {
            "counterpartIds": [
              "00000000-0000-0000-0000-000000000000"
            ],
            "hostIds": [
              "00000000-0000-0000-0000-000000000000"
            ],
            "hostNames": [
              "example-string"
            ],
            "location": "example-string",
            "locationId": "example-string",
            "managedObjectType": "ACTIVE_DIRECTORY_DOMAIN"
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}