REST API - install

vcenter nsx deployment install: install spec

The install_spec contains the inputs related to appliance deployment operation. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

JSON

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

Attributes:

Name	Type	Description
Required
placement	placement_spec	This subsection describes the VC inventory on which to deploy 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.
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.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.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`.
appliance	appliance_spec	Spec which describes configuration of the new NSX appliance to be 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.
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.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.
Optional
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_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_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.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.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.
policy	string	Spec which describes configuration of the new NSX appliance to be 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, default storage policy will be set.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vcenter.StoragePolicy`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vcenter.StoragePolicy`.