Create server with configuration drive

Method URI Description
POST /v2/{tenant_id}/servers 構成ドライブ拡張属性を持つサーバを作成する。

Normal response codes: 202

注意:

  • 「/etc/cloud/cloud.cfg」に以下の設定がない場合は、「/etc/cloud/cloud.cfg.d/datasource.cfg」を作成して追加してください。すでに設定済の場合は、対応する必要はありません。

    
datasource_list: ['OpenStack']
  • イメージを登録(インポート)したユーザーのパスワードを変更すると、イメージを使用できなくなります。その場合は、運用者に以下のどちらかを伝えて、イメージの変更を依頼してください。
    • イメージのuuidおよびユーザーの認証情報変更後のイメージのlocation情報
    • イメージのuuidおよびユーザーの認証情報変更後に登録(インポート)したイメージのuuid
  • インスタンスを作成した際に、"status"が "ERROR"および"fault"の"message"に以下のメッセージが表示された場合、「Create server (1)」に記載する手順でインスタンスを再作成してください。

    "ブロックデバイスマッピングが不正です: <経過時間(秒)>秒の経過後、または、<ボリュームのstatus確認回数>回のstatus確認後も、ボリューム<ボリュームのuuid>の作成が完了しません。"

Request

下表は、コンフィグドライブ使用サーバ作成リクエストのURIパラメーターの一覧です。

Name Type Description
{tenant_id} String プロジェクトID

下表は、コンフィグドライブ使用仮想サーバ作成リクエストのボディ部のパラメーターの一覧です。

Name Type Description
security_group array

(Optional)

 1つ以上のsecurity_groupオブジェクト。name属性にはセキュリティグループ名を指定してください。本属性を省略した場合、仮想サーバはデフォルトのセキュリティグループに作成されます。

SecurityGroupには、以下のIPアドレスおよびポート番号に対するTCP通信を許可したものを設定してください。

IPアドレス: 169.254.169.254

ポート番号: 80

TCP通信が許可されていないと、インスタンス作成時のホスト名(コンピュータ名)や管理者パスワードの設定が実施されない場合があります。
user_data string

(Optional)

 起動時に使用する構成情報またはスクリプト。Base64でエンコードしている必要があります。

サポートしている形式は、主に下記になります。

  • 業務OSがLinuxの場合
    • シェルスクリプト（#!で開始するもの）
  • 業務OSがWindowsの場合
    • PowerShell（#ps1_sysnative または #ps1_x86で開始するもの）
    • Windows batch（rem cmdで開始するもの）

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

(Optional)

 サーバを起動するアベイラビリティゾーン
server object

サーバ
imageRef string 仮想サーバに使用するイメージの参照先です。

IDまたはURLを指定してください。
flavorRef string 仮想サーバに使用したいフレーバーの参照先です。

IDまたはURLを指定してください。
key_name string

(Optional)

指定した名前のキーペアの公開鍵をサーバに割り当てます。
networks array

(Optional)

 networksオブジェクト。デフォルトでは、プロジェクトが所属するネットワークすべてが仮想サーバに割り当てられます。必要であれば、1つ以上のNICをサーバに作成することもできます。ネットワークのNICを仮想サーバに割り当てるには、networksオブジェクトのuuid属性にネットワークのUUIDを指定します。

既存ポートのNICを仮想サーバに割り当てるには、networksオブジェクトのポート属性にポートIDを指定します。

サーバ上の複数のNICを指定できます。

ネットワークは必ず指定してください。

仮想サーバに対して、以下の情報を設定するために、仮想サーバを接続するネットワークには仮想ルータが接続されている必要があります。
  • ホスト名(コンピュータ名)
  • 管理者パスワード
  • 認証鍵(キーペア)
uuid string

(Optional)

 ネットワークのNICを仮想サーバに割り当てるには、networksオブジェクトのuuid属性にネットワークIDを指定します。port属性を省略した場合は必須です。

ネットワークに複数のサブネットを含む場合、任意のサブネットからIPアドレスが割り当てられます。特定のサブネットのIPアドレスを割当てる場合は、事前にポートを作成し、そのポートのuuidをportで指定してください。
port string

(Optional)

 既存ポートのNICを仮想サーバに割り当てるには、networksオブジェクトのポート属性にポートIDを指定します。uuid属性を省略した場合は必須です。
fixed_ip string

(Optional)

 NICに設定する固定IPv4アドレス。
name string 仮想サーバ名

本情報は、コンピュータ名/ホスト名としても使用されます。

64文字以上を指定した場合、以下のようになります。

  • 業務OSがWindowsの場合

    コンピュータ名はWindowsがデフォルトで設定する名前となります。

  • 業務OSがLinux

    ホスト名は"host- < eth0 の Fixed IP address >"となります。

なお、コンピュータ名/ホスト名に設定する文字列は、以下のように変更され、設定されます。

  • 空白(" ")とアンダースコア("_")を、ハイフン("-")に置換
  • アルファベットの大文字を、小文字に置換
  • ピリオド(".")とハイフン("-")以外の記号を削除
  • 先頭、末尾のピリオド(".")またはハイフン("-")からなる文字列を削除
  • Windowsにおいては、文字列の先頭、末尾以外にピリオド(".")が存在する場合、ピリオド(".")直前までの文字列を採用
