com.vmware.nsx.node.network

Class InterfacesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.node.network.InterfacesStub

All Implemented Interfaces:

Interfaces, InterfacesTypes, com.vmware.vapi.bindings.Service

public class InterfacesStub
extends com.vmware.vapi.internal.bindings.Stub
implements Interfaces

Remote stub implementation of the Interfaces API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.node.network.InterfacesTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
InterfacesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
InterfacesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
NodeNetworkInterfaceProperties	get(java.lang.String interfaceId) Returns detailed information about the specified interface.
void	get(java.lang.String interfaceId, com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfaceProperties> asyncCallback) Returns detailed information about the specified interface.
void	get(java.lang.String interfaceId, com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfaceProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about the specified interface.
NodeNetworkInterfaceProperties	get(java.lang.String interfaceId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about the specified interface.
NodeNetworkInterfacePropertiesListResult	list() Returns the number of interfaces on the node appliance and detailed information about each interface.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfacePropertiesListResult> asyncCallback) Returns the number of interfaces on the node appliance and detailed information about each interface.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfacePropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the number of interfaces on the node appliance and detailed information about each interface.
NodeNetworkInterfacePropertiesListResult	list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the number of interfaces on the node appliance and detailed information about each interface.
NodeNetworkInterfaceProperties	update(java.lang.String interfaceId, NodeNetworkInterfaceProperties nodeNetworkInterfaceProperties) Updates the specified interface properties.
void	update(java.lang.String interfaceId, NodeNetworkInterfaceProperties nodeNetworkInterfaceProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfaceProperties> asyncCallback) Updates the specified interface properties.
void	update(java.lang.String interfaceId, NodeNetworkInterfaceProperties nodeNetworkInterfaceProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfaceProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Updates the specified interface properties.
NodeNetworkInterfaceProperties	update(java.lang.String interfaceId, NodeNetworkInterfaceProperties nodeNetworkInterfaceProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Updates the specified interface properties.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InterfacesStub

public InterfacesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                      com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                      com.vmware.vapi.bindings.StubConfigurationBase config)

InterfacesStub

public InterfacesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                      com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

get

public NodeNetworkInterfaceProperties get(java.lang.String interfaceId)

Description copied from interface: Interfaces

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method.

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

Specified by:

get in interface Interfaces

Parameters:

interfaceId - ID of interface to read (required)

Returns:

com.vmware.nsx.model.NodeNetworkInterfaceProperties

get

public NodeNetworkInterfaceProperties get(java.lang.String interfaceId,
                                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface Interfaces

Parameters:

interfaceId - ID of interface to read (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeNetworkInterfaceProperties

get

public void get(java.lang.String interfaceId,
                com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfaceProperties> asyncCallback)

Description copied from interface: Interfaces

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method.

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

Invocation Result:
com.vmware.nsx.model.NodeNetworkInterfaceProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface Interfaces

Parameters:

interfaceId - ID of interface to read (required)

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

get

public void get(java.lang.String interfaceId,
                com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfaceProperties> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method.

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:
com.vmware.nsx.model.NodeNetworkInterfaceProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

get in interface Interfaces

Parameters:

interfaceId - ID of interface to read (required)

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

invocationConfig - Configuration for the method invocation.

list

public NodeNetworkInterfacePropertiesListResult list()

Description copied from interface: Interfaces

Returns the number of interfaces on the node appliance and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

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

Specified by:

list in interface Interfaces

Returns:

com.vmware.nsx.model.NodeNetworkInterfacePropertiesListResult

list

public NodeNetworkInterfacePropertiesListResult list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Returns the number of interfaces on the node appliance and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

list in interface Interfaces

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeNetworkInterfacePropertiesListResult

list

public void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfacePropertiesListResult> asyncCallback)

Description copied from interface: Interfaces

Returns the number of interfaces on the node appliance and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

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

Invocation Result:
com.vmware.nsx.model.NodeNetworkInterfacePropertiesListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

list in interface Interfaces

Parameters:

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

list

public void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfacePropertiesListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Returns the number of interfaces on the node appliance and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).

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:
com.vmware.nsx.model.NodeNetworkInterfacePropertiesListResult

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

list in interface Interfaces

Parameters:

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

invocationConfig - Configuration for the method invocation.

update

public NodeNetworkInterfaceProperties update(java.lang.String interfaceId,
                                             NodeNetworkInterfaceProperties nodeNetworkInterfaceProperties)

Description copied from interface: Interfaces

Updates the specified interface properties. You cannot change the properties ip_configuration, ip_addresses, or plane. NSX Manager must have a static IP address. You must use NSX CLI to configure a controller or an edge node. Note: NSX manager reboot is required after adding IPv6 address.

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

Specified by:

update in interface Interfaces

Parameters:

interfaceId - ID of interface to update (required)

nodeNetworkInterfaceProperties - (required)

Returns:

com.vmware.nsx.model.NodeNetworkInterfaceProperties

update

public NodeNetworkInterfaceProperties update(java.lang.String interfaceId,
                                             NodeNetworkInterfaceProperties nodeNetworkInterfaceProperties,
                                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Updates the specified interface properties. You cannot change the properties ip_configuration, ip_addresses, or plane. NSX Manager must have a static IP address. You must use NSX CLI to configure a controller or an edge node. Note: NSX manager reboot is required after adding IPv6 address.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

update in interface Interfaces

Parameters:

interfaceId - ID of interface to update (required)

nodeNetworkInterfaceProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeNetworkInterfaceProperties

update

public void update(java.lang.String interfaceId,
                   NodeNetworkInterfaceProperties nodeNetworkInterfaceProperties,
                   com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfaceProperties> asyncCallback)

Description copied from interface: Interfaces

Updates the specified interface properties. You cannot change the properties ip_configuration, ip_addresses, or plane. NSX Manager must have a static IP address. You must use NSX CLI to configure a controller or an edge node. Note: NSX manager reboot is required after adding IPv6 address.

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

Invocation Result:
com.vmware.nsx.model.NodeNetworkInterfaceProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

update in interface Interfaces

Parameters:

interfaceId - ID of interface to update (required)

nodeNetworkInterfaceProperties - (required)

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

update

public void update(java.lang.String interfaceId,
                   NodeNetworkInterfaceProperties nodeNetworkInterfaceProperties,
                   com.vmware.vapi.bindings.client.AsyncCallback<NodeNetworkInterfaceProperties> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: Interfaces

Updates the specified interface properties. You cannot change the properties ip_configuration, ip_addresses, or plane. NSX Manager must have a static IP address. You must use NSX CLI to configure a controller or an edge node. Note: NSX manager reboot is required after adding IPv6 address.

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:
com.vmware.nsx.model.NodeNetworkInterfaceProperties

Operation Errors:
InvalidRequest - Bad Request, Precondition Failed
Unauthorized - Forbidden
ServiceUnavailable - Service Unavailable
InternalServerError - Internal Server Error
NotFound - Not Found

Specified by:

update in interface Interfaces

Parameters:

interfaceId - ID of interface to update (required)

nodeNetworkInterfaceProperties - (required)

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

invocationConfig - Configuration for the method invocation.