com.vmware.nsx.logical_ports

Interface Status

All Superinterfaces:

com.vmware.vapi.bindings.Service, StatusTypes

All Known Implementing Classes:

StatusStub

public interface Status
extends com.vmware.vapi.bindings.Service, StatusTypes

Field Summary

Fields inherited from interface com.vmware.nsx.logical_ports.StatusTypes

_VAPI_SERVICE_ID, GET_SOURCE_CACHED, GET_SOURCE_REALTIME, GETALL_ATTACHMENT_TYPE_BRIDGEENDPOINT, GETALL_ATTACHMENT_TYPE_DHCP_SERVICE, GETALL_ATTACHMENT_TYPE_L2VPN_SESSION, GETALL_ATTACHMENT_TYPE_LOGICALROUTER, GETALL_ATTACHMENT_TYPE_METADATA_PROXY, GETALL_ATTACHMENT_TYPE_NONE, GETALL_ATTACHMENT_TYPE_VIF, GETALL_SOURCE_CACHED, GETALL_SOURCE_REALTIME

Method Summary

Modifier and Type	Method and Description
LogicalPortOperationalStatus	get(java.lang.String lportId, java.lang.String source) Deprecated.
void	get(java.lang.String lportId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortOperationalStatus> asyncCallback) Deprecated.
void	get(java.lang.String lportId, java.lang.String source, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortOperationalStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPortOperationalStatus	get(java.lang.String lportId, java.lang.String source, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPortStatusSummary	getall(java.lang.String attachmentId, java.lang.String attachmentType, java.lang.String bridgeClusterId, java.lang.Boolean containerPortsOnly, java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.String logicalSwitchId, java.lang.Long pageSize, java.lang.String parentVifId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId) Deprecated.
void	getall(java.lang.String attachmentId, java.lang.String attachmentType, java.lang.String bridgeClusterId, java.lang.Boolean containerPortsOnly, java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.String logicalSwitchId, java.lang.Long pageSize, java.lang.String parentVifId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortStatusSummary> asyncCallback) Deprecated.
void	getall(java.lang.String attachmentId, java.lang.String attachmentType, java.lang.String bridgeClusterId, java.lang.Boolean containerPortsOnly, java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.String logicalSwitchId, java.lang.Long pageSize, java.lang.String parentVifId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortStatusSummary> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPortStatusSummary	getall(java.lang.String attachmentId, java.lang.String attachmentType, java.lang.String bridgeClusterId, java.lang.Boolean containerPortsOnly, java.lang.String cursor, java.lang.Boolean diagnostic, java.lang.String includedFields, java.lang.String logicalSwitchId, java.lang.Long pageSize, java.lang.String parentVifId, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String source, java.lang.String switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

get

@Deprecated
LogicalPortOperationalStatus get(java.lang.String lportId,
                                             java.lang.String source)

Deprecated.

Returns operational status of a specified logical port.

This api is deprecated from 3.2.2. Please use policy api -
/infra/segments//ports//status

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

Parameters:

lportId - (required)

source - Data source type. (optional)

Returns:

com.vmware.nsx.model.LogicalPortOperationalStatus

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
LogicalPortOperationalStatus get(java.lang.String lportId,
                                             java.lang.String source,
                                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns operational status of a specified logical port.

This api is deprecated from 3.2.2. Please use policy api -
/infra/segments//ports//status

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:

lportId - (required)

source - Data source type. (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalPortOperationalStatus

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 lportId,
                     java.lang.String source,
                     com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortOperationalStatus> asyncCallback)

Deprecated.

Returns operational status of a specified logical port.

This api is deprecated from 3.2.2. Please use policy api -
/infra/segments//ports//status

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

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

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

Parameters:

lportId - (required)

source - Data source type. (optional)

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

get

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

Deprecated.

Returns operational status of a specified logical port.

This api is deprecated from 3.2.2. Please use policy api -
/infra/segments//ports//status

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

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

Parameters:

lportId - (required)

source - Data source type. (optional)

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

invocationConfig - Configuration for the method invocation.

getall

@Deprecated
LogicalPortStatusSummary getall(java.lang.String attachmentId,
                                            java.lang.String attachmentType,
                                            java.lang.String bridgeClusterId,
                                            java.lang.Boolean containerPortsOnly,
                                            java.lang.String cursor,
                                            java.lang.Boolean diagnostic,
                                            java.lang.String includedFields,
                                            java.lang.String logicalSwitchId,
                                            java.lang.Long pageSize,
                                            java.lang.String parentVifId,
                                            java.lang.Boolean sortAscending,
                                            java.lang.String sortBy,
                                            java.lang.String source,
                                            java.lang.String switchingProfileId,
                                            java.lang.String transportNodeId,
                                            java.lang.String transportZoneId)

Deprecated.

Returns operational status of all logical ports. The query parameter \"source=realtime\" is not supported. Pagination is not supported for this API. The query parameters \"cursor\", \"sort_ascending\", \"sort_by\", \"page_size\" and \"included_fields\" will be ignored.

This api is deprecated from 3.2.2. Please use policy api -
/search/query?query=resource_type:SegmentPort&included_fields=id&included_fields=admin_state

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

Parameters:

attachmentId - Logical Port attachment Id (optional)

attachmentType - Type of attachment for logical port; for query only. (optional)

bridgeClusterId - Bridge Cluster identifier (optional)

containerPortsOnly - Only container VIF logical ports will be returned if true (optional, default to false)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

diagnostic - Flag to enable showing of transit logical port. (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

logicalSwitchId - Logical Switch identifier (optional)

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

parentVifId - ID of the VIF of type PARENT (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

switchingProfileId - Network Profile identifier (optional)

transportNodeId - Transport node identifier (optional)

transportZoneId - Transport zone identifier (optional)

Returns:

com.vmware.nsx.model.LogicalPortStatusSummary

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

getall

@Deprecated
LogicalPortStatusSummary getall(java.lang.String attachmentId,
                                            java.lang.String attachmentType,
                                            java.lang.String bridgeClusterId,
                                            java.lang.Boolean containerPortsOnly,
                                            java.lang.String cursor,
                                            java.lang.Boolean diagnostic,
                                            java.lang.String includedFields,
                                            java.lang.String logicalSwitchId,
                                            java.lang.Long pageSize,
                                            java.lang.String parentVifId,
                                            java.lang.Boolean sortAscending,
                                            java.lang.String sortBy,
                                            java.lang.String source,
                                            java.lang.String switchingProfileId,
                                            java.lang.String transportNodeId,
                                            java.lang.String transportZoneId,
                                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns operational status of all logical ports. The query parameter \"source=realtime\" is not supported. Pagination is not supported for this API. The query parameters \"cursor\", \"sort_ascending\", \"sort_by\", \"page_size\" and \"included_fields\" will be ignored.

This api is deprecated from 3.2.2. Please use policy api -
/search/query?query=resource_type:SegmentPort&included_fields=id&included_fields=admin_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:

attachmentId - Logical Port attachment Id (optional)

attachmentType - Type of attachment for logical port; for query only. (optional)

bridgeClusterId - Bridge Cluster identifier (optional)

containerPortsOnly - Only container VIF logical ports will be returned if true (optional, default to false)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

diagnostic - Flag to enable showing of transit logical port. (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

logicalSwitchId - Logical Switch identifier (optional)

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

parentVifId - ID of the VIF of type PARENT (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

switchingProfileId - Network Profile identifier (optional)

transportNodeId - Transport node identifier (optional)

transportZoneId - Transport zone identifier (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalPortStatusSummary

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

getall

@Deprecated
void getall(java.lang.String attachmentId,
                        java.lang.String attachmentType,
                        java.lang.String bridgeClusterId,
                        java.lang.Boolean containerPortsOnly,
                        java.lang.String cursor,
                        java.lang.Boolean diagnostic,
                        java.lang.String includedFields,
                        java.lang.String logicalSwitchId,
                        java.lang.Long pageSize,
                        java.lang.String parentVifId,
                        java.lang.Boolean sortAscending,
                        java.lang.String sortBy,
                        java.lang.String source,
                        java.lang.String switchingProfileId,
                        java.lang.String transportNodeId,
                        java.lang.String transportZoneId,
                        com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortStatusSummary> asyncCallback)

Deprecated.

Returns operational status of all logical ports. The query parameter \"source=realtime\" is not supported. Pagination is not supported for this API. The query parameters \"cursor\", \"sort_ascending\", \"sort_by\", \"page_size\" and \"included_fields\" will be ignored.

This api is deprecated from 3.2.2. Please use policy api -
/search/query?query=resource_type:SegmentPort&included_fields=id&included_fields=admin_state

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

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

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

Parameters:

attachmentId - Logical Port attachment Id (optional)

attachmentType - Type of attachment for logical port; for query only. (optional)

bridgeClusterId - Bridge Cluster identifier (optional)

containerPortsOnly - Only container VIF logical ports will be returned if true (optional, default to false)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

diagnostic - Flag to enable showing of transit logical port. (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

logicalSwitchId - Logical Switch identifier (optional)

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

parentVifId - ID of the VIF of type PARENT (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

switchingProfileId - Network Profile identifier (optional)

transportNodeId - Transport node identifier (optional)

transportZoneId - Transport zone identifier (optional)

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

getall

@Deprecated
void getall(java.lang.String attachmentId,
                        java.lang.String attachmentType,
                        java.lang.String bridgeClusterId,
                        java.lang.Boolean containerPortsOnly,
                        java.lang.String cursor,
                        java.lang.Boolean diagnostic,
                        java.lang.String includedFields,
                        java.lang.String logicalSwitchId,
                        java.lang.Long pageSize,
                        java.lang.String parentVifId,
                        java.lang.Boolean sortAscending,
                        java.lang.String sortBy,
                        java.lang.String source,
                        java.lang.String switchingProfileId,
                        java.lang.String transportNodeId,
                        java.lang.String transportZoneId,
                        com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortStatusSummary> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns operational status of all logical ports. The query parameter \"source=realtime\" is not supported. Pagination is not supported for this API. The query parameters \"cursor\", \"sort_ascending\", \"sort_by\", \"page_size\" and \"included_fields\" will be ignored.

This api is deprecated from 3.2.2. Please use policy api -
/search/query?query=resource_type:SegmentPort&included_fields=id&included_fields=admin_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.LogicalPortStatusSummary

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

Parameters:

attachmentId - Logical Port attachment Id (optional)

attachmentType - Type of attachment for logical port; for query only. (optional)

bridgeClusterId - Bridge Cluster identifier (optional)

containerPortsOnly - Only container VIF logical ports will be returned if true (optional, default to false)

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

diagnostic - Flag to enable showing of transit logical port. (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

logicalSwitchId - Logical Switch identifier (optional)

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

parentVifId - ID of the VIF of type PARENT (optional)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

source - Data source type. (optional)

switchingProfileId - Network Profile identifier (optional)

transportNodeId - Transport node identifier (optional)

transportZoneId - Transport zone identifier (optional)

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

invocationConfig - Configuration for the method invocation.