Properties

availability_zone

Name of the availability zone for server placement.
Optional property.
Type: String

block_device_mapping

Block device mappings for this server.
Required property.
Type: List
List contents:
- Optional property.
- Type: Map
- Map properties:
  - delete_on_termination
    - Indicate whether the volume should be deleted when the server is terminated.
      
      Specifies whether the volume that was created during scale-out and stack creation will be deleted during scale-in and during stack deletion.
      
      When "True" is specified, the volume that was created during scale-out and stack creation will be deleted during scale-in and during stack deletion.
      
      When "False" is specified, the volume that was created during scale-out and stack creation will not be deleted during scale-in and during stack deletion.
      
      If not specified, "False (do not delete)" will be used.
      
      The volume where snapshots are collected will not be deleted even if "True" is specified.
    - Optional property.
    - Type: Boolean
  - device_name
    - A device name where the volume will be attached in the system at /dev/device_name. This value is typically vda.
      
      Specify in the "/dev/vdx" format. "/dev/vd" is a fixed string, specify a letter that is valid as a device name for "x".
      
      When creating an instance with multiple volumes assigned, specify the highest priority letter among all of the device names of volumes for the boot volume.
      
      The order of priority is a > b > c > ...
      
      If vda is specified without an image being specified, only vda will be specified and "/dev/" will not be appended.
    - Required property.
    - Type: String
  - snapshot_id
    - The ID of the snapshot to create a volume from.
      
      If volume_id is not specified, this item must be specified.
    - Optional property.
    - Type: String
    - Value must be of type cinder.snapshot
  - volume_id
    - The ID of the volume to boot from. Only one of volume_id or snapshot_id should be provided.
      
      If snapshot_id is not specified, this item must be specified.
    - Optional property.
    - Type: String
    - Value must be of type cinder.volume
  - volume_size
    - The size of the volume, in GB. It is safe to leave this blank and have the Compute service infer the size.
      - If volume_id is specified and delete on termination is set to "True":
        
        This setting is mandatory. However, the specified volume size is ignored, and there is no change to the volume size specified for volume_id.
      - If volume_id is specified and delete on termination is not specified, or set to "False":
        
        This must not be specified. If specified, the specified volume size is ignored, and there is no change to the volume size specified for volume_id.
      - If snapshot_id is specified and delete on termination is set to "True":
        
        This setting is mandatory.
      - If snapshot_id is specified and delete on termination is not specified, or set to "False":
        
        This item is optional. If this item is omitted, the volume size of the snapshot collection source will be used.
    - Optional property.
    - Type: Integer

diskConfig

Control how the disk is partitioned when the server is created.
Optional property.
Allowed values: AUTO, MANUAL

flavor

The ID or name of the flavor to boot onto.
Required property.
Type: String
Value must be of type nova.flavor

image

The ID or name of the image to boot with.
Optional property.
Type: String
Value must be of type glance.image

key_name

Name of keypair to inject into the server.
Optional property.
Type: String
Value must be of type nova.keypair

metadata

Arbitrary key/value metadata to store for this server. Both keys and values must be 255 characters or less. Non-string values will be serialized to JSON (and the serialized string must be 255 characters or less).
Optional property.
Type: Map

Below is an example of specifying a password when the operating system is Windows.

The specified password is set for users specified in cloudbase-init.

metadata: { "admin_pass": 'password' } }

name

Server name.

Specify the value using up to 63 characters. Up to 255 characters can be specified, however, if the name is 64 characters or longer, the host name/computer name set for an instance will be as follows.
- Linux:
  
  The host name will be "host-fixedIpAddressOfEth0".
- Windows:
  
  The computer name is the default name set by Windows.
The string set for the host name/computer name is changed as follows and set.
- Spaces ( ) and underscores (_) are replaced with a hyphen (-).
- Uppercase alphabetic characters are replaced with lowercase alphabetic characters.
- Symbols other than periods (.) and hyphens (-) are removed.
- Periods (.) are removed from the beginning and end of the string if any, and a string consisting of hyphens (-) is removed.
Furthermore, if the operating system is Windows:
- If the string contains a period (.) other than at the beginning or end, the characters preceding the period will be used for the name.
Optional property.
Type: String

networks

An ordered list of NICs to be added to this server, with information about connected networks, fixed IPs, port etc.
Optional property.
Type: List
List contents:
- Optional property.
- Type: Map
- Map properties:
  - fixed_ip
    - Fixed IP address to specify for the port created on the requested network.
    - Optional property.
    - Type: String
  - network
    - Name or ID of network to create a port on.
    - Optional property.
    - Type: String
    - Value must be of type neutron.network
  - port
    - ID of an existing port to associate with this server.
    - Optional property.
    - Type: String
  - uuid
    
    CAUTION:
    DEPRECATED! - Use property network.
    - ID of network to create a port on.
    - Optional property.
    - Type: String
    - Value must be of type neutron.network

scheduler_hints

Arbitrary key-value pairs specified by the client to help boot a server.

When creating an instance with the server group uuid of "anti-affinity" specified, if there is no VM host where an instance can be created (the number of VM hosts that can be used is smaller than the number of instances belonging to the same server group), the instance status becomes ERROR after the instance creation request is received.
Optional property.
Type: Map

security_groups

List of security group names or IDs. Cannot be used if neutron ports are associated with this server; assign security groups to the ports instead.

SecurityGroup must be a security group with the permissions for TCP connections to the following IP address and port number.
- IP address: 169.254.169.254
- Port number: 80
If TCP connections are not permitted, setting of the host name (computer name) and administrator password may not be performed during instance creation.
Optional property, defaults to "[]".
Type: List

user_data

User data script to be executed by cloud-init.

Specifies the script. The supported format is mainly as shown below.
- Linux:
  - Shell script (begins with #!)
- Windows:
  - PowerShell (begins with #ps1_sysnative or #ps1_x86)
  - Windows batch (begins with rem cmd)
Optional property, defaults to "".
Type: String

CAUTION:

If the operating system is Linux, the cloud-config format can be specified apart from scripts, however, it is recommended that scripts be specified.

user_data_format

Specify "RAW".
Optional property, defaults to "HEAT_CFNTOOLS".
Type: String

CAUTION:

Only "RAW" is supported.

RAW: The specified user_data is passed as is to Nova.

admin_user

CAUTION:

DEPRECATED!

Name of the administrative user to use on the server. This property will be removed from Juno in favor of the default cloud-init user set up for each image (e.g. "ubuntu" for Ubuntu 12.04+, "fedora" for Fedora 19+ and "cloud-user" for CentOS/RHEL 6.5).
Optional property.
Type: String