com.vmware.nsx

Class HostSwitchProfilesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.HostSwitchProfilesStub

All Implemented Interfaces:

HostSwitchProfiles, HostSwitchProfilesTypes, com.vmware.vapi.bindings.Service

public class HostSwitchProfilesStub
extends com.vmware.vapi.internal.bindings.Stub
implements HostSwitchProfiles

Remote stub implementation of the HostSwitchProfiles API service.

WARNING: Internal class, subject to change in future versions.

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.nsx.HostSwitchProfilesTypes

_VAPI_SERVICE_ID, LIST_DEPLOYMENT_TYPE_PHYSICAL_MACHINE, LIST_DEPLOYMENT_TYPE_UNKNOWN, LIST_DEPLOYMENT_TYPE_VIRTUAL_MACHINE, LIST_HOSTSWITCH_PROFILE_TYPE_EXTRACONFIGHOSTSWITCHPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_HIGHPERFORMANCEHOSTSWITCHPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_LLDPHOSTSWITCHPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_NIOCPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_UPLINKHOSTSWITCHPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_VTEPHAHOSTSWITCHPROFILE, LIST_NODE_TYPE_EDGENODE, LIST_NODE_TYPE_PUBLICCLOUDGATEWAYNODE

Constructor Summary

Constructors

Constructor and Description
HostSwitchProfilesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
HostSwitchProfilesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

Method Summary

