com.vmware.nsx

Interface LogicalPorts

All Superinterfaces:

LogicalPortsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

LogicalPortsStub

public interface LogicalPorts
extends com.vmware.vapi.bindings.Service, LogicalPortsTypes

Field Summary

Fields inherited from interface com.vmware.nsx.LogicalPortsTypes

_VAPI_SERVICE_ID, LIST_ATTACHMENT_TYPE_BRIDGEENDPOINT, LIST_ATTACHMENT_TYPE_DHCP_SERVICE, LIST_ATTACHMENT_TYPE_L2VPN_SESSION, LIST_ATTACHMENT_TYPE_LOGICALROUTER, LIST_ATTACHMENT_TYPE_METADATA_PROXY, LIST_ATTACHMENT_TYPE_NONE, LIST_ATTACHMENT_TYPE_VIF

Method Summary

Modifier and Type	Method and Description
LogicalPort	create(LogicalPort logicalPort) Deprecated.
void	create(LogicalPort logicalPort, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPort> asyncCallback) Deprecated.
void	create(LogicalPort logicalPort, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPort> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPort	create(LogicalPort logicalPort, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String lportId, java.lang.Boolean detach) Deprecated.
void	delete(java.lang.String lportId, java.lang.Boolean detach, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String lportId, java.lang.Boolean detach, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String lportId, java.lang.Boolean detach, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPort	get(java.lang.String lportId) Deprecated.
void	get(java.lang.String lportId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPort> asyncCallback) Deprecated.
void	get(java.lang.String lportId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPort> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPort	get(java.lang.String lportId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPortListResult	list(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 switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId) Deprecated.
void	list(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 switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortListResult> asyncCallback) Deprecated.
void	list(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 switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPortListResult	list(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 switchingProfileId, java.lang.String transportNodeId, java.lang.String transportZoneId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPort	update(java.lang.String lportId, LogicalPort logicalPort) Deprecated.
void	update(java.lang.String lportId, LogicalPort logicalPort, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPort> asyncCallback) Deprecated.
void	update(java.lang.String lportId, LogicalPort logicalPort, com.vmware.vapi.bindings.client.AsyncCallback<LogicalPort> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
LogicalPort	update(java.lang.String lportId, LogicalPort logicalPort, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
LogicalPort create(LogicalPort logicalPort)

Deprecated.

Creates a new logical switch port. The required parameters are the associated logical_switch_id and admin_state (UP or DOWN). Optional parameters are the attachment and switching_profile_ids. If you don't specify switching_profile_ids, default switching profiles are assigned to the port. If you don't specify an attachment, the switch port remains empty. To configure an attachment, you must specify an id, and optionally you can specify an attachment_type (VIF or LOGICALROUTER). The attachment_type is VIF by default.
This api is now deprecated. Please use new api PUT /infra/segments//ports/

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

Parameters:

logicalPort - (required)

Returns:

com.vmware.nsx.model.LogicalPort

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
LogicalPort create(LogicalPort logicalPort,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Creates a new logical switch port. The required parameters are the associated logical_switch_id and admin_state (UP or DOWN). Optional parameters are the attachment and switching_profile_ids. If you don't specify switching_profile_ids, default switching profiles are assigned to the port. If you don't specify an attachment, the switch port remains empty. To configure an attachment, you must specify an id, and optionally you can specify an attachment_type (VIF or LOGICALROUTER). The attachment_type is VIF by default.
This api is now deprecated. Please use new api PUT /infra/segments//ports/

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:

logicalPort - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalPort

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

Deprecated.

Creates a new logical switch port. The required parameters are the associated logical_switch_id and admin_state (UP or DOWN). Optional parameters are the attachment and switching_profile_ids. If you don't specify switching_profile_ids, default switching profiles are assigned to the port. If you don't specify an attachment, the switch port remains empty. To configure an attachment, you must specify an id, and optionally you can specify an attachment_type (VIF or LOGICALROUTER). The attachment_type is VIF by default.
This api is now deprecated. Please use new api PUT /infra/segments//ports/

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

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

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

Parameters:

logicalPort - (required)

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

create

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

Deprecated.

Creates a new logical switch port. The required parameters are the associated logical_switch_id and admin_state (UP or DOWN). Optional parameters are the attachment and switching_profile_ids. If you don't specify switching_profile_ids, default switching profiles are assigned to the port. If you don't specify an attachment, the switch port remains empty. To configure an attachment, you must specify an id, and optionally you can specify an attachment_type (VIF or LOGICALROUTER). The attachment_type is VIF by default.
This api is now deprecated. Please use new api PUT /infra/segments//ports/

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

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

Parameters:

logicalPort - (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 lportId,
                        java.lang.Boolean detach)

Deprecated.

Deletes the specified logical switch port. By default, if logical port has attachments, or it is added to any NSGroup, the deletion will be failed. Option detach could be used for deleting logical port forcibly.
This api is now deprecated. Please use new api - DELETE /infra/segments//ports/

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

Parameters:

lportId - (required)

detach - force delete even if attached or referenced by a group (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 lportId,
                        java.lang.Boolean detach,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Deletes the specified logical switch port. By default, if logical port has attachments, or it is added to any NSGroup, the deletion will be failed. Option detach could be used for deleting logical port forcibly.
This api is now deprecated. Please use new api - DELETE /infra/segments//ports/

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)

detach - force delete even if attached or referenced by a group (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 lportId,
                        java.lang.Boolean detach,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

Deletes the specified logical switch port. By default, if logical port has attachments, or it is added to any NSGroup, the deletion will be failed. Option detach could be used for deleting logical port forcibly.
This api is now deprecated. Please use new api - DELETE /infra/segments//ports/

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:

lportId - (required)

detach - force delete even if attached or referenced by a group (optional, default to false)

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

delete

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

Deprecated.

Deletes the specified logical switch port. By default, if logical port has attachments, or it is added to any NSGroup, the deletion will be failed. Option detach could be used for deleting logical port forcibly.
This api is now deprecated. Please use new api - DELETE /infra/segments//ports/

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:

lportId - (required)

detach - force delete even if attached or referenced by a group (optional, default to false)

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

invocationConfig - Configuration for the method invocation.

get

@Deprecated
LogicalPort get(java.lang.String lportId)

Deprecated.

Returns information about a specified logical port.
Please use corresponding policy API /infra/segments//ports/

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

Parameters:

lportId - (required)

Returns:

com.vmware.nsx.model.LogicalPort

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

Deprecated.

Returns information about a specified logical port.
Please use corresponding policy API /infra/segments//ports/

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)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalPort

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

Deprecated.

Returns information about a specified logical port.
Please use corresponding policy API /infra/segments//ports/

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

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

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

Parameters:

lportId - (required)

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

get

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

Deprecated.

Returns information about a specified logical port.
Please use corresponding policy API /infra/segments//ports/

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

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

Parameters:

lportId - (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
LogicalPortListResult list(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 switchingProfileId,
                                       java.lang.String transportNodeId,
                                       java.lang.String transportZoneId)

Deprecated.

Returns information about all configured logical switch ports. Logical switch ports connect to VM virtual network interface cards (NICs). Each logical port is associated with one logical switch.
This api is now deprecated. Please use new api - /infra/segments//ports

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)

switchingProfileId - Network Profile identifier (optional)

transportNodeId - Transport node identifier (optional)

transportZoneId - Transport zone identifier (optional)

Returns:

com.vmware.nsx.model.LogicalPortListResult

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
LogicalPortListResult list(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 switchingProfileId,
                                       java.lang.String transportNodeId,
                                       java.lang.String transportZoneId,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about all configured logical switch ports. Logical switch ports connect to VM virtual network interface cards (NICs). Each logical port is associated with one logical switch.
This api is now deprecated. Please use new api - /infra/segments//ports

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)

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

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 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 switchingProfileId,
                      java.lang.String transportNodeId,
                      java.lang.String transportZoneId,
                      com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortListResult> asyncCallback)

Deprecated.

Returns information about all configured logical switch ports. Logical switch ports connect to VM virtual network interface cards (NICs). Each logical port is associated with one logical switch.
This api is now deprecated. Please use new api - /infra/segments//ports

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

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

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)

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.

list

@Deprecated
void list(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 switchingProfileId,
                      java.lang.String transportNodeId,
                      java.lang.String transportZoneId,
                      com.vmware.vapi.bindings.client.AsyncCallback<LogicalPortListResult> asyncCallback,
                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Returns information about all configured logical switch ports. Logical switch ports connect to VM virtual network interface cards (NICs). Each logical port is associated with one logical switch.
This api is now deprecated. Please use new api - /infra/segments//ports

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

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)

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.

update

@Deprecated
LogicalPort update(java.lang.String lportId,
                               LogicalPort logicalPort)

Deprecated.

Modifies an existing logical switch port. Parameters that can be modified include attachment_type (LOGICALROUTER, VIF), admin_state (UP or DOWN), attachment id and switching_profile_ids. You cannot modify the logical_switch_id. In other words, you cannot move an existing port from one switch to another switch.
This api is now deprecated. Please use new api - /infra/segments//ports/

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

Parameters:

lportId - (required)

logicalPort - (required)

Returns:

com.vmware.nsx.model.LogicalPort

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
LogicalPort update(java.lang.String lportId,
                               LogicalPort logicalPort,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies an existing logical switch port. Parameters that can be modified include attachment_type (LOGICALROUTER, VIF), admin_state (UP or DOWN), attachment id and switching_profile_ids. You cannot modify the logical_switch_id. In other words, you cannot move an existing port from one switch to another switch.
This api is now deprecated. Please use new api - /infra/segments//ports/

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)

logicalPort - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.LogicalPort

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 lportId,
                        LogicalPort logicalPort,
                        com.vmware.vapi.bindings.client.AsyncCallback<LogicalPort> asyncCallback)

Deprecated.

Modifies an existing logical switch port. Parameters that can be modified include attachment_type (LOGICALROUTER, VIF), admin_state (UP or DOWN), attachment id and switching_profile_ids. You cannot modify the logical_switch_id. In other words, you cannot move an existing port from one switch to another switch.
This api is now deprecated. Please use new api - /infra/segments//ports/

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

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

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

Parameters:

lportId - (required)

logicalPort - (required)

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

update

@Deprecated
void update(java.lang.String lportId,
                        LogicalPort logicalPort,
                        com.vmware.vapi.bindings.client.AsyncCallback<LogicalPort> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

Modifies an existing logical switch port. Parameters that can be modified include attachment_type (LOGICALROUTER, VIF), admin_state (UP or DOWN), attachment id and switching_profile_ids. You cannot modify the logical_switch_id. In other words, you cannot move an existing port from one switch to another switch.
This api is now deprecated. Please use new api - /infra/segments//ports/

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

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

Parameters:

lportId - (required)

logicalPort - (required)

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

invocationConfig - Configuration for the method invocation.