com.vmware.nsx.transport_nodes

Interface Tunnels

All Superinterfaces:

com.vmware.vapi.bindings.Service, TunnelsTypes

All Known Implementing Classes:

TunnelsStub

public interface Tunnels
extends com.vmware.vapi.bindings.Service, TunnelsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.transport_nodes.TunnelsTypes

_VAPI_SERVICE_ID, GET_SOURCE_CACHED, GET_SOURCE_REALTIME, LIST_BFD_DIAGNOSTIC_CODE_0, LIST_BFD_DIAGNOSTIC_CODE_1, LIST_BFD_DIAGNOSTIC_CODE_2, LIST_BFD_DIAGNOSTIC_CODE_3, LIST_BFD_DIAGNOSTIC_CODE_4, LIST_BFD_DIAGNOSTIC_CODE_5, LIST_BFD_DIAGNOSTIC_CODE_6, LIST_BFD_DIAGNOSTIC_CODE_7, LIST_BFD_DIAGNOSTIC_CODE_8, LIST_BFD_DIAGNOSTIC_CODE_ADMINISTRATIVELY_DOWN, LIST_BFD_DIAGNOSTIC_CODE_CONCATENATED_PATH_DOWN, LIST_BFD_DIAGNOSTIC_CODE_CONTROL_DETECTION_TIME_EXPIRED, LIST_BFD_DIAGNOSTIC_CODE_ECHO_FUNCTION_FAILED, LIST_BFD_DIAGNOSTIC_CODE_FORWARDING_PLANE_RESET, LIST_BFD_DIAGNOSTIC_CODE_NEIGHBOR_SIGNALED_SESSION_DOWN, LIST_BFD_DIAGNOSTIC_CODE_NO_DIAGNOSTIC, LIST_BFD_DIAGNOSTIC_CODE_PATH_DOWN, LIST_BFD_DIAGNOSTIC_CODE_REVERSE_CONCATENATED_PATH_DOWN, LIST_ENCAP_GENEVE, LIST_ENCAP_UNKNOWN_ENCAP, LIST_ENCAP_VXLAN, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME, LIST_STATUS_DOWN, LIST_STATUS_UP

Method Summary

Modifier and Type	Method and Description
TunnelProperties	get(java.lang.String nodeId, java.lang.String tunnelName, java.lang.String source) Tunnel properties
void	get(java.lang.String nodeId, java.lang.String tunnelName, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<TunnelProperties> asyncCallback) Tunnel properties
void	get(java.lang.String nodeId, java.lang.String tunnelName, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<TunnelProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Tunnel properties
TunnelProperties	get(java.lang.String nodeId, java.lang.String tunnelName, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Tunnel properties
TunnelList	list(java.lang.String nodeId, java.lang.String bfdDiagnosticCode, java.lang.String cursor, java.lang.String encap, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String remoteNodeId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String status) List of tunnels
void	list(java.lang.String nodeId, java.lang.String bfdDiagnosticCode, java.lang.String cursor, java.lang.String encap, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String remoteNodeId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String status, com.vmware.vapi.bindings.client.AsyncCallback<TunnelList> asyncCallback) List of tunnels
void	list(java.lang.String nodeId, java.lang.String bfdDiagnosticCode, java.lang.String cursor, java.lang.String encap, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String remoteNodeId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String status, com.vmware.vapi.bindings.client.AsyncCallback<TunnelList> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List of tunnels
TunnelList	list(java.lang.String nodeId, java.lang.String bfdDiagnosticCode, java.lang.String cursor, java.lang.String encap, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String remoteNodeId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String status, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List of tunnels

Method Detail

get

TunnelProperties get(java.lang.String nodeId,
                     java.lang.String tunnelName,
                     java.lang.String source)

Tunnel properties

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

Parameters:

nodeId - ID of transport node (required)

tunnelName - Tunnel name (required)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.TunnelProperties

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

TunnelProperties get(java.lang.String nodeId,
                     java.lang.String tunnelName,
                     java.lang.String source,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Tunnel properties

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 - ID of transport node (required)

tunnelName - Tunnel name (required)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.TunnelProperties

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

Tunnel properties

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

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

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

Parameters:

nodeId - ID of transport node (required)

tunnelName - Tunnel name (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 tunnelName,
         java.lang.String source,
         com.vmware.vapi.bindings.client.AsyncCallback<TunnelProperties> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Tunnel properties

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

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

Parameters:

nodeId - ID of transport node (required)

tunnelName - Tunnel name (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

TunnelList list(java.lang.String nodeId,
                java.lang.String bfdDiagnosticCode,
                java.lang.String cursor,
                java.lang.String encap,
                java.lang.String includedFields,
                java.lang.Long pageSize,
                java.lang.String remoteNodeId,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                java.lang.String source,
                java.lang.String status)

List of tunnels

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

Parameters:

nodeId - ID of transport node (required)

bfdDiagnosticCode - BFD diagnostic code of Tunnel as defined in RFC 5880 (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

encap - Tunnel encapsulation type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

remoteNodeId - (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

status - Tunnel status (optional)

Returns:

com.vmware.nsx.model.TunnelList

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

TunnelList list(java.lang.String nodeId,
                java.lang.String bfdDiagnosticCode,
                java.lang.String cursor,
                java.lang.String encap,
                java.lang.String includedFields,
                java.lang.Long pageSize,
                java.lang.String remoteNodeId,
                java.lang.Boolean sortAscending,
                java.lang.String sortBy,
                java.lang.String source,
                java.lang.String status,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List of tunnels

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 - ID of transport node (required)

bfdDiagnosticCode - BFD diagnostic code of Tunnel as defined in RFC 5880 (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

encap - Tunnel encapsulation type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

remoteNodeId - (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

status - Tunnel status (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.TunnelList

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 bfdDiagnosticCode,
          java.lang.String cursor,
          java.lang.String encap,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String remoteNodeId,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          java.lang.String status,
          com.vmware.vapi.bindings.client.AsyncCallback<TunnelList> asyncCallback)

List of tunnels

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

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

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

Parameters:

nodeId - ID of transport node (required)

bfdDiagnosticCode - BFD diagnostic code of Tunnel as defined in RFC 5880 (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

encap - Tunnel encapsulation type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

remoteNodeId - (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

status - Tunnel status (optional)

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

list

void list(java.lang.String nodeId,
          java.lang.String bfdDiagnosticCode,
          java.lang.String cursor,
          java.lang.String encap,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.String remoteNodeId,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          java.lang.String source,
          java.lang.String status,
          com.vmware.vapi.bindings.client.AsyncCallback<TunnelList> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List of tunnels

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

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

Parameters:

nodeId - ID of transport node (required)

bfdDiagnosticCode - BFD diagnostic code of Tunnel as defined in RFC 5880 (optional)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

encap - Tunnel encapsulation type (optional)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

remoteNodeId - (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

status - Tunnel status (optional)

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

invocationConfig - Configuration for the method invocation.