Modifier and Type	Method and Description
com.vmware.vapi.bindings.Structure	create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile) Creates a hostswitch profile.
void	create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Creates a hostswitch profile.
void	create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a hostswitch profile.
com.vmware.vapi.bindings.Structure	create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a hostswitch profile.
void	delete(java.lang.String hostSwitchProfileId) Deletes a specified hostswitch profile.
void	delete(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deletes a specified hostswitch profile.
void	delete(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes a specified hostswitch profile.
void	delete(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deletes a specified hostswitch profile.
com.vmware.vapi.bindings.Structure	get(java.lang.String hostSwitchProfileId) Returns information about a specified hostswitch profile.
void	get(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Returns information about a specified hostswitch profile.
void	get(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified hostswitch profile.
com.vmware.vapi.bindings.Structure	get(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about a specified hostswitch profile.
HostSwitchProfilesListResult	list(java.lang.String cursor, java.lang.String deploymentType, java.lang.String hostswitchProfileType, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.String nodeType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uplinkTeamingPolicyName) Returns information about the configured hostswitch profiles.
void	list(java.lang.String cursor, java.lang.String deploymentType, java.lang.String hostswitchProfileType, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.String nodeType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uplinkTeamingPolicyName, com.vmware.vapi.bindings.client.AsyncCallback<HostSwitchProfilesListResult> asyncCallback) Returns information about the configured hostswitch profiles.
void	list(java.lang.String cursor, java.lang.String deploymentType, java.lang.String hostswitchProfileType, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.String nodeType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uplinkTeamingPolicyName, com.vmware.vapi.bindings.client.AsyncCallback<HostSwitchProfilesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the configured hostswitch profiles.
HostSwitchProfilesListResult	list(java.lang.String cursor, java.lang.String deploymentType, java.lang.String hostswitchProfileType, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.String nodeType, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, java.lang.String uplinkTeamingPolicyName, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the configured hostswitch profiles.
com.vmware.vapi.bindings.Structure	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure baseHostSwitchProfile) Modifies a specified hostswitch profile.
void	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Modifies a specified hostswitch profile.
void	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies a specified hostswitch profile.
com.vmware.vapi.bindings.Structure	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Modifies a specified hostswitch profile.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HostSwitchProfilesStub

public HostSwitchProfilesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                              com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                              com.vmware.vapi.bindings.StubConfigurationBase config)

HostSwitchProfilesStub

public HostSwitchProfilesStub(com.vmware.vapi.core.ApiProvider apiProvider,
                              com.vmware.vapi.bindings.StubConfigurationBase config)

Method Detail

create

public com.vmware.vapi.bindings.Structure create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile)

Description copied from interface: HostSwitchProfiles

Creates a hostswitch profile. The resource_type is required. For uplink profiles, the teaming and policy parameters are required. By default, the mtu is 1600 and the transport_vlan is 0. The supported MTU range is 1280 through (uplink_mtu_threshold). (uplink_mtu_threshold) is 9000 by default. Range can be extended by modifying (uplink_mtu_threshold) in SwitchingGlobalConfig to the required upper threshold.
This api is now deprecated. Please use new api - PUT policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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

Specified by:

create in interface HostSwitchProfiles

Parameters:

baseHostSwitchProfile - (required) The parameter must contain all the properties defined in BaseHostSwitchProfile.

Returns:

com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

create

public com.vmware.vapi.bindings.Structure create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile,
                                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: HostSwitchProfiles

Creates a hostswitch profile. The resource_type is required. For uplink profiles, the teaming and policy parameters are required. By default, the mtu is 1600 and the transport_vlan is 0. The supported MTU range is 1280 through (uplink_mtu_threshold). (uplink_mtu_threshold) is 9000 by default. Range can be extended by modifying (uplink_mtu_threshold) in SwitchingGlobalConfig to the required upper threshold.
This api is now deprecated. Please use new api - PUT policy/api/v1/infra/host-switch-profiles/uplinkProfile1

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

create in interface HostSwitchProfiles

Parameters:

baseHostSwitchProfile - (required) The parameter must contain all the properties defined in BaseHostSwitchProfile.

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

create

public void create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile,
                   com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback)

Description copied from interface: HostSwitchProfiles

Creates a hostswitch profile. The resource_type is required. For uplink profiles, the teaming and policy parameters are required. By default, the mtu is 1600 and the transport_vlan is 0. The supported MTU range is 1280 through (uplink_mtu_threshold). (uplink_mtu_threshold) is 9000 by default. Range can be extended by modifying (uplink_mtu_threshold) in SwitchingGlobalConfig to the required upper threshold.
This api is now deprecated. Please use new api - PUT policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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

Invocation Result:
com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

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

Specified by:

create in interface HostSwitchProfiles

Parameters:

baseHostSwitchProfile - (required) The parameter must contain all the properties defined in BaseHostSwitchProfile.

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

create

public void create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile,
                   com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: HostSwitchProfiles

Creates a hostswitch profile. The resource_type is required. For uplink profiles, the teaming and policy parameters are required. By default, the mtu is 1600 and the transport_vlan is 0. The supported MTU range is 1280 through (uplink_mtu_threshold). (uplink_mtu_threshold) is 9000 by default. Range can be extended by modifying (uplink_mtu_threshold) in SwitchingGlobalConfig to the required upper threshold.
This api is now deprecated. Please use new api - PUT policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

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

Specified by:

create in interface HostSwitchProfiles

Parameters:

baseHostSwitchProfile - (required) The parameter must contain all the properties defined in BaseHostSwitchProfile.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(java.lang.String hostSwitchProfileId)

Description copied from interface: HostSwitchProfiles

Deletes a specified hostswitch profile.
This api is now deprecated. Please use new api - DELETE policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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

Specified by:

delete in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

delete

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

Description copied from interface: HostSwitchProfiles

Deletes a specified hostswitch profile.
This api is now deprecated. Please use new api - DELETE policy/api/v1/infra/host-switch-profiles/uplinkProfile1

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

delete in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

invocationConfig - Configuration for the method invocation.

delete

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

Description copied from interface: HostSwitchProfiles

Deletes a specified hostswitch profile.
This api is now deprecated. Please use new api - DELETE policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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

Specified by:

delete in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

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

delete

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

Description copied from interface: HostSwitchProfiles

Deletes a specified hostswitch profile.
This api is now deprecated. Please use new api - DELETE policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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

Specified by:

delete in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

get

public com.vmware.vapi.bindings.Structure get(java.lang.String hostSwitchProfileId)

Description copied from interface: HostSwitchProfiles

Returns information about a specified hostswitch profile.
This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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

Specified by:

get in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

Returns:

com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

get

public com.vmware.vapi.bindings.Structure get(java.lang.String hostSwitchProfileId,
                                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: HostSwitchProfiles

Returns information about a specified hostswitch profile.
This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles/uplinkProfile1

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

get in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

get

public void get(java.lang.String hostSwitchProfileId,
                com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback)

Description copied from interface: HostSwitchProfiles

Returns information about a specified hostswitch profile.
This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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

Invocation Result:
com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

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

Specified by:

get in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

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

get

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

Description copied from interface: HostSwitchProfiles

Returns information about a specified hostswitch profile.
This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

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

Specified by:

get in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

list

public HostSwitchProfilesListResult list(java.lang.String cursor,
                                         java.lang.String deploymentType,
                                         java.lang.String hostswitchProfileType,
                                         java.lang.Boolean includeSystemOwned,
                                         java.lang.String includedFields,
                                         java.lang.String nodeType,
                                         java.lang.Long pageSize,
                                         java.lang.Boolean sortAscending,
                                         java.lang.String sortBy,
                                         java.lang.String uplinkTeamingPolicyName)

Description copied from interface: HostSwitchProfiles

Returns information about the configured hostswitch profiles. Hostswitch profiles define networking policies for hostswitches (sometimes referred to as bridges in OVS). Currently, only uplink teaming is supported. Uplink teaming allows NSX to load balance traffic across different physical NICs (PNICs) on the hypervisor hosts. Multiple teaming policies are supported, including LACP active, LACP passive, load balancing based on source ID, and failover order.
This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles

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

Specified by:

list in interface HostSwitchProfiles

Parameters:

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

deploymentType - Supported edge deployment type. (optional)

hostswitchProfileType - Supported HostSwitch profiles. (optional)

includeSystemOwned - Whether the list result contains system resources (optional, default to false)

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

nodeType - Fabric node type for which uplink profiles are to be listed (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

uplinkTeamingPolicyName - The host switch profile's uplink teaming policy name (optional)

Returns:

com.vmware.nsx.model.HostSwitchProfilesListResult

list

public HostSwitchProfilesListResult list(java.lang.String cursor,
                                         java.lang.String deploymentType,
                                         java.lang.String hostswitchProfileType,
                                         java.lang.Boolean includeSystemOwned,
                                         java.lang.String includedFields,
                                         java.lang.String nodeType,
                                         java.lang.Long pageSize,
                                         java.lang.Boolean sortAscending,
                                         java.lang.String sortBy,
                                         java.lang.String uplinkTeamingPolicyName,
                                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: HostSwitchProfiles

Returns information about the configured hostswitch profiles. Hostswitch profiles define networking policies for hostswitches (sometimes referred to as bridges in OVS). Currently, only uplink teaming is supported. Uplink teaming allows NSX to load balance traffic across different physical NICs (PNICs) on the hypervisor hosts. Multiple teaming policies are supported, including LACP active, LACP passive, load balancing based on source ID, and failover order.
This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

list in interface HostSwitchProfiles

Parameters:

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

deploymentType - Supported edge deployment type. (optional)

hostswitchProfileType - Supported HostSwitch profiles. (optional)

includeSystemOwned - Whether the list result contains system resources (optional, default to false)

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

nodeType - Fabric node type for which uplink profiles are to be listed (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

uplinkTeamingPolicyName - The host switch profile's uplink teaming policy name (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.HostSwitchProfilesListResult

list

public void list(java.lang.String cursor,
                 java.lang.String deploymentType,
                 java.lang.String hostswitchProfileType,
                 java.lang.Boolean includeSystemOwned,
                 java.lang.String includedFields,
                 java.lang.String nodeType,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String uplinkTeamingPolicyName,
                 com.vmware.vapi.bindings.client.AsyncCallback<HostSwitchProfilesListResult> asyncCallback)

Description copied from interface: HostSwitchProfiles

Returns information about the configured hostswitch profiles. Hostswitch profiles define networking policies for hostswitches (sometimes referred to as bridges in OVS). Currently, only uplink teaming is supported. Uplink teaming allows NSX to load balance traffic across different physical NICs (PNICs) on the hypervisor hosts. Multiple teaming policies are supported, including LACP active, LACP passive, load balancing based on source ID, and failover order.
This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles

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

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

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

Specified by:

list in interface HostSwitchProfiles

Parameters:

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

deploymentType - Supported edge deployment type. (optional)

hostswitchProfileType - Supported HostSwitch profiles. (optional)

includeSystemOwned - Whether the list result contains system resources (optional, default to false)

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

nodeType - Fabric node type for which uplink profiles are to be listed (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

uplinkTeamingPolicyName - The host switch profile's uplink teaming policy name (optional)

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

list

public void list(java.lang.String cursor,
                 java.lang.String deploymentType,
                 java.lang.String hostswitchProfileType,
                 java.lang.Boolean includeSystemOwned,
                 java.lang.String includedFields,
                 java.lang.String nodeType,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 java.lang.String uplinkTeamingPolicyName,
                 com.vmware.vapi.bindings.client.AsyncCallback<HostSwitchProfilesListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: HostSwitchProfiles

Returns information about the configured hostswitch profiles. Hostswitch profiles define networking policies for hostswitches (sometimes referred to as bridges in OVS). Currently, only uplink teaming is supported. Uplink teaming allows NSX to load balance traffic across different physical NICs (PNICs) on the hypervisor hosts. Multiple teaming policies are supported, including LACP active, LACP passive, load balancing based on source ID, and failover order.
This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles

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

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

Specified by:

list in interface HostSwitchProfiles

Parameters:

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

deploymentType - Supported edge deployment type. (optional)

hostswitchProfileType - Supported HostSwitch profiles. (optional)

includeSystemOwned - Whether the list result contains system resources (optional, default to false)

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

nodeType - Fabric node type for which uplink profiles are to be listed (optional)

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

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

uplinkTeamingPolicyName - The host switch profile's uplink teaming policy name (optional)

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

invocationConfig - Configuration for the method invocation.

update

public com.vmware.vapi.bindings.Structure update(java.lang.String hostSwitchProfileId,
                                                 com.vmware.vapi.bindings.Structure baseHostSwitchProfile)

Description copied from interface: HostSwitchProfiles

Modifies a specified hostswitch profile. The body of the PUT request must include the resource_type. For uplink profiles, the put request must also include teaming parameters. Modifiable attributes include display_name, mtu, and transport_vlan. For uplink teaming policies, uplink_name and policy are also modifiable.
This api is now deprecated. Please use new api - PATCH policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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

Specified by:

update in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

baseHostSwitchProfile - (required) The parameter must contain all the properties defined in BaseHostSwitchProfile.

Returns:

com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

update

public com.vmware.vapi.bindings.Structure update(java.lang.String hostSwitchProfileId,
                                                 com.vmware.vapi.bindings.Structure baseHostSwitchProfile,
                                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: HostSwitchProfiles

Modifies a specified hostswitch profile. The body of the PUT request must include the resource_type. For uplink profiles, the put request must also include teaming parameters. Modifiable attributes include display_name, mtu, and transport_vlan. For uplink teaming policies, uplink_name and policy are also modifiable.
This api is now deprecated. Please use new api - PATCH policy/api/v1/infra/host-switch-profiles/uplinkProfile1

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

update in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

baseHostSwitchProfile - (required) The parameter must contain all the properties defined in BaseHostSwitchProfile.

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

update

public void update(java.lang.String hostSwitchProfileId,
                   com.vmware.vapi.bindings.Structure baseHostSwitchProfile,
                   com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback)

Description copied from interface: HostSwitchProfiles

Modifies a specified hostswitch profile. The body of the PUT request must include the resource_type. For uplink profiles, the put request must also include teaming parameters. Modifiable attributes include display_name, mtu, and transport_vlan. For uplink teaming policies, uplink_name and policy are also modifiable.
This api is now deprecated. Please use new api - PATCH policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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

Invocation Result:
com.vmware.nsx.model.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

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

Specified by:

update in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

baseHostSwitchProfile - (required) The parameter must contain all the properties defined in BaseHostSwitchProfile.

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

update

public void update(java.lang.String hostSwitchProfileId,
                   com.vmware.vapi.bindings.Structure baseHostSwitchProfile,
                   com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Description copied from interface: HostSwitchProfiles

Modifies a specified hostswitch profile. The body of the PUT request must include the resource_type. For uplink profiles, the put request must also include teaming parameters. Modifiable attributes include display_name, mtu, and transport_vlan. For uplink teaming policies, uplink_name and policy are also modifiable.
This api is now deprecated. Please use new api - PATCH policy/api/v1/infra/host-switch-profiles/uplinkProfile1

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.BaseHostSwitchProfile The return value will contain all the properties defined in BaseHostSwitchProfile.

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

Specified by:

update in interface HostSwitchProfiles

Parameters:

hostSwitchProfileId - (required)

baseHostSwitchProfile - (required) The parameter must contain all the properties defined in BaseHostSwitchProfile.

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

invocationConfig - Configuration for the method invocation.