Set Target Vds Topology

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.

Request

URI

POST

https://nsxmanager.your.domain/api/v1/nvds-urt/topology?action=apply

COPY

Query Parameters

string

cluster_id

Optional

cluster identifier

boolean

use_recommended_topology_config

Optional

Flag to indicate if use recommended topology got from the latest precheck

Request Body

UpgradeTopology of type(s) application/json

Optional

Show optional properties

{
    "topology": [
        {}
    ]
}

{
    "topology": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_protection": "string",
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "compute_manager_topology": [
                {
                    "compute_manager_id": "string",
                    "dvswitch": [
                        {
                            "_links": [
                                {
                                    "action": "string",
                                    "href": "string",
                                    "rel": "string"
                                }
                            ],
                            "_schema": "string",
                            "_self": {},
                            "_revision": 0,
                            "_create_time": 0,
                            "_create_user": "string",
                            "_last_modified_time": 0,
                            "_last_modified_user": "string",
                            "_protection": "string",
                            "_system_owned": false,
                            "description": "string",
                            "display_name": "string",
                            "id": "string",
                            "resource_type": "string",
                            "tags": [
                                {
                                    "scope": "string",
                                    "tag": "string"
                                }
                            ],
                            "cluster_id": "string",
                            "data_center_id": "string",
                            "status_details": [
                                "string"
                            ],
                            "transport_node_id": [
                                "string"
                            ],
                            "vds_config": {
                                "host_infra_traffic_res": [
                                    {
                                        "limit": "number",
                                        "reservation": "number",
                                        "shares": 0,
                                        "traffic_type": {
                                            "dynamic_res_pool_name": "string",
                                            "traffic_name": "string"
                                        }
                                    }
                                ],
                                "lacp_group_configs": [
                                    {
                                        "key": "string",
                                        "load_balance_algorithm": "string",
                                        "mode": "string",
                                        "name": "string",
                                        "timeout_type": "string",
                                        "uplink_names": [
                                            "string"
                                        ],
                                        "uplink_num": 0,
                                        "uplink_port_keys": [
                                            "string"
                                        ]
                                    }
                                ],
                                "lldp_send_enabled": false,
                                "mtu": 0,
                                "name": "string",
                                "uplink_port_names": [
                                    "string"
                                ],
                                "uuid": "string"
                            },
                            "vds_name": "string",
                            "vds_status": "string",
                            "vmknic": [
                                "string"
                            ]
                        }
                    ]
                }
            ],
            "nvds_id": "string",
            "nvds_name": "string"
        }
    ]
}

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns UpgradeTopology of type(s) application/json

"UpgradeTopology Object"

array of topology

topology

Required

All resultant VDS mapping for a NVDS after the migration

400

Returns BadRequest of type(s) application/json