com.vmware.nsx.logical_router_ports

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_router_ports.StateTypes

_VAPI_SERVICE_ID

Method Summary

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

Method Detail

get

@Deprecated
LogicalRouterPortState get(java.lang.String logicalRouterPortId,
                                       java.lang.Long barrierId,
                                       java.lang.String requestId)

Deprecated.

Return realized state information of a logical router port. Any configuration update that affects the logical router port 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 logical router ports, dhcp relays, etc.

To get all realized entities for the intent use below Policy API.
GET /policy/api/v1/infra/realized-state/realized-entities?intent_path=
For realized status of the intent use below Policy API.
GET /policy/api/v1/infra/realized-state/status?intent_path=
can be one of the following.
/infra/tier-0s//locale-services//interfaces/
/infra/tier-1s//locale-services//interfaces/
/infra/tier-1s//segments/ for DOWNLINK
/infra/segments/ for DOWNLINK
There are specific Policy APIs to get Segment state.
GET /policy/api/v1/infra/segments//state
GET /policy/api/v1/infra/tier-1s//segments//state
For DAD status use below Policy APIs.
GET /policy/api/v1/infra/segments//gateway-interface-dad-state
GET /policy/api/v1/infra/tier-1s//segments//gateway-interface-dad-state
For DAD status of all interfaces created on Gateway use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//state
GET /policy/api/v1/infra/tier-1s//state

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

Parameters:

logicalRouterPortId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

Returns:

com.vmware.nsx.model.LogicalRouterPortState

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

Deprecated.

Return realized state information of a logical router port. Any configuration update that affects the logical router port 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 logical router ports, dhcp relays, etc.

To get all realized entities for the intent use below Policy API.
GET /policy/api/v1/infra/realized-state/realized-entities?intent_path=
For realized status of the intent use below Policy API.
GET /policy/api/v1/infra/realized-state/status?intent_path=
can be one of the following.
/infra/tier-0s//locale-services//interfaces/
/infra/tier-1s//locale-services//interfaces/
/infra/tier-1s//segments/ for DOWNLINK
/infra/segments/ for DOWNLINK
There are specific Policy APIs to get Segment state.
GET /policy/api/v1/infra/segments//state
GET /policy/api/v1/infra/tier-1s//segments//state
For DAD status use below Policy APIs.
GET /policy/api/v1/infra/segments//gateway-interface-dad-state
GET /policy/api/v1/infra/tier-1s//segments//gateway-interface-dad-state
For DAD status of all interfaces created on Gateway use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//state
GET /policy/api/v1/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:

logicalRouterPortId - (required)

barrierId - (optional)

requestId - Realization request ID (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalRouterPortState

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

Deprecated.

Return realized state information of a logical router port. Any configuration update that affects the logical router port 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 logical router ports, dhcp relays, etc.

To get all realized entities for the intent use below Policy API.
GET /policy/api/v1/infra/realized-state/realized-entities?intent_path=
For realized status of the intent use below Policy API.
GET /policy/api/v1/infra/realized-state/status?intent_path=
can be one of the following.
/infra/tier-0s//locale-services//interfaces/
/infra/tier-1s//locale-services//interfaces/
/infra/tier-1s//segments/ for DOWNLINK
/infra/segments/ for DOWNLINK
There are specific Policy APIs to get Segment state.
GET /policy/api/v1/infra/segments//state
GET /policy/api/v1/infra/tier-1s//segments//state
For DAD status use below Policy APIs.
GET /policy/api/v1/infra/segments//gateway-interface-dad-state
GET /policy/api/v1/infra/tier-1s//segments//gateway-interface-dad-state
For DAD status of all interfaces created on Gateway use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//state
GET /policy/api/v1/infra/tier-1s//state

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

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

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

Parameters:

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

Deprecated.

Return realized state information of a logical router port. Any configuration update that affects the logical router port 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 logical router ports, dhcp relays, etc.

To get all realized entities for the intent use below Policy API.
GET /policy/api/v1/infra/realized-state/realized-entities?intent_path=
For realized status of the intent use below Policy API.
GET /policy/api/v1/infra/realized-state/status?intent_path=
can be one of the following.
/infra/tier-0s//locale-services//interfaces/
/infra/tier-1s//locale-services//interfaces/
/infra/tier-1s//segments/ for DOWNLINK
/infra/segments/ for DOWNLINK
There are specific Policy APIs to get Segment state.
GET /policy/api/v1/infra/segments//state
GET /policy/api/v1/infra/tier-1s//segments//state
For DAD status use below Policy APIs.
GET /policy/api/v1/infra/segments//gateway-interface-dad-state
GET /policy/api/v1/infra/tier-1s//segments//gateway-interface-dad-state
For DAD status of all interfaces created on Gateway use below Policy APIs.
GET /policy/api/v1/infra/tier-0s//state
GET /policy/api/v1/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.LogicalRouterPortState

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

Parameters:

logicalRouterPortId - (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.