com.vmware.vcenter.trusted_infrastructure

Interface TrustAuthorityClusters

All Superinterfaces:

Service, TrustAuthorityClustersTypes

All Known Implementing Classes:

TrustAuthorityClustersStub

public interface TrustAuthorityClusters
extends Service, TrustAuthorityClustersTypes

The TrustAuthorityClusters interface manages all the Trust Authority Components on each Trust Authority Host in the cluster. The TrustAuthorityClusters interface transforms a ClusterComputeResource into Trust Authority Cluster and vice versa. This interface was added in vSphere API 7.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.trusted_infrastructure.TrustAuthorityClustersTypes

TrustAuthorityClustersTypes._VAPI_OPERATIONS, TrustAuthorityClustersTypes.FilterSpec, TrustAuthorityClustersTypes.Info, TrustAuthorityClustersTypes.State, TrustAuthorityClustersTypes.Summary, TrustAuthorityClustersTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.trusted_infrastructure.TrustAuthorityClustersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
TrustAuthorityClustersTypes.Info	get(java.lang.String cluster) Get the result of the last Update operation which matches the cluster id.
void	get(java.lang.String cluster, AsyncCallback<TrustAuthorityClustersTypes.Info> asyncCallback) Get the result of the last Update operation which matches the cluster id.
void	get(java.lang.String cluster, AsyncCallback<TrustAuthorityClustersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get the result of the last Update operation which matches the cluster id.
TrustAuthorityClustersTypes.Info	get(java.lang.String cluster, InvocationConfig invocationConfig) Get the result of the last Update operation which matches the cluster id.
java.util.List<TrustAuthorityClustersTypes.Summary>	list(TrustAuthorityClustersTypes.FilterSpec spec) Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClustersTypes.FilterSpec.
void	list(TrustAuthorityClustersTypes.FilterSpec spec, AsyncCallback<java.util.List<TrustAuthorityClustersTypes.Summary>> asyncCallback) Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClustersTypes.FilterSpec.
void	list(TrustAuthorityClustersTypes.FilterSpec spec, AsyncCallback<java.util.List<TrustAuthorityClustersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClustersTypes.FilterSpec.
java.util.List<TrustAuthorityClustersTypes.Summary>	list(TrustAuthorityClustersTypes.FilterSpec spec, InvocationConfig invocationConfig) Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClustersTypes.FilterSpec.
java.lang.String	update_Task(java.lang.String cluster, TrustAuthorityClustersTypes.UpdateSpec spec) Updates the state of a cluster.
void	update_Task(java.lang.String cluster, TrustAuthorityClustersTypes.UpdateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Updates the state of a cluster.
void	update_Task(java.lang.String cluster, TrustAuthorityClustersTypes.UpdateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Updates the state of a cluster.
java.lang.String	update_Task(java.lang.String cluster, TrustAuthorityClustersTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the state of a cluster.

Method Detail

update_Task

java.lang.String update_Task(java.lang.String cluster,
                             TrustAuthorityClustersTypes.UpdateSpec spec)

Updates the state of a cluster. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - Cluster id. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The specification for update of a cluster.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

NotFound - if spec doesn't match to any cluster compute resource.

Unauthenticated - if the user can not be authenticated.

update_Task

java.lang.String update_Task(java.lang.String cluster,
                             TrustAuthorityClustersTypes.UpdateSpec spec,
                             InvocationConfig invocationConfig)

Updates the state of a cluster. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Cluster id. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The specification for update of a cluster.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

NotFound - if spec doesn't match to any cluster compute resource.

Unauthenticated - if the user can not be authenticated.

update_Task

void update_Task(java.lang.String cluster,
                 TrustAuthorityClustersTypes.UpdateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback)

Updates the state of a cluster. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
NotFound - if spec doesn't match to any cluster compute resource.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - Cluster id. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The specification for update of a cluster.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update_Task

void update_Task(java.lang.String cluster,
                 TrustAuthorityClustersTypes.UpdateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback,
                 InvocationConfig invocationConfig)

Updates the state of a cluster. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
NotFound - if spec doesn't match to any cluster compute resource.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - Cluster id. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The specification for update of a cluster.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

get

TrustAuthorityClustersTypes.Info get(java.lang.String cluster)

Get the result of the last Update operation which matches the cluster id. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

cluster - Cluster id. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

The TrustAuthorityClustersTypes.Info instance which contains information about the state of the cluster.

Throws:

Error - if there is a generic error.

NotFound - if cluster doesn't match to any ClusterComputeResource.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource ClusterComputeResource referenced by the parameter cluster requires System.View.

get

TrustAuthorityClustersTypes.Info get(java.lang.String cluster,
                                     InvocationConfig invocationConfig)

Get the result of the last Update operation which matches the cluster id. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - Cluster id. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

The TrustAuthorityClustersTypes.Info instance which contains information about the state of the cluster.

Throws:

Error - if there is a generic error.

NotFound - if cluster doesn't match to any ClusterComputeResource.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource ClusterComputeResource referenced by the parameter cluster requires System.View.

get

void get(java.lang.String cluster,
         AsyncCallback<TrustAuthorityClustersTypes.Info> asyncCallback)

Get the result of the last Update operation which matches the cluster id. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The TrustAuthorityClustersTypes.Info instance which contains information about the state of the cluster.

Operation Errors:
Error - if there is a generic error.
NotFound - if cluster doesn't match to any ClusterComputeResource.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource ClusterComputeResource referenced by the parameter cluster requires System.View.

Parameters:

cluster - Cluster id. The parameter must be an identifier for the resource type: ClusterComputeResource.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String cluster,
         AsyncCallback<TrustAuthorityClustersTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Get the result of the last Update operation which matches the cluster id. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The TrustAuthorityClustersTypes.Info instance which contains information about the state of the cluster.

Operation Errors:
Error - if there is a generic error.
NotFound - if cluster doesn't match to any ClusterComputeResource.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource ClusterComputeResource referenced by the parameter cluster requires System.View.

Parameters:

cluster - Cluster id. The parameter must be an identifier for the resource type: ClusterComputeResource.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

list

java.util.List<TrustAuthorityClustersTypes.Summary> list(TrustAuthorityClustersTypes.FilterSpec spec)

Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClustersTypes.FilterSpec. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

spec - Return only clusters matching the specified filters. If return all clusters.

Returns:

List of TrustAuthorityClustersTypes.Summary for a TrustAuthorityClusters.

Throws:

Error - if there is a generic error.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource ClusterComputeResource referenced by the property TrustAuthorityClustersTypes.FilterSpec.getCluster() requires System.View.

list

java.util.List<TrustAuthorityClustersTypes.Summary> list(TrustAuthorityClustersTypes.FilterSpec spec,
                                                         InvocationConfig invocationConfig)

Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClustersTypes.FilterSpec. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - Return only clusters matching the specified filters. If return all clusters.

invocationConfig - Configuration for the method invocation.

Returns:

List of TrustAuthorityClustersTypes.Summary for a TrustAuthorityClusters.

Throws:

Error - if there is a generic error.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource ClusterComputeResource referenced by the property TrustAuthorityClustersTypes.FilterSpec.getCluster() requires System.View.

list

void list(TrustAuthorityClustersTypes.FilterSpec spec,
          AsyncCallback<java.util.List<TrustAuthorityClustersTypes.Summary>> asyncCallback)

Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClustersTypes.FilterSpec. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
List of TrustAuthorityClustersTypes.Summary for a TrustAuthorityClusters.

Operation Errors:
Error - if there is a generic error.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource ClusterComputeResource referenced by the property TrustAuthorityClustersTypes.FilterSpec.getCluster() requires System.View.

Parameters:

spec - Return only clusters matching the specified filters. If return all clusters.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

list

void list(TrustAuthorityClustersTypes.FilterSpec spec,
          AsyncCallback<java.util.List<TrustAuthorityClustersTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns a list of clusters for this vCenter instance which matches the TrustAuthorityClustersTypes.FilterSpec. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
List of TrustAuthorityClustersTypes.Summary for a TrustAuthorityClusters.

Operation Errors:
Error - if there is a generic error.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource ClusterComputeResource referenced by the property TrustAuthorityClustersTypes.FilterSpec.getCluster() requires System.View.

Parameters:

spec - Return only clusters matching the specified filters. If return all clusters.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.