com.vmware.nsx.node.network

Interface Interfaces

All Superinterfaces:

InterfacesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

InterfacesStub

public interface Interfaces
extends com.vmware.vapi.bindings.Service, InterfacesTypes

Field Summary

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

_VAPI_SERVICE_ID

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.

Method Detail

get

NodeNetworkInterfaceProperties get(java.lang.String interfaceId)

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.

Parameters:

interfaceId - ID of interface to read (required)

Returns:

com.vmware.nsx.model.NodeNetworkInterfaceProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

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

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.

Parameters:

interfaceId - ID of interface to read (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeNetworkInterfaceProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

get

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

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

Parameters:

interfaceId - ID of interface to read (required)

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

get

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. 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

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

NodeNetworkInterfacePropertiesListResult list()

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.

Returns:

com.vmware.nsx.model.NodeNetworkInterfacePropertiesListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

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

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.

Parameters:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeNetworkInterfacePropertiesListResult

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

list

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. 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

Parameters:

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

list

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. 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

Parameters:

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

invocationConfig - Configuration for the method invocation.

update

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

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.

Parameters:

interfaceId - ID of interface to update (required)

nodeNetworkInterfaceProperties - (required)

Returns:

com.vmware.nsx.model.NodeNetworkInterfaceProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

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

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.

Parameters:

interfaceId - ID of interface to update (required)

nodeNetworkInterfaceProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeNetworkInterfaceProperties

Throws:

com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed

com.vmware.vapi.std.errors.Unauthorized - Forbidden

com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable

com.vmware.vapi.std.errors.InternalServerError - Internal Server Error

com.vmware.vapi.std.errors.NotFound - Not Found

update

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

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

Parameters:

interfaceId - ID of interface to update (required)

nodeNetworkInterfaceProperties - (required)

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

update

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. 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

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.