openapi: 3.1.0
info:
description: |-
This is a reference for the OpenStack Compute API which is provided by the Nova
project. To learn more about the OpenStack Compute API concepts, please refer to
the [API guide](https://docs.openstack.org/api-guide/compute/index.html).
title: OpenStack Compute API
version: '2.100'
paths:
/v2.1/:
get:
description: |-
This fetches all the information about all known major API versions in
the deployment. Links to more specific information will be provided
for each API version, as well as information about supported min and
max microversions.
Normal Response Codes: 200
operationId: :get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RootShowResponse'
description: Ok
'404':
description: Error
summary: List All Major Versions
tags:
- version
/v2.1/extensions:
get:
description: |-
Lists all extensions to the API.
Normal response codes: 200
Error response codes: unauthorized(401)
operationId: extensions:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionsListResponse'
description: Ok
summary: List Extensions
tags:
- extensions
/v2.1/extensions/{id}:
get:
description: |-
Shows details for an extension, by alias.
Normal response codes: 200
Error response codes: unauthorized(401), itemNotFound(404)
operationId: extensions/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionShowResponse'
description: Ok
'404':
description: Error
summary: Show Extension Details
tags:
- extensions
parameters:
- $ref: '#/components/parameters/extensions_id'
/v2.1/flavors:
get:
description: |-
Lists all flavors accessible to your project.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: flavors:get
parameters:
- $ref: '#/components/parameters/flavors_is_public'
- $ref: '#/components/parameters/flavors_limit'
- $ref: '#/components/parameters/flavors_marker'
- $ref: '#/components/parameters/flavors_minDisk'
- $ref: '#/components/parameters/flavors_minRam'
- $ref: '#/components/parameters/flavors_sort_dir'
- $ref: '#/components/parameters/flavors_sort_key'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsListResponse'
description: Ok
'400':
description: Error
summary: List Flavors
tags:
- flavors
post:
description: |-
Creates a flavor.
Creating a flavor is typically only available to administrators of a
cloud because this has implications for scheduling efficiently in the cloud.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
conflict(409)
operationId: flavors:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsCreateResponse'
description: Ok
'400':
description: Error
'409':
description: Error
summary: Create Flavor
tags:
- flavors
/v2.1/flavors/detail:
get:
description: |-
Lists flavors with details.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: flavors/detail:get
parameters:
- $ref: '#/components/parameters/flavors_detail_is_public'
- $ref: '#/components/parameters/flavors_detail_limit'
- $ref: '#/components/parameters/flavors_detail_marker'
- $ref: '#/components/parameters/flavors_detail_minDisk'
- $ref: '#/components/parameters/flavors_detail_minRam'
- $ref: '#/components/parameters/flavors_detail_sort_dir'
- $ref: '#/components/parameters/flavors_detail_sort_key'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsDetailResponse'
description: Ok
'400':
description: Error
summary: List Flavors With Details
tags:
- flavors
/v2.1/flavors/{flavor_id}/os-extra_specs:
get:
description: |-
Lists all extra specs for a flavor, by ID.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: flavors/flavor_id/os-extra_specs:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsOs_Extra_SpecsListResponse'
description: Ok
'404':
description: Error
summary: List Extra Specs For A Flavor
tags:
- flavors
parameters:
- $ref: '#/components/parameters/flavors_os_extra_specs_flavor_id'
post:
description: |-
Creates extra specs for a flavor, by ID.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409)
operationId: flavors/flavor_id/os-extra_specs:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsOs_Extra_SpecsCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsOs_Extra_SpecsCreateResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
summary: Create Extra Specs For A Flavor
tags:
- flavors
/v2.1/flavors/{flavor_id}/os-extra_specs/{id}:
delete:
description: |-
Deletes an extra spec, by key, for a flavor, by ID.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: flavors/flavor_id/os-extra_specs/id:delete
responses:
'204':
description: Ok
'404':
description: Error
summary: Delete An Extra Spec For A Flavor
tags:
- flavors
get:
description: |-
Shows an extra spec, by key, for a flavor, by ID.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: flavors/flavor_id/os-extra_specs/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsOs_Extra_SpecShowResponse'
description: Ok
'404':
description: Error
summary: Show An Extra Spec For A Flavor
tags:
- flavors
parameters:
- $ref: '#/components/parameters/flavors_os_extra_specs_flavor_id'
- $ref: '#/components/parameters/flavors_os_extra_specs_id'
put:
description: |-
Updates an extra spec, by key, for a flavor, by ID.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
itemNotFound(404), conflict(409)
operationId: flavors/flavor_id/os-extra_specs/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsOs_Extra_SpecUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsOs_Extra_SpecUpdateResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
summary: Update An Extra Spec For A Flavor
tags:
- flavors
/v2.1/flavors/{flavor_id}/os-flavor-access:
get:
description: |-
Lists flavor access information.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: flavors/flavor_id/os-flavor-access:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorsOs_Flavor_AccessListResponse'
description: Ok
'404':
description: Error
summary: List Flavor Access Information For Given Flavor
tags:
- flavors
parameters:
- $ref: '#/components/parameters/flavors_os_flavor_access_flavor_id'
/v2.1/flavors/{id}:
delete:
description: |-
Deletes a flavor.
This is typically an admin only action. Deleting a flavor that is in use by
existing servers is not recommended as it can cause incorrect data to
be returned to the user under some operations.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: flavors/id:delete
responses:
'204':
description: Ok
'404':
description: Error
summary: Delete Flavor
tags:
- flavors
get:
description: |-
Shows details for a flavor.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: flavors/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorShowResponse'
description: Ok
'404':
description: Error
summary: Show Flavor Details
tags:
- flavors
parameters:
- $ref: '#/components/parameters/flavors_id'
put:
description: |-
Updates a flavor description.
This API is available starting with microversion 2.55.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the `policy.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: flavors/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorUpdate_255'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FlavorUpdateResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: Update Flavor Description
tags:
- flavors
x-openstack:
min-ver: '2.55'
/v2.1/flavors/{id}/action:
parameters:
- $ref: '#/components/parameters/flavors_action_id'
post:
operationId: flavors/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/FlavorsAction_Add_Tenant_Access'
- $ref: '#/components/schemas/FlavorsAction_Remove_Tenant_Access'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/FlavorsActionAddtenantaccessResponse'
- $ref: '#/components/schemas/FlavorsActionRemovetenantaccessResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
tags:
- flavors
/v2.1/images:
get:
deprecated: true
description: |-
List images.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: images:get
parameters:
- $ref: '#/components/parameters/images_changes-since'
- $ref: '#/components/parameters/images_limit'
- $ref: '#/components/parameters/images_marker'
- $ref: '#/components/parameters/images_minDisk'
- $ref: '#/components/parameters/images_minRam'
- $ref: '#/components/parameters/images_name'
- $ref: '#/components/parameters/images_offset'
- $ref: '#/components/parameters/images_page_size'
- $ref: '#/components/parameters/images_server'
- $ref: '#/components/parameters/images_status'
- $ref: '#/components/parameters/images_type'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesListResponse'
description: Ok
'400':
description: Error
summary: List Images
tags:
- images
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/images/detail:
get:
deprecated: true
description: |-
List images with details.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: images/detail:get
parameters:
- $ref: '#/components/parameters/images_detail_changes-since'
- $ref: '#/components/parameters/images_detail_limit'
- $ref: '#/components/parameters/images_detail_marker'
- $ref: '#/components/parameters/images_detail_minDisk'
- $ref: '#/components/parameters/images_detail_minRam'
- $ref: '#/components/parameters/images_detail_name'
- $ref: '#/components/parameters/images_detail_offset'
- $ref: '#/components/parameters/images_detail_page_size'
- $ref: '#/components/parameters/images_detail_server'
- $ref: '#/components/parameters/images_detail_status'
- $ref: '#/components/parameters/images_detail_type'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesDetailResponse'
description: Ok
'400':
description: Error
summary: List Images With Details
tags:
- images
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/images/{id}:
delete:
deprecated: true
description: |-
Deletes an image.
Normal response codes: 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: images/id:delete
responses:
'204':
description: Ok
'403':
description: Error
'404':
description: Error
summary: Delete Image
tags:
- images
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
get:
deprecated: true
description: |-
Shows details for an image.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: images/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImageShowResponse'
description: Ok
'404':
description: Error
summary: Show Image Details
tags:
- images
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/images_id'
/v2.1/images/{image_id}/metadata:
get:
deprecated: true
description: |-
List metadata of an image.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: images/image_id/metadata:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesMetadataListResponse'
description: Ok
'403':
description: Error
'404':
description: Error
summary: List Image Metadata
tags:
- images
x-openstack:
max-ver: '2.38'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/images_metadata_image_id'
post:
deprecated: true
description: |-
Create an image metadata.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: images/image_id/metadata:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesMetadataCreate_21'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesMetadataCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
summary: Create Image Metadata
tags:
- images
x-openstack:
max-ver: '2.38'
min-ver: '2.1'
put:
deprecated: true
description: |-
Update an image metadata
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: images/image_id/metadata:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesMetadataUpdate_All_21'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesMetadataUpdate_AllResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
summary: Update Image Metadata
tags:
- images
x-openstack:
max-ver: '2.38'
min-ver: '2.1'
/v2.1/images/{image_id}/metadata/{id}:
delete:
deprecated: true
description: |-
Deletes a metadata item, by key, for an image.
Normal response codes: 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: images/image_id/metadata/id:delete
responses:
'204':
description: Ok
'403':
description: Error
'404':
description: Error
summary: Delete Image Metadata Item
tags:
- images
x-openstack:
max-ver: '2.38'
min-ver: '2.1'
get:
deprecated: true
description: |-
Shows metadata item, by key, for an image.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: images/image_id/metadata/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesMetadataShowResponse'
description: Ok
'403':
description: Error
'404':
description: Error
summary: Show Image Metadata Item
tags:
- images
x-openstack:
max-ver: '2.38'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/images_metadata_id'
- $ref: '#/components/parameters/images_metadata_image_id'
put:
deprecated: true
description: |-
Creates or updates a metadata item, by key, for an image.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: images/image_id/metadata/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesMetadataUpdate_21'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ImagesMetadataUpdateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
summary: Create Or Update Image Metadata Item
tags:
- images
x-openstack:
max-ver: '2.38'
min-ver: '2.1'
/v2.1/limits:
get:
description: |-
Shows rate and absolute limits for the project.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: limits:get
parameters:
- $ref: '#/components/parameters/limits_tenant_id'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/LimitsListResponse'
description: Ok
summary: Show Rate And Absolute Limits
tags:
- limits
/v2.1/os-agents:
get:
deprecated: true
description: |-
Lists agent builds.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), gone(410)
operationId: os-agents:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AgentsListResponse'
description: Ok
'410':
description: Error
summary: List Agent Builds
tags:
- os-agents
post:
deprecated: true
description: |-
Creates an agent build.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
conflict(409), gone(410)
operationId: os-agents:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AgentsCreateResponse'
description: Ok
'410':
description: Error
summary: Create Agent Build
tags:
- os-agents
/v2.1/os-agents/{id}:
delete:
deprecated: true
description: |-
Deletes an existing agent build.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410)
operationId: os-agents/id:delete
responses:
'204':
description: Ok
'410':
description: Error
summary: Delete Agent Build
tags:
- os-agents
parameters:
- $ref: '#/components/parameters/os_agents_id'
put:
deprecated: true
description: |-
Updates an agent build.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410)
operationId: os-agents/id:put
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AgentUpdateResponse'
description: Ok
'410':
description: Error
summary: Update Agent Build
tags:
- os-agents
/v2.1/os-aggregates:
get:
description: |-
Lists all aggregates. Includes the ID, name, and availability zone for each aggregate.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-aggregates:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AggregatesListResponse'
description: Ok
summary: List Aggregates
tags:
- os-aggregates
post:
description: |-
Creates an aggregate. If specifying an option availability_zone, the aggregate is
created as an availability zone and the availability zone is visible to normal users.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409)
operationId: os-aggregates:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AggregatesCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AggregatesCreateResponse'
description: Ok
'400':
description: Error
'409':
description: Error
summary: Create Aggregate
tags:
- os-aggregates
/v2.1/os-aggregates/{id}:
delete:
description: |-
Deletes an aggregate.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-aggregates/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'404':
description: Error
summary: Delete Aggregate
tags:
- os-aggregates
get:
description: |-
Shows details for an aggregate. Details include hosts and metadata.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-aggregates/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AggregateShowResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: Show Aggregate Details
tags:
- os-aggregates
parameters:
- $ref: '#/components/parameters/os_aggregates_id'
put:
description: |-
Updates either or both the name and availability zone for an aggregate.
If the aggregate to be updated has host that already in the given
availability zone, the request will fail with 400 error.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
operationId: os-aggregates/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AggregateUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AggregateUpdateResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
summary: Update Aggregate
tags:
- os-aggregates
/v2.1/os-aggregates/{id}/action:
parameters:
- $ref: '#/components/parameters/os_aggregates_action_id'
post:
operationId: os-aggregates/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_AggregatesAction_Add_Host'
- $ref: '#/components/schemas/Os_AggregatesAction_Remove_Host'
- $ref: '#/components/schemas/Os_AggregatesAction_Set_Metadata'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_AggregatesActionAdd_HostResponse'
- $ref: '#/components/schemas/Os_AggregatesActionRemove_HostResponse'
- $ref: '#/components/schemas/Os_AggregatesActionSet_MetadataResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
tags:
- os-aggregates
/v2.1/os-aggregates/{id}/images:
parameters:
- $ref: '#/components/parameters/os_aggregates_images_id'
post:
description: |-
Requests that a set of images be pre-cached on compute nodes within the referenced aggregate.
This API is available starting with microversion 2.81.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: os-aggregates/id/images:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AggregatesImagesImages_281'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_AggregatesImagesResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: Request Image Pre-caching for Aggregate
tags:
- os-aggregates
x-openstack:
min-ver: '2.81'
/v2.1/os-assisted-volume-snapshots:
post:
description: |-
Creates an assisted volume snapshot.
Normal response codes: 200
Error response codes: badRequest(400),unauthorized(401), forbidden(403)
operationId: os-assisted-volume-snapshots:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Assisted_Volume_SnapshotsCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Assisted_Volume_SnapshotsCreateResponse'
description: Ok
'400':
description: Error
summary: Create Assisted Volume Snapshots
tags:
- os-assisted-volume-snapshots
/v2.1/os-assisted-volume-snapshots/{id}:
delete:
description: |-
Deletes an assisted volume snapshot.
To make this request, add the `delete_info` query parameter to the URI, as follows:
DELETE /os-assisted-volume-snapshots/421752a6-acf6-4b2d-bc7a-119f9148cd8c?delete_info=’{“volume_id”: “521752a6-acf6-4b2d-bc7a-119f9148cd8c”}’
Normal response codes: 204
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: os-assisted-volume-snapshots/id:delete
parameters:
- $ref: '#/components/parameters/os_assisted_volume_snapshot_delete_info'
responses:
'204':
description: Ok
'400':
description: Error
'404':
description: Error
summary: Delete Assisted Volume Snapshot
tags:
- os-assisted-volume-snapshots
parameters:
- $ref: '#/components/parameters/os_assisted_volume_snapshots_id'
/v2.1/os-availability-zone:
get:
description: |-
Lists availability zone information.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-availability-zone:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Availability_ZoneListResponse'
description: Ok
summary: Get Availability Zone Information
tags:
- os-availability-zone
/v2.1/os-availability-zone/detail:
get:
description: |-
Gets detailed availability zone information.
Policy defaults enable only users with the administrative role to perform this operation.
Cloud providers can change these permissions through the `policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-availability-zone/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Availability_ZoneDetailResponse'
description: Ok
summary: Get Detailed Availability Zone Information
tags:
- os-availability-zone
/v2.1/os-baremetal-nodes:
get:
deprecated: true
description: |-
Lists the bare metal nodes known by the compute environment.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403),
notImplemented(501)
operationId: os-baremetal-nodes:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Baremetal_NodesListResponse'
description: Ok
'404':
description: Error
'501':
description: Error
summary: List Bare Metal Nodes
tags:
- os-baremetal-nodes
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
post:
deprecated: true
operationId: os-baremetal-nodes:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Baremetal_NodesCreateResponse'
description: Ok
'400':
description: Error
tags:
- os-baremetal-nodes
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-baremetal-nodes/{id}:
delete:
deprecated: true
operationId: os-baremetal-nodes/id:delete
responses:
'204':
description: Ok
'400':
description: Error
tags:
- os-baremetal-nodes
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
get:
deprecated: true
description: |-
Shows details for a bare metal node.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), notImplemented(501)
operationId: os-baremetal-nodes/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Baremetal_NodeShowResponse'
description: Ok
'404':
description: Error
'501':
description: Error
summary: Show Bare Metal Node Details
tags:
- os-baremetal-nodes
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_baremetal_nodes_id'
/v2.1/os-baremetal-nodes/{id}/action:
parameters:
- $ref: '#/components/parameters/os_baremetal_nodes_action_id'
post:
operationId: os-baremetal-nodes/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_Baremetal_NodesActionAdd_InterfaceRequest'
- $ref: '#/components/schemas/Os_Baremetal_NodesActionRemove_InterfaceRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_Baremetal_NodesActionAdd_InterfaceResponse'
- $ref: '#/components/schemas/Os_Baremetal_NodesActionRemove_InterfaceResponse'
description: Ok
'400':
description: Error
tags:
- os-baremetal-nodes
/v2.1/os-cells:
get:
deprecated: true
description: |-
Lists cells.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
operationId: os-cells:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CellsListResponse'
description: Ok
'410':
description: Error
summary: List Cells
tags:
- os-cells
post:
deprecated: true
description: |-
Create a new cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
operationId: os-cells:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CellsCreateResponse'
description: Ok
'410':
description: Error
summary: Create Cell
tags:
- os-cells
/v2.1/os-cells/capacities:
get:
deprecated: true
description: |-
Retrieve capacities.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
operationId: os-cells/capacities:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CellsCapacitiesResponse'
description: Ok
'410':
description: Error
summary: Capacities
tags:
- os-cells
/v2.1/os-cells/detail:
get:
deprecated: true
description: |-
Lists cells with details of capabilities.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
operationId: os-cells/detail:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CellsDetailResponse'
description: Ok
'410':
description: Error
summary: List Cells With Details
tags:
- os-cells
/v2.1/os-cells/info:
get:
deprecated: true
description: |-
Retrieve info about the current cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
operationId: os-cells/info:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CellsInfoResponse'
description: Ok
'410':
description: Error
summary: Info For This Cell
tags:
- os-cells
/v2.1/os-cells/sync_instances:
post:
deprecated: true
operationId: os-cells/sync_instances:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CellsSync_InstancesResponse'
description: Ok
'410':
description: Error
tags:
- os-cells
/v2.1/os-cells/{id}:
delete:
deprecated: true
description: |-
Remove a cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
operationId: os-cells/id:delete
responses:
'204':
description: Ok
'410':
description: Error
summary: Delete a Cell
tags:
- os-cells
get:
deprecated: true
description: |-
Shows data for a cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
operationId: os-cells/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CellShowResponse'
description: Ok
'410':
description: Error
summary: Show Cell Data
tags:
- os-cells
parameters:
- $ref: '#/components/parameters/os_cells_id'
put:
deprecated: true
description: |-
Update an existing cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
operationId: os-cells/id:put
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CellUpdateResponse'
description: Ok
'410':
description: Error
summary: Update a Cell
tags:
- os-cells
/v2.1/os-cells/{id}/capacities:
get:
deprecated: true
description: |-
Shows capacities for a cell.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
operationId: os-cells/id/capacities:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CellsCapacitiesResponse'
description: Ok
'410':
description: Error
summary: Show Cell Capacities
tags:
- os-cells
parameters:
- $ref: '#/components/parameters/os_cells_capacities_id'
/v2.1/os-certificates:
post:
deprecated: true
description: |-
Creates a root certificate.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-certificates:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CertificatesCreateResponse'
description: Ok
'410':
description: Error
summary: Create Root Certificate
tags:
- os-certificates
/v2.1/os-certificates/{id}:
get:
deprecated: true
description: |-
Return certificate information.
operationId: os-certificates/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CertificateShowResponse'
description: Ok
'410':
description: Error
tags:
- os-certificates
parameters:
- $ref: '#/components/parameters/os_certificates_id'
/v2.1/os-cloudpipe:
get:
deprecated: true
description: |-
Lists cloudpipes.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound (404)
operationId: os-cloudpipe:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CloudpipeListResponse'
description: Ok
'410':
description: Error
summary: List Cloudpipes
tags:
- os-cloudpipe
post:
deprecated: true
description: |-
Creates a cloudpipe.
Normal response codes: 200
Error response codes: badRequest(400),unauthorized(401), forbidden(403)
operationId: os-cloudpipe:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CloudpipeCreateResponse'
description: Ok
'410':
description: Error
summary: Create Cloudpipe
tags:
- os-cloudpipe
/v2.1/os-cloudpipe/{id}:
parameters:
- $ref: '#/components/parameters/os_cloudpipe_id'
put:
deprecated: true
description: |-
Configure cloudpipe parameters for the project.
operationId: os-cloudpipe/id:put
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_CloudpipeUpdateResponse'
description: Ok
'410':
description: Error
tags:
- os-cloudpipe
/v2.1/os-console-auth-tokens/{id}:
get:
deprecated: true
description: |-
Given the console authentication token for a server, shows the related
connection information.
Nova HyperV driver has been removed therefore requests for RDP console connection
information will always return an http 400 error. Starting from microversion 2.31
it’s available for all other console types.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: os-console-auth-tokens/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Console_Auth_TokenShowResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: Show Console Connection Information
tags:
- server-consoles
x-openstack:
max-ver: '2.30'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_console_auth_tokens_id'
/v2.1/os-fixed-ips/{id}:
get:
deprecated: true
description: |-
Shows details for a fixed IP address.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410)
operationId: os-fixed-ips/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Fixed_IpShowResponse'
description: Ok
'410':
description: Error
summary: Show Fixed Ip Details
tags:
- os-fixed-ips
parameters:
- $ref: '#/components/parameters/os_fixed_ips_id'
/v2.1/os-fixed-ips/{id}/action:
parameters:
- $ref: '#/components/parameters/os_fixed_ips_action_id'
post:
operationId: os-fixed-ips/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_Fixed_IpsActionReserveRequest'
- $ref: '#/components/schemas/Os_Fixed_IpsActionUnreserveRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_Fixed_IpsActionReserveResponse'
- $ref: '#/components/schemas/Os_Fixed_IpsActionUnreserveResponse'
description: Ok
'410':
description: Error
tags:
- os-fixed-ips
/v2.1/os-floating-ip-dns:
get:
deprecated: true
description: |-
Lists registered DNS domains published by the DNS drivers.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), gone(410),
notImplemented(501)
operationId: os-floating-ip-dns:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_Ip_DnsListResponse'
description: Ok
'410':
description: Error
summary: List DNS Domains
tags:
- os-floating-ip-dns
/v2.1/os-floating-ip-dns/{domain_id}/entries/{id}:
delete:
deprecated: true
description: |-
Deletes a DNS entry.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), notImplemented(501)
operationId: os-floating-ip-dns/domain_id/entries/id:delete
responses:
'204':
description: Ok
'410':
description: Error
summary: Delete DNS Entry
tags:
- os-floating-ip-dns
get:
deprecated: true
description: |-
Lists DNS entries for a domain and IP.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), notImplemented(501)
operationId: os-floating-ip-dns/domain_id/entries/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_Ip_DnsEntryShowResponse'
description: Ok
'410':
description: Error
summary: List DNS Entries
tags:
- os-floating-ip-dns
parameters:
- $ref: '#/components/parameters/os_floating_ip_dns_entries_domain_id'
- $ref: '#/components/parameters/os_floating_ip_dns_entries_id'
put:
deprecated: true
description: |-
Creates or updates a DNS entry.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), gone(410),
notImplemented(501)
operationId: os-floating-ip-dns/domain_id/entries/id:put
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_Ip_DnsEntryUpdateResponse'
description: Ok
'410':
description: Error
summary: Create Or Update DNS Entry
tags:
- os-floating-ip-dns
/v2.1/os-floating-ip-dns/{id}:
delete:
deprecated: true
description: |-
Deletes a DNS domain and all associated host entries.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), notImplemented(501)
operationId: os-floating-ip-dns/id:delete
responses:
'204':
description: Ok
'410':
description: Error
summary: Delete DNS Domain
tags:
- os-floating-ip-dns
parameters:
- $ref: '#/components/parameters/os_floating_ip_dns_id'
put:
deprecated: true
description: |-
Creates or updates a DNS domain.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
operationId: os-floating-ip-dns/id:put
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_Ip_DnUpdateResponse'
description: Ok
'410':
description: Error
summary: Create Or Update DNS Domain
tags:
- os-floating-ip-dns
/v2.1/os-floating-ip-pools:
get:
deprecated: true
description: |-
Lists floating IP pools.
Policy defaults enable only users with the administrative role or user
who is authorized to operate on tenant <tenant_id> to perform this
operation. Cloud providers can change these permissions through the
`policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-floating-ip-pools:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_Ip_PoolsListResponse'
description: Ok
summary: List Floating Ip Pools
tags:
- os-floating-ip-pools
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-floating-ips:
get:
deprecated: true
description: |-
Lists floating IP addresses associated with the tenant or account.
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.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-floating-ips:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_IpsListResponse'
description: Ok
summary: List Floating Ip Addresses
tags:
- os-floating-ips
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
post:
deprecated: true
description: |-
Creates, or allocates, a floating IP address for the current project.
By default, the floating IP address is allocated from the public pool.
If more than one floating IP address pool is available, use the
`pool` parameter to specify from which pool to allocate the IP address.
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.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: os-floating-ips:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_IpsCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
summary: Create (Allocate) Floating Ip Address
tags:
- os-floating-ips
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-floating-ips-bulk:
get:
deprecated: true
description: |-
Lists all floating IPs.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
operationId: os-floating-ips-bulk:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_Ips_BulkListResponse'
description: Ok
'410':
description: Error
summary: List Floating Ips
tags:
- os-floating-ips-bulk
post:
deprecated: true
description: |-
Bulk-creates floating IPs.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
conflict(409), gone(410)
operationId: os-floating-ips-bulk:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_Ips_BulkCreateResponse'
description: Ok
'410':
description: Error
summary: Create Floating Ips
tags:
- os-floating-ips-bulk
/v2.1/os-floating-ips-bulk/{id}:
get:
deprecated: true
description: |-
Lists all floating IPs for a host.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
operationId: os-floating-ips-bulk/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_Ips_BulkShowResponse'
description: Ok
'410':
description: Error
summary: List Floating Ips By Host
tags:
- os-floating-ips-bulk
parameters:
- $ref: '#/components/parameters/os_floating_ips_bulk_id'
put:
deprecated: true
operationId: os-floating-ips-bulk/id:put
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_Ips_BulkUpdateResponse'
description: Ok
'410':
description: Error
tags:
- os-floating-ips-bulk
/v2.1/os-floating-ips/{id}:
delete:
deprecated: true
description: |-
Deletes, or deallocates, a floating IP address from the current project and
returns it to the pool from which it was allocated.
If the IP address is still associated with a running instance,
it is automatically disassociated from that instance.
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.yaml` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: os-floating-ips/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
summary: Delete (Deallocate) Floating Ip Address
tags:
- os-floating-ips
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
get:
deprecated: true
description: |-
Shows details for a floating IP address, by ID, that is associated with the tenant or account.
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.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: os-floating-ips/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Floating_IpShowResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: Show Floating Ip Address Details
tags:
- os-floating-ips
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_floating_ips_id'
/v2.1/os-fping:
get:
deprecated: true
description: |-
Runs the fping utility to ping instances and reports which instances are alive.
Specify the `all_tenants=1` query parameter to ping instances for all tenants. For example:
Specify the `include` and `exclude` query parameters to filter the results. For example:
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.yaml` file.
Normal response codes: 200
Error response codes: serviceUnavailable(503), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410)
operationId: os-fping:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_FpingListResponse'
description: Ok
'410':
description: Error
summary: Ping Instances
tags:
- os-fping
/v2.1/os-fping/{id}:
get:
deprecated: true
description: |-
Runs the fping utility to ping an instance and reports whether the instance is alive.
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.yaml` file.
Normal response codes: 200
Error response codes: serviceUnavailable(503), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410)
operationId: os-fping/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_FpingShowResponse'
description: Ok
'410':
description: Error
summary: Ping An Instance
tags:
- os-fping
parameters:
- $ref: '#/components/parameters/os_fping_id'
/v2.1/os-hosts:
get:
deprecated: true
description: |-
Lists hosts.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-hosts:get
parameters:
- $ref: '#/components/parameters/os_hosts_zone'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HostsListResponse'
description: Ok
summary: List Hosts
tags:
- os-hosts
x-openstack:
max-ver: '2.42'
min-ver: '2.1'
/v2.1/os-hosts/{id}:
get:
deprecated: true
description: |-
Shows details for a host.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-hosts/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HostShowResponse'
description: Ok
'404':
description: Error
summary: Show Host Details
tags:
- os-hosts
x-openstack:
max-ver: '2.42'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_hosts_id'
put:
deprecated: true
description: |-
Enables, disables a host or put a host in maintenance or normal mode.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), NotImplemented(501)
operationId: os-hosts/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HostUpdate_21'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HostUpdateResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'501':
description: Error
summary: Update Host status
tags:
- os-hosts
x-openstack:
max-ver: '2.42'
min-ver: '2.1'
/v2.1/os-hosts/{id}/reboot:
get:
deprecated: true
description: |-
Reboots a host.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), NotImplemented(501)
operationId: os-hosts/id/reboot:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HostsRebootResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'501':
description: Error
summary: Reboot Host
tags:
- os-hosts
x-openstack:
max-ver: '2.42'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_hosts_reboot_id'
/v2.1/os-hosts/{id}/shutdown:
get:
deprecated: true
description: |-
Shuts down a host.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), NotImplemented(501)
operationId: os-hosts/id/shutdown:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HostsShutdownResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'501':
description: Error
summary: Shut Down Host
tags:
- os-hosts
x-openstack:
max-ver: '2.42'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_hosts_shutdown_id'
/v2.1/os-hosts/{id}/startup:
get:
deprecated: true
description: |-
Starts a host.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), NotImplemented(501)
operationId: os-hosts/id/startup:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HostsStartupResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'501':
description: Error
summary: Start Host
tags:
- os-hosts
x-openstack:
max-ver: '2.42'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_hosts_startup_id'
/v2.1/os-hypervisors:
get:
deprecated: true
description: |-
Lists hypervisors.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the `policy.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-hypervisors:get
parameters:
- $ref: '#/components/parameters/os_hypervisors_hypervisor_hostname_pattern'
- $ref: '#/components/parameters/os_hypervisors_limit'
- $ref: '#/components/parameters/os_hypervisors_marker'
- $ref: '#/components/parameters/os_hypervisors_with_servers'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HypervisorsListResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: List Hypervisors
tags:
- os-hypervisors
x-openstack:
max-ver: '2.32'
min-ver: '2.1'
/v2.1/os-hypervisors/detail:
get:
deprecated: true
description: |-
Lists hypervisors details.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the `policy.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-hypervisors/detail:get
parameters:
- $ref: '#/components/parameters/os_hypervisors_detail_hypervisor_hostname_pattern'
- $ref: '#/components/parameters/os_hypervisors_detail_limit'
- $ref: '#/components/parameters/os_hypervisors_detail_marker'
- $ref: '#/components/parameters/os_hypervisors_detail_with_servers'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HypervisorsDetailResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: List Hypervisors Details
tags:
- os-hypervisors
x-openstack:
max-ver: '2.32'
min-ver: '2.1'
/v2.1/os-hypervisors/statistics:
get:
deprecated: true
description: |-
Shows summary statistics for all enabled hypervisors over all compute nodes.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the `policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-hypervisors/statistics:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HypervisorsStatisticsResponse'
description: Ok
summary: Show Hypervisor Statistics (DEPRECATED)
tags:
- os-hypervisors
x-openstack:
max-ver: '2.87'
min-ver: '2.1'
/v2.1/os-hypervisors/{id}:
get:
deprecated: true
description: |-
Shows details for a given hypervisor.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the `policy.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-hypervisors/id:get
parameters:
- $ref: '#/components/parameters/os_hypervisor_with_servers'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HypervisorShowResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: Show Hypervisor Details
tags:
- os-hypervisors
x-openstack:
max-ver: '2.52'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_hypervisors_id'
/v2.1/os-hypervisors/{id}/search:
get:
deprecated: true
description: |-
Search hypervisor by a given hypervisor host name or portion of it.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the `policy.yaml` file.
Normal response code: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-hypervisors/id/search:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HypervisorsSearchResponse'
description: Ok
'404':
description: Error
summary: Search Hypervisor (DEPRECATED)
tags:
- os-hypervisors
x-openstack:
max-ver: '2.52'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_hypervisors_search_id'
/v2.1/os-hypervisors/{id}/servers:
get:
deprecated: true
description: |-
List all servers belong to each hypervisor whose host name is matching
a given hypervisor host name or portion of it.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the `policy.yaml` file.
Normal response code: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-hypervisors/id/servers:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HypervisorsServersResponse'
description: Ok
'404':
description: Error
summary: List Hypervisor Servers (DEPRECATED)
tags:
- os-hypervisors
x-openstack:
max-ver: '2.52'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_hypervisors_servers_id'
/v2.1/os-hypervisors/{id}/uptime:
get:
deprecated: true
description: |-
Shows the uptime for a given hypervisor.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
the `policy.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), NotImplemented(501)
operationId: os-hypervisors/id/uptime:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_HypervisorsUptimeResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'501':
description: Error
summary: Show Hypervisor Uptime (DEPRECATED)
tags:
- os-hypervisors
x-openstack:
max-ver: '2.87'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_hypervisors_uptime_id'
/v2.1/os-instance_usage_audit_log:
get:
description: |-
Lists usage audits for all servers on all compute hosts where usage auditing
is configured.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-instance_usage_audit_log:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Instance_Usage_Audit_LogListResponse'
description: Ok
summary: List Server Usage Audits
tags:
- os-instance_usage_audit_log
/v2.1/os-instance_usage_audit_log/{id}:
get:
description: |-
Lists usage audits that occurred before a specified time.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-instance_usage_audit_log/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Instance_Usage_Audit_LogShowResponse'
description: Ok
'400':
description: Error
summary: List Usage Audits Before Specified Time
tags:
- os-instance_usage_audit_log
parameters:
- $ref: '#/components/parameters/os_instance_usage_audit_log_id'
/v2.1/os-keypairs:
get:
deprecated: true
description: |-
Lists keypairs that are associated with the account.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-keypairs:get
parameters:
- $ref: '#/components/parameters/os_keypairs_limit'
- $ref: '#/components/parameters/os_keypairs_marker'
- $ref: '#/components/parameters/os_keypairs_user_id'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_KeypairsListResponse'
description: Ok
'400':
description: Error
summary: List Keypairs
tags:
- os-keypairs
x-openstack:
max-ver: '2.9'
min-ver: '2.0'
post:
description: |-
Imports (or generates) a keypair.
Normal response codes: 200, 201
Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409)
operationId: os-keypairs:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_KeypairsCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_KeypairsCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'409':
description: Error
summary: Import (or create) Keypair
tags:
- os-keypairs
/v2.1/os-keypairs/{id}:
delete:
deprecated: true
description: |-
Deletes a keypair.
Normal response codes: 202, 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-keypairs/id:delete
parameters:
- $ref: '#/components/parameters/os_keypair_user_id'
responses:
'204':
description: Ok
'404':
description: Error
summary: Delete Keypair
tags:
- os-keypairs
x-openstack:
max-ver: '2.9'
min-ver: '2.0'
get:
deprecated: true
description: |-
Shows details for a keypair that is associated with the account.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-keypairs/id:get
parameters:
- $ref: '#/components/parameters/os_keypair_user_id'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_KeypairShowResponse'
description: Ok
'404':
description: Error
summary: Show Keypair Details
tags:
- os-keypairs
x-openstack:
max-ver: '2.9'
min-ver: '2.0'
parameters:
- $ref: '#/components/parameters/os_keypairs_id'
/v2.1/os-migrations:
get:
deprecated: true
description: |-
Lists migrations.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
`policy.yaml` file.
Starting from microversion 2.59, the response is sorted by `created_at`
and `id` in descending order.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-migrations:get
parameters:
- $ref: '#/components/parameters/os_migrations_changes-before'
- $ref: '#/components/parameters/os_migrations_changes-since'
- $ref: '#/components/parameters/os_migrations_hidden'
- $ref: '#/components/parameters/os_migrations_host'
- $ref: '#/components/parameters/os_migrations_instance_uuid'
- $ref: '#/components/parameters/os_migrations_limit'
- $ref: '#/components/parameters/os_migrations_marker'
- $ref: '#/components/parameters/os_migrations_migration_type'
- $ref: '#/components/parameters/os_migrations_project_id'
- $ref: '#/components/parameters/os_migrations_source_compute'
- $ref: '#/components/parameters/os_migrations_status'
- $ref: '#/components/parameters/os_migrations_user_id'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_MigrationsListResponse'
description: Ok
'400':
description: Error
summary: List Migrations
tags:
- os-migrations
x-openstack:
max-ver: '2.58'
min-ver: '2.1'
/v2.1/os-networks:
get:
deprecated: true
description: |-
Lists networks for the project.
Policy defaults enable all users to perform this operation. Cloud
providers can change these permissions through the `policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-networks:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_NetworksListResponse'
description: Ok
summary: List Networks
tags:
- os-networks
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
post:
deprecated: true
description: |-
Creates a network.
Policy defaults enable only users with the administrative role or the
owner of the network to perform this operation. Cloud providers can change
these permissions through the `policy.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
conflict(409), gone(410), notImplemented(501)
operationId: os-networks:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_NetworksCreateResponse'
description: Ok
'410':
description: Error
summary: Create Network
tags:
- os-networks
/v2.1/os-networks/add:
post:
deprecated: true
description: |-
Adds a network to a project.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
`policy.yaml` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)
operationId: os-networks/add:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_NetworksAddResponse'
description: Ok
'410':
description: Error
summary: Add Network
tags:
- os-networks
/v2.1/os-networks/{id}:
delete:
deprecated: true
description: |-
Deletes a network.
Policy defaults enable only users with the administrative role or the
owner of the network to perform this operation. Cloud providers can change
these permissions through the `policy.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), gone(410)
operationId: os-networks/id:delete
responses:
'204':
description: Ok
'410':
description: Error
summary: Delete Network
tags:
- os-networks
get:
deprecated: true
description: |-
Shows details for a network.
Policy defaults enable all users to perform this operation. Cloud providers
can change these permissions through the `policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-networks/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_NetworkShowResponse'
description: Ok
'404':
description: Error
summary: Show Network Details
tags:
- os-networks
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_networks_id'
/v2.1/os-networks/{id}/action:
parameters:
- $ref: '#/components/parameters/os_networks_action_id'
post:
operationId: os-networks/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_NetworksActionAssociate_HostRequest'
- $ref: '#/components/schemas/Os_NetworksActionDisassociateRequest'
- $ref: '#/components/schemas/Os_NetworksActionDisassociate_HostRequest'
- $ref: '#/components/schemas/Os_NetworksActionDisassociate_ProjectRequest'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_NetworksActionAssociate_HostResponse'
- $ref: '#/components/schemas/Os_NetworksActionDisassociateResponse'
- $ref: '#/components/schemas/Os_NetworksActionDisassociate_HostResponse'
- $ref: '#/components/schemas/Os_NetworksActionDisassociate_ProjectResponse'
description: Ok
'410':
description: Error
tags:
- os-networks
/v2.1/os-quota-class-sets/{id}:
get:
description: |-
Show the quota for the Quota Class.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-quota-class-sets/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_Class_SetShowResponse'
description: Ok
summary: Show the quota for Quota Class
tags:
- quota-class-sets-os-quota-class-sets
parameters:
- $ref: '#/components/parameters/os_quota_class_sets_id'
put:
description: |-
Update the quotas for the Quota Class.
If the requested Quota Class is not found in the DB, then the API will create the one.
Only ‘default’ quota class is valid and used to set the default quotas, all other quota class
would not be used anywhere.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-quota-class-sets/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_Class_SetUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse'
description: Ok
'400':
description: Error
summary: Create or Update Quotas for Quota Class
tags:
- quota-class-sets-os-quota-class-sets
/v2.1/os-quota-sets/{id}:
delete:
description: |-
Reverts the quotas to default values for a project or a project and a user.
To revert quotas for a project and a user, specify the `user_id` query parameter.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403)
operationId: os-quota-sets/id:delete
parameters:
- $ref: '#/components/parameters/os_quota_set_user_id'
responses:
'204':
description: Ok
summary: Revert Quotas To Defaults
tags:
- quota-sets-os-quota-sets
get:
description: |-
Show the quota for a project or a project and a user.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-quota-sets/id:get
parameters:
- $ref: '#/components/parameters/os_quota_set_user_id'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_SetShowResponse'
description: Ok
'400':
description: Error
summary: Show A Quota
tags:
- quota-sets-os-quota-sets
parameters:
- $ref: '#/components/parameters/os_quota_sets_id'
put:
description: |-
Update the quotas for a project or a project and a user.
Users 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` attribute in the request body, the default value
is `false`.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-quota-sets/id:put
parameters:
- $ref: '#/components/parameters/os_quota_set_user_id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_SetUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_SetUpdateResponse'
description: Ok
'400':
description: Error
summary: Update Quotas
tags:
- quota-sets-os-quota-sets
/v2.1/os-quota-sets/{id}/defaults:
get:
description: |-
Lists the default quotas for a project.
Normal response codes: 200
Error response codes: badrequest(400), unauthorized(401), forbidden(403)
operationId: os-quota-sets/id/defaults:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_SetsDefaultsResponse'
description: Ok
'400':
description: Error
summary: List Default Quotas For Tenant
tags:
- quota-sets-os-quota-sets
x-openstack:
min-ver: '2.0'
parameters:
- $ref: '#/components/parameters/os_quota_sets_defaults_id'
/v2.1/os-quota-sets/{id}/detail:
get:
description: |-
Show the detail of quota for a project or a project and a user.
To show a quota for a project and a user, specify the `user_id` query parameter.
Normal response codes: 200
Error response codes: badrequest(400), unauthorized(401), forbidden(403)
operationId: os-quota-sets/id/detail:get
parameters:
- $ref: '#/components/parameters/os_quota_sets_detail_user_id'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Quota_SetsDetailResponse'
description: Ok
'400':
description: Error
summary: Show The Detail of Quota
tags:
- quota-sets-os-quota-sets
parameters:
- $ref: '#/components/parameters/os_quota_sets_detail_id'
/v2.1/os-security-group-default-rules:
get:
deprecated: true
description: |-
Lists default security group rules.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), notImplemented(501)
operationId: os-security-group-default-rules:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_Group_Default_RulesListResponse'
description: Ok
'410':
description: Error
summary: List Default Security Group Rules
tags:
- os-security-group-default-rules
post:
deprecated: true
description: |-
Creates a default security group rule.
If you specify a source port ( `from_port` ) or destination port ( `to_port` ) value, you must specify an
IP protocol ( `ip_protocol` ) value. Otherwise, the operation returns the `Bad Request (400)` response code.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
conflict(409), gone(410), notImplemented(501)
operationId: os-security-group-default-rules:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_Group_Default_RulesCreateResponse'
description: Ok
'410':
description: Error
summary: Create Default Security Group Rule
tags:
- os-security-group-default-rules
/v2.1/os-security-group-default-rules/{id}:
delete:
deprecated: true
description: |-
Deletes a security group rule.
Normal response codes: 204
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
operationId: os-security-group-default-rules/id:delete
responses:
'204':
description: Ok
'410':
description: Error
summary: Delete Default Security Group Rule
tags:
- os-security-group-default-rules
get:
deprecated: true
description: |-
Shows details for a security group rule.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410), notImplemented(501)
operationId: os-security-group-default-rules/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_Group_Default_RuleShowResponse'
description: Ok
'410':
description: Error
summary: Show Default Security Group Rule Details
tags:
- os-security-group-default-rules
parameters:
- $ref: '#/components/parameters/os_security_group_default_rules_id'
/v2.1/os-security-group-rules:
post:
deprecated: true
description: |-
Creates a rule for a security group. Either `cidr` or `group_id` must be
specified when creating a rule.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-security-group-rules:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_Group_RulesCreate_21'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_Group_RulesCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
summary: Create Security Group Rule
tags:
- os-security-group-rules
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-security-group-rules/{id}:
delete:
deprecated: true
description: |-
Deletes a security group rule.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
operationId: os-security-group-rules/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
summary: Delete Security Group Rule
tags:
- os-security-group-rules
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_security_group_rules_id'
/v2.1/os-security-groups:
get:
deprecated: true
description: |-
Lists security groups.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-security-groups:get
parameters:
- $ref: '#/components/parameters/os_security_groups_all_tenants'
- $ref: '#/components/parameters/os_security_groups_limit'
- $ref: '#/components/parameters/os_security_groups_offset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_GroupsListResponse'
description: Ok
'404':
description: Error
summary: List Security Groups
tags:
- os-security-groups
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
post:
deprecated: true
description: |-
Creates a security group.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-security-groups:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_GroupsCreate_21'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_GroupsCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
summary: Create Security Group
tags:
- os-security-groups
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-security-groups/{id}:
delete:
deprecated: true
description: |-
Deletes a security group.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-security-groups/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'404':
description: Error
summary: Delete Security Group
tags:
- os-security-groups
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
get:
deprecated: true
description: |-
Shows details for a security group.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-security-groups/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_GroupShowResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: Show Security Group Details
tags:
- os-security-groups
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_security_groups_id'
put:
deprecated: true
description: |-
Updates a security group.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-security-groups/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_GroupUpdate_21'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Security_GroupUpdateResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: Update Security Group
tags:
- os-security-groups
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-server-external-events:
post:
description: |-
Creates one or more external events, which the API dispatches to the
host a server is assigned to. If the server is not currently assigned
to a host the event will not be delivered.
You will receive back the list of events that you submitted, with an
updated `code` and `status` indicating their level of success.
Normal response codes: 200, 207
A 200 will be returned if all events succeeded, 207 will be returned
if any events could not be processed. The `code` attribute for the
event will explain further what went wrong.
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-server-external-events:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Server_External_EventsCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Server_External_EventsCreateResponse'
description: Ok
'403':
description: Error
summary: Run Events
tags:
- os-server-external-events
/v2.1/os-server-groups:
get:
description: |-
Lists all server groups for the tenant.
Administrative users can use the `all_projects` query parameter to list all server groups for all projects.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-server-groups:get
parameters:
- $ref: '#/components/parameters/os_server_groups_all_projects'
- $ref: '#/components/parameters/os_server_groups_limit'
- $ref: '#/components/parameters/os_server_groups_offset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Server_GroupsListResponse'
description: Ok
summary: List Server Groups
tags:
- os-server-groups
post:
description: |-
Creates a server group.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409)
operationId: os-server-groups:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Server_GroupsCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Server_GroupsCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'409':
description: Error
summary: Create Server Group
tags:
- os-server-groups
/v2.1/os-server-groups/{id}:
delete:
description: |-
Deletes a server group.
Normal response codes: 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-server-groups/id:delete
responses:
'204':
description: Ok
'404':
description: Error
summary: Delete Server Group
tags:
- os-server-groups
get:
description: |-
Shows details for a server group.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-server-groups/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Server_GroupShowResponse'
description: Ok
'404':
description: Error
summary: Show Server Group Details
tags:
- os-server-groups
parameters:
- $ref: '#/components/parameters/os_server_groups_id'
/v2.1/os-services:
get:
description: |-
Lists all running Compute services.
Provides details why any services were disabled.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-services:get
parameters:
- $ref: '#/components/parameters/os_services_binary'
- $ref: '#/components/parameters/os_services_host'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_ServicesListResponse'
description: Ok
summary: List Compute Services
tags:
- os-services
/v2.1/os-services/{id}:
delete:
description: |-
Deletes a service. If it’s a `nova-compute` service, then the
corresponding host will be removed from all the host aggregates as well.
Attempts to delete a `nova-compute` service which is still hosting instances
will result in a 409 HTTPConflict response. The instances will need to be
migrated or deleted before a compute service can be deleted.
Similarly, attempts to delete a `nova-compute` service which is involved in
in-progress migrations will result in a 409 HTTPConflict response. The
migrations will need to be completed, for example confirming or reverting a
resize, or the instances will need to be deleted before the compute service can
be deleted.
Normal response codes: 204
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
operationId: os-services/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
summary: Delete Compute Service
tags:
- os-services
parameters:
- $ref: '#/components/parameters/os_services_id'
put:
description: |-
Update a compute service to enable or disable scheduling, including recording a
reason why a compute service was disabled from scheduling. Set or unset the
`forced_down` flag for the service. This operation is only allowed on
services whose `binary` is `nova-compute`.
This API is available starting with microversion 2.53.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-services/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_ServiceUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_ServiceUpdateResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: Update Compute Service
tags:
- os-services
/v2.1/os-simple-tenant-usage:
get:
deprecated: true
description: |-
Lists usage statistics for all tenants.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-simple-tenant-usage:get
parameters:
- $ref: '#/components/parameters/os_simple_tenant_usage_detailed'
- $ref: '#/components/parameters/os_simple_tenant_usage_end'
- $ref: '#/components/parameters/os_simple_tenant_usage_limit'
- $ref: '#/components/parameters/os_simple_tenant_usage_marker'
- $ref: '#/components/parameters/os_simple_tenant_usage_start'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Simple_Tenant_UsageListResponse'
description: Ok
'400':
description: Error
summary: List Tenant Usage Statistics For All Tenants
tags:
- os-simple-tenant-usage
x-openstack:
max-ver: '2.39'
min-ver: '2.1'
/v2.1/os-simple-tenant-usage/{id}:
get:
deprecated: true
description: |-
Shows usage statistics for a tenant.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-simple-tenant-usage/id:get
parameters:
- $ref: '#/components/parameters/os_simple_tenant_usage_end'
- $ref: '#/components/parameters/os_simple_tenant_usage_limit'
- $ref: '#/components/parameters/os_simple_tenant_usage_marker'
- $ref: '#/components/parameters/os_simple_tenant_usage_start'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Simple_Tenant_UsageShowResponse'
description: Ok
'400':
description: Error
summary: Show Usage Statistics For Tenant
tags:
- os-simple-tenant-usage
x-openstack:
max-ver: '2.39'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_simple_tenant_usage_id'
/v2.1/os-snapshots:
get:
deprecated: true
description: |-
Lists snapshots.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-snapshots:get
parameters:
- $ref: '#/components/parameters/os_snapshots_limit'
- $ref: '#/components/parameters/os_snapshots_offset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_SnapshotsListResponse'
description: Ok
summary: List Snapshots
tags:
- os-snapshots
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
post:
deprecated: true
description: |-
Creates a new snapshot.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
operationId: os-snapshots:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_SnapshotsCreate_21'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_SnapshotsCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
summary: Create Snapshot
tags:
- os-snapshots
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-snapshots/detail:
get:
deprecated: true
description: |-
Lists all snapshots with details.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-snapshots/detail:get
parameters:
- $ref: '#/components/parameters/os_snapshots_detail_limit'
- $ref: '#/components/parameters/os_snapshots_detail_offset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_SnapshotsDetailResponse'
description: Ok
summary: List Snapshots With Details
tags:
- os-snapshots
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-snapshots/{id}:
delete:
deprecated: true
description: |-
Deletes a snapshot from the account.
This operation is asynchronous. You must list snapshots repeatedly to determine whether the snapshot was deleted.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-snapshots/id:delete
responses:
'204':
description: Ok
'404':
description: Error
summary: Delete Snapshot
tags:
- os-snapshots
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
get:
deprecated: true
description: |-
Shows details for a given snapshot.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-snapshots/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_SnapshotShowResponse'
description: Ok
'404':
description: Error
summary: Show Snapshot Details
tags:
- os-snapshots
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_snapshots_id'
/v2.1/os-tenant-networks:
get:
deprecated: true
description: |-
Lists all project networks.
Policy defaults enable only users with the administrative role or
the owner of the network to perform this operation. Cloud providers
can change these permissions through the `policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-tenant-networks:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Tenant_NetworksListResponse'
description: Ok
summary: List Project Networks
tags:
- os-tenant-networks
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
post:
deprecated: true
description: |-
Creates a project network.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the `policy.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
conflict(409), gone(410), serviceUnavailable(503)
**Example Create Project Network: JSON request**
operationId: os-tenant-networks:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Tenant_NetworksCreateResponse'
description: Ok
'410':
description: Error
summary: Create Project Network
tags:
- os-tenant-networks
/v2.1/os-tenant-networks/{id}:
delete:
deprecated: true
description: |-
Deletes a project network.
Policy defaults enable only users with the administrative role or
the owner of the network to perform this operation. Cloud providers
can change these permissions through the `policy.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), gone(410)
operationId: os-tenant-networks/id:delete
responses:
'204':
description: Ok
'410':
description: Error
summary: Delete Project Network
tags:
- os-tenant-networks
get:
deprecated: true
description: |-
Shows details for a project network.
Policy defaults enable only users with the administrative role or
the owner of the network to perform this operation. Cloud providers
can change these permissions through the `policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-tenant-networks/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Tenant_NetworkShowResponse'
description: Ok
'404':
description: Error
summary: Show Project Network Details
tags:
- os-tenant-networks
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_tenant_networks_id'
/v2.1/os-volumes:
get:
deprecated: true
description: |-
Lists the volumes associated with the account.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-volumes:get
parameters:
- $ref: '#/components/parameters/os_volumes_limit'
- $ref: '#/components/parameters/os_volumes_offset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_VolumesListResponse'
description: Ok
summary: List Volumes
tags:
- os-volumes
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
post:
deprecated: true
description: |-
Creates a new volume.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: os-volumes:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_VolumesCreate_21'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_VolumesCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
summary: Create Volume
tags:
- os-volumes
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-volumes/detail:
get:
deprecated: true
description: |-
Lists all volumes with details.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
operationId: os-volumes/detail:get
parameters:
- $ref: '#/components/parameters/os_volumes_detail_limit'
- $ref: '#/components/parameters/os_volumes_detail_offset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_VolumesDetailResponse'
description: Ok
summary: List Volumes With Details
tags:
- os-volumes
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
/v2.1/os-volumes/{id}:
delete:
deprecated: true
description: |-
Deletes a volume.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-volumes/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'404':
description: Error
summary: Delete Volume
tags:
- os-volumes
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
get:
deprecated: true
description: |-
Shows details for a given volume.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: os-volumes/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_VolumeShowResponse'
description: Ok
'404':
description: Error
summary: Show Volume Details
tags:
- os-volumes
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/os_volumes_id'
/v2.1/os-volumes_boot:
get:
description: |-
Returns a list of server names and ids for a given user.
operationId: os-volumes_boot:get
parameters:
- $ref: '#/components/parameters/os_volumes_boot_access_ip_v4'
- $ref: '#/components/parameters/os_volumes_boot_access_ip_v6'
- $ref: '#/components/parameters/os_volumes_boot_all_tenants'
- $ref: '#/components/parameters/os_volumes_boot_auto_disk_config'
- $ref: '#/components/parameters/os_volumes_boot_availability_zone'
- $ref: '#/components/parameters/os_volumes_boot_block_device_mapping'
- $ref: '#/components/parameters/os_volumes_boot_changes-before'
- $ref: '#/components/parameters/os_volumes_boot_changes-since'
- $ref: '#/components/parameters/os_volumes_boot_config_drive'
- $ref: '#/components/parameters/os_volumes_boot_created_at'
- $ref: '#/components/parameters/os_volumes_boot_deleted'
- $ref: '#/components/parameters/os_volumes_boot_description'
- $ref: '#/components/parameters/os_volumes_boot_display_description'
- $ref: '#/components/parameters/os_volumes_boot_display_name'
- $ref: '#/components/parameters/os_volumes_boot_flavor'
- $ref: '#/components/parameters/os_volumes_boot_host'
- $ref: '#/components/parameters/os_volumes_boot_hostname'
- $ref: '#/components/parameters/os_volumes_boot_image'
- $ref: '#/components/parameters/os_volumes_boot_image_ref'
- $ref: '#/components/parameters/os_volumes_boot_info_cache'
- $ref: '#/components/parameters/os_volumes_boot_ip'
- $ref: '#/components/parameters/os_volumes_boot_ip6'
- $ref: '#/components/parameters/os_volumes_boot_kernel_id'
- $ref: '#/components/parameters/os_volumes_boot_key_name'
- $ref: '#/components/parameters/os_volumes_boot_launch_index'
- $ref: '#/components/parameters/os_volumes_boot_launched_at'
- $ref: '#/components/parameters/os_volumes_boot_limit'
- $ref: '#/components/parameters/os_volumes_boot_locked'
- $ref: '#/components/parameters/os_volumes_boot_locked_by'
- $ref: '#/components/parameters/os_volumes_boot_marker'
- $ref: '#/components/parameters/os_volumes_boot_metadata'
- $ref: '#/components/parameters/os_volumes_boot_name'
- $ref: '#/components/parameters/os_volumes_boot_node'
- $ref: '#/components/parameters/os_volumes_boot_not-tags'
- $ref: '#/components/parameters/os_volumes_boot_not-tags-any'
- $ref: '#/components/parameters/os_volumes_boot_pci_devices'
- $ref: '#/components/parameters/os_volumes_boot_power_state'
- $ref: '#/components/parameters/os_volumes_boot_progress'
- $ref: '#/components/parameters/os_volumes_boot_project_id'
- $ref: '#/components/parameters/os_volumes_boot_ramdisk_id'
- $ref: '#/components/parameters/os_volumes_boot_reservation_id'
- $ref: '#/components/parameters/os_volumes_boot_root_device_name'
- $ref: '#/components/parameters/os_volumes_boot_security_groups'
- $ref: '#/components/parameters/os_volumes_boot_services'
- $ref: '#/components/parameters/os_volumes_boot_soft_deleted'
- $ref: '#/components/parameters/os_volumes_boot_sort_dir'
- $ref: '#/components/parameters/os_volumes_boot_sort_key'
- $ref: '#/components/parameters/os_volumes_boot_status'
- $ref: '#/components/parameters/os_volumes_boot_system_metadata'
- $ref: '#/components/parameters/os_volumes_boot_tags'
- $ref: '#/components/parameters/os_volumes_boot_tags-any'
- $ref: '#/components/parameters/os_volumes_boot_task_state'
- $ref: '#/components/parameters/os_volumes_boot_tenant_id'
- $ref: '#/components/parameters/os_volumes_boot_terminated_at'
- $ref: '#/components/parameters/os_volumes_boot_user_id'
- $ref: '#/components/parameters/os_volumes_boot_uuid'
- $ref: '#/components/parameters/os_volumes_boot_vm_state'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Volumes_BootListResponse'
description: Ok
'400':
description: Error
'403':
description: Error
tags:
- os-volumes_boot
post:
description: |-
Creates a new server for a given user.
operationId: os-volumes_boot:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Volumes_BootCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Volumes_BootCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'409':
description: Error
tags:
- os-volumes_boot
/v2.1/os-volumes_boot/detail:
get:
description: |-
Returns a list of server details for a given user.
operationId: os-volumes_boot/detail:get
parameters:
- $ref: '#/components/parameters/os_volumes_boot_detail_access_ip_v4'
- $ref: '#/components/parameters/os_volumes_boot_detail_access_ip_v6'
- $ref: '#/components/parameters/os_volumes_boot_detail_all_tenants'
- $ref: '#/components/parameters/os_volumes_boot_detail_auto_disk_config'
- $ref: '#/components/parameters/os_volumes_boot_detail_availability_zone'
- $ref: '#/components/parameters/os_volumes_boot_detail_block_device_mapping'
- $ref: '#/components/parameters/os_volumes_boot_detail_changes-before'
- $ref: '#/components/parameters/os_volumes_boot_detail_changes-since'
- $ref: '#/components/parameters/os_volumes_boot_detail_config_drive'
- $ref: '#/components/parameters/os_volumes_boot_detail_created_at'
- $ref: '#/components/parameters/os_volumes_boot_detail_deleted'
- $ref: '#/components/parameters/os_volumes_boot_detail_description'
- $ref: '#/components/parameters/os_volumes_boot_detail_display_description'
- $ref: '#/components/parameters/os_volumes_boot_detail_display_name'
- $ref: '#/components/parameters/os_volumes_boot_detail_flavor'
- $ref: '#/components/parameters/os_volumes_boot_detail_host'
- $ref: '#/components/parameters/os_volumes_boot_detail_hostname'
- $ref: '#/components/parameters/os_volumes_boot_detail_image'
- $ref: '#/components/parameters/os_volumes_boot_detail_image_ref'
- $ref: '#/components/parameters/os_volumes_boot_detail_info_cache'
- $ref: '#/components/parameters/os_volumes_boot_detail_ip'
- $ref: '#/components/parameters/os_volumes_boot_detail_ip6'
- $ref: '#/components/parameters/os_volumes_boot_detail_kernel_id'
- $ref: '#/components/parameters/os_volumes_boot_detail_key_name'
- $ref: '#/components/parameters/os_volumes_boot_detail_launch_index'
- $ref: '#/components/parameters/os_volumes_boot_detail_launched_at'
- $ref: '#/components/parameters/os_volumes_boot_detail_limit'
- $ref: '#/components/parameters/os_volumes_boot_detail_locked'
- $ref: '#/components/parameters/os_volumes_boot_detail_locked_by'
- $ref: '#/components/parameters/os_volumes_boot_detail_marker'
- $ref: '#/components/parameters/os_volumes_boot_detail_metadata'
- $ref: '#/components/parameters/os_volumes_boot_detail_name'
- $ref: '#/components/parameters/os_volumes_boot_detail_node'
- $ref: '#/components/parameters/os_volumes_boot_detail_not-tags'
- $ref: '#/components/parameters/os_volumes_boot_detail_not-tags-any'
- $ref: '#/components/parameters/os_volumes_boot_detail_pci_devices'
- $ref: '#/components/parameters/os_volumes_boot_detail_power_state'
- $ref: '#/components/parameters/os_volumes_boot_detail_progress'
- $ref: '#/components/parameters/os_volumes_boot_detail_project_id'
- $ref: '#/components/parameters/os_volumes_boot_detail_ramdisk_id'
- $ref: '#/components/parameters/os_volumes_boot_detail_reservation_id'
- $ref: '#/components/parameters/os_volumes_boot_detail_root_device_name'
- $ref: '#/components/parameters/os_volumes_boot_detail_security_groups'
- $ref: '#/components/parameters/os_volumes_boot_detail_services'
- $ref: '#/components/parameters/os_volumes_boot_detail_soft_deleted'
- $ref: '#/components/parameters/os_volumes_boot_detail_sort_dir'
- $ref: '#/components/parameters/os_volumes_boot_detail_sort_key'
- $ref: '#/components/parameters/os_volumes_boot_detail_status'
- $ref: '#/components/parameters/os_volumes_boot_detail_system_metadata'
- $ref: '#/components/parameters/os_volumes_boot_detail_tags'
- $ref: '#/components/parameters/os_volumes_boot_detail_tags-any'
- $ref: '#/components/parameters/os_volumes_boot_detail_task_state'
- $ref: '#/components/parameters/os_volumes_boot_detail_tenant_id'
- $ref: '#/components/parameters/os_volumes_boot_detail_terminated_at'
- $ref: '#/components/parameters/os_volumes_boot_detail_user_id'
- $ref: '#/components/parameters/os_volumes_boot_detail_uuid'
- $ref: '#/components/parameters/os_volumes_boot_detail_vm_state'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Volumes_BootDetailResponse'
description: Ok
'400':
description: Error
'403':
description: Error
tags:
- os-volumes_boot
/v2.1/os-volumes_boot/{id}:
delete:
description: |-
Destroys a server.
operationId: os-volumes_boot/id:delete
responses:
'204':
description: Ok
'404':
description: Error
'409':
description: Error
tags:
- os-volumes_boot
get:
description: |-
Returns server details by server id.
operationId: os-volumes_boot/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Volumes_BootShowResponse'
description: Ok
'404':
description: Error
tags:
- os-volumes_boot
parameters:
- $ref: '#/components/parameters/os_volumes_boot_id'
put:
description: |-
Update server then pass on to version-specific controller.
operationId: os-volumes_boot/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Volumes_BootUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Os_Volumes_BootUpdateResponse'
description: Ok
'404':
description: Error
tags:
- os-volumes_boot
/v2.1/os-volumes_boot/{id}/action:
parameters:
- $ref: '#/components/parameters/os_volumes_boot_action_id'
post:
operationId: os-volumes_boot/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootActionChange_Password'
- $ref: '#/components/schemas/Os_Volumes_BootActionCreatebackupRequest'
- $ref: '#/components/schemas/Os_Volumes_BootActionCreateimageRequest'
- $ref: '#/components/schemas/Os_Volumes_BootActionEvacuateRequest'
- $ref: '#/components/schemas/Os_Volumes_BootActionGet_Console_Output'
- $ref: '#/components/schemas/Os_Volumes_BootActionGet_Serial_Console_21'
- $ref: '#/components/schemas/Os_Volumes_BootActionGet_Spice_Console_21'
- $ref: '#/components/schemas/Os_Volumes_BootActionGet_Vnc_Console_21'
- $ref: '#/components/schemas/Os_Volumes_BootActionLockRequest'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-GetrdpconsoleRequest'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-MigrateliveRequest'
- $ref: '#/components/schemas/Os_Volumes_BootActionRebuildRequest'
- $ref: '#/components/schemas/Os_Volumes_BootActionResetnetworkRequest'
- $ref: '#/components/schemas/Os_Volumes_BootActionUnshelveRequest'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Confirm_Resize'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Reboot'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Resize'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Revert_Resize'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Trigger_Crash_Dump_217'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Add_Fixed_Ip_21'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Add_Floating_Ip_21'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Addsecuritygroup'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Force_Delete'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Inject_Network_Info'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Migrate_256'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Pause'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Remove_Fixed_Ip_21'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Remove_Floating_Ip_21'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Removesecuritygroup'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Rescue'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Reset_State'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Restore'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Resume'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Shelve'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Shelve_Offload'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Start_Server'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Stop_Server'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Suspend'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Unlock_21'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Unpause'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Unrescue'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootActionAddfixedipResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionAddfloatingipResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionAddsecuritygroupResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionChangepasswordResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionConfirmresizeResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionCreatebackupResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionCreateimageResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionEvacuateResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionForcedeleteResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionInjectnetworkinfoResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionLockResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionMigrateResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-GetconsoleoutputResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-GetrdpconsoleResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-GetserialconsoleResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-GetspiceconsoleResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-GetvncconsoleResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-MigrateliveResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-ResetstateResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-StartResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionOs-StopResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionPauseResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionRebootResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionRebuildResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionRemovefixedipResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionRemovefloatingipResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionRemovesecuritygroupResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionRescueResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionResetnetworkResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionResizeResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionRestoreResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionResumeResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionRevertresizeResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionShelveResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionShelveoffloadResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionSuspendResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionTrigger_Crash_DumpResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionUnlockResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionUnpauseResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionUnrescueResponse'
- $ref: '#/components/schemas/Os_Volumes_BootActionUnshelveResponse'
description: Ok
'400':
description: Error
'401':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
'410':
description: Error
'501':
description: Error
tags:
- os-volumes_boot
/v2.1/servers:
get:
description: |-
Lists IDs, names, and links for servers.
By default the servers are filtered using the project ID associated
with the authenticated request.
Servers contain a status attribute that indicates the current server
state. You can filter on the server status when you complete a list
servers request. The server status is returned in the response
body. The possible server status values are:
There is whitelist for valid filter keys. Any filter key other than from
whitelist will be silently ignored.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401),
forbidden(403)
operationId: servers:get
parameters:
- $ref: '#/components/parameters/servers_access_ip_v4'
- $ref: '#/components/parameters/servers_access_ip_v6'
- $ref: '#/components/parameters/servers_all_tenants'
- $ref: '#/components/parameters/servers_auto_disk_config'
- $ref: '#/components/parameters/servers_availability_zone'
- $ref: '#/components/parameters/servers_block_device_mapping'
- $ref: '#/components/parameters/servers_changes-before'
- $ref: '#/components/parameters/servers_changes-since'
- $ref: '#/components/parameters/servers_config_drive'
- $ref: '#/components/parameters/servers_created_at'
- $ref: '#/components/parameters/servers_deleted'
- $ref: '#/components/parameters/servers_description'
- $ref: '#/components/parameters/servers_display_description'
- $ref: '#/components/parameters/servers_display_name'
- $ref: '#/components/parameters/servers_flavor'
- $ref: '#/components/parameters/servers_host'
- $ref: '#/components/parameters/servers_hostname'
- $ref: '#/components/parameters/servers_image'
- $ref: '#/components/parameters/servers_image_ref'
- $ref: '#/components/parameters/servers_info_cache'
- $ref: '#/components/parameters/servers_ip'
- $ref: '#/components/parameters/servers_ip6'
- $ref: '#/components/parameters/servers_kernel_id'
- $ref: '#/components/parameters/servers_key_name'
- $ref: '#/components/parameters/servers_launch_index'
- $ref: '#/components/parameters/servers_launched_at'
- $ref: '#/components/parameters/servers_limit'
- $ref: '#/components/parameters/servers_locked'
- $ref: '#/components/parameters/servers_locked_by'
- $ref: '#/components/parameters/servers_marker'
- $ref: '#/components/parameters/servers_metadata'
- $ref: '#/components/parameters/servers_name'
- $ref: '#/components/parameters/servers_node'
- $ref: '#/components/parameters/servers_not-tags'
- $ref: '#/components/parameters/servers_not-tags-any'
- $ref: '#/components/parameters/servers_pci_devices'
- $ref: '#/components/parameters/servers_power_state'
- $ref: '#/components/parameters/servers_progress'
- $ref: '#/components/parameters/servers_project_id'
- $ref: '#/components/parameters/servers_ramdisk_id'
- $ref: '#/components/parameters/servers_reservation_id'
- $ref: '#/components/parameters/servers_root_device_name'
- $ref: '#/components/parameters/servers_security_groups'
- $ref: '#/components/parameters/servers_services'
- $ref: '#/components/parameters/servers_soft_deleted'
- $ref: '#/components/parameters/servers_sort_dir'
- $ref: '#/components/parameters/servers_sort_key'
- $ref: '#/components/parameters/servers_status'
- $ref: '#/components/parameters/servers_system_metadata'
- $ref: '#/components/parameters/servers_tags'
- $ref: '#/components/parameters/servers_tags-any'
- $ref: '#/components/parameters/servers_task_state'
- $ref: '#/components/parameters/servers_tenant_id'
- $ref: '#/components/parameters/servers_terminated_at'
- $ref: '#/components/parameters/servers_user_id'
- $ref: '#/components/parameters/servers_uuid'
- $ref: '#/components/parameters/servers_vm_state'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersListResponse'
description: Ok
'400':
description: Error
'403':
description: Error
summary: List Servers
tags:
- servers
post:
description: |-
Creates a server.
The progress of this operation depends on the location of the
requested image, network I/O, host load, selected flavor, and other
factors.
To check the progress of the request, make a `GET /servers/{id}`
request. This call returns a progress attribute, which is a percentage
value from 0 to 100.
The `Location` header returns the full URL to the newly created
server and is available as a `self` and `bookmark` link in the
server representation.
When you create a server, the response shows only the server ID, its
links, and the admin password. You can get additional attributes
through subsequent `GET` requests on the server.
Include the `block_device_mapping_v2` parameter in the create
request body to boot a server from a volume.
Include the `key_name` parameter in the create request body to add a
keypair to the server when you create it. To create a keypair, make a
[create keypair](https://docs.openstack.org/api-ref/compute/#create-or-import-keypair)
request.
**Preconditions**
**Asynchronous postconditions**
**Troubleshooting**
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401),
forbidden(403), itemNotFound(404), conflict(409)
operationId: servers:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'409':
description: Error
summary: Create Server
tags:
- servers
/v2.1/servers/detail:
get:
description: |-
For each server, shows server details including config drive,
extended status, and server usage information.
The extended status information appears in the OS-EXT-STS:vm_state,
OS-EXT-STS:power_state, and OS-EXT-STS:task_state attributes.
The server usage information appears in the OS-SRV-USG:launched_at and
OS-SRV-USG:terminated_at attributes.
HostId is unique per account and is not globally unique.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401),
forbidden(403)
operationId: servers/detail:get
parameters:
- $ref: '#/components/parameters/servers_detail_access_ip_v4'
- $ref: '#/components/parameters/servers_detail_access_ip_v6'
- $ref: '#/components/parameters/servers_detail_all_tenants'
- $ref: '#/components/parameters/servers_detail_auto_disk_config'
- $ref: '#/components/parameters/servers_detail_availability_zone'
- $ref: '#/components/parameters/servers_detail_block_device_mapping'
- $ref: '#/components/parameters/servers_detail_changes-before'
- $ref: '#/components/parameters/servers_detail_changes-since'
- $ref: '#/components/parameters/servers_detail_config_drive'
- $ref: '#/components/parameters/servers_detail_created_at'
- $ref: '#/components/parameters/servers_detail_deleted'
- $ref: '#/components/parameters/servers_detail_description'
- $ref: '#/components/parameters/servers_detail_display_description'
- $ref: '#/components/parameters/servers_detail_display_name'
- $ref: '#/components/parameters/servers_detail_flavor'
- $ref: '#/components/parameters/servers_detail_host'
- $ref: '#/components/parameters/servers_detail_hostname'
- $ref: '#/components/parameters/servers_detail_image'
- $ref: '#/components/parameters/servers_detail_image_ref'
- $ref: '#/components/parameters/servers_detail_info_cache'
- $ref: '#/components/parameters/servers_detail_ip'
- $ref: '#/components/parameters/servers_detail_ip6'
- $ref: '#/components/parameters/servers_detail_kernel_id'
- $ref: '#/components/parameters/servers_detail_key_name'
- $ref: '#/components/parameters/servers_detail_launch_index'
- $ref: '#/components/parameters/servers_detail_launched_at'
- $ref: '#/components/parameters/servers_detail_limit'
- $ref: '#/components/parameters/servers_detail_locked'
- $ref: '#/components/parameters/servers_detail_locked_by'
- $ref: '#/components/parameters/servers_detail_marker'
- $ref: '#/components/parameters/servers_detail_metadata'
- $ref: '#/components/parameters/servers_detail_name'
- $ref: '#/components/parameters/servers_detail_node'
- $ref: '#/components/parameters/servers_detail_not-tags'
- $ref: '#/components/parameters/servers_detail_not-tags-any'
- $ref: '#/components/parameters/servers_detail_pci_devices'
- $ref: '#/components/parameters/servers_detail_power_state'
- $ref: '#/components/parameters/servers_detail_progress'
- $ref: '#/components/parameters/servers_detail_project_id'
- $ref: '#/components/parameters/servers_detail_ramdisk_id'
- $ref: '#/components/parameters/servers_detail_reservation_id'
- $ref: '#/components/parameters/servers_detail_root_device_name'
- $ref: '#/components/parameters/servers_detail_security_groups'
- $ref: '#/components/parameters/servers_detail_services'
- $ref: '#/components/parameters/servers_detail_soft_deleted'
- $ref: '#/components/parameters/servers_detail_sort_dir'
- $ref: '#/components/parameters/servers_detail_sort_key'
- $ref: '#/components/parameters/servers_detail_status'
- $ref: '#/components/parameters/servers_detail_system_metadata'
- $ref: '#/components/parameters/servers_detail_tags'
- $ref: '#/components/parameters/servers_detail_tags-any'
- $ref: '#/components/parameters/servers_detail_task_state'
- $ref: '#/components/parameters/servers_detail_tenant_id'
- $ref: '#/components/parameters/servers_detail_terminated_at'
- $ref: '#/components/parameters/servers_detail_user_id'
- $ref: '#/components/parameters/servers_detail_uuid'
- $ref: '#/components/parameters/servers_detail_vm_state'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersDetailResponse'
description: Ok
'400':
description: Error
'403':
description: Error
summary: List Servers Detailed
tags:
- servers
/v2.1/servers/{id}:
delete:
description: |-
Deletes a server.
By default, the instance is going to be (hard) deleted immediately from
the system, but you can set `reclaim_instance_interval` > 0 to make
the API soft delete the instance, so that the instance won’t be
deleted until the `reclaim_instance_interval` has expired since the
instance was soft deleted. The instance marked as `SOFT_DELETED` can
be recovered via `restore` action before it’s really deleted from the
system.
**Preconditions**
**Asynchronous postconditions**
**Troubleshooting**
Normal response codes: 204
Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
operationId: servers/id:delete
responses:
'204':
description: Ok
'404':
description: Error
'409':
description: Error
summary: Delete Server
tags:
- servers
get:
description: |-
Shows details for a server.
Includes server details including configuration drive, extended status, and server usage information.
The extended status information appears in the `OS-EXT-STS:vm_state`, `OS-EXT-STS:power_state`, and `OS-EXT-STS:task_state` attributes.
The server usage information appears in the `OS-SRV-USG:launched_at` and `OS-SRV-USG:terminated_at` attributes.
HostId is unique per account and is not globally unique.
**Preconditions**
The server must exist.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404)
operationId: servers/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServerShowResponse'
description: Ok
'404':
description: Error
summary: Show Server Details
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_id'
put:
description: |-
Updates the editable attributes of an existing server.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401),
forbidden(403), itemNotFound(404)
operationId: servers/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServerUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServerUpdateResponse'
description: Ok
'404':
description: Error
summary: Update Server
tags:
- servers
/v2.1/servers/{id}/action:
parameters:
- $ref: '#/components/parameters/servers_action_id'
post:
operationId: servers/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ServersActionChange_Password'
- $ref: '#/components/schemas/ServersActionCreatebackupRequest'
- $ref: '#/components/schemas/ServersActionCreateimageRequest'
- $ref: '#/components/schemas/ServersActionEvacuateRequest'
- $ref: '#/components/schemas/ServersActionGet_Console_Output'
- $ref: '#/components/schemas/ServersActionGet_Serial_Console_21'
- $ref: '#/components/schemas/ServersActionGet_Spice_Console_21'
- $ref: '#/components/schemas/ServersActionGet_Vnc_Console_21'
- $ref: '#/components/schemas/ServersActionLockRequest'
- $ref: '#/components/schemas/ServersActionOs-GetrdpconsoleRequest'
- $ref: '#/components/schemas/ServersActionOs-MigrateliveRequest'
- $ref: '#/components/schemas/ServersActionRebuildRequest'
- $ref: '#/components/schemas/ServersActionResetnetworkRequest'
- $ref: '#/components/schemas/ServersActionUnshelveRequest'
- $ref: '#/components/schemas/ServersAction_Action_Confirm_Resize'
- $ref: '#/components/schemas/ServersAction_Action_Reboot'
- $ref: '#/components/schemas/ServersAction_Action_Resize'
- $ref: '#/components/schemas/ServersAction_Action_Revert_Resize'
- $ref: '#/components/schemas/ServersAction_Action_Trigger_Crash_Dump_217'
- $ref: '#/components/schemas/ServersAction_Add_Fixed_Ip_21'
- $ref: '#/components/schemas/ServersAction_Add_Floating_Ip_21'
- $ref: '#/components/schemas/ServersAction_Addsecuritygroup'
- $ref: '#/components/schemas/ServersAction_Force_Delete'
- $ref: '#/components/schemas/ServersAction_Inject_Network_Info'
- $ref: '#/components/schemas/ServersAction_Migrate_256'
- $ref: '#/components/schemas/ServersAction_Pause'
- $ref: '#/components/schemas/ServersAction_Remove_Fixed_Ip_21'
- $ref: '#/components/schemas/ServersAction_Remove_Floating_Ip_21'
- $ref: '#/components/schemas/ServersAction_Removesecuritygroup'
- $ref: '#/components/schemas/ServersAction_Rescue'
- $ref: '#/components/schemas/ServersAction_Reset_State'
- $ref: '#/components/schemas/ServersAction_Restore'
- $ref: '#/components/schemas/ServersAction_Resume'
- $ref: '#/components/schemas/ServersAction_Shelve'
- $ref: '#/components/schemas/ServersAction_Shelve_Offload'
- $ref: '#/components/schemas/ServersAction_Start_Server'
- $ref: '#/components/schemas/ServersAction_Stop_Server'
- $ref: '#/components/schemas/ServersAction_Suspend'
- $ref: '#/components/schemas/ServersAction_Unlock_21'
- $ref: '#/components/schemas/ServersAction_Unpause'
- $ref: '#/components/schemas/ServersAction_Unrescue'
x-openstack:
discriminator: action
responses:
'201':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ServersActionConfirmresizeResponse'
- $ref: '#/components/schemas/ServersActionCreatebackupResponse'
- $ref: '#/components/schemas/ServersActionCreateimageResponse'
- $ref: '#/components/schemas/ServersActionEvacuateResponse'
- $ref: '#/components/schemas/ServersActionOs-GetconsoleoutputResponse'
- $ref: '#/components/schemas/ServersActionOs-GetrdpconsoleResponse'
- $ref: '#/components/schemas/ServersActionOs-GetserialconsoleResponse'
- $ref: '#/components/schemas/ServersActionOs-GetspiceconsoleResponse'
- $ref: '#/components/schemas/ServersActionOs-GetvncconsoleResponse'
- $ref: '#/components/schemas/ServersActionRescueResponse'
description: Ok
'202':
description: Accepted
headers:
Location:
description: 'The image location URL of the image or backup created,
HTTP header "Location: <image location URL>" will be returned. May
be returned only in response of `createBackup` and `createImage` actions.'
schema:
type: string
x-openstack:
max-ver: '2.44'
'400':
description: Error
'401':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
'410':
description: Error
'501':
description: Error
tags:
- servers
/v2.1/servers/{server_id}/consoles:
get:
deprecated: true
description: |-
Lists all consoles for a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), gone(410)
operationId: servers/server_id/consoles:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersConsolesListResponse'
description: Ok
'410':
description: Error
summary: Lists Consoles
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_consoles_server_id'
post:
deprecated: true
description: |-
Creates a console for a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
operationId: servers/server_id/consoles:post
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersConsolesCreateResponse'
description: Ok
'410':
description: Error
summary: Create Console
tags:
- servers
/v2.1/servers/{server_id}/consoles/{id}:
delete:
deprecated: true
description: |-
Deletes a console for a server.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
operationId: servers/server_id/consoles/id:delete
responses:
'204':
description: Ok
'410':
description: Error
summary: Delete Console
tags:
- servers
get:
deprecated: true
description: |-
Shows console details for a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
operationId: servers/server_id/consoles/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersConsoleShowResponse'
description: Ok
'410':
description: Error
summary: Show Console Details
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_consoles_id'
- $ref: '#/components/parameters/servers_consoles_server_id'
/v2.1/servers/{server_id}/diagnostics:
get:
description: |-
Shows basic usage data for a server.
Policy defaults enable only users with the administrative role. Cloud
providers can change these permissions through the `policy.yaml`
file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), notfound(404), conflict(409), notimplemented(501)
operationId: servers/server_id/diagnostics:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersDiagnosticsListResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
'501':
description: Error
summary: Show Server Diagnostics
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_diagnostics_server_id'
/v2.1/servers/{server_id}/ips:
get:
description: |-
Lists IP addresses that are assigned to an instance.
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.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/ips:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersIpsListResponse'
description: Ok
'404':
description: Error
summary: List Ips
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_ips_server_id'
/v2.1/servers/{server_id}/ips/{id}:
get:
description: |-
Shows IP addresses details for a network label of a server instance.
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.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/ips/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersIpShowResponse'
description: Ok
'404':
description: Error
summary: Show Ip Details
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_ips_id'
- $ref: '#/components/parameters/servers_ips_server_id'
/v2.1/servers/{server_id}/metadata:
get:
description: |-
Lists all metadata for a server.
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.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/metadata:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMetadataListResponse'
description: Ok
'404':
description: Error
summary: List All Metadata
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_metadata_server_id'
post:
description: |-
Create or update one or more metadata items for a server.
Creates any metadata items that do not already exist in the server, replaces
exists metadata items that match keys. Does not modify items that are not in
the request.
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.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
operationId: servers/server_id/metadata:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMetadataCreate'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMetadataCreateResponse'
description: Ok
'403':
description: Error
'404':
description: Error
'409':
description: Error
summary: Create or Update Metadata Items
tags:
- servers
put:
description: |-
Replaces one or more metadata items for a server.
Creates any metadata items that do not already exist in the server. Removes and completely replaces any metadata items that already exist in the server with the metadata items in the request.
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.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
operationId: servers/server_id/metadata:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMetadataUpdate_All'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMetadataUpdate_AllResponse'
description: Ok
'403':
description: Error
'404':
description: Error
'409':
description: Error
summary: Replace Metadata Items
tags:
- servers
/v2.1/servers/{server_id}/metadata/{id}:
delete:
description: |-
Deletes a metadata item, by key, from a server.
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.yaml` file.
Normal response codes: 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
operationId: servers/server_id/metadata/id:delete
responses:
'204':
description: Ok
'404':
description: Error
'409':
description: Error
summary: Delete Metadata Item
tags:
- servers
get:
description: |-
Shows details for a metadata item, by key, for a server.
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.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/metadata/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMetadataShowResponse'
description: Ok
'404':
description: Error
summary: Show Metadata Item Details
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_metadata_id'
- $ref: '#/components/parameters/servers_metadata_server_id'
put:
description: |-
Creates or replaces a metadata item, by key, for a server.
Creates a metadata item that does not already exist in the server. Replaces
existing metadata items that match keys with the metadata item in the request.
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.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
operationId: servers/server_id/metadata/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMetadataUpdate'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMetadataUpdateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
summary: Create Or Update Metadata Item
tags:
- servers
/v2.1/servers/{server_id}/migrations:
get:
description: |-
Lists in-progress live migrations for a given server.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
`policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/migrations:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMigrationsListResponse'
description: Ok
'404':
description: Error
summary: List Migrations
tags:
- server-migrations
x-openstack:
min-ver: '2.23'
parameters:
- $ref: '#/components/parameters/servers_migrations_server_id'
/v2.1/servers/{server_id}/migrations/{id}:
delete:
description: |-
Abort an in-progress live migration.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
`policy.yaml` file.
**Preconditions**
The server OS-EXT-STS:task_state value must be `migrating`.
If the server is locked, you must have administrator privileges to force the
completion of the server migration.
For microversions from 2.24 to 2.64 the migration status must be `running`,
for microversion 2.65 and greater, the migration status can also be `queued`
and `preparing`.
**Asynchronous Postconditions**
After you make this request, you typically must keep polling the server status
to determine whether the request succeeded. You may also monitor the migration
using:
**Troubleshooting**
If the server status remains `MIGRATING` for an inordinate amount of
time, the request may have failed. Ensure you meet the preconditions and run
the request again. If the request fails again, investigate the compute back
end.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
operationId: servers/server_id/migrations/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
summary: Delete (Abort) Migration
tags:
- server-migrations
x-openstack:
min-ver: '2.24'
get:
description: |-
Show details for an in-progress live migration for a given server.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
`policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/migrations/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersMigrationShowResponse'
description: Ok
'404':
description: Error
summary: Show Migration Details
tags:
- server-migrations
x-openstack:
min-ver: '2.23'
parameters:
- $ref: '#/components/parameters/servers_migrations_id'
- $ref: '#/components/parameters/servers_migrations_server_id'
/v2.1/servers/{server_id}/migrations/{id}/action:
parameters:
- $ref: '#/components/parameters/servers_migrations_action_id'
- $ref: '#/components/parameters/servers_migrations_action_server_id'
post:
operationId: servers/server_id/migrations/id/action:post
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ServersMigrationsAction_Force_Complete_222'
x-openstack:
discriminator: action
responses:
'201':
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
tags:
- server-migrations
/v2.1/servers/{server_id}/os-instance-actions:
get:
deprecated: true
description: |-
Lists actions for a server.
Action information of deleted instances can be returned for requests
starting with microversion 2.21.
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.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/os-instance-actions:get
parameters:
- $ref: '#/components/parameters/servers_os_instance_actions_changes-before'
- $ref: '#/components/parameters/servers_os_instance_actions_changes-since'
- $ref: '#/components/parameters/servers_os_instance_actions_limit'
- $ref: '#/components/parameters/servers_os_instance_actions_marker'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Instance_ActionsListResponse'
description: Ok
'400':
description: Error
'404':
description: Error
summary: List Actions For Server
tags:
- servers
x-openstack:
max-ver: '2.57'
min-ver: '2.1'
parameters:
- $ref: '#/components/parameters/servers_os_instance_actions_server_id'
/v2.1/servers/{server_id}/os-instance-actions/{id}:
get:
description: |-
Shows details for a server action.
Action details of deleted instances can be returned for requests later
than microversion 2.21.
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.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/os-instance-actions/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse'
description: Ok
'404':
description: Error
summary: Show Server Action Details
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_os_instance_actions_id'
- $ref: '#/components/parameters/servers_os_instance_actions_server_id'
/v2.1/servers/{server_id}/os-interface:
get:
description: |-
Lists port interfaces that are attached to a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
NotImplemented(501)
operationId: servers/server_id/os-interface:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_InterfaceListResponse'
description: Ok
'404':
description: Error
'501':
description: Error
summary: List Port Interfaces
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_os_interface_server_id'
post:
description: |-
Creates a port interface and uses it to attach a port to a server.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409), computeFault(500), NotImplemented(501)
operationId: servers/server_id/os-interface:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_InterfaceCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_InterfaceCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
'500':
description: Error
'501':
description: Error
summary: Create Interface
tags:
- servers
/v2.1/servers/{server_id}/os-interface/{id}:
delete:
description: |-
Detaches a port interface from a server.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), NotImplemented(501)
operationId: servers/server_id/os-interface/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
'501':
description: Error
summary: Detach Interface
tags:
- servers
get:
description: |-
Shows details for a port interface that is attached to a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/os-interface/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_InterfaceShowResponse'
description: Ok
'403':
description: Error
'404':
description: Error
summary: Show Port Interface Details
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_os_interface_id'
- $ref: '#/components/parameters/servers_os_interface_server_id'
/v2.1/servers/{server_id}/os-security-groups:
get:
description: |-
Lists security groups for a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/os-security-groups:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Security_GroupsListResponse'
description: Ok
'404':
description: Error
summary: List Security Groups By Server
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_os_security_groups_server_id'
/v2.1/servers/{server_id}/os-server-password:
delete:
description: |-
Clears the encrypted administrative password for a server, which removes it
from the database.
This action does not actually change the instance server password.
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.yaml` file.
Normal response codes: 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/os-server-password:delete
responses:
'204':
description: Ok
'404':
description: Error
summary: Clear Admin Password
tags:
- servers
get:
description: |-
Shows the administrative password for a server.
This operation calls the metadata service to query metadata information and
does not read password information from the server itself.
The password saved in the metadata service is typically encrypted using the
public SSH key injected into this server, so the SSH private key is needed to
read the password.
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.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/os-server-password:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Server_PasswordListResponse'
description: Ok
'404':
description: Error
summary: Show Server Password
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_os_server_password_server_id'
/v2.1/servers/{server_id}/os-virtual-interfaces:
get:
deprecated: true
description: |-
Lists the virtual interfaces for an instance.
Policy defaults enable only users with the administrative role or the owner of
the server to perform this operation. Change these permissions through the
`policy.yaml` file.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410)
operationId: servers/server_id/os-virtual-interfaces:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Virtual_InterfacesListResponse'
description: Ok
'410':
description: Error
summary: List Virtual Interfaces
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_os_virtual_interfaces_server_id'
/v2.1/servers/{server_id}/os-volume_attachments:
get:
description: |-
List volume attachments for an instance.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/os-volume_attachments:get
parameters:
- $ref: '#/components/parameters/servers_os_volume_attachments_limit'
- $ref: '#/components/parameters/servers_os_volume_attachments_offset'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Volume_AttachmentsListResponse'
description: Ok
'404':
description: Error
summary: List volume attachments for an instance
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_os_volume_attachments_server_id'
post:
description: |-
Attach a volume to an instance.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
operationId: servers/server_id/os-volume_attachments:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
summary: Attach a volume to an instance
tags:
- servers
/v2.1/servers/{server_id}/os-volume_attachments/{id}:
delete:
description: |-
Detach a volume from an instance.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
operationId: servers/server_id/os-volume_attachments/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
summary: Detach a volume from an instance
tags:
- servers
get:
description: |-
Show a detail of a volume attachment.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/os-volume_attachments/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse'
description: Ok
'404':
description: Error
summary: Show a detail of a volume attachment
tags:
- servers
parameters:
- $ref: '#/components/parameters/servers_os_volume_attachments_id'
- $ref: '#/components/parameters/servers_os_volume_attachments_server_id'
put:
description: |-
Update a volume attachment.
Policy default role is ‘rule:admin_or_owner’, its scope is [project], which
allow project members or admins to change the fields of an attached volume of
a server. Cloud providers can change these permissions through the
`policy.yaml` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
operationId: servers/server_id/os-volume_attachments/id:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Volume_AttachmentUpdateRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersOs_Volume_AttachmentUpdateResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
summary: Update a volume attachment
tags:
- servers
/v2.1/servers/{server_id}/remote-consoles:
parameters:
- $ref: '#/components/parameters/servers_remote_consoles_server_id'
post:
description: |-
The API provides a unified request for creating a remote console. The user can
get a URL to connect the console from this API. The URL includes the token
which is used to get permission to access the console. Servers may support
different console protocols. To return a remote console using a specific
protocol, such as VNC, set the `protocol` parameter to `vnc`.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
operationId: servers/server_id/remote-consoles:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersRemote_ConsolesCreateRequest'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersRemote_ConsolesCreateResponse'
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
'501':
description: Error
summary: Create Console
tags:
- server-consoles
x-openstack:
min-ver: '2.6'
/v2.1/servers/{server_id}/shares:
get:
description: |-
List share attachments for an instance.
Normal response codes: 200
Error response codes: badrequest(400), forbidden(403), itemNotFound(404)
operationId: servers/server_id/shares:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersSharesListResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
summary: List share attachments for an instance
tags:
- servers
x-openstack:
min-ver: '2.97'
parameters:
- $ref: '#/components/parameters/servers_shares_server_id'
post:
description: |-
Attach a share to an instance.
Normal response codes: 201
Error response codes: badRequest(400), forbidden(403), itemNotFound(404), conflict(409)
operationId: servers/server_id/shares:post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersSharesCreate_297'
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersSharesCreateResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
summary: Attach a share to an instance
tags:
- servers
x-openstack:
min-ver: '2.97'
/v2.1/servers/{server_id}/shares/{id}:
delete:
description: |-
Detach a share from an instance.
Normal response codes: 200
Error response codes: badRequest(400), forbidden(403), itemNotFound(404), conflict(409)
operationId: servers/server_id/shares/id:delete
responses:
'204':
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
'409':
description: Error
summary: Detach a share from an instance
tags:
- servers
x-openstack:
min-ver: '2.97'
get:
description: |-
Show a detail of a share attachment.
Normal response codes: 200
Error response codes: badRequest(400), forbidden(403), itemNotFound(404)
operationId: servers/server_id/shares/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersShareShowResponse'
description: Ok
'400':
description: Error
'403':
description: Error
'404':
description: Error
summary: Show a detail of a share attachment
tags:
- servers
x-openstack:
min-ver: '2.97'
parameters:
- $ref: '#/components/parameters/servers_shares_id'
- $ref: '#/components/parameters/servers_shares_server_id'
/v2.1/servers/{server_id}/tags:
delete:
description: |-
Deletes all tags from the specified server.
Normal response codes: 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/tags:delete
responses:
'204':
description: Ok
'404':
description: Error
'409':
description: Error
summary: Delete All Tags
tags:
- server-tags
x-openstack:
min-ver: '2.26'
get:
description: |-
Lists all tags for a server.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/tags:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersTagsListResponse'
description: Ok
'404':
description: Error
summary: List Tags
tags:
- server-tags
x-openstack:
min-ver: '2.26'
parameters:
- $ref: '#/components/parameters/servers_tags_server_id'
put:
description: |-
Replaces all tags on specified server with the new set of tags.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/tags:put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ServersTagsUpdate_All_226'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersTagsUpdate_AllResponse'
description: Ok
'404':
description: Error
'409':
description: Error
summary: Replace Tags
tags:
- server-tags
x-openstack:
min-ver: '2.26'
/v2.1/servers/{server_id}/tags/{id}:
delete:
description: |-
Deletes a single tag from the specified server.
Normal response codes: 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/tags/id:delete
responses:
'204':
description: Ok
'404':
description: Error
'409':
description: Error
summary: Delete a Single Tag
tags:
- server-tags
x-openstack:
min-ver: '2.26'
get:
description: |-
Checks tag existence on the server. If tag exists response with 204 status code
will be returned. Otherwise returns 404.
Normal response codes: 204
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/tags/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersTagShowResponse'
description: Ok
'404':
description: Error
summary: Check Tag Existence
tags:
- server-tags
x-openstack:
min-ver: '2.26'
parameters:
- $ref: '#/components/parameters/servers_tags_id'
- $ref: '#/components/parameters/servers_tags_server_id'
put:
description: |-
Adds a single tag to the server if server has no specified tag. Response code
in this case is 201.
If the server has specified tag just returns 204.
Normal response codes: 201, 204
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
operationId: servers/server_id/tags/id:put
responses:
'200':
description: Ok
'400':
description: Error
'404':
description: Error
'409':
description: Error
summary: Add a Single Tag
tags:
- server-tags
x-openstack:
min-ver: '2.26'
/v2.1/servers/{server_id}/topology:
get:
description: |-
Shows NUMA topology information for a server.
Policy defaults enable only users with the administrative role or the owners
of the server to perform this operation. Cloud providers can change these
permissions through the `policy.yaml` file.
Normal response codes: 200
Error response codes: unauthorized(401), notfound(404), forbidden(403)
operationId: servers/server_id/topology:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ServersTopologyListResponse'
description: Ok
'404':
description: Error
summary: Show Server Topology
tags:
- servers
x-openstack:
min-ver: '2.78'
parameters:
- $ref: '#/components/parameters/servers_topology_server_id'
/v2.1/versions/{id}:
get:
operationId: versions/id:get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VersionShowResponse'
description: Ok
'404':
description: Error
tags:
- version
parameters:
- $ref: '#/components/parameters/versions_id'
components:
parameters:
extensions_id:
description: id parameter for /v2.1/extensions/{id} API
in: path
name: id
required: true
schema:
type: string
flavors_action_id:
description: id parameter for /v2.1/flavors/{id}/action API
in: path
name: id
required: true
schema:
type: string
flavors_detail_is_public:
in: query
name: is_public
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_detail_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_detail_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_detail_minDisk:
in: query
name: minDisk
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_detail_minRam:
in: query
name: minRam
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_detail_sort_dir:
in: query
name: sort_dir
schema:
enum:
- asc
- desc
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_detail_sort_key:
in: query
name: sort_key
schema:
enum:
- created_at
- description
- disabled
- ephemeral_gb
- flavorid
- id
- is_public
- memory_mb
- name
- root_gb
- rxtx_factor
- swap
- updated_at
- vcpu_weight
- vcpus
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_id:
description: id parameter for /v2.1/flavors/{id} API
in: path
name: id
required: true
schema:
type: string
flavors_is_public:
in: query
name: is_public
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_minDisk:
in: query
name: minDisk
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_minRam:
in: query
name: minRam
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_os_extra_specs_flavor_id:
description: flavor_id parameter for
/v2.1/flavors/{flavor_id}/os-extra_specs/{id} API
in: path
name: flavor_id
required: true
schema:
type: string
flavors_os_extra_specs_id:
description: id parameter for
/v2.1/flavors/{flavor_id}/os-extra_specs/{id} API
in: path
name: id
required: true
schema:
type: string
flavors_os_flavor_access_flavor_id:
description: flavor_id parameter for
/v2.1/flavors/{flavor_id}/os-flavor-access API
in: path
name: flavor_id
required: true
schema:
type: string
flavors_sort_dir:
in: query
name: sort_dir
schema:
enum:
- asc
- desc
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
flavors_sort_key:
in: query
name: sort_key
schema:
enum:
- created_at
- description
- disabled
- ephemeral_gb
- flavorid
- id
- is_public
- memory_mb
- name
- root_gb
- rxtx_factor
- swap
- updated_at
- vcpu_weight
- vcpus
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
images_changes-since:
in: query
name: changes-since
schema:
type: string
x-openstack:
max-ver: '2.35'
images_detail_changes-since:
in: query
name: changes-since
schema:
type: string
x-openstack:
max-ver: '2.35'
images_detail_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
images_detail_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.35'
images_detail_minDisk:
in: query
name: minDisk
schema:
type: string
x-openstack:
max-ver: '2.35'
images_detail_minRam:
in: query
name: minRam
schema:
type: string
x-openstack:
max-ver: '2.35'
images_detail_name:
in: query
name: name
schema:
type: string
x-openstack:
max-ver: '2.35'
images_detail_offset:
in: query
name: offset
schema:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
images_detail_page_size:
in: query
name: page_size
schema:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
images_detail_server:
in: query
name: server
schema:
type: string
x-openstack:
max-ver: '2.35'
images_detail_status:
in: query
name: status
schema:
type: string
x-openstack:
max-ver: '2.35'
images_detail_type:
in: query
name: type
schema:
type: string
x-openstack:
max-ver: '2.35'
images_id:
description: id parameter for /v2.1/images/{id} API
in: path
name: id
required: true
schema:
type: string
images_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
images_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.35'
images_metadata_id:
description: id parameter for /v2.1/images/{image_id}/metadata/{id} API
in: path
name: id
required: true
schema:
type: string
images_metadata_image_id:
description: image_id parameter for /v2.1/images/{image_id}/metadata/{id}
API
in: path
name: image_id
required: true
schema:
type: string
images_minDisk:
in: query
name: minDisk
schema:
type: string
x-openstack:
max-ver: '2.35'
images_minRam:
in: query
name: minRam
schema:
type: string
x-openstack:
max-ver: '2.35'
images_name:
in: query
name: name
schema:
type: string
x-openstack:
max-ver: '2.35'
images_offset:
in: query
name: offset
schema:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
images_page_size:
in: query
name: page_size
schema:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
images_server:
in: query
name: server
schema:
type: string
x-openstack:
max-ver: '2.35'
images_status:
in: query
name: status
schema:
type: string
x-openstack:
max-ver: '2.35'
images_type:
in: query
name: type
schema:
type: string
x-openstack:
max-ver: '2.35'
limits_tenant_id:
in: query
name: tenant_id
schema:
type: string
x-openstack:
max-ver: '2.56'
max_ver: '2.74'
os_agents_id:
description: id parameter for /v2.1/os-agents/{id} API
in: path
name: id
required: true
schema:
type: string
os_aggregates_action_id:
description: id parameter for /v2.1/os-aggregates/{id}/action API
in: path
name: id
required: true
schema:
type: string
os_aggregates_id:
description: id parameter for /v2.1/os-aggregates/{id} API
in: path
name: id
required: true
schema:
type: string
os_aggregates_images_id:
description: id parameter for /v2.1/os-aggregates/{id}/images API
in: path
name: id
required: true
schema:
type: string
os_assisted_volume_snapshot_delete_info:
in: query
name: delete_info
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
os_assisted_volume_snapshots_id:
description: id parameter for /v2.1/os-assisted-volume-snapshots/{id} API
in: path
name: id
required: true
schema:
type: string
os_baremetal_nodes_action_id:
description: id parameter for /v2.1/os-baremetal-nodes/{id}/action API
in: path
name: id
required: true
schema:
type: string
os_baremetal_nodes_id:
description: id parameter for /v2.1/os-baremetal-nodes/{id} API
in: path
name: id
required: true
schema:
type: string
os_cells_capacities_id:
description: id parameter for /v2.1/os-cells/{id}/capacities API
in: path
name: id
required: true
schema:
type: string
os_cells_id:
description: id parameter for /v2.1/os-cells/{id} API
in: path
name: id
required: true
schema:
type: string
os_certificates_id:
description: id parameter for /v2.1/os-certificates/{id} API
in: path
name: id
required: true
schema:
type: string
os_cloudpipe_id:
description: id parameter for /v2.1/os-cloudpipe/{id} API
in: path
name: id
required: true
schema:
type: string
os_console_auth_tokens_id:
description: id parameter for /v2.1/os-console-auth-tokens/{id} API
in: path
name: id
required: true
schema:
type: string
os_fixed_ips_action_id:
description: id parameter for /v2.1/os-fixed-ips/{id}/action API
in: path
name: id
required: true
schema:
type: string
os_fixed_ips_id:
description: id parameter for /v2.1/os-fixed-ips/{id} API
in: path
name: id
required: true
schema:
type: string
os_floating_ip_dns_entries_domain_id:
description: domain_id parameter for
/v2.1/os-floating-ip-dns/{domain_id}/entries/{id} API
in: path
name: domain_id
required: true
schema:
type: string
x-openstack:
resource_link: identity/v3/domain.id
os_floating_ip_dns_entries_id:
description: id parameter for
/v2.1/os-floating-ip-dns/{domain_id}/entries/{id} API
in: path
name: id
required: true
schema:
type: string
os_floating_ip_dns_id:
description: id parameter for /v2.1/os-floating-ip-dns/{id} API
in: path
name: id
required: true
schema:
type: string
os_floating_ips_bulk_id:
description: id parameter for /v2.1/os-floating-ips-bulk/{id} API
in: path
name: id
required: true
schema:
type: string
os_floating_ips_id:
description: id parameter for /v2.1/os-floating-ips/{id} API
in: path
name: id
required: true
schema:
type: string
os_fping_id:
description: id parameter for /v2.1/os-fping/{id} API
in: path
name: id
required: true
schema:
type: string
os_hosts_id:
description: id parameter for /v2.1/os-hosts/{id} API
in: path
name: id
required: true
schema:
type: string
os_hosts_reboot_id:
description: id parameter for /v2.1/os-hosts/{id}/reboot API
in: path
name: id
required: true
schema:
type: string
os_hosts_shutdown_id:
description: id parameter for /v2.1/os-hosts/{id}/shutdown API
in: path
name: id
required: true
schema:
type: string
os_hosts_startup_id:
description: id parameter for /v2.1/os-hosts/{id}/startup API
in: path
name: id
required: true
schema:
type: string
os_hosts_zone:
in: query
name: zone
schema:
type: string
x-openstack:
max-ver: '2.42'
os_hypervisor_with_servers:
in: query
name: with_servers
schema:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
x-openstack:
max-ver: '2.52'
min-ver: '2.53'
os_hypervisors_detail_hypervisor_hostname_pattern:
in: query
name: hypervisor_hostname_pattern
schema:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
x-openstack:
max-ver: '2.32'
min-ver: '2.53'
os_hypervisors_detail_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.32'
max_ver: '2.52'
min-ver: '2.33'
os_hypervisors_detail_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.32'
max_ver: '2.52'
min-ver: '2.33'
os_hypervisors_detail_with_servers:
in: query
name: with_servers
schema:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
x-openstack:
max-ver: '2.32'
min-ver: '2.53'
os_hypervisors_hypervisor_hostname_pattern:
in: query
name: hypervisor_hostname_pattern
schema:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
x-openstack:
max-ver: '2.32'
min-ver: '2.53'
os_hypervisors_id:
description: id parameter for /v2.1/os-hypervisors/{id} API
in: path
name: id
required: true
schema:
type: string
os_hypervisors_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.32'
max_ver: '2.52'
min-ver: '2.33'
os_hypervisors_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.32'
max_ver: '2.52'
min-ver: '2.33'
os_hypervisors_search_id:
description: id parameter for /v2.1/os-hypervisors/{id}/search API
in: path
name: id
required: true
schema:
type: string
os_hypervisors_servers_id:
description: id parameter for /v2.1/os-hypervisors/{id}/servers API
in: path
name: id
required: true
schema:
type: string
os_hypervisors_uptime_id:
description: id parameter for /v2.1/os-hypervisors/{id}/uptime API
in: path
name: id
required: true
schema:
type: string
os_hypervisors_with_servers:
in: query
name: with_servers
schema:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
x-openstack:
max-ver: '2.32'
min-ver: '2.53'
os_instance_usage_audit_log_id:
description: Filters the response by the date and time before which to
list usage audits.
in: path
name: id
required: true
schema:
format: date-time
type: string
os_keypair_user_id:
in: query
name: user_id
schema:
type: string
x-openstack:
max-ver: '2.9'
min-ver: '2.10'
resource_link: identity/v3/user.id
os_keypairs_id:
description: id parameter for /v2.1/os-keypairs/{id} API
in: path
name: id
required: true
schema:
type: string
os_keypairs_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.9'
min-ver: '2.35'
os_keypairs_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.9'
min-ver: '2.35'
os_keypairs_user_id:
in: query
name: user_id
schema:
type: string
x-openstack:
max-ver: '2.9'
min-ver: '2.10'
resource_link: identity/v3/user.id
os_migrations_changes-before:
in: query
name: changes-before
schema:
format: date-time
type: string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.66'
os_migrations_changes-since:
in: query
name: changes-since
schema:
format: date-time
type: string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.59'
os_migrations_hidden:
in: query
name: hidden
schema:
type: string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.0'
os_migrations_host:
in: query
name: host
schema:
type: string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.0'
os_migrations_instance_uuid:
in: query
name: instance_uuid
schema:
type: string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.0'
os_migrations_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.59'
os_migrations_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.59'
os_migrations_migration_type:
in: query
name: migration_type
schema:
type: string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.0'
os_migrations_project_id:
in: query
name: project_id
schema:
type: string
x-openstack:
max-ver: '2.58'
min-ver: '2.80'
resource_link: identity/v3/project.id
os_migrations_source_compute:
in: query
name: source_compute
schema:
type: string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.0'
os_migrations_status:
in: query
name: status
schema:
type: string
x-openstack:
max-ver: '2.58'
max_ver: '2.79'
min-ver: '2.0'
os_migrations_user_id:
in: query
name: user_id
schema:
type: string
x-openstack:
max-ver: '2.58'
min-ver: '2.80'
resource_link: identity/v3/user.id
os_networks_action_id:
description: id parameter for /v2.1/os-networks/{id}/action API
in: path
name: id
required: true
schema:
type: string
os_networks_id:
description: id parameter for /v2.1/os-networks/{id} API
in: path
name: id
required: true
schema:
type: string
os_quota_class_sets_id:
description: id parameter for /v2.1/os-quota-class-sets/{id} API
in: path
name: id
required: true
schema:
type: string
os_quota_set_user_id:
description: |-
ID of user to set the quotas for.
in: query
name: user_id
schema:
type: string
x-openstack:
min-ver: '2.0'
resource_link: identity/v3/user.id
os_quota_sets_defaults_id:
description: id parameter for /v2.1/os-quota-sets/{id}/defaults API
in: path
name: id
required: true
schema:
type: string
os_quota_sets_detail_id:
description: id parameter for /v2.1/os-quota-sets/{id}/detail API
in: path
name: id
required: true
schema:
type: string
os_quota_sets_detail_user_id:
in: query
name: user_id
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
resource_link: identity/v3/user.id
os_quota_sets_id:
description: id parameter for /v2.1/os-quota-sets/{id} API
in: path
name: id
required: true
schema:
type: string
os_security_group_default_rules_id:
description: id parameter for /v2.1/os-security-group-default-rules/{id}
API
in: path
name: id
required: true
schema:
type: string
os_security_group_rules_id:
description: id parameter for /v2.1/os-security-group-rules/{id} API
in: path
name: id
required: true
schema:
type: string
os_security_groups_all_tenants:
in: query
name: all_tenants
schema:
type: string
x-openstack:
max-ver: '2.35'
os_security_groups_id:
description: id parameter for /v2.1/os-security-groups/{id} API
in: path
name: id
required: true
schema:
type: string
os_security_groups_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
os_security_groups_offset:
in: query
name: offset
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
os_server_groups_all_projects:
in: query
name: all_projects
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
os_server_groups_id:
description: id parameter for /v2.1/os-server-groups/{id} API
in: path
name: id
required: true
schema:
type: string
os_server_groups_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
os_server_groups_offset:
in: query
name: offset
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
os_services_binary:
in: query
name: binary
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
os_services_host:
in: query
name: host
schema:
type: string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
os_services_id:
description: id parameter for /v2.1/os-services/{id} API
in: path
name: id
required: true
schema:
type: string
os_simple_tenant_usage_detailed:
in: query
name: detailed
schema:
type: string
x-openstack:
max-ver: '2.39'
max_ver: '2.74'
os_simple_tenant_usage_end:
in: query
name: end
schema:
type: string
x-openstack:
max-ver: '2.39'
max_ver: '2.74'
os_simple_tenant_usage_id:
description: id parameter for /v2.1/os-simple-tenant-usage/{id} API
in: path
name: id
required: true
schema:
type: string
os_simple_tenant_usage_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.39'
max_ver: '2.74'
min-ver: '2.40'
os_simple_tenant_usage_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.39'
max_ver: '2.74'
min-ver: '2.40'
os_simple_tenant_usage_start:
in: query
name: start
schema:
type: string
x-openstack:
max-ver: '2.39'
max_ver: '2.74'
os_snapshots_detail_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
os_snapshots_detail_offset:
in: query
name: offset
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
os_snapshots_id:
description: id parameter for /v2.1/os-snapshots/{id} API
in: path
name: id
required: true
schema:
type: string
os_snapshots_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
os_snapshots_offset:
in: query
name: offset
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
os_tenant_networks_id:
description: id parameter for /v2.1/os-tenant-networks/{id} API
in: path
name: id
required: true
schema:
type: string
os_volumes_boot_access_ip_v4:
in: query
name: access_ip_v4
schema:
format: regex
type: string
os_volumes_boot_access_ip_v6:
in: query
name: access_ip_v6
schema:
format: regex
type: string
os_volumes_boot_action_id:
description: id parameter for /v2.1/os-volumes_boot/{id}/action API
in: path
name: id
required: true
schema:
type: string
os_volumes_boot_all_tenants:
in: query
name: all_tenants
schema:
type: string
os_volumes_boot_auto_disk_config:
in: query
name: auto_disk_config
schema:
format: regex
type: string
os_volumes_boot_availability_zone:
in: query
name: availability_zone
schema:
format: regex
type: string
os_volumes_boot_block_device_mapping:
in: query
name: block_device_mapping
schema:
type: string
os_volumes_boot_changes-before:
in: query
name: changes-before
schema:
format: date-time
type: string
x-openstack:
min-ver: '2.66'
os_volumes_boot_changes-since:
in: query
name: changes-since
schema:
format: date-time
type: string
os_volumes_boot_config_drive:
in: query
name: config_drive
schema:
format: regex
type: string
os_volumes_boot_created_at:
in: query
name: created_at
schema:
format: regex
type: string
os_volumes_boot_deleted:
in: query
name: deleted
schema:
type: string
os_volumes_boot_description:
in: query
name: description
schema:
format: regex
type: string
os_volumes_boot_detail_access_ip_v4:
in: query
name: access_ip_v4
schema:
format: regex
type: string
os_volumes_boot_detail_access_ip_v6:
in: query
name: access_ip_v6
schema:
format: regex
type: string
os_volumes_boot_detail_all_tenants:
in: query
name: all_tenants
schema:
type: string
os_volumes_boot_detail_auto_disk_config:
in: query
name: auto_disk_config
schema:
format: regex
type: string
os_volumes_boot_detail_availability_zone:
in: query
name: availability_zone
schema:
format: regex
type: string
os_volumes_boot_detail_block_device_mapping:
in: query
name: block_device_mapping
schema:
type: string
os_volumes_boot_detail_changes-before:
in: query
name: changes-before
schema:
format: date-time
type: string
x-openstack:
min-ver: '2.66'
os_volumes_boot_detail_changes-since:
in: query
name: changes-since
schema:
format: date-time
type: string
os_volumes_boot_detail_config_drive:
in: query
name: config_drive
schema:
format: regex
type: string
os_volumes_boot_detail_created_at:
in: query
name: created_at
schema:
format: regex
type: string
os_volumes_boot_detail_deleted:
in: query
name: deleted
schema:
type: string
os_volumes_boot_detail_description:
in: query
name: description
schema:
format: regex
type: string
os_volumes_boot_detail_display_description:
in: query
name: display_description
schema:
format: regex
type: string
os_volumes_boot_detail_display_name:
in: query
name: display_name
schema:
format: regex
type: string
os_volumes_boot_detail_flavor:
in: query
name: flavor
schema:
format: regex
type: string
os_volumes_boot_detail_host:
in: query
name: host
schema:
type: string
os_volumes_boot_detail_hostname:
in: query
name: hostname
schema:
format: regex
type: string
os_volumes_boot_detail_image:
in: query
name: image
schema:
type: string
os_volumes_boot_detail_image_ref:
in: query
name: image_ref
schema:
type: string
os_volumes_boot_detail_info_cache:
in: query
name: info_cache
schema:
type: string
os_volumes_boot_detail_ip:
in: query
name: ip
schema:
format: regex
type: string
os_volumes_boot_detail_ip6:
in: query
name: ip6
schema:
format: regex
type: string
os_volumes_boot_detail_kernel_id:
in: query
name: kernel_id
schema:
format: regex
type: string
os_volumes_boot_detail_key_name:
in: query
name: key_name
schema:
format: regex
type: string
os_volumes_boot_detail_launch_index:
in: query
name: launch_index
schema:
type: string
os_volumes_boot_detail_launched_at:
in: query
name: launched_at
schema:
format: regex
type: string
os_volumes_boot_detail_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
os_volumes_boot_detail_locked:
in: query
name: locked
schema:
type: string
x-openstack:
min-ver: '2.73'
os_volumes_boot_detail_locked_by:
in: query
name: locked_by
schema:
format: regex
type: string
os_volumes_boot_detail_marker:
in: query
name: marker
schema:
type: string
os_volumes_boot_detail_metadata:
in: query
name: metadata
schema:
type: string
os_volumes_boot_detail_name:
in: query
name: name
schema:
format: regex
type: string
os_volumes_boot_detail_node:
in: query
name: node
schema:
format: regex
type: string
os_volumes_boot_detail_not-tags:
in: query
name: not-tags
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
os_volumes_boot_detail_not-tags-any:
in: query
name: not-tags-any
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
os_volumes_boot_detail_pci_devices:
in: query
name: pci_devices
schema:
type: string
os_volumes_boot_detail_power_state:
in: query
name: power_state
schema:
format: regex
type: string
os_volumes_boot_detail_progress:
in: query
name: progress
schema:
format: regex
type: string
os_volumes_boot_detail_project_id:
in: query
name: project_id
schema:
type: string
x-openstack:
resource_link: identity/v3/project.id
os_volumes_boot_detail_ramdisk_id:
in: query
name: ramdisk_id
schema:
format: regex
type: string
os_volumes_boot_detail_reservation_id:
in: query
name: reservation_id
schema:
format: regex
type: string
os_volumes_boot_detail_root_device_name:
in: query
name: root_device_name
schema:
format: regex
type: string
os_volumes_boot_detail_security_groups:
in: query
name: security_groups
schema:
type: string
os_volumes_boot_detail_services:
in: query
name: services
schema:
type: string
os_volumes_boot_detail_soft_deleted:
in: query
name: soft_deleted
schema:
type: string
os_volumes_boot_detail_sort_dir:
in: query
name: sort_dir
schema:
type: string
os_volumes_boot_detail_sort_key:
in: query
name: sort_key
schema:
enum:
- 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
- locked_by
- node
- power_state
- progress
- project_id
- ramdisk_id
- root_device_name
- task_state
- terminated_at
- updated_at
- user_id
- uuid
- vm_state
type: string
os_volumes_boot_detail_status:
in: query
name: status
schema:
type: string
os_volumes_boot_detail_system_metadata:
in: query
name: system_metadata
schema:
type: string
os_volumes_boot_detail_tags:
in: query
name: tags
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
os_volumes_boot_detail_tags-any:
in: query
name: tags-any
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
os_volumes_boot_detail_task_state:
in: query
name: task_state
schema:
type: string
os_volumes_boot_detail_tenant_id:
in: query
name: tenant_id
schema:
type: string
os_volumes_boot_detail_terminated_at:
in: query
name: terminated_at
schema:
format: regex
type: string
os_volumes_boot_detail_user_id:
in: query
name: user_id
schema:
type: string
x-openstack:
resource_link: identity/v3/user.id
os_volumes_boot_detail_uuid:
in: query
name: uuid
schema:
type: string
os_volumes_boot_detail_vm_state:
in: query
name: vm_state
schema:
type: string
os_volumes_boot_display_description:
in: query
name: display_description
schema:
format: regex
type: string
os_volumes_boot_display_name:
in: query
name: display_name
schema:
format: regex
type: string
os_volumes_boot_flavor:
in: query
name: flavor
schema:
format: regex
type: string
os_volumes_boot_host:
in: query
name: host
schema:
type: string
os_volumes_boot_hostname:
in: query
name: hostname
schema:
format: regex
type: string
os_volumes_boot_id:
description: id parameter for /v2.1/os-volumes_boot/{id} API
in: path
name: id
required: true
schema:
type: string
os_volumes_boot_image:
in: query
name: image
schema:
type: string
os_volumes_boot_image_ref:
in: query
name: image_ref
schema:
type: string
os_volumes_boot_info_cache:
in: query
name: info_cache
schema:
type: string
os_volumes_boot_ip:
in: query
name: ip
schema:
format: regex
type: string
os_volumes_boot_ip6:
in: query
name: ip6
schema:
format: regex
type: string
os_volumes_boot_kernel_id:
in: query
name: kernel_id
schema:
format: regex
type: string
os_volumes_boot_key_name:
in: query
name: key_name
schema:
format: regex
type: string
os_volumes_boot_launch_index:
in: query
name: launch_index
schema:
type: string
os_volumes_boot_launched_at:
in: query
name: launched_at
schema:
format: regex
type: string
os_volumes_boot_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
os_volumes_boot_locked:
in: query
name: locked
schema:
type: string
x-openstack:
min-ver: '2.73'
os_volumes_boot_locked_by:
in: query
name: locked_by
schema:
format: regex
type: string
os_volumes_boot_marker:
in: query
name: marker
schema:
type: string
os_volumes_boot_metadata:
in: query
name: metadata
schema:
type: string
os_volumes_boot_name:
in: query
name: name
schema:
format: regex
type: string
os_volumes_boot_node:
in: query
name: node
schema:
format: regex
type: string
os_volumes_boot_not-tags:
in: query
name: not-tags
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
os_volumes_boot_not-tags-any:
in: query
name: not-tags-any
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
os_volumes_boot_pci_devices:
in: query
name: pci_devices
schema:
type: string
os_volumes_boot_power_state:
in: query
name: power_state
schema:
format: regex
type: string
os_volumes_boot_progress:
in: query
name: progress
schema:
format: regex
type: string
os_volumes_boot_project_id:
in: query
name: project_id
schema:
type: string
x-openstack:
resource_link: identity/v3/project.id
os_volumes_boot_ramdisk_id:
in: query
name: ramdisk_id
schema:
format: regex
type: string
os_volumes_boot_reservation_id:
in: query
name: reservation_id
schema:
format: regex
type: string
os_volumes_boot_root_device_name:
in: query
name: root_device_name
schema:
format: regex
type: string
os_volumes_boot_security_groups:
in: query
name: security_groups
schema:
type: string
os_volumes_boot_services:
in: query
name: services
schema:
type: string
os_volumes_boot_soft_deleted:
in: query
name: soft_deleted
schema:
type: string
os_volumes_boot_sort_dir:
in: query
name: sort_dir
schema:
type: string
os_volumes_boot_sort_key:
in: query
name: sort_key
schema:
enum:
- 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
- locked_by
- node
- power_state
- progress
- project_id
- ramdisk_id
- root_device_name
- task_state
- terminated_at
- updated_at
- user_id
- uuid
- vm_state
type: string
os_volumes_boot_status:
in: query
name: status
schema:
type: string
os_volumes_boot_system_metadata:
in: query
name: system_metadata
schema:
type: string
os_volumes_boot_tags:
in: query
name: tags
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
os_volumes_boot_tags-any:
in: query
name: tags-any
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
os_volumes_boot_task_state:
in: query
name: task_state
schema:
type: string
os_volumes_boot_tenant_id:
in: query
name: tenant_id
schema:
type: string
os_volumes_boot_terminated_at:
in: query
name: terminated_at
schema:
format: regex
type: string
os_volumes_boot_user_id:
in: query
name: user_id
schema:
type: string
x-openstack:
resource_link: identity/v3/user.id
os_volumes_boot_uuid:
in: query
name: uuid
schema:
type: string
os_volumes_boot_vm_state:
in: query
name: vm_state
schema:
type: string
os_volumes_detail_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
os_volumes_detail_offset:
in: query
name: offset
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
os_volumes_id:
description: id parameter for /v2.1/os-volumes/{id} API
in: path
name: id
required: true
schema:
type: string
os_volumes_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
os_volumes_offset:
in: query
name: offset
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.35'
servers_access_ip_v4:
in: query
name: access_ip_v4
schema:
format: regex
type: string
servers_access_ip_v6:
in: query
name: access_ip_v6
schema:
format: regex
type: string
servers_action_id:
description: id parameter for /v2.1/servers/{id}/action API
in: path
name: id
required: true
schema:
type: string
servers_all_tenants:
in: query
name: all_tenants
schema:
type: string
servers_auto_disk_config:
in: query
name: auto_disk_config
schema:
format: regex
type: string
servers_availability_zone:
in: query
name: availability_zone
schema:
format: regex
type: string
servers_block_device_mapping:
in: query
name: block_device_mapping
schema:
type: string
servers_changes-before:
in: query
name: changes-before
schema:
format: date-time
type: string
x-openstack:
min-ver: '2.66'
servers_changes-since:
in: query
name: changes-since
schema:
format: date-time
type: string
servers_config_drive:
in: query
name: config_drive
schema:
format: regex
type: string
servers_consoles_id:
description: id parameter for /v2.1/servers/{server_id}/consoles/{id} API
in: path
name: id
required: true
schema:
type: string
servers_consoles_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/consoles/{id} API
in: path
name: server_id
required: true
schema:
type: string
servers_created_at:
in: query
name: created_at
schema:
format: regex
type: string
servers_deleted:
in: query
name: deleted
schema:
type: string
servers_description:
in: query
name: description
schema:
format: regex
type: string
servers_detail_access_ip_v4:
in: query
name: access_ip_v4
schema:
format: regex
type: string
servers_detail_access_ip_v6:
in: query
name: access_ip_v6
schema:
format: regex
type: string
servers_detail_all_tenants:
in: query
name: all_tenants
schema:
type: string
servers_detail_auto_disk_config:
in: query
name: auto_disk_config
schema:
format: regex
type: string
servers_detail_availability_zone:
in: query
name: availability_zone
schema:
format: regex
type: string
servers_detail_block_device_mapping:
in: query
name: block_device_mapping
schema:
type: string
servers_detail_changes-before:
in: query
name: changes-before
schema:
format: date-time
type: string
x-openstack:
min-ver: '2.66'
servers_detail_changes-since:
in: query
name: changes-since
schema:
format: date-time
type: string
servers_detail_config_drive:
in: query
name: config_drive
schema:
format: regex
type: string
servers_detail_created_at:
in: query
name: created_at
schema:
format: regex
type: string
servers_detail_deleted:
in: query
name: deleted
schema:
type: string
servers_detail_description:
in: query
name: description
schema:
format: regex
type: string
servers_detail_display_description:
in: query
name: display_description
schema:
format: regex
type: string
servers_detail_display_name:
in: query
name: display_name
schema:
format: regex
type: string
servers_detail_flavor:
in: query
name: flavor
schema:
format: regex
type: string
servers_detail_host:
in: query
name: host
schema:
type: string
servers_detail_hostname:
in: query
name: hostname
schema:
format: regex
type: string
servers_detail_image:
in: query
name: image
schema:
type: string
servers_detail_image_ref:
in: query
name: image_ref
schema:
type: string
servers_detail_info_cache:
in: query
name: info_cache
schema:
type: string
servers_detail_ip:
in: query
name: ip
schema:
format: regex
type: string
servers_detail_ip6:
in: query
name: ip6
schema:
format: regex
type: string
servers_detail_kernel_id:
in: query
name: kernel_id
schema:
format: regex
type: string
servers_detail_key_name:
in: query
name: key_name
schema:
format: regex
type: string
servers_detail_launch_index:
in: query
name: launch_index
schema:
type: string
servers_detail_launched_at:
in: query
name: launched_at
schema:
format: regex
type: string
servers_detail_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
servers_detail_locked:
in: query
name: locked
schema:
type: string
x-openstack:
min-ver: '2.73'
servers_detail_locked_by:
in: query
name: locked_by
schema:
format: regex
type: string
servers_detail_marker:
in: query
name: marker
schema:
type: string
servers_detail_metadata:
in: query
name: metadata
schema:
type: string
servers_detail_name:
in: query
name: name
schema:
format: regex
type: string
servers_detail_node:
in: query
name: node
schema:
format: regex
type: string
servers_detail_not-tags:
in: query
name: not-tags
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
servers_detail_not-tags-any:
in: query
name: not-tags-any
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
servers_detail_pci_devices:
in: query
name: pci_devices
schema:
type: string
servers_detail_power_state:
in: query
name: power_state
schema:
format: regex
type: string
servers_detail_progress:
in: query
name: progress
schema:
format: regex
type: string
servers_detail_project_id:
in: query
name: project_id
schema:
type: string
x-openstack:
resource_link: identity/v3/project.id
servers_detail_ramdisk_id:
in: query
name: ramdisk_id
schema:
format: regex
type: string
servers_detail_reservation_id:
in: query
name: reservation_id
schema:
format: regex
type: string
servers_detail_root_device_name:
in: query
name: root_device_name
schema:
format: regex
type: string
servers_detail_security_groups:
in: query
name: security_groups
schema:
type: string
servers_detail_services:
in: query
name: services
schema:
type: string
servers_detail_soft_deleted:
in: query
name: soft_deleted
schema:
type: string
servers_detail_sort_dir:
in: query
name: sort_dir
schema:
type: string
servers_detail_sort_key:
in: query
name: sort_key
schema:
enum:
- 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
- locked_by
- node
- power_state
- progress
- project_id
- ramdisk_id
- root_device_name
- task_state
- terminated_at
- updated_at
- user_id
- uuid
- vm_state
type: string
servers_detail_status:
in: query
name: status
schema:
type: string
servers_detail_system_metadata:
in: query
name: system_metadata
schema:
type: string
servers_detail_tags:
in: query
name: tags
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
servers_detail_tags-any:
in: query
name: tags-any
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
servers_detail_task_state:
in: query
name: task_state
schema:
type: string
servers_detail_tenant_id:
in: query
name: tenant_id
schema:
type: string
servers_detail_terminated_at:
in: query
name: terminated_at
schema:
format: regex
type: string
servers_detail_user_id:
in: query
name: user_id
schema:
type: string
x-openstack:
resource_link: identity/v3/user.id
servers_detail_uuid:
in: query
name: uuid
schema:
type: string
servers_detail_vm_state:
in: query
name: vm_state
schema:
type: string
servers_diagnostics_server_id:
description: server_id parameter for /v2.1/servers/{server_id}/diagnostics
API
in: path
name: server_id
required: true
schema:
type: string
servers_display_description:
in: query
name: display_description
schema:
format: regex
type: string
servers_display_name:
in: query
name: display_name
schema:
format: regex
type: string
servers_flavor:
in: query
name: flavor
schema:
format: regex
type: string
servers_host:
in: query
name: host
schema:
type: string
servers_hostname:
in: query
name: hostname
schema:
format: regex
type: string
servers_id:
description: id parameter for /v2.1/servers/{id} API
in: path
name: id
required: true
schema:
type: string
servers_image:
in: query
name: image
schema:
type: string
servers_image_ref:
in: query
name: image_ref
schema:
type: string
servers_info_cache:
in: query
name: info_cache
schema:
type: string
servers_ip:
in: query
name: ip
schema:
format: regex
type: string
servers_ip6:
in: query
name: ip6
schema:
format: regex
type: string
servers_ips_id:
description: id parameter for /v2.1/servers/{server_id}/ips/{id} API
in: path
name: id
required: true
schema:
type: string
servers_ips_server_id:
description: server_id parameter for /v2.1/servers/{server_id}/ips/{id}
API
in: path
name: server_id
required: true
schema:
type: string
servers_kernel_id:
in: query
name: kernel_id
schema:
format: regex
type: string
servers_key_name:
in: query
name: key_name
schema:
format: regex
type: string
servers_launch_index:
in: query
name: launch_index
schema:
type: string
servers_launched_at:
in: query
name: launched_at
schema:
format: regex
type: string
servers_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
servers_locked:
in: query
name: locked
schema:
type: string
x-openstack:
min-ver: '2.73'
servers_locked_by:
in: query
name: locked_by
schema:
format: regex
type: string
servers_marker:
in: query
name: marker
schema:
type: string
servers_metadata:
in: query
name: metadata
schema:
type: string
servers_metadata_id:
description: id parameter for /v2.1/servers/{server_id}/metadata/{id} API
in: path
name: id
required: true
schema:
type: string
servers_metadata_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/metadata/{id} API
in: path
name: server_id
required: true
schema:
type: string
servers_migrations_action_id:
description: id parameter for
/v2.1/servers/{server_id}/migrations/{id}/action API
in: path
name: id
required: true
schema:
type: string
servers_migrations_action_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/migrations/{id}/action API
in: path
name: server_id
required: true
schema:
type: string
servers_migrations_id:
description: id parameter for /v2.1/servers/{server_id}/migrations/{id}
API
in: path
name: id
required: true
schema:
type: string
servers_migrations_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/migrations/{id} API
in: path
name: server_id
required: true
schema:
type: string
servers_name:
in: query
name: name
schema:
format: regex
type: string
servers_node:
in: query
name: node
schema:
format: regex
type: string
servers_not-tags:
in: query
name: not-tags
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
servers_not-tags-any:
in: query
name: not-tags-any
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
servers_os_instance_actions_changes-before:
in: query
name: changes-before
schema:
format: date-time
type: string
x-openstack:
max-ver: '2.57'
min-ver: '2.66'
servers_os_instance_actions_changes-since:
in: query
name: changes-since
schema:
format: date-time
type: string
x-openstack:
max-ver: '2.57'
max_ver: '2.65'
min-ver: '2.58'
servers_os_instance_actions_id:
description: id parameter for
/v2.1/servers/{server_id}/os-instance-actions/{id} API
in: path
name: id
required: true
schema:
type: string
servers_os_instance_actions_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.57'
max_ver: '2.65'
min-ver: '2.58'
servers_os_instance_actions_marker:
in: query
name: marker
schema:
type: string
x-openstack:
max-ver: '2.57'
max_ver: '2.65'
min-ver: '2.58'
servers_os_instance_actions_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/os-instance-actions/{id} API
in: path
name: server_id
required: true
schema:
type: string
servers_os_interface_id:
description: id parameter for /v2.1/servers/{server_id}/os-interface/{id}
API
in: path
name: id
required: true
schema:
type: string
servers_os_interface_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/os-interface/{id} API
in: path
name: server_id
required: true
schema:
type: string
servers_os_security_groups_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/os-security-groups API
in: path
name: server_id
required: true
schema:
type: string
servers_os_server_password_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/os-server-password API
in: path
name: server_id
required: true
schema:
type: string
servers_os_virtual_interfaces_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/os-virtual-interfaces API
in: path
name: server_id
required: true
schema:
type: string
servers_os_volume_attachments_id:
description: id parameter for
/v2.1/servers/{server_id}/os-volume_attachments/{id} API
in: path
name: id
required: true
schema:
type: string
servers_os_volume_attachments_limit:
in: query
name: limit
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
servers_os_volume_attachments_offset:
in: query
name: offset
schema:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
x-openstack:
max-ver: '2.74'
min-ver: '2.0'
servers_os_volume_attachments_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/os-volume_attachments/{id} API
in: path
name: server_id
required: true
schema:
type: string
servers_pci_devices:
in: query
name: pci_devices
schema:
type: string
servers_power_state:
in: query
name: power_state
schema:
format: regex
type: string
servers_progress:
in: query
name: progress
schema:
format: regex
type: string
servers_project_id:
in: query
name: project_id
schema:
type: string
x-openstack:
resource_link: identity/v3/project.id
servers_ramdisk_id:
in: query
name: ramdisk_id
schema:
format: regex
type: string
servers_remote_consoles_server_id:
description: server_id parameter for
/v2.1/servers/{server_id}/remote-consoles API
in: path
name: server_id
required: true
schema:
type: string
servers_reservation_id:
in: query
name: reservation_id
schema:
format: regex
type: string
servers_root_device_name:
in: query
name: root_device_name
schema:
format: regex
type: string
servers_security_groups:
in: query
name: security_groups
schema:
type: string
servers_services:
in: query
name: services
schema:
type: string
servers_shares_id:
description: id parameter for /v2.1/servers/{server_id}/shares/{id} API
in: path
name: id
required: true
schema:
type: string
servers_shares_server_id:
description: server_id parameter for /v2.1/servers/{server_id}/shares/{id}
API
in: path
name: server_id
required: true
schema:
type: string
servers_soft_deleted:
in: query
name: soft_deleted
schema:
type: string
servers_sort_dir:
in: query
name: sort_dir
schema:
type: string
servers_sort_key:
in: query
name: sort_key
schema:
enum:
- 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
- locked_by
- node
- power_state
- progress
- project_id
- ramdisk_id
- root_device_name
- task_state
- terminated_at
- updated_at
- user_id
- uuid
- vm_state
type: string
servers_status:
in: query
name: status
schema:
type: string
servers_system_metadata:
in: query
name: system_metadata
schema:
type: string
servers_tags:
in: query
name: tags
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
servers_tags-any:
in: query
name: tags-any
schema:
format: regex
type: string
x-openstack:
min-ver: '2.26'
servers_tags_id:
description: id parameter for /v2.1/servers/{server_id}/tags/{id} API
in: path
name: id
required: true
schema:
type: string
servers_tags_server_id:
description: server_id parameter for /v2.1/servers/{server_id}/tags/{id}
API
in: path
name: server_id
required: true
schema:
type: string
servers_task_state:
in: query
name: task_state
schema:
type: string
servers_tenant_id:
in: query
name: tenant_id
schema:
type: string
servers_terminated_at:
in: query
name: terminated_at
schema:
format: regex
type: string
servers_topology_server_id:
description: server_id parameter for /v2.1/servers/{server_id}/topology
API
in: path
name: server_id
required: true
schema:
type: string
servers_user_id:
in: query
name: user_id
schema:
type: string
x-openstack:
resource_link: identity/v3/user.id
servers_uuid:
in: query
name: uuid
schema:
type: string
servers_vm_state:
in: query
name: vm_state
schema:
type: string
versions_id:
description: id parameter for /v2.1/versions/{id} API
in: path
name: id
required: true
schema:
type: string
schemas:
ExtensionShowResponse:
description: An extension object.
properties:
extension:
description: |-
An `extension` object.
properties:
alias:
description: |-
A short name by which this extension is also known.
type: string
description:
description: |-
Text describing this extension’s purpose.
type: string
links:
description: |-
Links pertaining to this extension. This is a list of dictionaries, each including
keys `href` and `rel`.
items:
description: Links to the resources in question. See [API Guide
/ Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
name:
description: |-
Name of the extension.
type: string
namespace:
description: |-
A URL pointing to the namespace for this extension.
type: string
updated:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
required:
- alias
- name
type: object
required:
- extension
type: object
ExtensionsListResponse:
description: An extension object.
properties:
extensions:
description: |-
List of `extension` objects.
items:
description: An extension object.
properties:
alias:
description: |-
A short name by which this extension is also known.
type: string
description:
description: |-
Text describing this extension’s purpose.
type: string
links:
description: |-
Links pertaining to this extension. This is a list of dictionaries, each including
keys `href` and `rel`.
items:
description: Links to the resources in question. See [API
Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
name:
description: |-
Name of the extension.
type: string
namespace:
description: |-
A URL pointing to the namespace for this extension.
type: string
updated:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
required:
- alias
- name
type: object
type: array
required:
- extensions
type: object
FlavorShowResponse:
additionalProperties: false
properties:
flavor:
additionalProperties: false
description: |-
The ID and links for the flavor for your server instance. A flavor is a combination
of memory, disk size, and CPUs.
properties:
OS-FLV-DISABLED:disabled:
description: |-
Whether or not the flavor has been administratively disabled.
This is an artifact of the legacy v2 API and will always be set to
`false`. There is currently no way to disable a flavor and set this to
`true`.
type: boolean
OS-FLV-EXT-DATA:ephemeral:
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.
type: integer
description:
description: |-
The description of the flavor.
**New in version 2.55**
type:
- 'null'
- string
disk:
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 the 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. Volume-backed instances can be enforced for flavors with
zero root disk via the `os_compute_api:servers:create:zero_disk_flavor`
policy rule.
type: integer
extra_specs:
additionalProperties: false
description: |-
A dictionary of the flavor’s extra-specs key-and-value pairs. This will
only be included if the user is allowed by policy to index flavor
extra_specs.
**New in version 2.61**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
id:
description: |-
The ID of the flavor. While people often make this look like
an int, this is really a string.
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
properties:
href:
format: uri
type: string
rel:
type: string
required:
- href
- rel
type: object
type: array
name:
description: |-
The display name of a flavor.
type: string
os-flavor-access:is_public: {}
ram:
description: |-
The amount of RAM a flavor has, in MiB.
type: integer
rxtx_factor: {}
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.
Currently, the empty string (‘’) is used to represent 0.
As of microversion 2.75 default return value of swap is 0
instead of empty string.
type: integer
vcpus:
description: |-
The number of virtual CPUs that will be allocated to the server.
type: integer
required:
- OS-FLV-DISABLED:disabled
- OS-FLV-EXT-DATA:ephemeral
- description
- disk
- id
- links
- name
- os-flavor-access:is_public
- ram
- rxtx_factor
- swap
- vcpus
type: object
required:
- flavor
type: object
FlavorUpdateResponse:
additionalProperties: false
properties:
flavor:
additionalProperties: false
description: |-
The ID and links for the flavor for your server instance. A flavor is a combination
of memory, disk size, and CPUs.
properties:
OS-FLV-DISABLED:disabled:
description: |-
Whether or not the flavor has been administratively disabled.
This is an artifact of the legacy v2 API and will always be set to
`false`. There is currently no way to disable a flavor and set this to
`true`.
type: boolean
OS-FLV-EXT-DATA:ephemeral:
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.
type: integer
description:
description: |-
The description of the flavor.
type:
- 'null'
- string
disk:
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 the 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. Volume-backed instances can be enforced for flavors with
zero root disk via the `os_compute_api:servers:create:zero_disk_flavor`
policy rule.
type: integer
extra_specs:
additionalProperties: false
description: |-
A dictionary of the flavor’s extra-specs key-and-value pairs. This will
only be included if the user is allowed by policy to index flavor
extra_specs.
**New in version 2.61**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
id:
description: |-
The ID of the flavor. While people often make this look like
an int, this is really a string.
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
properties:
href:
format: uri
type: string
rel:
type: string
required:
- href
- rel
type: object
type: array
name:
description: |-
The display name of a flavor.
type: string
os-flavor-access:is_public: {}
ram:
description: |-
The amount of RAM a flavor has, in MiB.
type: integer
rxtx_factor: {}
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.
Currently, the empty string (‘’) is used to represent 0.
As of microversion 2.75 default return value of swap is 0
instead of empty string.
type: integer
vcpus:
description: |-
The number of virtual CPUs that will be allocated to the server.
type: integer
required:
- OS-FLV-DISABLED:disabled
- OS-FLV-EXT-DATA:ephemeral
- description
- disk
- id
- links
- name
- os-flavor-access:is_public
- ram
- rxtx_factor
- swap
- vcpus
type: object
required:
- flavor
type: object
FlavorUpdate_255:
additionalProperties: false
properties:
flavor:
additionalProperties: false
description: |-
The ID and links for the flavor for your server instance. A flavor is a combination
of memory, disk size, and CPUs.
properties:
description:
description: |-
A free form description of the flavor. Limited to 65535 characters
in length. Only printable characters are allowed.
maxLength: 65535
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
required:
- description
type: object
required:
- flavor
type: object
x-openstack:
min-ver: '2.55'
FlavorsActionAddtenantaccessResponse:
additionalProperties: true
properties:
flavor_access:
description: |-
A list of objects, each with the keys `flavor_id` and `tenant_id`.
items:
additionalProperties: true
properties:
flavor_id:
description: |-
The ID of the flavor. While people often make this look like
an int, this is really a string.
type: string
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required:
- flavor_id
- tenant_id
type: object
type: array
required:
- flavor_access
type: object
x-openstack:
action-name: addTenantAccess
FlavorsActionRemovetenantaccessResponse:
additionalProperties: true
properties:
flavor_access:
description: |-
A list of objects, each with the keys `flavor_id` and `tenant_id`.
items:
additionalProperties: true
properties:
flavor_id:
description: |-
The ID of the flavor. While people often make this look like
an int, this is really a string.
type: string
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required:
- flavor_id
- tenant_id
type: object
type: array
required:
- flavor_access
type: object
x-openstack:
action-name: removeTenantAccess
FlavorsAction_Add_Tenant_Access:
additionalProperties: false
description: |-
Adds flavor access to a tenant and flavor.
Specify the `addTenantAccess` action and the `tenant` in the request body.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
properties:
addTenantAccess:
additionalProperties: false
description: |-
The action.
properties:
tenant:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
maxLength: 255
minLength: 1
type: string
required:
- tenant
type: object
required:
- addTenantAccess
summary: Add Flavor Access To Tenant (addTenantAccess Action)
type: object
x-openstack:
action-name: addTenantAccess
FlavorsAction_Remove_Tenant_Access:
additionalProperties: false
description: |-
Removes flavor access from a tenant and flavor.
Specify the `removeTenantAccess` action and the `tenant` in the request body.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
properties:
removeTenantAccess:
additionalProperties: false
description: |-
The action.
properties:
tenant:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
maxLength: 255
minLength: 1
type: string
required:
- tenant
type: object
required:
- removeTenantAccess
summary: Remove Flavor Access From Tenant (removeTenantAccess Action)
type: object
x-openstack:
action-name: removeTenantAccess
FlavorsCreateRequest:
oneOf:
- $ref: '#/components/schemas/FlavorsCreate_20'
- $ref: '#/components/schemas/FlavorsCreate_21'
- $ref: '#/components/schemas/FlavorsCreate_255'
x-openstack:
discriminator: microversion
FlavorsCreateResponse:
additionalProperties: false
properties:
flavor:
additionalProperties: false
description: |-
The ID and links for the flavor for your server instance. A flavor is a combination
of memory, disk size, and CPUs.
properties:
OS-FLV-DISABLED:disabled:
description: |-
Whether or not the flavor has been administratively disabled.
This is an artifact of the legacy v2 API and will always be set to
`false`. There is currently no way to disable a flavor and set this to
`true`.
type: boolean
OS-FLV-EXT-DATA:ephemeral:
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.
type: integer
description:
description: |-
The description of the flavor.
**New in version 2.55**
type:
- 'null'
- string
disk:
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 the 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. Volume-backed instances can be enforced for flavors with
zero root disk via the `os_compute_api:servers:create:zero_disk_flavor`
policy rule.
type: integer
extra_specs:
additionalProperties: false
description: |-
A dictionary of the flavor’s extra-specs key-and-value pairs. This will
only be included if the user is allowed by policy to index flavor
extra_specs.
**New in version 2.61**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
id:
description: |-
The ID of the flavor. While people often make this look like
an int, this is really a string.
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
properties:
href:
format: uri
type: string
rel:
type: string
required:
- href
- rel
type: object
type: array
name:
description: |-
The display name of a flavor.
type: string
os-flavor-access:is_public: {}
ram:
description: |-
The amount of RAM a flavor has, in MiB.
type: integer
rxtx_factor: {}
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.
Currently, the empty string (‘’) is used to represent 0.
As of microversion 2.75 default return value of swap is 0
instead of empty string.
type: integer
vcpus:
description: |-
The number of virtual CPUs that will be allocated to the server.
type: integer
required:
- OS-FLV-DISABLED:disabled
- OS-FLV-EXT-DATA:ephemeral
- description
- disk
- id
- links
- name
- os-flavor-access:is_public
- ram
- rxtx_factor
- swap
- vcpus
type: object
required:
- flavor
type: object
FlavorsCreate_20:
additionalProperties: false
properties:
flavor:
additionalProperties: false
description: |-
The ID and links for the flavor for your server instance. A flavor is a combination
of memory, disk size, and CPUs.
properties:
OS-FLV-EXT-DATA:ephemeral:
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.
maximum: 2147483647
minimum: 0
pattern: ^[0-9]+$
type:
- integer
- string
disk:
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.
maximum: 2147483647
minimum: 0
pattern: ^[0-9]+$
type:
- integer
- string
id:
description: |-
Only alphanumeric characters with hyphen ‘-’, underscore ‘_’, spaces
and dots ‘.’ are permitted. If an ID is not provided, then a default UUID
will be assigned.
maxLength: 255
minLength: 1
pattern: ^(?! )[a-zA-Z0-9. _-]+(?<! )$
type:
- 'null'
- number
- string
name:
description: |-
The display name of a flavor.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
os-flavor-access: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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
ram:
description: |-
The number of virtual CPUs that will be allocated to the server.
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
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.
exclusiveMinimum: 0
maximum: 3.40282e+38
pattern: ^[0-9]+(\.[0-9]+)?$
type:
- number
- string
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.
maximum: 2147483647
minimum: 0
pattern: ^[0-9]+$
type:
- integer
- string
vcpus:
description: |-
The number of virtual CPUs that will be allocated to the server.
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
required:
- disk
- name
- ram
- vcpus
type: object
required:
- flavor
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.0'
FlavorsCreate_21:
additionalProperties: false
properties:
flavor:
additionalProperties: false
description: |-
The ID and links for the flavor for your server instance. A flavor is a combination
of memory, disk size, and CPUs.
properties:
OS-FLV-EXT-DATA:ephemeral:
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.
maximum: 2147483647
minimum: 0
pattern: ^[0-9]+$
type:
- integer
- string
disk:
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.
maximum: 2147483647
minimum: 0
pattern: ^[0-9]+$
type:
- integer
- string
id:
description: |-
Only alphanumeric characters with hyphen ‘-’, underscore ‘_’, spaces
and dots ‘.’ are permitted. If an ID is not provided, then a default UUID
will be assigned.
maxLength: 255
minLength: 1
pattern: ^(?! )[a-zA-Z0-9. _-]+(?<! )$
type:
- 'null'
- number
- string
name:
description: |-
The display name of a flavor.
format: name
maxLength: 255
minLength: 1
type: string
os-flavor-access: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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
ram:
description: |-
The number of virtual CPUs that will be allocated to the server.
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
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.
exclusiveMinimum: 0
maximum: 3.40282e+38
pattern: ^[0-9]+(\.[0-9]+)?$
type:
- number
- string
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.
maximum: 2147483647
minimum: 0
pattern: ^[0-9]+$
type:
- integer
- string
vcpus:
description: |-
The number of virtual CPUs that will be allocated to the server.
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
required:
- disk
- name
- ram
- vcpus
type: object
required:
- flavor
type: object
x-openstack:
max-ver: '2.54'
min-ver: '2.1'
FlavorsCreate_255:
additionalProperties: false
properties:
flavor:
additionalProperties: false
description: |-
The ID and links for the flavor for your server instance. A flavor is a combination
of memory, disk size, and CPUs.
properties:
OS-FLV-EXT-DATA:ephemeral:
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.
maximum: 2147483647
minimum: 0
pattern: ^[0-9]+$
type:
- integer
- string
description:
description: |-
A free form description of the flavor. Limited to 65535 characters
in length. Only printable characters are allowed.
**New in version 2.55**
maxLength: 65535
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
disk:
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.
maximum: 2147483647
minimum: 0
pattern: ^[0-9]+$
type:
- integer
- string
id:
description: |-
Only alphanumeric characters with hyphen ‘-’, underscore ‘_’, spaces
and dots ‘.’ are permitted. If an ID is not provided, then a default UUID
will be assigned.
maxLength: 255
minLength: 1
pattern: ^(?! )[a-zA-Z0-9. _-]+(?<! )$
type:
- 'null'
- number
- string
name:
description: |-
The display name of a flavor.
format: name
maxLength: 255
minLength: 1
type: string
os-flavor-access: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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
ram:
description: |-
The number of virtual CPUs that will be allocated to the server.
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
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.
exclusiveMinimum: 0
maximum: 3.40282e+38
pattern: ^[0-9]+(\.[0-9]+)?$
type:
- number
- string
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.
maximum: 2147483647
minimum: 0
pattern: ^[0-9]+$
type:
- integer
- string
vcpus:
description: |-
The number of virtual CPUs that will be allocated to the server.
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
required:
- disk
- name
- ram
- vcpus
type: object
required:
- flavor
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.55'
FlavorsDetailResponse:
additionalProperties: false
properties:
flavors:
description: |-
An array of flavor objects.
items:
additionalProperties: false
properties:
OS-FLV-DISABLED:disabled:
description: |-
Whether or not the flavor has been administratively disabled.
This is an artifact of the legacy v2 API and will always be set to
`false`. There is currently no way to disable a flavor and set this to
`true`.
type: boolean
OS-FLV-EXT-DATA:ephemeral:
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.
type: integer
description:
description: |-
The description of the flavor.
**New in version 2.55**
type:
- 'null'
- string
disk:
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 the 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. Volume-backed instances can be enforced for flavors with
zero root disk via the `os_compute_api:servers:create:zero_disk_flavor`
policy rule.
type: integer
extra_specs:
additionalProperties: false
description: |-
A dictionary of the flavor’s extra-specs key-and-value pairs. This will
only be included if the user is allowed by policy to index flavor
extra_specs.
**New in version 2.61**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
id:
description: |-
The ID of the flavor. While people often make this look like
an int, this is really a string.
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
properties:
href:
format: uri
type: string
rel:
type: string
required:
- href
- rel
type: object
type: array
name:
description: |-
The display name of a flavor.
type: string
os-flavor-access:is_public: {}
ram:
description: |-
The amount of RAM a flavor has, in MiB.
type: integer
rxtx_factor: {}
swap:
anyOf:
- const: ''
- type: integer
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.
Currently, the empty string (‘’) is used to represent 0.
As of microversion 2.75 default return value of swap is 0
instead of empty string.
vcpus:
description: |-
The number of virtual CPUs that will be allocated to the server.
type: integer
required:
- OS-FLV-DISABLED:disabled
- OS-FLV-EXT-DATA:ephemeral
- description
- disk
- id
- links
- name
- os-flavor-access:is_public
- ram
- rxtx_factor
- swap
- vcpus
type: object
type: array
flavors_links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
type: string
required:
- href
- rel
type: object
type: array
required:
- flavors
type: object
FlavorsListResponse:
additionalProperties: false
properties:
flavors:
description: |-
An array of flavor objects.
items:
additionalProperties: false
properties:
description:
description: |-
The description of the flavor.
**New in version 2.55**
type:
- 'null'
- string
id:
description: |-
The ID of the flavor. While people often make this look like
an int, this is really a string.
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
type: string
required:
- href
- rel
type: object
type: array
name:
description: |-
The display name of a flavor.
type: string
required:
- description
- id
- links
- name
type: object
type: array
flavors_links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
type: string
required:
- href
- rel
type: object
type: array
required:
- flavors
type: object
FlavorsOs_Extra_SpecShowResponse:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
FlavorsOs_Extra_SpecUpdate:
additionalProperties: false
maxProperties: 1
minProperties: 1
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- number
- string
type: object
FlavorsOs_Extra_SpecUpdateResponse:
additionalProperties: false
maxProperties: 1
minProperties: 1
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- number
- string
type: object
FlavorsOs_Extra_SpecsCreate:
additionalProperties: false
properties:
extra_specs:
additionalProperties: false
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.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- number
- string
type: object
required:
- extra_specs
type: object
FlavorsOs_Extra_SpecsCreateResponse:
additionalProperties: false
properties:
extra_specs:
additionalProperties: false
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.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- number
- string
type: object
required:
- extra_specs
type: object
FlavorsOs_Extra_SpecsListResponse:
additionalProperties: false
properties:
extra_specs:
additionalProperties: false
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.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- extra_specs
type: object
FlavorsOs_Flavor_AccessListResponse:
additionalProperties: true
properties:
flavor_access:
description: |-
A list of objects, each with the keys `flavor_id` and `tenant_id`.
items:
additionalProperties: true
properties:
flavor_id:
description: |-
The ID of the flavor. While people often make this look like
an int, this is really a string.
type: string
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required:
- flavor_id
- tenant_id
type: object
type: array
required:
- flavor_access
type: object
ImageShowResponse:
additionalProperties: false
properties:
image:
additionalProperties: false
properties:
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.
enum:
- AUTO
- MANUAL
type: string
OS-EXT-IMG-SIZE:size:
description: |-
The size of the image.
type: integer
created:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
id:
description: |-
The ID of the Image.
format: uuid
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
maxItems: 3
minItems: 3
prefixItems:
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: alternate
type:
const: application/vnd.openstack.image
required:
- href
- rel
- type
type: object
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: bookmark
required:
- href
- rel
type: object
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: self
required:
- href
- rel
type: object
type: array
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type:
- array
- boolean
- integer
- 'null'
- number
- object
- string
type: object
minDisk:
description: |-
The minimum amount of disk space an image requires to boot, in GiB. For example, `100`.
minimum: 0
type: integer
minRam:
description: |-
The minimum amount of RAM an image requires to function, in MiB. For example, `512`.
minimum: 0
type: integer
name:
description: |-
The display name of an Image.
type:
- 'null'
- string
progress:
description: |-
A percentage value of the image save progress. This can be one of:
* `ACTIVE`: 100
* `SAVING`: 25 or 50
enum:
- 0
- 100
- 25
- 50
type: integer
server:
additionalProperties: false
description: |-
The server booted from image.
properties:
id:
format: uuid
type: string
links:
maxItems: 2
minItems: 2
prefixItems:
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: bookmark
required:
- href
- rel
type: object
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: self
required:
- href
- rel
type: object
type: array
required:
- id
- links
type: object
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
enum:
- ACTIVE
- DELETED
- ERROR
- SAVING
- UNKNOWN
type: string
updated:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
required:
- OS-EXT-IMG-SIZE:size
- created
- id
- links
- metadata
- minDisk
- minRam
- name
- progress
- status
- updated
type: object
required:
- image
type: object
ImagesDetailResponse:
additionalProperties: false
properties:
images:
description: |-
An array of Image objects.
items:
additionalProperties: false
properties:
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.
enum:
- AUTO
- MANUAL
type: string
OS-EXT-IMG-SIZE:size:
description: |-
The size of the image.
type: integer
created:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
id:
description: |-
The ID of the Image.
format: uuid
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
maxItems: 3
minItems: 3
prefixItems:
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: alternate
type:
const: application/vnd.openstack.image
required:
- href
- rel
- type
type: object
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: bookmark
required:
- href
- rel
type: object
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: self
required:
- href
- rel
type: object
type: array
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
type:
- array
- boolean
- integer
- 'null'
- number
- object
- string
type: object
minDisk:
description: |-
The minimum amount of disk space an image requires to boot, in GiB. For example, `100`.
minimum: 0
type: integer
minRam:
description: |-
The minimum amount of RAM an image requires to function, in MiB. For example, `512`.
minimum: 0
type: integer
name:
description: |-
The display name of an Image.
type:
- 'null'
- string
progress:
description: |-
A percentage value of the image save progress. This can be one of:
* `ACTIVE`: 100
* `SAVING`: 25 or 50
enum:
- 0
- 100
- 25
- 50
type: integer
server:
additionalProperties: false
description: |-
The server booted from image.
properties:
id:
format: uuid
type: string
links:
maxItems: 2
minItems: 2
prefixItems:
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: bookmark
required:
- href
- rel
type: object
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: self
required:
- href
- rel
type: object
type: array
required:
- id
- links
type: object
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
enum:
- ACTIVE
- DELETED
- ERROR
- SAVING
- UNKNOWN
type: string
updated:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
required:
- OS-EXT-IMG-SIZE:size
- created
- id
- links
- metadata
- minDisk
- minRam
- name
- progress
- status
- updated
type: object
type: array
images_links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: next
required:
- href
- rel
type: object
maxItems: 1
minItems: 1
type: array
required:
- images
type: object
ImagesListResponse:
additionalProperties: false
properties:
images:
description: |-
An array of Image objects.
items:
additionalProperties: false
properties:
id:
description: |-
The ID of the Image.
format: uuid
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
maxItems: 3
minItems: 3
prefixItems:
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: alternate
type:
const: application/vnd.openstack.image
required:
- href
- rel
- type
type: object
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: bookmark
required:
- href
- rel
type: object
- additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: self
required:
- href
- rel
type: object
type: array
name:
description: |-
The display name of an Image.
type:
- 'null'
- string
required:
- id
- links
- name
type: object
type: array
images_links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
const: next
required:
- href
- rel
type: object
maxItems: 1
minItems: 1
type: array
required:
- images
type: object
ImagesMetadataCreateResponse:
additionalProperties: false
properties:
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
required:
- metadata
type: object
ImagesMetadataCreate_21:
additionalProperties: false
properties:
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- metadata
type: object
x-openstack:
max-ver: '2.38'
min-ver: '2.1'
ImagesMetadataListResponse:
additionalProperties: false
properties:
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
required:
- metadata
type: object
ImagesMetadataShowResponse:
additionalProperties: false
properties:
meta:
additionalProperties: false
description: |-
The object of detailed key metadata items.
maxProperties: 1
minProperties: 1
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
required:
- meta
type: object
ImagesMetadataUpdateResponse:
additionalProperties: false
properties:
meta:
additionalProperties: false
description: |-
The object of detailed key metadata items.
maxProperties: 1
minProperties: 1
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
required:
- meta
type: object
ImagesMetadataUpdate_21:
additionalProperties: false
properties:
meta:
additionalProperties: false
description: |-
The object of detailed key metadata items.
maxProperties: 1
minProperties: 1
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- meta
type: object
x-openstack:
max-ver: '2.38'
min-ver: '2.1'
ImagesMetadataUpdate_AllResponse:
additionalProperties: false
properties:
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
required:
- metadata
type: object
ImagesMetadataUpdate_All_21:
additionalProperties: false
properties:
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- metadata
type: object
x-openstack:
max-ver: '2.38'
min-ver: '2.1'
LimitsListResponse:
properties:
limits:
description: |-
Data structure that contains both absolute limits within a deployment.
properties:
absolute:
additionalProperties:
type: integer
description: |-
Name/value pairs that set quota limits within a deployment and
Name/value pairs of resource usage.
properties:
maxServerGroupMembers:
description: |-
The number of allowed members for each server group.
type: integer
maxServerGroups:
description: |-
The number of allowed server groups for each tenant.
type: integer
maxServerMetamaxServerMeta:
description: The number of allowed metadata items for each
server.
type: integer
maxTotalCores:
description: |-
The number of allowed server cores for each tenant.
type: integer
maxTotalInstances:
description: |-
The number of allowed servers for each tenant.
type: integer
maxTotalKeypairs:
description: |-
The number of allowed key pairs for each user.
type: integer
maxTotalRAMSize:
description: |-
The amount of allowed server RAM, in MiB, for each tenant.
type: integer
totalCoresUsed:
description: |-
The number of used server cores in each tenant.
If `reserved` query parameter is specified and it is not 0,
the number of reserved server cores are also included.
type: integer
totalInstancesUsed:
description: |-
The number of servers in each tenant.
If `reserved` query parameter is specified and it is not 0,
the number of reserved servers are also included.
type: integer
totalRAMUsed:
description: |-
The amount of used server RAM in each tenant.
If `reserved` query parameter is specified and it is not 0,
the amount of reserved server RAM is also included.
type: integer
totalServerGroupsUsed:
description: |-
The number of used server groups in each tenant.
If `reserved` query parameter is specified and it is not 0,
the number of reserved server groups are also included.
type: integer
type: object
type: object
type: object
Os_AgentUpdateResponse: {}
Os_AgentsCreateResponse: {}
Os_AgentsListResponse: {}
Os_AggregateShowResponse:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
description: |-
The host aggregate object.
properties:
availability_zone:
description: |-
The availability zone of the host aggregate.
type:
- 'null'
- string
created_at:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
deleted:
description: |-
A boolean indicates whether this aggregate is deleted or not, if it has
not been deleted, `false` will appear.
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](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
hosts:
description: |-
An array of host information.
items:
type: string
type:
- array
- 'null'
id:
description: |-
The ID of the host aggregate.
type: integer
metadata:
additionalProperties: true
description: |-
Metadata key and value pairs associated with the aggregate.
properties: {}
type:
- 'null'
- object
name:
description: |-
The name of the host aggregate.
type: string
updated_at:
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](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
uuid:
description: |-
The UUID of the host aggregate.
**New in version 2.41**
format: uuid
type: string
required:
- availability_zone
- created_at
- deleted
- deleted_at
- hosts
- id
- metadata
- name
- updated_at
- uuid
type: object
required:
- aggregate
type: object
Os_AggregateUpdateRequest:
oneOf:
- $ref: '#/components/schemas/Os_AggregateUpdate_20'
- $ref: '#/components/schemas/Os_AggregateUpdate_21'
x-openstack:
discriminator: microversion
Os_AggregateUpdateResponse:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
description: |-
The host aggregate object.
properties:
availability_zone:
description: |-
The availability zone of the host aggregate.
type:
- 'null'
- string
created_at:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
deleted:
description: |-
A boolean indicates whether this aggregate is deleted or not, if it has
not been deleted, `false` will appear.
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](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
hosts:
description: |-
An array of host information.
items:
type: string
type:
- array
- 'null'
id:
description: |-
The ID of the host aggregate.
type: integer
metadata:
additionalProperties: true
description: |-
Metadata key and value pairs associated with the aggregate.
properties: {}
type:
- 'null'
- object
name:
description: |-
The name of the host aggregate.
type: string
updated_at:
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](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
uuid:
description: |-
The UUID of the host aggregate.
**New in version 2.41**
format: uuid
type: string
required:
- availability_zone
- created_at
- deleted
- deleted_at
- hosts
- id
- metadata
- name
- updated_at
- uuid
type: object
required:
- aggregate
type: object
Os_AggregateUpdate_20:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
anyOf:
- required:
- availability_zone
- required:
- name
description: |-
The host aggregate object.
properties:
availability_zone:
description: |-
The availability zone of the host aggregate. You should use a custom
availability zone rather than the default returned by the
os-availability-zone API. The availability zone must not include ‘:’
in its name.
Warning
You should not change or unset the availability zone of an
aggregate when that aggregate has hosts which contain servers in it
since that may impact the ability for those servers to move to another
host.
oneOf:
- type: 'null'
- format: az_name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
name:
description: |-
The name of the host aggregate.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
type: object
required:
- aggregate
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.0'
Os_AggregateUpdate_21:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
anyOf:
- required:
- availability_zone
- required:
- name
description: |-
The host aggregate object.
properties:
availability_zone:
description: |-
The availability zone of the host aggregate. You should use a custom
availability zone rather than the default returned by the
os-availability-zone API. The availability zone must not include ‘:’
in its name.
Warning
You should not change or unset the availability zone of an
aggregate when that aggregate has hosts which contain servers in it
since that may impact the ability for those servers to move to another
host.
oneOf:
- type: 'null'
- format: az_name
maxLength: 255
minLength: 1
type: string
name:
description: |-
The name of the host aggregate.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
type: object
required:
- aggregate
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.1'
Os_AggregatesActionAdd_HostResponse:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
properties:
availability_zone:
type:
- 'null'
- string
created_at:
format: date-time
type: string
deleted:
type: boolean
deleted_at:
format: date-time
type:
- 'null'
- string
hosts:
items:
type: string
type:
- array
- 'null'
id:
type: integer
metadata:
additionalProperties: true
properties: {}
type:
- 'null'
- object
name:
type: string
updated_at:
format: date-time
type:
- 'null'
- string
uuid:
format: uuid
type: string
required:
- availability_zone
- created_at
- deleted
- deleted_at
- hosts
- id
- metadata
- name
- updated_at
- uuid
type: object
required:
- aggregate
type: object
x-openstack:
action-name: add_host
Os_AggregatesActionRemove_HostResponse:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
properties:
availability_zone:
type:
- 'null'
- string
created_at:
format: date-time
type: string
deleted:
type: boolean
deleted_at:
format: date-time
type:
- 'null'
- string
hosts:
items:
type: string
type:
- array
- 'null'
id:
type: integer
metadata:
additionalProperties: true
properties: {}
type:
- 'null'
- object
name:
type: string
updated_at:
format: date-time
type:
- 'null'
- string
uuid:
format: uuid
type: string
required:
- availability_zone
- created_at
- deleted
- deleted_at
- hosts
- id
- metadata
- name
- updated_at
- uuid
type: object
required:
- aggregate
type: object
x-openstack:
action-name: remove_host
Os_AggregatesActionSet_MetadataResponse:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
properties:
availability_zone:
type:
- 'null'
- string
created_at:
format: date-time
type: string
deleted:
type: boolean
deleted_at:
format: date-time
type:
- 'null'
- string
hosts:
items:
type: string
type:
- array
- 'null'
id:
type: integer
metadata:
additionalProperties: true
properties: {}
type:
- 'null'
- object
name:
type: string
updated_at:
format: date-time
type:
- 'null'
- string
uuid:
format: uuid
type: string
required:
- availability_zone
- created_at
- deleted
- deleted_at
- hosts
- id
- metadata
- name
- updated_at
- uuid
type: object
required:
- aggregate
type: object
x-openstack:
action-name: set_metadata
Os_AggregatesAction_Add_Host:
additionalProperties: false
properties:
add_host:
additionalProperties: false
properties:
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
required:
- host
type: object
required:
- add_host
type: object
x-openstack:
action-name: add_host
Os_AggregatesAction_Remove_Host:
additionalProperties: false
properties:
remove_host:
additionalProperties: false
properties:
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
required:
- host
type: object
required:
- remove_host
type: object
x-openstack:
action-name: remove_host
Os_AggregatesAction_Set_Metadata:
additionalProperties: false
properties:
set_metadata:
additionalProperties: false
properties:
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
required:
- metadata
type: object
required:
- set_metadata
type: object
x-openstack:
action-name: set_metadata
Os_AggregatesCreateRequest:
oneOf:
- $ref: '#/components/schemas/Os_AggregatesCreate_20'
- $ref: '#/components/schemas/Os_AggregatesCreate_21'
x-openstack:
discriminator: microversion
Os_AggregatesCreateResponse:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
description: |-
The host aggregate object.
properties:
availability_zone:
description: |-
The availability zone of the host aggregate.
type:
- 'null'
- string
created_at:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
deleted:
description: |-
A boolean indicates whether this aggregate is deleted or not, if it has
not been deleted, `false` will appear.
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](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
id:
description: |-
The ID of the host aggregate.
type: integer
name:
description: |-
The name of the host aggregate.
type: string
updated_at:
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](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
uuid:
description: |-
The UUID of the host aggregate.
**New in version 2.41**
format: uuid
type: string
required:
- availability_zone
- created_at
- deleted
- deleted_at
- id
- name
- updated_at
- uuid
type: object
required:
- aggregate
type: object
Os_AggregatesCreate_20:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
description: |-
The host aggregate object.
properties:
availability_zone:
description: |-
The availability zone of the host aggregate. You should use a custom
availability zone rather than the default returned by the
os-availability-zone API. The availability zone must not include ‘:’
in its name.
oneOf:
- type: 'null'
- format: az_name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
name:
description: |-
The name of the host aggregate.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
required:
- aggregate
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.0'
Os_AggregatesCreate_21:
additionalProperties: false
properties:
aggregate:
additionalProperties: false
description: |-
The host aggregate object.
properties:
availability_zone:
description: |-
The availability zone of the host aggregate. You should use a custom
availability zone rather than the default returned by the
os-availability-zone API. The availability zone must not include ‘:’
in its name.
oneOf:
- type: 'null'
- format: az_name
maxLength: 255
minLength: 1
type: string
name:
description: |-
The name of the host aggregate.
format: name
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
required:
- aggregate
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.1'
Os_AggregatesImagesImages_281:
additionalProperties: false
properties:
cache:
description: |-
A list of image objects to cache.
items:
additionalProperties: false
properties:
id:
format: uuid
type: string
required:
- id
type: object
minItems: 1
type:
- array
required:
- cache
type: object
x-openstack:
min-ver: '2.81'
Os_AggregatesImagesResponse:
type: 'null'
Os_AggregatesListResponse:
additionalProperties: false
properties:
aggregates:
description: |-
The list of existing aggregates.
items:
additionalProperties: false
properties:
availability_zone:
description: |-
The availability zone of the host aggregate.
type:
- 'null'
- string
created_at:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
deleted:
description: |-
A boolean indicates whether this aggregate is deleted or not, if it has
not been deleted, `false` will appear.
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](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
hosts:
description: |-
A list of host ids in this aggregate.
items:
type: string
type:
- array
- 'null'
id:
description: |-
The ID of the host aggregate.
type: integer
metadata:
additionalProperties: true
description: |-
Metadata key and value pairs associated with the aggregate.
properties: {}
type:
- 'null'
- object
name:
description: |-
The name of the host aggregate.
type: string
updated_at:
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](https://en.wikipedia.org/wiki/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`.
format: date-time
type:
- 'null'
- string
uuid:
description: |-
The UUID of the host aggregate.
**New in version 2.41**
format: uuid
type: string
required:
- availability_zone
- created_at
- deleted
- deleted_at
- hosts
- id
- metadata
- name
- updated_at
- uuid
type: object
type: array
required:
- aggregates
type: object
Os_Assisted_Volume_SnapshotsCreate:
additionalProperties: false
properties:
snapshot:
additionalProperties: false
description: |-
A partial representation of a snapshot that is used to create a snapshot.
properties:
create_info:
additionalProperties: false
description: |-
Information for snapshot creation.
properties:
id:
description: |-
Its an arbitrary string that gets passed back to the user.
minLength: 1
type: string
new_file:
description: |-
The name of the qcow2 file that Block Storage creates, which becomes the active
image for the VM.
minLength: 1
type: string
snapshot_id:
description: |-
The UUID for a snapshot.
minLength: 1
type: string
type:
description: |-
The snapshot type. A valid value is `qcow2`.
enum:
- qcow2
type: string
required:
- new_file
- snapshot_id
- type
type: object
volume_id:
description: |-
The source volume ID.
minLength: 1
type: string
required:
- create_info
- volume_id
type: object
required:
- snapshot
type: object
Os_Assisted_Volume_SnapshotsCreateResponse:
additionalProperties: false
properties:
snapshot:
additionalProperties: false
description: |-
A partial representation of a snapshot that is used to create a snapshot.
properties:
id:
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.
format: uuid
type:
- 'null'
- string
volumeId:
description: |-
The source volume ID.
format: uuid
type: string
required:
- id
- volumeId
type: object
required:
- snapshot
type: object
Os_Availability_ZoneDetailResponse:
properties:
availabilityZoneInfo:
description: |-
The list of availability zone information.
items:
properties:
hosts:
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`.
examples:
- conductor:
nova-conductor:
active: true
available: true
updated_at:
scheduler:
nova-scheduler:
active: true
available: true
updated_at:
type: object
zoneName:
description: |-
The availability zone name.
type: string
zoneState:
description: |-
The current state of the availability zone.
properties:
available:
description: |-
Returns true if the availability zone is available.
type: boolean
type: object
required:
- zoneName
- zoneState
type: object
type: array
required:
- availabilityZoneInfo
type: object
Os_Availability_ZoneListResponse:
properties:
availabilityZoneInfo:
description: |-
The list of availability zone information.
items:
properties:
hosts:
description: |-
It is always `null`.
type: 'null'
zoneName:
description: |-
The availability zone name.
type: string
zoneState:
description: |-
The current state of the availability zone.
properties:
available:
description: |-
Returns true if the availability zone is available.
type: boolean
type: object
required:
- zoneName
- zoneState
type: object
type: array
required:
- availabilityZoneInfo
type: object
Os_Baremetal_NodeShowResponse:
additionalProperties: false
properties:
node:
additionalProperties: false
description: |-
A baremetal node object.
properties:
cpus:
description: |-
Number of CPUs the node has.
Note
This is a JSON string, even though it will look like an int value.
type: string
disk_gb:
description: |-
Amount of disk in GiB the node has.
Note
This is a JSON string, even though it will look like an int value.
type: string
host:
const: IRONIC MANAGED
description: |-
This will always have the value `IRONIC MANAGED`.
id:
description: |-
UUID of the baremetal node.
format: uuid
type: string
instance_uuid:
description: |-
UUID of the server instance on this node.
format: uuid
type: string
interfaces:
description: |-
A list of interface objects for active interfaces on the baremetal
node. Each will have an `address` field with the address.
items:
properties:
address:
type: string
type: object
type: array
memory_mb:
description: |-
Amount of memory in MiB the node has.
Note
This is a JSON string, even though it will look like an int value.
type: string
task_state:
description: |-
The Ironic task state for the node. See Ironic project for more
details.
type: string
required:
- cpus
- disk_gb
- host
- id
- instance_uuid
- interfaces
- memory_mb
- task_state
type: object
required:
- node
type: object
Os_Baremetal_NodesActionAdd_InterfaceRequest:
description: Empty body for add_interface action
properties:
add_interface:
type: 'null'
type: object
x-openstack:
action-name: add_interface
Os_Baremetal_NodesActionAdd_InterfaceResponse:
type: 'null'
x-openstack:
action-name: add_interface
Os_Baremetal_NodesActionRemove_InterfaceRequest:
description: Empty body for remove_interface action
properties:
remove_interface:
type: 'null'
type: object
x-openstack:
action-name: remove_interface
Os_Baremetal_NodesActionRemove_InterfaceResponse:
type: 'null'
x-openstack:
action-name: remove_interface
Os_Baremetal_NodesCreateResponse:
type: 'null'
Os_Baremetal_NodesListResponse:
additionalProperties: false
properties:
nodes:
description: |-
An array of baremetal node objects.
items:
additionalProperties: false
properties:
cpus:
description: |-
Number of CPUs the node has.
Note
This is a JSON string, even though it will look like an int value.
type: string
disk_gb:
description: |-
Amount of disk in GiB the node has.
Note
This is a JSON string, even though it will look like an int value.
type: string
host:
const: IRONIC MANAGED
description: |-
This will always have the value `IRONIC MANAGED`.
id:
description: |-
UUID of the baremetal node.
format: uuid
type: string
interfaces:
description: |-
A list of interface objects for active interfaces on the baremetal
node. Each will have an `address` field with the address.
items:
properties:
address:
type: string
type: object
type: array
memory_mb:
description: |-
Amount of memory in MiB the node has.
Note
This is a JSON string, even though it will look like an int value.
type: string
task_state:
description: |-
The Ironic task state for the node. See Ironic project for more
details.
type: string
required:
- cpus
- disk_gb
- host
- id
- interfaces
- memory_mb
- task_state
type: object
type: array
required:
- nodes
type: object
Os_CellShowResponse: {}
Os_CellUpdateResponse: {}
Os_CellsCapacitiesResponse: {}
Os_CellsCreateResponse: {}
Os_CellsDetailResponse: {}
Os_CellsInfoResponse: {}
Os_CellsListResponse: {}
Os_CellsSync_InstancesResponse: {}
Os_CertificateShowResponse: {}
Os_CertificatesCreateResponse: {}
Os_CloudpipeCreateResponse: {}
Os_CloudpipeListResponse: {}
Os_CloudpipeUpdateResponse: {}
Os_Console_Auth_TokenShowResponse:
description: Show Console Connection Information Response
properties:
console:
description: |-
The console object.
properties:
host:
description: |-
The name or ID of the host.
type: string
instance_uuid:
description: |-
The UUID of the server.
format: uuid
type: string
internal_access_path:
description: |-
The id representing the internal access path.
type: string
port:
description: |-
The port number.
type: integer
required:
- instance_uuid
- port
type: object
required:
- console
type: object
Os_Fixed_IpShowResponse: {}
Os_Fixed_IpsActionReserveRequest:
description: Empty body for reserve action
properties:
reserve:
type: 'null'
type: object
x-openstack:
action-name: reserve
Os_Fixed_IpsActionReserveResponse:
x-openstack:
action-name: reserve
Os_Fixed_IpsActionUnreserveRequest:
description: Empty body for unreserve action
properties:
unreserve:
type: 'null'
type: object
x-openstack:
action-name: unreserve
Os_Fixed_IpsActionUnreserveResponse:
x-openstack:
action-name: unreserve
Os_Floating_IpShowResponse:
additionalProperties: false
properties:
floating_ip:
additionalProperties: false
description: |-
A floating IP address object.
properties:
fixed_ip:
anyOf:
- format: ipv4
- format: ipv6
description: |-
Fixed IP associated with floating IP network.
type:
- 'null'
- string
id:
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.
format: uuid
type: string
instance_id:
description: |-
The UUID of the server.
format: uuid
type:
- 'null'
- string
ip:
anyOf:
- format: ipv4
- format: ipv6
description: |-
The floating ip address.
type: string
pool:
description: |-
The name or ID of the floating IP pool.
type: string
required:
- fixed_ip
- id
- instance_id
- ip
- pool
type: object
required:
- floating_ip
type: object
Os_Floating_Ip_DnUpdateResponse: {}
Os_Floating_Ip_DnsEntryShowResponse: {}
Os_Floating_Ip_DnsEntryUpdateResponse: {}
Os_Floating_Ip_DnsListResponse: {}
Os_Floating_Ip_PoolsListResponse:
additionalProperties: true
properties:
floating_ip_pools:
description: |-
The `floating_ip_pools` object.
items:
additionalProperties: false
properties:
name:
description: |-
The name or ID of the floating IP pool.
type: string
required:
- name
type: object
type: array
required:
- floating_ip_pools
type: object
Os_Floating_IpsCreateResponse:
additionalProperties: false
properties:
floating_ip:
additionalProperties: false
description: |-
A floating IP address object.
properties:
fixed_ip:
anyOf:
- format: ipv4
- format: ipv6
description: |-
Fixed IP associated with floating IP network.
type:
- 'null'
- string
id:
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.
format: uuid
type: string
instance_id:
description: |-
The UUID of the server.
format: uuid
type:
- 'null'
- string
ip:
anyOf:
- format: ipv4
- format: ipv6
description: |-
The floating ip address.
type: string
pool:
description: |-
The name or ID of the floating IP pool.
type: string
required:
- fixed_ip
- id
- instance_id
- ip
- pool
type: object
required:
- floating_ip
type: object
Os_Floating_IpsListResponse:
additionalProperties: false
properties:
floating_ips:
description: |-
An array of floating ip objects.
items:
additionalProperties: false
description: |-
A floating IP address object.
properties:
fixed_ip:
anyOf:
- format: ipv4
- format: ipv6
description: |-
Fixed IP associated with floating IP network.
type:
- 'null'
- string
id:
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.
format: uuid
type: string
instance_id:
description: |-
The UUID of the server.
format: uuid
type:
- 'null'
- string
ip:
anyOf:
- format: ipv4
- format: ipv6
description: |-
The floating ip address.
type: string
pool:
description: |-
The name or ID of the floating IP pool.
type: string
required:
- fixed_ip
- id
- instance_id
- ip
- pool
type: object
type: array
required:
- floating_ips
type: object
Os_Floating_Ips_BulkCreateResponse: {}
Os_Floating_Ips_BulkListResponse: {}
Os_Floating_Ips_BulkShowResponse: {}
Os_Floating_Ips_BulkUpdateResponse: {}
Os_FpingListResponse: {}
Os_FpingShowResponse: {}
Os_HostShowResponse:
additionalProperties: false
properties:
host:
description: |-
The array that includes resource info of the host.
items:
additionalProperties: false
properties:
resource:
additionalProperties: false
description: |-
The resource info of the host.
properties:
cpu:
description: |-
The number of virtual CPUs on the host.
type: integer
disk_gb:
description: |-
The disk size on the host (in GiB).
type: integer
host:
description: |-
The name of the host.
type: string
memory_mb:
description: |-
The memory size on the host (in MiB).
type: integer
project:
description: |-
The project id (or special name like total, used_now, used_max).
type: string
required:
- cpu
- disk_gb
- host
- memory_mb
- project
type: object
required:
- resource
type: object
type: array
required:
- host
type: object
Os_HostUpdateResponse:
additionalProperties: false
properties:
host:
description: |-
The name of the host.
type: string
maintenance_mode:
description: |-
Mode of maintenance state, either `on_maintenance` or
`off_maintenance`.
enum:
- off_maintenance
- on_maintenance
status:
description: |-
The status of the current host, either `enabled` or `disabled`.
enum:
- disabled
- enabled
required:
- host
type: object
Os_HostUpdate_21:
additionalProperties: false
anyOf:
- required:
- maintenance_mode
- required:
- status
properties:
maintenance_mode:
description: |-
Mode of maintenance state, either `enable` or `disable`.
enum:
- DISABLE
- Disable
- ENABLE
- Enable
- disable
- enable
type: string
status:
description: |-
The status of the host, either `enable` or `disable`.
enum:
- DISABLE
- Disable
- ENABLE
- Enable
- disable
- enable
type: string
type: object
x-openstack:
max-ver: '2.42'
min-ver: '2.1'
Os_HostsListResponse:
additionalProperties: false
properties:
hosts:
description: |-
An array of host information.
items:
additionalProperties: false
properties:
host_name:
description: |-
The name of the host.
type: string
service:
description: |-
The name of the service which is running on the host.
type: string
zone:
description: |-
The available zone of the host.
type: string
required:
- host_name
- service
- zone
type: object
type: array
required:
- hosts
type: object
Os_HostsRebootResponse:
additionalProperties: false
properties:
host:
description: |-
The name of the host.
type: string
power_action: {}
required:
- host
- power_action
type: object
Os_HostsShutdownResponse:
additionalProperties: false
properties:
host:
description: |-
The name of the host.
type: string
power_action: {}
required:
- host
- power_action
type: object
Os_HostsStartupResponse:
additionalProperties: false
properties:
host:
description: |-
The name of the host.
type: string
power_action: {}
required:
- host
- power_action
type: object
Os_HypervisorShowResponse:
properties:
hypervisor:
description: |-
The hypervisor object.
properties:
cpu_info:
additionalProperties: true
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.
**Available until version 2.87**
type: object
x-openstack:
max-ver: '2.87'
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).
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
disk_available_least:
description: |-
The actual free disk on this hypervisor(in GiB). If allocation ratios used
for overcommit are configured, this may be negative. This is intentional as
it provides insight into the amount by which the disk is overcommitted.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
free_disk_gb:
description: |-
The free disk remaining on this hypervisor(in GiB). This does not take
allocation ratios used for overcommit into account so this value may be
negative.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
free_ram_mb:
description: |-
The free RAM in this hypervisor(in MiB). This does not take allocation
ratios used for overcommit into account so this value may be negative.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
host_ip:
description: |-
The IP address of the hypervisor’s host.
format: ip
type: string
hypervisor_hostname:
description: |-
The hypervisor host name provided by the Nova virt driver. For the Ironic
driver, it is the Ironic node uuid.
type: string
hypervisor_type:
description: |-
The hypervisor type.
type: string
hypervisor_version:
description: |-
The hypervisor version.
type: integer
id:
description: The id of the hypervisor. From version 2.53 it is a
string as UUID
type: string
local_gb:
description: |-
The disk in this hypervisor (in GiB). This does not take allocation
ratios used for overcommit into account so there may be disparity between
this and the used count.
**Available until version 2.87**
type: integer
x-openstack:
description: The disk in this hypervisor (in GiB). This does not
take allocation ratios used for overcommit into account so
there may be disparity between this and the used count.
max-ver: '2.87'
local_gb_used:
description: |-
The disk used in this hypervisor (in GiB).
**Available until version 2.87**
type: integer
x-openstack:
description: The disk used in this hypervisor (in GiB).
max-ver: '2.87'
memory_mb:
description: |-
The memory of this hypervisor (in MiB). This does not take allocation
ratios used for overcommit into account so there may be disparity between
this and the used count.
**Available until version 2.87**
type: integer
x-openstack:
description: The memory of this hypervisor (in MiB). This does
not take allocation ratios used for overcommit into account so
there may be disparity between this and the used count.
max-ver: '2.87'
memory_mb_used:
description: |-
The memory used in this hypervisor (in MiB).
**Available until version 2.87**
type: integer
x-openstack:
description: The memory used in this hypervisor (in MiB).
max-ver: '2.87'
running_vms:
description: |-
The number of running VMs on this hypervisor.
**Available until version 2.87**
type: integer
x-openstack:
description: 'The number of running VMs on this hypervisor. '
max-ver: '2.87'
servers:
description: |-
A list of `server` objects. Before microversion 2.75, this field is only
returned if non-empty. From microversion 2.75, this field will always be
returned unless the `with_servers` query parameter is provided and is
set to `false`.
**New in version 2.53**
items:
properties:
name:
description: The server name.
type: string
uuid:
description: The server ID.
format: uuid
type: string
required:
- name
- uuid
type: object
type: array
x-openstack:
min-ver: '2.53'
service:
description: |-
The hypervisor service object.
properties:
disabled_reason:
description: |-
The disable reason of the service, `null` if the service is enabled or
disabled without reason provided.
type:
- 'null'
- string
host:
description: |-
The name of the host.
type: string
id:
description: |-
The id of the service as a uuid.
**New in version 2.53**
format: uuid
type:
- integer
- string
type: object
state:
description: |-
The state of the hypervisor. One of `up` or `down`.
enum:
- down
- up
type: string
status:
description: |-
The status of the hypervisor. One of `enabled` or `disabled`.
enum:
- disabled
- enabled
type: string
uptime:
description: |-
The response format of this api depends on the virt driver in use on a
given host. The libvirt driver returns the output of the uptime command
directly, the z/VM driver returns the ILP time. All other drivers
always return null. Note this value is cached and updated periodically.
**New in version 2.88**
type: string
x-openstack:
min-ver: '2.87'
vcpus:
description: |-
The number of vCPU in this hypervisor. This does not take allocation
ratios used for overcommit into account so there may be disparity between
this and the used count.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
vcpus_used:
description: |-
The number of vCPU used in this hypervisor.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
type: object
type: object
Os_HypervisorsDetailResponse:
properties:
hypervisor_links:
description: |-
Links pertaining to usage. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
**New in version 2.40**
items:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
hypervisors:
description: |-
An array of hypervisor information.
items:
description: The hypervisor object.
properties:
cpu_info:
additionalProperties: true
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.
**Available until version 2.87**
type: object
x-openstack:
max-ver: '2.87'
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).
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
disk_available_least:
description: |-
The actual free disk on this hypervisor(in GiB). If allocation ratios used
for overcommit are configured, this may be negative. This is intentional as
it provides insight into the amount by which the disk is overcommitted.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
free_disk_gb:
description: |-
The free disk remaining on this hypervisor(in GiB). This does not take
allocation ratios used for overcommit into account so this value may be
negative.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
free_ram_mb:
description: |-
The free RAM in this hypervisor(in MiB). This does not take allocation
ratios used for overcommit into account so this value may be negative.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
host_ip:
description: |-
The IP address of the hypervisor’s host.
format: ip
type: string
hypervisor_hostname:
description: |-
The hypervisor host name provided by the Nova virt driver. For the Ironic
driver, it is the Ironic node uuid.
type: string
hypervisor_type:
description: |-
The hypervisor type.
type: string
hypervisor_version:
description: |-
The hypervisor version.
type: integer
id:
description: The id of the hypervisor. From version 2.53 it is a
string as UUID
type: string
local_gb:
description: |-
The disk in this hypervisor (in GiB). This does not take allocation
ratios used for overcommit into account so there may be disparity between
this and the used count.
**Available until version 2.87**
type: integer
x-openstack:
description: The disk in this hypervisor (in GiB). This does
not take allocation ratios used for overcommit into account
so there may be disparity between this and the used count.
max-ver: '2.87'
local_gb_used:
description: |-
The disk used in this hypervisor (in GiB).
**Available until version 2.87**
type: integer
x-openstack:
description: The disk used in this hypervisor (in GiB).
max-ver: '2.87'
memory_mb:
description: |-
The memory of this hypervisor (in MiB). This does not take allocation
ratios used for overcommit into account so there may be disparity between
this and the used count.
**Available until version 2.87**
type: integer
x-openstack:
description: The memory of this hypervisor (in MiB). This does
not take allocation ratios used for overcommit into account
so there may be disparity between this and the used count.
max-ver: '2.87'
memory_mb_used:
description: |-
The memory used in this hypervisor (in MiB).
**Available until version 2.87**
type: integer
x-openstack:
description: The memory used in this hypervisor (in MiB).
max-ver: '2.87'
running_vms:
description: |-
The number of running VMs on this hypervisor.
**Available until version 2.87**
type: integer
x-openstack:
description: 'The number of running VMs on this hypervisor. '
max-ver: '2.87'
servers:
description: |-
A list of `server` objects. Before microversion 2.75, this field is only
returned if non-empty. From microversion 2.75, this field will always be
returned unless the `with_servers` query parameter is provided and is
set to `false`.
**New in version 2.53**
items:
properties:
name:
description: The server name.
type: string
uuid:
description: The server ID.
format: uuid
type: string
required:
- name
- uuid
type: object
type: array
x-openstack:
min-ver: '2.53'
service:
description: |-
The hypervisor service object.
properties:
disabled_reason:
description: |-
The disable reason of the service, `null` if the service is enabled or
disabled without reason provided.
type:
- 'null'
- string
host:
description: |-
The name of the host.
type: string
id:
description: |-
The id of the service as a uuid.
**New in version 2.53**
format: uuid
type:
- integer
- string
type: object
state:
description: |-
The state of the hypervisor. One of `up` or `down`.
enum:
- down
- up
type: string
status:
description: |-
The status of the hypervisor. One of `enabled` or `disabled`.
enum:
- disabled
- enabled
type: string
uptime:
description: |-
The response format of this api depends on the virt driver in use on a
given host. The libvirt driver returns the output of the uptime command
directly, the z/VM driver returns the ILP time. All other drivers
always return null. Note this value is cached and updated periodically.
**New in version 2.88**
type: string
x-openstack:
min-ver: '2.87'
vcpus:
description: |-
The number of vCPU in this hypervisor. This does not take allocation
ratios used for overcommit into account so there may be disparity between
this and the used count.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
vcpus_used:
description: |-
The number of vCPU used in this hypervisor.
**Available until version 2.87**
type: integer
x-openstack:
max-ver: '2.87'
type: object
type: array
required:
- hypervisors
type: object
Os_HypervisorsListResponse:
properties:
hypervisor_links:
description: |-
Links pertaining to usage. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
**New in version 2.40**
items:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
hypervisors:
description: |-
An array of hypervisor information.
items:
description: The hypervisor object.
properties:
hypervisor_hostname:
description: |-
The hypervisor host name provided by the Nova virt driver. For the Ironic
driver, it is the Ironic node uuid.
type: string
id:
description: |-
The id of the hypervisor as a UUID.
**New in version 2.53**
type: string
servers:
description: |-
A list of `server` objects. Before microversion 2.75, this field is only
returned if non-empty. From microversion 2.75, this field will always be
returned unless the `with_servers` query parameter is provided and is
set to `false`.
**New in version 2.53**
items:
properties:
name:
description: The server name.
type: string
uuid:
description: The server ID.
format: uuid
type: string
required:
- name
- uuid
type: object
type: array
x-openstack:
min-ver: '2.53'
state:
description: |-
The state of the hypervisor. One of `up` or `down`.
enum:
- down
- up
type: string
status:
description: |-
The status of the hypervisor. One of `enabled` or `disabled`.
enum:
- disabled
- enabled
type: string
required:
- hypervisor_hostname
- id
- servers
- state
type: object
type: array
required:
- hypervisors
type: object
Os_HypervisorsSearchResponse:
additionalProperties: false
properties:
hypervisors:
description: |-
An array of hypervisor information.
items:
additionalProperties: false
properties:
hypervisor_hostname:
description: |-
The hypervisor host name provided by the Nova virt driver. For the Ironic
driver, it is the Ironic node uuid.
type: string
id:
description: |-
The id of the hypervisor.
type: integer
state:
description: |-
The state of the hypervisor. One of `up` or `down`.
enum:
- down
- up
status:
description: |-
The status of the hypervisor. One of `enabled` or `disabled`.
enum:
- disabled
- enabled
required:
- hypervisor_hostname
- id
- state
- status
type: object
type: array
required:
- hypervisors
type: object
Os_HypervisorsServersResponse:
additionalProperties: false
properties:
hypervisors:
description: |-
An array of hypervisor information.
items:
additionalProperties: false
properties:
hypervisor_hostname:
description: |-
The hypervisor host name provided by the Nova virt driver. For the Ironic
driver, it is the Ironic node uuid.
type: string
id:
description: |-
The id of the hypervisor.
type: integer
servers:
description: |-
A list of `server` objects.
items:
additionalProperties: false
properties:
name:
type: string
uuid:
format: uuid
type: string
required:
- name
- uuid
type: object
type: array
state:
description: |-
The state of the hypervisor. One of `up` or `down`.
enum:
- down
- up
status:
description: |-
The status of the hypervisor. One of `enabled` or `disabled`.
enum:
- disabled
- enabled
required:
- hypervisor_hostname
- id
- state
- status
type: object
type: array
required:
- hypervisors
type: object
Os_HypervisorsStatisticsResponse:
additionalProperties: false
properties:
hypervisor_statistics:
additionalProperties: false
description: |-
The hypervisors statistics summary object.
properties:
count:
description: |-
The number of hypervisors.
type: integer
current_workload:
description: |-
The current_workload is the number of tasks the hypervisors are responsible
for. This will be equal or greater than the number of active VMs on the
systems (it can be greater when VMs are being deleted and a hypervisor is
still cleaning up).
type:
- integer
- 'null'
disk_available_least:
description: |-
The actual free disk on all hypervisors(in GiB). If allocation ratios used
for overcommit are configured, this may be negative. This is intentional as
it provides insight into the amount by which the disk is overcommitted.
type:
- integer
- 'null'
free_disk_gb:
description: |-
The free disk remaining on all hypervisors(in GiB). This does not take
allocation ratios used for overcommit into account so this value may be
negative.
type:
- integer
- 'null'
free_ram_mb:
description: |-
The free RAM on all hypervisors(in MiB). This does not take allocation
ratios used for overcommit into account so this value may be negative.
type:
- integer
- 'null'
local_gb:
description: |-
The disk on all hypervisors (in GiB). This does not take allocation
ratios used for overcommit into account so there may be disparity between
this and the used count.
type: integer
local_gb_used:
description: |-
The disk used on all hypervisors (in GiB).
type: integer
memory_mb:
description: |-
The memory of all hypervisors (in MiB). This does not take allocation
ratios used for overcommit into account so there may be disparity between
this and the used count.
type: integer
memory_mb_used:
description: |-
The memory used on all hypervisors(in MiB).
type: integer
running_vms:
description: |-
The total number of running VMs on all hypervisors.
type:
- integer
- 'null'
vcpus:
description: |-
The number of vCPU on all hypervisors. This does not take allocation
ratios used for overcommit into account so there may be disparity between
this and the used count.
type: integer
vcpus_used:
description: |-
The number of vCPU used on all hypervisors.
type: integer
required:
- count
- current_workload
- disk_available_least
- free_disk_gb
- free_ram_mb
- local_gb
- local_gb_used
- memory_mb
- memory_mb_used
- running_vms
- vcpus
- vcpus_used
type: object
required:
- hypervisor_statistics
type: object
Os_HypervisorsUptimeResponse:
additionalProperties: false
properties:
hypervisor:
additionalProperties: false
description: |-
The hypervisor object.
properties:
hypervisor_hostname:
description: |-
The hypervisor host name provided by the Nova virt driver. For the Ironic
driver, it is the Ironic node uuid.
type: string
id:
description: |-
The id of the hypervisor as a UUID.
**New in version 2.53**
format: uuid
type: string
servers:
items:
additionalProperties: false
properties:
name:
type: string
uuid:
format: uuid
type: string
required:
- name
- uuid
type: object
type: array
state:
description: |-
The state of the hypervisor. One of `up` or `down`.
enum:
- down
- up
status:
description: |-
The status of the hypervisor. One of `enabled` or `disabled`.
enum:
- disabled
- enabled
uptime:
description: |-
The total uptime of the hypervisor and information about average
load.
type:
- 'null'
- string
required:
- hypervisor_hostname
- id
- state
- status
- uptime
type: object
required:
- hypervisor
type: object
Os_Instance_Usage_Audit_LogListResponse:
description: The object of instance usage audit log information.
properties:
errors:
description: |-
The number of errors.
type: integer
hosts_not_run:
description: |-
A list of the hosts whose instance audit tasks have not run.
items:
type: string
type: array
instances:
description: |-
The number of instances.
type: integer
log:
description: |-
The object of instance usage audit logs.
type: object
message:
description: |-
The log message of the instance usage audit task.
type: string
num_hosts:
description: |-
The number of the hosts.
type: integer
num_hosts_done:
description: |-
The number of the hosts whose instance audit tasks have been done.
type: integer
num_hosts_not_run:
description: |-
The number of the hosts whose instance audit tasks have not run.
type: integer
num_hosts_running:
description: |-
The number of the hosts whose instance audit tasks are running.
type: integer
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.
```
type: string
period_beginning:
description: |-
The beginning time of the instance usage audit period.
For example, `2016-05-01 00:00:00`.
format: date-time
type: string
period_ending:
description: |-
The ending time of the instance usage audit period.
For example, `2016-06-01 00:00:00`.
format: date-time
type: string
state:
description: |-
The state of the instance usage audit task.
`DONE` or `RUNNING`.
enum:
- DONE
- RUNNING
type: string
total_errors:
description: |-
The total number of instance audit task errors.
type: integer
total_instances:
description: |-
The total number of VM instances in the period.
type: integer
type: object
Os_Instance_Usage_Audit_LogShowResponse:
description: The object of instance usage audit log information.
properties:
errors:
description: |-
The number of errors.
type: integer
hosts_not_run:
description: |-
A list of the hosts whose instance audit tasks have not run.
items:
type: string
type: array
instances:
description: |-
The number of instances.
type: integer
log:
description: |-
The object of instance usage audit logs.
type: object
message:
description: |-
The log message of the instance usage audit task.
type: string
num_hosts:
description: |-
The number of the hosts.
type: integer
num_hosts_done:
description: |-
The number of the hosts whose instance audit tasks have been done.
type: integer
num_hosts_not_run:
description: |-
The number of the hosts whose instance audit tasks have not run.
type: integer
num_hosts_running:
description: |-
The number of the hosts whose instance audit tasks are running.
type: integer
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.
```
type: string
period_beginning:
description: |-
The beginning time of the instance usage audit period.
For example, `2016-05-01 00:00:00`.
format: date-time
type: string
period_ending:
description: |-
The ending time of the instance usage audit period.
For example, `2016-06-01 00:00:00`.
format: date-time
type: string
state:
description: |-
The state of the instance usage audit task.
`DONE` or `RUNNING`.
enum:
- DONE
- RUNNING
type: string
total_errors:
description: |-
The total number of instance audit task errors.
type: integer
total_instances:
description: |-
The total number of VM instances in the period.
type: integer
type: object
Os_KeypairShowResponse:
description: Keypair object
properties:
keypair:
description: |-
Keypair object
properties:
fingerprint:
description: |-
The fingerprint for the keypair.
type: string
id:
description: |-
The keypair ID.
type: integer
name:
description: |-
The name for the keypair.
type: string
public_key:
description: |-
The keypair public key.
type: string
type:
description: |-
The type of the keypair. Allowed values are `ssh` or `x509`.
**New in version 2.2**
type: string
x-openstack:
min-ver: '2.2'
required:
- fingerprint
- id
- name
- public_key
- type
- user_id
type: object
required:
- keypair
type: object
Os_KeypairsCreateRequest:
oneOf:
- $ref: '#/components/schemas/Os_KeypairsCreate_20'
- $ref: '#/components/schemas/Os_KeypairsCreate_21'
- $ref: '#/components/schemas/Os_KeypairsCreate_210'
- $ref: '#/components/schemas/Os_KeypairsCreate_22'
- $ref: '#/components/schemas/Os_KeypairsCreate_292'
x-openstack:
discriminator: microversion
Os_KeypairsCreateResponse:
description: Keypair object
properties:
keypair:
description: |-
Keypair object
properties:
fingerprint:
description: |-
The fingerprint for the keypair.
type: string
name:
description: |-
The name for the keypair.
type: string
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.
**Available until version 2.91**
type: string
x-openstack:
max-ver: '2.91'
public_key:
description: |-
The keypair public key.
type: string
type:
description: |-
The type of the keypair. Allowed values are `ssh` or `x509`.
**New in version 2.2**
type: string
x-openstack:
min-ver: '2.2'
required:
- fingerprint
- name
- public_key
- type
- user_id
type: object
required:
- keypair
type: object
Os_KeypairsCreate_20:
additionalProperties: false
properties:
keypair:
additionalProperties: false
description: |-
Keypair object
properties:
name:
description: |-
A name for the keypair which will be used to reference it later.
Note
Since microversion 2.92, allowed characters are ASCII letters
`[a-zA-Z]`, digits `[0-9]` and the following special
characters: `[@._- ]`.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
public_key:
description: |-
The public ssh key to import.
Was optional before microversion 2.92 : if you were omitting this value, a
keypair was generated for you.
type: string
required:
- name
type: object
required:
- keypair
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.0'
Os_KeypairsCreate_21:
additionalProperties: false
properties:
keypair:
additionalProperties: false
description: |-
Keypair object
properties:
name:
allOf:
- format: name
maxLength: 255
minLength: 1
type: string
- maxLength: 255
minLength: 1
pattern: ^[_\- a-zA-Z0-9]+$
type: string
description: |-
A name for the keypair which will be used to reference it later.
Note
Since microversion 2.92, allowed characters are ASCII letters
`[a-zA-Z]`, digits `[0-9]` and the following special
characters: `[@._- ]`.
public_key:
description: |-
The public ssh key to import.
Was optional before microversion 2.92 : if you were omitting this value, a
keypair was generated for you.
type: string
required:
- name
type: object
required:
- keypair
type: object
x-openstack:
max-ver: '2.1'
min-ver: '2.1'
Os_KeypairsCreate_210:
additionalProperties: false
properties:
keypair:
additionalProperties: false
description: |-
Keypair object
properties:
name:
allOf:
- format: name
maxLength: 255
minLength: 1
type: string
- maxLength: 255
minLength: 1
pattern: ^[_\- a-zA-Z0-9]+$
type: string
description: |-
A name for the keypair which will be used to reference it later.
Note
Since microversion 2.92, allowed characters are ASCII letters
`[a-zA-Z]`, digits `[0-9]` and the following special
characters: `[@._- ]`.
public_key:
description: |-
The public ssh key to import.
Was optional before microversion 2.92 : if you were omitting this value, a
keypair was generated for you.
type: string
type:
description: |-
The type of the keypair. Allowed values are `ssh` or `x509`.
**New in version 2.2**
enum:
- ssh
- x509
type: string
user_id:
description: |-
The user_id for a keypair. This allows administrative users to
upload keys for other users than themselves.
**New in version 2.10**
type: string
required:
- name
type: object
required:
- keypair
type: object
x-openstack:
max-ver: '2.91'
min-ver: '2.10'
Os_KeypairsCreate_22:
additionalProperties: false
properties:
keypair:
additionalProperties: false
description: |-
Keypair object
properties:
name:
allOf:
- format: name
maxLength: 255
minLength: 1
type: string
- maxLength: 255
minLength: 1
pattern: ^[_\- a-zA-Z0-9]+$
type: string
description: |-
A name for the keypair which will be used to reference it later.
Note
Since microversion 2.92, allowed characters are ASCII letters
`[a-zA-Z]`, digits `[0-9]` and the following special
characters: `[@._- ]`.
public_key:
description: |-
The public ssh key to import.
Was optional before microversion 2.92 : if you were omitting this value, a
keypair was generated for you.
type: string
type:
description: |-
The type of the keypair. Allowed values are `ssh` or `x509`.
**New in version 2.2**
enum:
- ssh
- x509
type: string
required:
- name
type: object
required:
- keypair
type: object
x-openstack:
max-ver: '2.9'
min-ver: '2.2'
Os_KeypairsCreate_292:
additionalProperties: false
properties:
keypair:
additionalProperties: false
description: |-
Keypair object
properties:
name:
allOf:
- format: name
maxLength: 255
minLength: 1
type: string
- maxLength: 255
minLength: 1
pattern: ^[_\-\@\. a-zA-Z0-9]+$
type: string
description: |-
A name for the keypair which will be used to reference it later.
Note
Since microversion 2.92, allowed characters are ASCII letters
`[a-zA-Z]`, digits `[0-9]` and the following special
characters: `[@._- ]`.
public_key:
description: |-
The public ssh key to import.
Was optional before microversion 2.92 : if you were omitting this value, a
keypair was generated for you.
type: string
type:
description: |-
The type of the keypair. Allowed values are `ssh` or `x509`.
**New in version 2.2**
enum:
- ssh
- x509
type: string
user_id:
description: |-
The user_id for a keypair. This allows administrative users to
upload keys for other users than themselves.
**New in version 2.10**
type: string
required:
- name
- public_key
type: object
required:
- keypair
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.92'
Os_KeypairsListResponse:
properties:
keypairs:
description: |-
Array of Keypair objects
items:
properties:
keypair:
description: |-
Keypair object
properties:
fingerprint:
description: |-
The fingerprint for the keypair.
type: string
name:
description: |-
The name for the keypair.
type: string
public_key:
description: |-
The keypair public key.
type: string
type:
description: |-
The type of the keypair. Allowed values are `ssh` or `x509`.
**New in version 2.2**
type: string
x-openstack:
min-ver: '2.2'
required:
- fingerprint
- name
- public_key
- type
type: object
type: object
type: array
keypairs_links:
description: |-
Links pertaining to keypair. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
**New in version 2.35**
items:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
required:
- keypairs
type: object
Os_MigrationsListResponse:
description: List of migration objects
properties:
migrations:
description: |-
The list of server migration objects.
items:
description: Migration object
properties:
created_at:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
dest_compute:
description: |-
The target compute for a migration.
type: string
dest_host:
description: |-
The target host for a migration.
type: string
dest_node:
description: |-
The target node for a migration.
type: string
id:
description: |-
The ID of the server migration.
type: integer
instance_uuid:
description: |-
The UUID of the server.
format: uuid
type: string
migration_type:
description: |-
The type of the server migration. This is one of `live-migration`,
`migration`, `resize` and `evacuation`.
**New in version 2.23**
enum:
- live-migration
- migration
- resize
type: string
x-openstack:
min-ver: '2.23'
new_instance_type_id:
description: |-
In `resize` case, the flavor ID for resizing the server.
In the other cases, this parameter is same as the flavor ID
of the server when the migration was started.
Note
This is an internal ID and is not exposed in any other API.
In particular, this is not the ID specified or automatically generated
during flavor creation or returned via the `GET /flavors` API.
type: integer
old_instance_type_id:
description: |-
The flavor ID of the server when the migration was started.
Note
This is an internal ID and is not exposed in any other API.
In particular, this is not the ID specified or automatically generated
during flavor creation or returned via the `GET /flavors` API.
type: integer
project_id:
description: |-
The ID of the project which initiated the server migration. The value
may be `null` for older migration records.
**New in version 2.80**
type:
- 'null'
- string
x-openstack:
min-ver: '2.80'
source_compute:
description: |-
The source compute for a migration.
type: string
source_node:
description: |-
The source node for a migration.
type: string
status:
description: |-
The current status of the migration.
type: string
updated_at:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
user_id:
description: |-
The ID of the user which initiated the server migration. The value
may be `null` for older migration records.
**New in version 2.80**
type:
- 'null'
- string
x-openstack:
min-ver: '2.80'
uuid:
description: |-
The UUID of the migration.
**New in version 2.59**
format: uuid
type: string
x-openstack:
min-ver: '2.59'
type: object
type: array
migrations_links:
description: |-
Links pertaining to the migration.
This parameter is returned when paging and more data is available.
See [Paginated collections](https://docs.openstack.org/api-guide/compute/paginated_collections.html)
for more info.
**New in version 2.59**
items:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
x-openstack:
min-ver: '2.59'
type: object
Os_NetworkShowResponse:
additionalProperties: false
properties:
network:
additionalProperties: false
properties:
bridge:
type:
- 'null'
- string
bridge_interface:
type:
- 'null'
- string
broadcast:
type:
- 'null'
- string
cidr:
type:
- 'null'
- string
cidr_v6:
type:
- 'null'
- string
created_at:
type:
- 'null'
- string
deleted:
type:
- 'null'
- string
deleted_at:
type:
- 'null'
- string
dhcp_server:
type:
- 'null'
- string
dhcp_start:
type:
- 'null'
- string
dns1:
type:
- 'null'
- string
dns2:
type:
- 'null'
- string
enable_dhcp:
type:
- 'null'
- string
gateway:
type:
- 'null'
- string
gateway_v6:
type:
- 'null'
- string
host:
type:
- 'null'
- string
id:
format: string
type: string
injected:
type:
- 'null'
- string
label:
type: string
mtu:
type:
- integer
- 'null'
multi_host:
type:
- 'null'
- string
netmask:
type:
- 'null'
- string
netmask_v6:
type:
- 'null'
- string
priority:
type:
- 'null'
- string
project_id:
type:
- 'null'
- string
rxtx_base:
type:
- 'null'
- string
share_address:
type:
- 'null'
- string
updated_at:
type:
- 'null'
- string
vlan:
type:
- 'null'
- string
vpn_private_address:
type:
- 'null'
- string
vpn_public_address:
type:
- 'null'
- string
vpn_public_port:
type:
- integer
- 'null'
required:
- broadcast
- cidr
- cidr_v6
- dns1
- dns2
- gateway
- gateway_v6
- id
- label
- netmask
- netmask_v6
type: object
required:
- network
type: object
Os_NetworksActionAssociate_HostRequest:
description: Empty body for associate_host action
properties:
associate_host:
type: 'null'
type: object
x-openstack:
action-name: associate_host
Os_NetworksActionAssociate_HostResponse:
x-openstack:
action-name: associate_host
Os_NetworksActionDisassociateRequest:
description: Empty body for disassociate action
properties:
disassociate:
type: 'null'
type: object
x-openstack:
action-name: disassociate
Os_NetworksActionDisassociateResponse:
x-openstack:
action-name: disassociate
Os_NetworksActionDisassociate_HostRequest:
description: Empty body for disassociate_host action
properties:
disassociate_host:
type: 'null'
type: object
x-openstack:
action-name: disassociate_host
Os_NetworksActionDisassociate_HostResponse:
x-openstack:
action-name: disassociate_host
Os_NetworksActionDisassociate_ProjectRequest:
description: Empty body for disassociate_project action
properties:
disassociate_project:
type: 'null'
type: object
x-openstack:
action-name: disassociate_project
Os_NetworksActionDisassociate_ProjectResponse:
x-openstack:
action-name: disassociate_project
Os_NetworksAddResponse: {}
Os_NetworksCreateResponse: {}
Os_NetworksListResponse:
additionalProperties: false
properties:
networks:
items:
additionalProperties: false
properties:
bridge:
type:
- 'null'
- string
bridge_interface:
type:
- 'null'
- string
broadcast:
type:
- 'null'
- string
cidr:
type:
- 'null'
- string
cidr_v6:
type:
- 'null'
- string
created_at:
type:
- 'null'
- string
deleted:
type:
- 'null'
- string
deleted_at:
type:
- 'null'
- string
dhcp_server:
type:
- 'null'
- string
dhcp_start:
type:
- 'null'
- string
dns1:
type:
- 'null'
- string
dns2:
type:
- 'null'
- string
enable_dhcp:
type:
- 'null'
- string
gateway:
type:
- 'null'
- string
gateway_v6:
type:
- 'null'
- string
host:
type:
- 'null'
- string
id:
format: string
type: string
injected:
type:
- 'null'
- string
label:
type: string
mtu:
type:
- integer
- 'null'
multi_host:
type:
- 'null'
- string
netmask:
type:
- 'null'
- string
netmask_v6:
type:
- 'null'
- string
priority:
type:
- 'null'
- string
project_id:
type:
- 'null'
- string
rxtx_base:
type:
- 'null'
- string
share_address:
type:
- 'null'
- string
updated_at:
type:
- 'null'
- string
vlan:
type:
- 'null'
- string
vpn_private_address:
type:
- 'null'
- string
vpn_public_address:
type:
- 'null'
- string
vpn_public_port:
type:
- integer
- 'null'
required:
- broadcast
- cidr
- cidr_v6
- dns1
- dns2
- gateway
- gateway_v6
- id
- label
- netmask
- netmask_v6
type: object
type: array
required:
- networks
type: object
Os_Quota_Class_SetShowResponse:
properties:
quota_class_set:
description: |-
A `quota_class_set` object.
properties:
cores:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
fixed_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
floating_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
id:
description: |-
The ID of the quota class.
Nova supports the `default` Quota Class only.
type: string
injected_file_content_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_path_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_files:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
instances:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
networks:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_group_rules:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
required:
- id
type: object
type: object
Os_Quota_Class_SetUpdateRequest:
oneOf:
- $ref: '#/components/schemas/Os_Quota_Class_SetUpdate_21'
- $ref: '#/components/schemas/Os_Quota_Class_SetUpdate_250'
- $ref: '#/components/schemas/Os_Quota_Class_SetUpdate_257'
x-openstack:
discriminator: microversion
Os_Quota_Class_SetUpdateResponse:
description: Response of the os-quota-class-sets/id:put operation
type: object
Os_Quota_Class_SetUpdate_21:
additionalProperties: false
properties:
quota_class_set:
additionalProperties: false
description: |-
A `quota_class_set` object.
properties:
cores:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
fixed_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
floating_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_content_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_path_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_files:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
instances:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
networks:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_group_rules:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
type: object
required:
- quota_class_set
type: object
x-openstack:
max-ver: '2.49'
min-ver: '2.1'
Os_Quota_Class_SetUpdate_250:
additionalProperties: false
properties:
quota_class_set:
additionalProperties: false
description: |-
A `quota_class_set` object.
properties:
cores:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_content_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_path_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_files:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
instances:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
type: object
required:
- quota_class_set
type: object
x-openstack:
max-ver: '2.56'
min-ver: '2.50'
Os_Quota_Class_SetUpdate_257:
additionalProperties: false
properties:
quota_class_set:
additionalProperties: false
description: |-
A `quota_class_set` object.
properties:
cores:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
instances:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
type: object
required:
- quota_class_set
type: object
x-openstack:
max-ver: '2.49'
min-ver: '2.57'
Os_Quota_SetShowResponse:
properties:
quota_set:
description: |-
A `quota_set` object.
properties:
cores:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
fixed_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
floating_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
id:
description: |-
The UUID of the tenant/user the quotas listed for.
format: uuid
type: string
injected_file_content_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_path_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_files:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
instances:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
networks:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_group_rules:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
type: object
type: object
Os_Quota_SetUpdateRequest:
oneOf:
- $ref: '#/components/schemas/Os_Quota_SetUpdate_20'
- $ref: '#/components/schemas/Os_Quota_SetUpdate_236'
- $ref: '#/components/schemas/Os_Quota_SetUpdate_257'
x-openstack:
discriminator: microversion
Os_Quota_SetUpdateResponse:
properties:
quota_set:
description: |-
A `quota_set` object.
properties:
cores:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
fixed_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
floating_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
id:
description: |-
The UUID of the tenant/user the quotas listed for.
format: uuid
type: string
injected_file_content_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_path_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_files:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
instances:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
networks:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_group_rules:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
type: object
type: object
Os_Quota_SetUpdate_20:
additionalProperties: false
properties:
quota_set:
additionalProperties: false
description: |-
A `quota_set` object.
properties:
cores:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
fixed_ips:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
floating_ips:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
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`.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
injected_file_content_bytes:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_path_bytes:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_files:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
instances:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
networks:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_group_rules:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_groups:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
type: object
required:
- quota_set
type: object
x-openstack:
max-ver: '2.35'
min-ver: '2.0'
Os_Quota_SetUpdate_236:
additionalProperties: false
properties:
quota_set:
additionalProperties: false
description: |-
A `quota_set` object.
properties:
cores:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
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`.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
injected_file_content_bytes:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_path_bytes:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_files:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
instances:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed injected files for each tenant.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
type: object
required:
- quota_set
type: object
x-openstack:
max-ver: '2.56'
min-ver: '2.36'
Os_Quota_SetUpdate_257:
additionalProperties: false
properties:
quota_set:
additionalProperties: false
description: |-
A `quota_set` object.
properties:
cores:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
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`.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
instances:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed members for each server group.
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
type: object
required:
- quota_set
type: object
x-openstack:
max-ver: '2.35'
min-ver: '2.57'
Os_Quota_SetsDefaultsResponse:
properties:
quota_set:
description: |-
A `quota_set` object.
properties:
cores:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
fixed_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
floating_ips:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
id:
description: |-
The UUID of the tenant/user the quotas listed for.
format: uuid
type: string
injected_file_content_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_file_path_bytes:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
injected_files:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
instances:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
key_pairs:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
metadata_items:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
networks:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
ram:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_group_rules:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
security_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_group_members:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
server_groups:
description: |-
The number of allowed injected files for the quota class.
**Available until version 2.56**
maximum: 2147483647
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- string
type: object
type: object
Os_Quota_SetsDetailResponse:
properties:
quota_set:
description: |-
A `quota_set` object.
properties:
cores:
description: |-
The object of detailed cores quota, including in_use, limit and
reserved number of cores.
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
fixed_ips:
description: |-
The object of detailed fixed ips quota, including in_use, limit and
reserved number of fixed ips.
**Available until version 2.35**
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
x-openstack:
max-ver: '2.35'
floating_ips:
description: |-
The object of detailed floating ips quota, including in_use, limit and
reserved number of floating ips.
**Available until version 2.35**
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
x-openstack:
max-ver: '2.35'
id:
description: |-
The UUID of the tenant/user the quotas listed for.
format: uuid
type: string
injected_files:
description: |-
The object of detailed injected files quota, including in_use, limit and
reserved number of injected files.
**Available until version 2.56**
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
x-openstack:
max-ver: '2.56'
injected_files_content_bytes:
description: The object of detailed injected file content bytes
quota, including in_use, limit and reserved number of injected
file content bytes.
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
x-openstack:
max-ver: '2.56'
injected_files_path_bytes:
description: The object of detailed injected file path bytes
quota, including in_use, limit and reserved number of injected
file path bytes.
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
x-openstack:
max-ver: '2.56'
instances:
description: |-
The object of detailed servers quota, including in_use, limit and
reserved number of instances.
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
key_pairs:
description: |-
The object of detailed key pairs quota, including in_use, limit and
reserved number of key pairs.
Note
`in_use` field value for keypair quota details is always
zero. In Nova, key_pairs are a user-level resource, not a project-
level resource, so for legacy reasons, the keypair in-use information
is not counted.
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
metadata_items:
description: |-
The object of detailed key metadata items quota, including in_use,
limit and reserved number of metadata items.
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
networks:
description: |-
The number of private networks that can be created per project.
**Available until version 2.35**
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
x-openstack:
max-ver: '2.35'
ram:
description: |-
The object of detailed key ram quota, including in_use,
limit and reserved number of ram.
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
security_group_rules:
description: |-
The object of detailed security group rules quota, including in_use,
limit and reserved number of security group rules.
**Available until version 2.35**
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
x-openstack:
max-ver: '2.35'
security_groups:
description: |-
The object of detailed security groups, including in_use,
limit and reserved number of security groups.
**Available until version 2.35**
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
x-openstack:
max-ver: '2.35'
server_group_members:
description: |-
The object of detailed server group members, including in_use,
limit and reserved number of server group members.
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
server_groups:
description: |-
The object of detailed server groups, including in_use,
limit and reserved number of server groups.
properties:
in_use:
type: integer
limit:
type: integer
reserved:
type: integer
type: object
required:
- id
type: object
required:
- quota_set
type: object
Os_Security_GroupShowResponse:
additionalProperties: false
properties:
security_group:
additionalProperties: false
description: |-
Specify the `security_group` action in the request body.
properties:
description:
description: |-
Security group description.
type:
- 'null'
- string
id:
description: |-
The ID of the security group.
format: uuid
type: string
name:
description: |-
The security group name.
type: string
rules:
description: |-
The list of security group rules.
items:
additionalProperties: false
description: |-
A `security_group_rule` object.
properties:
from_port:
description: |-
The port at start of range.
minimum: -1
type:
- integer
- 'null'
group:
additionalProperties: false
description: |-
A `group` object. Includes the `tenant_id` and the source security
group `name`.
properties:
name:
description: |-
The security group name.
type: string
tenant_id:
description: |-
The UUID of the tenant that owns this security group.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required: []
type: object
id:
description: |-
The security group rule ID.
format: uuid
type: string
ip_protocol:
description: |-
The IP protocol. A valid value is ICMP, TCP, or UDP.
type:
- 'null'
- string
ip_range:
additionalProperties: false
description: |-
An IP range object. Includes the security group rule `cidr`.
properties:
cidr:
description: |-
The CIDR for address range.
format: cidr
type: string
required: []
type: object
parent_group_id:
description: |-
Security group ID.
format: uuid
type: string
to_port:
description: |-
The port at end of range.
minimum: -1
type:
- integer
- 'null'
required:
- from_port
- group
- id
- ip_protocol
- ip_range
- parent_group_id
- to_port
type: object
type: array
tenant_id:
description: |-
The UUID of the tenant that owns this security group.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required:
- description
- id
- name
- rules
- tenant_id
type: object
required:
- security_group
type: object
Os_Security_GroupUpdateResponse:
additionalProperties: false
properties:
security_group:
additionalProperties: false
description: |-
Specify the `security_group` action in the request body.
properties:
description:
description: |-
Security group description.
type:
- 'null'
- string
id:
description: |-
The ID of the security group.
format: uuid
type: string
name:
description: |-
The security group name.
type: string
rules:
description: |-
The list of security group rules.
items:
additionalProperties: false
properties:
from_port:
minimum: -1
type:
- integer
- 'null'
group:
additionalProperties: false
properties:
name:
type: string
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required: []
type: object
id:
format: uuid
type: string
ip_protocol:
type:
- 'null'
- string
ip_range:
additionalProperties: false
properties:
cidr:
format: cidr
type: string
required: []
type: object
parent_group_id:
format: uuid
type: string
to_port:
minimum: -1
type:
- integer
- 'null'
required:
- from_port
- group
- id
- ip_protocol
- ip_range
- parent_group_id
- to_port
type: object
type: array
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required:
- description
- id
- name
- rules
- tenant_id
type: object
required:
- security_group
type: object
Os_Security_GroupUpdate_21:
additionalProperties: true
properties:
security_group:
additionalProperties: true
properties:
description:
description: |-
Security group description.
maxLength: 255
minLength: 0
type: string
name:
description: |-
The security group name.
maxLength: 255
minLength: 0
type: string
required:
- description
- name
type: object
required:
- security_group
type: object
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
Os_Security_Group_Default_RuleShowResponse: {}
Os_Security_Group_Default_RulesCreateResponse: {}
Os_Security_Group_Default_RulesListResponse: {}
Os_Security_Group_RulesCreateResponse:
additionalProperties: false
properties:
security_group_rule:
additionalProperties: false
description: |-
A `security_group_rule` object.
properties:
from_port:
description: |-
The port at start of range.
minimum: -1
type:
- integer
- 'null'
group:
additionalProperties: false
description: |-
A `group` object. Includes the `tenant_id` and the source security
group `name`.
properties:
name:
description: |-
The security group name.
type: string
tenant_id:
description: |-
The UUID of the tenant that owns this security group.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required: []
type: object
id:
description: |-
The security group rule ID.
format: uuid
type: string
ip_protocol:
description: |-
The IP protocol. A valid value is ICMP, TCP, or UDP.
type:
- 'null'
- string
ip_range:
additionalProperties: false
description: |-
An IP range object. Includes the security group rule `cidr`.
properties:
cidr:
description: |-
The CIDR for address range.
format: cidr
type: string
required: []
type: object
parent_group_id:
description: |-
Security group ID.
format: uuid
type: string
to_port:
description: |-
The port at end of range.
minimum: -1
type:
- integer
- 'null'
required:
- from_port
- group
- id
- ip_protocol
- ip_range
- parent_group_id
- to_port
type: object
required:
- security_group_rule
type: object
Os_Security_Group_RulesCreate_21:
additionalProperties: true
properties:
security_group_rule:
additionalProperties: true
description: |-
A `security_group_rule` object.
properties:
cidr: {}
from_port: {}
group_id:
description: |-
The source security group ID.
format: uuid
type:
- 'null'
- string
ip_protocol: {}
parent_group_id:
description: |-
Security group ID.
format: uuid
type: string
to_port: {}
required:
- parent_group_id
type: object
required:
- security_group_rule
type: object
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
Os_Security_GroupsCreateResponse:
additionalProperties: false
properties:
security_group:
additionalProperties: false
description: |-
Specify the `security_group` action in the request body.
properties:
description:
description: |-
Security group description.
type:
- 'null'
- string
id:
description: |-
The ID of the security group.
format: uuid
type: string
name:
description: |-
The security group name.
type: string
rules:
description: |-
The list of security group rules.
items:
additionalProperties: false
properties:
from_port:
minimum: -1
type:
- integer
- 'null'
group:
additionalProperties: false
properties:
name:
type: string
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required: []
type: object
id:
format: uuid
type: string
ip_protocol:
type:
- 'null'
- string
ip_range:
additionalProperties: false
properties:
cidr:
format: cidr
type: string
required: []
type: object
parent_group_id:
format: uuid
type: string
to_port:
minimum: -1
type:
- integer
- 'null'
required:
- from_port
- group
- id
- ip_protocol
- ip_range
- parent_group_id
- to_port
type: object
type: array
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required:
- description
- id
- name
- rules
- tenant_id
type: object
required:
- security_group
type: object
Os_Security_GroupsCreate_21:
additionalProperties: true
properties:
security_group:
additionalProperties: true
description: |-
Specify the `security_group` action in the request body.
properties:
description:
description: |-
Security group description.
maxLength: 255
minLength: 0
type: string
name:
description: |-
The security group name.
maxLength: 255
minLength: 0
type: string
required:
- description
- name
type: object
required:
- security_group
type: object
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
Os_Security_GroupsListResponse:
additionalProperties: false
properties:
security_groups:
description: |-
One or more security groups objects.
items:
additionalProperties: false
description: |-
Specify the `security_group` action in the request body.
properties:
description:
description: |-
Security group description.
type:
- 'null'
- string
id:
description: |-
The ID of the security group.
format: uuid
type: string
name:
description: |-
The security group name.
type: string
rules:
description: |-
The list of security group rules.
items:
additionalProperties: false
description: |-
A `security_group_rule` object.
properties:
from_port:
description: |-
The port at start of range.
minimum: -1
type:
- integer
- 'null'
group:
additionalProperties: false
description: |-
A `group` object. Includes the `tenant_id` and the source security
group `name`.
properties:
name:
description: |-
The security group name.
type: string
tenant_id:
description: |-
The UUID of the tenant that owns this security group.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required: []
type: object
id:
description: |-
The security group rule ID.
format: uuid
type: string
ip_protocol:
description: |-
The IP protocol. A valid value is ICMP, TCP, or UDP.
type:
- 'null'
- string
ip_range:
additionalProperties: false
description: |-
An IP range object. Includes the security group rule `cidr`.
properties:
cidr:
description: |-
The CIDR for address range.
format: cidr
type: string
required: []
type: object
parent_group_id:
description: |-
Security group ID.
format: uuid
type: string
to_port:
description: |-
The port at end of range.
minimum: -1
type:
- integer
- 'null'
required:
- from_port
- group
- id
- ip_protocol
- ip_range
- parent_group_id
- to_port
type: object
type: array
tenant_id:
description: |-
The UUID of the tenant that owns this security group.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required:
- description
- id
- name
- rules
- tenant_id
type: object
type: array
required:
- security_groups
type: object
Os_Server_External_EventsCreateRequest:
oneOf:
- $ref: '#/components/schemas/Os_Server_External_EventsCreate_20'
- $ref: '#/components/schemas/Os_Server_External_EventsCreate_251'
- $ref: '#/components/schemas/Os_Server_External_EventsCreate_276'
- $ref: '#/components/schemas/Os_Server_External_EventsCreate_282'
- $ref: '#/components/schemas/Os_Server_External_EventsCreate_293'
x-openstack:
discriminator: microversion
Os_Server_External_EventsCreateResponse:
properties:
events:
description: |-
List of external events to process.
items:
properties:
name:
description: |-
The event name. A valid value is:
* `network-changed`
* `network-vif-plugged`
* `network-vif-unplugged`
* `network-vif-deleted`
* `volume-extended` (since microversion `2.51`)
* `power-update` (since microversion `2.76`)
* `accelerator-request-bound` (since microversion `2.82`)
* `volume-reimaged` (since microversion `2.93`)
enum:
- accelerator-request-bound
- network-changed
- network-vif-deleted
- network-vif-plugged
- network-vif-unplugged
- power-update
- volume-extended
type: string
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.
format: uuid
type: string
status:
description: |-
The event status. A valid value is `failed`, `completed`, or `in-progress`.
Default is `completed`.
enum:
- completed
- failed
- in-progress
type: string
tag:
description: |-
A string value that identifies the event. Certain types of events require
specific tags:
* For the `accelerator-request-bound` event, the tag must be
the accelerator request UUID.
* For the `power-update` event the tag must be either be `POWER_ON`
or `POWER_OFF`.
* For the `volume-extended` event the tag must be the volume id.
type: string
required:
- name
- server_uuid
- status
type: object
type: array
required:
- events
type: object
Os_Server_External_EventsCreate_20:
additionalProperties: false
properties:
events:
description: |-
List of external events to process.
items:
additionalProperties: false
properties:
name:
description: |-
The event name. A valid value is:
* `network-changed`
* `network-vif-plugged`
* `network-vif-unplugged`
* `network-vif-deleted`
* `volume-extended` (since microversion `2.51`)
* `power-update` (since microversion `2.76`)
* `accelerator-request-bound` (since microversion `2.82`)
* `volume-reimaged` (since microversion `2.93`)
enum:
- network-changed
- network-vif-deleted
- network-vif-plugged
- network-vif-unplugged
type: string
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.
format: uuid
type: string
status:
description: |-
The event status. A valid value is `failed`, `completed`, or `in-progress`.
Default is `completed`.
enum:
- completed
- failed
- in-progress
type: string
tag:
description: |-
A string value that identifies the event. Certain types of events require
specific tags:
* For the `accelerator-request-bound` event, the tag must be
the accelerator request UUID.
* For the `power-update` event the tag must be either be `POWER_ON`
or `POWER_OFF`.
* For the `volume-extended` event the tag must be the volume id.
maxLength: 255
type: string
required:
- name
- server_uuid
type: object
minItems: 1
type: array
required:
- events
type: object
x-openstack:
max-ver: '2.50'
min-ver: '2.0'
Os_Server_External_EventsCreate_251:
additionalProperties: false
properties:
events:
description: |-
List of external events to process.
items:
additionalProperties: false
properties:
name:
description: |-
The event name. A valid value is:
* `network-changed`
* `network-vif-plugged`
* `network-vif-unplugged`
* `network-vif-deleted`
* `volume-extended` (since microversion `2.51`)
* `power-update` (since microversion `2.76`)
* `accelerator-request-bound` (since microversion `2.82`)
* `volume-reimaged` (since microversion `2.93`)
enum:
- network-changed
- network-vif-deleted
- network-vif-plugged
- network-vif-unplugged
- volume-extended
type: string
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.
format: uuid
type: string
status:
description: |-
The event status. A valid value is `failed`, `completed`, or `in-progress`.
Default is `completed`.
enum:
- completed
- failed
- in-progress
type: string
tag:
description: |-
A string value that identifies the event. Certain types of events require
specific tags:
* For the `accelerator-request-bound` event, the tag must be
the accelerator request UUID.
* For the `power-update` event the tag must be either be `POWER_ON`
or `POWER_OFF`.
* For the `volume-extended` event the tag must be the volume id.
maxLength: 255
type: string
required:
- name
- server_uuid
type: object
minItems: 1
type: array
required:
- events
type: object
x-openstack:
max-ver: '2.75'
min-ver: '2.51'
Os_Server_External_EventsCreate_276:
additionalProperties: false
properties:
events:
description: |-
List of external events to process.
items:
additionalProperties: false
properties:
name:
description: |-
The event name. A valid value is:
* `network-changed`
* `network-vif-plugged`
* `network-vif-unplugged`
* `network-vif-deleted`
* `volume-extended` (since microversion `2.51`)
* `power-update` (since microversion `2.76`)
* `accelerator-request-bound` (since microversion `2.82`)
* `volume-reimaged` (since microversion `2.93`)
enum:
- network-changed
- network-vif-deleted
- network-vif-plugged
- network-vif-unplugged
- power-update
- volume-extended
type: string
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.
format: uuid
type: string
status:
description: |-
The event status. A valid value is `failed`, `completed`, or `in-progress`.
Default is `completed`.
enum:
- completed
- failed
- in-progress
type: string
tag:
description: |-
A string value that identifies the event. Certain types of events require
specific tags:
* For the `accelerator-request-bound` event, the tag must be
the accelerator request UUID.
* For the `power-update` event the tag must be either be `POWER_ON`
or `POWER_OFF`.
* For the `volume-extended` event the tag must be the volume id.
maxLength: 255
type: string
required:
- name
- server_uuid
type: object
minItems: 1
type: array
required:
- events
type: object
x-openstack:
max-ver: '2.81'
min-ver: '2.76'
Os_Server_External_EventsCreate_282:
additionalProperties: false
properties:
events:
description: |-
List of external events to process.
items:
additionalProperties: false
properties:
name:
description: |-
The event name. A valid value is:
* `network-changed`
* `network-vif-plugged`
* `network-vif-unplugged`
* `network-vif-deleted`
* `volume-extended` (since microversion `2.51`)
* `power-update` (since microversion `2.76`)
* `accelerator-request-bound` (since microversion `2.82`)
* `volume-reimaged` (since microversion `2.93`)
enum:
- accelerator-request-bound
- network-changed
- network-vif-deleted
- network-vif-plugged
- network-vif-unplugged
- power-update
- volume-extended
type: string
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.
format: uuid
type: string
status:
description: |-
The event status. A valid value is `failed`, `completed`, or `in-progress`.
Default is `completed`.
enum:
- completed
- failed
- in-progress
type: string
tag:
description: |-
A string value that identifies the event. Certain types of events require
specific tags:
* For the `accelerator-request-bound` event, the tag must be
the accelerator request UUID.
* For the `power-update` event the tag must be either be `POWER_ON`
or `POWER_OFF`.
* For the `volume-extended` event the tag must be the volume id.
maxLength: 255
type: string
required:
- name
- server_uuid
type: object
minItems: 1
type: array
required:
- events
type: object
x-openstack:
max-ver: '2.92'
min-ver: '2.82'
Os_Server_External_EventsCreate_293:
additionalProperties: false
properties:
events:
description: |-
List of external events to process.
items:
additionalProperties: false
properties:
name:
description: |-
The event name. A valid value is:
* `network-changed`
* `network-vif-plugged`
* `network-vif-unplugged`
* `network-vif-deleted`
* `volume-extended` (since microversion `2.51`)
* `power-update` (since microversion `2.76`)
* `accelerator-request-bound` (since microversion `2.82`)
* `volume-reimaged` (since microversion `2.93`)
enum:
- accelerator-request-bound
- network-changed
- network-vif-deleted
- network-vif-plugged
- network-vif-unplugged
- power-update
- volume-extended
- volume-reimaged
type: string
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.
format: uuid
type: string
status:
description: |-
The event status. A valid value is `failed`, `completed`, or `in-progress`.
Default is `completed`.
enum:
- completed
- failed
- in-progress
type: string
tag:
description: |-
A string value that identifies the event. Certain types of events require
specific tags:
* For the `accelerator-request-bound` event, the tag must be
the accelerator request UUID.
* For the `power-update` event the tag must be either be `POWER_ON`
or `POWER_OFF`.
* For the `volume-extended` event the tag must be the volume id.
maxLength: 255
type: string
required:
- name
- server_uuid
type: object
minItems: 1
type: array
required:
- events
type: object
x-openstack:
max-ver: '2.50'
min-ver: '2.93'
Os_Server_GroupShowResponse:
properties:
server_group:
description: |-
The server group object.
properties:
id:
description: |-
The UUID of the server group.
format: uuid
readOnly: true
type: string
members:
description: |-
A list of members in the server group.
items:
type: string
type: array
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes. It’s always empty and only used for keeping compatibility.
**Available until version 2.63**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
x-openstack:
max-ver: '2.63'
name:
description: |-
The name of the server group.
type: string
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.
**Available until version 2.63**
items:
enum:
- affinity
- anti-affinity
- soft-affinity
- soft-anti-affinity
type: string
maxItems: 1
type: array
x-openstack:
max-ver: '2.63'
policy:
description: |-
The `policy` field represents the name of the policy. 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.
* `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.
**New in version 2.64**
enum:
- affinity
- anti-affinity
- soft-affinity
- soft-anti-affinity
type: string
x-openstack:
min-ver: '2.64'
project_id:
description: |-
The project ID who owns the server group.
**New in version 2.13**
type: string
x-openstack:
min-ver: '2.13'
rules:
additionalProperties: false
description: |-
The `rules` field, which is a dict, can be applied to the policy.
Currently, only the `max_server_per_host` rule is supported for the
`anti-affinity` policy. The `max_server_per_host` rule allows
specifying how many members of the anti-affinity group can reside on the
same compute host. If not specified, only one member from the same
anti-affinity group can reside on a given host.
**New in version 2.64**
properties:
max_server_per_host:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
type: object
x-openstack:
min-ver: '2.64'
user_id:
description: |-
The user ID who owns the server group.
**New in version 2.13**
type: string
x-openstack:
min-ver: '2.13'
required:
- id
- name
- policy
- project_id
- user_id
type: object
required:
- server_group
type: object
Os_Server_GroupsCreateRequest:
oneOf:
- $ref: '#/components/schemas/Os_Server_GroupsCreate_20'
- $ref: '#/components/schemas/Os_Server_GroupsCreate_215'
- $ref: '#/components/schemas/Os_Server_GroupsCreate_264'
x-openstack:
discriminator: microversion
Os_Server_GroupsCreateResponse:
properties:
server_group:
description: |-
The server group object.
properties:
id:
description: |-
The UUID of the server group.
format: uuid
readOnly: true
type: string
members:
description: |-
A list of members in the server group.
items:
type: string
type: array
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes. It’s always empty and only used for keeping compatibility.
**Available until version 2.63**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
x-openstack:
max-ver: '2.63'
name:
description: |-
The name of the server group.
type: string
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.
**Available until version 2.63**
items:
enum:
- affinity
- anti-affinity
- soft-affinity
- soft-anti-affinity
type: string
maxItems: 1
type: array
x-openstack:
max-ver: '2.63'
policy:
description: |-
The `policy` field represents the name of the policy. 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.
* `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.
**New in version 2.64**
enum:
- affinity
- anti-affinity
- soft-affinity
- soft-anti-affinity
type: string
x-openstack:
min-ver: '2.64'
project_id:
description: |-
The project ID who owns the server group.
**New in version 2.13**
type: string
x-openstack:
min-ver: '2.13'
rules:
additionalProperties: false
description: |-
The `rules` field, which is a dict, can be applied to the policy.
Currently, only the `max_server_per_host` rule is supported for the
`anti-affinity` policy. The `max_server_per_host` rule allows
specifying how many members of the anti-affinity group can reside on the
same compute host. If not specified, only one member from the same
anti-affinity group can reside on a given host.
**New in version 2.64**
properties:
max_server_per_host:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
type: object
x-openstack:
min-ver: '2.64'
user_id:
description: |-
The user ID who owns the server group.
**New in version 2.13**
type: string
x-openstack:
min-ver: '2.13'
required:
- id
- name
- policy
- project_id
- user_id
type: object
required:
- server_group
type: object
Os_Server_GroupsCreate_20:
additionalProperties: false
properties:
server_group:
additionalProperties: false
description: |-
The server group object.
properties:
name:
description: |-
The name of the server group.
format: name
maxLength: 255
minLength: 1
type: string
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.
**Available until version 2.63**
items: {}
maxItems: 1
minItems: 1
prefixItems:
- enum:
- affinity
- anti-affinity
type: string
type: array
uniqueItems: true
required:
- name
- policies
type: object
required:
- server_group
type: object
x-openstack:
max-ver: '2.14'
min-ver: '2.0'
Os_Server_GroupsCreate_215:
additionalProperties: false
properties:
server_group:
additionalProperties: false
description: |-
The server group object.
properties:
name:
description: |-
The name of the server group.
format: name
maxLength: 255
minLength: 1
type: string
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.
**Available until version 2.63**
items: {}
maxItems: 1
minItems: 1
prefixItems:
- enum:
- affinity
- anti-affinity
- soft-affinity
- soft-anti-affinity
type: string
type: array
uniqueItems: true
required:
- name
- policies
type: object
required:
- server_group
type: object
x-openstack:
max-ver: '2.63'
min-ver: '2.15'
Os_Server_GroupsCreate_264:
additionalProperties: false
properties:
server_group:
additionalProperties: false
description: |-
The server group object.
properties:
name:
description: |-
The name of the server group.
format: name
maxLength: 255
minLength: 1
type: string
policy:
description: |-
The `policy` field represents the name of the policy. 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.
* `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.
**New in version 2.64**
enum:
- affinity
- anti-affinity
- soft-affinity
- soft-anti-affinity
type: string
rules:
additionalProperties: false
description: |-
The `rules` field, which is a dict, can be applied to the policy.
Currently, only the `max_server_per_host` rule is supported for the
`anti-affinity` policy. The `max_server_per_host` rule allows
specifying how many members of the anti-affinity group can reside on the
same compute host. If not specified, only one member from the same
anti-affinity group can reside on a given host. Requesting policy rules
with any other policy than `anti-affinity` will be 400.
**New in version 2.64**
properties:
max_server_per_host:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
type: object
required:
- name
- policy
type: object
required:
- server_group
type: object
x-openstack:
max-ver: '2.14'
min-ver: '2.64'
Os_Server_GroupsListResponse:
properties:
server_groups:
description: |-
The list of existing server groups.
items:
description: |-
The server group object.
properties:
id:
description: |-
The UUID of the server group.
format: uuid
readOnly: true
type: string
members:
description: |-
A list of members in the server group.
items:
type: string
type: array
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes. It’s always empty and only used for keeping compatibility.
**Available until version 2.63**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
x-openstack:
max-ver: '2.63'
name:
description: |-
The name of the server group.
type: string
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.
**Available until version 2.63**
items:
enum:
- affinity
- anti-affinity
- soft-affinity
- soft-anti-affinity
type: string
maxItems: 1
type: array
x-openstack:
max-ver: '2.63'
policy:
description: |-
The `policy` field represents the name of the policy. 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.
* `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.
**New in version 2.64**
enum:
- affinity
- anti-affinity
- soft-affinity
- soft-anti-affinity
type: string
x-openstack:
min-ver: '2.64'
project_id:
description: |-
The project ID who owns the server group.
**New in version 2.13**
type: string
x-openstack:
min-ver: '2.13'
rules:
additionalProperties: false
description: |-
The `rules` field, which is a dict, can be applied to the policy.
Currently, only the `max_server_per_host` rule is supported for the
`anti-affinity` policy. The `max_server_per_host` rule allows
specifying how many members of the anti-affinity group can reside on the
same compute host. If not specified, only one member from the same
anti-affinity group can reside on a given host.
**New in version 2.64**
properties:
max_server_per_host:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
type: object
x-openstack:
min-ver: '2.64'
user_id:
description: |-
The user ID who owns the server group.
**New in version 2.13**
type: string
x-openstack:
min-ver: '2.13'
required:
- id
- name
- policy
- project_id
- user_id
type: object
type: array
required:
- server_groups
type: object
Os_ServiceUpdateRequest:
oneOf:
- $ref: '#/components/schemas/Os_ServiceUpdate_20'
- $ref: '#/components/schemas/Os_ServiceUpdate_211'
- $ref: '#/components/schemas/Os_ServiceUpdate_253'
x-openstack:
discriminator: microversion
Os_ServiceUpdateResponse:
properties:
service:
description: |-
Object representing a compute service.
properties:
binary:
description: |-
The binary name of the service.
type: string
disabled_reason:
description: |-
The reason for disabling a service.
type: string
forced_down:
description: |-
Whether or not this service was forced down manually by an
administrator after the service was fenced. This value is useful
to know that some 3rd party has verified the service should be
marked down.
type: boolean
x-openstack:
min-ver: '2.11'
host:
description: |-
The name of the host.
type: string
id:
description: |-
The id of the service as a uuid.
format: uuid
readOnly: true
type:
- integer
- string
name:
description: Service name
type: string
state:
description: |-
The state of the service. One of `up` or `down`.
type: string
status:
description: |-
The status of the service. One of `enabled` or `disabled`.
enum:
- disabled
- enabled
readOnly: true
type: string
updated_at:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
readOnly: true
type: string
zone:
description: |-
The availability zone name.
type: string
x-openstack-sdk-name: availability_zone
required:
- host
- id
- state
- status
- zone
type: object
type: object
Os_ServiceUpdate_20:
additionalProperties: false
properties:
binary:
maxLength: 255
minLength: 1
type: string
disabled_reason:
description: |-
The reason for disabling a service. The minimum length is 1 and the
maximum length is 255. This may only be requested with `status=disabled`.
maxLength: 255
minLength: 1
type: string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
required:
- binary
- host
type: object
x-openstack:
max-ver: '2.10'
min-ver: '2.0'
Os_ServiceUpdate_211:
additionalProperties: false
properties:
binary:
maxLength: 255
minLength: 1
type: string
disabled_reason:
description: |-
The reason for disabling a service. The minimum length is 1 and the
maximum length is 255. This may only be requested with `status=disabled`.
maxLength: 255
minLength: 1
type: string
forced_down:
description: |-
`forced_down` is a manual override to tell nova that the service in
question has been fenced manually by the operations team (either hard
powered off, or network unplugged). That signals that it is safe to proceed
with `evacuate` or other operations that nova has safety checks to
prevent for hosts that are up.
Warning
Setting a service forced down without completely fencing it will likely
result in the corruption of VMs on that host.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
required:
- binary
- host
type: object
x-openstack:
max-ver: '2.52'
min-ver: '2.11'
Os_ServiceUpdate_253:
additionalProperties: false
properties:
disabled_reason:
description: |-
The reason for disabling a service. The minimum length is 1 and the
maximum length is 255. This may only be requested with `status=disabled`.
maxLength: 255
minLength: 1
type: string
forced_down:
description: |-
`forced_down` is a manual override to tell nova that the service in
question has been fenced manually by the operations team (either hard
powered off, or network unplugged). That signals that it is safe to proceed
with `evacuate` or other operations that nova has safety checks to
prevent for hosts that are up.
Warning
Setting a service forced down without completely fencing it will likely
result in the corruption of VMs on that host.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
status:
description: |-
The status of the service. One of `enabled` or `disabled`.
enum:
- disabled
- enabled
type: string
type: object
x-openstack:
max-ver: '2.10'
min-ver: '2.53'
Os_ServicesListResponse:
properties:
services:
description: |-
A list of service objects.
items:
description: |-
Object representing a compute service.
properties:
binary:
description: |-
The binary name of the service.
type: string
disabled_reason:
description: |-
The reason for disabling a service.
type: string
forced_down:
description: |-
Whether or not this service was forced down manually by an
administrator after the service was fenced. This value is useful
to know that some 3rd party has verified the service should be
marked down.
type: boolean
x-openstack:
min-ver: '2.11'
host:
description: |-
The name of the host.
type: string
id:
description: |-
The id of the service as a uuid.
format: uuid
readOnly: true
type:
- integer
- string
name:
description: Service name
type: string
state:
description: |-
The state of the service. One of `up` or `down`.
type: string
status:
description: |-
The status of the service. One of `enabled` or `disabled`.
enum:
- disabled
- enabled
readOnly: true
type: string
updated_at:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
readOnly: true
type: string
zone:
description: |-
The availability zone name.
type: string
x-openstack-sdk-name: availability_zone
required:
- host
- id
- state
- status
- zone
type: object
type: array
type: object
Os_Simple_Tenant_UsageListResponse:
properties:
tenant_usages:
description: |-
A list of the tenant usage objects.
items:
properties:
server_usages:
description: |-
A list of the server usage objects.
items:
properties:
ended_at:
description: The date and time when the server was
deleted.
format: date-time
type: string
flavor:
description: The display name of a flavor.
type: string
hours:
description: The duration that the server exists (in
hours).
format: float
type: number
instance_id:
description: The UUID of the server.
format: uuid
type: string
local_gb:
description: The sum of the root disk size of the server
and the ephemeral disk size of it (in GiB).
type: integer
memory_mb:
description: The memory size of the server (in MiB).
type: integer
name:
description: The server name.
type: string
started_at:
description: The date and time when the server was
launched.
format: date-time
type: string
state:
description: The VM state.
type: string
tenant_id:
description: The UUID of the project in a multi-tenancy
cloud.
type: string
uptime:
description: The uptime of the server.
type: integer
vcpus:
description: The number of virtual CPUs that the server
uses.
type: integer
type: object
type: array
start:
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`.
format: date-time
type: string
stop:
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`.
format: date-time
type: string
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
type: string
total_hours:
description: |-
The total duration that servers exist (in hours).
format: float
type: number
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.
format: float
type: number
total_memory_mb_usage:
description: |-
Multiplying the server memory size (in MiB) by hours the server exists,
and then adding that all together for each server.
format: float
type: number
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.
format: float
type: number
type: object
type: array
tenant_usages_links:
description: |-
Links pertaining to usage. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
**New in version 2.40**
items:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
type: object
Os_Simple_Tenant_UsageShowResponse:
properties:
tenant_usages:
description: |-
A list of the tenant usage objects.
items:
properties:
server_usages:
description: |-
A list of the server usage objects.
items:
properties:
ended_at:
description: The date and time when the server was
deleted.
format: date-time
type: string
flavor:
description: The display name of a flavor.
type: string
hours:
description: The duration that the server exists (in
hours).
format: float
type: number
instance_id:
description: The UUID of the server.
format: uuid
type: string
local_gb:
description: The sum of the root disk size of the server
and the ephemeral disk size of it (in GiB).
type: integer
memory_mb:
description: The memory size of the server (in MiB).
type: integer
name:
description: The server name.
type: string
started_at:
description: The date and time when the server was
launched.
format: date-time
type: string
state:
description: The VM state.
type: string
tenant_id:
description: The UUID of the project in a multi-tenancy
cloud.
type: string
uptime:
description: The uptime of the server.
type: integer
vcpus:
description: The number of virtual CPUs that the server
uses.
type: integer
type: object
type: array
start:
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`.
format: date-time
type: string
stop:
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`.
format: date-time
type: string
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
type: string
total_hours:
description: |-
The total duration that servers exist (in hours).
format: float
type: number
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.
format: float
type: number
total_memory_mb_usage:
description: |-
Multiplying the server memory size (in MiB) by hours the server exists,
and then adding that all together for each server.
format: float
type: number
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.
format: float
type: number
type: object
type: array
tenant_usages_links:
description: |-
Links pertaining to usage. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
**New in version 2.40**
items:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
type: object
Os_SnapshotShowResponse:
additionalProperties: false
properties:
snapshot:
additionalProperties: false
description: |-
A partial representation of a snapshot that is used to create a snapshot.
properties:
createdAt:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
displayDescription:
description: |-
The snapshot description.
type:
- 'null'
- string
displayName:
description: |-
The snapshot name.
type:
- 'null'
- string
id:
description: |-
The UUID for a snapshot.
format: uuid
type: string
size:
description: |-
The size of the volume, in gibibytes (GiB).
type: integer
status:
description: |-
The status of the snapshot. Valid status values are:
* `available`
* `creating`
* `deleting`
* `error`
* `error_deleting`
enum:
- available
- backing-up
- creating
- deleted
- deleting
- error
- error_deleting
- restoring
- unmanaging
type: string
volumeId:
description: |-
The source volume ID.
format: uuid
type: string
required:
- createdAt
- displayDescription
- displayName
- id
- size
- status
- volumeId
type: object
required:
- snapshot
type: object
Os_SnapshotsCreateResponse:
additionalProperties: false
properties:
snapshot:
additionalProperties: false
description: |-
A partial representation of a snapshot that is used to create a snapshot.
properties:
createdAt:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
displayDescription:
description: |-
The snapshot description.
type:
- 'null'
- string
displayName:
description: |-
The snapshot name.
type:
- 'null'
- string
id:
description: |-
The UUID for a snapshot.
format: uuid
type: string
size:
description: |-
The size of the volume, in gibibytes (GiB).
type: integer
status:
description: |-
The status of the snapshot. Valid status values are:
* `available`
* `creating`
* `deleting`
* `error`
* `error_deleting`
enum:
- available
- backing-up
- creating
- deleted
- deleting
- error
- error_deleting
- restoring
- unmanaging
type: string
volumeId:
description: |-
The source volume ID.
format: uuid
type: string
required:
- createdAt
- displayDescription
- displayName
- id
- size
- status
- volumeId
type: object
required:
- snapshot
type: object
Os_SnapshotsCreate_21:
additionalProperties: false
properties:
snapshot:
additionalProperties: false
description: |-
A partial representation of a snapshot that is used to create a snapshot.
properties:
display_description:
description: |-
The snapshot description.
type: string
display_name:
description: |-
The snapshot name.
type: string
force:
description: |-
Indicates whether to create a snapshot, even if the volume is attached.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
volume_id:
description: |-
The source volume ID.
type: string
required:
- volume_id
type: object
required:
- snapshot
type: object
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
Os_SnapshotsDetailResponse:
additionalProperties: false
properties:
snapshots:
description: |-
A list of snapshot objects.
items:
additionalProperties: false
description: |-
A partial representation of a snapshot that is used to create a snapshot.
properties:
createdAt:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
displayDescription:
description: |-
The snapshot description.
type:
- 'null'
- string
displayName:
description: |-
The snapshot name.
type:
- 'null'
- string
id:
description: |-
The UUID for a snapshot.
format: uuid
type: string
size:
description: |-
The size of the volume, in gibibytes (GiB).
type: integer
status:
description: |-
The status of the snapshot. Valid status values are:
* `available`
* `creating`
* `deleting`
* `error`
* `error_deleting`
enum:
- available
- backing-up
- creating
- deleted
- deleting
- error
- error_deleting
- restoring
- unmanaging
type: string
volumeId:
description: |-
The source volume ID.
format: uuid
type: string
required:
- createdAt
- displayDescription
- displayName
- id
- size
- status
- volumeId
type: object
type: array
required:
- snapshots
type: object
Os_SnapshotsListResponse:
additionalProperties: false
properties:
snapshots:
description: |-
A list of snapshot objects.
items:
additionalProperties: false
description: |-
A partial representation of a snapshot that is used to create a snapshot.
properties:
createdAt:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
displayDescription:
description: |-
The snapshot description.
type:
- 'null'
- string
displayName:
description: |-
The snapshot name.
type:
- 'null'
- string
id:
description: |-
The UUID for a snapshot.
format: uuid
type: string
size:
description: |-
The size of the volume, in gibibytes (GiB).
type: integer
status:
description: |-
The status of the snapshot. Valid status values are:
* `available`
* `creating`
* `deleting`
* `error`
* `error_deleting`
enum:
- available
- backing-up
- creating
- deleted
- deleting
- error
- error_deleting
- restoring
- unmanaging
type: string
volumeId:
description: |-
The source volume ID.
format: uuid
type: string
required:
- createdAt
- displayDescription
- displayName
- id
- size
- status
- volumeId
type: object
type: array
required:
- snapshots
type: object
Os_Tenant_NetworkShowResponse:
additionalProperties: false
properties:
network:
additionalProperties: false
properties:
cidr:
oneOf:
- const: None
- format: cidr
type: string
id:
format: uuid
type: string
label:
type: string
required:
- cidr
- id
- label
type: object
required:
- network
type: object
Os_Tenant_NetworksCreateResponse: {}
Os_Tenant_NetworksListResponse:
additionalProperties: false
properties:
networks:
items:
additionalProperties: false
properties:
cidr:
oneOf:
- const: None
- format: cidr
type: string
id:
format: uuid
type: string
label:
type: string
required:
- cidr
- id
- label
type: object
type: array
required:
- networks
type: object
Os_VolumeShowResponse:
additionalProperties: false
properties:
volume:
additionalProperties: false
description: |-
The `volume` object.
properties:
attachments:
additionalItems: false
description: |-
The list of volume attachments.
oneOf:
- items:
additionalProperties: false
properties:
device:
type: string
id:
format: uuid
type: string
serverId:
format: uuid
type: string
volumeId:
format: uuid
type: string
required:
- id
- serverId
- volumeId
type: object
- prefixItems:
- additionalProperties: false
properties: {}
required: []
type: object
type: array
availabilityZone:
description: |-
The availability zone name.
type:
- 'null'
- string
createdAt:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
displayDescription:
description: |-
The volume description.
type:
- 'null'
- string
displayName:
description: |-
The volume name.
type:
- 'null'
- string
id:
description: |-
The UUID of the volume.
format: uuid
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
size:
description: |-
The size of the volume, in gibibytes (GiB).
type: integer
snapshotId:
description: |-
The UUID for a snapshot.
oneOf:
- type: 'null'
- format: uuid
type: string
status:
description: |-
The status of the volume.
enum:
- attaching
- available
- awaiting-transfer
- backing-up
- creating
- deleting
- detaching
- downloading
- error
- error_backing-up
- error_deleting
- error_extending
- error_restoring
- extending
- in-use
- maintenance
- reserved
- restoring-backup
- retyping
- uploading
type: string
volumeType:
description: |-
The name or unique identifier for a volume type.
type:
- 'null'
- string
required:
- attachments
- availabilityZone
- createdAt
- displayDescription
- displayName
- id
- metadata
- size
- snapshotId
- status
- volumeType
type: object
required:
- volume
type: object
Os_VolumesCreateResponse:
additionalProperties: false
properties:
volume:
additionalProperties: false
description: |-
The `volume` object.
properties:
attachments:
additionalItems: false
description: |-
The list of volume attachments.
oneOf:
- items:
additionalProperties: false
properties:
device:
type: string
id:
format: uuid
type: string
serverId:
format: uuid
type: string
volumeId:
format: uuid
type: string
required:
- id
- serverId
- volumeId
type: object
- prefixItems:
- additionalProperties: false
properties: {}
required: []
type: object
type: array
availabilityZone:
description: |-
The availability zone name.
type:
- 'null'
- string
createdAt:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
displayDescription:
description: |-
The volume description.
type:
- 'null'
- string
displayName:
description: |-
The volume name.
type:
- 'null'
- string
id:
description: |-
The UUID of the volume.
format: uuid
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
size:
description: |-
The size of the volume, in gibibytes (GiB).
type: integer
snapshotId:
description: |-
The UUID for a snapshot.
oneOf:
- type: 'null'
- format: uuid
type: string
status:
description: |-
The status of the volume.
enum:
- attaching
- available
- awaiting-transfer
- backing-up
- creating
- deleting
- detaching
- downloading
- error
- error_backing-up
- error_deleting
- error_extending
- error_restoring
- extending
- in-use
- maintenance
- reserved
- restoring-backup
- retyping
- uploading
type: string
volumeType:
description: |-
The name or unique identifier for a volume type.
type:
- 'null'
- string
required:
- attachments
- availabilityZone
- createdAt
- displayDescription
- displayName
- id
- metadata
- size
- snapshotId
- status
- volumeType
type: object
required:
- volume
type: object
Os_VolumesCreate_21:
additionalProperties: false
properties:
volume:
additionalProperties: false
description: |-
The `volume` object.
properties:
availability_zone:
description: |-
The availability zone name.
type: string
display_description:
description: |-
The volume description.
type: string
display_name:
description: |-
The volume name.
type: string
metadata:
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
type: object
size:
description: |-
The size of the volume, in gibibytes (GiB).
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
snapshot_id:
description: |-
The UUID for a snapshot.
type: string
volume_type:
description: |-
The unique identifier for a volume type.
type: string
required:
- size
type: object
required:
- volume
type: object
x-openstack:
max-ver: '2.35'
min-ver: '2.1'
Os_VolumesDetailResponse:
additionalProperties: false
properties:
volumes:
description: |-
The list of `volume` objects.
items:
additionalProperties: false
description: |-
The `volume` object.
properties:
attachments:
additionalItems: false
description: |-
The list of volume attachments.
oneOf:
- items:
additionalProperties: false
properties:
device:
type: string
id:
format: uuid
type: string
serverId:
format: uuid
type: string
volumeId:
format: uuid
type: string
required:
- id
- serverId
- volumeId
type: object
- prefixItems:
- additionalProperties: false
properties: {}
required: []
type: object
type: array
availabilityZone:
description: |-
The availability zone name.
type:
- 'null'
- string
createdAt:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
displayDescription:
description: |-
The volume description.
type:
- 'null'
- string
displayName:
description: |-
The volume name.
type:
- 'null'
- string
id:
description: |-
The UUID of the volume.
format: uuid
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
size:
description: |-
The size of the volume, in gibibytes (GiB).
type: integer
snapshotId:
description: |-
The UUID for a snapshot.
oneOf:
- type: 'null'
- format: uuid
type: string
status:
description: |-
The status of the volume.
enum:
- attaching
- available
- awaiting-transfer
- backing-up
- creating
- deleting
- detaching
- downloading
- error
- error_backing-up
- error_deleting
- error_extending
- error_restoring
- extending
- in-use
- maintenance
- reserved
- restoring-backup
- retyping
- uploading
type: string
volumeType:
description: |-
The name or unique identifier for a volume type.
type:
- 'null'
- string
required:
- attachments
- availabilityZone
- createdAt
- displayDescription
- displayName
- id
- metadata
- size
- snapshotId
- status
- volumeType
type: object
type: array
required:
- volumes
type: object
Os_VolumesListResponse:
additionalProperties: false
properties:
volumes:
description: |-
The list of `volume` objects.
items:
additionalProperties: false
description: |-
The `volume` object.
properties:
attachments:
additionalItems: false
description: |-
The list of volume attachments.
oneOf:
- items:
additionalProperties: false
properties:
device:
type: string
id:
format: uuid
type: string
serverId:
format: uuid
type: string
volumeId:
format: uuid
type: string
required:
- id
- serverId
- volumeId
type: object
- prefixItems:
- additionalProperties: false
properties: {}
required: []
type: object
type: array
availabilityZone:
description: |-
The availability zone name.
type:
- 'null'
- string
createdAt:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
displayDescription:
description: |-
The volume description.
type:
- 'null'
- string
displayName:
description: |-
The volume name.
type:
- 'null'
- string
id:
description: |-
The UUID of the volume.
format: uuid
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type:
- 'null'
- string
type: object
size:
description: |-
The size of the volume, in gibibytes (GiB).
type: integer
snapshotId:
description: |-
The UUID for a snapshot.
oneOf:
- type: 'null'
- format: uuid
type: string
status:
description: |-
The status of the volume.
enum:
- attaching
- available
- awaiting-transfer
- backing-up
- creating
- deleting
- detaching
- downloading
- error
- error_backing-up
- error_deleting
- error_extending
- error_restoring
- extending
- in-use
- maintenance
- reserved
- restoring-backup
- retyping
- uploading
type: string
volumeType:
description: |-
The name or unique identifier for a volume type.
type:
- 'null'
- string
required:
- attachments
- availabilityZone
- createdAt
- displayDescription
- displayName
- id
- metadata
- size
- snapshotId
- status
- volumeType
type: object
type: array
required:
- volumes
type: object
Os_Volumes_BootActionAddfixedipResponse:
type: 'null'
x-openstack:
action-name: addFixedIp
Os_Volumes_BootActionAddfloatingipResponse:
type: 'null'
x-openstack:
action-name: addFloatingIp
Os_Volumes_BootActionAddsecuritygroupResponse:
type: 'null'
x-openstack:
action-name: addSecurityGroup
Os_Volumes_BootActionChange_Password:
additionalProperties: false
properties:
changePassword:
additionalProperties: false
properties:
adminPass:
type: string
required:
- adminPass
type: object
required:
- changePassword
type: object
x-openstack:
action-name: changePassword
Os_Volumes_BootActionChangepasswordResponse:
type: 'null'
x-openstack:
action-name: changePassword
Os_Volumes_BootActionConfirmresizeResponse:
type: 'null'
x-openstack:
action-name: confirmResize
Os_Volumes_BootActionCreatebackupRequest:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootAction_Create_Backup_20'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Create_Backup_21'
x-openstack:
action-name: createBackup
discriminator: microversion
Os_Volumes_BootActionCreatebackupResponse:
additionalProperties: false
properties:
image_id:
format: uuid
type: string
required:
- image_id
type: object
x-openstack:
action-name: createBackup
Os_Volumes_BootActionCreateimageRequest:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Create_Image_20'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Create_Image_21'
x-openstack:
action-name: createImage
discriminator: microversion
Os_Volumes_BootActionCreateimageResponse:
additionalProperties: false
properties:
image_id:
format: uuid
type: string
required:
- image_id
type: object
x-openstack:
action-name: createImage
Os_Volumes_BootActionEvacuateRequest:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootAction_Evacuate_20'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Evacuate_214'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Evacuate_229'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Evacuate_268'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Evacuate_295'
x-openstack:
action-name: evacuate
discriminator: microversion
Os_Volumes_BootActionEvacuateResponse:
type: 'null'
x-openstack:
action-name: evacuate
Os_Volumes_BootActionForcedeleteResponse:
type: 'null'
x-openstack:
action-name: forceDelete
Os_Volumes_BootActionGet_Console_Output:
additionalProperties: false
properties:
os-getConsoleOutput:
additionalProperties: false
properties:
length:
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
type: object
required:
- os-getConsoleOutput
type: object
x-openstack:
action-name: os-getConsoleOutput
Os_Volumes_BootActionGet_Serial_Console_21:
additionalProperties: false
properties:
os-getSerialConsole:
additionalProperties: false
properties:
type:
enum:
- serial
type: string
required:
- type
type: object
required:
- os-getSerialConsole
type: object
x-openstack:
action-name: os-getSerialConsole
max-ver: '2.5'
min-ver: '2.1'
Os_Volumes_BootActionGet_Spice_Console_21:
additionalProperties: false
properties:
os-getSPICEConsole:
additionalProperties: false
properties:
type:
enum:
- spice-html5
type: string
required:
- type
type: object
required:
- os-getSPICEConsole
type: object
x-openstack:
action-name: os-getSPICEConsole
max-ver: '2.5'
min-ver: '2.1'
Os_Volumes_BootActionGet_Vnc_Console_21:
additionalProperties: false
properties:
os-getVNCConsole:
additionalProperties: false
properties:
type:
enum:
- novnc
- xvpvnc
type: string
required:
- type
type: object
required:
- os-getVNCConsole
type: object
x-openstack:
action-name: os-getVNCConsole
max-ver: '2.5'
min-ver: '2.1'
Os_Volumes_BootActionInjectnetworkinfoResponse:
type: 'null'
x-openstack:
action-name: injectNetworkInfo
Os_Volumes_BootActionLockRequest:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootAction_Lock_21'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Lock_273'
x-openstack:
action-name: lock
discriminator: microversion
Os_Volumes_BootActionLockResponse:
type: 'null'
x-openstack:
action-name: lock
Os_Volumes_BootActionMigrateResponse:
type: 'null'
x-openstack:
action-name: migrate
Os_Volumes_BootActionOs-GetconsoleoutputResponse:
additionalProperties: false
properties:
output:
type: string
required:
- output
type: object
x-openstack:
action-name: os-getConsoleOutput
Os_Volumes_BootActionOs-GetrdpconsoleRequest:
description: Empty body for os-getRDPConsole action
properties:
os-getRDPConsole:
type: 'null'
type: object
x-openstack:
action-name: os-getRDPConsole
Os_Volumes_BootActionOs-GetrdpconsoleResponse:
additionalProperties: false
properties:
console:
additionalProperties: false
properties:
type:
const: rdp-html5
type: string
url:
format: uri
type: string
required:
- type
- url
type: object
required:
- console
type: object
x-openstack:
action-name: os-getRDPConsole
Os_Volumes_BootActionOs-GetserialconsoleResponse:
additionalProperties: false
properties:
console:
additionalProperties: false
properties:
type:
const: serial
type: string
url:
format: uri
type: string
required:
- type
- url
type: object
required:
- console
type: object
x-openstack:
action-name: os-getSerialConsole
Os_Volumes_BootActionOs-GetspiceconsoleResponse:
additionalProperties: false
properties:
console:
additionalProperties: false
properties:
type:
const: spice-html5
type: string
url:
format: uri
type: string
required:
- type
- url
type: object
type: object
x-openstack:
action-name: os-getSPICEConsole
Os_Volumes_BootActionOs-GetvncconsoleResponse:
additionalProperties: false
properties:
console:
additionalProperties: false
properties:
type:
enum:
- novnc
- xvpvnc
type: string
url:
format: uri
type: string
required:
- type
- url
type: object
required:
- console
type: object
x-openstack:
action-name: os-getVNCConsole
Os_Volumes_BootActionOs-MigrateliveRequest:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootAction_Migrate_Live_20'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Migrate_Live_225'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Migrate_Live_230'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Migrate_Live_268'
x-openstack:
action-name: os-migrateLive
discriminator: microversion
Os_Volumes_BootActionOs-MigrateliveResponse:
type: 'null'
x-openstack:
action-name: os-migrateLive
Os_Volumes_BootActionOs-ResetstateResponse:
type: 'null'
x-openstack:
action-name: os-resetState
Os_Volumes_BootActionOs-StartResponse:
type: 'null'
x-openstack:
action-name: os-start
Os_Volumes_BootActionOs-StopResponse:
type: 'null'
x-openstack:
action-name: os-stop
Os_Volumes_BootActionPauseResponse:
type: 'null'
x-openstack:
action-name: pause
Os_Volumes_BootActionRebootResponse:
type: 'null'
x-openstack:
action-name: reboot
Os_Volumes_BootActionRebuildRequest:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Rebuild_20'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Rebuild_21'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Rebuild_219'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Rebuild_254'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Rebuild_257'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Rebuild_263'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Rebuild_290'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Action_Rebuild_294'
x-openstack:
action-name: rebuild
discriminator: microversion
Os_Volumes_BootActionRebuildResponse:
additionalProperties: false
properties:
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
type: string
OS-EXT-AZ:availability_zone:
type: string
OS-EXT-SRV-ATTR:host:
type:
- 'null'
- string
OS-EXT-SRV-ATTR:hostname:
type: string
OS-EXT-SRV-ATTR:hypervisor_hostname:
type:
- 'null'
- string
OS-EXT-SRV-ATTR:instance_name:
type: string
OS-EXT-SRV-ATTR:kernel_id:
type:
- 'null'
- string
OS-EXT-SRV-ATTR:launch_index:
type: integer
OS-EXT-SRV-ATTR:ramdisk_id:
type:
- 'null'
- string
OS-EXT-SRV-ATTR:reservation_id:
type:
- 'null'
- string
OS-EXT-SRV-ATTR:root_device_name:
type:
- 'null'
- string
OS-EXT-STS:power_state:
enum:
- 0
- 1
- 3
- 4
- 6
- 7
type: integer
OS-EXT-STS:task_state:
type:
- 'null'
- string
OS-EXT-STS:vm_state:
type: string
OS-SRV-USG:launched_at:
format: date-time
type:
- 'null'
- string
OS-SRV-USG:terminated_at:
format: date-time
type:
- 'null'
- string
accessIPv4:
oneOf:
- const: ''
- format: ipv4
type: string
accessIPv6:
oneOf:
- const: ''
- format: ipv6
type: string
addresses:
additionalProperties: false
patternProperties:
^.+$:
items:
additionalProperties: false
properties:
OS-EXT-IPS-MAC:mac_addr:
format: mac-address
type: string
OS-EXT-IPS:type:
enum:
- fixed
- floating
type: string
addr:
oneOf:
- format: ipv4
- format: ipv6
type: string
version:
enum:
- 4
- 6
type: number
required:
- OS-EXT-IPS-MAC:mac_addr
- OS-EXT-IPS:type
- addr
- version
type: object
type: array
type: object
adminPass:
type:
- 'null'
- string
config_drive:
type:
- boolean
- 'null'
- string
created:
format: date-time
type: string
description:
type:
- 'null'
- string
fault:
additionalProperties: false
properties:
code:
type: integer
created:
format: date-time
type: string
details:
type: string
message:
type: string
required:
- code
- created
- message
type: object
flavor:
additionalProperties: false
properties:
disk:
type: integer
ephemeral:
type: integer
extra_specs:
additionalProperties: false
patternProperties:
^.+$:
type: string
type: object
original_name:
type: string
ram:
type: integer
swap:
type: integer
vcpus:
type: integer
required:
- disk
- ephemeral
- original_name
- ram
- swap
- vcpus
type: object
hostId:
type: string
host_status:
type: string
id:
type: string
image:
oneOf:
- additionalProperties: false
properties:
id:
type: string
links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
type: string
required:
- href
- rel
type: object
type: array
properties:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9_:. ]{1,255}$:
maxLength: 255
type: string
type: object
type: object
- const: ''
type: string
key_name:
type:
- 'null'
- string
links:
items:
additionalProperties: false
properties:
href:
format: uri
type: string
rel:
type: string
required:
- href
- rel
type: object
type: array
locked:
type: boolean
locked_reason:
type:
- 'null'
- string
metadata:
additionalProperties: false
patternProperties:
^.+$:
type: string
type: object
name:
type:
- 'null'
- string
os-extended-volumes:volumes_attached:
items:
additionalProperties: false
properties:
delete_on_termination:
default: false
type: boolean
id:
type: string
required:
- delete_on_termination
- id
type: object
type: array
pinned_availability_zone:
type:
- 'null'
- string
progress:
type:
- 'null'
- number
scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
security_groups:
items:
additionalProperties: false
properties:
name:
type: string
required:
- name
type: object
type: array
server_groups:
items:
format: uuid
type: string
maxLength: 1
type: array
status:
type: string
tags:
items:
type: string
maxItems: 50
type: array
tenant_id:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
trusted_image_certificates:
items:
type: string
type:
- array
- 'null'
updated:
format: date-time
type: string
user_data:
format: base64
maxLength: 65535
type:
- 'null'
- string
user_id:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required:
- OS-DCF:diskConfig
- OS-EXT-AZ:availability_zone
- OS-EXT-STS:power_state
- OS-EXT-STS:task_state
- OS-EXT-STS:vm_state
- OS-SRV-USG:launched_at
- OS-SRV-USG:terminated_at
- accessIPv4
- accessIPv6
- addresses
- config_drive
- created
- description
- flavor
- hostId
- id
- image
- key_name
- links
- locked
- locked_reason
- metadata
- name
- os-extended-volumes:volumes_attached
- pinned_availability_zone
- progress
- scheduler_hints
- server_groups
- status
- tags
- tenant_id
- trusted_image_certificates
- updated
- user_data
- user_id
type: object
required:
- server
type: object
x-openstack:
action-name: rebuild
Os_Volumes_BootActionRemovefixedipResponse:
type: 'null'
x-openstack:
action-name: removeFixedIp
Os_Volumes_BootActionRemovefloatingipResponse:
type: 'null'
x-openstack:
action-name: removeFloatingIp
Os_Volumes_BootActionRemovesecuritygroupResponse:
type: 'null'
x-openstack:
action-name: removeSecurityGroup
Os_Volumes_BootActionRescueResponse:
additionalProperties: false
properties:
adminPass:
type: string
type: object
x-openstack:
action-name: rescue
Os_Volumes_BootActionResetnetworkRequest:
description: Empty body for resetNetwork action
properties:
resetNetwork:
type: 'null'
type: object
x-openstack:
action-name: resetNetwork
Os_Volumes_BootActionResetnetworkResponse:
x-openstack:
action-name: resetNetwork
Os_Volumes_BootActionResizeResponse:
type: 'null'
x-openstack:
action-name: resize
Os_Volumes_BootActionRestoreResponse:
type: 'null'
x-openstack:
action-name: restore
Os_Volumes_BootActionResumeResponse:
type: 'null'
x-openstack:
action-name: resume
Os_Volumes_BootActionRevertresizeResponse:
type: 'null'
x-openstack:
action-name: revertResize
Os_Volumes_BootActionShelveResponse:
type: 'null'
x-openstack:
action-name: shelve
Os_Volumes_BootActionShelveoffloadResponse:
type: 'null'
x-openstack:
action-name: shelveOffload
Os_Volumes_BootActionSuspendResponse:
type: 'null'
x-openstack:
action-name: suspend
Os_Volumes_BootActionTrigger_Crash_DumpResponse:
type: 'null'
x-openstack:
action-name: trigger_crash_dump
Os_Volumes_BootActionUnlockResponse:
type: 'null'
x-openstack:
action-name: unlock
Os_Volumes_BootActionUnpauseResponse:
type: 'null'
x-openstack:
action-name: unpause
Os_Volumes_BootActionUnrescueResponse:
type: 'null'
x-openstack:
action-name: unrescue
Os_Volumes_BootActionUnshelveRequest:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootAction_Unshelve_21'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Unshelve_277'
- $ref: '#/components/schemas/Os_Volumes_BootAction_Unshelve_291'
x-openstack:
action-name: unshelve
discriminator: microversion
Os_Volumes_BootActionUnshelveResponse:
type: 'null'
x-openstack:
action-name: unshelve
Os_Volumes_BootAction_Action_Confirm_Resize:
additionalProperties: false
properties:
confirmResize: {}
required:
- confirmResize
type: object
x-openstack:
action-name: confirmResize
Os_Volumes_BootAction_Action_Create_Image_20:
additionalProperties: false
properties:
createImage:
additionalProperties: false
properties:
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
required:
- createImage
type: object
x-openstack:
action-name: createImage
max-ver: '2.0'
min-ver: '2.0'
Os_Volumes_BootAction_Action_Create_Image_21:
additionalProperties: false
properties:
createImage:
additionalProperties: false
properties:
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
required:
- createImage
type: object
x-openstack:
action-name: createImage
max-ver: '2.0'
min-ver: '2.1'
Os_Volumes_BootAction_Action_Reboot:
additionalProperties: false
properties:
reboot:
additionalProperties: false
properties:
type:
enum:
- HARD
- Hard
- SOFT
- Soft
- hard
- soft
type: string
required:
- type
type: object
required:
- reboot
type: object
x-openstack:
action-name: reboot
Os_Volumes_BootAction_Action_Rebuild_20:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
imageRef:
format: uuid
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
preserve_ephemeral:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- imageRef
type: object
required:
- rebuild
type: object
x-openstack:
action-name: rebuild
max-ver: '2.0'
min-ver: '2.0'
Os_Volumes_BootAction_Action_Rebuild_21:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
imageRef:
format: uuid
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
preserve_ephemeral:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- imageRef
type: object
required:
- rebuild
type: object
x-openstack:
action-name: rebuild
max-ver: '2.18'
min-ver: '2.1'
Os_Volumes_BootAction_Action_Rebuild_219:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
imageRef:
format: uuid
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
preserve_ephemeral:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- imageRef
type: object
required:
- rebuild
type: object
x-openstack:
action-name: rebuild
max-ver: '2.53'
min-ver: '2.19'
Os_Volumes_BootAction_Action_Rebuild_254:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
imageRef:
format: uuid
type: string
key_name:
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
preserve_ephemeral:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- imageRef
type: object
required:
- rebuild
type: object
x-openstack:
action-name: rebuild
max-ver: '2.56'
min-ver: '2.54'
Os_Volumes_BootAction_Action_Rebuild_257:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
imageRef:
format: uuid
type: string
key_name:
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
preserve_ephemeral:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
user_data:
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- imageRef
type: object
required:
- rebuild
type: object
x-openstack:
action-name: rebuild
max-ver: '2.62'
min-ver: '2.57'
Os_Volumes_BootAction_Action_Rebuild_263:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
imageRef:
format: uuid
type: string
key_name:
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
preserve_ephemeral:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
trusted_image_certificates:
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- imageRef
type: object
required:
- rebuild
type: object
x-openstack:
action-name: rebuild
max-ver: '2.89'
min-ver: '2.63'
Os_Volumes_BootAction_Action_Rebuild_290:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
hostname:
maxLength: 63
minLength: 2
pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]+$
type: string
imageRef:
format: uuid
type: string
key_name:
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
preserve_ephemeral:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
trusted_image_certificates:
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- imageRef
type: object
required:
- rebuild
type: object
x-openstack:
action-name: rebuild
max-ver: '2.93'
min-ver: '2.90'
Os_Volumes_BootAction_Action_Rebuild_294:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
hostname:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
imageRef:
format: uuid
type: string
key_name:
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
preserve_ephemeral:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
trusted_image_certificates:
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- imageRef
type: object
required:
- rebuild
type: object
x-openstack:
action-name: rebuild
max-ver: '2.0'
min-ver: '2.94'
Os_Volumes_BootAction_Action_Resize:
additionalProperties: false
properties:
resize:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
flavorRef:
minLength: 1
type:
- integer
- string
required:
- flavorRef
type: object
required:
- resize
type: object
x-openstack:
action-name: resize
Os_Volumes_BootAction_Action_Revert_Resize:
additionalProperties: false
properties:
revertResize: {}
required:
- revertResize
type: object
x-openstack:
action-name: revertResize
Os_Volumes_BootAction_Action_Trigger_Crash_Dump_217:
additionalProperties: false
properties:
trigger_crash_dump:
type: 'null'
required:
- trigger_crash_dump
type: object
x-openstack:
action-name: trigger_crash_dump
min-ver: '2.17'
Os_Volumes_BootAction_Add_Fixed_Ip_21:
additionalProperties: false
properties:
addFixedIp:
additionalProperties: false
properties:
networkId:
maxLength: 36
minLength: 1
type:
- number
- string
required:
- networkId
type: object
required:
- addFixedIp
type: object
x-openstack:
action-name: addFixedIp
max-ver: '2.43'
min-ver: '2.1'
Os_Volumes_BootAction_Add_Floating_Ip_21:
additionalProperties: false
properties:
addFloatingIp:
additionalProperties: false
properties:
address:
oneOf:
- format: ipv4
- format: ipv6
type: string
fixed_address:
oneOf:
- format: ipv4
- format: ipv6
type: string
required:
- address
type: object
required:
- addFloatingIp
type: object
x-openstack:
action-name: addFloatingIp
max-ver: '2.43'
min-ver: '2.1'
Os_Volumes_BootAction_Addsecuritygroup:
additionalProperties: true
properties:
addSecurityGroup:
additionalProperties: false
properties:
name:
minLength: 1
type: string
required:
- name
type: object
required:
- addSecurityGroup
type: object
x-openstack:
action-name: addSecurityGroup
Os_Volumes_BootAction_Create_Backup_20:
additionalProperties: false
properties:
createBackup:
additionalProperties: false
properties:
backup_type:
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
rotation:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
required:
- backup_type
- name
- rotation
type: object
required:
- createBackup
type: object
x-openstack:
action-name: createBackup
max-ver: '2.0'
min-ver: '2.0'
Os_Volumes_BootAction_Create_Backup_21:
additionalProperties: false
properties:
createBackup:
additionalProperties: false
properties:
backup_type:
type: string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
format: name
maxLength: 255
minLength: 1
type: string
rotation:
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
required:
- backup_type
- name
- rotation
type: object
required:
- createBackup
type: object
x-openstack:
action-name: createBackup
max-ver: '2.0'
min-ver: '2.1'
Os_Volumes_BootAction_Evacuate_20:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
properties:
adminPass:
type: string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
onSharedStorage:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- onSharedStorage
type: object
required:
- evacuate
type: object
x-openstack:
action-name: evacuate
max-ver: '2.13'
min-ver: '2.0'
Os_Volumes_BootAction_Evacuate_214:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
properties:
adminPass:
type: string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
type: object
required:
- evacuate
type: object
x-openstack:
action-name: evacuate
max-ver: '2.28'
min-ver: '2.14'
Os_Volumes_BootAction_Evacuate_229:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
properties:
adminPass:
type: string
force:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
type: object
required:
- evacuate
type: object
x-openstack:
action-name: evacuate
max-ver: '2.67'
min-ver: '2.29'
Os_Volumes_BootAction_Evacuate_268:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
properties:
adminPass:
type: string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
type: object
required:
- evacuate
type: object
x-openstack:
action-name: evacuate
max-ver: '2.94'
min-ver: '2.68'
Os_Volumes_BootAction_Evacuate_295:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
properties:
adminPass:
type: string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
type: object
required:
- evacuate
type: object
x-openstack:
action-name: evacuate
max-ver: '2.13'
min-ver: '2.95'
Os_Volumes_BootAction_Force_Delete:
additionalProperties: false
properties:
forceDelete: {}
required:
- forceDelete
type: object
x-openstack:
action-name: forceDelete
Os_Volumes_BootAction_Inject_Network_Info:
additionalProperties: false
properties:
injectNetworkInfo: {}
required:
- injectNetworkInfo
type: object
x-openstack:
action-name: injectNetworkInfo
Os_Volumes_BootAction_Lock_21:
additionalProperties: false
properties:
lock: {}
required:
- lock
type: object
x-openstack:
action-name: lock
max-ver: '2.72'
min-ver: '2.1'
Os_Volumes_BootAction_Lock_273:
additionalProperties: false
properties:
lock:
additionalProperties: false
properties:
locked_reason:
maxLength: 255
minLength: 1
type: string
type:
- 'null'
- object
required:
- lock
type: object
x-openstack:
action-name: lock
max-ver: '2.72'
min-ver: '2.73'
Os_Volumes_BootAction_Migrate_256:
additionalProperties: false
properties:
migrate:
additionalProperties: false
properties:
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
type:
- 'null'
- object
required:
- migrate
type: object
x-openstack:
action-name: migrate
min-ver: '2.56'
Os_Volumes_BootAction_Migrate_Live_20:
additionalProperties: false
properties:
os-migrateLive:
additionalProperties: false
properties:
block_migration:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
disk_over_commit:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
required:
- block_migration
- disk_over_commit
- host
type: object
required:
- os-migrateLive
type: object
x-openstack:
action-name: os-migrateLive
max-ver: '2.24'
min-ver: '2.0'
Os_Volumes_BootAction_Migrate_Live_225:
additionalProperties: false
properties:
os-migrateLive:
additionalProperties: false
properties:
block_migration:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- auto
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
required:
- block_migration
- host
type: object
required:
- os-migrateLive
type: object
x-openstack:
action-name: os-migrateLive
max-ver: '2.29'
min-ver: '2.25'
Os_Volumes_BootAction_Migrate_Live_230:
additionalProperties: false
properties:
os-migrateLive:
additionalProperties: false
properties:
block_migration:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- auto
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
force:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
required:
- block_migration
- host
type: object
required:
- os-migrateLive
type: object
x-openstack:
action-name: os-migrateLive
max-ver: '2.67'
min-ver: '2.30'
Os_Volumes_BootAction_Migrate_Live_268:
additionalProperties: false
properties:
os-migrateLive:
additionalProperties: false
properties:
block_migration:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- auto
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
required:
- block_migration
- host
type: object
required:
- os-migrateLive
type: object
x-openstack:
action-name: os-migrateLive
max-ver: '2.24'
min-ver: '2.68'
Os_Volumes_BootAction_Pause:
additionalProperties: false
properties:
pause: {}
required:
- pause
type: object
x-openstack:
action-name: pause
Os_Volumes_BootAction_Remove_Fixed_Ip_21:
additionalProperties: false
properties:
removeFixedIp:
additionalProperties: false
properties:
address:
oneOf:
- format: ipv4
- format: ipv6
type: string
required:
- address
type: object
required:
- removeFixedIp
type: object
x-openstack:
action-name: removeFixedIp
max-ver: '2.43'
min-ver: '2.1'
Os_Volumes_BootAction_Remove_Floating_Ip_21:
additionalProperties: false
properties:
removeFloatingIp:
additionalProperties: false
properties:
address:
oneOf:
- format: ipv4
- format: ipv6
type: string
required:
- address
type: object
required:
- removeFloatingIp
type: object
x-openstack:
action-name: removeFloatingIp
max-ver: '2.43'
min-ver: '2.1'
Os_Volumes_BootAction_Removesecuritygroup:
additionalProperties: true
properties:
removeSecurityGroup:
additionalProperties: false
properties:
name:
minLength: 1
type: string
required:
- name
type: object
required:
- removeSecurityGroup
type: object
x-openstack:
action-name: removeSecurityGroup
Os_Volumes_BootAction_Rescue:
additionalProperties: false
properties:
rescue:
additionalProperties: false
properties:
adminPass:
type: string
rescue_image_ref:
format: uuid
type: string
type:
- 'null'
- object
required:
- rescue
type: object
x-openstack:
action-name: rescue
Os_Volumes_BootAction_Reset_State:
additionalProperties: false
properties:
os-resetState:
additionalProperties: false
properties:
state:
enum:
- active
- error
type: string
required:
- state
type: object
required:
- os-resetState
type: object
x-openstack:
action-name: os-resetState
Os_Volumes_BootAction_Restore:
additionalProperties: false
properties:
restore: {}
required:
- restore
type: object
x-openstack:
action-name: restore
Os_Volumes_BootAction_Resume:
additionalProperties: false
properties:
resume: {}
required:
- resume
type: object
x-openstack:
action-name: resume
Os_Volumes_BootAction_Shelve:
additionalProperties: false
properties:
shelve: {}
required:
- shelve
type: object
x-openstack:
action-name: shelve
Os_Volumes_BootAction_Shelve_Offload:
additionalProperties: false
properties:
shelveOffload: {}
required:
- shelveOffload
type: object
x-openstack:
action-name: shelveOffload
Os_Volumes_BootAction_Start_Server:
additionalProperties: false
properties:
os-start: {}
required:
- os-start
type: object
x-openstack:
action-name: os-start
Os_Volumes_BootAction_Stop_Server:
additionalProperties: false
properties:
os-stop: {}
required:
- os-stop
type: object
x-openstack:
action-name: os-stop
Os_Volumes_BootAction_Suspend:
additionalProperties: false
properties:
suspend: {}
required:
- suspend
type: object
x-openstack:
action-name: suspend
Os_Volumes_BootAction_Unlock_21:
additionalProperties: false
properties:
unlock: {}
required:
- unlock
type: object
x-openstack:
action-name: unlock
max-ver: '2.72'
min-ver: '2.1'
Os_Volumes_BootAction_Unpause:
additionalProperties: false
properties:
unpause: {}
required:
- unpause
type: object
x-openstack:
action-name: unpause
Os_Volumes_BootAction_Unrescue:
additionalProperties: false
properties:
unrescue: {}
required:
- unrescue
type: object
x-openstack:
action-name: unrescue
Os_Volumes_BootAction_Unshelve_21:
additionalProperties: false
properties:
unshelve: {}
required:
- unshelve
type: object
x-openstack:
action-name: unshelve
max-ver: '2.76'
min-ver: '2.1'
Os_Volumes_BootAction_Unshelve_277:
additionalProperties: false
properties:
unshelve:
additionalProperties: false
properties:
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
required:
- availability_zone
type:
- 'null'
- object
required:
- unshelve
type: object
x-openstack:
action-name: unshelve
max-ver: '2.90'
min-ver: '2.77'
Os_Volumes_BootAction_Unshelve_291:
additionalProperties: false
properties:
unshelve:
additionalProperties: false
properties:
availability_zone:
type:
- 'null'
- string
host:
type: string
type:
- 'null'
- object
required:
- unshelve
type: object
x-openstack:
action-name: unshelve
max-ver: '2.76'
min-ver: '2.91'
Os_Volumes_BootCreateRequest:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootCreate_20'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_21'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_219'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_232'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_233'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_237'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_242'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_252'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_257'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_263'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_267'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_274'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_290'
- $ref: '#/components/schemas/Os_Volumes_BootCreate_294'
x-openstack:
discriminator: microversion
Os_Volumes_BootCreateResponse:
description: Response of the os-volumes_boot:post operation
type: object
Os_Volumes_BootCreate_20:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
networks:
items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
uuid:
type: string
type: object
type: array
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.0'
Os_Volumes_BootCreate_21:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
uuid:
type: string
type: object
type: array
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.18'
min-ver: '2.1'
Os_Volumes_BootCreate_219:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
uuid:
type: string
type: object
type: array
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.31'
min-ver: '2.19'
Os_Volumes_BootCreate_232:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
type: string
type: object
type: array
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.32'
min-ver: '2.32'
Os_Volumes_BootCreate_233:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
type: string
type: object
type: array
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.36'
min-ver: '2.33'
Os_Volumes_BootCreate_237:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.41'
min-ver: '2.37'
Os_Volumes_BootCreate_242:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.51'
min-ver: '2.42'
Os_Volumes_BootCreate_252:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
personality:
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.56'
min-ver: '2.52'
Os_Volumes_BootCreate_257:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.62'
min-ver: '2.57'
Os_Volumes_BootCreate_263:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.66'
min-ver: '2.63'
Os_Volumes_BootCreate_267:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
volume_type:
maxLength: 255
minLength: 0
type:
- 'null'
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.73'
min-ver: '2.67'
Os_Volumes_BootCreate_274:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
volume_type:
maxLength: 255
minLength: 0
type:
- 'null'
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
hypervisor_hostname:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.89'
min-ver: '2.74'
Os_Volumes_BootCreate_290:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
volume_type:
maxLength: 255
minLength: 0
type:
- 'null'
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
hostname:
maxLength: 63
minLength: 2
pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]+$
type: string
hypervisor_hostname:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.93'
min-ver: '2.90'
Os_Volumes_BootCreate_294:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
items:
type: string
type:
- array
- string
different_host:
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
format: uuid
type: string
query:
type:
- object
- string
same_host:
items:
format: uuid
type: string
type:
- array
- string
target_cell:
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
adminPass:
type: string
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
block_device_mapping_v2:
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
volume_type:
maxLength: 255
minLength: 0
type:
- 'null'
- string
type: object
type: array
config_drive:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
minLength: 1
type:
- integer
- string
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
hostname:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
hypervisor_hostname:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
imageRef:
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
networks:
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
security_groups:
items:
additionalProperties: false
properties:
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.94'
Os_Volumes_BootDetailResponse:
description: Response of the os-volumes_boot/detail:get operation
type: object
Os_Volumes_BootListResponse:
description: Response of the os-volumes_boot:get operation
type: object
Os_Volumes_BootShowResponse:
description: Response of the os-volumes_boot/id:get operation
type: object
Os_Volumes_BootUpdateRequest:
oneOf:
- $ref: '#/components/schemas/Os_Volumes_BootUpdate_20'
- $ref: '#/components/schemas/Os_Volumes_BootUpdate_21'
- $ref: '#/components/schemas/Os_Volumes_BootUpdate_219'
- $ref: '#/components/schemas/Os_Volumes_BootUpdate_290'
- $ref: '#/components/schemas/Os_Volumes_BootUpdate_294'
x-openstack:
discriminator: microversion
Os_Volumes_BootUpdateResponse:
description: Response of the os-volumes_boot/id:put operation
type: object
Os_Volumes_BootUpdate_20:
additionalProperties: false
properties:
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
name:
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.0'
Os_Volumes_BootUpdate_21:
additionalProperties: false
properties:
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.18'
min-ver: '2.1'
Os_Volumes_BootUpdate_219:
additionalProperties: false
properties:
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.89'
min-ver: '2.19'
Os_Volumes_BootUpdate_290:
additionalProperties: false
properties:
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
hostname:
maxLength: 63
minLength: 2
pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]+$
type: string
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.93'
min-ver: '2.90'
Os_Volumes_BootUpdate_294:
additionalProperties: false
properties:
server:
additionalProperties: false
properties:
OS-DCF:diskConfig:
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
format: ipv4
type: string
accessIPv6:
format: ipv6
type: string
description:
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
hostname:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
name:
format: name
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.94'
RootShowResponse:
additionalProperties: false
properties:
version:
additionalProperties: false
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.
properties:
id:
description: |-
A common name for the version in question. Informative only, it has no real semantic meaning.
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
additionalProperties: false
properties:
href:
type: string
rel:
type: string
type:
type: string
required:
- href
- rel
type: object
type: array
media-types:
items:
additionalProperties: false
properties:
base:
type: string
type:
type: string
required:
- base
- type
type: object
type: array
min_version:
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.
type: string
status:
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
enum:
- CURRENT
- DEPRECATED
- SUPPORTED
type: string
updated:
description: |-
This is a fixed string. It is `2011-01-21T11:33:21Z` in version 2.0,
`2013-07-23T11:33:21Z` in version 2.1.
Note
It is vestigial and provides no useful information.
It will be deprecated and removed in the future.
format: date-time
type: string
version:
type: string
required:
- id
- links
- min_version
- status
- updated
type: object
required:
- version
type: object
ServerShowResponse:
properties:
server:
description: |-
A `server` object.
properties:
OS-DCF:diskConfig:
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.
enum:
- AUTO
- MANUAL
type: string
OS-EXT-AZ:availability_zone:
description: |-
The availability zone name.
**New in version 2.75**
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.
**New in version 2.75**
type: string
OS-EXT-SRV-ATTR:hostname:
description: |-
The hostname of the instance reported in the metadata service.
This parameter only appears in responses for administrators until
microversion 2.90, after which it is shown for all users.
Note
This information is published via the metadata service and requires
application such as `cloud-init` to propagate it through to the
instance.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
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 uuid. Appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack-sdk-name: hypervisor_hostname
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.
**New in version 2.75**
type: string
OS-EXT-SRV-ATTR:kernel_id:
description: |-
The UUID of the kernel image when using an AMI. Will be null if not.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:launch_index:
description: |-
When servers are launched via multiple create, this is the
sequence in which the servers were launched.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: integer
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:ramdisk_id:
description: |-
The UUID of the ramdisk image when using an AMI. Will be null if not.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR: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.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:root_device_name:
description: |-
The root device name for the instance
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:user_data:
description: |-
The user_data the instance was created with.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
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
```
**New in version 2.75**
type: integer
OS-EXT-STS:task_state:
description: |-
The task state of the instance.
**New in version 2.75**
type: string
OS-EXT-STS:vm_state:
description: |-
The VM state.
**New in version 2.75**
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](https://en.wikipedia.org/wiki/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`.
**New in version 2.75**
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](https://en.wikipedia.org/wiki/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`.
**New in version 2.75**
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server. May be
automatically set by the provider.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server. May be
automatically set by the provider.
format: ipv6
type: string
addresses:
additionalProperties:
items:
properties:
addr:
description: The IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
version:
description: The IP version of the address associated with
server.
enum:
- 4
- 6
type: integer
type: object
type: array
description: |-
The addresses for the server. Servers with status `BUILD` hide their
addresses information.
This view is not updated immediately.
Please consult with OpenStack Networking API for up-to-date information.
type: object
config_drive:
description: |-
Indicates whether or not a config drive was used for this server.
The value is `True` or an empty string. An empty string stands for
`False`.
**New in version 2.75**
type: string
created:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
readOnly: true
type: string
description:
description: |-
The description of the server.
Before microversion 2.19 this was set to the server name.
**New in version 2.19**
type: string
fault:
additionalProperties: false
description: |-
A fault object. Only displayed when the server status is `ERROR` or
`DELETED` and a fault occurred.
properties:
code:
description: |-
The error response code.
type: integer
created:
description: |-
The date and time when the exception was raised. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
details:
description: |-
The stack trace. It is available if the response code is not 500 or
you have the administrator privilege
type: string
message:
description: |-
The error message.
type: string
type: object
flavor:
description: |-
Before microversion 2.47 this contains the ID and links for the flavor
used to boot the server instance. This can be an empty object in case
flavor information is no longer present in the system.
As of microversion 2.47 this contains a subset of the actual flavor
information used to create the server instance, represented as a nested
dictionary.
properties:
disk:
description: |-
The size of the root disk that was created in GiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
ephemeral:
description: |-
The size of the ephemeral disk that was created, in GiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
extra_specs:
additionalProperties: false
description: |-
A dictionary of the flavor’s extra-specs key-and-value pairs. This will
only be included if the user is allowed by policy to index flavor
extra_specs.
**New in version 2.47**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
x-openstack:
min-ver: '2.47'
id:
description: |-
The UUID of the server.
type: string
x-openstack:
max-ver: '2.46'
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
description: Links to the resources in question. See [API
Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
x-openstack:
max-ver: '2.46'
original_name:
description: |-
The display name of a flavor.
**New in version 2.47**
type: string
x-openstack:
min-ver: '2.47'
ram:
description: |-
The amount of RAM a flavor has, in MiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
swap:
description: |-
The size of a dedicated swap disk that was allocated, in MiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
vcpus:
description: |-
The number of virtual CPUs that were allocated to the server.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
type: object
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.
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.
By default, only administrators can get this parameter.
**New in version 2.75**
enum:
- ''
- DOWN
- MAINTENANCE
- UNKNOWN
- UP
- 'null'
type:
- 'null'
- string
x-openstack:
min-ver: '2.16'
id:
description: Id of the server
format: uuid
readOnly: true
type: string
image:
description: |-
The UUID and links for the image for your server instance. The `image` object
will be an empty string when you boot the server from a volume.
oneOf:
- description: The image property as returned from server.
properties:
id:
description: The image ID
format: uuid
type: string
links:
description: Links to the resources in question. See [API
Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
description: Links to the resources in question. See
[API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
properties:
type: object
x-openstack:
min-ver: '2.98'
required:
- id
type: object
- enum:
- ''
type: string
key_name:
description: |-
The name of associated key pair, if any.
**New in version 2.75**
type: string
links:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
description: Links to the resources in question. See [API Guide
/ Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
locked:
description: |-
True if the instance is locked otherwise False.
**New in version 2.9**
type: boolean
x-openstack:
min-ver: '2.9'
metadata:
additionalProperties: false
description: |-
A dictionary of metadata key-and-value pairs, which is maintained for backward
compatibility.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
type: string
os-extended-volumes:volumes_attached:
description: |-
The attached volumes, if any.
**New in version 2.75**
items:
type: object
type: array
progress:
description: |-
A percentage value of the operation progress.
This parameter only appears when the server status is `ACTIVE`,
`BUILD`, `REBUILD`, `RESIZE`, `VERIFY_RESIZE` or `MIGRATING`.
type: integer
security_groups:
description: |-
One or more security groups objects.
**New in version 2.75**
items:
properties:
name:
description: The security group name
type: string
type: object
type: array
server_groups:
description: |-
The UUIDs of the server groups to which the server belongs. Currently
this can contain at most one entry.
**New in version 2.71**
items:
type: string
type: array
x-openstack:
min-ver: '2.71'
status:
description: |-
The server status.
readOnly: true
type: string
tags:
description: |-
A list of tags. The maximum count of tags in this list is 50.
**New in version 2.26**
items:
type: string
type: array
x-openstack:
min-ver: '2.26'
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
format: uuid
type: string
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, that were used during image signature
verification to verify the signing certificate. The list is restricted
to a maximum of 50 IDs. The value is `null` if trusted certificate IDs
are not set.
**New in version 2.63**
items:
type: string
type:
- array
- 'null'
x-openstack:
min-ver: '2.63'
updated:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
readOnly: true
type: string
user_id:
description: |-
The user ID of the user who owns the server.
type: string
required:
- flavor
- id
- image
- name
type: object
type: object
ServerUpdateRequest:
oneOf:
- $ref: '#/components/schemas/ServerUpdate_20'
- $ref: '#/components/schemas/ServerUpdate_21'
- $ref: '#/components/schemas/ServerUpdate_219'
- $ref: '#/components/schemas/ServerUpdate_290'
- $ref: '#/components/schemas/ServerUpdate_294'
x-openstack:
discriminator: microversion
ServerUpdateResponse:
properties:
server:
description: |-
A `server` object.
properties:
OS-DCF:diskConfig:
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.
enum:
- AUTO
- MANUAL
type: string
OS-EXT-AZ:availability_zone:
description: |-
The availability zone name.
**New in version 2.75**
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.
**New in version 2.75**
type: string
OS-EXT-SRV-ATTR:hostname:
description: |-
The hostname of the instance reported in the metadata service.
This parameter only appears in responses for administrators until
microversion 2.90, after which it is shown for all users.
Note
This information is published via the metadata service and requires
application such as `cloud-init` to propagate it through to the
instance.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
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 uuid. Appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack-sdk-name: hypervisor_hostname
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.
**New in version 2.75**
type: string
OS-EXT-SRV-ATTR:kernel_id:
description: |-
The UUID of the kernel image when using an AMI. Will be null if not.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:launch_index:
description: |-
When servers are launched via multiple create, this is the
sequence in which the servers were launched.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: integer
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:ramdisk_id:
description: |-
The UUID of the ramdisk image when using an AMI. Will be null if not.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR: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.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:root_device_name:
description: |-
The root device name for the instance
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:user_data:
description: |-
The user_data the instance was created with.
By default, it appears in the response for administrative users only.
**New in version 2.75**
type: string
x-openstack:
min-ver: '2.3'
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
```
**New in version 2.75**
type: integer
OS-EXT-STS:task_state:
description: |-
The task state of the instance.
**New in version 2.75**
type: string
OS-EXT-STS:vm_state:
description: |-
The VM state.
**New in version 2.75**
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](https://en.wikipedia.org/wiki/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`.
**New in version 2.75**
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](https://en.wikipedia.org/wiki/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`.
**New in version 2.75**
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server. May be
automatically set by the provider.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server. May be
automatically set by the provider.
format: ipv6
type: string
addresses:
additionalProperties:
items:
properties:
addr:
description: The IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
version:
description: The IP version of the address associated with
server.
enum:
- 4
- 6
type: integer
type: object
type: array
description: |-
The addresses for the server. Servers with status `BUILD` hide their
addresses information.
This view is not updated immediately.
Please consult with OpenStack Networking API for up-to-date information.
type: object
config_drive:
description: |-
Indicates whether or not a config drive was used for this server.
The value is `True` or an empty string. An empty string stands for
`False`.
**New in version 2.75**
type: string
created:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
readOnly: true
type: string
description:
description: |-
The description of the server.
Before microversion 2.19 this was set to the server name.
**New in version 2.19**
type: string
fault:
additionalProperties: false
description: |-
A fault object. Only displayed when the server status is `ERROR` or
`DELETED` and a fault occurred.
properties:
code:
description: |-
The error response code.
type: integer
created:
description: |-
The date and time when the exception was raised. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
details:
description: |-
The stack trace. It is available if the response code is not 500 or
you have the administrator privilege
type: string
message:
description: |-
The error message.
type: string
type: object
flavor:
description: |-
Before microversion 2.47 this contains the ID and links for the flavor
used to boot the server instance. This can be an empty object in case
flavor information is no longer present in the system.
As of microversion 2.47 this contains a subset of the actual flavor
information used to create the server instance, represented as a nested
dictionary.
properties:
disk:
description: |-
The size of the root disk that was created in GiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
ephemeral:
description: |-
The size of the ephemeral disk that was created, in GiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
extra_specs:
additionalProperties: false
description: |-
A dictionary of the flavor’s extra-specs key-and-value pairs. This will
only be included if the user is allowed by policy to index flavor
extra_specs.
**New in version 2.47**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
x-openstack:
min-ver: '2.47'
id:
description: |-
The UUID of the server.
type: string
x-openstack:
max-ver: '2.46'
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
description: Links to the resources in question. See [API
Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
x-openstack:
max-ver: '2.46'
original_name:
description: |-
The display name of a flavor.
**New in version 2.47**
type: string
x-openstack:
min-ver: '2.47'
ram:
description: |-
The amount of RAM a flavor has, in MiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
swap:
description: |-
The size of a dedicated swap disk that was allocated, in MiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
vcpus:
description: |-
The number of virtual CPUs that were allocated to the server.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
type: object
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.
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.
By default, only administrators can get this parameter.
**New in version 2.75**
enum:
- ''
- DOWN
- MAINTENANCE
- UNKNOWN
- UP
- 'null'
type:
- 'null'
- string
x-openstack:
min-ver: '2.16'
id:
description: Id of the server
format: uuid
readOnly: true
type: string
image:
description: |-
The UUID and links for the image for your server instance. The `image` object
will be an empty string when you boot the server from a volume.
oneOf:
- description: The image property as returned from server.
properties:
id:
description: The image ID
format: uuid
type: string
links:
description: Links to the resources in question. See [API
Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
description: Links to the resources in question. See
[API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
properties:
type: object
x-openstack:
min-ver: '2.98'
required:
- id
type: object
- enum:
- ''
type: string
key_name:
description: |-
The name of associated key pair, if any.
**New in version 2.75**
type: string
links:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
description: Links to the resources in question. See [API Guide
/ Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
locked:
description: |-
True if the instance is locked otherwise False.
**New in version 2.9**
type: boolean
x-openstack:
min-ver: '2.9'
metadata:
additionalProperties: false
description: |-
A dictionary of metadata key-and-value pairs, which is maintained for backward
compatibility.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
type: string
os-extended-volumes:volumes_attached:
description: |-
The attached volumes, if any.
**New in version 2.75**
items:
type: object
type: array
progress:
description: |-
A percentage value of the operation progress.
This parameter only appears when the server status is `ACTIVE`,
`BUILD`, `REBUILD`, `RESIZE`, `VERIFY_RESIZE` or `MIGRATING`.
type: integer
security_groups:
description: |-
One or more security groups objects.
**New in version 2.75**
items:
properties:
name:
description: The security group name
type: string
type: object
type: array
server_groups:
description: |-
The UUIDs of the server groups to which the server belongs. Currently
this can contain at most one entry.
**New in version 2.71**
items:
type: string
type: array
x-openstack:
min-ver: '2.71'
status:
description: |-
The server status.
readOnly: true
type: string
tags:
description: |-
A list of tags. The maximum count of tags in this list is 50.
**New in version 2.26**
items:
type: string
type: array
x-openstack:
min-ver: '2.26'
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
format: uuid
type: string
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, that were used during image signature
verification to verify the signing certificate. The list is restricted
to a maximum of 50 IDs. The value is `null` if trusted certificate IDs
are not set.
**New in version 2.63**
items:
type: string
type:
- array
- 'null'
x-openstack:
min-ver: '2.63'
updated:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
readOnly: true
type: string
user_id:
description: |-
The user ID of the user who owns the server.
type: string
required:
- flavor
- id
- image
- name
type: object
type: object
ServerUpdate_20:
additionalProperties: false
properties:
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
name:
description: |-
The server name.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.0'
ServerUpdate_21:
additionalProperties: false
properties:
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.18'
min-ver: '2.1'
ServerUpdate_219:
additionalProperties: false
properties:
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.89'
min-ver: '2.19'
ServerUpdate_290:
additionalProperties: false
properties:
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
hostname:
description: |-
The hostname to configure for the instance in the metadata service.
Starting with microversion 2.94, this can be a Fully Qualified Domain Name
(FQDN) of up to 255 characters in length.
Note
This information is published via the metadata service and requires
application such as `cloud-init` to propagate it through to the
instance.
**New in version 2.90**
maxLength: 63
minLength: 2
pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]+$
type: string
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.93'
min-ver: '2.90'
ServerUpdate_294:
additionalProperties: false
properties:
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
hostname:
description: |-
The hostname to configure for the instance in the metadata service.
Starting with microversion 2.94, this can be a Fully Qualified Domain Name
(FQDN) of up to 255 characters in length.
Note
This information is published via the metadata service and requires
application such as `cloud-init` to propagate it through to the
instance.
**New in version 2.90**
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
type: string
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.94'
ServersActionChange_Password:
additionalProperties: false
description: |-
Changes the administrative password for a server.
Specify the `changePassword` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409), notImplemented(501)
properties:
changePassword:
additionalProperties: false
description: |-
The action to change an administrative password of the server.
properties:
adminPass:
description: |-
The administrative password for the server.
type: string
required:
- adminPass
type: object
required:
- changePassword
summary: Change Administrative Password (changePassword Action)
type: object
x-openstack:
action-name: changePassword
ServersActionConfirmresizeResponse:
type: 'null'
x-openstack:
action-name: confirmResize
ServersActionCreatebackupRequest:
description: |-
Creates a back up of a server.
Specify the `createBackup` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
oneOf:
- $ref: '#/components/schemas/ServersAction_Create_Backup_20'
- $ref: '#/components/schemas/ServersAction_Create_Backup_21'
summary: Create Server Back Up (createBackup Action)
x-openstack:
action-name: createBackup
discriminator: microversion
ServersActionCreatebackupResponse:
properties:
image_id:
description: The UUID for the resulting image snapshot.
type: string
x-openstack:
min-ver: '2.45'
type: object
x-openstack:
action-name: createBackup
ServersActionCreateimageRequest:
description: |-
Creates an image from a server.
Specify the `createImage` action in the request body.
After you make this request, you typically must keep polling the status of
the created image to determine whether the request succeeded.
If the operation succeeds, the created image has a status of `active` and
the server status returns to the original status. You can also see the new
image in the image back end that OpenStack Image service manages.
**Preconditions**
The server must exist.
You can only create a new image from the server when its status is `ACTIVE`,
`SHUTOFF`, `SUSPENDED` or `PAUSED`
(`PAUSED` is only supported for image-backed servers).
The project must have sufficient volume snapshot quota in the block storage
service when the server has attached volumes.
If the project does not have sufficient volume snapshot quota,
the API returns a 403 error.
**Asynchronous Postconditions**
A snapshot image will be created in the Image service.
In the image-backed server case, volume snapshots of attached volumes will not
be created.
In the volume-backed server case,
volume snapshots will be created for all volumes attached to the server and
then those will be represented with a `block_device_mapping` image property
in the resulting snapshot image in the Image service.
If that snapshot image is used later to create a new server,
it will result in a volume-backed server where the root volume is created
from the snapshot of the original root volume. The volumes created from
the snapshots of the original other volumes will be attached to the server.
**Troubleshooting**
If the image status remains uploading or shows another error status,
the request failed. Ensure you meet the preconditions and run the request
again. If the request fails again, investigate the image back end.
If the server status does not go back to an original server’s status,
the request failed. Ensure you meet the preconditions, or check if
there is another operation that causes race conditions for the server,
then run the request again. If the request fails again, investigate the
compute back end or ask your cloud provider.
If the request fails due to an error on OpenStack Compute service, the image
is purged from the image store that OpenStack Image service manages. Ensure
you meet the preconditions and run the request again. If the request fails
again, investigate OpenStack Compute service or ask your cloud provider.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
oneOf:
- $ref: '#/components/schemas/ServersAction_Action_Create_Image_20'
- $ref: '#/components/schemas/ServersAction_Action_Create_Image_21'
summary: Create Image (createImage Action)
x-openstack:
action-name: createImage
discriminator: microversion
ServersActionCreateimageResponse:
properties:
image_id:
description: The UUID for the resulting image snapshot.
type: string
x-openstack:
min-ver: '2.45'
type: object
x-openstack:
action-name: createImage
ServersActionEvacuateRequest:
description: |-
Evacuates a server from a failed host to a new host.
**Preconditions**
Starting from API version 2.68, the `force` parameter is no longer accepted
as this could not be meaningfully supported by servers with complex resource
allocations.
Starting from API version 2.95, the server will remain stopped on the
destination until it is manually started. If the server should end in the same
power state on the destination as it had on the source before the evacuation,
older microversions can be used.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
oneOf:
- $ref: '#/components/schemas/ServersAction_Evacuate_20'
- $ref: '#/components/schemas/ServersAction_Evacuate_214'
- $ref: '#/components/schemas/ServersAction_Evacuate_229'
- $ref: '#/components/schemas/ServersAction_Evacuate_268'
- $ref: '#/components/schemas/ServersAction_Evacuate_295'
summary: Evacuate Server (evacuate Action)
x-openstack:
action-name: evacuate
discriminator: microversion
ServersActionEvacuateResponse:
properties:
adminPass:
description: An administrative password to access moved instance. If
you set enable_instance_password configuration option to False, the
API wouldn’t return the adminPass field in response.
type: string
required:
- adminPass
type: object
x-openstack:
action-name: evacuate
ServersActionGet_Console_Output:
additionalProperties: false
description: |-
Shows console output for a server.
This API returns the text of the console since boot.
The content returned may be large. Limit the lines of console
text, beginning at the tail of the content, by setting
the optional `length` parameter in the request body.
The server to get console log from should set
`export LC_ALL=en_US.UTF-8` in order to avoid incorrect unicode error.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403),
notFound(404), conflict(409), methodNotImplemented(501)
properties:
os-getConsoleOutput:
additionalProperties: false
description: |-
The action to get console output of the server.
properties:
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’.
minimum: -1
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
type: object
required:
- os-getConsoleOutput
summary: Show Console Output (os-getConsoleOutput Action)
type: object
x-openstack:
action-name: os-getConsoleOutput
ServersActionGet_Serial_Console_21:
additionalProperties: false
description: |-
Gets a serial console for a server.
Specify the `os-getSerialConsole` action in the request body.
The only supported connection type is `serial`. The `type` parameter
should be set as `serial`.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
properties:
os-getSerialConsole:
additionalProperties: false
description: |-
The action.
properties:
type:
description: |-
The type of serial console. The only valid value is `serial`.
enum:
- serial
type: string
required:
- type
type: object
required:
- os-getSerialConsole
summary: Get Serial Console (os-getSerialConsole Action) (DEPRECATED)
type: object
x-openstack:
action-name: os-getSerialConsole
max-ver: '2.5'
min-ver: '2.1'
ServersActionGet_Spice_Console_21:
additionalProperties: false
description: |-
Gets a SPICE console for a server.
Specify the `os-getSPICEConsole` action in the request body.
The only supported connection type is `spice-html5`. The `type` parameter
should be set to `spice-html5`.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
properties:
os-getSPICEConsole:
additionalProperties: false
description: |-
The action.
properties:
type:
description: |-
The type of SPICE console. The only valid value is `spice-html5`.
enum:
- spice-html5
type: string
required:
- type
type: object
required:
- os-getSPICEConsole
summary: Get SPICE Console (os-getSPICEConsole Action) (DEPRECATED)
type: object
x-openstack:
action-name: os-getSPICEConsole
max-ver: '2.5'
min-ver: '2.1'
ServersActionGet_Vnc_Console_21:
additionalProperties: false
description: |-
Gets a VNC console for a server.
Specify the `os-getVNCConsole` action in the request body.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
properties:
os-getVNCConsole:
additionalProperties: false
description: |-
The action.
properties:
type:
description: |-
The type of VNC console. The only valid value is `novnc`.
enum:
- novnc
- xvpvnc
type: string
required:
- type
type: object
required:
- os-getVNCConsole
summary: Get VNC Console (os-getVNCConsole Action) (DEPRECATED)
type: object
x-openstack:
action-name: os-getVNCConsole
max-ver: '2.5'
min-ver: '2.1'
ServersActionLockRequest:
description: |-
Locks a server.
Specify the `lock` action in the request body.
Most actions by non-admin users are not allowed to the server
after this operation is successful and the server is locked.
See the “Lock, Unlock” item in [Server actions](https://docs.openstack.org/api-guide/compute/server_concepts.html#server-actions)
for the restricted actions.
But administrators can perform actions on the server
even though the server is locked. Note that from microversion 2.73 it is
possible to specify a reason when locking the server.
The [unlock action](https://docs.openstack.org/api-ref/compute/#unlock-server-unlock-action)
will unlock a server in locked state so additional actions can
be performed on the server by non-admin users.
You can know whether a server is locked or not and the `locked_reason`
(if specified, from the 2.73 microversion) by the [List Servers Detailed API](https://docs.openstack.org/api-ref/compute/#list-servers-detailed)
or
the [Show Server Details API](https://docs.openstack.org/api-ref/compute/#show-server-details).
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.yaml` file.
Administrators can overwrite owner’s lock.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
oneOf:
- $ref: '#/components/schemas/ServersAction_Lock_21'
- $ref: '#/components/schemas/ServersAction_Lock_273'
summary: Lock Server (lock Action)
x-openstack:
action-name: lock
discriminator: microversion
ServersActionOs-GetconsoleoutputResponse:
description: The console output as a string. Control characters will be
escaped to create a valid JSON string.
properties:
output:
type: string
required:
- output
type: object
x-openstack:
action-name: os-getConsoleOutput
ServersActionOs-GetrdpconsoleRequest:
description: |-
Gets an [RDP](https://technet.microsoft.com/en-us/windowsserver/ee236407) console for a server.
The only supported connect type is `rdp-html5`. The `type` parameter should
be set as `rdp-html5`.
Specify the `os-getRDPConsole` action in the request body.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
properties:
os-getRDPConsole:
description: |-
The action.
type: 'null'
summary: Get RDP Console (os-getRDPConsole Action)
type: object
x-openstack:
action-name: os-getRDPConsole
ServersActionOs-GetrdpconsoleResponse:
description: The remote console object.
properties:
console:
properties:
type:
description: The type of the remote console
enum:
- novnc
- rdp-html5
- serial
- spice-html5
type: string
url:
description: The URL used to connect to the console.
type: string
required:
- type
- url
type: object
required:
- console
type: object
x-openstack:
action-name: os-getRDPConsole
ServersActionOs-GetserialconsoleResponse:
description: The remote console object.
properties:
console:
properties:
type:
description: The type of the remote console
enum:
- novnc
- rdp-html5
- serial
- spice-html5
type: string
url:
description: The URL used to connect to the console.
type: string
required:
- type
- url
type: object
required:
- console
type: object
x-openstack:
action-name: os-getSerialConsole
ServersActionOs-GetspiceconsoleResponse:
description: The remote console object.
properties:
console:
properties:
type:
description: The type of the remote console
enum:
- novnc
- rdp-html5
- serial
- spice-html5
type: string
url:
description: The URL used to connect to the console.
type: string
required:
- type
- url
type: object
required:
- console
type: object
x-openstack:
action-name: os-getSPICEConsole
ServersActionOs-GetvncconsoleResponse:
description: The remote console object.
properties:
console:
properties:
type:
description: The type of the remote console
enum:
- novnc
- rdp-html5
- serial
- spice-html5
type: string
url:
description: The URL used to connect to the console.
type: string
required:
- type
- url
type: object
required:
- console
type: object
x-openstack:
action-name: os-getVNCConsole
ServersActionOs-MigrateliveRequest:
description: |-
Live-migrates a server to a new host without rebooting.
Specify the `os-migrateLive` action in the request body.
Use the `host` parameter to specify the destination host. If
this param is `null`, the scheduler chooses a host. If a scheduled host
is not suitable to do migration, the scheduler tries up to
`migrate_max_retries` rescheduling attempts.
Starting from API version 2.25, the `block_migration` parameter could be
to `auto` so that nova can decide value of block_migration during live
migration.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the `policy.yaml` file.
Starting from REST API version 2.34 pre-live-migration checks are done
asynchronously, results of these checks are available in `instance-actions`.
Nova responds immediately, and no pre-live-migration checks are returned.
The instance will not immediately change state to `ERROR`, if a failure of
the live-migration checks occurs.
Starting from API version 2.68, the `force` parameter is no longer accepted
as this could not be meaningfully supported by servers with complex resource
allocations.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
itemNotFound(404), conflict(409)
oneOf:
- $ref: '#/components/schemas/ServersAction_Migrate_Live_20'
- $ref: '#/components/schemas/ServersAction_Migrate_Live_225'
- $ref: '#/components/schemas/ServersAction_Migrate_Live_230'
- $ref: '#/components/schemas/ServersAction_Migrate_Live_268'
summary: Live-Migrate Server (os-migrateLive Action)
x-openstack:
action-name: os-migrateLive
discriminator: microversion
ServersActionRebuildRequest:
description: |-
Rebuilds a server.
Specify the `rebuild` action in the request body.
This operation recreates the root disk of the server.
With microversion 2.93, we support rebuilding volume backed
instances which will reimage the volume with the provided
image. For microversion < 2.93, this operation keeps the
contents of the volume given the image provided is same as
the image with which the volume was created else the operation
will error out.
**Preconditions**
The server status must be `ACTIVE`, `SHUTOFF` or `ERROR`.
**Asynchronous Postconditions**
If the server was in status `SHUTOFF` before the rebuild, it will be stopped
and in status `SHUTOFF` after the rebuild, otherwise it will be `ACTIVE`
if the rebuild was successful or `ERROR` if the rebuild failed.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
oneOf:
- $ref: '#/components/schemas/ServersAction_Action_Rebuild_20'
- $ref: '#/components/schemas/ServersAction_Action_Rebuild_21'
- $ref: '#/components/schemas/ServersAction_Action_Rebuild_219'
- $ref: '#/components/schemas/ServersAction_Action_Rebuild_254'
- $ref: '#/components/schemas/ServersAction_Action_Rebuild_257'
- $ref: '#/components/schemas/ServersAction_Action_Rebuild_263'
- $ref: '#/components/schemas/ServersAction_Action_Rebuild_290'
- $ref: '#/components/schemas/ServersAction_Action_Rebuild_294'
summary: Rebuild Server (rebuild Action)
x-openstack:
action-name: rebuild
discriminator: microversion
ServersActionRescueResponse:
properties:
adminPass:
description: An administrative password to access moved instance. If
you set enable_instance_password configuration option to False, the
API wouldn’t return the adminPass field in response.
type: string
required:
- adminPass
type: object
x-openstack:
action-name: rescue
ServersActionResetnetworkRequest:
description: |-
Resets networking on a server.
Specify the `resetNetwork` action in the request body.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the `policy.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), gone(410)
properties:
resetNetwork:
description: |-
The action.
type: 'null'
summary: Reset Networking On A Server (resetNetwork Action) (DEPRECATED)
type: object
x-openstack:
action-name: resetNetwork
ServersActionUnshelveRequest:
description: |-
Unshelves, or restores, a shelved server.
Specify the `unshelve` action in the request body.
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.yaml` file.
**Preconditions**
Unshelving a server without parameters requires its status to be `SHELVED` or `SHELVED_OFFLOADED`.
Unshelving a server with availability_zone and/or host parameters requires its status to be only `SHELVED_OFFLOADED` otherwise HTTP 409 conflict response is returned.
If a server is locked, you must have administrator privileges to unshelve the server.
As of `microversion 2.91`, you can unshelve to a specific compute node if you have PROJECT_ADMIN privileges.
This microversion also gives the ability to pin a server to an availability_zone and to unpin a server
from any availability_zone.
When a server is pinned to an availability_zone, the server move operations will keep the server in that
availability_zone. However, when the server is not pinned to any availability_zone, the move operations can
move the server to nodes in different availability_zones.
The behavior according to unshelve parameters will follow the below table.
**Asynchronous Postconditions**
After you successfully unshelve a server, its status changes to `ACTIVE`.
The server appears on the compute node.
The shelved image is deleted from the list of images returned by an API call.
**Troubleshooting**
If the server status does not change to `ACTIVE`, the unshelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
oneOf:
- $ref: '#/components/schemas/ServersAction_Unshelve_21'
- $ref: '#/components/schemas/ServersAction_Unshelve_277'
- $ref: '#/components/schemas/ServersAction_Unshelve_291'
summary: Unshelve (Restore) Shelved Server (unshelve Action)
x-openstack:
action-name: unshelve
discriminator: microversion
ServersAction_Action_Confirm_Resize:
additionalProperties: false
description: |-
Confirms a pending resize action for a server.
Specify the `confirmResize` action in the request body.
After you make this request, you typically must keep polling the server
status to determine whether the request succeeded. A successfully
confirming resize operation shows a status of `ACTIVE` or `SHUTOFF`
and a migration status of `confirmed`. You can also see the resized
server in the compute node that OpenStack Compute manages.
**Preconditions**
You can only confirm the resized server where the status is
`VERIFY_RESIZE`.
If the server is locked, you must have administrator privileges
to confirm the server.
**Troubleshooting**
If the server status remains `VERIFY_RESIZE`, the request failed. Ensure you
meet the preconditions and run the request again. If the request fails
again, the server status should be `ERROR` and a migration status of
`error`. Investigate the compute back end or ask your cloud provider.
There are some options for trying to correct the server status:
Note that the cloud provider may still need to cleanup any orphaned resources
on the source hypervisor.
Normal response codes: 204
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
properties:
confirmResize: {}
required:
- confirmResize
summary: Confirm Resized Server (confirmResize Action)
type: object
x-openstack:
action-name: confirmResize
ServersAction_Action_Create_Image_20:
additionalProperties: false
properties:
createImage:
additionalProperties: false
description: |-
The action to create a snapshot of the image or
the volume(s) of the server.
properties:
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs for the image.
The maximum size for each metadata key and value pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The display name of an Image.
format: name
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
required:
- createImage
summary: Create Image (createImage Action)
type: object
x-openstack:
action-name: createImage
max-ver: '2.0'
min-ver: '2.0'
ServersAction_Action_Create_Image_21:
additionalProperties: false
properties:
createImage:
additionalProperties: false
description: |-
The action to create a snapshot of the image or
the volume(s) of the server.
properties:
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs for the image.
The maximum size for each metadata key and value pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The display name of an Image.
format: name
maxLength: 255
minLength: 1
type: string
required:
- name
type: object
required:
- createImage
summary: Create Image (createImage Action)
type: object
x-openstack:
action-name: createImage
max-ver: '2.0'
min-ver: '2.1'
ServersAction_Action_Reboot:
additionalProperties: false
description: |-
Reboots a server.
Specify the `reboot` action in the request body.
**Preconditions**
The preconditions for rebooting a server depend on the type of reboot.
You can only *SOFT* reboot a server when its status is `ACTIVE`.
You can only *HARD* reboot a server when its status is one of:
If the server is locked, you must have administrator privileges
to reboot the server.
**Asynchronous Postconditions**
After you successfully reboot a server, its status changes to `ACTIVE`.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409)
properties:
reboot:
additionalProperties: false
description: |-
The action to reboot a server.
properties:
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.
enum:
- HARD
- Hard
- SOFT
- Soft
- hard
- soft
type: string
required:
- type
type: object
required:
- reboot
summary: Reboot Server (reboot Action)
type: object
x-openstack:
action-name: reboot
ServersAction_Action_Rebuild_20:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
description: |-
The action to rebuild a server.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
imageRef:
description: |-
The UUID of the image to rebuild for your server instance. It
must be a valid UUID otherwise API will return 400. To rebuild a
volume-backed server with a new image, at least microversion 2.93
needs to be provided in the request else the request will fall
back to old behaviour i.e. the API will return 400 (for an image
different from the image used when creating the volume). For
non-volume-backed servers, specifying a new image will result in
validating that the image is acceptable for the current compute
host on which the server exists. If the new image is not valid,
the server will go into `ERROR` status.
format: uuid
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- imageRef
type: object
required:
- rebuild
summary: Rebuild Server (rebuild Action)
type: object
x-openstack:
action-name: rebuild
max-ver: '2.0'
min-ver: '2.0'
ServersAction_Action_Rebuild_21:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
description: |-
The action to rebuild a server.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
imageRef:
description: |-
The UUID of the image to rebuild for your server instance. It
must be a valid UUID otherwise API will return 400. To rebuild a
volume-backed server with a new image, at least microversion 2.93
needs to be provided in the request else the request will fall
back to old behaviour i.e. the API will return 400 (for an image
different from the image used when creating the volume). For
non-volume-backed servers, specifying a new image will result in
validating that the image is acceptable for the current compute
host on which the server exists. If the new image is not valid,
the server will go into `ERROR` status.
format: uuid
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- imageRef
type: object
required:
- rebuild
summary: Rebuild Server (rebuild Action)
type: object
x-openstack:
action-name: rebuild
max-ver: '2.18'
min-ver: '2.1'
ServersAction_Action_Rebuild_219:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
description: |-
The action to rebuild a server.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
imageRef:
description: |-
The UUID of the image to rebuild for your server instance. It
must be a valid UUID otherwise API will return 400. To rebuild a
volume-backed server with a new image, at least microversion 2.93
needs to be provided in the request else the request will fall
back to old behaviour i.e. the API will return 400 (for an image
different from the image used when creating the volume). For
non-volume-backed servers, specifying a new image will result in
validating that the image is acceptable for the current compute
host on which the server exists. If the new image is not valid,
the server will go into `ERROR` status.
format: uuid
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- imageRef
type: object
required:
- rebuild
summary: Rebuild Server (rebuild Action)
type: object
x-openstack:
action-name: rebuild
max-ver: '2.53'
min-ver: '2.19'
ServersAction_Action_Rebuild_254:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
description: |-
The action to rebuild a server.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
imageRef:
description: |-
The UUID of the image to rebuild for your server instance. It
must be a valid UUID otherwise API will return 400. To rebuild a
volume-backed server with a new image, at least microversion 2.93
needs to be provided in the request else the request will fall
back to old behaviour i.e. the API will return 400 (for an image
different from the image used when creating the volume). For
non-volume-backed servers, specifying a new image will result in
validating that the image is acceptable for the current compute
host on which the server exists. If the new image is not valid,
the server will go into `ERROR` status.
format: uuid
type: string
key_name:
description: |-
Key pair name for rebuild API. If `null` is specified,
the existing keypair is unset.
Note
Users within the same project are able to rebuild other
user’s instances in that project with a new keypair. Keys
are owned by users (which is the only resource that’s true
of). Servers are owned by projects. Because of this a rebuild
with a key_name is looking up the keypair by the user calling
rebuild.
**New in version 2.54**
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- imageRef
type: object
required:
- rebuild
summary: Rebuild Server (rebuild Action)
type: object
x-openstack:
action-name: rebuild
max-ver: '2.56'
min-ver: '2.54'
ServersAction_Action_Rebuild_257:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
description: |-
The action to rebuild a server.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
imageRef:
description: |-
The UUID of the image to rebuild for your server instance. It
must be a valid UUID otherwise API will return 400. To rebuild a
volume-backed server with a new image, at least microversion 2.93
needs to be provided in the request else the request will fall
back to old behaviour i.e. the API will return 400 (for an image
different from the image used when creating the volume). For
non-volume-backed servers, specifying a new image will result in
validating that the image is acceptable for the current compute
host on which the server exists. If the new image is not valid,
the server will go into `ERROR` status.
format: uuid
type: string
key_name:
description: |-
Key pair name for rebuild API. If `null` is specified,
the existing keypair is unset.
Note
Users within the same project are able to rebuild other
user’s instances in that project with a new keypair. Keys
are owned by users (which is the only resource that’s true
of). Servers are owned by projects. Because of this a rebuild
with a key_name is looking up the keypair by the user calling
rebuild.
**New in version 2.54**
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
user_data:
description: |-
Configuration information or scripts to use upon rebuild.
Must be Base64 encoded. Restricted to 65535 bytes.
If `null` is specified, the existing user_data is unset.
**New in version 2.57**
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- imageRef
type: object
required:
- rebuild
summary: Rebuild Server (rebuild Action)
type: object
x-openstack:
action-name: rebuild
max-ver: '2.62'
min-ver: '2.57'
ServersAction_Action_Rebuild_263:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
description: |-
The action to rebuild a server.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
imageRef:
description: |-
The UUID of the image to rebuild for your server instance. It
must be a valid UUID otherwise API will return 400. To rebuild a
volume-backed server with a new image, at least microversion 2.93
needs to be provided in the request else the request will fall
back to old behaviour i.e. the API will return 400 (for an image
different from the image used when creating the volume). For
non-volume-backed servers, specifying a new image will result in
validating that the image is acceptable for the current compute
host on which the server exists. If the new image is not valid,
the server will go into `ERROR` status.
format: uuid
type: string
key_name:
description: |-
Key pair name for rebuild API. If `null` is specified,
the existing keypair is unset.
Note
Users within the same project are able to rebuild other
user’s instances in that project with a new keypair. Keys
are owned by users (which is the only resource that’s true
of). Servers are owned by projects. Because of this a rebuild
with a key_name is looking up the keypair by the user calling
rebuild.
**New in version 2.54**
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, which are used during image
signature verification to verify the signing certificate. The list is
restricted to a maximum of 50 IDs. This parameter is optional in server
rebuild requests if allowed by policy, and is not supported
for volume-backed instances.
If `null` is specified, the existing trusted certificate IDs are either
unset or reset to the configured defaults.
**New in version 2.63**
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
description: |-
Configuration information or scripts to use upon rebuild.
Must be Base64 encoded. Restricted to 65535 bytes.
If `null` is specified, the existing user_data is unset.
**New in version 2.57**
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- imageRef
type: object
required:
- rebuild
summary: Rebuild Server (rebuild Action)
type: object
x-openstack:
action-name: rebuild
max-ver: '2.89'
min-ver: '2.63'
ServersAction_Action_Rebuild_290:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
description: |-
The action to rebuild a server.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
hostname:
description: |-
The hostname to configure for the instance in the metadata service.
Starting with microversion 2.94, this can be a Fully Qualified Domain Name
(FQDN) of up to 255 characters in length.
Note
This information is published via the metadata service and requires
application such as `cloud-init` to propagate it through to the
instance.
**New in version 2.90**
maxLength: 63
minLength: 2
pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]+$
type: string
imageRef:
description: |-
The UUID of the image to rebuild for your server instance. It
must be a valid UUID otherwise API will return 400. To rebuild a
volume-backed server with a new image, at least microversion 2.93
needs to be provided in the request else the request will fall
back to old behaviour i.e. the API will return 400 (for an image
different from the image used when creating the volume). For
non-volume-backed servers, specifying a new image will result in
validating that the image is acceptable for the current compute
host on which the server exists. If the new image is not valid,
the server will go into `ERROR` status.
format: uuid
type: string
key_name:
description: |-
Key pair name for rebuild API. If `null` is specified,
the existing keypair is unset.
Note
Users within the same project are able to rebuild other
user’s instances in that project with a new keypair. Keys
are owned by users (which is the only resource that’s true
of). Servers are owned by projects. Because of this a rebuild
with a key_name is looking up the keypair by the user calling
rebuild.
**New in version 2.54**
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, which are used during image
signature verification to verify the signing certificate. The list is
restricted to a maximum of 50 IDs. This parameter is optional in server
rebuild requests if allowed by policy, and is not supported
for volume-backed instances.
If `null` is specified, the existing trusted certificate IDs are either
unset or reset to the configured defaults.
**New in version 2.63**
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
description: |-
Configuration information or scripts to use upon rebuild.
Must be Base64 encoded. Restricted to 65535 bytes.
If `null` is specified, the existing user_data is unset.
**New in version 2.57**
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- imageRef
type: object
required:
- rebuild
summary: Rebuild Server (rebuild Action)
type: object
x-openstack:
action-name: rebuild
max-ver: '2.93'
min-ver: '2.90'
ServersAction_Action_Rebuild_294:
additionalProperties: false
properties:
rebuild:
additionalProperties: false
description: |-
The action to rebuild a server.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
hostname:
description: |-
The hostname to configure for the instance in the metadata service.
Starting with microversion 2.94, this can be a Fully Qualified Domain Name
(FQDN) of up to 255 characters in length.
Note
This information is published via the metadata service and requires
application such as `cloud-init` to propagate it through to the
instance.
**New in version 2.90**
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
imageRef:
description: |-
The UUID of the image to rebuild for your server instance. It
must be a valid UUID otherwise API will return 400. To rebuild a
volume-backed server with a new image, at least microversion 2.93
needs to be provided in the request else the request will fall
back to old behaviour i.e. the API will return 400 (for an image
different from the image used when creating the volume). For
non-volume-backed servers, specifying a new image will result in
validating that the image is acceptable for the current compute
host on which the server exists. If the new image is not valid,
the server will go into `ERROR` status.
format: uuid
type: string
key_name:
description: |-
Key pair name for rebuild API. If `null` is specified,
the existing keypair is unset.
Note
Users within the same project are able to rebuild other
user’s instances in that project with a new keypair. Keys
are owned by users (which is the only resource that’s true
of). Servers are owned by projects. Because of this a rebuild
with a key_name is looking up the keypair by the user calling
rebuild.
**New in version 2.54**
oneOf:
- type: 'null'
- maxLength: 255
minLength: 1
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
format: name
maxLength: 255
minLength: 1
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.
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, which are used during image
signature verification to verify the signing certificate. The list is
restricted to a maximum of 50 IDs. This parameter is optional in server
rebuild requests if allowed by policy, and is not supported
for volume-backed instances.
If `null` is specified, the existing trusted certificate IDs are either
unset or reset to the configured defaults.
**New in version 2.63**
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
description: |-
Configuration information or scripts to use upon rebuild.
Must be Base64 encoded. Restricted to 65535 bytes.
If `null` is specified, the existing user_data is unset.
**New in version 2.57**
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- imageRef
type: object
required:
- rebuild
summary: Rebuild Server (rebuild Action)
type: object
x-openstack:
action-name: rebuild
max-ver: '2.0'
min-ver: '2.94'
ServersAction_Action_Resize:
additionalProperties: false
description: |-
Resizes a server.
Specify the `resize` action in the request body.
**Preconditions**
You can only resize a server when its status is `ACTIVE` or `SHUTOFF`.
If the server is locked, you must have administrator privileges
to resize the server.
**Asynchronous Postconditions**
A successfully resized server shows a `VERIFY_RESIZE` status and `finished`
migration status. If the cloud has configured the [resize_confirm_window](https://docs.openstack.org/nova/latest/configuration/config.html#DEFAULT.resize_confirm_window)
option of the Compute service to a positive value, the Compute service
automatically confirms the resize operation after the configured interval.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
properties:
resize:
additionalProperties: false
description: |-
The action to resize a server.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
flavorRef:
description: |-
The flavor ID for resizing the server. The size of the disk in the flavor
being resized to must be greater than or equal to the size of the disk in
the current flavor.
If a specified flavor ID is the same as the current one of the server,
the request returns a `Bad Request (400)` response code.
minLength: 1
type:
- integer
- string
required:
- flavorRef
type: object
required:
- resize
summary: Resize Server (resize Action)
type: object
x-openstack:
action-name: resize
ServersAction_Action_Revert_Resize:
additionalProperties: false
description: |-
Cancels and reverts a pending resize action for a server.
Specify the `revertResize` action in the request body.
**Preconditions**
You can only revert the resized server where the status is
`VERIFY_RESIZE` and the OS-EXT-STS:vm_state is `resized`.
If the server is locked, you must have administrator privileges to revert
the resizing.
**Asynchronous Postconditions**
After you make this request, you typically must keep polling the server status
to determine whether the request succeeded. A reverting resize operation shows
a status of `REVERT_RESIZE` and a task_state of `resize_reverting`. If
successful, the status will return to `ACTIVE` or `SHUTOFF`. You can also
see the reverted server in the compute node that OpenStack Compute manages.
**Troubleshooting**
If the server status remains `VERIFY_RESIZE`, the request failed. Ensure you
meet the preconditions and run the request again. If the request fails again,
investigate the compute back end.
The server is not reverted in the compute node that OpenStack Compute manages.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
properties:
revertResize: {}
required:
- revertResize
summary: Revert Resized Server (revertResize Action)
type: object
x-openstack:
action-name: revertResize
ServersAction_Action_Trigger_Crash_Dump_217:
additionalProperties: false
properties:
trigger_crash_dump:
type: 'null'
required:
- trigger_crash_dump
type: object
x-openstack:
action-name: trigger_crash_dump
min-ver: '2.17'
ServersAction_Add_Fixed_Ip_21:
additionalProperties: false
description: |-
Adds a fixed IP address to a server instance, which associates that
address with the server. The fixed IP address is retrieved from the
network that you specify in the request.
Specify the `addFixedIp` action and the network ID in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
properties:
addFixedIp:
additionalProperties: false
description: |-
The action to add a fixed ip address to a server.
properties:
networkId:
description: |-
The network ID.
maxLength: 36
minLength: 1
type:
- number
- string
required:
- networkId
type: object
required:
- addFixedIp
summary: Add (Associate) Fixed Ip (addFixedIp Action) (DEPRECATED)
type: object
x-openstack:
action-name: addFixedIp
max-ver: '2.43'
min-ver: '2.1'
ServersAction_Add_Floating_Ip_21:
additionalProperties: false
description: |-
Adds a floating IP address to a server, which associates
that address with the server.
A pool of floating IP addresses, configured by the cloud administrator,
is available in OpenStack Compute. The project quota defines the maximum
number of floating IP addresses that you can allocate to the project.
After you [create (allocate) a floating IPaddress](https://docs.openstack.org/api-ref/compute/#create-allocate-floating-ip-address)
for a project, you can associate that address with the server. Specify
the `addFloatingIp` action in the request body.
If an instance is connected to multiple networks, you can associate a
floating IP address with a specific fixed IP address by using the
optional `fixed_address` parameter.
**Preconditions**
The server must exist.
You can only add a floating IP address to the server when its status is `ACTIVE` or `STOPPED`
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
properties:
addFloatingIp:
additionalProperties: false
description: |-
The action. Contains required floating IP `address` and optional
`fixed_address`.
properties:
address:
description: |-
The fixed IP address with which you want to associate the floating IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
fixed_address:
description: |-
The fixed IP address with which you want to associate the floating IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
required:
- address
type: object
required:
- addFloatingIp
summary: Add (Associate) Floating Ip (addFloatingIp Action) (DEPRECATED)
type: object
x-openstack:
action-name: addFloatingIp
max-ver: '2.43'
min-ver: '2.1'
ServersAction_Addsecuritygroup:
additionalProperties: true
description: |-
Adds a security group to a server.
Specify the `addSecurityGroup` action in the request body.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
properties:
addSecurityGroup:
additionalProperties: false
description: |-
The action to add a security group to a server.
properties:
name:
description: |-
The security group name.
minLength: 1
type: string
required:
- name
type: object
required:
- addSecurityGroup
summary: Add Security Group To A Server (addSecurityGroup Action)
type: object
x-openstack:
action-name: addSecurityGroup
ServersAction_Create_Backup_20:
additionalProperties: false
properties:
createBackup:
additionalProperties: false
description: |-
The action.
properties:
backup_type:
description: |-
The type of the backup, for example, `daily`.
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The name of the image to be backed up.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
rotation:
description: |-
The rotation of the back up image, the oldest image will be removed when image count
exceed the rotation count.
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
required:
- backup_type
- name
- rotation
type: object
required:
- createBackup
summary: Create Server Back Up (createBackup Action)
type: object
x-openstack:
action-name: createBackup
max-ver: '2.0'
min-ver: '2.0'
ServersAction_Create_Backup_21:
additionalProperties: false
properties:
createBackup:
additionalProperties: false
description: |-
The action.
properties:
backup_type:
description: |-
The type of the backup, for example, `daily`.
type: string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The name of the image to be backed up.
format: name
maxLength: 255
minLength: 1
type: string
rotation:
description: |-
The rotation of the back up image, the oldest image will be removed when image count
exceed the rotation count.
minLength: 1
minimum: 0
pattern: ^[0-9]*$
type:
- integer
- string
required:
- backup_type
- name
- rotation
type: object
required:
- createBackup
summary: Create Server Back Up (createBackup Action)
type: object
x-openstack:
action-name: createBackup
max-ver: '2.0'
min-ver: '2.1'
ServersAction_Evacuate_20:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
description: |-
The action to evacuate a server to another host.
properties:
adminPass:
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.
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.
Warning
Prior to microversion 2.29, specifying a host will bypass
validation by the scheduler, which could result in failures to actually
evacuate the instance to the specified host, or over-subscription of the
host. It is recommended to either not specify a host so that the
scheduler will pick one, or specify a host with microversion >= 2.29 and
without `force=True` set.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
onSharedStorage:
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.
**Available until version 2.13**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
required:
- onSharedStorage
type: object
required:
- evacuate
summary: Evacuate Server (evacuate Action)
type: object
x-openstack:
action-name: evacuate
max-ver: '2.13'
min-ver: '2.0'
ServersAction_Evacuate_214:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
description: |-
The action to evacuate a server to another host.
properties:
adminPass:
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.
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.
Warning
Prior to microversion 2.29, specifying a host will bypass
validation by the scheduler, which could result in failures to actually
evacuate the instance to the specified host, or over-subscription of the
host. It is recommended to either not specify a host so that the
scheduler will pick one, or specify a host with microversion >= 2.29 and
without `force=True` set.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
type: object
required:
- evacuate
summary: Evacuate Server (evacuate Action)
type: object
x-openstack:
action-name: evacuate
max-ver: '2.28'
min-ver: '2.14'
ServersAction_Evacuate_229:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
description: |-
The action to evacuate a server to another host.
properties:
adminPass:
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.
type: string
force:
description: |-
Force an evacuation by not verifying the provided destination host by the
scheduler.
Warning
This could result in failures to actually evacuate the
instance to the specified host. It is recommended to either not specify
a host so that the scheduler will pick one, or specify a host without
`force=True` set.
Furthermore, this should not be specified when evacuating instances
managed by a clustered hypervisor driver like ironic since you
cannot specify a node, so the compute service will pick a node randomly
which may not be able to accommodate the instance.
**New in version 2.29**
**Available until version 2.67**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- 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.
Warning
Prior to microversion 2.29, specifying a host will bypass
validation by the scheduler, which could result in failures to actually
evacuate the instance to the specified host, or over-subscription of the
host. It is recommended to either not specify a host so that the
scheduler will pick one, or specify a host with microversion >= 2.29 and
without `force=True` set.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
type: object
required:
- evacuate
summary: Evacuate Server (evacuate Action)
type: object
x-openstack:
action-name: evacuate
max-ver: '2.67'
min-ver: '2.29'
ServersAction_Evacuate_268:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
description: |-
The action to evacuate a server to another host.
properties:
adminPass:
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.
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.
Warning
Prior to microversion 2.29, specifying a host will bypass
validation by the scheduler, which could result in failures to actually
evacuate the instance to the specified host, or over-subscription of the
host. It is recommended to either not specify a host so that the
scheduler will pick one, or specify a host with microversion >= 2.29 and
without `force=True` set.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
type: object
required:
- evacuate
summary: Evacuate Server (evacuate Action)
type: object
x-openstack:
action-name: evacuate
max-ver: '2.94'
min-ver: '2.68'
ServersAction_Evacuate_295:
additionalProperties: false
properties:
evacuate:
additionalProperties: false
description: |-
The action to evacuate a server to another host.
properties:
adminPass:
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.
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.
Warning
Prior to microversion 2.29, specifying a host will bypass
validation by the scheduler, which could result in failures to actually
evacuate the instance to the specified host, or over-subscription of the
host. It is recommended to either not specify a host so that the
scheduler will pick one, or specify a host with microversion >= 2.29 and
without `force=True` set.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
type: object
required:
- evacuate
summary: Evacuate Server (evacuate Action)
type: object
x-openstack:
action-name: evacuate
max-ver: '2.13'
min-ver: '2.95'
ServersAction_Force_Delete:
additionalProperties: false
description: |-
Force-deletes a server before deferred cleanup.
Specify the `forceDelete` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409)
properties:
forceDelete: {}
required:
- forceDelete
summary: Force-Delete Server (forceDelete Action)
type: object
x-openstack:
action-name: forceDelete
ServersAction_Inject_Network_Info:
additionalProperties: false
description: |-
Injects network information into a server.
Specify the `injectNetworkInfo` action in the request body.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the `policy.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
properties:
injectNetworkInfo: {}
required:
- injectNetworkInfo
summary: Inject Network Information (injectNetworkInfo Action)
type: object
x-openstack:
action-name: injectNetworkInfo
ServersAction_Lock_21:
additionalProperties: false
properties:
lock: {}
required:
- lock
summary: Lock Server (lock Action)
type: object
x-openstack:
action-name: lock
max-ver: '2.72'
min-ver: '2.1'
ServersAction_Lock_273:
additionalProperties: false
properties:
lock:
additionalProperties: false
description: |-
The action to lock a server.
This parameter can be `null`.
Up to microversion 2.73, this parameter should be `null`.
properties:
locked_reason:
maxLength: 255
minLength: 1
type: string
type:
- 'null'
- object
required:
- lock
summary: Lock Server (lock Action)
type: object
x-openstack:
action-name: lock
max-ver: '2.72'
min-ver: '2.73'
ServersAction_Migrate_256:
additionalProperties: false
description: |-
Migrates a server to a host.
Specify the `migrate` action in the request body.
Up to microversion 2.55, the scheduler chooses the host.
Starting from microversion 2.56, the `host` parameter is available
to specify the destination host. If you specify `null` or don’t specify
this parameter, the scheduler chooses a host.
**Asynchronous Postconditions**
A successfully migrated server shows a `VERIFY_RESIZE` status and `finished`
migration status. If the cloud has configured the [resize_confirm_window](https://docs.openstack.org/nova/latest/configuration/config.html#DEFAULT.resize_confirm_window)
option of the Compute service to a positive value, the Compute service
automatically confirms the migrate operation after the configured interval.
There are two different policies for this action, depending on whether the host
parameter is set. Both defaults enable only users with the administrative role
to perform this operation. Cloud providers can change these permissions
through the `policy.yaml` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
itemNotFound(404), conflict(409)
properties:
migrate:
additionalProperties: false
description: |-
The action to cold migrate a server.
This parameter can be `null`.
Up to microversion 2.55, this parameter should be `null`.
properties:
host:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
type:
- 'null'
- object
required:
- migrate
summary: Migrate Server (migrate Action)
type: object
x-openstack:
action-name: migrate
min-ver: '2.56'
ServersAction_Migrate_Live_20:
additionalProperties: false
properties:
os-migrateLive:
additionalProperties: false
description: |-
The action.
properties:
block_migration:
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.
**Available until version 2.25**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- 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.
**Available until version 2.25**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
description: |-
The host to which to migrate the server. If this parameter is `None`,
the scheduler chooses a host.
Warning
Prior to microversion 2.30, specifying a host will bypass
validation by the scheduler, which could result in failures to actually
migrate the instance to the specified host, or over-subscription of the
host. It is recommended to either not specify a host so that the
scheduler will pick one, or specify a host with microversion >= 2.30 and
without `force=True` set.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
required:
- block_migration
- disk_over_commit
- host
type: object
required:
- os-migrateLive
summary: Live-Migrate Server (os-migrateLive Action)
type: object
x-openstack:
action-name: os-migrateLive
max-ver: '2.24'
min-ver: '2.0'
ServersAction_Migrate_Live_225:
additionalProperties: false
properties:
os-migrateLive:
additionalProperties: false
description: |-
The action.
properties:
block_migration:
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.
**New in version 2.25**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- auto
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
description: |-
The host to which to migrate the server. If this parameter is `None`,
the scheduler chooses a host.
Warning
Prior to microversion 2.30, specifying a host will bypass
validation by the scheduler, which could result in failures to actually
migrate the instance to the specified host, or over-subscription of the
host. It is recommended to either not specify a host so that the
scheduler will pick one, or specify a host with microversion >= 2.30 and
without `force=True` set.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
required:
- block_migration
- host
type: object
required:
- os-migrateLive
summary: Live-Migrate Server (os-migrateLive Action)
type: object
x-openstack:
action-name: os-migrateLive
max-ver: '2.29'
min-ver: '2.25'
ServersAction_Migrate_Live_230:
additionalProperties: false
properties:
os-migrateLive:
additionalProperties: false
description: |-
The action.
properties:
block_migration:
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.
**New in version 2.25**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- auto
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
force:
description: |-
Force a live-migration by not verifying the provided destination host by
the scheduler.
Warning
This could result in failures to actually live migrate the
instance to the specified host. It is recommended to either not specify
a host so that the scheduler will pick one, or specify a host without
`force=True` set.
**New in version 2.30**
**Available until version 2.67**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
description: |-
The host to which to migrate the server. If this parameter is `None`,
the scheduler chooses a host.
Warning
Prior to microversion 2.30, specifying a host will bypass
validation by the scheduler, which could result in failures to actually
migrate the instance to the specified host, or over-subscription of the
host. It is recommended to either not specify a host so that the
scheduler will pick one, or specify a host with microversion >= 2.30 and
without `force=True` set.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
required:
- block_migration
- host
type: object
required:
- os-migrateLive
summary: Live-Migrate Server (os-migrateLive Action)
type: object
x-openstack:
action-name: os-migrateLive
max-ver: '2.67'
min-ver: '2.30'
ServersAction_Migrate_Live_268:
additionalProperties: false
properties:
os-migrateLive:
additionalProperties: false
description: |-
The action.
properties:
block_migration:
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.
**New in version 2.25**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- auto
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
host:
description: |-
The host to which to migrate the server. If this parameter is `None`,
the scheduler chooses a host.
Warning
Prior to microversion 2.30, specifying a host will bypass
validation by the scheduler, which could result in failures to actually
migrate the instance to the specified host, or over-subscription of the
host. It is recommended to either not specify a host so that the
scheduler will pick one, or specify a host with microversion >= 2.30 and
without `force=True` set.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type:
- 'null'
- string
required:
- block_migration
- host
type: object
required:
- os-migrateLive
summary: Live-Migrate Server (os-migrateLive Action)
type: object
x-openstack:
action-name: os-migrateLive
max-ver: '2.24'
min-ver: '2.68'
ServersAction_Pause:
additionalProperties: false
description: |-
Pauses a server. Changes its status to `PAUSED`.
Specify the `pause` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
properties:
pause: {}
required:
- pause
summary: Pause Server (pause Action)
type: object
x-openstack:
action-name: pause
ServersAction_Remove_Fixed_Ip_21:
additionalProperties: false
description: |-
Removes, or disassociates, a fixed IP address from a server.
Specify the `removeFixedIp` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404)
properties:
removeFixedIp:
additionalProperties: false
description: |-
The action to remove a fixed ip address from a server.
properties:
address:
description: |-
The IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
required:
- address
type: object
required:
- removeFixedIp
summary: Remove (Disassociate) Fixed Ip (removeFixedIp Action)
(DEPRECATED)
type: object
x-openstack:
action-name: removeFixedIp
max-ver: '2.43'
min-ver: '2.1'
ServersAction_Remove_Floating_Ip_21:
additionalProperties: false
description: |-
Removes, or disassociates, a floating IP address from a server.
The IP address is returned to the pool of IP addresses that is available
for all projects. When you remove a floating IP address and that IP address
is still associated with a running instance, it is automatically
disassociated from that instance.
Specify the `removeFloatingIp` action in the request body.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
properties:
removeFloatingIp:
additionalProperties: false
description: |-
The action to remove or disassociate a floating IP address
from the server.
properties:
address:
description: |-
The floating IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
required:
- address
type: object
required:
- removeFloatingIp
summary: Remove (Disassociate) Floating Ip (removeFloatingIp Action)
(DEPRECATED)
type: object
x-openstack:
action-name: removeFloatingIp
max-ver: '2.43'
min-ver: '2.1'
ServersAction_Removesecuritygroup:
additionalProperties: true
description: |-
Removes a security group from a server.
Specify the `removeSecurityGroup` action in the request body.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
properties:
removeSecurityGroup:
additionalProperties: false
description: |-
The action to remove a security group from the server.
properties:
name:
description: |-
The security group name.
minLength: 1
type: string
required:
- name
type: object
required:
- removeSecurityGroup
summary: Remove Security Group From A Server (removeSecurityGroup Action)
type: object
x-openstack:
action-name: removeSecurityGroup
ServersAction_Rescue:
additionalProperties: false
description: |-
Puts a server in rescue mode and changes its status to `RESCUE`.
Specify the `rescue` action in the request body.
If you specify the `rescue_image_ref` extended attribute,
the image is used to rescue the instance. If you omit an image
reference, the base image reference is used by default.
**Asynchronous Postconditions**
After you successfully rescue a server and make a `GET
/servers/{server_id}` request, its status changes to `RESCUE`.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409), notImplemented(501)
properties:
rescue:
additionalProperties: false
description: |-
The action to rescue a server.
properties:
adminPass:
type: string
rescue_image_ref:
format: uuid
type: string
type:
- 'null'
- object
required:
- rescue
summary: Rescue Server (rescue Action)
type: object
x-openstack:
action-name: rescue
ServersAction_Reset_State:
additionalProperties: false
description: |-
Resets the state of a server.
Specify the `os-resetState` action and the `state` in the request body.
Policy defaults enable only users with the administrative role to
perform this operation. Cloud providers can change these permissions
through the `policy.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
properties:
os-resetState:
additionalProperties: false
description: |-
The action.
properties:
state:
description: |-
The state of the server to be set, `active` or `error` are valid.
enum:
- active
- error
type: string
required:
- state
type: object
required:
- os-resetState
summary: Reset Server State (os-resetState Action)
type: object
x-openstack:
action-name: os-resetState
ServersAction_Restore:
additionalProperties: false
description: |-
Restores a previously soft-deleted server instance. You cannot use
this method to restore deleted instances.
Specify the `restore` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409)
properties:
restore: {}
required:
- restore
summary: Restore Soft-Deleted Instance (restore Action)
type: object
x-openstack:
action-name: restore
ServersAction_Resume:
additionalProperties: false
description: |-
Resumes a suspended server and changes its status to `ACTIVE`.
Specify the `resume` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), conflict(409)
properties:
resume: {}
required:
- resume
summary: Resume Suspended Server (resume Action)
type: object
x-openstack:
action-name: resume
ServersAction_Shelve:
additionalProperties: false
description: |-
Shelves a server.
Specify the `shelve` action in the request body.
All associated data and resources are kept but anything still in memory is not retained. To restore a shelved instance, use the `unshelve` action. To remove a shelved instance, use the `shelveOffload` action.
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.yaml` file.
**Preconditions**
The server status must be `ACTIVE`, `SHUTOFF`, `PAUSED`, or `SUSPENDED`.
If the server is locked, you must have administrator privileges to shelve the server.
**Asynchronous Postconditions**
After you successfully shelve a server, its status changes to `SHELVED` and the image status is `ACTIVE`. The server instance data appears on the compute node that the Compute service manages.
If you boot the server from volumes or set the `shelved_offload_time` option to 0, the Compute service automatically deletes the instance on compute nodes and changes the server status to `SHELVED_OFFLOADED`.
**Troubleshooting**
If the server status does not change to `SHELVED` or `SHELVED_OFFLOADED`, the shelve operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
properties:
shelve: {}
required:
- shelve
summary: Shelve Server (shelve Action)
type: object
x-openstack:
action-name: shelve
ServersAction_Shelve_Offload:
additionalProperties: false
description: |-
Shelf-offloads, or removes, a shelved server.
Specify the `shelveOffload` action in the request body.
Data and resource associations are deleted. If an instance is no longer needed, you can remove that instance from the hypervisor to minimize resource usage.
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.yaml` file.
**Preconditions**
The server status must be `SHELVED`.
If the server is locked, you must have administrator privileges to shelve-offload the server.
**Asynchronous Postconditions**
After you successfully shelve-offload a server, its status changes to `SHELVED_OFFLOADED`. The server instance data appears on the compute node.
**Troubleshooting**
If the server status does not change to `SHELVED_OFFLOADED`, the shelve-offload operation failed. Ensure that you meet the preconditions and run the request again. If the request fails again, investigate whether another operation is running that causes a race condition.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
properties:
shelveOffload: {}
required:
- shelveOffload
summary: Shelf-Offload (Remove) Server (shelveOffload Action)
type: object
x-openstack:
action-name: shelveOffload
ServersAction_Start_Server:
additionalProperties: false
description: |-
Starts a stopped server and changes its status to `ACTIVE`.
Specify the `os-start` action in the request body.
**Preconditions**
The server status must be `SHUTOFF`.
If the server is locked, you must have administrator privileges
to start the server.
**Asynchronous Postconditions**
After you successfully start a server, its status changes to `ACTIVE`.
**Troubleshooting**
If the server status does not change to `ACTIVE`, the start operation failed.
Ensure that you meet the preconditions and run the request again.
If the request fails again, investigate whether another operation is running
that causes a race condition.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409)
properties:
os-start: {}
required:
- os-start
summary: Start Server (os-start Action)
type: object
x-openstack:
action-name: os-start
ServersAction_Stop_Server:
additionalProperties: false
description: |-
Stops a running server and changes its status to `SHUTOFF`.
Specify the `os-stop` action in the request body.
**Preconditions**
The server status must be `ACTIVE` or `ERROR`.
If the server is locked, you must have administrator privileges
to stop the server.
**Asynchronous Postconditions**
After you successfully stop a server, its status changes to `SHUTOFF`.
This API operation does not delete the server instance data and the data
will be available again after `os-start` action.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409)
properties:
os-stop: {}
required:
- os-stop
summary: Stop Server (os-stop Action)
type: object
x-openstack:
action-name: os-stop
ServersAction_Suspend:
additionalProperties: false
description: |-
Suspends a server and changes its status to `SUSPENDED`.
Specify the `suspend` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409)
properties:
suspend: {}
required:
- suspend
summary: Suspend Server (suspend Action)
type: object
x-openstack:
action-name: suspend
ServersAction_Unlock_21:
additionalProperties: false
description: |-
Unlocks a locked server.
Specify the `unlock` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
properties:
unlock: {}
required:
- unlock
summary: Unlock Server (unlock Action)
type: object
x-openstack:
action-name: unlock
max-ver: '2.72'
min-ver: '2.1'
ServersAction_Unpause:
additionalProperties: false
description: |-
Unpauses a paused server and changes its status to `ACTIVE`.
Specify the `unpause` action in the request body.
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.yaml` file.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
properties:
unpause: {}
required:
- unpause
summary: Unpause Server (unpause Action)
type: object
x-openstack:
action-name: unpause
ServersAction_Unrescue:
additionalProperties: false
description: |-
Unrescues a server. Changes status to `ACTIVE`.
Specify the `unrescue` action in the request body.
**Preconditions**
The server must exist.
You can only unrescue a server when its status is `RESCUE`.
**Asynchronous Postconditions**
After you successfully unrescue a server and make a
`GET /servers/{server_id}`
request, its status changes to `ACTIVE`.
Normal response codes: 202
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
conflict(409), notImplemented(501)
properties:
unrescue: {}
required:
- unrescue
summary: Unrescue Server (unrescue Action)
type: object
x-openstack:
action-name: unrescue
ServersAction_Unshelve_21:
additionalProperties: false
properties:
unshelve: {}
required:
- unshelve
summary: Unshelve (Restore) Shelved Server (unshelve Action)
type: object
x-openstack:
action-name: unshelve
max-ver: '2.76'
min-ver: '2.1'
ServersAction_Unshelve_277:
additionalProperties: false
properties:
unshelve:
additionalProperties: false
description: |-
The action.
properties:
availability_zone:
format: name
maxLength: 255
minLength: 1
type: string
required:
- availability_zone
type:
- 'null'
- object
required:
- unshelve
summary: Unshelve (Restore) Shelved Server (unshelve Action)
type: object
x-openstack:
action-name: unshelve
max-ver: '2.90'
min-ver: '2.77'
ServersAction_Unshelve_291:
additionalProperties: false
properties:
unshelve:
additionalProperties: false
description: |-
The action.
properties:
availability_zone:
type:
- 'null'
- string
host:
type: string
type:
- 'null'
- object
required:
- unshelve
summary: Unshelve (Restore) Shelved Server (unshelve Action)
type: object
x-openstack:
action-name: unshelve
max-ver: '2.76'
min-ver: '2.91'
ServersConsoleShowResponse: {}
ServersConsolesCreateResponse: {}
ServersConsolesListResponse: {}
ServersCreateRequest:
oneOf:
- $ref: '#/components/schemas/ServersCreate_20'
- $ref: '#/components/schemas/ServersCreate_21'
- $ref: '#/components/schemas/ServersCreate_219'
- $ref: '#/components/schemas/ServersCreate_232'
- $ref: '#/components/schemas/ServersCreate_233'
- $ref: '#/components/schemas/ServersCreate_237'
- $ref: '#/components/schemas/ServersCreate_242'
- $ref: '#/components/schemas/ServersCreate_252'
- $ref: '#/components/schemas/ServersCreate_257'
- $ref: '#/components/schemas/ServersCreate_263'
- $ref: '#/components/schemas/ServersCreate_267'
- $ref: '#/components/schemas/ServersCreate_274'
- $ref: '#/components/schemas/ServersCreate_290'
- $ref: '#/components/schemas/ServersCreate_294'
x-openstack:
discriminator: microversion
ServersCreateResponse:
oneOf:
- description: Created server object
properties:
server:
description: |-
A `server` object.
properties:
OS-DCF:diskConfig:
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.
enum:
- AUTO
- MANUAL
type: string
adminPass:
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.
format: password
type: string
id:
description: |-
The UUID of the server.
format: uuid
readOnly: true
type: string
links:
description: |-
Links pertaining to usage. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
**New in version 2.40**
items:
description: Links to the resources in question. See [API
Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
security_groups:
description: |-
One or more security groups objects.
items:
properties:
name:
description: The security group name
type: string
type: object
type: array
required:
- id
type: object
type: object
- properties:
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.
type: string
required:
- reservation_id
type: object
ServersCreate_20:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
Key pair name.
Note
The `null` value was allowed in the Nova legacy v2 API,
but due to strict input validation, it is not allowed in
the Nova v2.1 API.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
Key pair name.
Note
The `null` value was allowed in the Nova legacy v2 API,
but due to strict input validation, it is not allowed in
the Nova v2.1 API.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
Key pair name.
Note
The `null` value was allowed in the Nova legacy v2 API,
but due to strict input validation, it is not allowed in
the Nova v2.1 API.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
items:
additionalProperties: false
properties:
fixed_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
uuid:
type: string
type: object
type: array
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
Key pair name.
Note
The `null` value was allowed in the Nova legacy v2 API,
but due to strict input validation, it is not allowed in
the Nova v2.1 API.
format: name_with_leading_trailing_spaces
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type:
- 'null'
- string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.0'
ServersCreate_21:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
items:
additionalProperties: false
properties:
fixed_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
uuid:
type: string
type: object
type: array
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.18'
min-ver: '2.1'
ServersCreate_219:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
items:
additionalProperties: false
properties:
fixed_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
uuid:
type: string
type: object
type: array
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.31'
min-ver: '2.19'
ServersCreate_232:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
items:
additionalProperties: false
properties:
fixed_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
type: string
type: object
type: array
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.32'
min-ver: '2.32'
ServersCreate_233:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
items:
additionalProperties: false
properties:
fixed_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
type: string
type: object
type: array
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.36'
min-ver: '2.33'
ServersCreate_237:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.41'
min-ver: '2.37'
ServersCreate_242:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.51'
min-ver: '2.42'
ServersCreate_252:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
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.
**Available until version 2.56**
items:
additionalProperties: false
properties:
contents:
format: base64
type: string
path:
type: string
type: object
type: array
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
description: |-
A list of tags. Tags have the following restrictions:
* Tag is a Unicode bytestring no longer than 60 characters.
* Tag is a non-empty string.
* ‘/’ is not allowed to be in a tag name
* Comma is not allowed to be in a tag name in order to simplify
requests that specify lists of tags
* All other characters are allowed to be in a tag name
* Each server can have up to 50 tags.
**New in version 2.52**
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.56'
min-ver: '2.52'
ServersCreate_257:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
description: |-
A list of tags. Tags have the following restrictions:
* Tag is a Unicode bytestring no longer than 60 characters.
* Tag is a non-empty string.
* ‘/’ is not allowed to be in a tag name
* Comma is not allowed to be in a tag name in order to simplify
requests that specify lists of tags
* All other characters are allowed to be in a tag name
* Each server can have up to 50 tags.
**New in version 2.52**
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.62'
min-ver: '2.57'
ServersCreate_263:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
description: |-
A list of tags. Tags have the following restrictions:
* Tag is a Unicode bytestring no longer than 60 characters.
* Tag is a non-empty string.
* ‘/’ is not allowed to be in a tag name
* Comma is not allowed to be in a tag name in order to simplify
requests that specify lists of tags
* All other characters are allowed to be in a tag name
* Each server can have up to 50 tags.
**New in version 2.52**
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, which are used during image
signature verification to verify the signing certificate. The list is
restricted to a maximum of 50 IDs. This parameter is optional in server
create requests if allowed by policy, and is not supported for
volume-backed instances.
**New in version 2.63**
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.66'
min-ver: '2.63'
ServersCreate_267:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
volume_type:
maxLength: 255
minLength: 0
type:
- 'null'
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- 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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
description: |-
A list of tags. Tags have the following restrictions:
* Tag is a Unicode bytestring no longer than 60 characters.
* Tag is a non-empty string.
* ‘/’ is not allowed to be in a tag name
* Comma is not allowed to be in a tag name in order to simplify
requests that specify lists of tags
* All other characters are allowed to be in a tag name
* Each server can have up to 50 tags.
**New in version 2.52**
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, which are used during image
signature verification to verify the signing certificate. The list is
restricted to a maximum of 50 IDs. This parameter is optional in server
create requests if allowed by policy, and is not supported for
volume-backed instances.
**New in version 2.63**
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.73'
min-ver: '2.67'
ServersCreate_274:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
volume_type:
maxLength: 255
minLength: 0
type:
- 'null'
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- string
host:
description: |-
The hostname of the hypervisor on which the server is to be created.
The API will return 400 if no hypervisors are found with the given
hostname. By default, it can be specified by administrators only.
**New in version 2.74**
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
hypervisor_hostname:
description: |-
The hostname of the hypervisor on which the server is to be created.
The API will return 400 if no hypervisors are found with the given
hostname. By default, it can be specified by administrators only.
**New in version 2.74**
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
description: |-
A list of tags. Tags have the following restrictions:
* Tag is a Unicode bytestring no longer than 60 characters.
* Tag is a non-empty string.
* ‘/’ is not allowed to be in a tag name
* Comma is not allowed to be in a tag name in order to simplify
requests that specify lists of tags
* All other characters are allowed to be in a tag name
* Each server can have up to 50 tags.
**New in version 2.52**
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, which are used during image
signature verification to verify the signing certificate. The list is
restricted to a maximum of 50 IDs. This parameter is optional in server
create requests if allowed by policy, and is not supported for
volume-backed instances.
**New in version 2.63**
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.89'
min-ver: '2.74'
ServersCreate_290:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
volume_type:
maxLength: 255
minLength: 0
type:
- 'null'
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- string
host:
description: |-
The hostname of the hypervisor on which the server is to be created.
The API will return 400 if no hypervisors are found with the given
hostname. By default, it can be specified by administrators only.
**New in version 2.74**
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
hostname:
description: |-
The hostname to configure for the instance in the metadata service.
Starting with microversion 2.94, this can be a Fully Qualified Domain Name
(FQDN) of up to 255 characters in length.
Note
This information is published via the metadata service and requires
application such as `cloud-init` to propagate it through to the
instance.
**New in version 2.90**
maxLength: 63
minLength: 2
pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]+$
type: string
hypervisor_hostname:
description: |-
The hostname of the hypervisor on which the server is to be created.
The API will return 400 if no hypervisors are found with the given
hostname. By default, it can be specified by administrators only.
**New in version 2.74**
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
description: |-
A list of tags. Tags have the following restrictions:
* Tag is a Unicode bytestring no longer than 60 characters.
* Tag is a non-empty string.
* ‘/’ is not allowed to be in a tag name
* Comma is not allowed to be in a tag name in order to simplify
requests that specify lists of tags
* All other characters are allowed to be in a tag name
* Each server can have up to 50 tags.
**New in version 2.52**
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, which are used during image
signature verification to verify the signing certificate. The list is
restricted to a maximum of 50 IDs. This parameter is optional in server
create requests if allowed by policy, and is not supported for
volume-backed instances.
**New in version 2.63**
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.93'
min-ver: '2.90'
ServersCreate_294:
additionalProperties: false
properties:
OS-SCH-HNT:scheduler_hints:
additionalProperties: true
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
os:scheduler_hints:
additionalProperties: true
description: |-
The dictionary of data to send to the scheduler. Alternatively, you can specify
`OS-SCH-HNT:scheduler_hints` as the key in the request body.
Note
This is a top-level key in the request body, not part of the
server portion of the request body.
There are a few caveats with scheduler hints:
* The request validation schema is per hint. For example, some require a
single string value, and some accept a list of values.
* Hints are only used based on the cloud scheduler configuration, which
varies per deployment.
* Hints are pluggable per deployment, meaning that a cloud can have custom
hints which may not be available in another cloud.
For these reasons, it is important to consult each cloud’s user
documentation to know what is available for scheduler hints.
properties:
build_near_host_ip:
description: |-
Schedule the server on a host in the network specified with this parameter
and a cidr (`os:scheduler_hints.cidr`).
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
oneOf:
- format: ipv4
- format: ipv6
type: string
cidr:
description: |-
Schedule the server on a host in the network specified with an IP address
(`os:scheduler_hints:build_near_host_ip`) and this parameter.
If `os:scheduler_hints:build_near_host_ip` is specified and
this parameter is omitted, `/24` is used.
It is available when `SimpleCIDRAffinityFilter` is available
on cloud side.
pattern: ^/[0-9a-f.:]+$
type: string
different_cell:
description: |-
A list of cell routes or a cell route (string).
Schedule the server in a cell that is not specified.
It is available when `DifferentCellFilter` is available on cloud side
that is cell v1 environment.
items:
type: string
type:
- array
- string
different_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on a different host from a set of servers.
It is available when `DifferentHostFilter` is available on cloud side.
oneOf:
- items:
format: uuid
type: string
type: array
- format: uuid
type: string
group:
description: |-
The server group UUID. Schedule the server according to a policy of
the server group (`anti-affinity`, `affinity`, `soft-anti-affinity`
or `soft-affinity`).
It is available when `ServerGroupAffinityFilter`,
`ServerGroupAntiAffinityFilter`, `ServerGroupSoftAntiAffinityWeigher`,
`ServerGroupSoftAffinityWeigher` are available on cloud side.
format: uuid
type: string
query:
description: |-
Schedule the server by using a custom filter in JSON format.
For example:
```
"query": "[\">=\",\"$free_ram_mb\",1024]"
```
It is available when `JsonFilter` is available on cloud side.
type:
- object
- string
same_host:
description: |-
A list of server UUIDs or a server UUID.
Schedule the server on the same host as another server in a set of
servers.
It is available when `SameHostFilter` is available on cloud side.
items:
format: uuid
type: string
type:
- array
- string
target_cell:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
server:
additionalProperties: false
description: |-
A `server` object.
properties:
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.
enum:
- AUTO
- MANUAL
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server.
format: ipv6
type: string
adminPass:
description: |-
The administrative password of the server. If you omit this parameter, the operation
generates a new password.
type: string
availability_zone:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
block_device_mapping:
items:
additionalProperties: false
properties:
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
type: object
type: array
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:
> ```
> "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",
> "disk_bus": "scsi"}]
> ```
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.
items:
additionalProperties: false
properties:
boot_index:
pattern: ^-?[0-9]+$
type:
- integer
- 'null'
- string
connection_info:
maxLength: 16777215
type: string
delete_on_termination:
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
destination_type:
enum:
- local
- volume
type: string
device_name:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._/-]*$
type: string
device_type:
maxLength: 255
type: string
disk_bus:
maxLength: 255
type: string
guest_format:
maxLength: 255
type: string
image_id:
format: uuid
type: string
no_device: {}
snapshot_id:
format: uuid
type: string
source_type:
enum:
- blank
- image
- snapshot
- volume
type: string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9._-]*$
type: string
virtual_name:
maxLength: 255
type: string
volume_id:
format: uuid
type: string
volume_size:
maximum: 2147483647
minimum: 1
pattern: ^[0-9]+$
type:
- integer
- string
volume_type:
maxLength: 255
minLength: 0
type:
- 'null'
- string
type: object
type: array
config_drive:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
description:
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.
**New in version 2.19**
maxLength: 255
minLength: 0
pattern: ^[\
-\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻ -〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ!-하-ᅦᅧ-ᅬᅭ-ᅲᅳ-ᅵ¢-₩│-○-�]*$
type:
- 'null'
- string
flavorRef:
description: |-
The flavor reference, as an ID (including a UUID) or full URL,
for the flavor for your server instance.
minLength: 1
type:
- integer
- string
host:
description: |-
The hostname of the hypervisor on which the server is to be created.
The API will return 400 if no hypervisors are found with the given
hostname. By default, it can be specified by administrators only.
**New in version 2.74**
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
hostname:
description: |-
The hostname to configure for the instance in the metadata service.
Starting with microversion 2.94, this can be a Fully Qualified Domain Name
(FQDN) of up to 255 characters in length.
Note
This information is published via the metadata service and requires
application such as `cloud-init` to propagate it through to the
instance.
**New in version 2.90**
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
type: string
hypervisor_hostname:
description: |-
The hostname of the hypervisor on which the server is to be created.
The API will return 400 if no hypervisors are found with the given
hostname. By default, it can be specified by administrators only.
**New in version 2.74**
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-._]*$
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.
oneOf:
- format: uuid
type: string
- maxLength: 0
type: string
key_name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
max_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size of the metadata key and value is
255 bytes each.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
min_count:
minLength: 1
minimum: 1
pattern: ^[0-9]*$
type:
- integer
- string
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
networks:
description: |-
A list of `network` 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.
If multiple networks are defined, the order in which they appear in the
guest operating system will not necessarily reflect the order in which they
are given in the server boot request. Guests should therefore not depend
on device order to deduce any information about their network devices.
Instead, device role tags should be used: introduced in 2.32, broken in
2.37, and re-introduced and fixed in 2.42, 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
string 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, fixed IPs or device
tags. These are requested as strings for the networks value, not in a
list. See the associated example.
oneOf:
- items:
additionalProperties: false
properties:
fixed_ip:
oneOf:
- format: ipv4
- format: ipv6
type: string
port:
format: uuid
type:
- 'null'
- string
tag:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
uuid:
format: uuid
type: string
type: object
type: array
- enum:
- auto
- none
type: string
return_reservation_id:
description: |-
Indicates whether a config 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](https://docs.openstack.org/nova/latest/user/config-drive.html).
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
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. Requested security groups are not
applied to pre-existing ports.
items:
additionalProperties: false
properties:
name:
description: |-
A target cell name. Schedule the server in a host in the cell specified.
It is available when `TargetCellFilter` is available on cloud side
that is cell v1 environment.
format: name
maxLength: 255
minLength: 1
type: string
type: object
type: array
tags:
description: |-
A list of tags. Tags have the following restrictions:
* Tag is a Unicode bytestring no longer than 60 characters.
* Tag is a non-empty string.
* ‘/’ is not allowed to be in a tag name
* Comma is not allowed to be in a tag name in order to simplify
requests that specify lists of tags
* All other characters are allowed to be in a tag name
* Each server can have up to 50 tags.
**New in version 2.52**
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, which are used during image
signature verification to verify the signing certificate. The list is
restricted to a maximum of 50 IDs. This parameter is optional in server
create requests if allowed by policy, and is not supported for
volume-backed instances.
**New in version 2.63**
items:
minLength: 1
type: string
maxItems: 50
minItems: 1
type:
- array
- 'null'
uniqueItems: true
user_data:
description: |-
Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.
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.
format: base64
maxLength: 65535
type: string
required:
- flavorRef
- name
- networks
type: object
required:
- server
type: object
x-openstack:
max-ver: '2.0'
min-ver: '2.94'
ServersDetailResponse:
properties:
servers:
description: |-
A list of `server` objects.
items:
description: Server object
properties:
OS-DCF:diskConfig:
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.
enum:
- AUTO
- MANUAL
type: string
OS-EXT-AZ:availability_zone:
description: |-
The availability zone name.
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.
type: string
OS-EXT-SRV-ATTR:hostname:
description: |-
The hostname of the instance reported in the metadata service.
This parameter only appears in responses for administrators until
microversion 2.90, after which it is shown for all users.
Note
This information is published via the metadata service and requires
application such as `cloud-init` to propagate it through to the
instance.
**New in version 2.3**
type: string
x-openstack:
min-ver: '2.3'
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 uuid. Appears in the response for administrative users only.
type: string
x-openstack-sdk-name: hypervisor_hostname
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.
type: string
OS-EXT-SRV-ATTR:kernel_id:
description: |-
The UUID of the kernel image when using an AMI. Will be null if not.
By default, it appears in the response for administrative users only.
**New in version 2.3**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:launch_index:
description: |-
When servers are launched via multiple create, this is the
sequence in which the servers were launched.
By default, it appears in the response for administrative users only.
**New in version 2.3**
type: integer
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:ramdisk_id:
description: |-
The UUID of the ramdisk image when using an AMI. Will be null if not.
By default, it appears in the response for administrative users only.
**New in version 2.3**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR: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.
By default, it appears in the response for administrative users only.
**New in version 2.3**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:root_device_name:
description: |-
The root device name for the instance
By default, it appears in the response for administrative users only.
**New in version 2.3**
type: string
x-openstack:
min-ver: '2.3'
OS-EXT-SRV-ATTR:user_data:
description: |-
The user_data the instance was created with.
By default, it appears in the response for administrative users only.
**New in version 2.3**
type: string
x-openstack:
min-ver: '2.3'
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
```
type: integer
OS-EXT-STS:task_state:
description: |-
The task state of the instance.
type: string
OS-EXT-STS:vm_state:
description: |-
The VM state.
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](https://en.wikipedia.org/wiki/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`.
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](https://en.wikipedia.org/wiki/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`.
type: string
accessIPv4:
description: |-
IPv4 address that should be used to access this server. May be
automatically set by the provider.
format: ipv4
type: string
accessIPv6:
description: |-
IPv6 address that should be used to access this server. May be
automatically set by the provider.
format: ipv6
type: string
addresses:
additionalProperties:
items:
properties:
addr:
description: The IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
version:
description: The IP version of the address associated
with server.
enum:
- 4
- 6
type: integer
type: object
type: array
description: |-
The addresses for the server. Servers with status `BUILD` hide their
addresses information.
This view is not updated immediately.
Please consult with OpenStack Networking API for up-to-date information.
type: object
config_drive:
description: |-
Indicates whether or not a config drive was used for this server.
The value is `True` or an empty string. An empty string stands for
`False`.
type: string
created:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
readOnly: true
type: string
description:
description: |-
The description of the server.
Before microversion 2.19 this was set to the server name.
**New in version 2.19**
type: string
fault:
additionalProperties: false
description: |-
A fault object. Only displayed when the server status is `ERROR` or
`DELETED` and a fault occurred.
properties:
code:
description: |-
The error response code.
type: integer
created:
description: |-
The date and time when the exception was raised. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
details:
description: |-
The stack trace. It is available if the response code is not 500 or
you have the administrator privilege
type: string
message:
description: |-
The error message.
type: string
type: object
flavor:
description: |-
Before microversion 2.47 this contains the ID and links for the flavor
used to boot the server instance. This can be an empty object in case
flavor information is no longer present in the system.
As of microversion 2.47 this contains a subset of the actual flavor
information used to create the server instance, represented as a nested
dictionary.
properties:
disk:
description: |-
The size of the root disk that was created in GiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
ephemeral:
description: |-
The size of the ephemeral disk that was created, in GiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
extra_specs:
additionalProperties: false
description: |-
A dictionary of the flavor’s extra-specs key-and-value pairs. This will
only be included if the user is allowed by policy to index flavor
extra_specs.
**New in version 2.47**
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
x-openstack:
min-ver: '2.47'
id:
description: |-
The UUID of the server.
type: string
x-openstack:
max-ver: '2.46'
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
description: Links to the resources in question. See [API
Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
x-openstack:
max-ver: '2.46'
original_name:
description: |-
The display name of a flavor.
**New in version 2.47**
type: string
x-openstack:
min-ver: '2.47'
ram:
description: |-
The amount of RAM a flavor has, in MiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
swap:
description: |-
The size of a dedicated swap disk that was allocated, in MiB.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
vcpus:
description: |-
The number of virtual CPUs that were allocated to the server.
**New in version 2.47**
type: integer
x-openstack:
min-ver: '2.47'
type: object
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.
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.
By default, only administrators can get this parameter.
**New in version 2.16**
enum:
- ''
- DOWN
- MAINTENANCE
- UNKNOWN
- UP
- 'null'
type:
- 'null'
- string
x-openstack:
min-ver: '2.16'
id:
description: Id of the server
format: uuid
readOnly: true
type: string
image:
description: |-
The UUID and links for the image for your server instance. The `image` object
will be an empty string when you boot the server from a volume.
oneOf:
- description: The image property as returned from server.
properties:
id:
description: The image ID
format: uuid
type: string
links:
description: Links to the resources in question. See
[API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
description: Links to the resources in question. See
[API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
properties:
type: object
x-openstack:
min-ver: '2.98'
required:
- id
type: object
- enum:
- ''
type: string
key_name:
description: |-
The name of associated key pair, if any.
type: string
links:
description: Links to the resources in question. See [API Guide
/ Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
description: Links to the resources in question. See [API
Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
locked:
description: |-
True if the instance is locked otherwise False.
**New in version 2.9**
type: boolean
x-openstack:
min-ver: '2.9'
metadata:
additionalProperties: false
description: |-
A dictionary of metadata key-and-value pairs, which is maintained for backward
compatibility.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
name:
description: |-
The server name.
type: string
os-extended-volumes:volumes_attached:
description: |-
The attached volumes, if any.
items:
type: object
type: array
progress:
description: |-
A percentage value of the operation progress.
This parameter only appears when the server status is `ACTIVE`,
`BUILD`, `REBUILD`, `RESIZE`, `VERIFY_RESIZE` or `MIGRATING`.
type: integer
security_groups:
description: |-
One or more security groups objects.
items:
properties:
name:
description: The security group name
type: string
type: object
type: array
server_groups:
description: The UUIDs of the server groups to which the server
belongs. Currently this can contain at most one entry.
items:
type: string
type: array
x-openstack:
min-ver: '2.71'
status:
description: |-
The server status.
readOnly: true
type: string
tags:
description: |-
A list of tags. The maximum count of tags in this list is 50.
**New in version 2.26**
items:
type: string
type: array
x-openstack:
min-ver: '2.26'
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
format: uuid
type: string
trusted_image_certificates:
description: |-
A list of trusted certificate IDs, that were used during image signature
verification to verify the signing certificate. The list is restricted
to a maximum of 50 IDs. The value is `null` if trusted certificate IDs
are not set.
**New in version 2.63**
items:
type: string
type:
- array
- 'null'
x-openstack:
min-ver: '2.63'
updated:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
readOnly: true
type: string
user_id:
description: |-
The user ID of the user who owns the server.
type: string
required:
- flavor
- id
- image
- name
type: object
type: array
servers_links:
description: |-
Links pertaining to usage. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
**New in version 2.40**
items:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
type: object
ServersDiagnosticsListResponse:
properties:
config_drive:
description: |-
Indicates whether or not a config drive was used for this server.
**New in version 2.48**
type: boolean
x-openstack:
min-ver: '2.48'
cpu_details:
description: |-
The list of dictionaries with detailed information about VM CPUs.
Following fields are presented in each dictionary:
* `id` - the ID of CPU (Integer)
* `time` - CPU Time in nano seconds (Integer)
* `utilisation` - CPU utilisation in percents (Integer)
**New in version 2.48**
items:
type: object
type: array
x-openstack:
min-ver: '2.48'
disk_details:
description: |-
The list of dictionaries with detailed information about VM disks.
Following fields are presented in each dictionary:
* `read_bytes` - Disk reads in bytes (Integer)
* `read_requests` - Read requests (Integer)
* `write_bytes` - Disk writes in bytes (Integer)
* `write_requests` - Write requests (Integer)
* `errors_count` - Disk errors (Integer)
**New in version 2.48**
items:
type: object
type: array
x-openstack:
min-ver: '2.48'
driver:
description: |-
The driver on which the VM is running. Possible values are:
* `libvirt`
* `xenapi`
* `vmwareapi`
* `ironic`
**New in version 2.48**
enum:
- hyperv
- ironic
- libvirt
- vmwareapi
- xenapi
type: string
x-openstack:
min-ver: '2.48'
hypervisor:
description: |-
The hypervisor on which the VM is running. Examples for libvirt driver
may be: `qemu`, `kvm` or `xen`.
**New in version 2.48**
type: string
x-openstack:
min-ver: '2.48'
hypervisor_os:
description: |-
The hypervisor OS.
**New in version 2.48**
type: string
x-openstack:
min-ver: '2.48'
id:
description: Id of the resource
format: uuid
readOnly: true
type: string
memory_details:
description: |-
The dictionary with information about VM memory usage.
Following fields are presented in the dictionary:
* `maximum` - Amount of memory provisioned for the VM in MiB (Integer)
* `used` - Amount of memory that is currently used by the guest operating
system and its applications in MiB (Integer)
**New in version 2.48**
items:
type: object
type: array
x-openstack:
min-ver: '2.48'
name:
description: Name
type: string
nic_details:
description: |-
The list of dictionaries with detailed information about VM NICs.
Following fields are presented in each dictionary:
* `mac_address` - Mac address of the interface (String)
* `rx_octets` - Received octets (Integer)
* `rx_errors` - Received errors (Integer)
* `rx_drop` - Received packets dropped (Integer)
* `rx_packets` - Received packets (Integer)
* `rx_rate` - Receive rate in bytes (Integer)
* `tx_octets` - Transmitted Octets (Integer)
* `tx_errors` - Transmit errors (Integer)
* `tx_drop` - Transmit dropped packets (Integer)
* `tx_packets` - Transmit packets (Integer)
* `tx_rate` - Transmit rate in bytes (Integer)
**New in version 2.48**
items:
properties:
mac_address:
description: ''
type: string
rx_drop:
description: ''
type: integer
rx_errors:
description: ''
type: integer
rx_octets:
description: ''
type: integer
rx_packets:
description: ''
type: integer
rx_rate:
description: ''
type: integer
tx_drop:
description: ''
type: integer
tx_errors:
description: ''
type: integer
tx_octets:
description: ''
type: integer
tx_packets:
description: ''
type: integer
tx_rate:
description: ''
type: integer
type: object
type: array
x-openstack:
min-ver: '2.48'
num_cpus:
description: |-
The number of vCPUs.
**New in version 2.48**
type: integer
x-openstack:
min-ver: '2.48'
num_disks:
description: |-
The number of disks.
**New in version 2.48**
type: integer
x-openstack:
min-ver: '2.48'
num_nics:
description: |-
The number of vNICs.
**New in version 2.48**
type: integer
x-openstack:
min-ver: '2.48'
state:
description: |-
A string enum denoting the current state of the VM. Possible values are:
* `pending`
* `running`
* `paused`
* `shutdown`
* `crashed`
* `suspended`
**New in version 2.48**
enum:
- crashed
- paused
- pending
- running
- shutdown
- suspended
type: string
x-openstack:
min-ver: '2.48'
uptime:
description: |-
The amount of time in seconds that the VM has been running.
**New in version 2.48**
type: integer
x-openstack:
min-ver: '2.48'
required:
- id
- name
type: object
ServersIpShowResponse:
additionalProperties:
items:
properties:
addr:
description: The IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
version:
description: The IP version of the address associated with server.
enum:
- 4
- 6
type: integer
type: object
type: array
description: A dictionary of addresses this server can be accessed
through. The dictionary contains keys such as ``private`` and
``public``, each containing a list of dictionaries for addresses of that
type. The addresses are contained in a dictionary with keys ``addr`` and
``version``, which is either 4 or 6 depending on the protocol of the IP
address.
maxProperties: 1
type: object
ServersIpsListResponse:
description: The addresses information for the server.
properties:
addresses:
additionalProperties:
items:
properties:
addr:
description: The IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
version:
description: The IP version of the address associated with
server.
enum:
- 4
- 6
type: integer
type: object
type: array
description: |-
The addresses information for the server.
type: object
type: object
ServersListResponse:
properties:
servers:
description: |-
A list of `server` objects.
items:
description: Server object
properties:
id:
description: |-
The UUID of the server.
format: uuid
type: string
name:
description: |-
The server name.
format: uuid
type: string
required:
- id
- name
type: object
type: array
servers_links:
description: |-
Links pertaining to usage. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
**New in version 2.40**
items:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
type: object
ServersMetadataCreate:
additionalProperties: false
properties:
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- metadata
type: object
ServersMetadataCreateResponse:
description: Metadata key and value pairs. The maximum size for each
metadata key and value pair is 255 bytes.
properties:
metadata:
additionalProperties: false
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.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- metadata
type: object
ServersMetadataListResponse:
description: Metadata key and value pairs. The maximum size for each
metadata key and value pair is 255 bytes.
properties:
metadata:
additionalProperties: false
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.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- metadata
type: object
ServersMetadataShowResponse:
description: Metadata key and value pairs. The maximum size for each
metadata key and value pair is 255 bytes.
properties:
meta:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
maxProperties: 1
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
type: object
ServersMetadataUpdate:
additionalProperties: false
properties:
meta:
additionalProperties: false
maxProperties: 1
minProperties: 1
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- meta
type: object
ServersMetadataUpdateResponse:
description: Response of the servers/server_id/metadata/id:put operation
type: object
ServersMetadataUpdate_All:
additionalProperties: false
properties:
metadata:
additionalProperties: false
description: |-
Metadata key and value pairs. The maximum size for each metadata key and value
pair is 255 bytes.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- metadata
type: object
ServersMetadataUpdate_AllResponse:
description: Metadata key and value pairs. The maximum size for each
metadata key and value pair is 255 bytes.
properties:
metadata:
additionalProperties: false
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.
patternProperties:
^[a-zA-Z0-9-_:. ]{1,255}$:
maxLength: 255
type: string
type: object
required:
- metadata
type: object
ServersMigrationShowResponse:
properties:
migration:
description: |-
The server migration object.
properties:
created_at:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
dest_compute:
description: |-
The target compute for a migration.
type: string
dest_host:
description: |-
The target host for a migration.
type: string
dest_node:
description: |-
The target node for a migration.
type: string
disk_processed_bytes:
description: |-
The amount of disk, in bytes, that has been processed during the migration.
type: integer
disk_remaining_bytes:
description: |-
The amount of disk, in bytes, that still needs to be migrated.
type: integer
disk_total_bytes:
description: |-
The total amount of disk, in bytes, that needs to be migrated.
type: integer
id:
description: |-
The ID of the server migration.
type: integer
memory_processed_bytes:
description: |-
The amount of memory, in bytes, that has been processed during the migration.
type: integer
memory_remaining_bytes:
description: |-
The amount of memory, in bytes, that still needs to be migrated.
type: integer
memory_total_bytes:
description: |-
The total amount of memory, in bytes, that needs to be migrated.
type: integer
project_id:
description: |-
The ID of the project which initiated the server migration. The value
may be `null` for older migration records.
**New in version 2.80**
type:
- 'null'
- string
x-openstack:
min-ver: '2.80'
server_uuid:
description: |-
The UUID of the server.
format: uuid
type: string
source_compute:
description: |-
The source compute for a migration.
type: string
source_node:
description: |-
The source node for a migration.
type: string
status:
description: |-
The current status of the migration.
type: string
updated_at:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
user_id:
description: |-
The ID of the user which initiated the server migration. The value
may be `null` for older migration records.
**New in version 2.80**
type:
- 'null'
- string
x-openstack:
min-ver: '2.80'
uuid:
description: |-
The UUID of the migration.
**New in version 2.59**
format: uuid
type: string
x-openstack:
min-ver: '2.59'
type: object
type: object
ServersMigrationsAction_Force_Complete_222:
additionalProperties: false
description: |-
Force an in-progress live migration for a given server to complete.
Specify the `force_complete` action in the request body.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through the
`policy.yaml` file.
**Preconditions**
The server OS-EXT-STS:vm_state value must be `active` and the server
OS-EXT-STS:task_state value must be `migrating`.
If the server is locked, you must have administrator privileges to force the
completion of the server migration.
The migration status must be `running`.
**Asynchronous Postconditions**
After you make this request, you typically must keep polling the server status
to determine whether the request succeeded.
**Troubleshooting**
If the server status remains `MIGRATING` for an inordinate amount of time,
the request may have failed. Ensure you meet the preconditions and run the
request again. If the request fails again, investigate the compute back end.
More details can be found in the
[admin guide](https://docs.openstack.org/nova/latest/admin/live-migration-usage.html#what-to-do-when-the-migration-times-out).
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
properties:
force_complete:
description: |-
The action to force an in-progress live migration to complete.
type: 'null'
required:
- force_complete
summary: Force Migration Complete Action (force_complete Action)
type: object
x-openstack:
action-name: force_complete
min-ver: '2.22'
ServersMigrationsListResponse:
description: List of migration objects
properties:
migrations:
description: |-
The list of server migration objects.
items:
description: Migration object
properties:
created_at:
description: |-
The date and time when the resource was created. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
dest_compute:
description: |-
The target compute for a migration.
type: string
dest_host:
description: |-
The target host for a migration.
type: string
dest_node:
description: |-
The target node for a migration.
type: string
disk_processed_bytes:
description: |-
The amount of disk, in bytes, that has been processed during the migration.
type: integer
disk_remaining_bytes:
description: |-
The amount of disk, in bytes, that still needs to be migrated.
type: integer
disk_total_bytes:
description: |-
The total amount of disk, in bytes, that needs to be migrated.
type: integer
id:
description: |-
The ID of the server migration.
type: integer
memory_processed_bytes:
description: |-
The amount of memory, in bytes, that has been processed during the migration.
type: integer
memory_remaining_bytes:
description: |-
The amount of memory, in bytes, that still needs to be migrated.
type: integer
memory_total_bytes:
description: |-
The total amount of memory, in bytes, that needs to be migrated.
type: integer
project_id:
description: |-
The ID of the project which initiated the server migration. The value
may be `null` for older migration records.
**New in version 2.80**
type:
- 'null'
- string
x-openstack:
min-ver: '2.80'
server_uuid:
description: |-
The UUID of the server.
format: uuid
type: string
source_compute:
description: |-
The source compute for a migration.
type: string
source_node:
description: |-
The source node for a migration.
type: string
status:
description: |-
The current status of the migration.
type: string
updated_at:
description: |-
The date and time when the resource was updated. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
user_id:
description: |-
The ID of the user which initiated the server migration. The value
may be `null` for older migration records.
**New in version 2.80**
type:
- 'null'
- string
x-openstack:
min-ver: '2.80'
uuid:
description: |-
The UUID of the migration.
**New in version 2.59**
format: uuid
type: string
x-openstack:
min-ver: '2.59'
type: object
type: array
type: object
ServersOs_Instance_ActionShowResponse:
properties:
instanceAction:
description: |-
The instance action object.
properties:
action:
description: |-
The name of the action.
type: string
events:
description: |-
The events which occurred in this action in descending order of creation.
Policy defaults enable only users with the administrative role or the owner
of the server to see instance action event information. Cloud providers can
change these permissions through the `policy.yaml` file.
**New in version 2.51**
items:
description: Event
properties:
details:
description: Details of the event. May be null.
type:
- 'null'
- string
x-openstack:
min-ver: '2.84'
event:
description: The name of the event.
type: string
finish_time:
description: The date and time when the event was finished.
format: date-time
type: string
host:
description: The name of the host on which the event
occurred. Policy defaults enable only users with the
administrative role to see an instance action event host.
Cloud providers can change these permissions through the
policy.json file.
type: string
x-openstack:
min-ver: '2.62'
hostId:
description: An obfuscated hashed host ID string, or the
empty string if there is no host for the event. 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. This is useful when within the same project you
need to determine if two events occurred on the same or
different physical hosts.
type: string
x-openstack:
min-ver: '2.62'
result:
description: The result of the event.
type: string
start_time:
description: |-
The date and time when the action was started. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
traceback:
description: he traceback stack if an error occurred in this
event. Policy defaults enable only users with the
administrative role to see an instance action event
traceback. Cloud providers can change these permissions
through the policy.json file.
type:
- 'null'
- string
required:
- event
- start-time
type: object
type: array
instance_uuid:
description: |-
The UUID of the server.
type: string
message:
description: |-
The related error message for when an action fails.
type:
- 'null'
- string
project_id:
description: |-
The ID of the project which initiated the server action.
This can be `null` for `nova-manage`-initiated actions.
type: string
request_id:
description: |-
The request id generated when execute the API of this action.
type: string
start_time:
description: |-
The date and time when the action was started. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
updated_at:
description: |-
The date and time when the instance action or the action event of
instance action was updated. The date and time stamp format is
[ISO 8601](https://en.wikipedia.org/wiki/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`.
**New in version 2.58**
format: date-time
type:
- 'null'
- string
x-openstack:
min-ver: '2.58'
user_id:
description: |-
The ID of the user which initiated the server action.
This can be `null` for `nova-manage`-initiated actions.
type:
- 'null'
- string
required:
- action
- events
- project_id
- request_id
- user_id
type: object
required:
- instanceAction
type: object
ServersOs_Instance_ActionsListResponse:
properties:
instanceActions:
description: |-
List of the actions for the given instance in descending order of creation.
items:
description: The instance action object.
properties:
action:
description: |-
The name of the action.
type: string
instance_uuid:
description: |-
The UUID of the server.
type: string
message:
description: |-
The related error message for when an action fails.
type:
- 'null'
- string
project_id:
description: |-
The ID of the project which initiated the server action.
This can be `null` for `nova-manage`-initiated actions.
type: string
request_id:
description: |-
The request id generated when execute the API of this action.
type: string
start_time:
description: |-
The date and time when the action was started. The date and time
stamp format is [ISO 8601](https://en.wikipedia.org/wiki/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`.
format: date-time
type: string
updated_at:
description: |-
The date and time when the instance action or the action event of
instance action was updated. The date and time stamp format is
[ISO 8601](https://en.wikipedia.org/wiki/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`.
**New in version 2.58**
format: date-time
type:
- 'null'
- string
x-openstack:
min-ver: '2.58'
user_id:
description: |-
The ID of the user which initiated the server action.
This can be `null` for `nova-manage`-initiated actions.
type:
- 'null'
- string
required:
- action
- events
- project_id
- request_id
- user_id
type: object
type: array
links:
description: |-
Links pertaining to usage. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
**New in version 2.40**
items:
description: Links to the resources in question. See [API Guide /
Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
properties:
href:
format: uri
type: string
rel:
type: string
type: object
type: array
required:
- instanceActions
type: object
ServersOs_InterfaceCreateRequest:
oneOf:
- $ref: '#/components/schemas/ServersOs_InterfaceCreate_20'
- $ref: '#/components/schemas/ServersOs_InterfaceCreate_249'
x-openstack:
discriminator: microversion
ServersOs_InterfaceCreateResponse:
properties:
interfaceAttachment:
description: |-
The interface attachment.
properties:
fixed_ips:
description: |-
Fixed IP addresses with subnet IDs.
items:
properties:
ip_address:
description: |-
The IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
subnet_id:
description: |-
The UUID of the subnet.
format: uuid
type: string
type: object
type: array
mac_addr:
description: |-
The MAC address.
pattern: ^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$
type: string
net_id:
description: |-
The network ID.
format: uuid
type: string
port_id:
description: |-
The port ID.
format: uuid
type: string
port_state:
description: |-
The port state.
type: string
tag:
description: |-
The device tag applied to the virtual network interface or `null`.
**New in version 2.70**
type:
- 'null'
- string
x-openstack:
min-ver: '2.70'
required:
- fixed_ips
type: object
type: object
ServersOs_InterfaceCreate_20:
additionalProperties: false
properties:
interfaceAttachment:
additionalProperties: false
description: |-
Specify the `interfaceAttachment` action in the request body.
properties:
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.
items:
additionalProperties: false
properties:
ip_address:
description: |-
The IP address. It is required when `fixed_ips` is specified.
oneOf:
- format: ipv4
- format: ipv6
type: string
required:
- ip_address
type: object
maxItems: 1
minItems: 1
type: array
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.
format: uuid
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.
format: uuid
type: string
type: object
type: object
x-openstack:
max-ver: '2.48'
min-ver: '2.0'
ServersOs_InterfaceCreate_249:
additionalProperties: false
properties:
interfaceAttachment:
additionalProperties: false
description: |-
Specify the `interfaceAttachment` action in the request body.
properties:
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.
items:
additionalProperties: false
properties:
ip_address:
description: |-
The IP address. It is required when `fixed_ips` is specified.
oneOf:
- format: ipv4
- format: ipv6
type: string
required:
- ip_address
type: object
maxItems: 1
minItems: 1
type: array
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.
format: uuid
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.
format: uuid
type: string
tag:
description: |-
A device role tag that can be applied to a network interface when attaching
it to the VM. 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.
**New in version 2.49**
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
type: object
type: object
x-openstack:
max-ver: '2.48'
min-ver: '2.49'
ServersOs_InterfaceListResponse:
properties:
interfaceAttachments:
description: |-
List of the interface attachments.
items:
description: |-
The interface attachment.
properties:
fixed_ips:
description: |-
Fixed IP addresses with subnet IDs.
items:
properties:
ip_address:
description: |-
The IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
subnet_id:
description: |-
The UUID of the subnet.
format: uuid
type: string
type: object
type: array
mac_addr:
description: |-
The MAC address.
pattern: ^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$
type: string
net_id:
description: |-
The network ID.
format: uuid
type: string
port_id:
description: |-
The port ID.
format: uuid
type: string
port_state:
description: |-
The port state.
type: string
tag:
description: |-
The device tag applied to the virtual network interface or `null`.
**New in version 2.70**
type:
- 'null'
- string
x-openstack:
min-ver: '2.70'
required:
- fixed_ips
type: object
type: array
type: object
ServersOs_InterfaceShowResponse:
properties:
interfaceAttachment:
description: |-
The interface attachment.
properties:
fixed_ips:
description: |-
Fixed IP addresses with subnet IDs.
items:
properties:
ip_address:
description: |-
The IP address.
oneOf:
- format: ipv4
- format: ipv6
type: string
subnet_id:
description: |-
The UUID of the subnet.
format: uuid
type: string
type: object
type: array
mac_addr:
description: |-
The MAC address.
pattern: ^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$
type: string
net_id:
description: |-
The network ID.
format: uuid
type: string
port_id:
description: |-
The port ID.
format: uuid
type: string
port_state:
description: |-
The port state.
type: string
tag:
description: |-
The device tag applied to the virtual network interface or `null`.
**New in version 2.70**
type:
- 'null'
- string
x-openstack:
min-ver: '2.70'
required:
- fixed_ips
type: object
type: object
ServersOs_Security_GroupsListResponse:
properties:
security_groups:
description: |-
One or more security groups objects.
items:
properties:
description:
description: |-
Security group description.
type: string
id:
description: |-
The ID of the security group.
format: uuid
type: string
name:
description: |-
The security group name.
type: string
rules:
description: |-
The list of security group rules.
items:
properties:
from_port:
type: integer
group:
properties:
name:
type: string
type: object
id:
format: uuid
type: string
ip_protocol:
type: string
ip_range:
type: object
parent_group_id:
format: uuid
type: string
to_port:
type: integer
type: object
type: array
tenant_id:
description: |-
The UUID of the tenant in a multi-tenancy cloud.
format: uuid
type: string
required:
- id
- name
type: object
type: array
type: object
ServersOs_Server_PasswordListResponse:
properties:
password:
description: |-
The password returned from metadata server.
format: password
type: string
type: object
ServersOs_Virtual_InterfacesListResponse: {}
ServersOs_Volume_AttachmentShowResponse:
properties:
volumeAttachment:
description: |-
A dictionary representation of a volume attachment containing the fields
`device`, `id`, `serverId` and `volumeId`.
properties:
attachment_id:
description: |-
The UUID of the associated volume attachment in Cinder.
**New in version 2.89**
format: uuid
type: string
x-openstack:
min-ver: '2.89'
bdm_uuid:
description: |-
The UUID of the block device mapping record in Nova for the attachment.
**New in version 2.89**
format: uuid
type: string
x-openstack:
min-ver: '2.89'
delete_on_termination:
description: |-
A flag indicating if the attached volume will be deleted when the server is
deleted.
**New in version 2.79**
type: boolean
x-openstack:
min-ver: '2.79'
device:
description: |-
Name of the device in the attachment object, such as, `/dev/vdb`.
type: string
id:
description: |-
The volume ID of the attachment.
**Available until version 2.88**
format: uuid
type: string
x-openstack:
max-ver: '2.88'
serverId:
description: |-
The UUID of the server.
format: uuid
type: string
tag:
description: |-
The device tag applied to the volume block device or `null`.
**New in version 2.70**
type:
- 'null'
- string
x-openstack:
min-ver: '2.70'
volumeId:
description: |-
The UUID of the attached volume.
format: uuid
type: string
required:
- device
- id
- serverId
- volumeId
type: object
required:
- volumeAttachment
type: object
ServersOs_Volume_AttachmentUpdateRequest:
oneOf:
- $ref: '#/components/schemas/ServersOs_Volume_AttachmentUpdate_20'
- $ref: '#/components/schemas/ServersOs_Volume_AttachmentUpdate_285'
x-openstack:
discriminator: microversion
ServersOs_Volume_AttachmentUpdateResponse:
properties:
volumeAttachment:
description: |-
A dictionary representation of a volume attachment containing the fields
`device`, `id`, `serverId` and `volumeId`.
properties:
attachment_id:
description: |-
The UUID of the associated volume attachment in Cinder.
**New in version 2.89**
format: uuid
type: string
x-openstack:
min-ver: '2.89'
bdm_uuid:
description: |-
The UUID of the block device mapping record in Nova for the attachment.
**New in version 2.89**
format: uuid
type: string
x-openstack:
min-ver: '2.89'
delete_on_termination:
description: |-
A flag indicating if the attached volume will be deleted when the server is
deleted.
**New in version 2.79**
type: boolean
x-openstack:
min-ver: '2.79'
device:
description: |-
Name of the device in the attachment object, such as, `/dev/vdb`.
type: string
id:
description: |-
The volume ID of the attachment.
**Available until version 2.88**
format: uuid
type: string
x-openstack:
max-ver: '2.88'
serverId:
description: |-
The UUID of the server.
format: uuid
type: string
tag:
description: |-
The device tag applied to the volume block device or `null`.
**New in version 2.70**
type:
- 'null'
- string
x-openstack:
min-ver: '2.70'
volumeId:
description: |-
The UUID of the attached volume.
format: uuid
type: string
required:
- device
- id
- serverId
- volumeId
type: object
required:
- volumeAttachment
type: object
ServersOs_Volume_AttachmentUpdate_20:
additionalProperties: false
properties:
volumeAttachment:
additionalProperties: false
description: |-
A dictionary representation of a volume attachment containing the field
`volumeId` which is the UUID of the replacement volume, and other fields
to update in the attachment.
properties:
volumeId:
description: |-
The UUID of the attached volume.
format: uuid
type: string
required:
- volumeId
type: object
required:
- volumeAttachment
type: object
x-openstack:
max-ver: '2.84'
min-ver: '2.0'
ServersOs_Volume_AttachmentUpdate_285:
additionalProperties: false
properties:
volumeAttachment:
additionalProperties: false
description: |-
A dictionary representation of a volume attachment containing the field
`volumeId` which is the UUID of the replacement volume, and other fields
to update in the attachment.
properties:
delete_on_termination:
description: |-
A flag indicating if the attached volume will be deleted when the server is
deleted.
**New in version 2.85**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- string
device:
description: |-
Name of the device in the attachment object, such as, `/dev/vdb`.
**New in version 2.85**
pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$
type:
- 'null'
- string
id:
description: |-
The UUID of the attachment.
**New in version 2.85**
format: uuid
type: string
serverId:
description: |-
The UUID of the server.
**New in version 2.85**
format: uuid
type: string
tag:
description: |-
The device tag applied to the volume block device or `null`.
**New in version 2.85**
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
volumeId:
description: |-
The UUID of the attached volume.
format: uuid
type: string
required:
- volumeId
type: object
required:
- volumeAttachment
type: object
x-openstack:
max-ver: '2.84'
min-ver: '2.85'
ServersOs_Volume_AttachmentsCreateRequest:
oneOf:
- $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreate_20'
- $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreate_249'
- $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreate_279'
x-openstack:
discriminator: microversion
ServersOs_Volume_AttachmentsCreateResponse:
properties:
volumeAttachment:
description: |-
A dictionary representation of a volume attachment containing the fields
`device`, `id`, `serverId` and `volumeId`.
properties:
attachment_id:
description: |-
The UUID of the associated volume attachment in Cinder.
**New in version 2.89**
format: uuid
type: string
x-openstack:
min-ver: '2.89'
bdm_uuid:
description: |-
The UUID of the block device mapping record in Nova for the attachment.
**New in version 2.89**
format: uuid
type: string
x-openstack:
min-ver: '2.89'
delete_on_termination:
description: |-
A flag indicating if the attached volume will be deleted when the server is
deleted.
**New in version 2.79**
type: boolean
x-openstack:
min-ver: '2.79'
device:
description: |-
Name of the device in the attachment object, such as, `/dev/vdb`.
type: string
id:
description: |-
The volume ID of the attachment.
**Available until version 2.88**
format: uuid
type: string
x-openstack:
max-ver: '2.88'
serverId:
description: |-
The UUID of the server.
format: uuid
type: string
tag:
description: |-
The device tag applied to the volume block device or `null`.
**New in version 2.70**
type:
- 'null'
- string
x-openstack:
min-ver: '2.70'
volumeId:
description: |-
The UUID of the attached volume.
format: uuid
type: string
required:
- device
- id
- serverId
- volumeId
type: object
required:
- volumeAttachment
type: object
ServersOs_Volume_AttachmentsCreate_20:
additionalProperties: false
properties:
volumeAttachment:
additionalProperties: false
description: |-
A dictionary representation of a volume attachment containing the fields
`device` and `volumeId`.
properties:
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.
pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$
type:
- 'null'
- string
volumeId:
description: |-
The UUID of the volume to attach.
format: uuid
type: string
required:
- volumeId
type: object
required:
- volumeAttachment
type: object
x-openstack:
max-ver: '2.48'
min-ver: '2.0'
ServersOs_Volume_AttachmentsCreate_249:
additionalProperties: false
properties:
volumeAttachment:
additionalProperties: false
description: |-
A dictionary representation of a volume attachment containing the fields
`device` and `volumeId`.
properties:
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.
pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$
type:
- 'null'
- string
tag:
description: |-
A device role tag that can be applied to a volume when attaching it to the
VM. 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
Tagged volume attachment is not supported for shelved-offloaded
instances.
**New in version 2.49**
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
volumeId:
description: |-
The UUID of the volume to attach.
format: uuid
type: string
required:
- volumeId
type: object
required:
- volumeAttachment
type: object
x-openstack:
max-ver: '2.78'
min-ver: '2.49'
ServersOs_Volume_AttachmentsCreate_279:
additionalProperties: false
properties:
volumeAttachment:
additionalProperties: false
description: |-
A dictionary representation of a volume attachment containing the fields
`device` and `volumeId`.
properties:
delete_on_termination:
description: |-
To delete the attached volume when the server is destroyed, specify `true`.
Otherwise, specify `false`. Default: `false`
**New in version 2.79**
enum:
- '0'
- '1'
- 'FALSE'
- false
- 'False'
- NO
- No
- OFF
- ON
- Off
- On
- 'TRUE'
- true
- 'True'
- YES
- Yes
- 'false'
- no
- off
- on
- 'true'
- yes
type:
- boolean
- 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.
pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$
type:
- 'null'
- string
tag:
description: |-
A device role tag that can be applied to a volume when attaching it to the
VM. 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
Tagged volume attachment is not supported for shelved-offloaded
instances.
**New in version 2.49**
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
volumeId:
description: |-
The UUID of the volume to attach.
format: uuid
type: string
required:
- volumeId
type: object
required:
- volumeAttachment
type: object
x-openstack:
max-ver: '2.48'
min-ver: '2.79'
ServersOs_Volume_AttachmentsListResponse:
properties:
volumeAttachments:
description: |-
The list of volume attachments.
items:
description: |-
A dictionary representation of a volume attachment containing the fields
`device`, `id`, `serverId` and `volumeId`.
properties:
attachment_id:
description: |-
The UUID of the associated volume attachment in Cinder.
**New in version 2.89**
format: uuid
type: string
x-openstack:
min-ver: '2.89'
bdm_uuid:
description: |-
The UUID of the block device mapping record in Nova for the attachment.
**New in version 2.89**
format: uuid
type: string
x-openstack:
min-ver: '2.89'
delete_on_termination:
description: |-
A flag indicating if the attached volume will be deleted when the server is
deleted.
**New in version 2.79**
type: boolean
x-openstack:
min-ver: '2.79'
device:
description: |-
Name of the device in the attachment object, such as, `/dev/vdb`.
type: string
id:
description: |-
The volume ID of the attachment.
**Available until version 2.88**
format: uuid
type: string
x-openstack:
max-ver: '2.88'
serverId:
description: |-
The UUID of the server.
format: uuid
type: string
tag:
description: |-
The device tag applied to the volume block device or `null`.
**New in version 2.70**
type:
- 'null'
- string
x-openstack:
min-ver: '2.70'
volumeId:
description: |-
The UUID of the attached volume.
format: uuid
type: string
required:
- device
- id
- serverId
- volumeId
type: object
type: array
required:
- volumeAttachments
type: object
ServersRemote_ConsolesCreateRequest:
oneOf:
- $ref: '#/components/schemas/ServersRemote_ConsolesCreate_26'
- $ref: '#/components/schemas/ServersRemote_ConsolesCreate_28'
- $ref: '#/components/schemas/ServersRemote_ConsolesCreate_299'
x-openstack:
discriminator: microversion
ServersRemote_ConsolesCreateResponse:
description: Create Console Response
properties:
remote_console:
description: |-
The remote console object.
properties:
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`. The protocol `rdp` requires the Hyper-V driver
which was removed in the 29.0.0 (Caracal) release.
enum:
- mks
- rdp
- serial
- spice
- vnc
type: string
type:
description: |-
The type of remote console. The valid values are `novnc`,
`rdp-html5`, `spice-html5`, `spice-direct`, `serial`, and
`webmks`. The type `webmks` was added in Microversion `2.8` and the
type `spice-direct` was added in Microversion `2.99`. The type
`rdp-html5` requires the Hyper-V driver which was removed in the 29.0.0
(Caracal) release.
enum:
- novnc
- rdp-html5
- serial
- spice-html5
- webmks
- xvpvnc
type: string
url:
description: |-
The URL is used to connect the console.
format: uri
type: string
required:
- protocol
- type
- url
type: object
required:
- remote_console
type: object
ServersRemote_ConsolesCreate_26:
additionalProperties: false
properties:
remote_console:
additionalProperties: false
description: |-
The remote console object.
properties:
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`. The protocol `rdp` requires the Hyper-V driver
which was removed in the 29.0.0 (Caracal) release.
enum:
- rdp
- serial
- spice
- vnc
type: string
type:
description: |-
The type of remote console. The valid values are `novnc`,
`rdp-html5`, `spice-html5`, `spice-direct`, `serial`, and
`webmks`. The type `webmks` was added in Microversion `2.8` and the
type `spice-direct` was added in Microversion `2.99`. The type
`rdp-html5` requires the Hyper-V driver which was removed in the 29.0.0
(Caracal) release.
enum:
- novnc
- rdp-html5
- serial
- spice-html5
- xvpvnc
type: string
required:
- protocol
- type
type: object
required:
- remote_console
type: object
x-openstack:
max-ver: '2.7'
min-ver: '2.6'
ServersRemote_ConsolesCreate_28:
additionalProperties: false
properties:
remote_console:
additionalProperties: false
description: |-
The remote console object.
properties:
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`. The protocol `rdp` requires the Hyper-V driver
which was removed in the 29.0.0 (Caracal) release.
enum:
- mks
- rdp
- serial
- spice
- vnc
type: string
type:
description: |-
The type of remote console. The valid values are `novnc`,
`rdp-html5`, `spice-html5`, `spice-direct`, `serial`, and
`webmks`. The type `webmks` was added in Microversion `2.8` and the
type `spice-direct` was added in Microversion `2.99`. The type
`rdp-html5` requires the Hyper-V driver which was removed in the 29.0.0
(Caracal) release.
enum:
- novnc
- rdp-html5
- serial
- spice-html5
- webmks
- xvpvnc
type: string
required:
- protocol
- type
type: object
required:
- remote_console
type: object
x-openstack:
max-ver: '2.98'
min-ver: '2.8'
ServersRemote_ConsolesCreate_299:
additionalProperties: false
properties:
remote_console:
additionalProperties: false
description: |-
The remote console object.
properties:
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`. The protocol `rdp` requires the Hyper-V driver
which was removed in the 29.0.0 (Caracal) release.
enum:
- mks
- rdp
- serial
- spice
- vnc
type: string
type:
description: |-
The type of remote console. The valid values are `novnc`,
`rdp-html5`, `spice-html5`, `spice-direct`, `serial`, and
`webmks`. The type `webmks` was added in Microversion `2.8` and the
type `spice-direct` was added in Microversion `2.99`. The type
`rdp-html5` requires the Hyper-V driver which was removed in the 29.0.0
(Caracal) release.
enum:
- novnc
- rdp-html5
- serial
- spice-direct
- spice-html5
- webmks
- xvpvnc
type: string
required:
- protocol
- type
type: object
required:
- remote_console
type: object
x-openstack:
max-ver: '2.7'
min-ver: '2.99'
ServersShareShowResponse:
additionalProperties: false
properties:
share:
additionalProperties: false
description: |-
A dictionary representation of a share attachment containing the fields
`uuid`, `serverId`, `status`, `tag` and `export_location`.
properties:
export_location:
description: |-
The export location used to attach the share to the underlying host.
type: string
share_id:
description: |-
The UUID of the attached share.
format: uuid
type: string
status:
description: |-
Status of the Share:
* attaching: The share is being attached to the VM by the compute node.
* detaching: The share is being detached from the VM by the compute node.
* inactive: The share is attached but inactive because the VM is stopped.
* active: The share is attached, and the VM is running.
* error: The share is in an error state.
enum:
- active
- attaching
- detaching
- error
- inactive
type: string
tag:
description: |-
The device tag to be used by users to mount the share within the instance,
if not provided then the share UUID will be used automatically.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
uuid:
description: |-
The UUID of the attached share.
format: uuid
type: string
required:
- share_id
- status
- tag
type: object
required:
- share
title: Server share
type: object
ServersSharesCreateResponse:
additionalProperties: false
properties:
share:
additionalProperties: false
description: |-
A dictionary representation of a share attachment containing the fields
`uuid`, `serverId`, `status`, `tag` and `export_location`.
properties:
export_location:
description: |-
The export location used to attach the share to the underlying host.
type: string
share_id:
description: |-
The UUID of the attached share.
format: uuid
type: string
status:
description: |-
Status of the Share:
* attaching: The share is being attached to the VM by the compute node.
* detaching: The share is being detached from the VM by the compute node.
* inactive: The share is attached but inactive because the VM is stopped.
* active: The share is attached, and the VM is running.
* error: The share is in an error state.
enum:
- active
- attaching
- detaching
- error
- inactive
type: string
tag:
description: |-
The device tag to be used by users to mount the share within the instance,
if not provided then the share UUID will be used automatically.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
uuid:
description: |-
The UUID of the attached share.
format: uuid
type: string
required:
- share_id
- status
- tag
type: object
required:
- share
title: Server share
type: object
ServersSharesCreate_297:
additionalProperties: false
properties:
share:
additionalProperties: false
properties:
share_id:
description: |-
The UUID of the attached share.
format: uuid
type: string
tag:
description: |-
The device tag to be used by users to mount the share within the instance,
if not provided then the share UUID will be used automatically.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
required:
- share_id
type: object
required:
- share
title: Server shares
type: object
x-openstack:
min-ver: '2.97'
ServersSharesListResponse:
additionalProperties: false
properties:
shares:
description: |-
The list of share attachments.
items:
additionalProperties: false
description: |-
A dictionary representation of a share attachment containing the fields
`uuid`, `serverId`, `status`, `tag` and `export_location`.
properties:
export_location:
description: |-
The export location used to attach the share to the underlying host.
type: string
share_id:
description: |-
The UUID of the attached share.
format: uuid
type: string
status:
description: |-
Status of the Share:
* attaching: The share is being attached to the VM by the compute node.
* detaching: The share is being detached from the VM by the compute node.
* inactive: The share is attached but inactive because the VM is stopped.
* active: The share is attached, and the VM is running.
* error: The share is in an error state.
enum:
- active
- attaching
- detaching
- error
- inactive
type: string
tag:
description: |-
The device tag to be used by users to mount the share within the instance,
if not provided then the share UUID will be used automatically.
maxLength: 255
minLength: 1
pattern: ^[a-zA-Z0-9-]*$
type: string
uuid:
description: |-
The UUID of the attached share.
format: uuid
type: string
required:
- share_id
- status
- tag
type: object
type: array
required:
- shares
title: Server shares
type: object
ServersTagShowResponse:
description: Response of the servers/server_id/tags/id:get operation
type: object
ServersTagsListResponse:
description: Server Tags
properties:
tags:
description: |-
A list of tags. The maximum count of tags in this list is 50.
items:
type: string
type: array
type: object
ServersTagsUpdate_AllResponse:
description: Server Tags
properties:
tags:
description: |-
A list of tags. The maximum count of tags in this list is 50.
items:
type: string
type: array
type: object
ServersTagsUpdate_All_226:
additionalProperties: false
properties:
tags:
description: |-
A list of tags. The maximum count of tags in this list is 50.
items:
maxLength: 60
minLength: 1
pattern: ^[^,/]*$
type: string
maxItems: 50
type: array
required:
- tags
title: Server tags
type: object
x-openstack:
min-ver: '2.26'
ServersTopologyListResponse:
description: NUMA topology information for a server
properties:
nodes:
description: |-
NUMA nodes information of a server.
items:
description: NUMA node information of a server
properties:
cpu_pinning:
additionalProperties:
type: integer
description: The mapping of server cores to host physical CPU
type: object
host_node:
description: The host NUMA node the virtual NUMA node is map to.
type: integer
memory_mb:
description: The amount of memory assigned to this NUMA node in
MB.
type: integer
pagesize_kb:
description: |-
The page size in KB of a server. This field is `null` if the
page size information is not available.
type:
- integer
- 'null'
siblings:
description: A mapping of host cpus thread sibling.
items:
type: integer
type: array
vcpu_set:
description: A list of IDs of the virtual CPU assigned to this
NUMA node.
items:
type: integer
type: array
type: object
type: array
type: object
VersionShowResponse:
additionalProperties: false
properties:
version:
additionalProperties: false
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.
properties:
id:
description: |-
A common name for the version in question. Informative only, it has no real semantic meaning.
type: string
links:
description: |-
Links to the resources in question. See [API Guide / Links and
References](https://docs.openstack.org/api-guide/compute/links_and_references.html)
for more info.
items:
additionalProperties: false
properties:
href:
type: string
rel:
type: string
type:
type: string
required:
- href
- rel
type: object
type: array
media-types:
items:
additionalProperties: false
properties:
base:
type: string
type:
type: string
required:
- base
- type
type: object
type: array
min_version:
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.
type: string
status:
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
enum:
- CURRENT
- DEPRECATED
- SUPPORTED
type: string
updated:
description: |-
This is a fixed string. It is `2011-01-21T11:33:21Z` in version 2.0,
`2013-07-23T11:33:21Z` in version 2.1.
Note
It is vestigial and provides no useful information.
It will be deprecated and removed in the future.
format: date-time
type: string
version:
type: string
required:
- id
- links
- min_version
- status
- updated
type: object
required:
- version
type: object
securitySchemes:
ApiKeyAuth:
in: header
name: X-Auth-Token
type: apiKey
security:
- ApiKeyAuth: []
tags:
- name: extensions
- description: |-
Show and manage server flavors.
name: flavors
- name: images
- name: limits
- name: os-agents
- name: os-aggregates
- name: os-assisted-volume-snapshots
- name: os-availability-zone
- name: os-baremetal-nodes
- name: os-cells
- name: os-certificates
- name: os-cloudpipe
- name: os-fixed-ips
- name: os-floating-ip-dns
- name: os-floating-ip-pools
- name: os-floating-ips
- name: os-floating-ips-bulk
- name: os-fping
- name: os-hosts
- name: os-hypervisors
- name: os-instance_usage_audit_log
- name: os-keypairs
- name: os-migrations
- name: os-networks
- name: os-security-group-default-rules
- name: os-security-group-rules
- name: os-security-groups
- name: os-server-external-events
- name: os-server-groups
- name: os-services
- name: os-simple-tenant-usage
- name: os-snapshots
- name: os-tenant-networks
- name: os-volumes
- name: os-volumes_boot
- description: |-
Show, Create or Update the quotas for a Quota Class.
Nova supports implicit ‘default’ Quota Class only.
name: quota-class-sets-os-quota-class-sets
- description: |-
Permits administrators, depending on policy settings, to view default
quotas, view details for quotas, revert quotas to defaults, and update
the quotas for a project or a project and user.
name: quota-sets-os-quota-sets
- description: |-
Manage server consoles.
name: server-consoles
- name: server-migrations
- name: server-tags
- name: servers
- name: version