com.vmware.nsx.logical_routers.service_cluster

Interface State

All Superinterfaces:

com.vmware.vapi.bindings.Service, StateTypes

All Known Implementing Classes:

StateStub

public interface State
extends com.vmware.vapi.bindings.Service, StateTypes

Field Summary

Fields inherited from interface com.vmware.nsx.logical_routers.service_cluster.StateTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
LogicalServiceRouterClusterState	get(java.lang.String logicalRouterId, java.lang.Long barrierId, java.lang.String requestId) Deprecated.
void	get(java.lang.String logicalRouterId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalServiceRouterClusterState> asyncCallback) Deprecated.
void	get(java.lang.String logicalRouterId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalServiceRouterClusterState> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalServiceRouterClusterState	get(java.lang.String logicalRouterId, java.lang.Long barrierId, java.lang.String requestId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

get

@Deprecated
LogicalServiceRouterClusterState get(java.lang.String logicalRouterId,
                                                 java.lang.Long barrierId,
                                                 java.lang.String requestId)

Deprecated.

Return realized state information of a logical service router cluster. Any configuration update that affects the logical service router cluster can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of nat, bgp, bfd, etc. What is a Service Router? When a service cannot be distributed is enabled on a Logical Router, a Service Router (SR) is instantiated. Some examples of services that are not distributed are NAT, DHCP server, Metadata Proxy, Edge Firewall, Load Balancer and so on.

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

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

Parameters:

logicalRouterId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

Returns:

com.vmware.nsx.model.LogicalServiceRouterClusterState

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
LogicalServiceRouterClusterState get(java.lang.String logicalRouterId,
                                                 java.lang.Long barrierId,
                                                 java.lang.String requestId,
                                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Return realized state information of a logical service router cluster. Any configuration update that affects the logical service router cluster can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of nat, bgp, bfd, etc. What is a Service Router? When a service cannot be distributed is enabled on a Logical Router, a Service Router (SR) is instantiated. Some examples of services that are not distributed are NAT, DHCP server, Metadata Proxy, Edge Firewall, Load Balancer and so on.

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

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)

barrierId - (optional)

requestId - Realization request ID (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalServiceRouterClusterState

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,
                     java.lang.Long barrierId,
                     java.lang.String requestId,
                     com.vmware.vapi.bindings.client.AsyncCallback<LogicalServiceRouterClusterState> asyncCallback)

Deprecated.

Return realized state information of a logical service router cluster. Any configuration update that affects the logical service router cluster can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of nat, bgp, bfd, etc. What is a Service Router? When a service cannot be distributed is enabled on a Logical Router, a Service Router (SR) is instantiated. Some examples of services that are not distributed are NAT, DHCP server, Metadata Proxy, Edge Firewall, Load Balancer and so on.

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

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

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

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

Parameters:

logicalRouterId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

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

get

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

Deprecated.

Return realized state information of a logical service router cluster. Any configuration update that affects the logical service router cluster can use this API to get its realized state by passing a request_id returned by the configuration change operation. e.g. Update configuration of nat, bgp, bfd, etc. What is a Service Router? When a service cannot be distributed is enabled on a Logical Router, a Service Router (SR) is instantiated. Some examples of services that are not distributed are NAT, DHCP server, Metadata Proxy, Edge Firewall, Load Balancer and so on.

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

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

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

Parameters:

logicalRouterId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

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

invocationConfig - Configuration for the method invocation.