com.vmware.vcenter.namespace_management.clusters

Interface Topology

All Superinterfaces:

Service, TopologyTypes

All Known Implementing Classes:

TopologyStub

public interface Topology
extends Service, TopologyTypes

The Topology interface provides methods to query the topological layout of the infrastructure a Supervisor is running on. This interface was added in vSphere API 8.0.0.1.

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.clusters.TopologyTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(java.lang.String cluster) Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there's any.
void	get(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there's any.
void	get(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there's any.
java.lang.String	get(java.lang.String cluster, InvocationConfig invocationConfig) Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there's any.

Method Detail

get

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

Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there's any. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. This method was added in vSphere API 8.0.0.1.

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

Parameters:

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

Returns:

Identifier of the Supervisor associated with the given vSphere Cluster. The return value will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Throws:

Error - if the system reports an error while responding to the request.

Error - if the system reports an error while responding to the request.

NotFound - if the given vSphere Cluster does not exist.

Unauthenticated - if the user can not be authenticated.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

get

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

Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there's any. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. This method was added in vSphere API 8.0.0.1.

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 - Identifier for a vSphere Cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Identifier of the Supervisor associated with the given vSphere Cluster. The return value will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Throws:

Error - if the system reports an error while responding to the request.

Error - if the system reports an error while responding to the request.

NotFound - if the given vSphere Cluster does not exist.

Unauthenticated - if the user can not be authenticated.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

get

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

Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there's any. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
Identifier of the Supervisor associated with the given vSphere Cluster. The return value will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reports an error while responding to the request.
NotFound - if the given vSphere Cluster does not exist.
Unauthenticated - if the user can not be authenticated.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

Parameters:

cluster - Identifier for a vSphere Cluster. 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<java.lang.String> asyncCallback,
         InvocationConfig invocationConfig)

Queries the Supervisor ID that is currently running on the given vSphere Cluster ID, if there's any. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. This method was added in vSphere API 8.0.0.1.

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:
Identifier of the Supervisor associated with the given vSphere Cluster. The return value will be an identifier for the resource type: com.vmware.vcenter.consumption_domains.Zone.

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reports an error while responding to the request.
NotFound - if the given vSphere Cluster does not exist.
Unauthenticated - if the user can not be authenticated.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege and the System.Read privilege on all vSphere Clusters hosting the Supervisor.

Parameters:

cluster - Identifier for a vSphere Cluster. 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.