REST API - get

vcenter nsx deployment configuration: get

Gets the configuration details of currently installed NSX on the vCenter Server Appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/vcenter/nsx/deployment/configuration

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "appliance" : {
        "size" : "string",
        "root_password" : "secret string",
        "name" : "string",
        "thin" : true,
        "network" : {
            "subnet" : "string",
            "hostname" : "string",
            "ip" : "string",
            "gateway" : "string",
            "dns_servers" : [
                "string",
                "string"
            ]
        }
    },
    "product_type" : "NSXT",
    "placement" : {
        "cluster" : "obj-103",
        "cluster_name" : "string",
        "datastore" : "obj-103",
        "network_name" : "string",
        "datastore_name" : "string",
        "network" : "obj-103"
    },
    "version" : "string",
    "status" : "UNCONFIGURED"
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	info	Info for the currenly deployed NSX appliance.
-.status	string	The NSX configuration status on the vCenter. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Describes the state of NSX deployment. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: UNCONFIGURED: NSX is not configured on the vCenter Server. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. CONFIGURED: NSX is configured on the vCenter Server. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.product_type	string	The product type of the NSX deployment. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Describes the product type of NSX deployment. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: NSXT: Full version of NSX with all features. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. NSXE: Limited functionalities only to provide WCP support. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.Optional. It is only relevant when status has value [CONFIGURED]. This field is optional and it is only relevant when the value of `status` is CONFIGURED.
-.version	string	The version of deployed NSX. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. It is only relevant when status has value [CONFIGURED]. This field is optional and it is only relevant when the value of `status` is CONFIGURED.
-.placement	placement_spec	This subsection describes the VC inventory on which NSX Manager appliance is deployed. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, no spec in case NSXT.
-.placement.cluster	string	The identifier of the cluster of which the appliance is a member. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ClusterComputeResource:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ClusterComputeResource:VCenter`.
-.placement.cluster_name	string	The name of the cluster of which the appliance is a member. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, cluster ID will be used.
-.placement.network	string	The identifier of the Network object used to attach the appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Network:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Network:VCenter`.
-.placement.network_name	string	The name of the Network object used to attach the appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, network ID will be used.
-.placement.datastore	string	The identifier of the datastore to put all the virtual disks on. The datastore must be accessible from the management vCenter. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore:VCenter`.
-.placement.datastore_name	string	The name of the datastore. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, datastore ID will be used.
-.appliance	appliance_spec	Spec which describes configuration of the deployed NSX Manager appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, no spec in case NSXT.
-.appliance.name	string	The name of the appliance to deploy. Should not collide with the name of already existing VMs on the same Folder. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, system generated name will be assigned.
-.appliance.size	string	A size descriptor based on the resource requirement of the NSX appliance. Run the install-recommendation API to get the list of deployment sizes. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.appliance.root_password	secret	This password is for appliance OS root user Password must conform to the following requirements: 1. At least 8 characters. 2. No more than 20 characters. 3. At least 1 uppercase character. 4. At least 1 lowercase character. 5. At least 1 number. 6. At least 1 special character (e.g., '!', '(', '@', etc.). 7. Only visible A-Z, a-z, 0-9 and punctuation (spaces are not allowed). Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, system generated password will be used.
-.appliance.thin	boolean	A thin provisioned virtual disk has space allocated and zeroed on demand as the space is used. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.appliance.network	network	Network details of the appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.appliance.network.ip	string	Network IP address. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.appliance.network.hostname	string	Fully qualified domain name of the appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.appliance.network.subnet	string	The subnet mask of the network. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.appliance.network.gateway	string	Gateway of the network. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.appliance.network.dns_servers	string[]	A comma-separated list of IP addresses of DNS servers. A JSON array such as ["1.2.3.4", "127.0.0.1"]. DNS servers must be reachable. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Errors:

HTTP Status Code	Type	Description
404	not_found	if the current NSX deployment settings could not be fetched.
500	error	if the system reports an error while responding to the request.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user is not a member of the Administrators group.