System Administration > Configuration > Fabric > Profiles > Hostswitch Profiles

Associated URIs:

API Description API Path

List Hostswitch Profiles


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.
GET /api/v1/host-switch-profiles (Deprecated)

Create a Hostswitch Profile


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.
POST /api/v1/host-switch-profiles (Deprecated)

Delete a Hostswitch Profile


Deletes a specified hostswitch profile. 		DELETE /api/v1/host-switch-profiles/{host-switch-profile-id} (Deprecated)

Get a Hostswitch Profile by ID


Returns information about a specified hostswitch profile. 		GET /api/v1/host-switch-profiles/{host-switch-profile-id} (Deprecated)

Update a Hostswitch Profile


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.
PUT /api/v1/host-switch-profiles/{host-switch-profile-id} (Deprecated)

List Hostswitch Profiles


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 - Enable or disable 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
GET /policy/api/v1/infra/host-switch-profiles

Delete a Hostswitch Profile


Deletes a specified hostswitch profile. 		DELETE /policy/api/v1/infra/host-switch-profiles/{host-switch-profile-id}

Get a Hostswitch Profile by ID


Returns information about a specified hostswitch profile. 		GET /policy/api/v1/infra/host-switch-profiles/{host-switch-profile-id}

Create or update a Hostswitch Profile


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 - Enable or disable 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
PATCH /policy/api/v1/infra/host-switch-profiles/{host-switch-profile-id}

Create or update a Hostswitch Profile


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 - Enable or disable 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
PUT /policy/api/v1/infra/host-switch-profiles/{host-switch-profile-id}