com.vmware.nsx.logical_routers.routing

Interface ForwardingTable

All Superinterfaces:

ForwardingTableTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ForwardingTableStub

public interface ForwardingTable
extends com.vmware.vapi.bindings.Service, ForwardingTableTypes

Field Summary

Fields inherited from interface com.vmware.nsx.logical_routers.routing.ForwardingTableTypes

_VAPI_SERVICE_ID, LIST_COMPONENT_TYPE_ROUTES, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME

Method Summary

Modifier and Type	Method and Description
LogicalRouterRouteTable	list(java.lang.String logicalRouterId, java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId) Deprecated.
void	list(java.lang.String logicalRouterId, java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback) Deprecated.
void	list(java.lang.String logicalRouterId, java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouterRouteTable	list(java.lang.String logicalRouterId, java.lang.String componentType, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

list

@Deprecated
LogicalRouterRouteTable list(java.lang.String logicalRouterId,
                                         java.lang.String componentType,
                                         java.lang.String cursor,
                                         java.lang.String includedFields,
                                         java.lang.String networkPrefix,
                                         java.lang.Long pageSize,
                                         java.lang.Boolean sortAscending,
                                         java.lang.String sortBy,
                                         java.lang.String source,
                                         java.lang.String transportNodeId)

Deprecated.

Returns the FIB for the logical router on a node of the given transport-node-id. Query parameter \"transport_node_id=\" is required. To filter the result by network address, paramter \"network_prefix=\" needs to be specified. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//forwarding-table
GET /policy/api/v1/infra/tier-1s//forwarding-table

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

Parameters:

logicalRouterId - (required)

componentType - Define the DR routes (optional)

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

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

networkPrefix - IPv4 or IPv6 CIDR Block (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

Returns:

com.vmware.nsx.model.LogicalRouterRouteTable

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

@Deprecated
LogicalRouterRouteTable list(java.lang.String logicalRouterId,
                                         java.lang.String componentType,
                                         java.lang.String cursor,
                                         java.lang.String includedFields,
                                         java.lang.String networkPrefix,
                                         java.lang.Long pageSize,
                                         java.lang.Boolean sortAscending,
                                         java.lang.String sortBy,
                                         java.lang.String source,
                                         java.lang.String transportNodeId,
                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns the FIB for the logical router on a node of the given transport-node-id. Query parameter \"transport_node_id=\" is required. To filter the result by network address, paramter \"network_prefix=\" needs to be specified. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//forwarding-table
GET /policy/api/v1/infra/tier-1s//forwarding-table

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:

logicalRouterId - (required)

componentType - Define the DR routes (optional)

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

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

networkPrefix - IPv4 or IPv6 CIDR Block (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalRouterRouteTable

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

@Deprecated
void list(java.lang.String logicalRouterId,
                      java.lang.String componentType,
                      java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.String networkPrefix,
                      java.lang.Long pageSize,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      java.lang.String source,
                      java.lang.String transportNodeId,
                      com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback)

Deprecated.

Returns the FIB for the logical router on a node of the given transport-node-id. Query parameter \"transport_node_id=\" is required. To filter the result by network address, paramter \"network_prefix=\" needs to be specified. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//forwarding-table
GET /policy/api/v1/infra/tier-1s//forwarding-table

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

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

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

Parameters:

logicalRouterId - (required)

componentType - Define the DR routes (optional)

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

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

networkPrefix - IPv4 or IPv6 CIDR Block (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

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

list

@Deprecated
void list(java.lang.String logicalRouterId,
                      java.lang.String componentType,
                      java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.String networkPrefix,
                      java.lang.Long pageSize,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      java.lang.String source,
                      java.lang.String transportNodeId,
                      com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns the FIB for the logical router on a node of the given transport-node-id. Query parameter \"transport_node_id=\" is required. To filter the result by network address, paramter \"network_prefix=\" needs to be specified. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//forwarding-table
GET /policy/api/v1/infra/tier-1s//forwarding-table

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

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

Parameters:

logicalRouterId - (required)

componentType - Define the DR routes (optional)

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

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

networkPrefix - IPv4 or IPv6 CIDR Block (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

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

invocationConfig - Configuration for the method invocation.