com.vmware.nsx_policy.infra

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_policy.infra.HostSwitchProfilesTypes

_VAPI_SERVICE_ID, LIST_DEPLOYMENT_TYPE_PHYSICAL_MACHINE, LIST_DEPLOYMENT_TYPE_UNKNOWN, LIST_DEPLOYMENT_TYPE_VIRTUAL_MACHINE, LIST_HOSTSWITCH_PROFILE_TYPE_POLICYEXTRACONFIGHOSTSWITCHPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_POLICYHIGHPERFORMANCEHOSTSWITCHPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_POLICYLLDPHOSTSWITCHPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_POLICYNIOCPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_POLICYUPLINKHOSTSWITCHPROFILE, LIST_HOSTSWITCH_PROFILE_TYPE_POLICYVTEPHAHOSTSWITCHPROFILE, LIST_NODE_TYPE_EDGENODE, LIST_NODE_TYPE_PUBLICCLOUDGATEWAYNODE

Method Summary

Modifier and Type	Method and Description
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.
PolicyHostSwitchProfilesListResult	list(java.lang.String cursor, java.lang.String deploymentType, java.lang.String hostswitchProfileType, java.lang.Boolean includeMarkForDeleteObjects, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.Long maxActiveUplinkCount, 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 includeMarkForDeleteObjects, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.Long maxActiveUplinkCount, 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<PolicyHostSwitchProfilesListResult> 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 includeMarkForDeleteObjects, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.Long maxActiveUplinkCount, 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<PolicyHostSwitchProfilesListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns information about the configured hostswitch profiles.
PolicyHostSwitchProfilesListResult	list(java.lang.String cursor, java.lang.String deploymentType, java.lang.String hostswitchProfileType, java.lang.Boolean includeMarkForDeleteObjects, java.lang.Boolean includeSystemOwned, java.lang.String includedFields, java.lang.Long maxActiveUplinkCount, 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	patch(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure policyBaseHostSwitchProfile) Patch a hostswitch profile.
void	patch(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure policyBaseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Patch a hostswitch profile.
void	patch(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure policyBaseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Patch a hostswitch profile.
com.vmware.vapi.bindings.Structure	patch(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure policyBaseHostSwitchProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Patch a hostswitch profile.
com.vmware.vapi.bindings.Structure	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure policyBaseHostSwitchProfile) Create or update a hostswitch profile.
void	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure policyBaseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback) Create or update a hostswitch profile.
void	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure policyBaseHostSwitchProfile, com.vmware.vapi.bindings.client.AsyncCallback<com.vmware.vapi.bindings.Structure> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create or update a hostswitch profile.
com.vmware.vapi.bindings.Structure	update(java.lang.String hostSwitchProfileId, com.vmware.vapi.bindings.Structure policyBaseHostSwitchProfile, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Create or update a hostswitch profile.

Method Detail

delete

void delete(java.lang.String hostSwitchProfileId)

Deletes a specified hostswitch profile.

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

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

Deletes a specified hostswitch profile.

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

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

Deletes a specified hostswitch profile.

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

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.

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

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

Returns information about a specified hostswitch profile.

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

Parameters:

hostSwitchProfileId - (required)

Returns:

com.vmware.nsx_policy.model.PolicyBaseHostSwitchProfile The return value will contain all the properties defined in PolicyBaseHostSwitchProfile.

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

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

Returns information about a specified hostswitch profile.

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

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

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.

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

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

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

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.

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

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

PolicyHostSwitchProfilesListResult list(java.lang.String cursor,
                                        java.lang.String deploymentType,
                                        java.lang.String hostswitchProfileType,
                                        java.lang.Boolean includeMarkForDeleteObjects,
                                        java.lang.Boolean includeSystemOwned,
                                        java.lang.String includedFields,
                                        java.lang.Long maxActiveUplinkCount,
                                        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. Hostswitch profiles define networking policies for hostswitches (sometimes referred to as bridges in OVS). Currently, following profiles are supported. UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

maxActiveUplinkCount - Filter uplink profiles by number of active links in teaming policy. (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_policy.model.PolicyHostSwitchProfilesListResult

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

PolicyHostSwitchProfilesListResult list(java.lang.String cursor,
                                        java.lang.String deploymentType,
                                        java.lang.String hostswitchProfileType,
                                        java.lang.Boolean includeMarkForDeleteObjects,
                                        java.lang.Boolean includeSystemOwned,
                                        java.lang.String includedFields,
                                        java.lang.Long maxActiveUplinkCount,
                                        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. Hostswitch profiles define networking policies for hostswitches (sometimes referred to as bridges in OVS). Currently, following profiles are supported. UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

maxActiveUplinkCount - Filter uplink profiles by number of active links in teaming policy. (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_policy.model.PolicyHostSwitchProfilesListResult

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

void list(java.lang.String cursor,
          java.lang.String deploymentType,
          java.lang.String hostswitchProfileType,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.Boolean includeSystemOwned,
          java.lang.String includedFields,
          java.lang.Long maxActiveUplinkCount,
          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<PolicyHostSwitchProfilesListResult> asyncCallback)

Returns information about the configured hostswitch profiles. Hostswitch profiles define networking policies for hostswitches (sometimes referred to as bridges in OVS). Currently, following profiles are supported. UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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

Invocation Result:
com.vmware.nsx_policy.model.PolicyHostSwitchProfilesListResult

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

maxActiveUplinkCount - Filter uplink profiles by number of active links in teaming policy. (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

void list(java.lang.String cursor,
          java.lang.String deploymentType,
          java.lang.String hostswitchProfileType,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.Boolean includeSystemOwned,
          java.lang.String includedFields,
          java.lang.Long maxActiveUplinkCount,
          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<PolicyHostSwitchProfilesListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns information about the configured hostswitch profiles. Hostswitch profiles define networking policies for hostswitches (sometimes referred to as bridges in OVS). Currently, following profiles are supported. UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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_policy.model.PolicyHostSwitchProfilesListResult

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)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

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)

maxActiveUplinkCount - Filter uplink profiles by number of active links in teaming policy. (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.

patch

com.vmware.vapi.bindings.Structure patch(java.lang.String hostSwitchProfileId,
                                         com.vmware.vapi.bindings.Structure policyBaseHostSwitchProfile)

Patch a hostswitch profile. The resource_type is required and needs to be one of the following, UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - 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. Teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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

Parameters:

hostSwitchProfileId - (required)

policyBaseHostSwitchProfile - (required) The parameter must contain all the properties defined in PolicyBaseHostSwitchProfile.

Returns:

com.vmware.nsx_policy.model.PolicyBaseHostSwitchProfile The return value will contain all the properties defined in PolicyBaseHostSwitchProfile.

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

patch

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

Patch a hostswitch profile. The resource_type is required and needs to be one of the following, UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - 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. Teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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)

policyBaseHostSwitchProfile - (required) The parameter must contain all the properties defined in PolicyBaseHostSwitchProfile.

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyBaseHostSwitchProfile The return value will contain all the properties defined in PolicyBaseHostSwitchProfile.

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

patch

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

Patch a hostswitch profile. The resource_type is required and needs to be one of the following, UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - 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. Teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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

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

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

Parameters:

hostSwitchProfileId - (required)

policyBaseHostSwitchProfile - (required) The parameter must contain all the properties defined in PolicyBaseHostSwitchProfile.

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

patch

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

Patch a hostswitch profile. The resource_type is required and needs to be one of the following, UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - 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. Teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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

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

Parameters:

hostSwitchProfileId - (required)

policyBaseHostSwitchProfile - (required) The parameter must contain all the properties defined in PolicyBaseHostSwitchProfile.

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

invocationConfig - Configuration for the method invocation.

update

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

Create or update a hostswitch profile. The resource_type is required and needs to be one of the following, UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - 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. Teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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

Parameters:

hostSwitchProfileId - (required)

policyBaseHostSwitchProfile - (required) The parameter must contain all the properties defined in PolicyBaseHostSwitchProfile.

Returns:

com.vmware.nsx_policy.model.PolicyBaseHostSwitchProfile The return value will contain all the properties defined in PolicyBaseHostSwitchProfile.

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

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

Create or update a hostswitch profile. The resource_type is required and needs to be one of the following, UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - 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. Teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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)

policyBaseHostSwitchProfile - (required) The parameter must contain all the properties defined in PolicyBaseHostSwitchProfile.

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.PolicyBaseHostSwitchProfile The return value will contain all the properties defined in PolicyBaseHostSwitchProfile.

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

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

Create or update a hostswitch profile. The resource_type is required and needs to be one of the following, UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - 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. Teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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

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

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

Parameters:

hostSwitchProfileId - (required)

policyBaseHostSwitchProfile - (required) The parameter must contain all the properties defined in PolicyBaseHostSwitchProfile.

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

update

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

Create or update a hostswitch profile. The resource_type is required and needs to be one of the following, UplinkHostSwitchProfile, LldpHostSwitchProfile, NiocProfile & ExtraConfigHostSwitchProfile. Uplink profile - 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. Teaming defined in this profile 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. Lldp profile - Activate or deactivate sending LLDP packets NiocProfile - Network I/O Control settings: defines limits, shares and reservations for various host traffic types. ExtraConfig - Vendor specific configuration on HostSwitch, logical switch or logical port

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

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

Parameters:

hostSwitchProfileId - (required)

policyBaseHostSwitchProfile - (required) The parameter must contain all the properties defined in PolicyBaseHostSwitchProfile.

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

invocationConfig - Configuration for the method invocation.