# variables in header image_location: description: | The image location URL of the image or backup created, HTTP header "Location: " will be returned. .. note:: The URL returned may not be accessible to users and should not be relied upon. Use microversion 2.45 or simply parse the image ID out of the URL in the Location response header. in: header required: true type: string max_version: 2.44 server_location: description: | The location URL of the server, HTTP header "Location: " will be returned. in: header required: true type: string tag_location: description: | The location of the tag. It's individual tag URL which can be used for checking the existence of the tag on the server or deleting the tag from the server. in: header required: true type: string min_version: 2.26 x-openstack-request-id: description: | A unique ID for tracking the request. The request ID associated with the request appears in the log lines for that request. By default, the middleware configuration ensures that the request ID appears in the log files. in: header required: true type: string # variables in path agent_build_id: description: | The id of the agent build. in: path required: true type: string aggregate_id: description: | The aggregate ID. in: path required: true type: integer api_version: in: path required: true type: string description: > The API version as returned in the links from the ``GET /`` call. attachment_id: description: | The UUID of the attachment. in: path required: true type: string before_timestamp: description: | Filters the response by the date and time before which to list usage audits. The date and time stamp format is as follows: :: CCYY-MM-DD hh:mm:ss.NNNNNN For example, ``2015-08-27 09:49:58`` or ``2015-08-27 09:49:58.123456``. in: path required: true type: string cell_id: description: | The UUID of the cell. in: path required: true type: string console_id: description: | The UUID of the console. in: path required: true type: string console_token: description: | Console authentication token. in: path required: true type: string disabled_reason: description: | The reason for disabling a service. in: path required: false type: string domain: description: | The registered DNS domain that the DNS drivers publish. in: path required: true type: string fixed_ip_path: description: | The fixed IP of interest to you. in: path required: true type: string flavor_extra_spec_key: description: | The extra spec key for the flavor. in: path required: true type: string flavor_id: description: | The ID of the flavor. in: path required: true type: string floating_ip_id: description: | The ID of the floating IP address. in: path required: true type: string host_name: description: | The name of the host. in: path required: true type: string hypervisor_hostname_pattern: description: | The hypervisor host name or a portion of it. The hypervisor hosts are selected with the host name matching this pattern. in: path required: true type: string hypervisor_id: description: | The ID of the hypervisor. in: path required: true type: integer image_id: description: | The UUID of the image. in: path required: true type: string instance_id: description: | The UUID of the instance. in: path required: true type: string ip: description: | The IP address. in: path required: true type: string key: description: | The metadata item key, as a string. Maximum length is 255 characters. in: path required: true type: string keypair_name_path: description: | The keypair name. in: path required: true type: string migration_id_path: description: | The ID of the server migration. in: path required: true type: integer network_id: description: | The UUID of the network. in: path required: true type: string network_label: description: | The network label, such as ``public`` or ``private``. in: path required: true type: string node_id: description: | The node ID. in: path required: true type: string port_id_path: description: | The UUID of the port. in: path required: true type: string request_id: description: | The ID of the request. in: path required: true type: string security_group_default_rule_id: description: | The UUID of the security group rule. in: path required: true type: string security_group_id: description: | The ID of the security group. in: path required: true type: string security_group_rule_id: description: | The ID of the security group rule. in: path required: true type: string server_group_id: description: | The UUID of the server group. in: path required: true type: string server_id_path: description: | The UUID of the server. in: path required: true type: string service_id_path: description: | The id of the service. in: path required: true type: integer snapshot_id_path: description: | The UUID of the snapshot. in: path required: true type: string tag: description: | The tag as a string. in: path required: true type: string min_version: 2.26 tenant_id: description: | The UUID of the tenant in a multi-tenancy cloud. in: path required: true type: string volume_id_path: description: | The unique ID for a volume. in: path required: true type: string # variables in query access_ip_v4_query_server: in: query required: false type: string description: | Filter server list result by IPv4 address that should be used to access the server. access_ip_v6_query_server: in: query required: false type: string description: | Filter server list result by IPv6 address that should be used to access the server. all_projects: description: | Administrator only. Lists server groups for all projects. For example: ``GET /os-server-groups?all_projects=True`` If you specify a tenant ID for a non-administrative user with this query parameter, the call lists all server groups for the tenant, or project, rather than for all projects. in: query required: false type: boolean all_tenants: description: | Specify the ``all_tenants=1`` query parameter to ping instances for all tenants. By default this is only allowed by admin users. in: query required: false type: integer all_tenants_query: description: | Specify the ``all_tenants=1`` query parameter to list all instances for all projects. By default this is only allowed by admin users. in: query required: false type: integer availability_zone_query_server: description: | Filter the server list result by server availability zone. in: query required: false type: string changes-since: description: | Filters the response by a date and time when the image last changed status. Use this query parameter to check for changes since a previous request rather than re-downloading and re-parsing the full status at each polling interval. If data has changed, the call returns only the items changed since the ``changes-since`` time. If data has not changed since the ``changes-since`` time, the call returns an empty list. To enable you to keep track of changes, this filter also displays images that were deleted if the ``changes-since`` value specifies a date in the last 30 days. Items deleted more than 30 days ago might be returned, but it is not guaranteed. The date and time stamp format is `ISO 8601 `_: :: CCYY-MM-DDThh:mm:ss±hh:mm The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC. For example, ``2015-08-27T09:49:58-05:00``. If you omit the time zone, the UTC time zone is assumed. in: query required: false type: string changes_since_server: description: | Filters the response by a date and time stamp when the server last changed status. To help keep track of changes this may also return recently deleted servers. The date and time stamp format is `ISO 8601 `_: :: CCYY-MM-DDThh:mm:ss±hh:mm The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC. For example, ``2015-08-27T09:49:58-05:00``. If you omit the time zone, the UTC time zone is assumed. in: query required: false type: string config_drive_query_server: description: | Filter the server list result by the config drive setting of the server. in: query required: false type: boolean created_at_query_server: description: | Filter the server list result by a date and time stamp when server was created. The date and time stamp format is `ISO 8601 `_: :: CCYY-MM-DDThh:mm:ss±hh:mm The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC. For example, ``2015-08-27T09:49:58-05:00``. If you omit the time zone, the UTC time zone is assumed. in: query required: false type: string delete_info: description: | Information for snapshot deletion. Include the ID of the associated volume. For example: .. code-block:: javascript DELETE /os-assisted-volume-snapshots?delete_info='{"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c"}' in: query required: true type: string deleted_query: in: query required: false type: boolean description: | Show deleted items. In some circumstances deleted items will still be accessible via the backend database, however there is no contract on how long, so this parameter should be used with caution. It is typically only available to administrators. description_query_server: description: | Filter the server list result by description. .. note:: ``display_description`` can also be requested which is alias of ``description`` but that is not recommended to use as that will be removed in future. in: query required: false type: string detailed_simple_tenant_usage: description: | Specify the ``detailed=1`` query parameter to get detail information ('server_usages' information). in: query required: false type: integer disk_config_query_server: description: | Filter the server list result by the ``disk_config`` setting of the server, Valid values are: - ``AUTO`` - ``MANUAL`` in: query required: false type: string end_simple_tenant_usage: description: | The ending time to calculate usage statistics on compute and storage resources. The date and time stamp format is any of the following ones: :: CCYY-MM-DDThh:mm:ss For example, ``2015-08-27T09:49:58``. :: CCYY-MM-DDThh:mm:ss.NNNNNN For example, ``2015-08-27T09:49:58.123456``. :: CCYY-MM-DD hh:mm:ss.NNNNNN For example, ``2015-08-27 09:49:58.123456``. If you omit this parameter, the current time is used. in: query required: false type: string exclude: description: | Specify ``exclude=uuid[,uuid...]`` to exclude the instances from the results. in: query required: false type: string flavor_is_public_query: in: query required: false type: boolean description: | Filters the flavor list by only public flavors. By default ``non admin`` users only see public flavors, and ``admin`` users can see additional non public flavors. flavor_query: description: | Filters the response by a flavor, as a UUID. A flavor is a combination of memory, disk size, and CPUs. in: query required: false type: string host_query_server: description: | Filter the server list result by the host name of compute node. Only allowed for Admin. in: query required: false type: string hostname_query_server: description: | Filter the server list result by the host name of server. in: query required: false type: string hypervisor_limit: description: | Requests a page size of items. Returns a number of items up to a limit value. Use the ``limit`` parameter to make an initial limited request and use the ID of the last-seen item from the response as the ``marker`` parameter value in a subsequent limited request. in: query required: false type: integer min_version: 2.33 hypervisor_marker: description: | The ID of the last-seen item. Use the ``limit`` parameter to make an initial limited request and use the ID of the last-seen item from the response as the ``marker`` parameter value in a subsequent limited request. in: query required: false type: string min_version: 2.33 hypervisor_query: description: | Filters the response by a hypervisor type. in: query required: false type: string image_name_query: description: | Filters the response by an image name, as a string. in: query required: false type: string image_query: description: | Filters the response by an image, as a UUID. .. note:: 'image_ref' can also be requested which is alias of 'image' but that is not recommended to use as that will be removed in future. in: query required: false type: string image_server_query: description: | Filters the response by a server, as a URL. format: uri in: query required: false type: string image_status_query: description: | Filters the response by an image status, as a string. For example, ``ACTIVE``. in: query required: false type: string image_type_query: description: | Filters the response by an image type. For example, ``snapshot`` or ``backup``. in: query required: false type: string include: description: | Specify ``include=uuid[,uuid...]`` to include the instances in the results. in: query required: false type: string ip6_query: description: | An IPv6 address to filter results by. in: query required: false type: string min_version: 2.5 ip_query: description: | An IPv4 address to filter results by. in: query required: false type: string kernel_id_query_server: in: query required: false type: string description: | Filter the server list result by the UUID of the kernel image when using an AMI. key_name_query_server: description: | Filter the server list result by keypair name. in: query required: false type: string keypair_limit: description: | Requests a page size of items. Returns a number of items up to a limit value. Use the ``limit`` parameter to make an initial limited request and use the last-seen item from the response as the ``marker`` parameter value in a subsequent limited request. in: query required: false type: integer min_version: 2.35 keypair_marker: description: | The last-seen item. Use the ``limit`` parameter to make an initial limited request and use the last-seen item from the response as the ``marker`` parameter value in a subsequent limited request. in: query required: false type: string min_version: 2.35 keypair_user: in: query required: false type: string description: | This allows administrative users to operate key-pairs of specified user ID. min_version: 2.10 launch_index_query_server: description: | Filter the server list result by the sequence in which the servers were launched. in: query required: false type: string launched_at_query_server: description: | Filter the server list result by a date and time stamp when the instance was launched. The date and time stamp format is `ISO 8601 `_: :: CCYY-MM-DDThh:mm:ss±hh:mm The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC. For example, ``2015-08-27T09:49:58-05:00``. If you omit the time zone, the UTC time zone is assumed. in: query required: false type: string limit: description: | Requests a page size of items. Returns a number of items up to a limit value. Use the ``limit`` parameter to make an initial limited request and use the ID of the last-seen item from the response as the ``marker`` parameter value in a subsequent limited request. in: query required: false type: integer limit_simple: description: | Used in conjunction with ``offset`` to return a slice of items. ``limit`` is the maximum number of items to return. If ``limit`` is not specified, or exceeds the configurable ``max_limit``, then ``max_limit`` will be used instead. in: query required: false type: integer locked_by_query_server: description: | Filter the server list result by who locked the server, possible value could be ``admin``, ``owner`` or ``none``. in: query required: false type: string marker: description: | The ID of the last-seen item. Use the ``limit`` parameter to make an initial limited request and use the ID of the last-seen item from the response as the ``marker`` parameter value in a subsequent limited request. in: query required: false type: string migration_hidden: description: | The 'hidden' setting of migration to filter. in: query required: false type: string migration_host: description: | The source/destination compute node of migration to filter. in: query required: false type: string migration_instance_uuid: description: | The uuid of the instance that migration is operated on to filter. in: query required: false type: string migration_source_compute: description: | The source compute node of migration to filter. in: query required: false type: string migration_status: description: | The status of migration to filter. in: query required: false type: string migration_type: description: | The type of migration to filter. in: query required: false type: string minDisk: description: | Filters the response by a minimum disk space, in GiB. For example, ``100``. in: query required: false type: integer minRam: description: | Filters the response by a minimum RAM, in MB. For example, ``512``. in: query required: false type: integer node_query_server: description: | Filter the server list result by the node. Only allowed for Admin. in: query required: false type: string not_tags_any_query: in: query required: false type: string description: | A list of tags to filter the server list by. Servers that don't match any tags in this list will be returned. Boolean expression in this case is 'NOT (t1 OR t2)'. Tags in query must be separated by comma. min_version: 2.26 not_tags_query: in: query required: false type: string description: | A list of tags to filter the server list by. Servers that don't match all tags in this list will be returned. Boolean expression in this case is 'NOT (t1 AND t2)'. Tags in query must be separated by comma. min_version: 2.26 offset_simple: description: | Used in conjunction with ``limit`` to return a slice of items. ``offset`` is where to start in the list. in: query required: false type: integer power_state_query_server: in: query required: false type: string description: | Filter the server list result by server power state. progress_query_server: description: | Filter the server list result by the progress of the server. in: query required: false type: string ramdisk_id_query_server: in: query required: false type: string description: | Filter the server list result by the UUID of the ramdisk image when using an AMI. reservation_id_query: in: query required: false type: string description: | A reservation id as returned by a servers multiple create call. server_name_query: description: | Filters the response by a server name, as a string. You can use regular expressions in the query. For example, the ``?name=bob`` regular expression returns both bob and bobb. If you must match on only bob, you can use a regular expression that matches the syntax of the underlying database server that is implemented for Compute, such as MySQL or PostgreSQL. .. note:: 'display_name' can also be requested which is alias of 'name' but that is not recommended to use as that will be removed in future. format: regexp in: query required: false type: string server_root_device_name_query: in: query required: true type: string description: | Filter the server list result by the root device name of the server server_status_query: description: | Filters the response by a server status, as a string. For example, ``ACTIVE``. in: query required: false type: string server_uuid_query: description: | Filter the server list result by the UUID of the server. in: query required: false type: string sort_dir_flavor: description: | Sort direction. A valid value is ``asc`` (ascending) or ``desc`` (descending). Default is ``asc``. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the direction of the flavor ``sort_key`` attribute. in: query required: false type: string sort_dir_server: description: | Sort direction. A valid value is ``asc`` (ascending) or ``desc`` (descending). Default is ``desc``. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the direction of the server ``sort_key`` attribute. in: query required: false type: string sort_key_flavor: description: | Sorts by a flavor attribute. Default attribute is ``flavorid``. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the flavor ``sort_key`` attribute. in: query required: false type: string sort_key_server: description: | Sorts by a server attribute. Default attribute is ``created``. You can specify multiple pairs of sort key and sort direction query parameters. If you omit the sort direction in a pair, the API uses the natural sorting direction of the server ``sort_key`` attribute. The sort keys are limited to: - ``access_ip_v4`` - ``access_ip_v6`` - ``auto_disk_config`` - ``availability_zone`` - ``config_drive`` - ``created_at`` - ``display_description`` - ``display_name`` - ``host`` - ``hostname`` - ``image_ref`` - ``instance_type_id`` - ``kernel_id`` - ``key_name`` - ``launch_index`` - ``launched_at`` - ``locked_by`` - ``node`` - ``power_state`` - ``progress`` - ``project_id`` - ``ramdisk_id`` - ``root_device_name`` - ``task_state`` - ``terminated_at`` - ``updated_at`` - ``user_id`` - ``uuid`` - ``vm_state`` in: query required: false type: string start_simple_tenant_usage: description: | The beginning time to calculate usage statistics on compute and storage resources. The date and time stamp format is any of the following ones: :: CCYY-MM-DDThh:mm:ss For example, ``2015-08-27T09:49:58``. :: CCYY-MM-DDThh:mm:ss.NNNNNN For example, ``2015-08-27T09:49:58.123456``. :: CCYY-MM-DD hh:mm:ss.NNNNNN For example, ``2015-08-27 09:49:58.123456``. If you omit this parameter, the current time is used. in: query required: false type: string tags_any_query: in: query required: false type: string description: | A list of tags to filter the server list by. Servers that match any tag in this list will be returned. Boolean expression in this case is 't1 OR t2'. Tags in query must be separated by comma. min_version: 2.26 tags_query: in: query required: false type: string description: | A list of tags to filter the server list by. Servers that match all tags in this list will be returned. Boolean expression in this case is 't1 AND t2'. Tags in query must be separated by comma. min_version: 2.26 task_state_query_server: in: query required: false type: string description: | Filter the server list result by task state. terminated_at_query_server: description: | Filter the server list result by a date and time stamp when instance was terminated. The date and time stamp format is `ISO 8601 `_: :: CCYY-MM-DDThh:mm:ss±hh:mm The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC. For example, ``2015-08-27T09:49:58-05:00``. If you omit the time zone, the UTC time zone is assumed. in: query required: false type: string usage_limit: description: | Requests a page size of items. Calculate usage for the limited number of instances. Use the ``limit`` parameter to make an initial limited request and use the last-seen instance UUID from the response as the ``marker`` parameter value in a subsequent limited request. in: query required: false type: integer min_version: 2.40 usage_marker: description: | The last-seen item. Use the ``limit`` parameter to make an initial limited request and use the last-seen instance UUID from the response as the ``marker`` parameter value in a subsequent limited request. in: query required: false type: string min_version: 2.40 user_id_query_quota: description: | ID of user to list the quotas for. in: query required: false type: string user_id_query_quota_delete: description: | ID of user to delete quotas for. in: query required: false type: string user_id_query_server: description: | Filter the list of servers by the given user ID. in: query required: false type: string user_id_query_set_quota: description: | ID of user to set the quotas for. in: query required: false type: string vm_state_query_server: description: | Filter the server list result by vm state. in: query required: false type: string # variables in body accessIPv4: in: body required: true type: string description: | IPv4 address that should be used to access this server. May be automatically set by the provider. accessIPv4_in: in: body required: false type: string description: | IPv4 address that should be used to access this server. accessIPv6: in: body required: true type: string description: | IPv6 address that should be used to access this server. May be automatically set by the provider. accessIPv6_in: in: body required: false type: string description: | IPv6 address that should be used to access this server. action: description: | The name of the action. in: body required: true type: string action_reserve: description: | The attribute to reserve an IP with a value of ``null``. in: body required: false type: string action_unreserve: description: | The attribute to release an IP with a value of ``null``. in: body required: false type: string addFixedIp: description: | The action to add a fixed ip address to a server. in: body required: true type: object addFloatingIp: description: | The action. Contains required floating IP ``address`` and optional ``fixed_address``. in: body required: true type: object address: description: | The floating IP address. in: body required: true type: string addresses: description: | The addresses for the server. Addresses information is hidden for any server in a state set in the ``hide_server_address_states`` configuration option. By default, servers in ``building`` state hide their addresses information. See ``nova.conf`` `configuration options `_ for more information. in: body required: true type: object addresses_obj: description: | The addresses information for the server. in: body required: true type: object addSecurityGroup: description: | The action to add a security group to a server. in: body required: true type: object addTenantAccess: description: | The action. in: body required: true type: string adminPass_change_password: description: | The administrative password for the server. in: body required: true type: string adminPass_evacuate: description: | An administrative password to access the evacuated instance. If you set ``enable_instance_password`` configuration option to ``False``, the API wouldn't return the ``adminPass`` field in response. in: body required: false type: string max_version: 2.13 adminPass_evacuate_request: description: | An administrative password to access the evacuated server. If you omit this parameter, the operation generates a new password. Up to API version 2.13, if ``onSharedStorage`` is set to ``True`` and this parameter is specified, an error is raised. in: body required: false type: string adminPass_request: description: | The administrative password of the server. If you omit this parameter, the operation generates a new password. in: body required: false type: string adminPass_rescue_request: description: | The password for the rescued instance. If you omit this parameter, the operation generates a new password. in: body required: false type: string adminPass_response: description: | The administrative password for the server. If you set ``enable_instance_password`` configuration option to ``False``, the API wouldn't return the ``adminPass`` field in response. in: body required: false type: string agent: description: | The guest agent object. in: body required: true type: object agent_id: description: | The agent ID. in: body required: true type: integer agent_id_str: description: | The agent ID. (This is a bug of API, this should be integer type which is consistent with the responses of agent create and list. This will be fixed in later microversion.) in: body required: true type: string agents: description: | A list of guest agent objects. in: body required: true type: array aggregate: description: | The host aggregate object. in: body required: true type: object aggregate_add_host: description: | The add_host object used to add host to aggregate. in: body required: true type: object aggregate_az: description: | The availability zone of the host aggregate. in: body required: true type: string aggregate_az_optional: description: | The availability zone of the host aggregate. in: body required: false type: string aggregate_host_list: description: | A list of host ids in this aggregate. in: body required: true type: array aggregate_id_body: description: | The ID of the host aggregate. in: body required: true type: integer aggregate_metadata: description: | Metadata key and value pairs associate with the aggregate. in: body required: true type: object aggregate_name: description: | The name of the host aggregate. in: body required: true type: string aggregate_name_optional: description: | The name of the host aggregate. in: body required: false type: string aggregate_remove_host: description: | The add_host object used to remove host from aggregate. in: body required: true type: object aggregate_uuid: description: | The UUID of the host aggregate. in: body required: true type: string min_version: 2.41 aggregates: description: | The list of existing aggregates. in: body required: true type: array alias: description: | A short name by which this extension is also known. in: body required: true type: string alive: description: | Returns true if the instance is alive. in: body required: true type: boolean architecture: description: | The name of the cpu architecture. in: body required: true type: string associate_host: description: | The name of the host to associate. in: body required: true type: string attachment_device_resp: description: | Name of the device in the attachment object, such as, ``/dev/vdb``. in: body required: false type: string attachment_id_required: description: | The UUID of the attachment. in: body required: true type: string attachment_id_resp: description: | The UUID of the attachment. in: body required: false type: string attachment_server_id_resp: description: | The UUID of the server. in: body required: false type: string attachment_volumeId_resp: description: | The UUID of the attached volume. in: body required: false type: string availability_zone: description: | The availability zone. in: body required: false type: string availability_zone_info: description: | The list of availability zone information. in: body required: true type: array availability_zone_state: description: | The current state of the availability zone. in: body required: true type: object available: description: | Returns true if the availability zone is available. in: body required: true type: boolean backup_name: description: | The name of the image to be backed up. in: body required: true type: string backup_rotation: description: | The rotation of the back up image, the oldest image will be removed when image count exceed the rotation count. in: body required: true type: integer backup_type: description: | The type of the backup, for example, ``daily``. in: body required: true type: string baremetal_cpus: description: | Number of CPUs the node has. .. note:: This is a JSON string, even though it will look like an int value. in: body required: true type: string baremetal_disk: description: | Amount of disk in GiB the node has. .. note:: This is a JSON string, even though it will look like an int value. in: body required: true type: string baremetal_host: description: | This will always have the value ``IRONIC MANAGED``. in: body required: true type: string baremetal_id: description: | UUID of the baremetal node. in: body required: true type: string baremetal_instance_uuid: description: | UUID of the server instance on this node. in: body required: true type: string baremetal_interfaces: description: | A list of interface objects for active interfaces on the baremetal node. Each will have an ``address`` field with the address. in: body required: true type: array baremetal_mem: description: | Amount of memory in MiB the node has. .. note:: This is a JSON string, even though it will look like an int value. in: body required: true type: string baremetal_node: description: | A baremetal node object. in: body required: true type: object baremetal_nodes: description: | An array of baremetal node objects. in: body required: true type: array baremetal_taskstate: description: | The Ironic task state for the node. See Ironic project for more details. in: body required: true type: string binary: description: | The binary name of the service. in: body required: true type: string block_device_mapping_v2: description: | Enables fine grained control of the block device mapping for an instance. This is typically used for booting servers from volumes. An example format would look as follows: .. code-block:: javascript "block_device_mapping_v2": [{ "boot_index": "0", "uuid": "ac408821-c95a-448f-9292-73986c790911", "source_type": "image", "volume_size": "25", "destination_type": "volume", "delete_on_termination": true, "tag": "disk1" }] In microversion 2.32, ``tag`` is an optional string attribute that can be used to assign a tag to the block device. This tag is then exposed to the guest in the metadata API and the config drive and is associated to hardware metadata for that block device, such as bus (ex: SCSI), bus address (ex: 1:0:2:0), and serial. A bug has caused the ``tag`` attribute to no longer be accepted starting with version 2.33. It has been restored in version 2.42. in: body required: false type: object block_device_uuid: description: | This is the uuid of source resource. The uuid is point to different resource based on the source_type. For example, if source_type is ``image`` as the above sample, the block device is created based on the specified image which is gotten from the image service. in: body required: false type: string block_migration: description: | Set to ``True`` to migrate local disks by using block migration. If the source or destination host uses shared storage and you set this value to ``True``, the live migration fails. in: body required: true type: boolean max_version: 2.24 block_migration_2_25: description: | Migrates local disks by using block migration. Set to ``auto`` which means nova will detect whether source and destination hosts on shared storage. if they are on shared storage, the live-migration won't be block migration. Otherwise the block migration will be executed. Set to ``True``, means the request will fail when the source or destination host uses shared storage. Set to ``False`` means the request will fail when the source and destination hosts are not on the shared storage. in: body required: true type: string min_version: 2.25 boot_index: description: | Defines the order in which a hypervisor tries devices when it attempts to boot the guest from storage. Give each device a unique boot index starting from ``0``. To disable a device from booting, set the boot index to a negative value or use the default boot index value, which is ``None``. The simplest usage is, set the boot index of the boot device to ``0`` and use the default boot index value, ``None``, for any other devices. Some hypervisors might not support booting from multiple devices; these hypervisors consider only the device with a boot index of ``0``. Some hypervisors support booting from multiple devices but only if the devices are of different types. For example, a disk and CD-ROM. in: body required: true type: string certificate: description: | The certificate object. in: body required: true type: object changePassword: description: | The action to change an administrative password of the server. in: body required: true type: object cidr: description: | The CIDR for address range. in: body required: true type: string cloudpipe: description: | The cloudpipe object. in: body required: true type: object cloudpipes: description: | The list of cloudpipe objects. in: body required: true type: array code: description: | The HTTP response code for the event. The following codes are currently used: * 200 - successfully submitted event * 404 - the instance specified by ``server_uuid`` was not found * 422 - no host was found for the server specified by ``server_uuid``, so there is no route to this server. in: body required: true type: string config_drive: description: | Indicates whether a configuration drive enables metadata injection. The config_drive setting provides information about a drive that the instance can mount at boot time. The instance reads files from the drive to get information that is normally available through the metadata service. This metadata is different from the user data. Not all cloud providers enable the ``config_drive``. Read more in the OpenStack End User Guide. in: body required: false type: boolean config_drive_resp: description: | Indicates whether or not a config drive was used for this server. in: body required: true type: boolean configure_project_cloudpipe: description: | VPN IP and Port information to configure the cloudpipe instance.. in: body required: true type: object confirmResize: description: | The action to confirm a resize operation. in: body required: true type: none console: description: | The console object. in: body required: true type: object console_host: description: | The name or ID of the host. in: body required: false type: string console_id_in_body: description: | The UUID of the console. in: body required: true type: string console_output: description: | The console output as a string. Control characters will be escaped to create a valid JSON string. in: body required: true type: string console_password: description: | The password for the console. in: body required: true type: string console_type: description: | The type of the console. in: body required: true type: string consoles: description: | The list of console objects. in: body required: true type: array contents: description: | The file contents field in the personality object. in: body required: true type: string cores: description: | The number of allowed instance cores for each tenant. in: body required: true type: integer cores_quota_details: description: | The object of detailed cores quota, including in_use, limit and reserved number of cores. in: body required: true type: object cores_quota_optional: description: | The number of allowed instance cores for each tenant. in: body required: false type: integer cpu_info: description: | A dictionary that contains cpu information like ``arch``, ``model``, ``vendor``, ``features`` and ``topology``. The content of this field is hypervisor specific. .. note:: Since version 2.28 ``cpu_info`` field is returned as a dictionary instead of string. in: body required: true type: object create_info: description: | Information for snapshot creation. in: body required: true type: object create_info_id: description: | Its an arbitrary string that gets passed back to the user. in: body required: false type: string create_info_id_resp: description: | Its the same arbitrary string which was sent in request body. .. note:: This string is passed back to user as it is and not being used in Nova internally. So use ``snapshot_id`` instead for further operation on this snapshot. in: body required: true type: string createBackup: description: | The action. in: body required: true type: object created: description: | The date and time when the resource was created. The date and time stamp format is `ISO 8601 `_ :: CCYY-MM-DDThh:mm:ss±hh:mm For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is ``-05:00``. in: body required: true type: string createImage: description: | The action to create a snapshot of the image or the volume(s) of the server. in: body required: true type: object current_workload: description: | The current_workload is the number of tasks the hypervisor is responsible for. This will be equal or greater than the number of active VMs on the system (it can be greater when VMs are being deleted and the hypervisor is still cleaning up). in: body required: true type: integer data: description: | The certificate. in: body required: true type: string delete_on_termination: description: | To delete the boot volume when the server is destroyed, specify ``true``. Otherwise, specify ``false``. Default: ``false`` in: body required: false type: string deleted: description: | A boolean indicates whether this aggregate is deleted or not, if it has not been deleted, ``false`` will appear. in: body required: true type: boolean deleted_at: description: | The date and time when the resource was deleted. If the resource has not been deleted yet, this field will be ``null``, The date and time stamp format is `ISO 8601 `_ :: CCYY-MM-DDThh:mm:ss±hh:mm For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is ``-05:00``. in: body required: true type: string description: description: | Security group description. in: body required: true type: string destination_type: description: | Defines where the volume comes from. A valid value is ``local`` or ``volume``. in: body required: false type: string device: description: | Name of the device such as, ``/dev/vdb``. Omit or set this parameter to null for auto-assignment, if supported. If you specify this parameter, the device must not exist in the guest operating system. Note that as of the 12.0.0 Liberty release, the Nova libvirt driver no longer honors a user-supplied device name. This is the same behavior as if the device name parameter is not supplied on the request. in: body required: false type: string device_name: description: | A path to the device for the volume that you want to use to boot the server. Note that as of the 12.0.0 Liberty release, the Nova libvirt driver no longer honors a user-supplied device name. This is the same behavior as if the device name parameter is not supplied on the request. in: body required: true type: string device_resp: description: | Name of the device such as, ``/dev/vdb``. in: body required: true type: string device_tag_bdm: description: | A device role tag that can be applied to a block device. The guest OS of a server that has devices tagged in this manner can access hardware metadata about the tagged devices from the metadata API and on the config drive, if enabled. .. note:: Due to a bug, block device tags are accepted in version 2.32 and subsequently starting with version 2.42. in: body required: false type: string min_version: 2.32 device_tag_nic: description: | A device role tag that can be applied to a network interface. The guest OS of a server that has devices tagged in this manner can access hardware metadata about the tagged devices from the metadata API and on the config drive, if enabled. .. note:: Due to a bug, network interface tags are accepted between 2.32 and 2.36 inclusively, and subsequently starting with version 2.42. in: body required: false type: string min_version: 2.32 disabled_reason_body: description: | The reason for disabling a service. in: body required: true type: string disk_available_least: description: | The actual free disk on this hypervisor(in GB). in: body required: true type: integer disk_config: description: | Disk configuration. The value is either: - ``AUTO``. The API builds the server with a single partition the size of the target flavor disk. The API automatically adjusts the file system to fit the entire partition. - ``MANUAL``. The API builds the server by using the partition scheme and file system that is in the source image. If the target flavor disk is larger, The API does not partition the remaining disk space. in: body required: true type: string disk_over_commit: description: | Set to ``True`` to enable over commit when the destination host is checked for available disk space. Set to ``False`` to disable over commit. This setting affects only the libvirt virt driver. in: body required: true type: boolean max_version: 2.25 display_description: description: | The volume description. in: body required: true type: string display_description_optional: description: | The volume description. in: body required: false type: string display_name: description: | The volume name. in: body required: true type: string display_name_optional: description: | The volume name. in: body required: false type: string ended_at: description: | The date and time when the server was deleted. The date and time stamp format is as follows: :: CCYY-MM-DDThh:mm:ss.NNNNNN For example, ``2015-08-27T09:49:58.123456``. If the server hasn't been deleted yet, its value is ``null``. in: body required: true type: string ended_at_optional: description: | The date and time when the server was deleted. The date and time stamp format is as follows: :: CCYY-MM-DDThh:mm:ss.NNNNNN For example, ``2015-08-27T09:49:58.123456``. If the server hasn't been deleted yet, its value is ``null``. in: body required: false type: string errors: description: | The number of errors. in: body required: true type: integer evacuate: description: | The action to evacuate a server to another host. in: body required: true type: object event: description: | The name of the event. in: body required: true type: string event_finish_time: description: | The date and time when the event was finished. The date and time stamp format is `ISO 8601 `_ :: CCYY-MM-DDThh:mm:ss±hh:mm For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is ``-05:00``. in: body required: true type: string event_name: description: | The event name. A valid value is ``network-changed``, ``network-vif-plugged``, ``network-vif-unplugged``, or ``network-vif-deleted``. in: body required: true type: string event_result: description: | The result of the event. in: body required: true type: string event_start_time: description: | The date and time when the event was started. The date and time stamp format is `ISO 8601 `_ :: CCYY-MM-DDThh:mm:ss±hh:mm For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is ``-05:00``. in: body required: true type: string event_status: description: | The event status. A valid value is ``failed``, ``completed``, or ``in-progress``. Default is ``completed``. in: body required: false type: string event_tag: description: | A string value that identifies the event. in: body required: false type: string event_traceback: description: | The traceback stack if error occurred in this event. in: body required: true type: string events: description: | The action. in: body required: true type: array extension: description: | An ``extension`` object. in: body required: true type: object extension_description: description: | Text describing this extension's purpose. in: body required: true type: string extension_links: description: | Links pertaining to this extension. This is a list of dictionaries, each including keys ``href`` and ``rel``. in: body required: true type: array extension_name: description: | Name of the extension. in: body required: true type: string extensions: description: | List of ``extension`` objects. in: body required: true type: array extra_specs: description: | A dictionary of the flavor's extra-specs key-and-value pairs. It appears in the os-extra-specs' "create" REQUEST body, as well as the os-extra-specs' "create" and "list" RESPONSE body. in: body required: true type: object fault: description: | A fault object. Only displayed in the failed response. Default keys are ``code``, ``created``, and ``message`` (response code, created time, and message respectively). In addition, the key ``details`` (stack trace) is available if you have the administrator privilege. in: body required: false type: object fixed_address: description: | The fixed IP address with which you want to associate the floating IP address. in: body required: false type: string fixed_ip: description: | A fixed IPv4 address for the NIC. Valid with a ``neutron`` or ``nova-networks`` network. in: body required: false type: string fixed_ip_address: description: | Fixed IP associated with floating IP network. in: body required: true type: string fixed_ip_host: description: | The hostname of the host that manages the server that is associated with this fixed IP address. in: body required: true type: string fixed_ip_hostname: description: | The hostname of the server that is associated with this fixed IP address. in: body required: true type: string fixed_ip_obj: description: | A fixed IP address object. in: body required: true type: object fixed_ips: description: | Fixed IP addresses. If you request a specific fixed IP address without a ``net_id``, the request returns a ``Bad Request (400)`` response code. in: body required: false type: array fixed_ips_quota: description: | The number of allowed fixed IP addresses for each tenant. Must be equal to or greater than the number of allowed instances. in: body required: true type: integer max_version: 2.35 fixed_ips_quota_details: description: | The object of detailed fixed ips quota, including in_use, limit and reserved number of fixed ips. in: body required: true type: object max_version: 2.35 fixed_ips_quota_optional: description: | The number of allowed fixed IP addresses for each tenant. Must be equal to or greater than the number of allowed instances. in: body required: false type: integer max_version: 2.35 fixed_ips_resp: description: | Fixed IP addresses with subnet IDs. in: body required: true type: array flavor: description: | The ID and links for the flavor for your server instance. A flavor is a combination of memory, disk size, and CPUs. in: body required: true type: object flavor_access: description: | A list of objects, each with the keys ``flavor_id`` and ``tenant_id``. in: body required: true type: array flavor_cpus: in: body required: true type: integer description: | The number of virtual CPUs that will be allocated to the server. flavor_disabled: in: body required: false type: boolean description: | Whether or not the flavor has been administratively disabled. This is typically only visible to administrative users. flavor_disk: in: body required: true type: integer description: | The size of the root disk that will be created in GiB. If 0 the root disk will be set to exactly the size of the image used to deploy the instance. However, in this case filter scheduler cannot select the compute host based on the virtual image size. Therefore, 0 should only be used for volume booted instances or for testing purposes. flavor_ephem_disk: in: body required: true type: integer description: | The size of the ephemeral disk that will be created, in GiB. Ephemeral disks may be written over on server state changes. So should only be used as a scratch space for applications that are aware of its limitations. Defaults to 0. flavor_ephem_disk_in: in: body required: false type: integer description: | The size of the ephemeral disk that will be created, in GiB. Ephemeral disks may be written over on server state changes. So should only be used as a scratch space for applications that are aware of its limitations. Defaults to 0. flavor_extra_spec_key2: description: | The extra spec key of a flavor. It appears in the os-extra-specs' "create" and "update" REQUEST body, as well as the os-extra-specs' "create", "list", "show", and "update" RESPONSE body. in: body required: true type: string flavor_extra_spec_value: description: | The extra spec value of a flavor. It appears in the os-extra-specs' "create" and "update" REQUEST body, as well as the os-extra-specs' "create", "list", "show", and "update" RESPONSE body. in: body required: true type: string flavor_id_body: description: | The ID of the flavor. While people often make this look like an int, this is really a string. in: body required: true type: string flavor_id_body_create: description: | The ID of the flavor. While people often make this look like an int, this is really a string. If not provided, this defaults to a uuid. in: body required: false type: string flavor_is_public: description: | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified. in: body required: true type: boolean flavor_is_public_in: description: | Whether the flavor is public (available to all projects) or scoped to a set of projects. Default is True if not specified. in: body required: false type: boolean flavor_name: description: | The display name of a flavor. in: body required: true type: string flavor_name_optional: description: | The display name of a flavor. in: body required: false type: string flavor_ram: description: | The amount of RAM a flavor has, in MiB. in: body required: true type: integer flavor_rxtx_factor: description: | The receive / transmit factor (as a float) that will be set on ports if the network backend supports the QOS extension. Otherwise it will be ignored. It defaults to 1.0. in: body required: true type: float flavor_rxtx_factor_in: description: | The receive / transmit factor (as a float) that will be set on ports if the network backend supports the QOS extension. Otherwise it will be ignored. It defaults to 1.0. in: body required: false type: float flavor_server: description: | The ID and links for the flavor for your server instance. A flavor is a combination of memory, disk size, and CPUs. This can be empty object in case flavor information is not present in the system. in: body required: true type: object flavor_swap: description: | The size of a dedicated swap disk that will be allocated, in MiB. If 0 (the default), no dedicated swap disk will be created. in: body required: true type: integer flavor_swap_in: description: | The size of a dedicated swap disk that will be allocated, in MiB. If 0 (the default), no dedicated swap disk will be created. in: body required: false type: integer flavorRef: description: | The flavor reference, as an ID (including a UUID) or full URL, for the flavor for your server instance. in: body required: true type: string flavorRef_resize: description: | The flavor ID for resizing the server. If a specified flavor ID is the same as the current one of the server, the request returns a ``Bad Request (400)`` response code. in: body required: true type: string flavors: description: | An array of flavor objects. in: body required: true type: array floating_ip: description: | The floating ip address. in: body required: true type: string floating_ip_bulk_object: description: | The floating ip bulk address object. in: body required: true type: object floating_ip_id_value: description: | The floating IP id value. .. note:: For nova-network, the value will be of type integer, whereas for neutron, the value will be of type string. in: body required: true type: string floating_ip_obj: description: | A floating IP address object. in: body required: true type: object floating_ip_pool_name: description: | The name of the floating ip pool. in: body required: true type: string floating_ip_pool_name_optional: description: | The name of the floating ip pool in: body required: false type: string floating_ip_pools: description: | The ``floating_ip_pools`` object. in: body required: true type: array floating_ips: description: | The number of allowed floating IP addresses for each tenant. in: body required: true type: integer max_version: 2.35 floating_ips_list: description: | An array of floating ip objects. in: body required: true type: array floating_ips_quota_details: description: | The object of detailed floating ips quota, including in_use, limit and reserved number of floating ips. in: body required: true type: object max_version: 2.35 floating_ips_quota_optional: description: | The number of allowed floating IP addresses for each tenant. in: body required: false type: integer max_version: 2.35 force: description: | You can force the update even if the quota has already been used and the reserved quota exceeds the new quota. To force the update, specify the ``"force": "True"``. Default is ``False``. in: body required: false type: boolean force_evacuate: description: | Force an evacuation by not verifying the provided destination host by the scheduler. in: body required: false type: boolean min_version: 2.29 force_live_migrate: description: | Force a live-migration by not verifying the provided destination host by the scheduler. in: body required: false type: boolean min_version: 2.30 force_migration_complete: description: | The action. in: body required: true type: string min_version: 2.22 force_snapshot: description: | Indicates whether to create a snapshot, even if the volume is attached. in: body required: false type: boolean forced_down: description: | Whether or not this service was forced down manually by an administrator. This value is useful to know that some 3rd party has verified the service should be marked down. in: body required: true type: boolean min_version: 2.11 forceDelete: description: | The action. in: body required: true type: none free_ram_mb: description: | The free RAM in this hypervisor(in MB). in: body required: true type: integer from_port: description: | The port at start of range. in: body required: true type: integer group: description: | A ``group`` object. Includes the ``tenant_id`` and the source security group ``name``. in: body required: true type: object group_id: description: | The source security group ID. in: body required: false type: string guest_format: description: | Specifies the guest server disk file system format, such as ``ephemeral`` or ``swap``. in: body required: true type: string host: description: | The name or ID of the host to which the server is evacuated. If you omit this parameter, the scheduler chooses a host. in: body required: false type: string host_cpu: description: | The number of virtual CPUs on the host. in: body required: true type: integer host_disk_gb: description: | The disk size on the host (in GB). in: body required: true type: integer host_done_num: description: | The number of the hosts whose instance audit tasks have been done. in: body required: true type: integer host_ip: description: | The IP address of the hypervisor's host. in: body required: true type: string host_maintenance_mode: description: | Mode of maintenance state, either ``on_maintenance`` or ``off_maintenance``. in: body required: false type: string host_maintenance_mode_in: description: | Mode of maintenance state, either ``enable`` or ``disable``. in: body required: false type: string host_memory_mb: description: | The memory size on the host (in MB). in: body required: true type: integer host_migration: description: | The host to which to migrate the server. If this parameter is ``None``, the scheduler chooses a host. in: body required: true type: string host_name_body: description: | The name of the host. in: body required: true type: string host_not_run: description: | A list of the hosts whose instance audit tasks have not run. in: body required: true type: array host_not_run_num: description: | The number of the hosts whose instance audit tasks have not run. in: body required: true type: integer host_num: description: | The number of the hosts. in: body required: true type: integer host_power_action: description: | The power action on the host. in: body required: true type: string host_project: description: | The project id (or special name like total, used_now, used_max). in: body required: true type: string host_resource: description: | The resource info of the host. in: body required: true type: object host_resource_array: description: | The array that includes resource info of the host. in: body required: true type: array host_running_num: description: | The number of the hosts whose instance audit tasks are running. in: body required: true type: integer host_service: description: | The name of the service which is running on the host. in: body required: true type: string host_status: description: | The host status. Values where next value in list can override the previous: - ``UP`` if nova-compute up. - ``UNKNOWN`` if nova-compute not reported by servicegroup driver. - ``DOWN`` if nova-compute forced down. - ``MAINTENANCE`` if nova-compute is disabled. - Empty string indicates there is no host for server. This attribute appears in the response only if the policy permits. in: body required: true type: string min_version: 2.16 host_status_body: description: | The status of the current host, either ``enabled`` or ``disabled``. in: body required: false type: string host_status_body_in: description: | The status of the host, either ``enable`` or ``disable``. in: body required: false type: string host_zone: description: | The available zone of the host. in: body required: true type: string hostId: description: | An ID string representing the host. This is a hashed value so will not actually look like a hostname, and is hashed with data from the project_id, so the same physical host as seen by two different project_ids, will be different. It is useful when within the same project you need to determine if two instances are on the same or different physical hosts for the purposes of availability or performance. in: body required: true type: string hosts: description: | An array of host information. in: body required: true type: array hosts.availability_zone: description: | An object containing a list of host information. The host information is comprised of host and service objects. The service object returns three parameters representing the states of the service: ``active``, ``available``, and ``updated_at``. in: body required: true type: object hosts.availability_zone_none: description: | It is always ``null``. in: body required: true type: none hours: description: | The duration that the server exists (in hours). in: body required: true type: float hours_optional: description: | The duration that the server exists (in hours). in: body required: false type: float hypervisor: description: | The hypervisor object. in: body required: true type: object hypervisor_count: description: | The number of hypervisors. in: body required: true type: integer hypervisor_free_disk_gb: description: | The free disk remaining on this hypervisor(in GB). in: body required: true type: integer hypervisor_hostname: description: | The hypervisor host name provided by the Nova virt driver. For the Ironic driver, it is the Ironic node name. in: body required: true type: string hypervisor_id_body: description: | The id of the hypervisor. in: body required: true type: integer hypervisor_links: description: | Links to the hypervisors resource. See `API Guide / Links and References `_ for more info. in: body type: array min_version: 2.33 required: false hypervisor_service: description: | The hypervisor service object. in: body required: true type: object hypervisor_state: description: | The state of the hypervisor. One of ``up`` or ``down``. in: body required: true type: string hypervisor_statistics: description: | The object of the hypervisors' statics. in: body required: true type: object hypervisor_status: description: | The status of the hypervisor. One of ``enabled`` or ``disabled``. in: body required: true type: string hypervisor_type: in: body required: true type: string description: | The hypervisor type for the agent. Currently only ``xen`` is supported. hypervisor_type_body: description: | The hypervisor type. in: body required: true type: string hypervisor_vcpus: description: | The number of vcpu in this hypervisor. in: body required: true type: integer hypervisor_vcpus_used: description: | The number of vcpu used in this hypervisor. in: body required: true type: integer hypervisor_version: description: | The hypervisor version. in: body required: true type: integer hypervisors: description: | An array of hypervisor information. in: body required: true type: array id: description: | The security group name or UUID. in: body required: true type: string image: description: | The UUID and links for the image for your server instance. The ``image`` object might be an empty string when you boot the server from a volume. in: body required: true type: object image_id_body: description: | The ID of the Image. in: body required: true type: string image_metadata: description: | Metadata key and value pairs for the image. The maximum size for each metadata key and value pair is 255 bytes. in: body required: false type: object image_metadata_items: description: | The number of allowed metadata items for each image. Starting from version 2.39 this field is dropped from 'os-limits' response, because 'image-metadata' proxy API was deprecated. in: body required: true type: integer max_version: 2.38 image_name: description: | The display name of an Image. in: body required: true type: string image_progress: description: | A percentage value of the image save progress. This can be one of: - ``ACTIVE``: 100 - ``SAVING``: 25 or 50 in: body required: true type: integer image_server: description: | The server booted from image. in: body required: false type: object image_size: description: | The size of the image. in: body required: true type: integer image_status: description: | The status of image, as a string. This can be one of: - ``ACTIVE``: image is in active state - ``SAVING``: image is in queued or in saving process - ``DELETED``: image is deleted or in progress of deletion - ``ERROR``: image is in error state - ``UNKNOWN``: image is in unknown state in: body required: true type: string imageRef: description: | The UUID of the image to use for your server instance. This is not required in case of boot from volume. In all other cases it is required and must be a valid UUID otherwise API will return 400. in: body required: true type: string imageRef_rebuild: description: | The UUID of the image to rebuild for your server instance. It must be a valid UUID otherwise API will return 400. in: body required: true type: string images: description: | An array of Image objects. in: body required: true type: array injected_file_content_bytes: description: | The number of allowed bytes of content for each injected file. in: body required: true type: integer injected_file_content_bytes_quota_details: description: | The object of detailed injected file content bytes quota, including in_use, limit and reserved number of injected file content bytes. in: body required: true type: object injected_file_content_bytes_quota_optional: description: | The number of allowed bytes of content for each injected file. in: body required: false type: integer injected_file_path_bytes: description: | The number of allowed bytes for each injected file path. in: body required: true type: integer injected_file_path_bytes_quota_details: description: | The object of detailed injected file path bytes quota, including in_use, limit and reserved number of injected file path bytes. in: body required: true type: object injected_file_path_bytes_quota_optional: description: | The number of allowed bytes for each injected file path. in: body required: false type: integer injected_files: description: | The number of allowed injected files for each tenant. in: body required: true type: integer injected_files_quota_details: description: | The object of detailed injected files quota, including in_use, limit and reserved number of injected files. in: body required: true type: object injected_files_quota_optional: description: | The number of allowed injected files for each tenant. in: body required: false type: integer injectNetworkInfo: description: | The action. in: body required: true type: none instance_action_events: description: | The events occurred in this action. in: body required: true type: array instance_id_body: description: | The UUID of the server. in: body required: true type: string instance_id_cloudpipe: description: | The UUID of the cloudpipe instance. in: body required: true type: string instance_name: description: | The name of the instance. in: body required: true type: string instance_usage_audit_log: description: | The object of instance usage audit logs. in: body required: true type: object instance_usage_audit_log_message: description: | The log message of the instance usage audit task. in: body required: true type: string instance_usage_audit_logs: description: | The object of instance usage audit log information. in: body required: true type: object instance_usage_audit_task_state: description: | The state of the instance usage audit task. ``DONE`` or ``RUNNING``. in: body required: true type: string instanceAction: description: | The instance action object. in: body required: true type: object instanceActions: description: | List of the actions for the given instance. in: body required: true type: array instances: description: | The number of allowed instances for each tenant. in: body required: true type: integer instances_quota_details: description: | The object of detailed instances quota, including in_use, limit and reserved number of instances. in: body required: true type: object instances_quota_optional: description: | The number of allowed instances for each tenant. in: body required: false type: integer instances_usage_audit: description: | The number of instances. in: body required: true type: integer interfaceAttachment: description: | Specify the ``interfaceAttachment`` action in the request body. in: body required: true type: string interfaceAttachment_resp: description: | The interface attachment. in: body required: true type: object interfaceAttachments: description: | List of the interface attachments. in: body required: true type: array internal_access_path: description: | The id representing the internal access path. in: body required: false type: string ip_address: description: | The IP address. in: body required: true type: string ip_address_req: description: | The IP address. It is required when ``fixed_ips`` is specified. in: body required: true type: string ip_host: description: | The name or ID of the host associated to the IP. in: body required: true type: string ip_protocol: description: | The IP protocol. A valid value is ICMP, TCP, or UDP. in: body required: true type: string ip_range: description: | The range of IP addresses to use for creating floating IPs. in: body required: true type: string ip_range_delete: description: | The range of IP addresses from which to bulk-delete floating IPs. in: body required: true type: string key_name: description: | Key pair name. in: body required: false type: string key_name_resp: description: | The name of associated key pair, if any. in: body required: true type: string key_pairs: description: | The number of allowed key pairs for each user. in: body required: true type: integer key_pairs_quota_details: description: | The object of detailed key pairs quota, including in_use, limit and reserved number of key pairs. in: body required: true type: object key_pairs_quota_optional: description: | The number of allowed key pairs for each user. in: body required: false type: integer keypair: in: body type: object required: true description: | Keypair object keypair_deleted: description: | A boolean indicates whether this keypair is deleted or not. The value is always ``false`` (not deleted). in: body required: true type: boolean keypair_fingerprint: in: body required: true type: string description: | The fingerprint for the keypair. keypair_id: description: | The keypair ID. in: body required: true type: integer keypair_links: description: | Links pertaining to keypair. See `API Guide / Links and References `_ for more info. in: body type: array required: false min_version: 2.35 keypair_name: in: body required: true type: string description: | A name for the keypair which will be used to reference it later. keypair_private_key: description: | If you do not provide a public key on create, a new keypair will be built for you, and the private key will be returned during the initial create call. Make sure to save this, as there is no way to get this private key again in the future. in: body required: false type: string keypair_public_key: description: | The keypair public key. in: body required: true type: string keypair_public_key_in: description: | The public ssh key to import. If you omit this value, a keypair is generated for you. in: body required: false type: string keypair_type: in: body required: true type: string description: | The type of the keypair. Allowed values are ``ssh`` or ``x509``. min_version: 2.2 keypair_type_in: in: body required: false type: string description: | The type of the keypair. Allowed values are ``ssh`` or ``x509``. min_version: 2.2 keypair_updated_deleted_at: description: | It is always ``null``. in: body required: true type: none # NOTE(mriedem): This is the user_id description for the keypair create/show # response which has always been returned. keypair_userid: in: body required: true type: string description: | The user_id for a keypair. keypair_userid_in: in: body required: false type: string description: | The user_id for a keypair. This allows administrative users to upload keys for other users than themselves. min_version: 2.10 keypairs: in: body type: array required: true description: | Array of Keypair objects length: description: | The number of lines to fetch from the end of console log. All lines will be returned if this is not specified. .. note:: This parameter can be specified as not only 'integer' but also 'string'. in: body required: false type: integer limits: description: | Data structure that contains both absolute limits within a deployment. in: body required: true type: object limits_absolutes: description: | Name/value pairs that set quota limits within a deployment. in: body required: true type: object limits_rate_uri: description: | A human readable URI that is used as a friendly description of where the api rate limit is applied. in: body required: true type: string limits_rates: description: | An empty list for backwards compatibility purposes. in: body required: true type: array links: description: | Links to the resources in question. See `API Guide / Links and References `_ for more info. in: body required: true type: array local_gb: description: | The disk in this hypervisor(in GB). in: body required: true type: integer local_gb_simple_tenant_usage: description: | The sum of the root disk size of the server and the ephemeral disk size of it (in GiB). in: body required: true type: integer local_gb_simple_tenant_usage_optional: description: | The sum of the root disk size of the server and the ephemeral disk size of it (in GiB). in: body required: false type: integer local_gb_used: description: | The disk used in this hypervisor(in GB). in: body required: true type: integer lock: description: | The action to lock a server. in: body required: true type: none locked: description: | True if the instance is locked otherwise False. in: body required: true type: boolean min_version: 2.9 mac_addr: description: | The MAC address. in: body required: true type: string mac_address: description: | The MAC address. in: body required: true type: string md5hash: description: | The MD5 hash. in: body required: true type: string members: description: | A list of members in the server group. in: body required: true type: array memory_mb: description: | The memory of this hypervisor(in MB). in: body required: true type: integer memory_mb_simple_tenant_usage: description: | The memory size of the server (in MB). in: body required: true type: integer memory_mb_simple_tenant_usage_optional: description: | The memory size of the server (in MB). in: body required: false type: integer memory_mb_used: description: | The memory used in this hypervisor(in MB). in: body required: true type: integer message: description: | The related error message for when an action fails. in: body required: true type: string meta: description: | The object of detailed key metadata items. in: body required: true type: object metadata: description: | Metadata key and value pairs. The maximum size of the metadata key and value is 255 bytes each. in: body required: false type: object metadata_compat: description: | A dictionary of metadata key-and-value pairs, which is maintained for backward compatibility. in: body required: true type: object metadata_items: description: | The number of allowed metadata items for each instance. in: body required: true type: integer metadata_items_quota_details: description: | The object of detailed key metadata items quota, including in_use, limit and reserved number of metadata items. in: body required: true type: object metadata_items_quota_optional: description: | The number of allowed metadata items for each instance. in: body required: false type: integer metadata_object: description: | Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes. in: body required: true type: object migrate: description: | The action. in: body required: true type: string migrate_dest_compute: description: | The target compute for a migration. in: body required: true type: string migrate_dest_host: description: | The target host for a migration. in: body required: true type: string migrate_dest_node: description: | The target node for a migration. in: body required: true type: string migrate_disk_processed_bytes: description: | The amount of disk, in bytes, that has been processed during the migration. in: body required: true type: integer migrate_disk_remaining_bytes: description: | The amount of disk, in bytes, that still needs to be migrated. in: body required: true type: integer migrate_disk_total_bytes: description: | The total amount of disk, in bytes, that needs to be migrated. in: body required: true type: integer migrate_memory_processed_bytes: description: | The amount of memory, in bytes, that has been processed during the migration. in: body required: true type: integer migrate_memory_remaining_bytes: description: | The amount of memory, in bytes, that still needs to be migrated. in: body required: true type: integer migrate_memory_total_bytes: description: | The total amount of memory, in bytes, that needs to be migrated. in: body required: true type: integer migrate_source_compute: description: | The source compute for a migration. in: body required: true type: string migrate_source_node: description: | The source node for a migration. in: body required: true type: string migrate_status: description: | The current status of the migration. in: body required: true type: string migration: description: | The server migration object. in: body required: true type: object migration_id: description: | The ID of the server migration. in: body required: true type: integer migrations: description: | The list of server migration objects. in: body required: true type: array minDisk_body: description: | The minimum amount of disk space an image requires to boot, in GiB. For example, ``100``. in: body required: true type: integer minRam_body: description: | The minimum amount of RAM an image requires to function, in MB. For example, ``512``. in: body required: true type: integer name: description: | The security group name. in: body required: true type: string name_server_group: description: | The name of the server group. in: body required: true type: string namespace: description: | A URL pointing to the namespace for this extension. in: body required: true type: string net_id: description: | The ID of the network for which you want to create a port interface. The ``net_id`` and ``port_id`` parameters are mutually exclusive. If you do not specify the ``net_id`` parameter, the OpenStack Networking API v2.0 uses the network information cache that is associated with the instance. in: body required: false type: string net_id_resp: description: | The network ID. in: body required: true type: string net_id_resp_2_12: description: | The network ID. in: body required: true type: string min_version: 2.12 network_label_body: description: | List of IP address and IP version pairs. The ``network_label`` stands for the name of a network, such as ``public`` or ``private``. in: body required: true type: array network_uuid: description: | To provision the server instance with a NIC for a network, specify the UUID of the network in the ``uuid`` attribute in a ``networks`` object. Required if you omit the ``port`` attribute. Starting with microversion 2.37, this value is strictly enforced to be in UUID format. in: body required: false type: string networks: description: | A ``networks`` object. Required parameter when there are multiple networks defined for the tenant. When you do not specify the networks parameter, the server attaches to the only network created for the current tenant. Optionally, you can create one or more NICs on the server. To provision the server instance with a NIC for a network, specify the UUID of the network in the ``uuid`` attribute in a ``networks`` object. To provision the server instance with a NIC for an already existing port, specify the port-id in the ``port`` attribute in a ``networks`` object. In microversion 2.32, the ``tag`` is an optional string attribute that can be used to assign a tag to a virtual network interface. This tag is then exposed to the guest in the metadata API and the config drive and is associated to hardware metadata for that network interface, such as bus (ex: PCI), bus address (ex: 0000:00:02.0), and MAC address. A bug has caused the ``tag`` attribute to no longer be accepted starting with version 2.37. Therefore, network interfaces could only be tagged in versions 2.32 to 2.36 inclusively. Version 2.42 has restored the ``tag`` attribute. Starting with microversion 2.37, this field is required and the special values *auto* and *none* can be specified for networks. *auto* tells the Compute service to use a network that is available to the project, if one exists. If one does not exist, the Compute service will attempt to automatically allocate a network for the project (if possible). *none* tells the Compute service to not allocate a network for the instance. The *auto* and *none* values cannot be used with any other network values, including other network uuids, ports or fixed IPs. These are requested as strings for the networks value, not in a list. See the associated example. in: body required: true type: object new_file: description: | The name of the qcow2 file that Block Storage creates, which becomes the active image for the VM. in: body required: true type: string on_shared_storage: description: | Server on shared storage. .. note:: Starting since version 2.14, Nova automatically detects whether the server is on shared storage or not. Therefore this parameter was removed. in: body required: true type: boolean max_version: 2.13 os: description: | The name of the operating system. in: body required: true type: string os-availability-zone:availability_zone: description: | The availability zone from which to launch the server. When you provision resources, you specify from which availability zone you want your instance to be built. Typically, you use availability zones to arrange OpenStack compute hosts into logical groups. An availability zone provides a form of physical isolation and redundancy from other availability zones. For instance, if some racks in your data center are on a separate power source, you can put servers in those racks in their own availability zone. Availability zones can also help separate different classes of hardware. By segregating resources into availability zones, you can ensure that your application resources are spread across disparate machines to achieve high availability in the event of hardware or other failure. in: body required: false type: string OS-DCF:diskConfig: description: | Controls how the API partitions the disk when you create, rebuild, or resize servers. A server inherits the ``OS-DCF:diskConfig`` value from the image from which it was created, and an image inherits the ``OS-DCF:diskConfig`` value from the server from which it was created. To override the inherited setting, you can include this attribute in the request body of a server create, rebuild, or resize request. If the ``OS-DCF:diskConfig`` value for an image is ``MANUAL``, you cannot create a server from that image and set its ``OS-DCF:diskConfig`` value to ``AUTO``. A valid value is: - ``AUTO``. The API builds the server with a single partition the size of the target flavor disk. The API automatically adjusts the file system to fit the entire partition. - ``MANUAL``. The API builds the server by using whatever partition scheme and file system is in the source image. If the target flavor disk is larger, the API does not partition the remaining disk space. in: body required: false type: string OS-EXT-AZ:availability_zone: description: | The availability zone name. in: body required: true type: string OS-EXT-AZ:availability_zone_optional: description: | The availability zone name. in: body required: false type: string OS-EXT-SRV-ATTR:host: description: | The name of the compute host on which this instance is running. Appears in the response for administrative users only. in: body required: true type: string OS-EXT-SRV-ATTR:hypervisor_hostname: description: | The hypervisor host name provided by the Nova virt driver. For the Ironic driver, it is the Ironic node name. Appears in the response for administrative users only. in: body required: true type: string OS-EXT-SRV-ATTR:instance_name: description: | The instance name. The Compute API generates the instance name from the instance name template. Appears in the response for administrative users only. in: body required: true type: string OS-EXT-STS:power_state: description: | The power state of the instance. This is an enum value that is mapped as:: 0: NOSTATE 1: RUNNING 3: PAUSED 4: SHUTDOWN 6: CRASHED 7: SUSPENDED in: body required: true type: integer OS-EXT-STS:task_state: description: | The task state of the instance. in: body required: true type: string OS-EXT-STS:vm_state: description: | The VM state. in: body required: true type: string os-extended-volumes:volumes_attached: description: | The attached volumes, if any. in: body required: true type: array os-extended-volumes:volumes_attached.delete_on_termination: description: | A flag indicating if the attached volume will be deleted when the server is deleted. By default this is False and can only be set when creating a volume while creating a server, which is commonly referred to as boot from volume. in: body required: true type: boolean min_version: 2.3 os-extended-volumes:volumes_attached.id: description: | The attached volume ID. in: body required: true type: string os-getConsoleOutput: description: | The action to get console output of the server. in: body required: true type: object os-getRDPConsole: description: | The action. in: body required: true type: object os-getRDPConsole-type: description: | The type of RDP console. The only valid value is ``rdp-html5``. in: body required: true type: string os-getRDPConsole-url: description: | The URL used to connect to the RDP console. in: body required: true type: string os-getSerialConsole: description: | The action. in: body required: true type: object os-getSerialConsole-type: description: | The type of serial console. The only valid value is ``serial``. in: body required: true type: string os-getSerialConsole-url: description: | The URL used to connect to the Serial console. in: body required: true type: string os-getSPICEConsole: description: | The action. in: body required: true type: object os-getSPICEConsole-type: description: | The type of SPICE console. The only valid value is ``spice-html5``. in: body required: true type: string os-getSPICEConsole-url: description: | The URL used to connect to the SPICE console. in: body required: true type: string os-getVNCConsole: description: | The action. in: body required: true type: object os-getVNCConsole-type: description: | The type of VNC console. The valid values are ``novnc`` and ``xvpvnc``. in: body required: true type: string os-getVNCConsole-url: description: | The URL used to connect to the VNC console. in: body required: true type: string os-migrateLive: description: | The action. in: body required: true type: object os-resetState: description: | The action. in: body required: true type: object os-resetState_state: description: | The state of the server to be set, ``active`` or ``error`` are valid. in: body required: true type: string OS-SRV-USG:launched_at: description: | The date and time when the server was launched. The date and time stamp format is `ISO 8601 `_: :: CCYY-MM-DDThh:mm:ss±hh:mm For example, ``2015-08-27T09:49:58-05:00``. The ``hh±:mm`` value, if included, is the time zone as an offset from UTC. If the ``deleted_at`` date and time stamp is not set, its value is ``null``. in: body required: true type: string OS-SRV-USG:terminated_at: description: | The date and time when the server was deleted. The date and time stamp format is `ISO 8601 `_: :: CCYY-MM-DDThh:mm:ss±hh:mm For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC. If the ``deleted_at`` date and time stamp is not set, its value is ``null``. in: body required: true type: string os-start: description: | The action to start a stopped server. in: body required: true type: none os-stop: description: | The action to stop a running server. in: body required: true type: none os:scheduler_hints: description: | The dictionary of data to send to the scheduler. Alternatively, you can specify ``OS-SCH-HNT:scheduler_hints`` as the string. in: body required: false type: object overall_status: description: | The overall status of instance audit tasks. :: M of N hosts done. K errors. The ``M`` value is the number of hosts whose instance audit tasks have been done in the period. The ``N`` value is the number of all hosts. The ``K`` value is the number of hosts whose instance audit tasks cause errors. If instance audit tasks have been done at all hosts in the period, the overall status is as follows: :: ALL hosts done. K errors. in: body required: true type: string para: description: | The parameter object. in: body required: true type: object parent_group_id: description: | Security group ID. in: body required: true type: string password: description: | The password returned from metadata server. in: body required: false type: string path: description: | The path field in the personality object. in: body required: true type: string pause: description: | The action to pause a server. in: body required: true type: none period_beginning: description: | The beginning time of the instance usage audit period. For example, ``2016-05-01 00:00:00``. in: body required: true type: string period_ending: description: | The ending time of the instance usage audit period. For example, ``2016-06-01 00:00:00``. in: body required: true type: string personality: description: | The file path and contents, text only, to inject into the server at launch. The maximum size of the file path data is 255 bytes. The maximum limit is the number of allowed bytes in the decoded, rather than encoded, data. in: body required: false type: array policies: description: | A list of exactly one policy name to associate with the server group. The current valid policy names are: - ``anti-affinity`` - servers in this group must be scheduled to different hosts. - ``affinity`` - servers in this group must be scheduled to the same host. - ``soft-anti-affinity`` - servers in this group should be scheduled to different hosts if possible, but if not possible then they should still be scheduled instead of resulting in a build failure. This policy was added in microversion 2.15. - ``soft-affinity`` - servers in this group should be scheduled to the same host if possible, but if not possible then they should still be scheduled instead of resulting in a build failure. This policy was added in microversion 2.15. in: body required: true type: array pool: description: | Pool from which to allocate the IP address. If you omit this parameter, the call allocates the floating IP address from the public pool. If no floating IP addresses are available, the call returns the ``400`` response code with an informational message. Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. in: body required: false type: string port: description: | To provision the server instance with a NIC for an already existing port, specify the port-id in the ``port`` attribute in a ``networks`` object. The port status must be ``DOWN``. required if you omit the ``uuid`` attribute. in: body required: false type: string port_id: description: | The ID of the port for which you want to create an interface. The ``net_id`` and ``port_id`` parameters are mutually exclusive. If you do not specify the ``port_id`` parameter, the OpenStack Networking API v2.0 allocates a port and creates an interface for it on the network. in: body required: false type: string port_id_resp: description: | The port ID. in: body required: true type: string port_number: description: | The port number. in: body required: true type: integer port_state: description: | The port state. in: body required: true type: string preserve_ephemeral: description: | Indicates whether the server is rebuilt with the preservation of the ephemeral partition (``true``). .. note:: This only works with baremetal servers provided by Ironic. Passing it to any other server instance results in a fault and will prevent the rebuild from happening. in: body required: false type: boolean previous: description: | Moves to the previous metadata item. format: uri in: body required: false type: string private_key: description: | The secret key. in: body required: true type: string progress: description: | A percentage value of the build progress. in: body required: true type: integer project_id: description: | The UUID of the project. If omitted, the project ID defaults to the calling tenant. in: body required: false type: string project_id_instance_action: description: | The UUID of the project that this server belongs to. in: body required: true type: string project_id_query_server: description: | Filter the list of servers by the given project ID. .. note:: 'tenant_id' can also be requested which is alias of 'project_id' but that is not recommended to use as that will be removed in future. in: body required: false type: string project_id_server_group: description: | The project ID who owns the server group. min_version: 2.13 in: body required: false type: string project_id_value: description: | The project id under which the bulk ip addresses are created in: body required: true type: string quota_set: description: | A ``quota_set`` object. in: body required: true type: object quota_tenant_or_user_id_body: description: | The UUID of the tenant/user the quotas listed for. in: body required: true type: string ram: description: | The amount of allowed instance RAM, in MB, for each tenant. in: body required: true type: integer ram_quota_details: description: | The object of detailed key ram quota, including in_use, limit and reserved number of ram. in: body required: true type: object ram_quota_optional: description: | The amount of allowed instance RAM, in MB, for each tenant. in: body required: false type: integer reboot: description: | The action to reboot a server. in: body required: true type: object reboot_type: description: | The type of the reboot action. The valid values are ``HARD`` and ``SOFT``. A ``SOFT`` reboot attempts a graceful shutdown and restart of the server. A ``HARD`` reboot attempts a forced shutdown and restart of the server. The ``HARD`` reboot corresponds to the power cycles of the server. in: body required: true type: string rebuild: description: | The action to rebuild a server. in: body required: true type: object remote_console: description: | The remote console object. in: body required: true type: object remote_console_protocol: description: | The protocol of remote console. The valid values are ``vnc``, ``spice``, ``rdp``, ``serial`` and ``mks``. The protocol ``mks`` is added since Microversion ``2.8``. in: body required: true type: string remote_console_type: description: | The type of remote console. The valid values are ``novnc``, ``xvpvnc``, ``rdp-html5``, ``spice-html5``, ``serial``, and ``webmks``. The type ``webmks`` is added since Microversion ``2.8``. in: body required: true type: string remote_console_url: description: | The URL is used to connect the console. in: body required: true type: string removeFixedIp: description: | The action to remove a fixed ip address from a server. in: body required: true type: object removeFloatingIp: description: | The action to remove or disassociate a floating IP address from the server. in: body required: true type: object removeSecurityGroup: description: | The action to remove a security group from the server. in: body required: true type: object removeTenantAccess: description: | The action. in: body required: true type: string request_id_body: description: | The request id generated when execute the API of this action. in: body required: true type: string rescue: description: | The action to rescue a server. in: body required: true type: object rescue_image_ref: description: | The image reference to use to rescue your server instance. Specify the image reference by ID or full URL. If you omit an image reference, default is the base image reference. in: body required: false type: string reservation_id: description: | The reservation id for the server. This is an id that can be useful in tracking groups of servers created with multiple create, that will all have the same reservation_id. in: body required: true type: string reserved: description: | The reserved quota value. in: body required: true type: integer reserved_fixedip: description: | True if the fixed ip is reserved, otherwise False. in: body required: true type: boolean min_version: 2.4 resetNetwork: description: | The action. in: body required: true type: none resize: description: | The action to resize a server. in: body required: true type: object restore: description: | The action. in: body required: true type: none resume: description: | The action to resume a suspended server. in: body required: true type: none return_reservation_id: description: | Set to ``True`` to request that the response return a reservation ID instead of instance information. Default is ``False``. in: body required: false type: boolean revertResize: description: | The action to revert a resize operation. in: body required: true type: none rules: description: | A security group rules object. in: body required: true type: array running_vms: description: | The number of running vms on this hypervisor. in: body required: true type: integer running_vms_total: description: | The total number of running vms on all hypervisors. in: body required: true type: integer secgroup_default_rule_id: description: | The security group default rule ID. in: body required: true type: string secgroup_rule_cidr: description: | The CIDR for address range. in: body required: false type: string secgroup_rule_id: description: | The security group rule ID. in: body required: true type: string secgroup_rule_ip_range: description: | An IP range object. Includes the security group rule ``cidr``. in: body required: true type: object secgroup_tenant_id_body: description: | The UUID of the tenant that owns this security group. in: body required: true type: string security_group: description: | Specify the ``security_group`` action in the request body. in: body required: true type: string security_group_default_rule: description: | A ``security_group_default_rule`` object. in: body required: true type: object security_group_default_rules: description: | A list of the ``security_group_default_rule`` object. in: body required: true type: array security_group_rule: description: | A ``security_group_rule`` object. in: body required: true type: object security_group_rules: description: | The number of allowed rules for each security group. in: body required: false type: integer max_version: 2.35 security_group_rules_quota: description: | The number of allowed rules for each security group. in: body required: true type: integer max_version: 2.35 security_group_rules_quota_details: description: | The object of detailed security group rules quota, including in_use, limit and reserved number of security group rules. in: body required: true type: object max_version: 2.35 security_groups: description: | One or more security groups. Specify the name of the security group in the ``name`` attribute. If you omit this attribute, the API creates the server in the ``default`` security group. in: body required: false type: array security_groups_obj: description: | Security groups object. in: body required: true type: array security_groups_quota: description: | The number of allowed security groups for each tenant. in: body required: true type: integer max_version: 2.35 security_groups_quota_details: description: | The object of detailed security groups, including in_use, limit and reserved number of security groups. in: body required: true type: object max_version: 2.35 security_groups_quota_optional: description: | The number of allowed security groups for each tenant. in: body required: false type: integer max_version: 2.35 server: description: | A ``server`` object. in: body required: true type: object server_description: type: string in: body required: false min_version: 2.19 description: | A free form description of the server. Limited to 255 characters in length. Before microversion 2.19 this was set to the server name. server_description_resp: description: | The description of the server. Before microversion 2.19 this was set to the server name. in: body required: true type: string min_version: 2.19 server_group: description: | The server group obejct. in: body required: true type: object server_group_id_body: description: | The UUID of the server group. in: body required: true type: string server_group_members: description: | The number of allowed members for each server group. in: body required: true type: integer server_group_members_quota_details: description: | The object of detailed server group members, including in_use, limit and reserved number of server group members. in: body required: true type: object server_group_members_quota_optional: description: | The number of allowed members for each server group. in: body required: false type: integer server_groups: description: | The number of allowed server groups for each tenant. in: body required: true type: integer server_groups_list: description: | The list of existing server groups. in: body required: true type: array server_groups_quota_details: description: | The object of detailed server groups, including in_use, limit and reserved number of server groups. in: body required: true type: object server_groups_quota_optional: description: | The number of allowed server groups for each tenant. in: body required: false type: integer server_hostname: in: body required: true type: string description: | The hostname set on the instance when it is booted. min_version: 2.3 server_id: description: | The UUID of the server. in: body required: true type: string server_id_optional: description: | The UUID of the server. in: body required: false type: string server_kernel_id: in: body required: true type: string description: | The UUID of the kernel image when using an AMI. Will be null if not. min_version: 2.3 server_launch_index: in: body required: true type: integer description: | When servers are launched via multiple create, this is the sequence in which the servers were launched. min_version: 2.3 server_links: description: | Links pertaining to the server. See `API Guide / Links and References `_ for more info. in: body type: array required: true server_name: description: | The server name. in: body required: true type: string server_name_optional: description: | The server name. in: body required: false type: string server_ramdisk_id: in: body required: true type: string description: | The UUID of the ramdisk image when using an AMI. Will be null if not. min_version: 2.3 server_reservation_id: in: body required: true type: string description: | The reservation id for the server. This is an id that can be useful in tracking groups of servers created with multiple create, that will all have the same reservation_id. min_version: 2.3 server_root_device_name: in: body required: true type: string description: | The root device name for the instance min_version: 2.3 server_status: description: | The server status. in: body required: true type: string server_usages: description: | A list of the server usage objects. in: body required: true type: array server_usages_optional: description: | A list of the server usage objects. in: body required: false type: array server_user_data: in: body required: true type: string description: | The user_data the instance was created with. min_version: 2.3 server_uuid: description: | The UUID of the server instance to which the API dispatches the event. You must assign this instance to a host. Otherwise, this call does not dispatch the event to the instance. in: body required: true type: string servers: description: | A list of ``server`` objects. in: body required: true type: array servers_max_count: in: body required: false type: string description: | The max number of servers to be created. Defaults to the value of ``min_count``. servers_min_count: in: body required: false type: string description: | The min number of servers to be created. Defaults to 1. servers_multiple_create_name: in: body required: true type: string description: | A base name for creating unique names during multiple create. A unique string will be appended to the end of this base name for every server created. service: description: | Object representing a compute service. in: body required: true type: object service_disable_reason: description: | The disable reason of the service, ``null`` if the service is enabled or disabled without reason provided. in: body required: true type: string service_id_body: description: | The id of the service. in: body required: true type: integer service_state: description: | The state of the service. One of ``up`` or ``down``. in: body required: true type: string service_status: description: | The status of the service. One of ``enabled`` or ``disabled``. in: body required: true type: string services: description: | A list of service objects. in: body required: true type: array set_metadata: description: | The set_metadata object used to set metadata for host aggregate. in: body required: true type: object shelve: description: | The action. in: body required: true type: none shelveOffload: description: | The action. in: body required: true type: none size: description: | The size of the volume, in gibibytes (GiB). in: body required: true type: integer snapshot: description: | A partial representation of a snapshot that is used to create a snapshot. in: body required: true type: object snapshot_description: description: | The snapshot description. in: body required: true type: string snapshot_description_optional: description: | The snapshot description. in: body required: false type: string snapshot_id: description: | The UUID for a snapshot. in: body required: true type: string snapshot_id_optional: description: | The UUID for a snapshot. in: body required: false type: string snapshot_id_resp_2_45: description: | The UUID for the resulting image snapshot. in: body required: true type: string min_version: 2.45 snapshot_name: description: | The snapshot name. in: body required: true type: string snapshot_name_optional: description: | The snapshot name. in: body required: false type: string snapshot_status: description: | The status of the snapshot. Valid status values are: - ``available`` - ``creating`` - ``deleting`` - ``error`` - ``error_deleting`` in: body required: true type: string snapshots: description: | A list of snapshot objects. in: body required: true type: array source_type: description: | The source type of the volume. A valid value is ``blank``, ``snapshot``, ``volume``, or ``image``. in: body required: true type: string start_simple_tenant_usage_body: description: | The beginning time to calculate usage statistics on compute and storage resources. The date and time stamp format is as follows: :: CCYY-MM-DDThh:mm:ss.NNNNNN For example, ``2015-08-27T09:49:58.123456``. in: body required: true type: string start_time: description: | The date and time when the action was started. The date and time stamp format is `ISO 8601 `_ :: CCYY-MM-DDThh:mm:ss±hh:mm For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is ``-05:00``. in: body required: true type: string started_at: description: | The date and time when the server was launched. The date and time stamp format is as follows: :: CCYY-MM-DDThh:mm:ss.NNNNNN For example, ``2015-08-27T09:49:58.123456``. in: body required: true type: string started_at_optional: description: | The date and time when the server was launched. The date and time stamp format is as follows: :: CCYY-MM-DDThh:mm:ss.NNNNNN For example, ``2015-08-27T09:49:58.123456``. in: body required: false type: string stop_simple_tenant_usage: description: | The ending time to calculate usage statistics on compute and storage resources. The date and time stamp format is as follows: :: CCYY-MM-DDThh:mm:ss.NNNNNN For example, ``2015-08-27T09:49:58.123456``. in: body required: true type: string subnet_id: description: | The UUID of the subnet. in: body required: true type: string suspend: description: | The action to suspend a server. in: body required: true type: none tags: description: | A list of tags. The maximum count of tags in this list is 50. in: body required: true type: array min_version: 2.26 tenant_id_body: description: | The UUID of the tenant in a multi-tenancy cloud. in: body required: true type: string tenant_id_optional: description: | The UUID of the tenant in a multi-tenancy cloud. in: body required: false type: string tenant_usage: description: | The tenant usage object. in: body required: true type: object tenant_usages: description: | A list of the tenant usage objects. in: body required: true type: array to_port: description: | The port at end of range. in: body required: true type: integer total_errors: description: | The total number of instance audit task errors. in: body required: true type: integer total_hours: description: | The total duration that servers exist (in hours). in: body required: true type: float total_instances: description: | The total number of VM instances in the period. in: body required: true type: integer total_local_gb_usage: description: | Multiplying the server disk size (in GiB) by hours the server exists, and then adding that all together for each server. in: body required: true type: float total_memory_mb_usage: description: | Multiplying the server memory size (in MB) by hours the server exists, and then adding that all together for each server. in: body required: true type: float total_vcpus_usage: description: | Multiplying the number of virtual CPUs of the server by hours the server exists, and then adding that all together for each server. in: body required: true type: float trigger_crash_dump: in: body required: true type: none description: | Specifies the trigger crash dump action should be run type-os-assisted-volume-snapshot: description: | The snapshot type. A valid value is ``qcow2``. in: body required: true type: string unlock: description: | The action to unlock a locked server. in: body required: true type: none unpause: description: | The action to unpause a paused server. in: body required: true type: none unrescue: description: | The action to unrescue a server in rescue mode. in: body required: true type: none unshelve: description: | The action. in: body required: true type: none updated: description: | The date and time when the resource was updated. The date and time stamp format is `ISO 8601 `_ :: CCYY-MM-DDThh:mm:ss±hh:mm For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is ``-05:00``. in: body required: true type: string updated_consider_null: description: | The date and time when the resource was updated, if the resource has not been updated, this field will show as ``null``. The date and time stamp format is `ISO 8601 `_ :: CCYY-MM-DDThh:mm:ss±hh:mm For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC. In the previous example, the offset value is ``-05:00``. in: body required: true type: string uptime: description: | The total uptime of the hypervisor and information about average load. in: body required: true type: string uptime_simple_tenant_usage: description: | The uptime of the server. in: body required: true type: integer uptime_simple_tenant_usage_optional: description: | The uptime of the server. in: body required: false type: integer url: description: | The URL associated with the agent. in: body required: true type: string usage_links: description: | Links pertaining to usage. See `API Guide / Links and References `_ for more info. in: body type: array required: false min_version: 2.40 user_data: description: | Configuration information or scripts to use upon launch. Must be Base64 encoded. .. note:: The ``null`` value allowed in Nova legacy v2 API, but due to the strict input validation, it isn't allowed in Nova v2.1 API. in: body required: false type: string user_id: description: | The user ID of the user who owns the server. in: body required: true type: string user_id_server_group: description: | The user ID who owns the server group. min_version: 2.13 in: body required: false type: string vcpus: description: | The number of virtual CPUs that the server uses. in: body required: true type: integer vcpus_optional: description: | The number of virtual CPUs that the server uses. in: body required: false type: integer version: description: | The version. in: body required: true type: string version_id: type: string in: body required: true description: > A common name for the version in question. Informative only, it has no real semantic meaning. version_ip: description: | The IP version of the address associated with server. in: body required: true type: integer version_max: type: string in: body required: true description: > If this version of the API supports microversions, the maximum microversion that is supported. This will be the empty string if microversions are not supported. version_min: type: string in: body required: true description: > If this version of the API supports microversions, the minimum microversion that is supported. This will be the empty string if microversions are not supported. version_status: type: string in: body required: true description: | The status of this API version. This can be one of: - ``CURRENT``: this is the preferred version of the API to use - ``SUPPORTED``: this is an older, but still supported version of the API - ``DEPRECATED``: a deprecated version of the API that is slated for removal versions: type: array in: body required: true description: > A list of version objects that describe the API versions available. virtual_interface: description: | Virtual interface for the floating ip address. in: body required: true type: string virtual_interface_id: description: | The UUID of the virtual interface. in: body required: true type: string virtual_interface_id_optional: description: | Virtual interface for the floating ip address in: body required: false type: string virtual_interfaces: description: | An array of virtual interfaces. in: body required: true type: array vm_state_optional: description: | The VM state. in: body required: false type: string volume: description: | The ``volume`` object. in: body required: true type: object volume_id: description: | The source volume ID. in: body required: true type: string volume_id_resp: description: | The UUID of the volume. in: body required: true type: string volume_status: description: | The status of the volume. in: body required: true type: string volume_type: description: | The name or unique identifier for a volume type. in: body required: true type: string volume_type_optional: description: | The unique identifier for a volume type. in: body required: false type: string # This is the volumeAttachment in a response body. volumeAttachment: description: | A dictionary representation of a volume attachment containing the fields ``device``, ``id``, ``serverId`` and ``volumeId``. in: body required: true type: object # This is the volumeAttachment in a POST (attach volume) request body. volumeAttachment_post: description: | A dictionary representation of a volume attachment containing the fields ``device`` and ``volumeId``. in: body required: true type: object # This is the volumeAttachment in a PUT (swap volume) request body. volumeAttachment_put: description: | A dictionary representation of a volume attachment containing the field ``volumeId``. in: body required: true type: object volumeAttachments: description: | The list of volume attachments. in: body required: true type: array volumeId: description: | The UUID of the volume to attach. in: body required: true type: string volumeId_resp: description: | The UUID of the attached volume. in: body required: true type: string volumeId_swap: description: | The UUID of the volume to attach instead of the attached volume. in: body required: true type: string volumes: description: | The list of ``volume`` objects. in: body required: true type: array vpn_public_ip: description: | The VPN IP address. in: body required: true type: string vpn_public_ip_resp: description: | The VPN public IP address. in: body required: false type: string vpn_public_port: description: | The VPN port. in: body required: true type: string vpn_public_port_resp: description: | The VPN public port. in: body required: false type: string vpn_state: description: | The VPN state. in: body required: false type: string