com.vmware.nsx.logical_routers.routing

Class RoutingTableStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.logical_routers.routing.RoutingTableStub

All Implemented Interfaces:

RoutingTable, RoutingTableTypes, com.vmware.vapi.bindings.Service

public class RoutingTableStub
extends com.vmware.vapi.internal.bindings.Stub
implements RoutingTable

Remote stub implementation of the RoutingTable 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.logical_routers.routing.RoutingTableTypes

_VAPI_SERVICE_ID, LIST_ROUTE_SOURCE_BGP, LIST_ROUTE_SOURCE_CONNECTED, LIST_ROUTE_SOURCE_OSPF, LIST_ROUTE_SOURCE_STATIC, LIST_SOURCE_CACHED, LIST_SOURCE_REALTIME, LIST_VRF_TABLE_DEFAULT, LIST_VRF_TABLE_INTER_SR

Constructor Summary

Constructors

Constructor and Description
RoutingTableStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
RoutingTableStub(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
LogicalRouterRouteTable	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.String routeSource, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, java.lang.String vrfTable) Returns the route table(RIB) for the logical router on a node of the given transport-node-id.
void	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.String routeSource, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, java.lang.String vrfTable, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback) Returns the route table(RIB) for the logical router on a node of the given transport-node-id.
void	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.String routeSource, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, java.lang.String vrfTable, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterRouteTable> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the route table(RIB) for the logical router on a node of the given transport-node-id.
LogicalRouterRouteTable	list(java.lang.String logicalRouterId, java.lang.String cursor, java.lang.String includedFields, java.lang.String networkPrefix, java.lang.Long pageSize, java.lang.String routeSource, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String transportNodeId, java.lang.String vrfTable, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the route table(RIB) for the logical router on a node of the given transport-node-id.

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

RoutingTableStub

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

RoutingTableStub

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

Method Detail

list

public LogicalRouterRouteTable list(java.lang.String logicalRouterId,
                                    java.lang.String cursor,
                                    java.lang.String includedFields,
                                    java.lang.String networkPrefix,
                                    java.lang.Long pageSize,
                                    java.lang.String routeSource,
                                    java.lang.Boolean sortAscending,
                                    java.lang.String sortBy,
                                    java.lang.String source,
                                    java.lang.String transportNodeId,
                                    java.lang.String vrfTable)

Description copied from interface: RoutingTable

Returns the route table(RIB) 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, parameter \"network_prefix=\" needs to be specified. To filter the result by route source, parameter \"route_source=\" needs to be specified where source_type can be BGP, STATIC, CONNECTED, NSX_STATIC, TIER1_NAT or TIER0_NAT. It is also possible to filter the RIB table using both network address and route source filter together. Query parameter \"source=realtime\" is the only supported source.

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

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

Specified by:

list in interface RoutingTable

Parameters:

logicalRouterId - (required)

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 - IPAddress or CIDR Block (optional)

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

routeSource - Route source filter parameter (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

vrfTable - VRF filter parameter (optional)

Returns:

com.vmware.nsx.model.LogicalRouterRouteTable

list

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

Description copied from interface: RoutingTable

Returns the route table(RIB) 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, parameter \"network_prefix=\" needs to be specified. To filter the result by route source, parameter \"route_source=\" needs to be specified where source_type can be BGP, STATIC, CONNECTED, NSX_STATIC, TIER1_NAT or TIER0_NAT. It is also possible to filter the RIB table using both network address and route source filter together. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//routing-table
GET /policy/api/v1/infra/tier-1s//routing-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.

Specified by:

list in interface RoutingTable

Parameters:

logicalRouterId - (required)

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 - IPAddress or CIDR Block (optional)

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

routeSource - Route source filter parameter (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

vrfTable - VRF filter parameter (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalRouterRouteTable

list

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

Description copied from interface: RoutingTable

Returns the route table(RIB) 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, parameter \"network_prefix=\" needs to be specified. To filter the result by route source, parameter \"route_source=\" needs to be specified where source_type can be BGP, STATIC, CONNECTED, NSX_STATIC, TIER1_NAT or TIER0_NAT. It is also possible to filter the RIB table using both network address and route source filter together. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//routing-table
GET /policy/api/v1/infra/tier-1s//routing-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

Specified by:

list in interface RoutingTable

Parameters:

logicalRouterId - (required)

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 - IPAddress or CIDR Block (optional)

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

routeSource - Route source filter parameter (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

vrfTable - VRF filter parameter (optional)

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

list

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

Description copied from interface: RoutingTable

Returns the route table(RIB) 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, parameter \"network_prefix=\" needs to be specified. To filter the result by route source, parameter \"route_source=\" needs to be specified where source_type can be BGP, STATIC, CONNECTED, NSX_STATIC, TIER1_NAT or TIER0_NAT. It is also possible to filter the RIB table using both network address and route source filter together. Query parameter \"source=realtime\" is the only supported source.

Please use below Policy API.
GET /policy/api/v1/infra/tier-0s//routing-table
GET /policy/api/v1/infra/tier-1s//routing-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

Specified by:

list in interface RoutingTable

Parameters:

logicalRouterId - (required)

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 - IPAddress or CIDR Block (optional)

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

routeSource - Route source filter parameter (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

transportNodeId - TransportNode Id (optional)

vrfTable - VRF filter parameter (optional)

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

invocationConfig - Configuration for the method invocation.