Cloud.vSphere.Machine
Request schema for provisioning of a vSphere machine resource
{
"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",
"skipUserCreation": false,
"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"
}Cloud Account indicates the name of the endpoint used to provision this machine.
Active Directory Configuration
Machine IP address, populated by discovery or provisioning.
List of disks to attach to the machine.
The purpose of this boolean property is whether to skip or validate SSL/TLS certificate when streaming OVF or OVA.
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.
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.
Specify how the provided Cloud Config should be handled
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.
Number of cores per socket.
The number of resource instances to be created.
Number of virtual processors to assign to this machine. The default is 1.
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.
Generic types of compute resources, mapped in an environment to specific types of compute resources.
The path to the folder where the virtual machine is provisioned, relative to the datacenter that the resource pool is in.
Group Placement
Indicates that the machine is not added to Active Directory by a policy. It skips the Active Directory policy.
Generic compute images, mapped in an environment to specific compute resource images.
vSphere image used for creating the machine. Examples include templates, OVA or OVF links, snapshots, and content libraries.
Name of the machine as specified in the blueprint.
Networks to attach to the machine. Multiple network interfaces are allowed.
Operating system of the machine, populated by discovery or provisioning. Values include WINDOWS and LINUX.
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.
Machine power state of ON, OFF, GUEST_OFF, UNKNOWN, or SUSPEND.
VMware Aria Automation Assembler project under which the machine is provisioned. Indicates project ID.
A unique identifier of the resource in the context of the provider.
Datacenter name where the machine landed.
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.
Time in seconds SDRS should reserve storage on the datastore
The actual name of the machine determined after the allocation.
The number of retry attempt if insufficient storage error occurs
Maximum number of snapshots allowed for the machine.
Settings for constraining to the correct storage at provisioning time.
Resource categorization, in case-sensitive key names, or in key-value pairs.
Machine virtual memory size in megabytes. The default is 1024 MB (1GB).
The UUID of the vCenter this machine is deployed to.