MachineSpecification | VM Apps Org - Provisioning Service

MachineSpecification

Specification for a cloud agnostic machine.

JSON Example

{
    "name": "string",
    "projectId": "e058",
    "deploymentId": "123e4567-e89b-12d3-a456-426655440000",
    "customProperties": {
        "customProperties": "string"
    },
    "description": "string",
    "flavor": "small, medium, large",
    "flavorRef": "t2.micro",
    "image": "vmware-gold-master, ubuntu-latest, rhel-compliant, windows",
    "imageRef": "ami-f6795a8c",
    "nics": [
        {
            "name": "string",
            "description": "string",
            "deviceIndex": 1,
            "networkId": "54097407-4532-460c-94a8-8f9e18f4c925",
            "fabricNetworkId": "54097407-4532-460c-94a8-8f9e18f4c925",
            "addresses": [
                "10.1.2.190"
            ],
            "macAddress": "[\"00:50:56:99:d8:34\"]",
            "securityGroupIds": [
                "string"
            ],
            "customProperties": {
                "awaitIp": "true"
            }
        }
    ],
    "disks": [
        {
            "name": "string",
            "description": "string",
            "blockDeviceId": "1298765",
            "scsiController": "SCSI_Controller_0, SCSI_Controller_1, SCSI_Controller_2, SCSI_Controller_3",
            "unitNumber": "0",
            "diskAttachmentProperties": {
                "scsiController": "SCSI_Controller_0",
                "unitNumber": "2"
            }
        }
    ],
    "bootConfig": {
        "content": "#cloud-config\nrepo_update: true\nrepo_upgrade: all\n\npackages:\n - mysql-server\n\nruncmd:\n - sed -e '/bind-address/ s/^#*/#/' -i /etc/mysql/mysql.conf.d/mysqld.cnf\n - service mysql restart\n - mysql -e \"GRANT ALL PRIVILEGES ON *.* TO 'root'@'%' IDENTIFIED BY 'mysqlpassword';\"\n - mysql -e \"FLUSH PRIVILEGES;\"\n"
    },
    "bootConfigSettings": {
        "phoneHomeShouldWait": true,
        "phoneHomeTimeoutSeconds": 100,
        "phoneHomeFailOnTimeout": false,
        "deploymentFailOnCloudConfigRuntimeError": true
    },
    "machineCount": 3,
    "constraints": [
        {
            "mandatory": false,
            "expression": "ha:strong"
        }
    ],
    "imageDiskConstraints": [
        {
            "mandatory": "true",
            "expression": "environment:prod"
        },
        {
            "mandatory": "false",
            "expression": "pci"
        }
    ],
    "tags": [
        {
            "key": "ownedBy",
            "value": "Rainpole"
        }
    ],
    "remoteAccess": {
        "authentication": "publicPrivateKey",
        "keyPair": "string",
        "sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCu74dLkAGGYIgNuszEAM0HaS2Y6boTPw+HqsFmtPSOpxPQoosws/OWGZlW1uue6Y4lIvdRqZOaLK+2di5512etY67ZwFHc5h1kx4az433DsnoZhIzXEKKI+EXfH/w72CIyG/uVhIzmA4FvRVQKXinE1vaVen6v1CBQEZibx9RXrVRP1VRibsKFRXYxywNEl1VtPK7KaxCEYO9IXi4SKVulSAhOVequwjlo5E8bKNT61/g/YyMvwCbaTTPPeCpS/7i+JHYY3QZ8fQY/Syn+bOFpKCCHl+7VpsL8gjWe6fI4bUp6KUiW7ZkQpL/47rxawKnRMKKEU9P0ICp3RRB39lXT",
        "username": "string",
        "password": "string",
        "skipUserCreation": false
    },
    "saltConfiguration": {
        "masterId": "string",
        "minionId": "string",
        "saltEnvironment": "string",
        "pillarEnvironment": "string",
        "installerFileName": "string",
        "stateFiles": [
            "string"
        ],
        "variables": {
            "variables": "string"
        },
        "additionalAuthParams": {
            "additionalAuthParams": "string"
        },
        "additionalMinionParams": {
            "additionalMinionParams": "string"
        }
    }
}

string

name

Required

A human-friendly name used as an identifier in APIs that support this option.

string

projectId

Required

The id of the project the current user belongs to.

string

deploymentId

Optional

The id of the deployment that is associated with this resource

object

customProperties

Optional

Additional custom properties that may be used to extend this resource.

string

description

Optional

Describes machine within the scope of your organization and is not propagated to the cloud

string

flavor

Required

Flavor of machine instance.

string

flavorRef

Required

Provider specific flavor reference. Valid if no flavor property is provided

string

image

Required

Type of image used for this machine.

string

imageRef

Required

Direct image reference used for this machine (name, path, location, uri, etc.). Valid if no image property is provided

array of NetworkInterfaceSpecification

nics

Optional

A set of network interface controller specifications for this machine. If not specified, then a default network connection will be created.

array of DiskAttachmentSpecification

disks

Optional

A set of disk specifications for this machine.

MachineBootConfig

bootConfig

Optional

Machine boot config that will be passed to the instance that can be used to perform common automated configuration tasks and even run scripts after the instance starts.

MachineBootConfigSettings

bootConfigSettings

Optional

Machine boot config settings that will define how the provisioning will handle the boot config script execution.

integer As int32 As int32

machineCount

Optional

Number of machines to provision - default 1.

array of PlacementConstraint

constraints

Optional

Constraints that are used to drive placement policies for the virtual machine that is produced from this specification. Constraint expressions are matched against tags on existing placement targets.

array of PlacementConstraint

imageDiskConstraints

Optional

Constraints that are used to drive placement policies for the image disk. Constraint expressions are matched against tags on existing placement targets.

array of Tag