System Administration > Configuration > Fabric > Profiles

Associated URIs:

API Description API Path

List Cluster Profiles


Returns paginated list of cluster profiles
Cluster profiles define policies for edge cluster and bridge cluster.
GET /api/v1/cluster-profiles

Create a Cluster Profile


Create a cluster profile. The resource_type is required.
POST /api/v1/cluster-profiles

Delete a cluster profile


Delete a specified cluster profile. 		DELETE /api/v1/cluster-profiles/<cluster-profile-id>

Get cluster profile by Id


Returns information about a specified cluster profile. 		GET /api/v1/cluster-profiles/<cluster-profile-id>

Update a cluster profile


Modifie a specified cluster profile. The body of the PUT request must
include the resource_type.
PUT /api/v1/cluster-profiles/<cluster-profile-id>

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. This api is now deprecated. Please use new api -
policy/api/v1/infra/host-switch-profiles
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.
This api is now deprecated. Please use new api -
PUT policy/api/v1/infra/host-switch-profiles/uplinkProfile1
POST /api/v1/host-switch-profiles (Deprecated)

Delete a Hostswitch Profile


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

Get a Hostswitch Profile by ID


Returns information about a specified hostswitch profile. This api is now deprecated. Please use new api - policy/api/v1/infra/host-switch-profiles/uplinkProfile1 		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.
This api is now deprecated. Please use new api -
PATCH policy/api/v1/infra/host-switch-profiles/uplinkProfile1
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>

List Host Transport Nodes


Returns information about all host transport node profiles.
GET /policy/api/v1/infra/host-transport-node-profiles

Get a Transport Node


Returns information about a specified host transport node profile. 		GET /policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>

Delete a Host Transport Node Profile


Deletes the specified host transport node profile. A host transport node profile
can be deleted only when it is not attached to any compute collection.
DELETE /policy/api/v1/infra/host-transport-node-profiles/<transport-node-profile-id>

Update a Host Transport Node Profile


Host transport node profile captures the configuration needed to create
a host transport node. A host transport node profile can be attached to
compute collections for automatic host transport node creation of member hosts.

When configurations of a host transport node profile(TNP) are updated, all the
host transport nodes in all the compute collections to which this TNP is attached
are updated to reflect the updated configuration.
PUT /policy/api/v1/infra/host-transport-node-profiles/<transport-node-profile-id>

List Transport Nodes


Returns information about all transport node profiles.
This api is now deprecated. Please use new api -
/policy/api/v1/infra/host-transport-node-profiles
GET /api/v1/transport-node-profiles (Deprecated)

Create a Transport Node Profile


Transport node profile captures the configuration needed to create
a transport node. A transport node profile can be attached to
compute collections for automatic TN creation of member hosts.
This api is now deprecated. Please use new api -
/policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>
POST /api/v1/transport-node-profiles (Deprecated)

Delete a Transport Node Profile


Deletes the specified transport node profile. A transport node profile
can be deleted only when it is not attached to any compute collection.
This api is now deprecated. Please use new api -
/policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>
DELETE /api/v1/transport-node-profiles/<transport-node-profile-id> (Deprecated)

Get a Transport Node


Returns information about a specified transport node profile. This api is now deprecated. Please use new api - /policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id> 		GET /api/v1/transport-node-profiles/<transport-node-profile-id> (Deprecated)

Update a Transport Node Profile


When configurations of a transport node profile(TNP) is updated, all the
transport nodes in all the compute collections to which this TNP is attached
are updated to reflect the updated configuration.
This api is now deprecated. Please use new api -
/policy/api/v1/infra/host-transport-node-profiles/<host-transport-node-profile-id>
PUT /api/v1/transport-node-profiles/<transport-node-profile-id> (Deprecated)

List transport zone profiles


Returns information about the configured transport zone profiles. Transport zone
profiles define networking policies for transport zones and transport zone endpoints.
This api is now deprecated. Please use new api -
/policy/api/v1/infra/transport-zone-profiles
GET /api/v1/transportzone-profiles (Deprecated)

Create a transport zone Profile


Creates a transport zone profile. The resource_type is required.
This api is now deprecated. Please use new api -
PUT /policy/api/v1/infra/transport-zone-profiles/<tz-profile>
POST /api/v1/transportzone-profiles (Deprecated)

Delete a transport zone Profile


Deletes a specified transport zone profile. This api is now deprecated. Please use new api - DELETE /policy/api/v1/infra/transport-zone-profiles/<tz-profile> 		DELETE /api/v1/transportzone-profiles/<transportzone-profile-id> (Deprecated)

Get transport zone profile by identifier


Returns information about a specified transport zone profile. This api is now deprecated. Please use new api - /policy/api/v1/infra/transport-zone-profiles/<tz-profile> 		GET /api/v1/transportzone-profiles/<transportzone-profile-id> (Deprecated)

Update a transport zone profile


Modifies a specified transport zone profile. The body of the PUT request must include the resource_type.
This api is now deprecated. Please use new api -
PATCH /policy/api/v1/infra/transport-zone-profiles/<tz-profile>
PUT /api/v1/transportzone-profiles/<transportzone-profile-id> (Deprecated)