Create Machine | Cloud Assembly IaaS API

Create Machine

Create machine

Request

URI

POST

https://api.mgmt.cloud.vmware.com//iaas/api/machines

COPY

Query Parameters

string

apiVersion

Optional

The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /iaas/api/about

Request Body

Machine Specification instance

MachineSpecification of type(s) application/json

Required

{
    "image": "vmware-gold-master, ubuntu-latest, rhel-compliant, windows",
    "disks": [
        {
            "blockDeviceId": "1298765",
            "name": "string",
            "description": "string"
        }
    ],
    "imageDiskConstraints": [
        {
            "expression": "ha:strong",
            "mandatory": false
        }
    ],
    "description": "string",
    "machineCount": 3,
    "constraints": [
        {
            "expression": "ha:strong",
            "mandatory": false
        }
    ],
    "tags": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "flavor": "small, medium, large",
    "deploymentId": "123e4567-e89b-12d3-a456-426655440000",
    "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"
    },
    "name": "string",
    "nics": [
        {
            "addresses": [
                "string"
            ],
            "securityGroupIds": [
                "string"
            ],
            "name": "string",
            "description": "string",
            "networkId": "dcd9",
            "deviceIndex": 1
        }
    ],
    "imageRef": "ami-f6795a8c",
    "remoteAccess": {
        "password": "string",
        "sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCu74dLkAGGYIgNuszEAM0HaS2Y6boTPw+HqsFmtPSOpxPQoosws/OWGZlW1uue6Y4lIvdRqZOaLK+2di5512etY67ZwFHc5h1kx4az433DsnoZhIzXEKKI+EXfH/w72CIyG/uVhIzmA4FvRVQKXinE1vaVen6v1CBQEZibx9RXrVRP1VRibsKFRXYxywNEl1VtPK7KaxCEYO9IXi4SKVulSAhOVequwjlo5E8bKNT61/g/YyMvwCbaTTPPeCpS/7i+JHYY3QZ8fQY/Syn+bOFpKCCHl+7VpsL8gjWe6fI4bUp6KUiW7ZkQpL/47rxawKnRMKKEU9P0ICp3RRB39lXT",
        "keyPair": "string",
        "authentication": "publicPrivateKey",
        "username": "string"
    },
    "projectId": "e058"
}

string

image

Required

Type of image used for this machine.

array of DiskAttachmentSpecification

disks

Optional

A set of disk specifications for this machine.

array of Constraint

imageDiskConstraints

Optional

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

string

description

Optional

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

integer As int32 As int32

machineCount

Optional

Number of machines to provision - default 1.

array of Constraint

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 Tag

tags

Optional

A set of tag keys and optional values that should be set on any resource that is produced from this specification.

string

flavor

Required

Flavor of machine instance.

object

customProperties

Optional

Additional custom properties that may be used to extend the machine.

string

deploymentId

Optional

The id of the deployment that is associated with this resource

MachineBootConfig

bootConfig

Optional

bootConfig

string

name

Required

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

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.

string

imageRef

Required

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

RemoteAccessSpecification

remoteAccess

Optional

remoteAccess

string

projectId

Required

The id of the project the current user belongs to.

Responses

202

successful operation

Returns RequestTracker of type(s) application/json

{
    "name": "Power-off",
    "progress": 90,
    "resources": [
        "string"
    ],
    "id": "we655aew4e8e",
    "message": "In Progress",
    "status": "FINISHED",
    "selfLink": "/.../request-tracker/we655aew4e8e"
}

string

name

Optional

Name of the operation.

integer As int32 As int32

progress

Required

Progress of the request as percentage.

array of string

resources

Optional

Collection of resources.