com.vmware.nsx

Interface LogicalRouters

All Superinterfaces:

LogicalRoutersTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

LogicalRoutersStub

public interface LogicalRouters
extends com.vmware.vapi.bindings.Service, LogicalRoutersTypes

Field Summary

Fields inherited from interface com.vmware.nsx.LogicalRoutersTypes

_VAPI_SERVICE_ID, LIST_ROUTER_TYPE_TIER0, LIST_ROUTER_TYPE_TIER1, LIST_ROUTER_TYPE_VRF

Method Summary

Modifier and Type	Method and Description
LogicalRouter	create(LogicalRouter logicalRouter) Deprecated.
void	create(LogicalRouter logicalRouter, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback) Deprecated.
void	create(LogicalRouter logicalRouter, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouter	create(LogicalRouter logicalRouter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.Boolean cascadeDeleteLinkedPorts, java.lang.Boolean force) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.Boolean cascadeDeleteLinkedPorts, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.Boolean cascadeDeleteLinkedPorts, java.lang.Boolean force, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String logicalRouterId, java.lang.Boolean cascadeDeleteLinkedPorts, java.lang.Boolean force, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouter	get(java.lang.String logicalRouterId) Deprecated.
void	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback) Deprecated.
void	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouter	get(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouterListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String routerType, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String vrfsOnLogicalRouterId) Deprecated.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String routerType, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String vrfsOnLogicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterListResult> asyncCallback) Deprecated.
void	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String routerType, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String vrfsOnLogicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouterListResult	list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String routerType, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String vrfsOnLogicalRouterId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouter	reallocate(java.lang.String logicalRouterId, ServiceRouterAllocationConfig serviceRouterAllocationConfig) Deprecated.
void	reallocate(java.lang.String logicalRouterId, ServiceRouterAllocationConfig serviceRouterAllocationConfig, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback) Deprecated.
void	reallocate(java.lang.String logicalRouterId, ServiceRouterAllocationConfig serviceRouterAllocationConfig, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouter	reallocate(java.lang.String logicalRouterId, ServiceRouterAllocationConfig serviceRouterAllocationConfig, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	reprocess(java.lang.String logicalRouterId) Deprecated.
void	reprocess(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	reprocess(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	reprocess(java.lang.String logicalRouterId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouter	update(java.lang.String logicalRouterId, LogicalRouter logicalRouter) Deprecated.
void	update(java.lang.String logicalRouterId, LogicalRouter logicalRouter, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback) Deprecated.
void	update(java.lang.String logicalRouterId, LogicalRouter logicalRouter, com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalRouter	update(java.lang.String logicalRouterId, LogicalRouter logicalRouter, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
LogicalRouter create(LogicalRouter logicalRouter)

Deprecated.

Creates a logical router. The required parameters are router_type (TIER0 or TIER1) and edge_cluster_id (TIER0 only). Optional parameters include internal and external transit network addresses.

Please use below policy apis instead of this API.
PATCH /infra/tier-0s/
PATCH /infra/tier-0s//locale-services/
PATCH /infra/tier-1s/
PATCH /infra/tier-1s//locale-services/

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

Parameters:

logicalRouter - (required)

Returns:

com.vmware.nsx.model.LogicalRouter

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

create

@Deprecated
LogicalRouter create(LogicalRouter logicalRouter,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Creates a logical router. The required parameters are router_type (TIER0 or TIER1) and edge_cluster_id (TIER0 only). Optional parameters include internal and external transit network addresses.

Please use below policy apis instead of this API.
PATCH /infra/tier-0s/
PATCH /infra/tier-0s//locale-services/
PATCH /infra/tier-1s/
PATCH /infra/tier-1s//locale-services/

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:

logicalRouter - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalRouter

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

create

@Deprecated
void create(LogicalRouter logicalRouter,
                        com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback)

Deprecated.

Creates a logical router. The required parameters are router_type (TIER0 or TIER1) and edge_cluster_id (TIER0 only). Optional parameters include internal and external transit network addresses.

Please use below policy apis instead of this API.
PATCH /infra/tier-0s/
PATCH /infra/tier-0s//locale-services/
PATCH /infra/tier-1s/
PATCH /infra/tier-1s//locale-services/

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

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

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

Parameters:

logicalRouter - (required)

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

create

@Deprecated
void create(LogicalRouter logicalRouter,
                        com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Creates a logical router. The required parameters are router_type (TIER0 or TIER1) and edge_cluster_id (TIER0 only). Optional parameters include internal and external transit network addresses.

Please use below policy apis instead of this API.
PATCH /infra/tier-0s/
PATCH /infra/tier-0s//locale-services/
PATCH /infra/tier-1s/
PATCH /infra/tier-1s//locale-services/

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

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

Parameters:

logicalRouter - (required)

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

invocationConfig - Configuration for the method invocation.

delete

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.Boolean cascadeDeleteLinkedPorts,
                        java.lang.Boolean force)

Deprecated.

Deletes the specified logical router. You must delete associated logical router ports before you can delete a logical router. Otherwise use force delete which will delete all related ports and other entities associated with that LR. To force delete logical router pass force=true in query param.

Please use below policy apis instead of this API.
DELETE /infra/tier-0s/
DELETE /infra/tier-1s/

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

Parameters:

logicalRouterId - (required)

cascadeDeleteLinkedPorts - Flag to specify whether to delete related logical switch ports (optional, default to false)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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

delete

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.Boolean cascadeDeleteLinkedPorts,
                        java.lang.Boolean force,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Deletes the specified logical router. You must delete associated logical router ports before you can delete a logical router. Otherwise use force delete which will delete all related ports and other entities associated with that LR. To force delete logical router pass force=true in query param.

Please use below policy apis instead of this API.
DELETE /infra/tier-0s/
DELETE /infra/tier-1s/

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)

cascadeDeleteLinkedPorts - Flag to specify whether to delete related logical switch ports (optional, default to false)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

invocationConfig - Configuration for the method invocation.

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

delete

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.Boolean cascadeDeleteLinkedPorts,
                        java.lang.Boolean force,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Deletes the specified logical router. You must delete associated logical router ports before you can delete a logical router. Otherwise use force delete which will delete all related ports and other entities associated with that LR. To force delete logical router pass force=true in query param.

Please use below policy apis instead of this API.
DELETE /infra/tier-0s/
DELETE /infra/tier-1s/

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

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

Parameters:

logicalRouterId - (required)

cascadeDeleteLinkedPorts - Flag to specify whether to delete related logical switch ports (optional, default to false)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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

delete

@Deprecated
void delete(java.lang.String logicalRouterId,
                        java.lang.Boolean cascadeDeleteLinkedPorts,
                        java.lang.Boolean force,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Deletes the specified logical router. You must delete associated logical router ports before you can delete a logical router. Otherwise use force delete which will delete all related ports and other entities associated with that LR. To force delete logical router pass force=true in query param.

Please use below policy apis instead of this API.
DELETE /infra/tier-0s/
DELETE /infra/tier-1s/

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

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

Parameters:

logicalRouterId - (required)

cascadeDeleteLinkedPorts - Flag to specify whether to delete related logical switch ports (optional, default to false)

force - Force delete the resource even if it is being used somewhere (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
LogicalRouter get(java.lang.String logicalRouterId)

Deprecated.

Returns information about the specified logical router.

Please use below policy apis instead of this API.
GET /infra/tier-0s/
GET /infra/tier-0s//locale-services/
GET /infra/tier-1s/
GET /infra/tier-1s//locale-services/

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

Parameters:

logicalRouterId - (required)

Returns:

com.vmware.nsx.model.LogicalRouter

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

@Deprecated
LogicalRouter get(java.lang.String logicalRouterId,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about the specified logical router.

Please use below policy apis instead of this API.
GET /infra/tier-0s/
GET /infra/tier-0s//locale-services/
GET /infra/tier-1s/
GET /infra/tier-1s//locale-services/

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)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalRouter

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

@Deprecated
void get(java.lang.String logicalRouterId,
                     com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback)

Deprecated.

Returns information about the specified logical router.

Please use below policy apis instead of this API.
GET /infra/tier-0s/
GET /infra/tier-0s//locale-services/
GET /infra/tier-1s/
GET /infra/tier-1s//locale-services/

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

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

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

Parameters:

logicalRouterId - (required)

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

get

@Deprecated
void get(java.lang.String logicalRouterId,
                     com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about the specified logical router.

Please use below policy apis instead of this API.
GET /infra/tier-0s/
GET /infra/tier-0s//locale-services/
GET /infra/tier-1s/
GET /infra/tier-1s//locale-services/

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

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

Parameters:

logicalRouterId - (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
LogicalRouterListResult list(java.lang.String cursor,
                                         java.lang.String includedFields,
                                         java.lang.Long pageSize,
                                         java.lang.String routerType,
                                         java.lang.Boolean sortAscending,
                                         java.lang.String sortBy,
                                         java.lang.String vrfsOnLogicalRouterId)

Deprecated.

Returns information about all logical routers, including the UUID, internal and external transit network addresses, and the router type (TIER0 or TIER1). You can get information for only TIER0 routers or only the TIER1 routers by including the router_type query parameter.

Please use below policy apis instead of this API.
GET /infra/tier-0s/
GET /infra/tier-1s/

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

Parameters:

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)

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

routerType - Type of Logical Router (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

vrfsOnLogicalRouterId - List all VRFs on the specified logical router. (optional)

Returns:

com.vmware.nsx.model.LogicalRouterListResult

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
LogicalRouterListResult list(java.lang.String cursor,
                                         java.lang.String includedFields,
                                         java.lang.Long pageSize,
                                         java.lang.String routerType,
                                         java.lang.Boolean sortAscending,
                                         java.lang.String sortBy,
                                         java.lang.String vrfsOnLogicalRouterId,
                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about all logical routers, including the UUID, internal and external transit network addresses, and the router type (TIER0 or TIER1). You can get information for only TIER0 routers or only the TIER1 routers by including the router_type query parameter.

Please use below policy apis instead of this API.
GET /infra/tier-0s/
GET /infra/tier-1s/

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:

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)

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

routerType - Type of Logical Router (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

vrfsOnLogicalRouterId - List all VRFs on the specified logical router. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalRouterListResult

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 cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.String routerType,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      java.lang.String vrfsOnLogicalRouterId,
                      com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterListResult> asyncCallback)

Deprecated.

Returns information about all logical routers, including the UUID, internal and external transit network addresses, and the router type (TIER0 or TIER1). You can get information for only TIER0 routers or only the TIER1 routers by including the router_type query parameter.

Please use below policy apis instead of this API.
GET /infra/tier-0s/
GET /infra/tier-1s/

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

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

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

Parameters:

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)

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

routerType - Type of Logical Router (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

vrfsOnLogicalRouterId - List all VRFs on the specified logical router. (optional)

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

list

@Deprecated
void list(java.lang.String cursor,
                      java.lang.String includedFields,
                      java.lang.Long pageSize,
                      java.lang.String routerType,
                      java.lang.Boolean sortAscending,
                      java.lang.String sortBy,
                      java.lang.String vrfsOnLogicalRouterId,
                      com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouterListResult> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about all logical routers, including the UUID, internal and external transit network addresses, and the router type (TIER0 or TIER1). You can get information for only TIER0 routers or only the TIER1 routers by including the router_type query parameter.

Please use below policy apis instead of this API.
GET /infra/tier-0s/
GET /infra/tier-1s/

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

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

Parameters:

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)

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

routerType - Type of Logical Router (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

vrfsOnLogicalRouterId - List all VRFs on the specified logical router. (optional)

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

invocationConfig - Configuration for the method invocation.

reallocate

@Deprecated
LogicalRouter reallocate(java.lang.String logicalRouterId,
                                     ServiceRouterAllocationConfig serviceRouterAllocationConfig)

Deprecated.

API to re allocate edge node placement for TIER1 logical router. You can re-allocate service routers of TIER1 in same edge cluster or different edge cluster. You can also place edge nodes manually and provide maximum two indices for HA mode ACTIVE_STANDBY. To re-allocate on new edge cluster you must have existing edge cluster for TIER1 logical router. This will be disruptive operation and all existing statistics of logical router will be remove.

In policy there will be no equivalent API but it will be achieved automatically when you will change edge cluster or will remove edge nodes from tier1 locale service

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

Parameters:

logicalRouterId - (required)

serviceRouterAllocationConfig - (required)

Returns:

com.vmware.nsx.model.LogicalRouter

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

reallocate

@Deprecated
LogicalRouter reallocate(java.lang.String logicalRouterId,
                                     ServiceRouterAllocationConfig serviceRouterAllocationConfig,
                                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

API to re allocate edge node placement for TIER1 logical router. You can re-allocate service routers of TIER1 in same edge cluster or different edge cluster. You can also place edge nodes manually and provide maximum two indices for HA mode ACTIVE_STANDBY. To re-allocate on new edge cluster you must have existing edge cluster for TIER1 logical router. This will be disruptive operation and all existing statistics of logical router will be remove.

In policy there will be no equivalent API but it will be achieved automatically when you will change edge cluster or will remove edge nodes from tier1 locale service

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)

serviceRouterAllocationConfig - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalRouter

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

reallocate

@Deprecated
void reallocate(java.lang.String logicalRouterId,
                            ServiceRouterAllocationConfig serviceRouterAllocationConfig,
                            com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback)

Deprecated.

API to re allocate edge node placement for TIER1 logical router. You can re-allocate service routers of TIER1 in same edge cluster or different edge cluster. You can also place edge nodes manually and provide maximum two indices for HA mode ACTIVE_STANDBY. To re-allocate on new edge cluster you must have existing edge cluster for TIER1 logical router. This will be disruptive operation and all existing statistics of logical router will be remove.

In policy there will be no equivalent API but it will be achieved automatically when you will change edge cluster or will remove edge nodes from tier1 locale service

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

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

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

Parameters:

logicalRouterId - (required)

serviceRouterAllocationConfig - (required)

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

reallocate

@Deprecated
void reallocate(java.lang.String logicalRouterId,
                            ServiceRouterAllocationConfig serviceRouterAllocationConfig,
                            com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

API to re allocate edge node placement for TIER1 logical router. You can re-allocate service routers of TIER1 in same edge cluster or different edge cluster. You can also place edge nodes manually and provide maximum two indices for HA mode ACTIVE_STANDBY. To re-allocate on new edge cluster you must have existing edge cluster for TIER1 logical router. This will be disruptive operation and all existing statistics of logical router will be remove.

In policy there will be no equivalent API but it will be achieved automatically when you will change edge cluster or will remove edge nodes from tier1 locale service

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

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

Parameters:

logicalRouterId - (required)

serviceRouterAllocationConfig - (required)

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

invocationConfig - Configuration for the method invocation.

reprocess

@Deprecated
void reprocess(java.lang.String logicalRouterId)

Deprecated.

Reprocess logical router configuration and configuration of related entities like logical router ports, static routing, etc. Any missing Updates are published to controller.

Please use below policy apis instead of this API.
POST /infra/tier-0s/?action=reprocess
POST /infra/tier-1s/?action=reprocess

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

Parameters:

logicalRouterId - (required)

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

reprocess

@Deprecated
void reprocess(java.lang.String logicalRouterId,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Reprocess logical router configuration and configuration of related entities like logical router ports, static routing, etc. Any missing Updates are published to controller.

Please use below policy apis instead of this API.
POST /infra/tier-0s/?action=reprocess
POST /infra/tier-1s/?action=reprocess

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)

invocationConfig - Configuration for the method invocation.

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

reprocess

@Deprecated
void reprocess(java.lang.String logicalRouterId,
                           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Reprocess logical router configuration and configuration of related entities like logical router ports, static routing, etc. Any missing Updates are published to controller.

Please use below policy apis instead of this API.
POST /infra/tier-0s/?action=reprocess
POST /infra/tier-1s/?action=reprocess

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

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

Parameters:

logicalRouterId - (required)

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

reprocess

@Deprecated
void reprocess(java.lang.String logicalRouterId,
                           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Reprocess logical router configuration and configuration of related entities like logical router ports, static routing, etc. Any missing Updates are published to controller.

Please use below policy apis instead of this API.
POST /infra/tier-0s/?action=reprocess
POST /infra/tier-1s/?action=reprocess

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

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

Parameters:

logicalRouterId - (required)

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

invocationConfig - Configuration for the method invocation.

update

@Deprecated
LogicalRouter update(java.lang.String logicalRouterId,
                                 LogicalRouter logicalRouter)

Deprecated.

Modifies the specified logical router. Modifiable attributes include the internal_transit_network, external_transit_networks, and edge_cluster_id (for TIER0 routers).

Please use below policy apis instead of this API.
PUT /infra/tier-0s/
PUT /infra/tier-0s//locale-services/
PUT /infra/tier-1s/
PUT /infra/tier-1s//locale-services/

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

Parameters:

logicalRouterId - (required)

logicalRouter - (required)

Returns:

com.vmware.nsx.model.LogicalRouter

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

@Deprecated
LogicalRouter update(java.lang.String logicalRouterId,
                                 LogicalRouter logicalRouter,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies the specified logical router. Modifiable attributes include the internal_transit_network, external_transit_networks, and edge_cluster_id (for TIER0 routers).

Please use below policy apis instead of this API.
PUT /infra/tier-0s/
PUT /infra/tier-0s//locale-services/
PUT /infra/tier-1s/
PUT /infra/tier-1s//locale-services/

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)

logicalRouter - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalRouter

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

@Deprecated
void update(java.lang.String logicalRouterId,
                        LogicalRouter logicalRouter,
                        com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback)

Deprecated.

Modifies the specified logical router. Modifiable attributes include the internal_transit_network, external_transit_networks, and edge_cluster_id (for TIER0 routers).

Please use below policy apis instead of this API.
PUT /infra/tier-0s/
PUT /infra/tier-0s//locale-services/
PUT /infra/tier-1s/
PUT /infra/tier-1s//locale-services/

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

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

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

Parameters:

logicalRouterId - (required)

logicalRouter - (required)

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

update

@Deprecated
void update(java.lang.String logicalRouterId,
                        LogicalRouter logicalRouter,
                        com.vmware.vapi.bindings.client.AsyncCallback<LogicalRouter> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies the specified logical router. Modifiable attributes include the internal_transit_network, external_transit_networks, and edge_cluster_id (for TIER0 routers).

Please use below policy apis instead of this API.
PUT /infra/tier-0s/
PUT /infra/tier-0s//locale-services/
PUT /infra/tier-1s/
PUT /infra/tier-1s//locale-services/

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

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

Parameters:

logicalRouterId - (required)

logicalRouter - (required)

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

invocationConfig - Configuration for the method invocation.