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

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

Delete a Hostswitch Profile


Deletes a specified hostswitch profile. 		DELETE /api/v1/host-switch-profiles/<host-switch-profile-id>

Get a Hostswitch Profile by ID


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

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>

List Transport Nodes


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

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.
POST /api/v1/transport-node-profiles

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.
DELETE /api/v1/transport-node-profiles/<transport-node-profile-id>

Get a Transport Node


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

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.
PUT /api/v1/transport-node-profiles/<transport-node-profile-id>

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.
GET /api/v1/transportzone-profiles

Create a transport zone Profile


Creates a transport zone profile. The resource_type is required.
POST /api/v1/transportzone-profiles

Delete a transport zone Profile


Deletes a specified transport zone profile. 		DELETE /api/v1/transportzone-profiles/<transportzone-profile-id>

Get transport zone profile by identifier


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

Update a transport zone profile


Modifies a specified transport zone profile. The body of the PUT request must include the resource_type.
PUT /api/v1/transportzone-profiles/<transportzone-profile-id>