com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters

Interface ConsumerPrincipals

All Superinterfaces:

ConsumerPrincipalsTypes, Service

All Known Implementing Classes:

ConsumerPrincipalsStub

public interface ConsumerPrincipals
extends Service, ConsumerPrincipalsTypes

The ConsumerPrincipals interface configures the token policies and STS trust necessary for the workload vCenter to query the trusted services for their status. This interface was added in vSphere API 7.0.0.

Nested Class Summary

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

ConsumerPrincipalsTypes._VAPI_OPERATIONS, ConsumerPrincipalsTypes.CreateSpec, ConsumerPrincipalsTypes.FilterSpec, ConsumerPrincipalsTypes.Health, ConsumerPrincipalsTypes.Info, ConsumerPrincipalsTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.ConsumerPrincipalsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(java.lang.String cluster, ConsumerPrincipalsTypes.CreateSpec spec) Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster.
void	create_Task(java.lang.String cluster, ConsumerPrincipalsTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster.
void	create_Task(java.lang.String cluster, ConsumerPrincipalsTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster.
java.lang.String	create_Task(java.lang.String cluster, ConsumerPrincipalsTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String profile) Removes the read-only policy configured on ESX for a specific principal.
void	delete_Task(java.lang.String cluster, java.lang.String profile, AsyncCallback<java.lang.String> asyncCallback) Removes the read-only policy configured on ESX for a specific principal.
void	delete_Task(java.lang.String cluster, java.lang.String profile, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Removes the read-only policy configured on ESX for a specific principal.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String profile, InvocationConfig invocationConfig) Removes the read-only policy configured on ESX for a specific principal.
java.lang.String	get_Task(java.lang.String cluster, java.lang.String profile) Retrieve information for a specific profile.
void	get_Task(java.lang.String cluster, java.lang.String profile, AsyncCallback<java.lang.String> asyncCallback) Retrieve information for a specific profile.
void	get_Task(java.lang.String cluster, java.lang.String profile, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Retrieve information for a specific profile.
java.lang.String	get_Task(java.lang.String cluster, java.lang.String profile, InvocationConfig invocationConfig) Retrieve information for a specific profile.
java.lang.String	list_Task(java.lang.String cluster, ConsumerPrincipalsTypes.FilterSpec spec) Lists all policies configured on a specific cluster.
void	list_Task(java.lang.String cluster, ConsumerPrincipalsTypes.FilterSpec spec, AsyncCallback<java.lang.String> asyncCallback) Lists all policies configured on a specific cluster.
void	list_Task(java.lang.String cluster, ConsumerPrincipalsTypes.FilterSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Lists all policies configured on a specific cluster.
java.lang.String	list_Task(java.lang.String cluster, ConsumerPrincipalsTypes.FilterSpec spec, InvocationConfig invocationConfig) Lists all policies configured on a specific cluster.

Method Detail

create_Task

java.lang.String create_Task(java.lang.String cluster,
                             ConsumerPrincipalsTypes.CreateSpec spec)

Creates a profile with the specified connection information on all hosts from a Trust Authority 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 - The ID of the Trust Authority Cluster to configure. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The CreateSpec specifying the connection information.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - if a profile for the issuer already exists.

Error - if there is a generic error.

NotFound - if there is no such cluster.

Unauthenticated - if the user can not be authenticated.

create_Task

java.lang.String create_Task(java.lang.String cluster,
                             ConsumerPrincipalsTypes.CreateSpec spec,
                             InvocationConfig invocationConfig)

Creates a profile with the specified connection information on all hosts from a Trust Authority 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 - The ID of the Trust Authority Cluster to configure. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The CreateSpec specifying the connection information.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - if a profile for the issuer already exists.

Error - if there is a generic error.

NotFound - if there is no such cluster.

Unauthenticated - if the user can not be authenticated.

create_Task

void create_Task(java.lang.String cluster,
                 ConsumerPrincipalsTypes.CreateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback)

Creates a profile with the specified connection information on all hosts from a Trust Authority 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:
AlreadyExists - if a profile for the issuer already exists.
Error - if there is a generic error.
NotFound - if there is no such cluster.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - The ID of the Trust Authority Cluster to configure. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The CreateSpec specifying the connection information.

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

create_Task

void create_Task(java.lang.String cluster,
                 ConsumerPrincipalsTypes.CreateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback,
                 InvocationConfig invocationConfig)

Creates a profile with the specified connection information on all hosts from a Trust Authority 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:
AlreadyExists - if a profile for the issuer already exists.
Error - if there is a generic error.
NotFound - if there is no such cluster.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - The ID of the Trust Authority Cluster to configure. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The CreateSpec specifying the connection information.

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

invocationConfig - Configuration for the method invocation.

delete_Task

java.lang.String delete_Task(java.lang.String cluster,
                             java.lang.String profile)

Removes the read-only policy configured on ESX for a specific principal. 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 - The ID of the Trust Authority Cluster to configure. The parameter must be an identifier for the resource type: ClusterComputeResource.

profile - The ID of the connection profile to modify. The parameter must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

NotFound - if there is no profile configured with that ID.

Unauthenticated - if the user can not be authenticated.

delete_Task

java.lang.String delete_Task(java.lang.String cluster,
                             java.lang.String profile,
                             InvocationConfig invocationConfig)

Removes the read-only policy configured on ESX for a specific principal. 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 - The ID of the Trust Authority Cluster to configure. The parameter must be an identifier for the resource type: ClusterComputeResource.

profile - The ID of the connection profile to modify. The parameter must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.

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 there is no profile configured with that ID.

Unauthenticated - if the user can not be authenticated.

delete_Task

void delete_Task(java.lang.String cluster,
                 java.lang.String profile,
                 AsyncCallback<java.lang.String> asyncCallback)

Removes the read-only policy configured on ESX for a specific principal. 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 there is no profile configured with that ID.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - The ID of the Trust Authority Cluster to configure. The parameter must be an identifier for the resource type: ClusterComputeResource.

profile - The ID of the connection profile to modify. The parameter must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.

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

delete_Task

void delete_Task(java.lang.String cluster,
                 java.lang.String profile,
                 AsyncCallback<java.lang.String> asyncCallback,
                 InvocationConfig invocationConfig)

Removes the read-only policy configured on ESX for a specific principal. 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 there is no profile configured with that ID.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - The ID of the Trust Authority Cluster to configure. The parameter must be an identifier for the resource type: ClusterComputeResource.

profile - The ID of the connection profile to modify. The parameter must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.

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

invocationConfig - Configuration for the method invocation.

get_Task

java.lang.String get_Task(java.lang.String cluster,
                          java.lang.String profile)

Retrieve information for a specific profile. 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 - The ID of the Trust Authority Cluster on which the profile is configured. The parameter must be an identifier for the resource type: ClusterComputeResource.

profile - The ID of the profile. The parameter must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

NotFound - if there is no profile configured with that ID.

Unauthenticated - if the user can not be authenticated.

get_Task

java.lang.String get_Task(java.lang.String cluster,
                          java.lang.String profile,
                          InvocationConfig invocationConfig)

Retrieve information for a specific profile. 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 - The ID of the Trust Authority Cluster on which the profile is configured. The parameter must be an identifier for the resource type: ClusterComputeResource.

profile - The ID of the profile. The parameter must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.

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 there is no profile configured with that ID.

Unauthenticated - if the user can not be authenticated.

get_Task

void get_Task(java.lang.String cluster,
              java.lang.String profile,
              AsyncCallback<java.lang.String> asyncCallback)

Retrieve information for a specific profile. 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 there is no profile configured with that ID.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - The ID of the Trust Authority Cluster on which the profile is configured. The parameter must be an identifier for the resource type: ClusterComputeResource.

profile - The ID of the profile. The parameter must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.

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

get_Task

void get_Task(java.lang.String cluster,
              java.lang.String profile,
              AsyncCallback<java.lang.String> asyncCallback,
              InvocationConfig invocationConfig)

Retrieve information for a specific profile. 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 there is no profile configured with that ID.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - The ID of the Trust Authority Cluster on which the profile is configured. The parameter must be an identifier for the resource type: ClusterComputeResource.

profile - The ID of the profile. The parameter must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.

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

invocationConfig - Configuration for the method invocation.

list_Task

java.lang.String list_Task(java.lang.String cluster,
                           ConsumerPrincipalsTypes.FilterSpec spec)

Lists all policies configured on a specific 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 - The ID of the Trust Authority Cluster on which the profile is configured. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - A FilterSpec specifying the profiles to be listed. If return all policies.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

NotFound - if there is no profile configured with that ID.

Unauthenticated - if the user can not be authenticated.

list_Task

java.lang.String list_Task(java.lang.String cluster,
                           ConsumerPrincipalsTypes.FilterSpec spec,
                           InvocationConfig invocationConfig)

Lists all policies configured on a specific 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 - The ID of the Trust Authority Cluster on which the profile is configured. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - A FilterSpec specifying the profiles to be listed. If return all policies.

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 there is no profile configured with that ID.

Unauthenticated - if the user can not be authenticated.

list_Task

void list_Task(java.lang.String cluster,
               ConsumerPrincipalsTypes.FilterSpec spec,
               AsyncCallback<java.lang.String> asyncCallback)

Lists all policies configured on a specific 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 there is no profile configured with that ID.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - The ID of the Trust Authority Cluster on which the profile is configured. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - A FilterSpec specifying the profiles to be listed. If return all policies.

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

list_Task

void list_Task(java.lang.String cluster,
               ConsumerPrincipalsTypes.FilterSpec spec,
               AsyncCallback<java.lang.String> asyncCallback,
               InvocationConfig invocationConfig)

Lists all policies configured on a specific 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 there is no profile configured with that ID.
Unauthenticated - if the user can not be authenticated.

Parameters:

cluster - The ID of the Trust Authority Cluster on which the profile is configured. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - A FilterSpec specifying the profiles to be listed. If return all policies.

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

invocationConfig - Configuration for the method invocation.