3.46.1. Create server with configuration drive

3.46.1.1. Request
3.46.1.2. Response

Method	URI	Description
POST	`/v2/{tenant_id}/servers{?security_group,user_data,availability_zone}`	Creates a server with the configuration drive extended attribute.

Normal response codes: 202

3.46.1.1. Request

This table shows the URI parameters for the create server with configuration drive request:

Name	Type	Description
`{tenant_id}`	String	The ID for the tenant or account in a multi-tenancy cloud.

This table shows the query parameters for the create server with configuration drive request:

Name Type Description

Name	Type	Description
`security_group`	String (Required)	The name of the security group. If blank, the server is created in the `default` security group.
`user_data`	String (Optional)	Configuration information or scripts to use upon launch. Must be Base64 encoded.
`availability_zone`	String (Optional)	The availability zone in which to launch the server.

security_group

String

(Required)

The name of the security group. If blank, the server is created in the default security group.

user_data

String

(Optional)

Configuration information or scripts to use upon launch. Must be Base64 encoded.

availability_zone

String

(Optional)

The availability zone in which to launch the server.

Example 3.388. Create server with configuration drive: JSON request

{
    "server" : {
        "name" : "new-server-test",
        "imageRef" : "http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
        "flavorRef" : "http://openstack.example.com/openstack/flavors/1",
        "metadata" : {
            "My Server Name" : "Apache1"
        },
        "personality" : [
            {
                "path" : "/etc/banner.txt",
                "contents" : "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA=="
            }
        ]
    }
}

Example 3.389. Create server with configuration drive: XML request

<?xml version="1.0" encoding="UTF-8"?>
<server xmlns="http://docs.openstack.org/compute/api/v1.1" imageRef="http://openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b" flavorRef="http://openstack.example.com/openstack/flavors/1" name="new-server-test">
  <metadata>
    <meta key="My Server Name">Apache1</meta>
  </metadata>
  <personality>
    <file path="/etc/banner.txt">
        ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBp
        dCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5k
        IGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVs
        c2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4g
        QnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRo
        ZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlv
        dSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vy
        c2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6
        b25zLiINCg0KLVJpY2hhcmQgQmFjaA==
    </file>
  </personality>
</server>

This operation does not require a request body.

3.46.1.2. Response

Example 3.390. 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"
            }
        ]
    }
}

Example 3.391. Create server with configuration drive: XML response

<?xml version='1.0' encoding='UTF-8'?>
<server xmlns:atom="http://www.w3.org/2005/Atom" xmlns="http://docs.openstack.org/compute/api/v1.1" id="00bba779-f8ae-403e-901d-1af18bcb9187" adminPass="XJqvFkH62TZh">
  <metadata/>
  <atom:link href="http://openstack.example.com/v2/openstack/servers/00bba779-f8ae-403e-901d-1af18bcb9187" rel="self"/>
  <atom:link href="http://openstack.example.com/openstack/servers/00bba779-f8ae-403e-901d-1af18bcb9187" rel="bookmark"/>
</server>

This operation does not return a response body.

Questions? Discuss on ask.openstack.org
Found an error? Report a bug against this page

Legal notices