com.vmware.nsx

Interface HostSwitchProfiles

All Superinterfaces:

HostSwitchProfilesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

HostSwitchProfilesStub

public interface HostSwitchProfiles
extends com.vmware.vapi.bindings.Service, HostSwitchProfilesTypes

Field Summary

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

Method Summary

Modifier and Type	Method and Description
com.vmware.vapi.bindings.Structure	create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile) Deprecated.
void	create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Deprecated.
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) Deprecated.
com.vmware.vapi.bindings.Structure	create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String hostSwitchProfileId) Deprecated.
void	delete(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Deprecated.
void	delete(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
void	delete(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
com.vmware.vapi.bindings.Structure	get(java.lang.String hostSwitchProfileId) Deprecated.
void	get(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Deprecated.
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) Deprecated.
com.vmware.vapi.bindings.Structure	get(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.
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) Deprecated.
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) Deprecated.
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) Deprecated.
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) Deprecated.
com.vmware.vapi.bindings.Structure	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure baseHostSwitchProfile) Deprecated.
void	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Deprecated.
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) Deprecated.
com.vmware.vapi.bindings.Structure	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure baseHostSwitchProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated.

Method Detail

create

@Deprecated
com.vmware.vapi.bindings.Structure create(com.vmware.vapi.bindings.Structure baseHostSwitchProfile)

Deprecated.

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.

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.

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

Deprecated.

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.

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.

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

Deprecated.

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

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

@Deprecated
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)

Deprecated.

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

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

@Deprecated
void delete(java.lang.String hostSwitchProfileId)

Deprecated.

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.

Parameters:

hostSwitchProfileId - (required)

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 hostSwitchProfileId,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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.

Parameters:

hostSwitchProfileId - (required)

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 hostSwitchProfileId,
                        com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Deprecated.

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

Parameters:

hostSwitchProfileId - (required)

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

delete

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

Deprecated.

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

Parameters:

hostSwitchProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

get

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

Deprecated.

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.

Parameters:

hostSwitchProfileId - (required)

Returns:

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

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

Deprecated.

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.

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.

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

Deprecated.

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

Parameters:

hostSwitchProfileId - (required)

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

get

@Deprecated
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)

Deprecated.

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

Parameters:

hostSwitchProfileId - (required)

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

invocationConfig - Configuration for the method invocation.

list

@Deprecated
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)

Deprecated.

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.

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

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
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)

Deprecated.

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.

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

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 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)

Deprecated.

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

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

@Deprecated
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)

Deprecated.

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

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

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

Deprecated.

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.

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.

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
com.vmware.vapi.bindings.Structure update(java.lang.String hostSwitchProfileId,
                                                      com.vmware.vapi.bindings.Structure baseHostSwitchProfile,
                                                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated.

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.

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.

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

Deprecated.

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

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

@Deprecated
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)

Deprecated.

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

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.