Cloud.vSphere.Machine | Aria Automation 8.16 Resource Type Schema

Cloud.vSphere.Machine

Request schema for provisioning of a vSphere machine resource

AnyOf

This class requires at least one of the following:

undefined

JSON Example

{
    "account": "string",
    "activeDirectory": {
        "finalRelativeDN": "string",
        "relativeDN": "string",
        "securityGroup": "string"
    },
    "address": "string",
    "attachedDisks": [
        {
            "source": "string"
        }
    ],
    "checkImageSSLCertificate": false,
    "cloneStrategy": "string",
    "cloudConfig": "string",
    "cloudConfigSettings": {
        "deploymentFailOnCloudConfigRuntimeError": false,
        "phoneHomeFailOnTimeout": false,
        "phoneHomeShouldWait": false,
        "phoneHomeTimeoutSeconds": 0
    },
    "constraints": [
        {
            "tag": "string"
        }
    ],
    "coreCount": 0,
    "count": 0,
    "cpuCount": 0,
    "customizationSpec": "string",
    "flavor": "string",
    "folderName": "string",
    "groupPlacement": "string",
    "ignoreActiveDirectory": "string",
    "image": "string",
    "imageRef": "string",
    "name": "string",
    "networks": [
        {
            "address": "string",
            "assignIPv6Address": false,
            "assignPublicIpAddress": false,
            "assignment": "string",
            "deviceIndex": 0,
            "dns": [
                "string"
            ],
            "dnsSearchDomains": [
                "string"
            ],
            "domain": "string",
            "gateway": "string",
            "netmask": "string",
            "network": "string",
            "primaryAddress": false,
            "securityGroups": [
                "string"
            ],
            "tags": [
                {
                    "key": "string",
                    "value": "string"
                }
            ]
        }
    ],
    "osType": "string",
    "ovfProperties": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "powerState": "string",
    "project": "string",
    "providerId": "string",
    "region": "string",
    "remoteAccess": {
        "authentication": "string",
        "password": "string",
        "privateKey": "string",
        "sshKey": "string",
        "username": "string"
    },
    "resourceLeaseDurationSec": 0,
    "resourceName": "string",
    "retryCount": 0,
    "snapshotLimit": 0,
    "storage": {
        "bootDiskCapacityInGB": 0,
        "constraints": [
            {
                "tag": "string"
            }
        ],
        "maxDiskCapacityInGB": 0
    },
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "totalMemoryMB": 0,
    "vcUuid": "string"
}

string

account

Optional

Cloud Account indicates the name of the endpoint used to provision this machine.

object

activeDirectory

Optional

Active Directory Configuration

string

address

Optional

Machine IP address, populated by discovery or provisioning.

array of object

attachedDisks

Optional

List of disks to attach to the machine.

boolean

checkImageSSLCertificate

Optional

The purpose of this boolean property is whether to skip or validate SSL/TLS certificate when streaming OVF or OVA.

string

cloneStrategy

Optional

If the type of request is a clone from a VM template, the strategy would determine if the clone is from the top most snapshot (LINKED) or a full clone (FULL). Default is considered as LINKED if snapshot is found on the image, else it will be FULL.

Possible values are : LINKED, FULL,

string

cloudConfig

Optional

When provisioning an instance, machine cloud-init startup instructions from user data fields. Sample cloud config instructions:

#cloud-config
repo_update: true
repo_upgrade: all
packages:
- httpd
- mariadb-server

runcmd:
- [ sh, -c, "amazon-linux-extras install -y lamp-mariadb10.2-php7.2 php7.2" ]
- systemctl start httpd
- sudo systemctl enable httpd

When cloud-init is used with static network assignment a customization spec is created on the fly and applied to the machine. When using both we suggest disabling network configuration on your template to avoid errors.

object

cloudConfigSettings

Optional

Specify how the provided Cloud Config should be handled

array of object

constraints

Optional

To target the correct resources, blueprint constraints are matched against infrastructure capability tags. Constraints must include the key name. Options include value, negative[!], and hard or soft requirement.

integer

coreCount

Optional

Number of cores per socket.

integer

count

Optional

The number of resource instances to be created.

integer

cpuCount

Optional

Number of virtual processors to assign to this machine. The default is 1.

string

customizationSpec

Optional

If machine settings from a vSphere customization spec need to be applied upon creation, the name of the customization spec to use, which must exist on the endpoint. Example customizations include host, network, and licensing settings.

string

flavor

Optional

Generic types of compute resources, mapped in an environment to specific types of compute resources.

string

folderName

Optional

The path to the folder where the virtual machine is provisioned, relative to the datacenter that the resource pool is in.

string

groupPlacement

Optional

Group Placement

string

ignoreActiveDirectory

Optional

Indicates that the machine is not added to Active Directory by a policy. It skips the Active Directory policy.

Possible values are : true, false,

string

image

Optional

Generic compute images, mapped in an environment to specific compute resource images.

string

imageRef

Optional

vSphere image used for creating the machine. Examples include templates, OVA or OVF links, snapshots, and content libraries.

string

name

Optional

Name of the machine as specified in the blueprint.

array of object

networks

Optional

Networks to attach to the machine. Multiple network interfaces are allowed.

string

osType

Optional

Operating system of the machine, populated by discovery or provisioning. Values include WINDOWS and LINUX.

array of object

ovfProperties

Optional

Map of key, value pairs. key is the ovf key for a property in an OVF package. value is the ovf value for a property in an ovf package.

string

powerState

Optional

Machine power state of ON, OFF, GUEST_OFF, UNKNOWN, or SUSPEND.

Possible values are : ON, OFF, SUSPEND, GUEST_OFF,

string

project

Optional

VMware Aria Automation Assembler project under which the machine is provisioned. Indicates project ID.

string

providerId

Optional

A unique identifier of the resource in the context of the provider.

string

region

Optional

Datacenter name where the machine landed.

object

remoteAccess

Optional

Settings to remotely connect to the provisioned machine, by public/private key pair or username/password authentication. vSphere supports key pair but not username/password.

integer

resourceLeaseDurationSec

Optional

Time in seconds SDRS should reserve storage on the datastore

string

resourceName

Optional

The actual name of the machine determined after the allocation.

integer

retryCount

Optional

The number of retry attempt if insufficient storage error occurs

integer

snapshotLimit

Optional

Maximum number of snapshots allowed for the machine.

object

storage

Optional

Settings for constraining to the correct storage at provisioning time.

array of object