com.vmware.vcenter.namespace_management.supervisors

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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.supervisors.TopologyTypes

TopologyTypes.Info

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.util.List<TopologyTypes.Info>	get(java.lang.String supervisor) Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID.
void	get(java.lang.String supervisor, AsyncCallback<java.util.List<TopologyTypes.Info>> asyncCallback) Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID.
void	get(java.lang.String supervisor, AsyncCallback<java.util.List<TopologyTypes.Info>> asyncCallback, InvocationConfig invocationConfig) Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID.
java.util.List<TopologyTypes.Info>	get(java.lang.String supervisor, InvocationConfig invocationConfig) Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID.

Method Detail

get

java.util.List<TopologyTypes.Info> get(java.lang.String supervisor)

Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. Use the vSphere Cluster IDs obtained from get(java.lang.String) to call the APIs that requires a vSphere Cluster ID instead of a Supervisor. 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:

supervisor - Identifier for a Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

Returns:

List of TopologyTypes.Info of vSphere Zone and vSphere Cluster associations.

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 given Supervisor 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.util.List<TopologyTypes.Info> get(java.lang.String supervisor,
                                       InvocationConfig invocationConfig)

Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. Use the vSphere Cluster IDs obtained from get(java.lang.String) to call the APIs that requires a vSphere Cluster ID instead of a Supervisor. 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:

supervisor - Identifier for a Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

invocationConfig - Configuration for the method invocation.

Returns:

List of TopologyTypes.Info of vSphere Zone and vSphere Cluster associations.

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 given Supervisor 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 supervisor,
         AsyncCallback<java.util.List<TopologyTypes.Info>> asyncCallback)

Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. Use the vSphere Cluster IDs obtained from get(java.lang.String) to call the APIs that requires a vSphere Cluster ID instead of a Supervisor. 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:
List of TopologyTypes.Info of vSphere Zone and vSphere Cluster associations.

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 given Supervisor 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:

supervisor - Identifier for a Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

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

get

void get(java.lang.String supervisor,
         AsyncCallback<java.util.List<TopologyTypes.Info>> asyncCallback,
         InvocationConfig invocationConfig)

Queries the current association between vSphere Zones and vSphere Clusters from the given Supervisor ID. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. Use the vSphere Cluster IDs obtained from get(java.lang.String) to call the APIs that requires a vSphere Cluster ID instead of a Supervisor. 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:
List of TopologyTypes.Info of vSphere Zone and vSphere Cluster associations.

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 given Supervisor 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:

supervisor - Identifier for a Supervisor. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

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

invocationConfig - Configuration for the method invocation.