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.
      
      スケールアウトおよびスタック作成時に作成したボリュームを、スケールインおよびスタック削除時に削除するかどうかを指定します。
      
      "True"を指定した場合、スケールアウトおよびスタック作成時に作成したボリュームを、スケールインおよびスタック削除時にボリュームを削除します。
      
      "False"を指定した場合、スケールアウトおよびスタック作成時に作成したボリュームを、スケールインおよびスタック削除時にボリュームを削除しません。
      
      未指定時は"False（削除しない）"となります。
      
      なお、snapshotが採取されているボリュームは、"True"を指定しても削除されません。
    - 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.
      
      /dev/vdx の形式で指定してください。/dev/vdまでは固定で、xはデバイス名として有効な文字を指定します。
      
      複数のボリュームを割当てたインスタンスを作成する場合、起動ボリュームには、全てのボリュームのデバイス名のうち、優先度が最も高い文字を指定してください。
      
      優先度は、a > b > c > ...の順です。
      
      imageを指定せず、vdaを指定する場合、"/dev/"を付加せず、vdaだけを指定します。
    - Required property.
    - Type: String
  - snapshot_id
    - The ID of the snapshot to create a volume from.
      
      volume_idを指定しない場合、必ず指定してください。
    - 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.
      
      snapshot_idを指定しない場合、必ず指定してください。
    - 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.
      - volume_idを指定し、delete on terminationに"True"を指定した場合
        
        指定は必須です。ただし、指定したボリュームサイズは無視され、volume_idに指定したボリュームのサイズは変わりません。
      - volume_idを指定し、delete on terminationを指定しない、または、"False"を指定した場合
        
        指定しないでください。指定した場合、指定したボリュームサイズは無視され、volume_idに指定したボリュームのサイズは変わりません。
      - snapshot_idを指定し、delete on terminationに"True"を指定した場合
        
        指定は必須です。
      - snapshot_idを指定し、delete on terminationを指定しない、または、"False"を指定した場合
        
        指定は任意となります。省略すると、スナップショットの採取元のボリュームのサイズとなります。
    - 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

業務OSがWindowsの場合のパスワードの指定例を、以下に記載します。

なお、指定したパスワードをcloudbase-initで指定したユーザーに対して設定します。

metadata: { "admin_pass": '<パスワードを指定>' } }

name

Server name.

63文字以内で指定してください。最大255文字まで指定できますが、64文字以上の場合、インスタンスに設定するホスト名/コンピュータ名は以下の値となります。
- 業務OSがLinuxの場合
  
  ホスト名は"host-<eth0 の Fixed IP address>"となります。
- 業務OSがWindowsの場合
  
  コンピュータ名はWindowsがデフォルトで設定する名前となります。
なお、ホスト名/コンピュータ名に設定する文字列は、以下のように変更され、設定されます。
- 空白（" "）とアンダースコア（"_"）を、ハイフン（"-"）に置換します。
- アルファベットの大文字を、小文字に置換します。
- ピリオド（"."）とハイフン（"-"）以外の記号を削除します。
- 先頭、末尾のピリオド（"."）またはハイフン（"-"）からなる文字列を削除します。
さらに、業務OSがWindowsの場合、
- 文字列の先頭、末尾以外にピリオド（"."）が存在する場合、ピリオド（"."）直前までの文字列を採用します。
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.

"anti-affinity"のserver groupのuuidを指定してインスタンスを作成したとき、インスタンスを作成できるVMホストが無い（同じserver groupに属するインスタンスの数より、使用できるVMホストの数のほうが少ない）場合は、インスタンスの作成要求を受け付けた後、インスタンスのstatusがERRORとなります。
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には、以下のIPアドレスおよびポート番号に対するTCP通信を許可したものを設定してください。
- IPアドレス: 169.254.169.254
- ポート番号: 80
TCP通信が許可されていないと、インスタンス作成時のホスト名（コンピュータ名）や管理者パスワードの設定が実施されない場合があります。
Optional property, defaults to "[]".
Type: List

user_data

User data script to be executed by cloud-init.

スクリプトを指定します。サポートしている形式は、主に下記になります。
- 業務OSがLinuxの場合
  - シェルスクリプト（#!で開始するもの）
- 業務OSがWindowsの場合
  - PowerShell（#ps1_sysnative または #ps1_x86で開始するもの）
  - Windows batch（rem cmdで開始するもの）
Optional property, defaults to "".
Type: String

CAUTION:

業務OSがLinuxの場合、スクリプトのほかにcloud-config形式の指定もできますが、スクリプトの指定を推奨します。

user_data_format

"RAW" を指定してください。
Optional property, defaults to "HEAT_CFNTOOLS".
Type: String

CAUTION:

"RAW"指定のみをサポートします。

RAW : 指定したuser_dataをそのまま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