com.vmware.nsx.cluster.nodes.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.cluster.nodes.network.InterfacesTypes

_VAPI_SERVICE_ID, GET_SOURCE_CACHED, GET_SOURCE_REALTIME, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

Method Summary

Modifier and Type	Method and Description
NodeInterfaceProperties	get(java.lang.String nodeId, java.lang.String interfaceId, java.lang.String source) Returns detailed information about the specified interface.
void	get(java.lang.String nodeId, java.lang.String interfaceId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfaceProperties> asyncCallback) Returns detailed information about the specified interface.
void	get(java.lang.String nodeId, java.lang.String interfaceId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfaceProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about the specified interface.
NodeInterfaceProperties	get(java.lang.String nodeId, java.lang.String interfaceId, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about the specified interface.
NodeInterfacePropertiesListResult	list(java.lang.String nodeId, java.lang.String source) Returns the number of interfaces on the node and detailed information about each interface.
void	list(java.lang.String nodeId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfacePropertiesListResult> asyncCallback) Returns the number of interfaces on the node and detailed information about each interface.
void	list(java.lang.String nodeId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfacePropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the number of interfaces on the node and detailed information about each interface.
NodeInterfacePropertiesListResult	list(java.lang.String nodeId, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the number of interfaces on the node and detailed information about each interface.

Method Detail

get

NodeInterfaceProperties get(java.lang.String nodeId,
                            java.lang.String interfaceId,
                            java.lang.String source)

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 (static or DHCP).

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

Parameters:

nodeId - (required)

interfaceId - (required)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.NodeInterfaceProperties

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

NodeInterfaceProperties get(java.lang.String nodeId,
                            java.lang.String interfaceId,
                            java.lang.String source,
                            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 (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:

nodeId - (required)

interfaceId - (required)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeInterfaceProperties

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 nodeId,
         java.lang.String interfaceId,
         java.lang.String source,
         com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfaceProperties> 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 (static or DHCP).

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

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

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

Parameters:

nodeId - (required)

interfaceId - (required)

source - Data source type. (optional)

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

get

void get(java.lang.String nodeId,
         java.lang.String interfaceId,
         java.lang.String source,
         com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfaceProperties> 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 (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.NodeInterfaceProperties

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

Parameters:

nodeId - (required)

interfaceId - (required)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.

list

NodeInterfacePropertiesListResult list(java.lang.String nodeId,
                                       java.lang.String source)

Returns the number of interfaces on the node 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). Note that if virtual IP (VIP) addresses are configured, virtual interfaces will not be returned.

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

Parameters:

nodeId - (required)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.NodeInterfacePropertiesListResult

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

NodeInterfacePropertiesListResult list(java.lang.String nodeId,
                                       java.lang.String source,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the number of interfaces on the node 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). Note that if virtual IP (VIP) addresses are configured, virtual interfaces will not be returned.

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:

nodeId - (required)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeInterfacePropertiesListResult

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(java.lang.String nodeId,
          java.lang.String source,
          com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfacePropertiesListResult> asyncCallback)

Returns the number of interfaces on the node 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). Note that if virtual IP (VIP) addresses are configured, virtual interfaces will not be returned.

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

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

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

Parameters:

nodeId - (required)

source - Data source type. (optional)

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

list

void list(java.lang.String nodeId,
          java.lang.String source,
          com.vmware.vapi.bindings.client.AsyncCallback<NodeInterfacePropertiesListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the number of interfaces on the node 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). Note that if virtual IP (VIP) addresses are configured, virtual interfaces will not be returned.

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

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

Parameters:

nodeId - (required)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.