Cloud.GCP.Machine

Cloud.GCP.Machine
Cloud.GCP.Machine

Request schema for provisioning of GCP machine resource

AnyOf
This class requires at least one of the following:
undefined
undefined
JSON Example
{
    "account": "string",
    "activeDirectory": {
        "finalRelativeDN": "string",
        "relativeDN": "string",
        "securityGroup": "string"
    },
    "address": "string",
    "attachedDisks": [
        {
            "source": "string"
        }
    ],
    "attachedGpuType": "string",
    "cloudConfig": "string",
    "constraints": [
        {
            "tag": "string"
        }
    ],
    "count": 0,
    "diskEncryptionKey": {
        "kmsKey": {
            "keyName": "string",
            "keyRing": "string",
            "keyRingRegion": "string",
            "kmsProjectId": "string"
        },
        "kmsKeyServiceAccount": "string"
    },
    "enableSecureBoot": false,
    "externalLink": "string",
    "flavor": "string",
    "flavorRef": "string",
    "gpuCount": 0,
    "ignoreActiveDirectory": "string",
    "image": "string",
    "imageRef": "string",
    "name": "string",
    "networks": [
        {
            "address": "string",
            "assignPublicIpAddress": false,
            "assignment": "string",
            "deviceIndex": 0,
            "network": "string"
        }
    ],
    "powerState": "string",
    "project": "string",
    "providerId": "string",
    "region": "string",
    "resourceName": "string",
    "storage": {
        "bootDiskCapacityInGB": 0,
        "constraints": [
            {
                "tag": "string"
            }
        ],
        "maxDiskCapacityInGB": 0
    },
    "tags": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "useSoleTenant": false
}
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.

string
attachedGpuType
Optional

The type of the GPU hardware that will be attached to a machine from the N1 family.

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
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
count
Optional

The number of resource instances to be created.

object
diskEncryptionKey
Optional

Encrypts the disk using a customer-managed encryption key.
Encryption keys do not protect access to metadata of the disk.
After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key.

boolean
enableSecureBoot
Optional

Indicates whether to deploy Machine on GCP with enabled Secure Boot. It can be used to fully enable Shielded VM functionality.

string
externalLink
Optional

URL to the machine on the GCP console.

string
flavor
Optional

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

string
flavorRef
Optional

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

integer
gpuCount
Optional

The count of the GPUs that will be attached to a machine from the N1 family.

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

GCP image used for creating the instance.

string As ^(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)$
name
Optional

Machine name.

array of object
networks
Optional

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

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

Cloud Assembly 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

Location where the machine landed.

string
resourceName
Optional

The actual name of the machine determined after the allocation.

object
storage
Optional

Settings for constraining to the correct storage at provisioning time.

array of object
tags
Optional

Resource categorization, in case-sensitive key names, or in key-value pairs.

boolean
useSoleTenant
Optional

Indicates user intent whether to deploy Machine on GCP sole-tenant node or not. This property needs to be used in conjunction with constraint tags on machine. The machine constraint tags should be exactly same as the node affinity labels defined by the user in GCP node templates. These tags will lead to the placement of machine in a GCP node group. User defined Node Affinity Labels are automatically discovered on GCP and applied as tags on vRA Availability zones.