Set VDS configuration and create it in vCenter

Request:

Method:

POST

URI Path(s):

/api/v1/nvds-urt/topology?action=apply

Request Headers:

n/a

Query Parameters:

SetTargetVdsTopologyParameters+

Name	Description	Type	Notes
cluster_id	cluster identifier	string
use_recommended_topology_config	Flag to indicate if use recommended topology got from the latest precheck	boolean

Request Body:

UpgradeTopology+

Name	Description	Type	Notes
topology	All resultant VDS mapping for a NVDS after the migration	array of NvdsUpgradeTopology	Required

Example Request:

PUT https://<nsx-mgr>/api/v1/nvds-urt/topology?action=apply { "topology": [ { "nvds_id": "bb 23 24 9d e4 0a 4c 62-91 9b 77 66 55 29 4c 92", "nvds_name": "mynvds1", "compute_manager_topology": [ { "compute_manager_id": "ddb8efeb-581e-435a-93b7-f95da399d7e0", "dvswitch": [ { "data_center_id": "domain-c8:70dade9c-eaf2-462b-9005-7ecf14595c19", "vds_name": "myvds1", "transport_node_id": ["674007b3-5671-4409-911f-1c191ef492f7"] } ] } ] } ] }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

UpgradeTopology+

Name	Description	Type	Notes
topology	All resultant VDS mapping for a NVDS after the migration	array of NvdsUpgradeTopology	Required

Example Response:

{ "topology": [ { "nvds_id": "bb 23 24 9d e4 0a 4c 62-91 9b 77 66 55 29 4c 92", "nvds_name": "mynvds1", "compute_manager_topology": [ { "compute_manager_id": "ddb8efeb-581e-435a-93b7-f95da399d7e0", "dvswitch": [ { "data_center_id": "domain-c8:70dade9c-eaf2-462b-9005-7ecf14595c19", "vds_name": "myvds1", "transport_node_id": [ "674007b3-5671-4409-911f-1c191ef492f7" ] } ] } ] } ] }

Required Permissions:

crud

Feature:

nodes_transport_nodes Description:

Upon successful preheck status goes to PENDING_TOPOLOGY and global recommended topology is generated which can be retrieved via GetRecommendedVdsTopology API. User can apply the entire recommeneded topology all together or can apply partial depending on which TrasportNodes user wants to be upgraded from NVDS to CVDS. User can change system generated vds_name field, all other fields cannot be changed when applying topology.