REST API - list
  1. Operations
  2. vcenter
  3. trusted infrastructure
  4. trust authority clusters

vcenter trusted infrastructure trust authority clusters: list

Returns a list of clusters for this vCenter instance which matches the vcenter.trusted_infrastructure.trust_authority_clusters.filter_spec. This operation was added in vSphere API 7.0.0.

Request:

HTTP request

GET https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters

?cluster={value-1}
&cluster={value-2}
&state={value-1}
&state={value-2}

Query Parameters:

Name Type Description
bold = required
cluster string[] Identifies the cluster. This attribute was added in vSphere API 7.0.0.

Optional. cluster If {@term.unset} return all Trust Authority Clusters.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ClusterComputeResource.
state string[] The state of the vcenter.trusted_infrastructure.trust_authority_clusters. This attribute was added in vSphere API 7.0.0.

Optional. state If {@term.unset} return all Trust Authority Clusters.

Response:

HTTP Status Code: 200

Response Body Structure:

[
    {
        "cluster" : "obj-103",
        "state" : "ENABLE"
    },
    {
        "cluster" : "obj-103",
        "state" : "ENABLE"
    }
]

Headers:

None

Type:

Name Type Description
bold = required
- summary[] List of vcenter.trusted_infrastructure.trust_authority_clusters.summary for a vcenter.trusted_infrastructure.trust_authority_clusters.
-[].cluster string Identifies the cluster. This attribute was added in vSphere API 7.0.0.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.
-[].state string The state of the vcenter.trusted_infrastructure.trust_authority_clusters. This attribute was added in vSphere API 7.0.0.

Defines the states of the vcenter.trusted_infrastructure.trust_authority_clusters. This enumeration was added in vSphere API 7.0.0. Value is one of:
ENABLE: The vcenter.trusted_infrastructure.trust_authority_clusters is enabled. This constant was added in vSphere API 7.0.0.
DISABLE: The vcenter.trusted_infrastructure.trust_authority_clusters is disabled. This constant was added in vSphere API 7.0.0.

Errors:

HTTP Status Code Type Description
500 error if there is a generic error.
401 unauthenticated if the user can not be authenticated.