com.vmware.vcenter.topology

Interface Nodes

All Superinterfaces:

NodesTypes, Service

All Known Implementing Classes:

NodesStub

public interface Nodes
extends Service, NodesTypes

The Nodes interface provides methods to retrieve vCenter and Platform Services Controller nodes information in the topology. This interface was added in vSphere API 6.7.2.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.topology.NodesTypes

NodesTypes.ApplianceType, NodesTypes.FilterSpec, NodesTypes.Info, NodesTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.topology.NodesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
NodesTypes.Info	get(java.lang.String node) Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
void	get(java.lang.String node, AsyncCallback<NodesTypes.Info> asyncCallback) Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
void	get(java.lang.String node, AsyncCallback<NodesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
NodesTypes.Info	get(java.lang.String node, InvocationConfig invocationConfig) Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
java.util.List<NodesTypes.Summary>	list(NodesTypes.FilterSpec filter) Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.
void	list(NodesTypes.FilterSpec filter, AsyncCallback<java.util.List<NodesTypes.Summary>> asyncCallback) Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.
void	list(NodesTypes.FilterSpec filter, AsyncCallback<java.util.List<NodesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.
java.util.List<NodesTypes.Summary>	list(NodesTypes.FilterSpec filter, InvocationConfig invocationConfig) Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

Method Detail

list

java.util.List<NodesTypes.Summary> list(NodesTypes.FilterSpec filter)

Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec. This method was added in vSphere API 6.7.2.

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

Parameters:

filter - Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a NodesTypes.FilterSpec with all properties null which means all nodes match the filter.

Returns:

commonly used information for all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

Throws:

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

InvalidArgument - if the NodesTypes.FilterSpec.getTypes() property contains a value that is not supported.

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

• Method execution requires System.Read.

list

java.util.List<NodesTypes.Summary> list(NodesTypes.FilterSpec filter,
                                        InvocationConfig invocationConfig)

Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec. This method was added in vSphere API 6.7.2.

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:

filter - Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a NodesTypes.FilterSpec with all properties null which means all nodes match the filter.

invocationConfig - Configuration for the method invocation.

Returns:

commonly used information for all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

Throws:

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

InvalidArgument - if the NodesTypes.FilterSpec.getTypes() property contains a value that is not supported.

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

• Method execution requires System.Read.

list

void list(NodesTypes.FilterSpec filter,
          AsyncCallback<java.util.List<NodesTypes.Summary>> asyncCallback)

Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec. This method was added in vSphere API 6.7.2.

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

Invocation Result:
commonly used information for all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
InvalidArgument - if the NodesTypes.FilterSpec.getTypes() property contains a value that is not supported.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

filter - Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a NodesTypes.FilterSpec with all properties null which means all nodes match the filter.

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

list

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

Returns information about all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec. This method was added in vSphere API 6.7.2.

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:
commonly used information for all vCenter and Platform Services Controller nodes matching the NodesTypes.FilterSpec.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
InvalidArgument - if the NodesTypes.FilterSpec.getTypes() property contains a value that is not supported.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

filter - Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a NodesTypes.FilterSpec with all properties null which means all nodes match the filter.

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

invocationConfig - Configuration for the method invocation.

get

NodesTypes.Info get(java.lang.String node)

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This method was added in vSphere API 6.7.2.

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

Parameters:

node - Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

Returns:

vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See NodesTypes.Info.

Throws:

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

NotFound - if a node doesn't exist for given node identifier.

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

• Method execution requires System.Read.

get

NodesTypes.Info get(java.lang.String node,
                    InvocationConfig invocationConfig)

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This method was added in vSphere API 6.7.2.

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:

node - Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

invocationConfig - Configuration for the method invocation.

Returns:

vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See NodesTypes.Info.

Throws:

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

NotFound - if a node doesn't exist for given node identifier.

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

• Method execution requires System.Read.

get

void get(java.lang.String node,
         AsyncCallback<NodesTypes.Info> asyncCallback)

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This method was added in vSphere API 6.7.2.

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

Invocation Result:
vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See NodesTypes.Info.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
NotFound - if a node doesn't exist for given node identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

node - Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

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

get

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

Retrieve details for a given identifier of the vCenter or Platform Services Controller node. This method was added in vSphere API 6.7.2.

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:
vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See NodesTypes.Info.

Operation Errors:
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.
NotFound - if a node doesn't exist for given node identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires System.Read.

Parameters:

node - Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

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

invocationConfig - Configuration for the method invocation.