1. Types
  2. vcenter
  3. nsx
  4. deployment

vcenter nsx deployment: appliance spec

The appliance_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:

{
    "size" : "string",
    "root_password" : "secret string",
    "name" : "string",
    "thin" : true,
    "network" : {
        "subnet" : "string",
        "hostname" : "string",
        "ip" : "string",
        "gateway" : "string",
        "dns_servers" : [
            "string",
            "string"
        ]
    }
}

Attributes:

Name Type Description
Required
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.
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.
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.
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.
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.
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.
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.
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
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.
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.