com.vmware.nsx.node.network

Interface Routes

All Superinterfaces:

RoutesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RoutesStub

public interface Routes
extends com.vmware.vapi.bindings.Service, RoutesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.node.network.RoutesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
NodeRouteProperties	create(NodeRouteProperties nodeRouteProperties) Add a route to the node routing table.
void	create(NodeRouteProperties nodeRouteProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback) Add a route to the node routing table.
void	create(NodeRouteProperties nodeRouteProperties, com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add a route to the node routing table.
NodeRouteProperties	create(NodeRouteProperties nodeRouteProperties, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Add a route to the node routing table.
void	delete(java.lang.String routeId) Delete a route from the node routing table.
void	delete(java.lang.String routeId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete a route from the node routing table.
void	delete(java.lang.String routeId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a route from the node routing table.
void	delete(java.lang.String routeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete a route from the node routing table.
NodeRouteProperties	get(java.lang.String routeId) Returns detailed information about a specified route in the node routing table.
void	get(java.lang.String routeId, com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback) Returns detailed information about a specified route in the node routing table.
void	get(java.lang.String routeId, com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about a specified route in the node routing table.
NodeRouteProperties	get(java.lang.String routeId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about a specified route in the node routing table.
NodeRoutePropertiesListResult	list() Returns detailed information about each route in the node routing table.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeRoutePropertiesListResult> asyncCallback) Returns detailed information about each route in the node routing table.
void	list(com.vmware.vapi.bindings.client.AsyncCallback<NodeRoutePropertiesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about each route in the node routing table.
NodeRoutePropertiesListResult	list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns detailed information about each route in the node routing table.

Method Detail

create

NodeRouteProperties create(NodeRouteProperties nodeRouteProperties)

Add a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route.

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

Parameters:

nodeRouteProperties - (required)

Returns:

com.vmware.nsx.model.NodeRouteProperties

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

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

NodeRouteProperties create(NodeRouteProperties nodeRouteProperties,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route.

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:

nodeRouteProperties - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeRouteProperties

Throws:

com.vmware.vapi.std.errors.ConcurrentChange - Conflict

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

void create(NodeRouteProperties nodeRouteProperties,
            com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback)

Add a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route.

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

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

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

Parameters:

nodeRouteProperties - (required)

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

create

void create(NodeRouteProperties nodeRouteProperties,
            com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Add a route to the node routing table. For static routes, the route_type, interface_id, netmask, and destination are required parameters. For default routes, the route_type, gateway address, and interface_id are required. For blackhole routes, the route_type and destination are required. All other parameters are optional. When you add a static route, the scope and route_id are created automatically. When you add a default or blackhole route, the route_id is created automatically. The route_id is read-only, meaning that it cannot be modified. All other properties can be modified by deleting and readding the route.

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

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

Parameters:

nodeRouteProperties - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String routeId)

Delete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route.

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

Parameters:

routeId - ID of route to delete (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

delete

void delete(java.lang.String routeId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route.

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:

routeId - ID of route to delete (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

delete

void delete(java.lang.String routeId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route.

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:

routeId - ID of route to delete (required)

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

delete

void delete(java.lang.String routeId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete a route from the node routing table. You can modify an existing route by deleting it and then posting the modified version of the route. To verify, remove the route ID from the URI, issue a GET request, and note the absense of the deleted route.

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:

routeId - ID of route to delete (required)

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

invocationConfig - Configuration for the method invocation.

get

NodeRouteProperties get(java.lang.String routeId)

Returns detailed information about a specified route in the node routing table.

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

Parameters:

routeId - ID of route to read (required)

Returns:

com.vmware.nsx.model.NodeRouteProperties

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

NodeRouteProperties get(java.lang.String routeId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns detailed information about a specified route in the node 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.

Parameters:

routeId - ID of route to read (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeRouteProperties

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 routeId,
         com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback)

Returns detailed information about a specified route in the node routing table.

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

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

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

Parameters:

routeId - ID of route to read (required)

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

get

void get(java.lang.String routeId,
         com.vmware.vapi.bindings.client.AsyncCallback<NodeRouteProperties> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns detailed information about a specified route in the node 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.NodeRouteProperties

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

Parameters:

routeId - ID of route to read (required)

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

invocationConfig - Configuration for the method invocation.

list

NodeRoutePropertiesListResult list()

Returns detailed information about each route in the node routing table. Routes can be of any type i.e. IPv4 or IPv6 or both. Route information includes the route ipv6 flag (True or False), route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. If ipv6 flag is True then route information is for IPv6 route else for IPv4 route. The route scope refers to the distance to the destination network: The \"host\" scope leads to a destination address on the node, such as a loopback address; the \"link\" scope leads to a destination on the local network; and the \"global\" scope leads to addresses that are more than one hop away.

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

Returns:

com.vmware.nsx.model.NodeRoutePropertiesListResult

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

NodeRoutePropertiesListResult list(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns detailed information about each route in the node routing table. Routes can be of any type i.e. IPv4 or IPv6 or both. Route information includes the route ipv6 flag (True or False), route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. If ipv6 flag is True then route information is for IPv6 route else for IPv4 route. The route scope refers to the distance to the destination network: The \"host\" scope leads to a destination address on the node, such as a loopback address; the \"link\" scope leads to a destination on the local network; and the \"global\" scope leads to addresses that are more than one hop away.

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:

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.NodeRoutePropertiesListResult

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(com.vmware.vapi.bindings.client.AsyncCallback<NodeRoutePropertiesListResult> asyncCallback)

Returns detailed information about each route in the node routing table. Routes can be of any type i.e. IPv4 or IPv6 or both. Route information includes the route ipv6 flag (True or False), route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. If ipv6 flag is True then route information is for IPv6 route else for IPv4 route. The route scope refers to the distance to the destination network: The \"host\" scope leads to a destination address on the node, such as a loopback address; the \"link\" scope leads to a destination on the local network; and the \"global\" scope leads to addresses that are more than one hop away.

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

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

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

Parameters:

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

list

void list(com.vmware.vapi.bindings.client.AsyncCallback<NodeRoutePropertiesListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns detailed information about each route in the node routing table. Routes can be of any type i.e. IPv4 or IPv6 or both. Route information includes the route ipv6 flag (True or False), route type (default, static, and so on), a unique route identifier, the route metric, the protocol from which the route was learned, the route source (which is the preferred egress interface), the route destination, and the route scope. If ipv6 flag is True then route information is for IPv6 route else for IPv4 route. The route scope refers to the distance to the destination network: The \"host\" scope leads to a destination address on the node, such as a loopback address; the \"link\" scope leads to a destination on the local network; and the \"global\" scope leads to addresses that are more than one hop away.

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

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

Parameters:

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

invocationConfig - Configuration for the method invocation.