com.vmware.vcenter.namespace_management

Interface NSXTier0Gateway

All Superinterfaces:

NSXTier0GatewayTypes, Service

All Known Implementing Classes:

NSXTier0GatewayStub

public interface NSXTier0Gateway
extends Service, NSXTier0GatewayTypes

The NSXTier0Gateway provides methods to get information of NSX Tier0 Gateways. This interface was added in vSphere API 7.0.2.0.

Nested Class Summary

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

NSXTier0GatewayTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.NSXTier0GatewayTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.util.List<NSXTier0GatewayTypes.Summary>	list(java.lang.String distributedSwitch) Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch.
void	list(java.lang.String distributedSwitch, AsyncCallback<java.util.List<NSXTier0GatewayTypes.Summary>> asyncCallback) Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch.
void	list(java.lang.String distributedSwitch, AsyncCallback<java.util.List<NSXTier0GatewayTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch.
java.util.List<NSXTier0GatewayTypes.Summary>	list(java.lang.String distributedSwitch, InvocationConfig invocationConfig) Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch.

Method Detail

list

java.util.List<NSXTier0GatewayTypes.Summary> list(java.lang.String distributedSwitch)

Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch. This method was added in vSphere API 7.0.2.0.

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

Parameters:

distributedSwitch - Identifier of a Distributed Switch. Only CVDS type of distributed switches is supported. Only Tier0 Gateways that are associated with the particular Distributed Switch will be listed. The parameter must be an identifier for the resource type: vSphereDistributedSwitch.

Returns:

List of summaries of Tier0 Gateways associated with the given Distributed Switch.

Throws:

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

InternalServerError - if the server reports an unknown internal error.

NotFound - if no existing Tier0 Gateways associated with the given Distributed Switch can be found.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

java.util.List<NSXTier0GatewayTypes.Summary> list(java.lang.String distributedSwitch,
                                                  InvocationConfig invocationConfig)

Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch. This method was added in vSphere API 7.0.2.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:

distributedSwitch - Identifier of a Distributed Switch. Only CVDS type of distributed switches is supported. Only Tier0 Gateways that are associated with the particular Distributed Switch will be listed. The parameter must be an identifier for the resource type: vSphereDistributedSwitch.

invocationConfig - Configuration for the method invocation.

Returns:

List of summaries of Tier0 Gateways associated with the given Distributed Switch.

Throws:

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

InternalServerError - if the server reports an unknown internal error.

NotFound - if no existing Tier0 Gateways associated with the given Distributed Switch can be found.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

void list(java.lang.String distributedSwitch,
          AsyncCallback<java.util.List<NSXTier0GatewayTypes.Summary>> asyncCallback)

Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch. This method was added in vSphere API 7.0.2.0.

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

Invocation Result:
List of summaries of Tier0 Gateways associated with the given Distributed Switch.

Operation Errors:
Error - if the system reports an error while responding to the request.
InternalServerError - if the server reports an unknown internal error.
NotFound - if no existing Tier0 Gateways associated with the given Distributed Switch can be found.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

distributedSwitch - Identifier of a Distributed Switch. Only CVDS type of distributed switches is supported. Only Tier0 Gateways that are associated with the particular Distributed Switch will be listed. The parameter must be an identifier for the resource type: vSphereDistributedSwitch.

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

list

void list(java.lang.String distributedSwitch,
          AsyncCallback<java.util.List<NSXTier0GatewayTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns information of NSX-T Tier0 Gateways associated with a Distributed Switch. This method was added in vSphere API 7.0.2.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 summaries of Tier0 Gateways associated with the given Distributed Switch.

Operation Errors:
Error - if the system reports an error while responding to the request.
InternalServerError - if the server reports an unknown internal error.
NotFound - if no existing Tier0 Gateways associated with the given Distributed Switch can be found.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

distributedSwitch - Identifier of a Distributed Switch. Only CVDS type of distributed switches is supported. Only Tier0 Gateways that are associated with the particular Distributed Switch will be listed. The parameter must be an identifier for the resource type: vSphereDistributedSwitch.

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

invocationConfig - Configuration for the method invocation.