ProductNodeSpecV2

ProductNodeSpecV2
ProductNodeSpecV2

The node spec defining the node to be deployed

JSON Example
{
    "properties": {
        "properties": {}
    },
    "nodeId": 0,
    "isPrimary": false,
    "cpuNum": 0,
    "ramMemory": 0,
    "hostName": "string",
    "vmName": "string",
    "deploymentOption": "string",
    "datastoreName": "string",
    "clusterName": "string",
    "resourcePool": "string",
    "datacenterName": "string",
    "rootPassword": "string",
    "gateway": "string",
    "deployment": {
        "vcenterName": "string",
        "datacenterName": "string",
        "clusterName": "string",
        "resourcePool": "string",
        "vmFolder": "string",
        "datastoreNames": [
            "string"
        ]
    },
    "nics": [
        {
            "ipAddress": "string",
            "networkName": "string",
            "staticRoutes": [
                "string"
            ],
            "dcVcenterNetworksSpec": {
                "portGroupName": "string",
                "gateway": "string",
                "subnetMask": "string",
                "domainName": "string",
                "searchPath": [
                    "string"
                ],
                "useDhcp": false,
                "dns": [
                    "string"
                ],
                "ntp": [
                    "string"
                ]
            }
        }
    ],
    "status": "string"
}
object
properties
Optional

Additional properties

integer As int32 As int32
nodeId
Optional

The ID of the node.

boolean
isPrimary
Optional

Marks node as primary.

integer As int32 As int32
cpuNum
Optional

Number of CPUs to configure the VM with.

integer As int32 As int32
ramMemory
Optional

Memory size (in MB) to configure the VM with.

string As ^([a-z_A-Z0-9]([a-z_A-Z0-9\-]*[a-zA-Z0-9])?\.)*[a-z_A-Z0-9]([a-z_A-Z0-9\-]*[a-z_A-Z0-9])?$
hostName
Required

Hostname of the node.

string As ^[a-zA-Z0-9][a-zA-Z0-9\-_.()\[\]{}]{0,79}$
vmName
Required

VM name of the node.

string
deploymentOption
Optional

Deployment option of the VM (values depend on the product's OVF properties).

string
datastoreName
Optional

Datastore to use for the VM. If not defined, the first datastore of specified deployment infrastructure vCenter will be used.

string
clusterName
Optional

vCenter cluster name to use for the VM. If not defined, the cluster defined for specified deployment infrastructure vCenter will be used.

string
resourcePool
Optional

vCenter resource pool name to use for the VM. If not defined, the resource pool defined for specified deployment infrastructure vCenter will be used.

string
datacenterName
Optional

Datacenter name to use for the VM. If not defined, the datacenter defined for specified deployment infrastructure vCenter will be used.

string As (^[^'"]{2,32}$)|(^ref:password:[a-zA-Z0-9]{20}$)
rootPassword
Required

The password for root user (or similar admin user depending on OS).

string As ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
gateway
Optional

The gateway to configure for the VM. If not set, the value of the first NIC's network will be used.

deployment
Optional

The target vCenter to deploy the node - to be defined either on product or node level.

array of NicSpecV2
nics
Optional

List of NICs to configure for the VM.

string
status
Optional

status

Possible values are : MAINTENANCE, OFF, SERVICE_OFF, UNKNOWN, OK,