metadata object

(Optional)

 メタデータキーと値のペア。メタデータキーと値の最大サイズはそれぞれ、255バイトです。
  • 業務OSがWindowsの場合

    インスタンスのパスワードを指定する場合、キーに"admin_pass"を指定してください。

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

    cloudbase-initに指定したユーザーについては、イメージ提供元に確認してください。

    指定例: "metadata": {"admin_pass": "<インスタンスに設定するパスワード >"}

  • オートフェイルオーバー機能を使用する場合、

    "fcx.autofailover": "true"を指定してください。

    なお、以下の条件を満たすインスタンスは、運用者による復旧対象外となります。利用者にて、インスタンスの再作成、または、インスタンスを削除してください。

    • "fcx.autofailover": "false"が設定されている、または、
    • オートスケール対象となっている、または、
    • インスタンスのstatusが、ERROR
block_device_mapping_v2 array 他のパラメーターが指定された場合にボリュームからサーバを起動できるようにします。
device_name string

仮想サーバの起動に使用するボリュームのデバイスのパスを記述します。

/dev/vd* の形式で指定してください（/dev/vdを含め255文字以内）。

*部分は以下のように指定できます。

  • 小文字の半角英字だけを指定する場合は、以下のように指定してください。

    "/dev/vd" + 1文字以上の小文字の半角英字

    例 : /dev/vda

  • 小文字の半角英字と半角数字を指定する場合は、以下のように指定してください。

    "/dev/vd" + 1文字以上の小文字の半角英字 + 1文字以上の半角数字

    例 : /dev/vda0、/dev/vdb1 等

注: 複数のボリュームを割り当てたインスタンスを作成する場合、デバイス名の"/dev/vd" + 1文字以上の小文字の半角英字部分が重複しないようにしてください。
警告:

特に理由がない限りは、システムボリュームのデバイス名を/dev/vdaとしてください。

デバイス名に指定された文字の優先順序は、a > b > c > ...です。
source_type string ボリュームのボリュームソース種別を記述します。"snapshot"、"volume"、または "image"を選択できます。
destination_type string 接続先("volume")を指定します。
delete_on_termination bool

(Optional)

 インスタンス作成時に作成したボリュームを、インスタンス削除時に削除するかどうかを指定します。

Trueを指定した場合、インスタンス作成時に作成したボリュームを、インスタンス削除時にボリュームも削除します。

Falseを指定した場合、インスタンス作成時に作成したボリュームを、インスタンス削除時にボリュームを削除しません。

未指定時は、False(削除しない)となります。

なお、snapshotが採取されているボリュームは、Trueを指定しても削除されません。
boot_index string デバイスの起動順序を指定します。0から連続した値を指定します。起動ディスクは、0を指定します。
config_drive string

(Optional)

 falseのみ指定できます。
uuid string source_typeに指定したリソースのUUIDを指定します。
volume_size string ボリュームサイズをGB単位で指定します。

source_typeにimageを指定した場合は、必ず指定してください。値には、使用するイメージのmin_diskパラメーター以上の値を指定してください。なお、使用するイメージのmin_diskパラメーターが無し、または、0の場合、イメージの提供元に最小サイズを確認し、指定してください。

source_typeにvolumeを指定した場合は、値を指定しても無視されます。

source_typeにsnapshotを指定した場合に、省略すると、スナップショットの採取元のボリュームのサイズとなります。
volume_type string

(Optional)

 ボリュームタイプ名を指定します。

source_typeにimageを指定した場合にだけ、指定されたボリュームタイプでボリュームが作成されます。省略した場合は M1 となります。

source_typeにvolumeを指定した場合は、ボリュームタイプは変更できないため、値を指定しても無視されます。

source_typeにsnapshotを指定した場合は、スナップショット元のボリュームのボリュームタイプで作成されます。値を指定しても無視されます。
OS-DCF:diskConfig string

(Optional)

 有効な値は、AUTOまたはMANUALです。

Example 3.394. Create server with configuration drive: JSON request


{
	"server": {
		"name": "new-server-test",
		"imageRef": "b5660a6e-4b46-4be3-9707-6b47221b454f",
		"flavorRef": "2",
		"key_name": "keypair1",
		"metadata": {
			"My Server Name": "Apache1"
		}
	}
}

Response

Example. Create server with configuration drive: JSON response


{
	"server": {
		"adminPass": "am5LKVsBVQ4s",
		"id": "58da039c-dc81-4d8f-8688-a2f819e2f750",
		"links": [
			{
				"href": "http://openstack.example.com/v2/openstack/servers/58da039c-dc81-4d8f-8688-a2f819e2f750",
				"rel": "self"
			},
			{
				"href": "http://openstack.example.com/openstack/servers/58da039c-dc81-4d8f-8688-a2f819e2f750",
				"rel": "bookmark"
			}
		]
	}
}