diff --git a/cli-cmd/identity/src/v4/federation/identity_provider/create.rs b/cli-cmd/identity/src/v4/federation/identity_provider/create.rs index e02c78308..a46c67510 100644 --- a/cli-cmd/identity/src/v4/federation/identity_provider/create.rs +++ b/cli-cmd/identity/src/v4/federation/identity_provider/create.rs @@ -20,7 +20,7 @@ //! Wraps invoking of the `v4/federation/identity_providers` with `POST` method use clap::Args; -use eyre::{OptionExt, WrapErr}; +use eyre::WrapErr; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/cli-cmd/identity/src/v4/federation/identity_provider/delete.rs b/cli-cmd/identity/src/v4/federation/identity_provider/delete.rs index 569e483ac..2d2d571b6 100644 --- a/cli-cmd/identity/src/v4/federation/identity_provider/delete.rs +++ b/cli-cmd/identity/src/v4/federation/identity_provider/delete.rs @@ -20,7 +20,6 @@ //! Wraps invoking of the `v4/federation/identity_providers/{idp_id}` with `DELETE` method use clap::Args; -use eyre::{OptionExt, WrapErr}; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/cli-cmd/identity/src/v4/federation/identity_provider/list.rs b/cli-cmd/identity/src/v4/federation/identity_provider/list.rs index 9283f9c7f..df078c189 100644 --- a/cli-cmd/identity/src/v4/federation/identity_provider/list.rs +++ b/cli-cmd/identity/src/v4/federation/identity_provider/list.rs @@ -20,7 +20,6 @@ //! Wraps invoking of the `v4/federation/identity_providers` with `GET` method use clap::Args; -use eyre::{OptionExt, WrapErr}; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/cli-cmd/identity/src/v4/federation/identity_provider/set.rs b/cli-cmd/identity/src/v4/federation/identity_provider/set.rs index 491306536..9a3fb74b4 100644 --- a/cli-cmd/identity/src/v4/federation/identity_provider/set.rs +++ b/cli-cmd/identity/src/v4/federation/identity_provider/set.rs @@ -20,7 +20,7 @@ //! Wraps invoking of the `v4/federation/identity_providers/{idp_id}` with `PUT` method use clap::Args; -use eyre::{OptionExt, WrapErr}; +use eyre::WrapErr; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/cli-cmd/identity/src/v4/federation/identity_provider/show.rs b/cli-cmd/identity/src/v4/federation/identity_provider/show.rs index be3e5d28e..6a5bb7740 100644 --- a/cli-cmd/identity/src/v4/federation/identity_provider/show.rs +++ b/cli-cmd/identity/src/v4/federation/identity_provider/show.rs @@ -20,7 +20,6 @@ //! Wraps invoking of the `v4/federation/identity_providers/{idp_id}` with `GET` method use clap::Args; -use eyre::{OptionExt, WrapErr}; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/cli-cmd/identity/src/v4/federation/mapping/create.rs b/cli-cmd/identity/src/v4/federation/mapping/create.rs index 41b3c66ec..83b31441b 100644 --- a/cli-cmd/identity/src/v4/federation/mapping/create.rs +++ b/cli-cmd/identity/src/v4/federation/mapping/create.rs @@ -20,7 +20,7 @@ //! Wraps invoking of the `v4/federation/mappings` with `POST` method use clap::Args; -use eyre::{OptionExt, WrapErr}; +use eyre::WrapErr; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/cli-cmd/identity/src/v4/federation/mapping/delete.rs b/cli-cmd/identity/src/v4/federation/mapping/delete.rs index 1760744bf..5026422b8 100644 --- a/cli-cmd/identity/src/v4/federation/mapping/delete.rs +++ b/cli-cmd/identity/src/v4/federation/mapping/delete.rs @@ -20,7 +20,6 @@ //! Wraps invoking of the `v4/federation/mappings/{id}` with `DELETE` method use clap::Args; -use eyre::{OptionExt, WrapErr}; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/cli-cmd/identity/src/v4/federation/mapping/list.rs b/cli-cmd/identity/src/v4/federation/mapping/list.rs index e968cea62..977e7269a 100644 --- a/cli-cmd/identity/src/v4/federation/mapping/list.rs +++ b/cli-cmd/identity/src/v4/federation/mapping/list.rs @@ -20,7 +20,6 @@ //! Wraps invoking of the `v4/federation/mappings` with `GET` method use clap::Args; -use eyre::{OptionExt, WrapErr}; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/cli-cmd/identity/src/v4/federation/mapping/set.rs b/cli-cmd/identity/src/v4/federation/mapping/set.rs index 36e65cfda..3d273e617 100644 --- a/cli-cmd/identity/src/v4/federation/mapping/set.rs +++ b/cli-cmd/identity/src/v4/federation/mapping/set.rs @@ -20,7 +20,7 @@ //! Wraps invoking of the `v4/federation/mappings/{id}` with `PUT` method use clap::Args; -use eyre::{OptionExt, WrapErr}; +use eyre::WrapErr; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/cli-cmd/identity/src/v4/federation/mapping/show.rs b/cli-cmd/identity/src/v4/federation/mapping/show.rs index 8789818b7..f19e9b9f6 100644 --- a/cli-cmd/identity/src/v4/federation/mapping/show.rs +++ b/cli-cmd/identity/src/v4/federation/mapping/show.rs @@ -20,7 +20,6 @@ //! Wraps invoking of the `v4/federation/mappings/{id}` with `GET` method use clap::Args; -use eyre::{OptionExt, WrapErr}; use tracing::info; use openstack_cli_core::cli::CliArgs; diff --git a/openstack_types/data/block-storage/v3.71.yaml b/openstack_types/data/block-storage/v3.71.yaml index d85c1ee50..a0001ae60 100644 --- a/openstack_types/data/block-storage/v3.71.yaml +++ b/openstack_types/data/block-storage/v3.71.yaml @@ -10220,7 +10220,6 @@ components: - attachment type: object x-openstack: - max-ver: '3.53' min-ver: '3.54' AttachmentsDetailResponse: properties: @@ -10605,7 +10604,6 @@ components: - backup type: object x-openstack: - max-ver: '3.42' min-ver: '3.43' BackupUpdate_39: additionalProperties: false diff --git a/openstack_types/data/block-storage/v3.yaml b/openstack_types/data/block-storage/v3.yaml index d85c1ee50..a0001ae60 100644 --- a/openstack_types/data/block-storage/v3.yaml +++ b/openstack_types/data/block-storage/v3.yaml @@ -10220,7 +10220,6 @@ components: - attachment type: object x-openstack: - max-ver: '3.53' min-ver: '3.54' AttachmentsDetailResponse: properties: @@ -10605,7 +10604,6 @@ components: - backup type: object x-openstack: - max-ver: '3.42' min-ver: '3.43' BackupUpdate_39: additionalProperties: false diff --git a/openstack_types/data/compute/v2.103.yaml b/openstack_types/data/compute/v2.103.yaml index 7d3afbd61..d00a14489 100644 --- a/openstack_types/data/compute/v2.103.yaml +++ b/openstack_types/data/compute/v2.103.yaml @@ -24,8 +24,6 @@ paths: schema: $ref: '#/components/schemas/RootShowResponse' description: Ok - '404': - description: Error summary: List All Major Versions tags: - version @@ -43,7 +41,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExtensionsListResponse' + $ref: '#/components/schemas/ExtensionsIndexResponse' description: Ok summary: List Extensions tags: @@ -64,8 +62,6 @@ paths: schema: $ref: '#/components/schemas/ExtensionShowResponse' description: Ok - '404': - description: Error summary: Show Extension Details tags: - extensions @@ -94,10 +90,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsListResponse' + oneOf: + - $ref: '#/components/schemas/FlavorsIndexResponse_20' + - $ref: '#/components/schemas/FlavorsIndexResponse_255' description: Ok - '400': - description: Error summary: List Flavors tags: - flavors @@ -123,7 +119,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsCreateResponse' + oneOf: + - $ref: '#/components/schemas/FlavorsCreateResponse_20' + - $ref: '#/components/schemas/FlavorsCreateResponse_2102' + - $ref: '#/components/schemas/FlavorsCreateResponse_255' + - $ref: '#/components/schemas/FlavorsCreateResponse_261' + - $ref: '#/components/schemas/FlavorsCreateResponse_275' description: Ok '400': description: Error @@ -155,10 +156,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsDetailResponse' + oneOf: + - $ref: '#/components/schemas/FlavorsDetailDetailResponse_20' + - $ref: '#/components/schemas/FlavorsDetailDetailResponse_2102' + - $ref: '#/components/schemas/FlavorsDetailDetailResponse_255' + - $ref: '#/components/schemas/FlavorsDetailDetailResponse_261' description: Ok - '400': - description: Error summary: List Flavors With Details tags: - flavors @@ -176,10 +179,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsOs_Extra_SpecsListResponse' + $ref: '#/components/schemas/FlavorsOs_Extra_SpecsIndexResponse' description: Ok - '404': - description: Error summary: List Extra Specs For A Flavor tags: - flavors @@ -227,8 +228,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete An Extra Spec For A Flavor tags: - flavors @@ -247,8 +246,6 @@ paths: schema: $ref: '#/components/schemas/FlavorsOs_Extra_SpecShowResponse' description: Ok - '404': - description: Error summary: Show An Extra Spec For A Flavor tags: - flavors @@ -299,10 +296,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsOs_Flavor_AccessListResponse' + $ref: '#/components/schemas/FlavorsOs_Flavor_AccessIndexResponse' description: Ok - '404': - description: Error summary: List Flavor Access Information For Given Flavor tags: - flavors @@ -324,8 +319,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete Flavor tags: - flavors @@ -342,10 +335,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorShowResponse' + oneOf: + - $ref: '#/components/schemas/FlavorShowResponse_20' + - $ref: '#/components/schemas/FlavorShowResponse_2102' + - $ref: '#/components/schemas/FlavorShowResponse_255' + - $ref: '#/components/schemas/FlavorShowResponse_261' + - $ref: '#/components/schemas/FlavorShowResponse_275' description: Ok - '404': - description: Error summary: Show Flavor Details tags: - flavors @@ -375,7 +371,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorUpdateResponse' + oneOf: + - $ref: '#/components/schemas/FlavorUpdateResponse_2102' + - $ref: '#/components/schemas/FlavorUpdateResponse_255' + - $ref: '#/components/schemas/FlavorUpdateResponse_261' + - $ref: '#/components/schemas/FlavorUpdateResponse_275' description: Ok '400': description: Error @@ -406,8 +406,8 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/FlavorsActionAddtenantaccessResponse' - - $ref: '#/components/schemas/FlavorsActionRemovetenantaccessResponse' + - $ref: '#/components/schemas/FlavorsAction_Add_Tenant_AccessResponse' + - $ref: '#/components/schemas/FlavorsAction_Remove_Tenant_AccessResponse' description: Ok '400': description: Error @@ -446,10 +446,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesListResponse' + $ref: '#/components/schemas/ImagesIndexResponse_21' description: Ok - '400': - description: Error summary: List Images tags: - images @@ -483,10 +481,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesDetailResponse' + $ref: '#/components/schemas/ImagesDetailDetailResponse_21' description: Ok - '400': - description: Error summary: List Images With Details tags: - images @@ -530,10 +526,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImageShowResponse' + $ref: '#/components/schemas/ImageShowResponse_21' description: Ok - '404': - description: Error summary: Show Image Details tags: - images @@ -557,7 +551,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataListResponse' + $ref: '#/components/schemas/ImagesMetadataIndexResponse_21' description: Ok '403': description: Error @@ -591,7 +585,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataCreateResponse' + $ref: '#/components/schemas/ImagesMetadataCreateResponse_21' description: Ok '400': description: Error @@ -625,7 +619,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataUpdate_AllResponse' + $ref: '#/components/schemas/ImagesMetadataUpdate_AllResponse_21' description: Ok '400': description: Error @@ -676,7 +670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataShowResponse' + $ref: '#/components/schemas/ImagesMetadataShowResponse_21' description: Ok '403': description: Error @@ -710,7 +704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataUpdateResponse' + $ref: '#/components/schemas/ImagesMetadataUpdateResponse_21' description: Ok '400': description: Error @@ -740,14 +734,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LimitsListResponse' + oneOf: + - $ref: '#/components/schemas/LimitsIndexResponse_21' + - $ref: '#/components/schemas/LimitsIndexResponse_236' + - $ref: '#/components/schemas/LimitsIndexResponse_239' + - $ref: '#/components/schemas/LimitsIndexResponse_257' description: Ok summary: Show Rate And Absolute Limits tags: - limits /v2.1/os-agents: get: - deprecated: true description: |- Lists agent builds. @@ -757,18 +754,11 @@ paths: 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. @@ -779,19 +769,12 @@ paths: 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. @@ -803,15 +786,12 @@ paths: 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. @@ -822,13 +802,7 @@ paths: 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 @@ -846,7 +820,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_AggregatesListResponse' + oneOf: + - $ref: '#/components/schemas/Os_AggregatesIndexResponse_21' + - $ref: '#/components/schemas/Os_AggregatesIndexResponse_241' description: Ok summary: List Aggregates tags: @@ -870,7 +846,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_AggregatesCreateResponse' + oneOf: + - $ref: '#/components/schemas/Os_AggregatesCreateResponse_21' + - $ref: '#/components/schemas/Os_AggregatesCreateResponse_241' description: Ok '400': description: Error @@ -911,7 +889,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_AggregateShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_AggregateShowResponse_21' + - $ref: '#/components/schemas/Os_AggregateShowResponse_241' description: Ok '400': description: Error @@ -943,7 +923,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_AggregateUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_AggregateUpdateResponse_21' + - $ref: '#/components/schemas/Os_AggregateUpdateResponse_241' description: Ok '400': description: Error @@ -975,9 +957,12 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/Os_AggregatesActionAdd_HostResponse' - - $ref: '#/components/schemas/Os_AggregatesActionRemove_HostResponse' - - $ref: '#/components/schemas/Os_AggregatesActionSet_MetadataResponse' + - $ref: '#/components/schemas/Os_AggregatesAction_Add_HostResponse_21' + - $ref: '#/components/schemas/Os_AggregatesAction_Add_HostResponse_241' + - $ref: '#/components/schemas/Os_AggregatesAction_Remove_HostResponse_21' + - $ref: '#/components/schemas/Os_AggregatesAction_Remove_HostResponse_241' + - $ref: '#/components/schemas/Os_AggregatesAction_Set_MetadataResponse_21' + - $ref: '#/components/schemas/Os_AggregatesAction_Set_MetadataResponse_241' description: Ok '400': description: Error @@ -1008,10 +993,6 @@ paths: $ref: '#/components/schemas/Os_AggregatesImagesImages_281' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_AggregatesImagesResponse' description: Ok '400': description: Error @@ -1043,8 +1024,6 @@ paths: schema: $ref: '#/components/schemas/Os_Assisted_Volume_SnapshotsCreateResponse' description: Ok - '400': - description: Error summary: Create Assisted Volume Snapshots tags: - os-assisted-volume-snapshots @@ -1090,7 +1069,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Availability_ZoneListResponse' + $ref: '#/components/schemas/Os_Availability_ZoneIndexResponse' description: Ok summary: Get Availability Zone Information tags: @@ -1111,7 +1090,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Availability_ZoneDetailResponse' + $ref: '#/components/schemas/Os_Availability_ZoneDetailDetailResponse' description: Ok summary: Get Detailed Availability Zone Information tags: @@ -1132,7 +1111,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Baremetal_NodesListResponse' + $ref: '#/components/schemas/Os_Baremetal_NodesIndexResponse_21' description: Ok '404': description: Error @@ -1149,13 +1128,7 @@ paths: 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: @@ -1168,8 +1141,6 @@ paths: responses: '204': description: Ok - '400': - description: Error tags: - os-baremetal-nodes x-openstack: @@ -1190,7 +1161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Baremetal_NodeShowResponse' + $ref: '#/components/schemas/Os_Baremetal_NodeShowResponse_21' description: Ok '404': description: Error @@ -1220,20 +1191,11 @@ paths: 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. @@ -1244,18 +1206,11 @@ paths: 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. @@ -1266,19 +1221,12 @@ paths: 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. @@ -1289,19 +1237,12 @@ paths: 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. @@ -1312,19 +1253,12 @@ paths: 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. @@ -1335,34 +1269,20 @@ paths: 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. @@ -1374,13 +1294,10 @@ paths: responses: '204': description: Ok - '410': - description: Error summary: Delete a Cell tags: - os-cells get: - deprecated: true description: |- Shows data for a cell. @@ -1391,20 +1308,13 @@ paths: 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. @@ -1415,19 +1325,12 @@ paths: 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. @@ -1438,13 +1341,7 @@ paths: 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 @@ -1452,7 +1349,6 @@ paths: - $ref: '#/components/parameters/os_cells_capacities_id' /v2.1/os-certificates: post: - deprecated: true description: |- Creates a root certificate. @@ -1462,38 +1358,24 @@ paths: 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. @@ -1503,18 +1385,11 @@ paths: 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. @@ -1524,13 +1399,7 @@ paths: 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 @@ -1538,19 +1407,12 @@ paths: 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}: @@ -1574,10 +1436,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Console_Auth_TokenShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Console_Auth_TokenShowResponse_21' + - $ref: '#/components/schemas/Os_Console_Auth_TokenShowResponse_299' description: Ok '400': description: Error + '401': + description: Error '404': description: Error summary: Show Console Connection Information @@ -1590,7 +1456,6 @@ paths: - $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. @@ -1601,13 +1466,7 @@ paths: 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 @@ -1629,20 +1488,11 @@ paths: 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. @@ -1653,19 +1503,12 @@ paths: 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. @@ -1677,13 +1520,10 @@ paths: 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. @@ -1694,13 +1534,7 @@ paths: 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 @@ -1708,7 +1542,6 @@ paths: - $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. @@ -1719,19 +1552,12 @@ paths: 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. @@ -1743,15 +1569,12 @@ paths: 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. @@ -1762,13 +1585,7 @@ paths: 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 @@ -1792,7 +1609,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Floating_Ip_PoolsListResponse' + $ref: '#/components/schemas/Os_Floating_Ip_PoolsIndexResponse_21' description: Ok summary: List Floating Ip Pools tags: @@ -1819,7 +1636,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Floating_IpsListResponse' + $ref: '#/components/schemas/Os_Floating_IpsIndexResponse_21' description: Ok summary: List Floating Ip Addresses tags: @@ -1850,7 +1667,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Floating_IpsCreateResponse' + $ref: '#/components/schemas/Os_Floating_IpsCreateResponse_21' description: Ok '400': description: Error @@ -1866,7 +1683,6 @@ paths: min-ver: '2.1' /v2.1/os-floating-ips-bulk: get: - deprecated: true description: |- Lists all floating IPs. @@ -1877,18 +1693,11 @@ paths: 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. @@ -1899,19 +1708,12 @@ paths: 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. @@ -1922,30 +1724,17 @@ paths: 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}: @@ -2003,7 +1792,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Floating_IpShowResponse' + $ref: '#/components/schemas/Os_Floating_IpShowResponse_21' description: Ok '400': description: Error @@ -2019,7 +1808,6 @@ paths: - $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. @@ -2038,19 +1826,12 @@ paths: 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. @@ -2065,13 +1846,7 @@ paths: 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 @@ -2094,7 +1869,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostsListResponse' + $ref: '#/components/schemas/Os_HostsIndexResponse_21' description: Ok summary: List Hosts tags: @@ -2117,10 +1892,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostShowResponse' + $ref: '#/components/schemas/Os_HostShowResponse_21' description: Ok - '404': - description: Error summary: Show Host Details tags: - os-hosts @@ -2149,7 +1922,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostUpdateResponse' + $ref: '#/components/schemas/Os_HostUpdateResponse_21' description: Ok '400': description: Error @@ -2179,7 +1952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostsRebootResponse' + $ref: '#/components/schemas/Os_HostsRebootRebootResponse_21' description: Ok '400': description: Error @@ -2211,7 +1984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostsShutdownResponse' + $ref: '#/components/schemas/Os_HostsShutdownShutdownResponse_21' description: Ok '400': description: Error @@ -2243,7 +2016,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostsStartupResponse' + $ref: '#/components/schemas/Os_HostsStartupStartupResponse_21' description: Ok '400': description: Error @@ -2283,7 +2056,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsListResponse' + oneOf: + - $ref: '#/components/schemas/Os_HypervisorsIndexResponse_21' + - $ref: '#/components/schemas/Os_HypervisorsIndexResponse_233' + - $ref: '#/components/schemas/Os_HypervisorsIndexResponse_253' description: Ok '400': description: Error @@ -2319,7 +2095,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsDetailResponse' + oneOf: + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_21' + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_228' + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_233' + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_253' + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_288' description: Ok '400': description: Error @@ -2350,7 +2131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsStatisticsResponse' + $ref: '#/components/schemas/Os_HypervisorsStatisticsStatisticsResponse_21' description: Ok summary: Show Hypervisor Statistics (DEPRECATED) tags: @@ -2379,7 +2160,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_HypervisorShowResponse_21' + - $ref: '#/components/schemas/Os_HypervisorShowResponse_228' + - $ref: '#/components/schemas/Os_HypervisorShowResponse_253' + - $ref: '#/components/schemas/Os_HypervisorShowResponse_288' description: Ok '400': description: Error @@ -2412,10 +2197,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsSearchResponse' + $ref: '#/components/schemas/Os_HypervisorsSearchSearchResponse_21' description: Ok - '404': - description: Error summary: Search Hypervisor (DEPRECATED) tags: - os-hypervisors @@ -2444,10 +2227,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsServersResponse' + $ref: '#/components/schemas/Os_HypervisorsServersServersResponse_21' description: Ok - '404': - description: Error summary: List Hypervisor Servers (DEPRECATED) tags: - os-hypervisors @@ -2475,7 +2256,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsUptimeResponse' + oneOf: + - $ref: '#/components/schemas/Os_HypervisorsUptimeUptimeResponse_21' + - $ref: '#/components/schemas/Os_HypervisorsUptimeUptimeResponse_253' description: Ok '400': description: Error @@ -2506,7 +2289,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Instance_Usage_Audit_LogListResponse' + $ref: '#/components/schemas/Os_Instance_Usage_Audit_LogIndexResponse' description: Ok summary: List Server Usage Audits tags: @@ -2527,8 +2310,6 @@ paths: 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 @@ -2553,10 +2334,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_KeypairsListResponse' + oneOf: + - $ref: '#/components/schemas/Os_KeypairsIndexResponse_20' + - $ref: '#/components/schemas/Os_KeypairsIndexResponse_22' + - $ref: '#/components/schemas/Os_KeypairsIndexResponse_235' description: Ok - '400': - description: Error summary: List Keypairs tags: - os-keypairs @@ -2581,7 +2363,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_KeypairsCreateResponse' + oneOf: + - $ref: '#/components/schemas/Os_KeypairsCreateResponse_20' + - $ref: '#/components/schemas/Os_KeypairsCreateResponse_22' + - $ref: '#/components/schemas/Os_KeypairsCreateResponse_292' description: Ok '400': description: Error @@ -2607,8 +2392,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete Keypair tags: - os-keypairs @@ -2631,10 +2414,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_KeypairShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_KeypairShowResponse_20' + - $ref: '#/components/schemas/Os_KeypairShowResponse_22' description: Ok - '404': - description: Error summary: Show Keypair Details tags: - os-keypairs @@ -2678,10 +2461,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_MigrationsListResponse' + oneOf: + - $ref: '#/components/schemas/Os_MigrationsIndexResponse_20' + - $ref: '#/components/schemas/Os_MigrationsIndexResponse_223' + - $ref: '#/components/schemas/Os_MigrationsIndexResponse_259' + - $ref: '#/components/schemas/Os_MigrationsIndexResponse_280' description: Ok - '400': - description: Error summary: List Migrations tags: - os-migrations @@ -2706,7 +2491,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_NetworksListResponse' + $ref: '#/components/schemas/Os_NetworksIndexResponse_21' description: Ok summary: List Networks tags: @@ -2715,7 +2500,6 @@ paths: max-ver: '2.35' min-ver: '2.1' post: - deprecated: true description: |- Creates a network. @@ -2730,19 +2514,12 @@ paths: 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. @@ -2757,19 +2534,12 @@ paths: 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. @@ -2785,8 +2555,6 @@ paths: responses: '204': description: Ok - '410': - description: Error summary: Delete Network tags: - os-networks @@ -2807,10 +2575,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_NetworkShowResponse' + $ref: '#/components/schemas/Os_NetworkShowResponse_21' description: Ok - '404': - description: Error summary: Show Network Details tags: - os-networks @@ -2837,17 +2603,7 @@ paths: 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}: @@ -2864,7 +2620,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse_21' + - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse_250' + - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse_257' description: Ok summary: Show the quota for Quota Class tags: @@ -2893,10 +2652,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse_21' + - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse_250' + - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse_257' description: Ok - '400': - description: Error summary: Create or Update Quotas for Quota Class tags: - quota-class-sets-os-quota-class-sets @@ -2934,10 +2694,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_SetShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_SetShowResponse_20' + - $ref: '#/components/schemas/Os_Quota_SetShowResponse_236' + - $ref: '#/components/schemas/Os_Quota_SetShowResponse_257' description: Ok - '400': - description: Error summary: Show A Quota tags: - quota-sets-os-quota-sets @@ -2968,10 +2729,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse_20' + - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse_236' + - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse_257' description: Ok - '400': - description: Error summary: Update Quotas tags: - quota-sets-os-quota-sets @@ -2989,10 +2751,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_SetsDefaultsResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_SetsDefaultsDefaultsResponse_20' + - $ref: '#/components/schemas/Os_Quota_SetsDefaultsDefaultsResponse_236' + - $ref: '#/components/schemas/Os_Quota_SetsDefaultsDefaultsResponse_257' description: Ok - '400': - description: Error summary: List Default Quotas For Tenant tags: - quota-sets-os-quota-sets @@ -3018,10 +2781,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_SetsDetailResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_SetsDetailDetailResponse_20' + - $ref: '#/components/schemas/Os_Quota_SetsDetailDetailResponse_236' + - $ref: '#/components/schemas/Os_Quota_SetsDetailDetailResponse_257' description: Ok - '400': - description: Error summary: Show The Detail of Quota tags: - quota-sets-os-quota-sets @@ -3029,7 +2793,6 @@ paths: - $ref: '#/components/parameters/os_quota_sets_detail_id' /v2.1/os-security-group-default-rules: get: - deprecated: true description: |- Lists default security group rules. @@ -3040,18 +2803,11 @@ paths: 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. @@ -3065,19 +2821,12 @@ paths: 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. @@ -3089,13 +2838,10 @@ paths: 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. @@ -3106,13 +2852,7 @@ paths: 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 @@ -3139,7 +2879,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_Group_RulesCreateResponse' + $ref: '#/components/schemas/Os_Security_Group_RulesCreateResponse_21' description: Ok '400': description: Error @@ -3199,10 +2939,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_GroupsListResponse' + $ref: '#/components/schemas/Os_Security_GroupsIndexResponse_21' description: Ok - '404': - description: Error summary: List Security Groups tags: - os-security-groups @@ -3228,7 +2966,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_GroupsCreateResponse' + $ref: '#/components/schemas/Os_Security_GroupsCreateResponse_21' description: Ok '400': description: Error @@ -3277,7 +3015,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_GroupShowResponse' + $ref: '#/components/schemas/Os_Security_GroupShowResponse_21' description: Ok '400': description: Error @@ -3310,7 +3048,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_GroupUpdateResponse' + $ref: '#/components/schemas/Os_Security_GroupUpdateResponse_21' description: Ok '400': description: Error @@ -3350,10 +3088,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_20' + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_251' + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_276' + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_282' + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_293' description: Ok - '403': - description: Error summary: Run Events tags: - os-server-external-events @@ -3377,7 +3118,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Server_GroupsListResponse' + oneOf: + - $ref: '#/components/schemas/Os_Server_GroupsIndexResponse_21' + - $ref: '#/components/schemas/Os_Server_GroupsIndexResponse_213' + - $ref: '#/components/schemas/Os_Server_GroupsIndexResponse_215' + - $ref: '#/components/schemas/Os_Server_GroupsIndexResponse_264' description: Ok summary: List Server Groups tags: @@ -3400,7 +3145,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse_21' + - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse_213' + - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse_215' + - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse_264' description: Ok '400': description: Error @@ -3423,8 +3172,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete Server Group tags: - os-server-groups @@ -3441,10 +3188,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Server_GroupShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Server_GroupShowResponse_21' + - $ref: '#/components/schemas/Os_Server_GroupShowResponse_213' + - $ref: '#/components/schemas/Os_Server_GroupShowResponse_215' + - $ref: '#/components/schemas/Os_Server_GroupShowResponse_264' description: Ok - '404': - description: Error summary: Show Server Group Details tags: - os-server-groups @@ -3469,7 +3218,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_ServicesListResponse' + oneOf: + - $ref: '#/components/schemas/Os_ServicesIndexResponse_20' + - $ref: '#/components/schemas/Os_ServicesIndexResponse_211' + - $ref: '#/components/schemas/Os_ServicesIndexResponse_253' + - $ref: '#/components/schemas/Os_ServicesIndexResponse_269' description: Ok summary: List Compute Services tags: @@ -3532,7 +3285,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_ServiceUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_ServiceUpdateResponse_20' + - $ref: '#/components/schemas/Os_ServiceUpdateResponse_253' + - $ref: '#/components/schemas/Os_ServiceUpdateResponse_269' description: Ok '400': description: Error @@ -3562,10 +3318,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Simple_Tenant_UsageListResponse' + oneOf: + - $ref: '#/components/schemas/Os_Simple_Tenant_UsageIndexResponse_21' + - $ref: '#/components/schemas/Os_Simple_Tenant_UsageIndexResponse_240' description: Ok - '400': - description: Error summary: List Tenant Usage Statistics For All Tenants tags: - os-simple-tenant-usage @@ -3592,10 +3348,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Simple_Tenant_UsageShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Simple_Tenant_UsageShowResponse_21' + - $ref: '#/components/schemas/Os_Simple_Tenant_UsageShowResponse_240' description: Ok - '400': - description: Error summary: Show Usage Statistics For Tenant tags: - os-simple-tenant-usage @@ -3622,7 +3378,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_SnapshotsListResponse' + $ref: '#/components/schemas/Os_SnapshotsIndexResponse_21' description: Ok summary: List Snapshots tags: @@ -3649,7 +3405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_SnapshotsCreateResponse' + $ref: '#/components/schemas/Os_SnapshotsCreateResponse_21' description: Ok '400': description: Error @@ -3679,7 +3435,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_SnapshotsDetailResponse' + $ref: '#/components/schemas/Os_SnapshotsDetailDetailResponse_21' description: Ok summary: List Snapshots With Details tags: @@ -3702,8 +3458,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete Snapshot tags: - os-snapshots @@ -3724,10 +3478,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_SnapshotShowResponse' + $ref: '#/components/schemas/Os_SnapshotShowResponse_21' description: Ok - '404': - description: Error summary: Show Snapshot Details tags: - os-snapshots @@ -3755,7 +3507,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Tenant_NetworksListResponse' + $ref: '#/components/schemas/Os_Tenant_NetworksIndexResponse_21' description: Ok summary: List Project Networks tags: @@ -3764,7 +3516,6 @@ paths: max-ver: '2.35' min-ver: '2.1' post: - deprecated: true description: |- Creates a project network. @@ -3781,19 +3532,12 @@ paths: 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. @@ -3809,8 +3553,6 @@ paths: responses: '204': description: Ok - '410': - description: Error summary: Delete Project Network tags: - os-tenant-networks @@ -3832,10 +3574,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Tenant_NetworkShowResponse' + $ref: '#/components/schemas/Os_Tenant_NetworkShowResponse_21' description: Ok - '404': - description: Error summary: Show Project Network Details tags: - os-tenant-networks @@ -3862,7 +3602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_VolumesListResponse' + $ref: '#/components/schemas/Os_VolumesIndexResponse_21' description: Ok summary: List Volumes tags: @@ -3890,7 +3630,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_VolumesCreateResponse' + $ref: '#/components/schemas/Os_VolumesCreateResponse_21' description: Ok '400': description: Error @@ -3922,7 +3662,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_VolumesDetailResponse' + $ref: '#/components/schemas/Os_VolumesDetailDetailResponse_21' description: Ok summary: List Volumes With Details tags: @@ -3967,10 +3707,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_VolumeShowResponse' + $ref: '#/components/schemas/Os_VolumeShowResponse_21' description: Ok - '404': - description: Error summary: Show Volume Details tags: - os-volumes @@ -4048,7 +3786,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootListResponse' + oneOf: + - $ref: '#/components/schemas/Os_Volumes_BootIndexResponse_21' + - $ref: '#/components/schemas/Os_Volumes_BootIndexResponse_269' description: Ok '400': description: Error @@ -4074,7 +3814,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootCreateResponse' + $ref: '#/components/schemas/Os_Volumes_BootCreateResponse_21' description: Ok '400': description: Error @@ -4156,7 +3896,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootDetailResponse' + oneOf: + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_21' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_2100' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_216' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_219' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_226' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_23' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_247' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_263' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_269' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_273' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_29' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_290' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_296' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_298' description: Ok '400': description: Error @@ -4195,10 +3949,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_20' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_2100' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_216' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_219' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_226' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_23' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_247' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_263' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_269' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_271' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_273' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_29' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_290' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_296' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_298' description: Ok - '404': - description: Error tags: - os-volumes_boot x-openstack: @@ -4221,10 +3988,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_20' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_2100' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_219' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_226' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_247' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_263' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_271' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_273' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_275' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_29' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_296' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_298' description: Ok - '404': - description: Error tags: - os-volumes_boot x-openstack: @@ -4257,15 +4034,21 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/Os_Volumes_BootActionConfirmresizeResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionCreateimageResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionOs-StartResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionOs-StopResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionRebootResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionRebuildResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionResizeResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionRevertresizeResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionTrigger_Crash_DumpResponse' + - $ref: '#/components/schemas/Os_Volumes_BootAction_Create_ImageResponse_245' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_20' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_2100' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_219' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_226' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_247' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_254' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_257' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_263' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_271' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_273' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_275' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_29' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_296' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_298' description: Ok '400': description: Error @@ -4363,7 +4146,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersListResponse' + oneOf: + - $ref: '#/components/schemas/ServersIndexResponse_21' + - $ref: '#/components/schemas/ServersIndexResponse_269' description: Ok '400': description: Error @@ -4514,7 +4299,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersDetailResponse' + oneOf: + - $ref: '#/components/schemas/ServersDetailDetailResponse_21' + - $ref: '#/components/schemas/ServersDetailDetailResponse_2100' + - $ref: '#/components/schemas/ServersDetailDetailResponse_216' + - $ref: '#/components/schemas/ServersDetailDetailResponse_219' + - $ref: '#/components/schemas/ServersDetailDetailResponse_226' + - $ref: '#/components/schemas/ServersDetailDetailResponse_23' + - $ref: '#/components/schemas/ServersDetailDetailResponse_247' + - $ref: '#/components/schemas/ServersDetailDetailResponse_263' + - $ref: '#/components/schemas/ServersDetailDetailResponse_269' + - $ref: '#/components/schemas/ServersDetailDetailResponse_273' + - $ref: '#/components/schemas/ServersDetailDetailResponse_29' + - $ref: '#/components/schemas/ServersDetailDetailResponse_290' + - $ref: '#/components/schemas/ServersDetailDetailResponse_296' + - $ref: '#/components/schemas/ServersDetailDetailResponse_298' description: Ok '400': description: Error @@ -4583,10 +4382,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServerShowResponse' + oneOf: + - $ref: '#/components/schemas/ServerShowResponse_20' + - $ref: '#/components/schemas/ServerShowResponse_2100' + - $ref: '#/components/schemas/ServerShowResponse_216' + - $ref: '#/components/schemas/ServerShowResponse_219' + - $ref: '#/components/schemas/ServerShowResponse_226' + - $ref: '#/components/schemas/ServerShowResponse_23' + - $ref: '#/components/schemas/ServerShowResponse_247' + - $ref: '#/components/schemas/ServerShowResponse_263' + - $ref: '#/components/schemas/ServerShowResponse_269' + - $ref: '#/components/schemas/ServerShowResponse_271' + - $ref: '#/components/schemas/ServerShowResponse_273' + - $ref: '#/components/schemas/ServerShowResponse_29' + - $ref: '#/components/schemas/ServerShowResponse_290' + - $ref: '#/components/schemas/ServerShowResponse_296' + - $ref: '#/components/schemas/ServerShowResponse_298' description: Ok - '404': - description: Error summary: Show Server Details tags: - servers @@ -4611,10 +4423,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServerUpdateResponse' + oneOf: + - $ref: '#/components/schemas/ServerUpdateResponse_20' + - $ref: '#/components/schemas/ServerUpdateResponse_2100' + - $ref: '#/components/schemas/ServerUpdateResponse_219' + - $ref: '#/components/schemas/ServerUpdateResponse_226' + - $ref: '#/components/schemas/ServerUpdateResponse_247' + - $ref: '#/components/schemas/ServerUpdateResponse_263' + - $ref: '#/components/schemas/ServerUpdateResponse_271' + - $ref: '#/components/schemas/ServerUpdateResponse_273' + - $ref: '#/components/schemas/ServerUpdateResponse_275' + - $ref: '#/components/schemas/ServerUpdateResponse_29' + - $ref: '#/components/schemas/ServerUpdateResponse_296' + - $ref: '#/components/schemas/ServerUpdateResponse_298' description: Ok - '404': - description: Error summary: Update Server tags: - servers @@ -4677,16 +4499,29 @@ paths: 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' + - $ref: '#/components/schemas/ServersActionGet_Console_OutputResponse' + - $ref: '#/components/schemas/ServersActionGet_Rdp_ConsoleResponse_21' + - $ref: '#/components/schemas/ServersActionGet_Serial_ConsoleResponse_21' + - $ref: '#/components/schemas/ServersActionGet_Spice_ConsoleResponse_21' + - $ref: '#/components/schemas/ServersActionGet_Vnc_ConsoleResponse_21' + - $ref: '#/components/schemas/ServersAction_Create_BackupResponse_245' + - $ref: '#/components/schemas/ServersAction_Create_ImageResponse_245' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_20' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_2100' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_219' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_226' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_247' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_254' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_257' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_263' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_271' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_273' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_275' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_29' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_296' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_298' + - $ref: '#/components/schemas/ServersAction_RescueResponse' description: Ok '202': description: Accepted @@ -4709,15 +4544,12 @@ paths: 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. @@ -4727,20 +4559,13 @@ paths: 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. @@ -4751,19 +4576,12 @@ paths: 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. @@ -4775,13 +4593,10 @@ paths: responses: '204': description: Ok - '410': - description: Error summary: Delete Console tags: - servers get: - deprecated: true description: |- Shows console details for a server. @@ -4792,13 +4607,7 @@ paths: 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 @@ -4823,7 +4632,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersDiagnosticsListResponse' + oneOf: + - $ref: '#/components/schemas/ServersDiagnosticsIndexResponse_21' + - $ref: '#/components/schemas/ServersDiagnosticsIndexResponse_248' description: Ok '400': description: Error @@ -4856,10 +4667,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersIpsListResponse' + $ref: '#/components/schemas/ServersIpsIndexResponse' description: Ok - '404': - description: Error summary: List Ips tags: - servers @@ -4885,8 +4694,6 @@ paths: schema: $ref: '#/components/schemas/ServersIpShowResponse' description: Ok - '404': - description: Error summary: Show Ip Details tags: - servers @@ -4909,10 +4716,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersMetadataListResponse' + $ref: '#/components/schemas/ServersMetadataIndexResponse' description: Ok - '404': - description: Error summary: List All Metadata tags: - servers @@ -5026,8 +4831,6 @@ paths: schema: $ref: '#/components/schemas/ServersMetadataShowResponse' description: Ok - '404': - description: Error summary: Show Metadata Item Details tags: - servers @@ -5089,10 +4892,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersMigrationsListResponse' + oneOf: + - $ref: '#/components/schemas/ServersMigrationsIndexResponse_223' + - $ref: '#/components/schemas/ServersMigrationsIndexResponse_259' + - $ref: '#/components/schemas/ServersMigrationsIndexResponse_280' description: Ok - '404': - description: Error summary: List Migrations tags: - server-migrations @@ -5168,10 +4972,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersMigrationShowResponse' + oneOf: + - $ref: '#/components/schemas/ServersMigrationShowResponse_223' + - $ref: '#/components/schemas/ServersMigrationShowResponse_259' + - $ref: '#/components/schemas/ServersMigrationShowResponse_280' description: Ok - '404': - description: Error summary: Show Migration Details tags: - server-migrations @@ -5234,7 +5039,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Instance_ActionsListResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Instance_ActionsIndexResponse_21' + - $ref: '#/components/schemas/ServersOs_Instance_ActionsIndexResponse_258' description: Ok '400': description: Error @@ -5269,10 +5076,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_21' + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_251' + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_258' + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_262' + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_284' description: Ok - '404': - description: Error summary: Show Server Action Details tags: - servers @@ -5294,7 +5104,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_InterfaceListResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_InterfaceIndexResponse_21' + - $ref: '#/components/schemas/ServersOs_InterfaceIndexResponse_270' description: Ok '404': description: Error @@ -5324,7 +5136,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_InterfaceCreateResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_InterfaceCreateResponse_21' + - $ref: '#/components/schemas/ServersOs_InterfaceCreateResponse_270' description: Ok '400': description: Error @@ -5378,7 +5192,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_InterfaceShowResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_InterfaceShowResponse_21' + - $ref: '#/components/schemas/ServersOs_InterfaceShowResponse_270' description: Ok '403': description: Error @@ -5404,10 +5220,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Security_GroupsListResponse' + $ref: '#/components/schemas/ServersOs_Security_GroupsIndexResponse' description: Ok - '404': - description: Error summary: List Security Groups By Server tags: - servers @@ -5432,8 +5246,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Clear Admin Password tags: - servers @@ -5461,10 +5273,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Server_PasswordListResponse' + $ref: '#/components/schemas/ServersOs_Server_PasswordIndexResponse' description: Ok - '404': - description: Error summary: Show Server Password tags: - servers @@ -5472,7 +5282,6 @@ paths: - $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. @@ -5487,13 +5296,7 @@ paths: 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 @@ -5516,10 +5319,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsListResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsIndexResponse_20' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsIndexResponse_270' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsIndexResponse_279' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsIndexResponse_289' description: Ok - '404': - description: Error summary: List volume attachments for an instance tags: - servers @@ -5543,7 +5348,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateResponse_20' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateResponse_270' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateResponse_279' description: Ok '400': description: Error @@ -5592,10 +5400,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse_20' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse_270' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse_279' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse_289' description: Ok - '404': - description: Error summary: Show a detail of a volume attachment tags: - servers @@ -5662,7 +5472,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersRemote_ConsolesCreateResponse' + oneOf: + - $ref: '#/components/schemas/ServersRemote_ConsolesCreateResponse_26' + - $ref: '#/components/schemas/ServersRemote_ConsolesCreateResponse_28' + - $ref: '#/components/schemas/ServersRemote_ConsolesCreateResponse_299' description: Ok '400': description: Error @@ -5691,7 +5504,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersSharesListResponse' + $ref: '#/components/schemas/ServersSharesIndexResponse_297' description: Ok '400': description: Error @@ -5724,7 +5537,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersSharesCreateResponse' + $ref: '#/components/schemas/ServersSharesCreateResponse_297' description: Ok '400': description: Error @@ -5777,7 +5590,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersShareShowResponse' + $ref: '#/components/schemas/ServersShareShowResponse_297' description: Ok '400': description: Error @@ -5827,10 +5640,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersTagsListResponse' + $ref: '#/components/schemas/ServersTagsIndexResponse_226' description: Ok - '404': - description: Error summary: List Tags tags: - server-tags @@ -5856,7 +5667,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersTagsUpdate_AllResponse' + $ref: '#/components/schemas/ServersTagsUpdate_AllResponse_226' description: Ok '404': description: Error @@ -5899,13 +5710,7 @@ paths: 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 @@ -5957,10 +5762,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersTopologyListResponse' + $ref: '#/components/schemas/ServersTopologyIndexResponse_278' description: Ok - '404': - description: Error summary: Show Server Topology tags: - servers @@ -5978,8 +5781,6 @@ paths: schema: $ref: '#/components/schemas/VersionShowResponse' description: Ok - '404': - description: Error tags: - version parameters: @@ -6006,7 +5807,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_limit: in: query @@ -6019,7 +5819,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_marker: in: query @@ -6027,7 +5826,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_minDisk: in: query @@ -6035,7 +5833,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_minRam: in: query @@ -6043,7 +5840,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_name: in: query @@ -6051,7 +5847,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.102' flavors_detail_sort_dir: in: query @@ -6062,7 +5857,6 @@ components: - desc type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_sort_key: in: query @@ -6085,7 +5879,6 @@ components: - vcpus type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_id: description: id parameter for /v2.1/flavors/{id} API @@ -6100,7 +5893,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_limit: in: query @@ -6113,7 +5905,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_marker: in: query @@ -6121,7 +5912,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_minDisk: in: query @@ -6129,7 +5919,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_minRam: in: query @@ -6137,7 +5926,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_name: in: query @@ -6145,7 +5933,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.102' flavors_os_extra_specs_flavor_id: description: flavor_id parameter for @@ -6180,7 +5967,6 @@ components: - desc type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_sort_key: in: query @@ -6203,7 +5989,6 @@ components: - vcpus type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' images_changes-since: in: query @@ -6416,9 +6201,6 @@ components: 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 @@ -6453,7 +6235,6 @@ components: 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 @@ -7000,7 +6781,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' resource_link: identity/v3/user.id os_quota_sets_defaults_id: @@ -7023,7 +6803,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' resource_link: identity/v3/user.id os_quota_sets_id: @@ -7092,7 +6871,6 @@ components: 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 @@ -7112,7 +6890,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' os_server_groups_offset: in: query @@ -7125,7 +6902,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' os_services_binary: in: query @@ -7133,7 +6909,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' os_services_host: in: query @@ -7141,7 +6916,6 @@ components: 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 @@ -8403,18 +8177,12 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_access_ip_v6: in: query name: access_ip_v6 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_action_id: description: id parameter for /v2.1/servers/{id}/action API in: path @@ -8427,35 +8195,23 @@ components: name: all_tenants schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_auto_disk_config: in: query name: auto_disk_config schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_availability_zone: in: query name: availability_zone schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_block_device_mapping: in: query name: block_device_mapping schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_changes-before: in: query name: changes-before @@ -8463,8 +8219,6 @@ components: format: date-time type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.66' servers_changes-since: in: query @@ -8472,18 +8226,12 @@ components: schema: format: date-time type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_config_drive: in: query name: config_drive schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_consoles_id: description: id parameter for /v2.1/servers/{server_id}/consoles/{id} API in: path @@ -8505,78 +8253,51 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_deleted: in: query name: deleted schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_description: in: query name: description schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_access_ip_v4: in: query name: access_ip_v4 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_access_ip_v6: in: query name: access_ip_v6 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_all_tenants: in: query name: all_tenants schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_auto_disk_config: in: query name: auto_disk_config schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_availability_zone: in: query name: availability_zone schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_block_device_mapping: in: query name: block_device_mapping schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_changes-before: in: query name: changes-before @@ -8584,8 +8305,6 @@ components: format: date-time type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.66' servers_detail_changes-since: in: query @@ -8593,165 +8312,108 @@ components: schema: format: date-time type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_config_drive: in: query name: config_drive schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_created_at: in: query name: created_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_deleted: in: query name: deleted schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_description: in: query name: description schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_display_description: in: query name: display_description schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_display_name: in: query name: display_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_flavor: in: query name: flavor schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_host: in: query name: host schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_hostname: in: query name: hostname schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_image: in: query name: image schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_image_ref: in: query name: image_ref schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_info_cache: in: query name: info_cache schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_ip: in: query name: ip schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_ip6: in: query name: ip6 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_kernel_id: in: query name: kernel_id schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_key_name: in: query name: key_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_launch_index: in: query name: launch_index schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_launched_at: in: query name: launched_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_limit: in: query name: limit @@ -8762,17 +8424,12 @@ components: type: - integer - string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_locked: in: query name: locked schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.73' servers_detail_locked_by: in: query @@ -8780,43 +8437,28 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_marker: in: query name: marker schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_metadata: in: query name: metadata schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_name: in: query name: name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_node: in: query name: node schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_not-tags: in: query name: not-tags @@ -8824,8 +8466,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_detail_not-tags-any: in: query @@ -8834,43 +8474,30 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_detail_pci_devices: in: query name: pci_devices schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_power_state: in: query name: power_state schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_progress: in: query name: progress schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_project_id: in: query name: project_id schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' resource_link: identity/v3/project.id servers_detail_ramdisk_id: in: query @@ -8878,59 +8505,38 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_reservation_id: in: query name: reservation_id schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_root_device_name: in: query name: root_device_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_security_groups: in: query name: security_groups schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_services: in: query name: services schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_soft_deleted: in: query name: soft_deleted schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_sort_dir: in: query name: sort_dir schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_sort_key: in: query name: sort_key @@ -8967,25 +8573,16 @@ components: - uuid - vm_state type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_status: in: query name: status schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_system_metadata: in: query name: system_metadata schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_tags: in: query name: tags @@ -8993,8 +8590,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_detail_tags-any: in: query @@ -9003,59 +8598,40 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_detail_task_state: in: query name: task_state schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_tenant_id: in: query name: tenant_id schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_terminated_at: in: query name: terminated_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_user_id: in: query name: user_id schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' resource_link: identity/v3/user.id servers_detail_uuid: in: query name: uuid schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_vm_state: in: query name: vm_state schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_diagnostics_server_id: description: server_id parameter for /v2.1/servers/{server_id}/diagnostics API @@ -9070,44 +8646,29 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_display_name: in: query name: display_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_flavor: in: query name: flavor schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_host: in: query name: host schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_hostname: in: query name: hostname schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_id: description: id parameter for /v2.1/servers/{id} API in: path @@ -9120,43 +8681,28 @@ components: name: image schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_image_ref: in: query name: image_ref schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_info_cache: in: query name: info_cache schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_ip: in: query name: ip schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_ip6: in: query name: ip6 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_ips_id: description: id parameter for /v2.1/servers/{server_id}/ips/{id} API in: path @@ -9178,35 +8724,23 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_key_name: in: query name: key_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_launch_index: in: query name: launch_index schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_launched_at: in: query name: launched_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_limit: in: query name: limit @@ -9217,17 +8751,12 @@ components: type: - integer - string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_locked: in: query name: locked schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.73' servers_locked_by: in: query @@ -9235,25 +8764,16 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_marker: in: query name: marker schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_metadata: in: query name: metadata schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_metadata_id: description: id parameter for /v2.1/servers/{server_id}/metadata/{id} API in: path @@ -9307,18 +8827,12 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_node: in: query name: node schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_not-tags: in: query name: not-tags @@ -9326,8 +8840,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_not-tags-any: in: query @@ -9336,8 +8848,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_os_instance_actions_changes-before: in: query @@ -9456,7 +8966,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' servers_os_volume_attachments_offset: in: query @@ -9469,7 +8978,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' servers_os_volume_attachments_server_id: description: server_id parameter for @@ -9484,35 +8992,24 @@ components: name: pci_devices schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_power_state: in: query name: power_state schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_progress: in: query name: progress schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_project_id: in: query name: project_id schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' resource_link: identity/v3/project.id servers_ramdisk_id: in: query @@ -9520,9 +9017,6 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_remote_consoles_server_id: description: server_id parameter for /v2.1/servers/{server_id}/remote-consoles API @@ -9537,34 +9031,22 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_root_device_name: in: query name: root_device_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_security_groups: in: query name: security_groups schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_services: in: query name: services schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_shares_id: description: id parameter for /v2.1/servers/{server_id}/shares/{id} API in: path @@ -9585,17 +9067,11 @@ components: name: soft_deleted schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_sort_dir: in: query name: sort_dir schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_sort_key: in: query name: sort_key @@ -9632,25 +9108,16 @@ components: - uuid - vm_state type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_status: in: query name: status schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_system_metadata: in: query name: system_metadata schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_tags: in: query name: tags @@ -9658,8 +9125,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_tags-any: in: query @@ -9668,8 +9133,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_tags_id: description: id parameter for /v2.1/servers/{server_id}/tags/{id} API @@ -9691,26 +9154,17 @@ components: name: task_state schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_tenant_id: in: query name: tenant_id schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_terminated_at: in: query name: terminated_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_topology_server_id: description: server_id parameter for /v2.1/servers/{server_id}/topology API @@ -9725,25 +9179,17 @@ components: schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' resource_link: identity/v3/user.id servers_uuid: in: query name: uuid schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_vm_state: in: query name: vm_state schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' versions_id: description: id parameter for /v2.1/versions/{id} API in: path @@ -9753,9 +9199,10 @@ components: type: string schemas: ExtensionShowResponse: - description: An extension object. + additionalProperties: false properties: extension: + additionalProperties: false description: |- An `extension` object. properties: @@ -9772,13 +9219,9 @@ components: 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 + format: url type: string rel: type: string @@ -9808,19 +9251,23 @@ components: type: string required: - alias + - description + - links - name + - namespace + - updated type: object required: - extension type: object - ExtensionsListResponse: - description: An extension object. + ExtensionsIndexResponse: + additionalProperties: false properties: extensions: description: |- List of `extension` objects. items: - description: An extension object. + additionalProperties: false properties: alias: description: |- @@ -9835,13 +9282,9 @@ components: 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 + format: url type: string rel: type: string @@ -9871,13 +9314,118 @@ components: type: string required: - alias + - description + - links - name + - namespace + - updated type: object type: array required: - extensions type: object - FlavorShowResponse: + FlavorShowResponse_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-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`. + + **Available until version 2.101** + 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 + 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 + 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 + - disk + - id + - links + - name + - os-flavor-access:is_public + - ram + - rxtx_factor + - swap + - vcpus + type: object + required: + - flavor + type: object + x-openstack: + max-ver: '2.54' + min-ver: '2.0' + FlavorShowResponse_2102: additionalProperties: false properties: flavor: @@ -9983,7 +9531,9 @@ components: required: - flavor type: object - FlavorUpdateResponse: + x-openstack: + min-ver: '2.102' + FlavorShowResponse_255: additionalProperties: false properties: flavor: @@ -9992,6 +9542,15 @@ components: 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`. + + **Available until version 2.101** + type: boolean OS-FLV-EXT-DATA:ephemeral: description: |- The size of the ephemeral disk that will be created, in @@ -10002,6 +9561,8 @@ components: description: description: |- The description of the flavor. + + **New in version 2.55** type: - 'null' - string @@ -10016,19 +9577,6 @@ components: 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 @@ -10060,19 +9608,23 @@ components: 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. - 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 @@ -10081,13 +9633,17 @@ components: - name - os-flavor-access:is_public - ram + - rxtx_factor - swap - vcpus type: object required: - flavor type: object - FlavorUpdate_255: + x-openstack: + max-ver: '2.60' + min-ver: '2.55' + FlavorShowResponse_261: additionalProperties: false properties: flavor: @@ -10096,160 +9652,242 @@ components: 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`. + + **Available until version 2.101** + 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: |- - 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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 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: + max-ver: '2.74' + min-ver: '2.61' + FlavorShowResponse_275: 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: + flavor: additionalProperties: false description: |- - The action. + The ID and links for the flavor for your server instance. A flavor is a combination + of memory, disk size, and CPUs. properties: - tenant: + OS-FLV-DISABLED:disabled: 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. + 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`. - Specify the `removeTenantAccess` action and the `tenant` in the request body. + **Available until version 2.101** + 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. - Normal response codes: 200 + **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. - Error response codes: badRequest(400), unauthorized(401), forbidden(403), - itemNotFound(404), conflict(409) - properties: - removeTenantAccess: - additionalProperties: false - description: |- - The action. - properties: - tenant: + **New in version 2.61** + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + maxLength: 255 + type: string + type: object + id: description: |- - The UUID of the tenant in a multi-tenancy cloud. - maxLength: 255 - minLength: 1 + 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: - - tenant + - 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: - - removeTenantAccess - summary: Remove Flavor Access From Tenant (removeTenantAccess Action) + - flavor type: object x-openstack: - action-name: removeTenantAccess - FlavorsCreateRequest: - oneOf: - - $ref: '#/components/schemas/FlavorsCreate_20' - - $ref: '#/components/schemas/FlavorsCreate_21' - - $ref: '#/components/schemas/FlavorsCreate_2102' - - $ref: '#/components/schemas/FlavorsCreate_255' - x-openstack: - discriminator: microversion - FlavorsCreateResponse: + max-ver: '2.101' + min-ver: '2.75' + FlavorUpdateResponse_2102: additionalProperties: false properties: flavor: @@ -10268,8 +9906,6 @@ components: description: description: |- The description of the flavor. - - **New in version 2.55** type: - 'null' - string @@ -10355,7 +9991,9 @@ components: required: - flavor type: object - FlavorsCreate_20: + x-openstack: + min-ver: '2.102' + FlavorUpdateResponse_255: additionalProperties: false properties: flavor: @@ -10364,129 +10002,106 @@ components: 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`. + + **Available until version 2.101** + type: boolean 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]+$ + 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: - - integer + - '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 + 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 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. _-]+(?= 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 + 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 + 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 + 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_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_RebuildResponse_20: + additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + type: string + accessIPv4: + oneOf: + - const: '' + - format: ipv4 + type: string + accessIPv6: + oneOf: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object + adminPass: + type: + - 'null' + - string + created: + format: date-time + type: 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: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: + type: string + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - no_device: {} - snapshot_id: - format: uuid + rel: + enum: + - bookmark + - self type: string - virtual_name: - maxLength: 255 + required: + - href + - rel + type: object + type: array + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: + type: + - 'null' + - string + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - flavor + - hostId + - id + - image + - links + - metadata + - name + - progress + - status + - tenant_id + - updated + - user_id + type: object + required: + - server + type: object + x-openstack: + action-name: rebuild + max-ver: '2.8' + min-ver: '2.0' + ServersAction_RebuildResponse_2100: + 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 + - 'null' + 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 + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + properties: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - volume_id: - format: uuid + rel: + enum: + - bookmark + - self type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - href + - rel type: object type: array - block_device_mapping_v2: + 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: - 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 + default: false + type: boolean + id: type: string - image_id: - format: uuid + 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 - no_device: {} - snapshot_id: + type: + - array + - string + different_host: + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + group: + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + type: + - object + - string + same_host: + items: 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: + - array + - string + target_cell: + format: name + maxLength: 255 + minLength: 1 + type: string + type: object + security_groups: + items: + additionalProperties: false + properties: + name: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - name 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 + server_groups: + items: + format: uuid + type: string + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + 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: - - boolean + - array + - 'null' + updated: + format: date-time + type: string + user_data: + format: base64 + maxLength: 65535 + type: + - 'null' - string - description: + user_id: maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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 + min-ver: '2.100' + ServersAction_RebuildResponse_219: + additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + type: string + accessIPv4: + oneOf: + - const: '' + - format: ipv4 + type: string + accessIPv6: + oneOf: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object + adminPass: type: - 'null' - string - flavorRef: - minLength: 1 + created: + format: date-time + type: string + description: type: - - integer + - 'null' - string - imageRef: - oneOf: - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - - maxLength: 0 + details: type: string - key_name: - format: name - maxLength: 255 - minLength: 1 + message: + type: string + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: type: string - max_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ - type: - - integer - - string + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean 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]*$ + name: type: - - integer + - 'null' - string - name: - format: name + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - networks: + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - links + - locked + - metadata + - name + - progress + - status + - tenant_id + - updated + - user_id + type: object + required: + - server + type: object + x-openstack: + action-name: rebuild + max-ver: '2.25' + min-ver: '2.19' + ServersAction_RebuildResponse_226: + additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: - - items: + - const: '' + - format: ipv4 + type: string + accessIPv6: + oneOf: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: additionalProperties: false properties: - fixed_ip: + addr: oneOf: - format: ipv4 - format: ipv6 type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object + adminPass: + type: + - '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: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - uuid: - format: uuid + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel type: object type: array - - enum: - - auto - - none + type: object + hostId: + type: string + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' type: string - personality: + links: items: additionalProperties: false properties: - contents: - format: base64 + href: + format: uri type: string - path: + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel 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 + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: type: - - boolean + - 'null' - string - security_groups: - items: - additionalProperties: false - properties: - name: - format: name - maxLength: 255 - minLength: 1 - type: string - type: object - type: array + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array - user_data: - format: base64 - maxLength: 65535 + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string required: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - links + - locked + - metadata - name - - networks + - progress + - status + - tags + - tenant_id + - updated + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.56' - min-ver: '2.52' - Os_Volumes_BootCreate_257: + action-name: rebuild + max-ver: '2.46' + min-ver: '2.26' + ServersAction_RebuildResponse_247: additionalProperties: false properties: - OS-SCH-HNT:scheduler_hints: - additionalProperties: true + server: + additionalProperties: false properties: - build_near_host_ip: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: + - const: '' - 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: + accessIPv6: oneOf: - - items: - format: uuid - type: string + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object type: array - - format: uuid - type: string - query: - type: - - object - - string - same_host: - items: - format: uuid - type: string + type: object + adminPass: type: - - array + - 'null' - 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.:]+$ + created: + format: date-time type: string - different_cell: - items: - type: string + description: type: - - array + - 'null' - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid + details: 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: + 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 - availability_zone: - format: name - maxLength: 255 - minLength: 1 + id: 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: + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + links: 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 + href: + format: uri type: string - source_type: + rel: 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 + - bookmark + - self type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - href + - rel 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: type: - 'null' - string - flavorRef: - minLength: 1 + progress: type: - - integer - - string - imageRef: - oneOf: - - format: uuid - type: string - - maxLength: 0 - type: string - key_name: - format: name + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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 + updated: + format: date-time + type: string + user_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - networks: + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - links + - locked + - metadata + - name + - progress + - status + - tags + - tenant_id + - updated + - user_id + type: object + required: + - server + type: object + x-openstack: + action-name: rebuild + max-ver: '2.53' + min-ver: '2.47' + ServersAction_RebuildResponse_254: + additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: - - items: + - const: '' + - format: ipv4 + type: string + accessIPv6: + oneOf: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: additionalProperties: false properties: - fixed_ip: + addr: 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 + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version type: object type: array - - enum: - - auto - - none + type: object + adminPass: + type: + - '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 - 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 + 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 + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: type: - - boolean + - 'null' - string - security_groups: + links: items: additionalProperties: false properties: - name: - format: name - maxLength: 255 - minLength: 1 + href: + format: uri + type: string + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel type: object type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: + type: + - 'null' + - string + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array - user_data: - format: base64 - maxLength: 65535 + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string required: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata - name - - networks + - progress + - status + - tags + - tenant_id + - updated + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.62' - min-ver: '2.57' - Os_Volumes_BootCreate_263: + action-name: rebuild + max-ver: '2.56' + min-ver: '2.54' + ServersAction_RebuildResponse_257: additionalProperties: false properties: - OS-SCH-HNT:scheduler_hints: - additionalProperties: true + server: + additionalProperties: false properties: - build_near_host_ip: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: + - const: '' - 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: + accessIPv6: oneOf: - - items: - format: uuid - type: string + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object type: array - - format: uuid - type: string - query: + type: object + adminPass: type: - - object + - 'null' - string - same_host: - items: - format: uuid - type: string + created: + format: date-time + type: string + description: type: - - array + - 'null' - 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 + 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 - cidr: - pattern: ^/[0-9a-f.:]+$ + id: type: string - different_cell: - items: - type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: type: - - array + - 'null' - string - different_host: - oneOf: - - items: - format: uuid + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - type: array - - format: uuid - type: string - group: - oneOf: - - items: - format: uuid + rel: + enum: + - bookmark + - self type: string - type: array - - format: uuid + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: type: string - query: + type: object + name: type: - - object + - 'null' - string - same_host: + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: items: - format: uuid type: string + maxItems: 50 + type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_data: + format: base64 + maxLength: 65535 type: - - array + - 'null' - string - target_cell: - format: name + user_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata + - name + - progress + - status + - tags + - tenant_id + - updated + - user_data + - user_id type: object + required: + - server + type: object + x-openstack: + action-name: rebuild + max-ver: '2.62' + min-ver: '2.57' + ServersAction_RebuildResponse_263: + additionalProperties: false + properties: server: additionalProperties: false properties: OS-DCF:diskConfig: - enum: - - AUTO - - MANUAL type: string accessIPv4: - format: ipv4 + oneOf: + - const: '' + - format: ipv4 type: string accessIPv6: - format: ipv6 + oneOf: + - const: '' + - format: ipv6 type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object 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 + - 'null' - string + created: + format: date-time + type: string description: - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ type: - 'null' - string - flavorRef: - minLength: 1 - type: - - integer - - string - imageRef: - oneOf: - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - - maxLength: 0 + details: 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: + message: + type: string + required: + - code + - created + - message + type: object + flavor: additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: - maxLength: 255 + 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 - min_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ - type: - - integer - - string - name: - format: name - maxLength: 255 - minLength: 1 + hostId: type: string - networks: + id: + type: string + image: 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 + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' 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 + key_name: type: - - boolean + - 'null' - string - security_groups: + links: items: additionalProperties: false properties: - name: - format: name - maxLength: 255 - minLength: 1 + href: + format: uri + type: string + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel type: object type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: + type: + - 'null' + - string + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string trusted_image_certificates: items: - minLength: 1 type: string - maxItems: 50 - minItems: 1 type: - array - 'null' - uniqueItems: true + 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: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata - name - - networks + - progress + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_data + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.66' + action-name: rebuild + max-ver: '2.70' min-ver: '2.63' - Os_Volumes_BootCreate_267: + ServersAction_RebuildResponse_271: 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + oneOf: + - const: '' + - format: ipv4 type: string accessIPv6: - format: ipv6 + oneOf: + - const: '' + - format: ipv6 type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object 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 + - 'null' - string + created: + format: date-time + type: string description: - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ type: - 'null' - string - flavorRef: - minLength: 1 - type: - - integer - - string - imageRef: - oneOf: - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - - maxLength: 0 + 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 + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' type: string key_name: - format: name - maxLength: 255 - minLength: 1 - type: string - max_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ type: - - integer + - 'null' - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean 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 + - 'null' - string - security_groups: + progress: + type: + - 'null' + - number + server_groups: items: - additionalProperties: false - properties: - name: - format: name - maxLength: 255 - minLength: 1 - type: string - type: object + format: uuid + type: string + maxLength: 1 type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string trusted_image_certificates: items: - minLength: 1 type: string - maxItems: 50 - minItems: 1 type: - array - 'null' - uniqueItems: true + 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: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata - name - - networks + - progress + - server_groups + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_data + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.73' - min-ver: '2.67' - Os_Volumes_BootCreate_274: + action-name: rebuild + max-ver: '2.72' + min-ver: '2.71' + ServersAction_RebuildResponse_273: additionalProperties: false properties: - OS-SCH-HNT:scheduler_hints: - additionalProperties: true + server: + additionalProperties: false properties: - build_near_host_ip: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: + - const: '' - 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: + accessIPv6: oneOf: - - items: - format: uuid - type: string + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object type: array - - format: uuid - type: string - query: - type: - - object - - string - same_host: - items: - format: uuid - type: string + type: object + adminPass: type: - - array + - 'null' - 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.:]+$ + created: + format: date-time type: string - different_cell: - items: - type: string + description: type: - - array + - 'null' - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid + details: 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: + 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 - availability_zone: - format: name - maxLength: 255 - minLength: 1 + id: 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 + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - source_type: + rel: 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 + - bookmark + - self type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string - volume_type: - maxLength: 255 - minLength: 0 - type: - - 'null' - - string + required: + - href + - rel 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 + locked: + type: boolean + locked_reason: type: - - boolean + - 'null' - string - description: - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: type: - 'null' - string - flavorRef: - minLength: 1 + progress: type: - - integer - - string - host: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + - 'null' + - number + server_groups: + items: + format: uuid + type: string + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - hypervisor_hostname: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + pattern: ^[a-zA-Z0-9-]*$ type: string - imageRef: - oneOf: - - format: uuid - type: string - - maxLength: 0 - type: string - key_name: - format: name + 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 - max_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - locked_reason + - metadata + - name + - progress + - 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 + max-ver: '2.74' + min-ver: '2.73' + ServersAction_RebuildResponse_275: + 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 + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - 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]*$ + 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 + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' - string - name: - format: name - maxLength: 255 - minLength: 1 + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - networks: + accessIPv6: oneOf: - - items: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: additionalProperties: false properties: - fixed_ip: + 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 - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ - type: string - uuid: - format: uuid - 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 - - enum: - - auto - - none + 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 - 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 + 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: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + 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 + progress: type: - - boolean - - string + - 'null' + - number security_groups: items: additionalProperties: false properties: name: - format: name - maxLength: 255 - minLength: 1 type: string + required: + - name type: object type: array + server_groups: + items: + format: uuid + type: string + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string trusted_image_certificates: items: - minLength: 1 type: string - maxItems: 50 - minItems: 1 type: - array - 'null' - uniqueItems: true + 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: - - flavorRef + - 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 - - networks + - os-extended-volumes:volumes_attached + - progress + - server_groups + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_data + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.89' - min-ver: '2.74' - Os_Volumes_BootCreate_290: + action-name: rebuild + max-ver: '2.95' + min-ver: '2.75' + ServersAction_RebuildResponse_29: 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + oneOf: + - const: '' + - format: ipv4 type: string accessIPv6: - format: ipv6 + oneOf: + - const: '' + - format: ipv6 type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object 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-._]*$ + created: + format: date-time type: string - imageRef: - oneOf: - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - - maxLength: 0 + details: 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 + message: 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: + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: + type: string + links: + 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: ^[^,/]*$ + href: + format: uri type: string - uuid: - format: uuid + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel type: object type: array - - enum: - - auto - - none + type: object + hostId: + type: string + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' 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: + links: items: additionalProperties: false properties: - name: - format: name - maxLength: 255 - minLength: 1 + href: + format: uri + type: string + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel 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 + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: type: - - array - 'null' - uniqueItems: true - user_data: - format: base64 - maxLength: 65535 + - string + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string required: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - flavor + - hostId + - id + - image + - links + - locked + - metadata - name - - networks + - progress + - status + - tenant_id + - updated + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.93' - min-ver: '2.90' - Os_Volumes_BootCreate_294: + action-name: rebuild + max-ver: '2.18' + min-ver: '2.9' + ServersAction_RebuildResponse_296: additionalProperties: false properties: - OS-SCH-HNT:scheduler_hints: - additionalProperties: true + server: + additionalProperties: false properties: - build_near_host_ip: - oneOf: - - format: ipv4 - - format: ipv6 + OS-DCF:diskConfig: type: string - cidr: - pattern: ^/[0-9a-f.:]+$ + OS-EXT-AZ:availability_zone: type: string - different_cell: - items: - type: string + OS-EXT-SRV-ATTR:host: type: - - array + - 'null' - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: + OS-EXT-SRV-ATTR:hostname: + type: string + OS-EXT-SRV-ATTR:hypervisor_hostname: type: - - object + - 'null' - string - same_host: - items: - format: uuid - type: string + OS-EXT-SRV-ATTR:instance_name: + type: string + OS-EXT-SRV-ATTR:kernel_id: type: - - array + - 'null' - 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 + OS-EXT-SRV-ATTR:launch_index: type: - - array + - integer + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: + OS-EXT-SRV-ATTR:reservation_id: type: - - object + - 'null' - string - same_host: - items: - format: uuid - type: string + OS-EXT-SRV-ATTR:root_device_name: type: - - array + - 'null' - string - target_cell: - format: name - maxLength: 255 - minLength: 1 - type: string - type: object - server: - additionalProperties: false - properties: - OS-DCF:diskConfig: + OS-EXT-STS:power_state: 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 + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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: - 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 + - 'null' - string + created: + format: date-time + type: 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-._]*$ + 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 - hostname: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + host_status: type: string - hypervisor_hostname: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + id: type: string - imageRef: + image: oneOf: - - format: uuid - type: string - - maxLength: 0 + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' type: string key_name: - format: name - maxLength: 255 - minLength: 1 - type: string - max_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ type: - - integer + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + locked_reason: + type: + - 'null' - 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]*$ + name: type: - - integer + - 'null' - 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 + 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: - - boolean + - 'null' - string + progress: + type: + - 'null' + - number security_groups: items: additionalProperties: false properties: name: - format: name - maxLength: 255 - minLength: 1 type: string + required: + - name type: object type: array + server_groups: + items: + format: uuid + type: string + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string trusted_image_certificates: items: - minLength: 1 type: string - maxItems: 50 - minItems: 1 type: - array - 'null' - uniqueItems: true + updated: + format: date-time + type: string user_data: format: base64 maxLength: 65535 - type: string - required: - - flavorRef - - name - - networks - type: object - required: - - server - type: object - x-openstack: - max-ver: '2.102' - min-ver: '2.94' - Os_Volumes_BootDetailResponse: - additionalProperties: false - properties: - servers: - items: - oneOf: - - 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 - - 'null' - 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-SRV-ATTR:user_data: - format: base64 - maxLength: 65535 - type: - - 'null' - - string - OS-EXT-STS:power_state: - enum: - - - - 0 - - 1 - - 3 - - 4 - - 6 - - 7 - type: - - integer - - 'null' - OS-EXT-STS:task_state: - type: - - 'null' - - string - OS-EXT-STS:vm_state: - type: - - 'null' - - 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 - config_drive: - enum: - - '' - - - - 'False' - - 'True' - type: - - 'null' - - string - created: - format: date-time - type: string - description: - type: - - 'null' - - string - fault: + 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 + - 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 + max-ver: '2.97' + min-ver: '2.96' + ServersAction_RebuildResponse_298: + 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 + - 'null' + 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 + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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: - code: - type: integer - created: - format: date-time + OS-EXT-IPS-MAC:mac_addr: + format: mac-address type: string - details: + OS-EXT-IPS:type: + enum: + - fixed + - floating type: string - message: + addr: + oneOf: + - format: ipv4 + - format: ipv6 type: string + version: + enum: + - 4 + - 6 + type: number required: - - code - - created - - message + - OS-EXT-IPS-MAC:mac_addr + - OS-EXT-IPS:type + - addr + - version type: object - flavor: - additionalProperties: false - properties: - disk: - type: integer - ephemeral: - type: integer - extra_specs: + 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: + format: uuid + type: string + links: + items: 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: - enum: - - '' - - DOWN - - MAINTENANCE - - UNKNOWN - - UP - type: string - id: - format: uuid - type: string - image: - oneOf: - - additionalProperties: false properties: - id: - format: uuid + href: + format: uri type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - properties: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9_:. ]{1,255}$: - maxLength: 255 - type: - - 'null' - - string - type: object + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel type: object - - const: '' - type: string - key_name: - type: - - 'null' - - string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - 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 + type: array 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + patternProperties: + ^[a-zA-Z0-9_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string type: object - type: array - status: - enum: - - ACTIVE - - BUILD - - DELETED - - ERROR - - HARD_REBOOT - - MIGRATING - - PASSWORD - - PAUSED - - REBOOT - - REBUILD - - RESCUE - - RESIZE - - REVERT_RESIZE - - SHELVED - - SHELVED_OFFLOADED - - SHUTOFF - - SOFT_DELETED - - SUSPENDED - - UNKNOWN - - VERIFY_RESIZE - type: string - tags: - items: - type: string - maxItems: 50 - type: array - tenant_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - trusted_image_certificates: - items: - type: string - type: - - array - - 'null' - updated: - format: date-time + rel: + enum: + - bookmark + - self type: string - user_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ + 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: - - OS-DCF:diskConfig - - OS-EXT-AZ:availability_zone - - OS-EXT-SRV-ATTR:hostname - - 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 + - delete_on_termination - id - - image - - key_name - - links - - locked - - locked_reason - - metadata - - name - - os-extended-volumes:volumes_attached - - pinned_availability_zone - - scheduler_hints - - status - - tags - - tenant_id - - trusted_image_certificates - - updated - - user_id type: object - - additionalProperties: false + type: array + pinned_availability_zone: + type: + - 'null' + - string + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false properties: - created: - format: date-time - type: string - id: - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - status: - const: UNKNOWN - type: string - tenant_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ + name: type: string required: - - created - - id - - links - - status - - tenant_id + - name type: object - type: array - servers_links: - items: - additionalProperties: false - properties: - href: - format: uri + type: array + server_groups: + items: + format: uuid type: string - rel: - const: next - required: - - href - - rel - type: object - maxItems: 1 - minItems: 1 - type: array + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + 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 + - server_groups + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_data + - user_id + type: object required: - - servers + - server type: object - Os_Volumes_BootListResponse: + x-openstack: + action-name: rebuild + max-ver: '2.99' + min-ver: '2.98' + ServersAction_Rebuild_20: additionalProperties: false properties: - servers: - items: - oneOf: - - additionalProperties: false + 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: - id: - format: uuid + contents: + format: base64 type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - name: + path: type: string - required: - - id - - links - - name type: object - - additionalProperties: false + 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_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: - id: - format: uuid + contents: + format: base64 type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - status: - const: UNKNOWN + path: type: string - required: - - id - - links - - status type: object - type: array - servers_links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - const: next - required: - - href - - rel - type: object - maxItems: 1 - minItems: 1 - type: array + 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: - - servers + - rebuild + summary: Rebuild Server (rebuild Action) type: object - Os_Volumes_BootShowResponse: + x-openstack: + action-name: rebuild + max-ver: '2.18' + min-ver: '2.1' + ServersAction_Rebuild_219: additionalProperties: false properties: - server: - oneOf: - - 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 - - 'null' - 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-SRV-ATTR:user_data: - format: base64 - maxLength: 65535 - type: - - 'null' - - string - OS-EXT-STS:power_state: - enum: - - - - 0 - - 1 - - 3 - - 4 - - 6 - - 7 - type: - - integer - - 'null' - OS-EXT-STS:task_state: - type: - - 'null' - - string - OS-EXT-STS:vm_state: - type: - - 'null' - - 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 - config_drive: - enum: - - '' - - - - 'False' - - 'True' - type: - - '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: - enum: - - '' - - DOWN - - MAINTENANCE - - UNKNOWN - - UP - type: string - id: - format: uuid - type: string - image: - oneOf: - - additionalProperties: false - properties: - id: - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - properties: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9_:. ]{1,255}$: - maxLength: 255 - type: - - 'null' - - string - type: object - type: object - - const: '' - type: string - key_name: - type: - - 'null' - - string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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: - enum: - - ACTIVE - - BUILD - - DELETED - - ERROR - - HARD_REBOOT - - MIGRATING - - PASSWORD - - PAUSED - - REBOOT - - REBUILD - - RESCUE - - RESIZE - - REVERT_RESIZE - - SHELVED - - SHELVED_OFFLOADED - - SHUTOFF - - SOFT_DELETED - - SUSPENDED - - UNKNOWN - - VERIFY_RESIZE + 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 - tags: - items: + 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 - maxItems: 50 - type: array - tenant_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ - type: string - trusted_image_certificates: - items: + path: type: string - type: - - array - - 'null' - updated: - format: date-time + 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_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 - user_id: + 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 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ type: string - required: - - OS-DCF:diskConfig - - OS-EXT-AZ:availability_zone - - OS-EXT-SRV-ATTR:hostname - - 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 - - scheduler_hints - - server_groups - - status - - tags - - tenant_id - - trusted_image_certificates - - updated - - user_id type: object - - additionalProperties: false - properties: - OS-EXT-AZ:availability_zone: - type: string - OS-EXT-STS:power_state: - enum: - - - - 0 - - 1 - - 3 - - 4 - - 6 - - 7 - type: - - integer - - 'null' - created: - format: date-time - type: string - 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 - id: - format: uuid - type: string - image: - oneOf: - - additionalProperties: false - properties: - id: - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - type: object - - const: '' - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - server_groups: - items: - format: uuid + 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 - maxLength: 1 - type: array - status: - const: UNKNOWN - type: string - tenant_id: - maxLength: 255 + 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_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 - pattern: ^[a-zA-Z0-9-]*$ type: string - user_id: + 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 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ type: string - required: - - OS-EXT-AZ:availability_zone - - OS-EXT-STS:power_state - - created - - flavor - - id - - image - - links - - server_groups - - status - - tenant_id - - user_id 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: - - server + - rebuild + summary: Rebuild Server (rebuild Action) 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: + action-name: rebuild + max-ver: '2.62' + min-ver: '2.57' + ServersAction_Rebuild_263: additionalProperties: false properties: - server: + 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 - OS-EXT-AZ:availability_zone: + accessIPv4: + description: |- + IPv4 address that should be used to access this server. + format: ipv4 type: string - OS-EXT-SRV-ATTR:host: - type: - - 'null' - - string - OS-EXT-SRV-ATTR:hostname: + accessIPv6: + description: |- + IPv6 address that should be used to access this server. + format: ipv6 type: string - OS-EXT-SRV-ATTR:hypervisor_hostname: - type: - - 'null' - - string - OS-EXT-SRV-ATTR:instance_name: + adminPass: + description: |- + The administrative password of the server. If you omit this parameter, the operation + generates a new password. 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: + 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 - OS-EXT-SRV-ATTR:reservation_id: + 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: - - 'null' + - boolean - string - OS-EXT-SRV-ATTR:root_device_name: + 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' - - string - OS-EXT-SRV-ATTR:user_data: + 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 - OS-EXT-STS:power_state: + 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_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: - - - - 0 - - 1 - - 3 - - 4 - - 6 - - 7 - type: - - integer - - 'null' - OS-EXT-STS:task_state: - type: - - 'null' - - string - OS-EXT-STS:vm_state: - type: - - 'null' - - string - OS-SRV-USG:launched_at: - format: date-time - type: - - 'null' - - string - OS-SRV-USG:terminated_at: - format: date-time - type: - - 'null' - - string + - AUTO + - MANUAL + type: string accessIPv4: - oneOf: - - const: '' - - format: ipv4 + description: |- + IPv4 address that should be used to access this server. + format: ipv4 type: string accessIPv6: - oneOf: - - const: '' - - format: ipv6 + description: |- + IPv6 address that should be used to access this server. + 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 - config_drive: - type: - - boolean - - 'null' - - string - created: - format: date-time + 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 - 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: + 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 - image: - oneOf: - - additionalProperties: false - properties: - id: - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - properties: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9_:. ]{1,255}$: - maxLength: 255 - type: - - 'null' - - string - type: object - type: object - - const: '' - type: string - key_name: - type: - - 'null' - - string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - locked: - type: boolean - locked_reason: - 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: - - 'null' + - boolean - string - os-extended-volumes:volumes_attached: + 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: - 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: + 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 - progress: + 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_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' - - number - scheduler_hints: - additionalProperties: true - properties: - build_near_host_ip: - oneOf: - - format: ipv4 - - format: ipv6 - type: string - cidr: - pattern: ^/[0-9a-f.:]+$ + - 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 - different_cell: - items: - type: string - type: - - array - - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: - type: - - object - - string - same_host: - items: - format: uuid - type: string - type: - - array - - string - target_cell: - format: name + 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 - 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: - enum: - - ACTIVE - - BUILD - - DELETED - - ERROR - - HARD_REBOOT - - MIGRATING - - PASSWORD - - PAUSED - - REBOOT - - REBUILD - - RESCUE - - RESIZE - - REVERT_RESIZE - - SHELVED - - SHELVED_OFFLOADED - - SHUTOFF - - SOFT_DELETED - - SUSPENDED - - UNKNOWN - - VERIFY_RESIZE - type: string - tags: - items: - type: string - maxItems: 50 - type: array - tenant_id: + name: + description: |- + The server name. + format: name maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ 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' - updated: - format: date-time - type: string - user_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ + 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 + min-ver: '2.94' + 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: - - 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 - - links - - locked - - locked_reason - - metadata - - name - - os-extended-volumes:volumes_attached - - pinned_availability_zone - - scheduler_hints - - server_groups - - status - - tags - - tenant_id - - trusted_image_certificates - - updated - - user_id + - 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: - - server + - removeFloatingIp + summary: Remove (Disassociate) Floating Ip (removeFloatingIp Action) + (DEPRECATED) type: object - Os_Volumes_BootUpdate_20: - additionalProperties: false + 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: - server: + removeSecurityGroup: additionalProperties: false + description: |- + The action to remove a security group from the server. 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 + description: |- + The security group name. minLength: 1 type: string + required: + - name type: object required: - - server + - removeSecurityGroup + summary: Remove Security Group From A Server (removeSecurityGroup Action) type: object x-openstack: - max-ver: '2.0' - min-ver: '2.0' - Os_Volumes_BootUpdate_21: + 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: - server: + rescue: additionalProperties: false + description: |- + The action to rescue a server. properties: - OS-DCF:diskConfig: - enum: - - AUTO - - MANUAL - type: string - accessIPv4: - format: ipv4 - type: string - accessIPv6: - format: ipv6 + adminPass: type: string - name: - format: name - maxLength: 255 - minLength: 1 + rescue_image_ref: + format: uuid type: string - type: object + type: + - 'null' + - object required: - - server + - rescue + summary: Rescue Server (rescue Action) type: object x-openstack: - max-ver: '2.18' - min-ver: '2.1' - Os_Volumes_BootUpdate_219: + action-name: rescue + ServersAction_RescueResponse: additionalProperties: false properties: - server: + adminPass: + type: string + 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: - OS-DCF:diskConfig: + state: + description: |- + The state of the server to be set, `active` or `error` are valid. 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 + - active + - error type: string + required: + - state type: object required: - - server + - os-resetState + summary: Reset Server State (os-resetState Action) type: object x-openstack: - max-ver: '2.89' - min-ver: '2.19' - Os_Volumes_BootUpdate_290: + action-name: os-resetState + ServersAction_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: - server: + 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 - accessIPv4: - format: ipv4 - type: string - accessIPv6: - format: ipv6 - type: string - description: - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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: - - 'null' + - integer - 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 + required: + - flavorRef type: object required: - - server + - resize + summary: Resize Server (resize Action) type: object x-openstack: - max-ver: '2.93' - min-ver: '2.90' - Os_Volumes_BootUpdate_294: + action-name: resize + 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: - 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 + resume: {} required: - - server + - resume + summary: Resume Suspended Server (resume Action) type: object x-openstack: - max-ver: '2.102' - min-ver: '2.94' - RootShowResponse: + action-name: resume + ServersAction_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: - 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: + revertResize: {} + required: + - revertResize + summary: Revert Resized Server (revertResize Action) + type: object + x-openstack: + action-name: revertResize + ServersAction_Shelve: + additionalProperties: false + description: |- + Shelves a server. - * `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. + Specify the `shelve` action in the request body. - Note + 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. - 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 + 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: - - version + - shelveOffload + summary: Shelf-Offload (Remove) Server (shelveOffload Action) type: object - ServerShowResponse: - properties: - server: - description: |- - A `server` object. - properties: - OS-DCF:diskConfig: - description: |- - Disk configuration. The value is either: + x-openstack: + action-name: shelveOffload + ServersAction_Start: + additionalProperties: false + description: |- + Starts a stopped server and changes its status to `ACTIVE`. - * `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. + Specify the `os-start` action in the request body. - **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. + **Preconditions** - **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. + The server status must be `SHUTOFF`. - Note + If the server is locked, you must have administrator privileges + to start the server. - This information is published via the metadata service and requires - application such as `cloud-init` to propagate it through to the - instance. + **Asynchronous Postconditions** - **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. + After you successfully start a server, its status changes to `ACTIVE`. - **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. + **Troubleshooting** - **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. + 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. - **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. + Normal response codes: 202 - **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. + 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: + additionalProperties: false + description: |- + Stops a running server and changes its status to `SHUTOFF`. - **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. + Specify the `os-stop` action in the request body. - **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. + **Preconditions** - **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. + The server status must be `ACTIVE` or `ERROR`. - **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: + If the server is locked, you must have administrator privileges + to stop the server. - ``` - 0: NOSTATE - 1: RUNNING - 3: PAUSED - 4: SHUTDOWN - 6: CRASHED - 7: SUSPENDED - ``` + **Asynchronous Postconditions** - **New in version 2.75** - type: integer - OS-EXT-STS:task_state: - description: |- - The task state of the instance. + 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. - **New in version 2.75** - type: string - OS-EXT-STS:vm_state: - description: |- - The VM state. + Normal response codes: 202 - **New in version 2.75** - type: string - OS-SRV-USG:launched_at: - description: |- - The date and time when the server was launched. + 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`. - The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + Specify the `suspend` action in the request body. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + 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. - For example, `2015-08-27T09:49:58-05:00`. + Normal response codes: 202 - 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`. + 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_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_Unlock_21: + additionalProperties: false + description: |- + Unlocks a locked server. - **New in version 2.75** - type: string - OS-SRV-USG:terminated_at: - description: |- - The date and time when the server was deleted. + Specify the `unlock` action in the request body. - The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + 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. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + Normal response codes: 202 - 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`. + 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`. - **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`. + Specify the `unpause` action in the request body. - **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) + 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. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + Normal response codes: 202 - 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. + 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`. - **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) + Specify the `unrescue` action in the request body. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + **Preconditions** - 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. + The server must exist. - 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. + You can only unrescue a server when its status is `RESCUE`. - **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. + **Asynchronous Postconditions** - **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. + After you successfully unrescue a server and make a + `GET /servers/​{server_id}​` + request, its status changes to `ACTIVE`. - **New in version 2.47** - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: - maxLength: 255 - type: string - type: object - x-openstack: - min-ver: '2.47' + 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 + min-ver: '2.91' + 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: + - additionalProperties: false + properties: + reservation_id: + type: string + required: + - reservation_id + - additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + enum: + - AUTO + - MANUAL + type: string + adminPass: + type: string id: - description: |- - The UUID of the server. + format: uuid 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. + additionalProperties: false properties: href: format: uri type: string rel: + enum: + - bookmark + - self type: string + required: + - href + - rel 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' + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + required: + - OS-DCF:diskConfig + - id + - links + - security_groups type: object - hostId: + required: + - server + type: object + ServersCreate_20: + additionalProperties: false + properties: + OS-SCH-HNT:scheduler_hints: + additionalProperties: true + properties: + build_near_host_ip: 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. + 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 - host_status: + cidr: 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' + 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: - - 'null' + - array - string - x-openstack: - min-ver: '2.16' - id: - description: Id of the server - format: uuid - readOnly: true - type: string - image: + different_host: 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. + 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: - - 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: + - items: + format: uuid 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: array + - format: uuid 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: + group: description: |- - One or more security groups objects. - - **New in version 2.75** - items: - properties: - name: - description: The security group name + 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. + oneOf: + - items: + format: uuid type: string - type: object - type: array - server_groups: + type: array + - format: uuid + type: string + query: description: |- - The UUIDs of the server groups to which the server belongs. Currently - this can contain at most one entry. + Schedule the server by using a custom filter in JSON format. + For example: - **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. + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - **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: + It is available when `JsonFilter` is available on cloud side. + type: + - object + - string + same_host: 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** + 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 - - '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: + - string + target_cell: description: |- - The user ID of the user who owns the server. + 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 - 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: + os:scheduler_hints: + additionalProperties: true 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. + 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. - **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. + Note - **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. + This is a top-level key in the request body, not part of the + server portion of the request body. - **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. + There are a few caveats with scheduler hints: - **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. + * 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. - **New in version 2.75** - type: string - x-openstack: - min-ver: '2.3' - OS-EXT-SRV-ATTR:root_device_name: + 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: |- - The root device name for the instance - By default, it appears in the response for administrative users only. - - **New in version 2.75** + 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 - x-openstack: - min-ver: '2.3' - OS-EXT-SRV-ATTR:user_data: + cidr: 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** + 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 - x-openstack: - min-ver: '2.3' - OS-EXT-STS:power_state: + different_cell: 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: + 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: |- - The task state of the instance. - - **New in version 2.75** - type: string - OS-EXT-STS:vm_state: + 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 VM state. - - **New in version 2.75** - type: string - OS-SRV-USG:launched_at: + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: 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): + Schedule the server by using a custom filter in JSON format. + For example: ``` - CCYY-MM-DDThh:mm:ss±hh:mm + "query": "[\">=\",\"$free_ram_mb\",1024]" ``` - 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** + 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 - OS-SRV-USG:terminated_at: + type: object + server: + additionalProperties: false + description: |- + A `server` object. + properties: + OS-DCF:diskConfig: 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`. + 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: - **New in version 2.75** + * `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. May be - automatically set by the provider. + 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. May be - automatically set by the provider. + IPv6 address that should be used to access this server. 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: + adminPass: 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** + The administrative password of the server. If you omit this parameter, the operation + generates a new password. type: string - created: + availability_zone: 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 - ``` + Key pair name. - 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. + Note - **New in version 2.19** + 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 - 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: + 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: |- - 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. + 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: - **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. + > ``` + > "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"}] + > ``` - **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. + 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. - **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: + 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: |- - 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** + 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: - - '' - - DOWN - - MAINTENANCE - - UNKNOWN - - UP - - 'null' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - NO + - No + - OFF + - ON + - Off + - On + - 'TRUE' + - true + - 'True' + - YES + - Yes + - 'false' + - no + - off + - on + - 'true' + - yes type: - - 'null' + - boolean - 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: - - '' + 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: |- - The name of associated key pair, if any. + Key pair name. - **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. + Note - **New in version 2.9** - type: boolean - x-openstack: - min-ver: '2.9' + 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: |- - A dictionary of metadata key-and-value pairs, which is maintained for backward - compatibility. + 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: |- - The server name. + 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 - os-extended-volumes:volumes_attached: + networks: description: |- - The attached volumes, if any. + 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. - **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. + 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. - **New in version 2.75** + 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: - name: - description: The security group name + 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 - server_groups: + personality: description: |- - The UUIDs of the server groups to which the server belongs. Currently - this can contain at most one entry. + 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. - **New in version 2.71** + **Available until version 2.56** items: - type: string + additionalProperties: false + properties: + contents: + format: base64 + type: string + path: + type: string + type: object type: array - x-openstack: - min-ver: '2.71' - status: + return_reservation_id: description: |- - The server status. - readOnly: true - type: string - tags: + 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: |- - A list of tags. The maximum count of tags in this list is 50. - - **New in version 2.26** + 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: - type: string + 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 - 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: + user_data: 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. + Configuration information or scripts to use upon launch. + Must be Base64 encoded. Restricted to 65535 bytes. - **New in version 2.63** - items: - type: string + 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: - - 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 + - string required: - - flavor - - id - - image + - flavorRef - 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: + ServersCreate_21: additionalProperties: false properties: - server: - additionalProperties: false - description: |- - A `server` object. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true 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: + build_near_host_ip: description: |- - IPv6 address that should be used to access this server. - format: ipv6 + 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 - name: + cidr: description: |- - The server name. - format: name - maxLength: 255 - minLength: 1 + 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 - 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: + different_cell: 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: + 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: |- - IPv4 address that should be used to access this server. - format: ipv4 - type: string - accessIPv6: + 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: |- - IPv6 address that should be used to access this server. - format: ipv6 - type: string - 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: 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. + Schedule the server by using a custom filter in JSON format. + For example: - **New in version 2.19** - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` + + It is available when `JsonFilter` is available on cloud side. type: - - 'null' + - object - string - name: + same_host: description: |- - The server name. + 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 - required: - - server - type: object - x-openstack: - max-ver: '2.89' - min-ver: '2.19' - ServerUpdate_290: - additionalProperties: false - properties: - server: - additionalProperties: false + minLength: 1 + type: string + type: object + os:scheduler_hints: + additionalProperties: true 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: + 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. - * `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: + 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: |- - IPv4 address that should be used to access this server. - format: ipv4 + 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 - accessIPv6: + cidr: description: |- - IPv6 address that should be used to access this server. - format: ipv6 + 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 - description: + different_cell: 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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: - - 'null' + - array - string - hostname: + different_host: 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 + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - This information is published via the metadata service and requires - application such as `cloud-init` to propagate it through to the - instance. + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - **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: + It is available when `JsonFilter` is available on cloud side. + type: + - object + - string + same_host: description: |- - The server name. + 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 - required: - - server - type: object - x-openstack: - max-ver: '2.93' - min-ver: '2.90' - ServerUpdate_294: - additionalProperties: false - properties: server: additionalProperties: false description: |- @@ -31313,972 +78488,1699 @@ components: 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: + adminPass: 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-._]*$ + The administrative password of the server. If you omit this parameter, the operation + generates a new password. type: string - name: + availability_zone: description: |- - The server name. + 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 - 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_Create_Image_20' - - $ref: '#/components/schemas/ServersAction_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: + 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: |- - 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. + 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: - The only supported connection type is `spice-html5`. The `type` parameter - should be set to `spice-html5`. + > ``` + > "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"}] + > ``` - Normal response codes: 200 + 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. - 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: + 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: |- - The type of SPICE console. The only valid value is `spice-html5`. + 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: - - spice-html5 + - '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 - 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: + max_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string + metadata: + additionalProperties: false description: |- - The type of VNC console. The only valid value is `novnc`. - enum: - - novnc - - xvpvnc + 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 - 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. + 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. - The only supported connect type is `rdp-html5`. The `type` parameter should - be set as `rdp-html5`. + 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. - Specify the `os-getRDPConsole` action in the request body. + 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. - Normal response codes: 200 + 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. - 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 + **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: - - novnc - - rdp-html5 - - serial - - spice-html5 - type: string - url: - description: The URL used to connect to the console. + - '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: - - type - - url + - flavorRef + - name type: object required: - - console + - server type: object x-openstack: - action-name: os-getSPICEConsole - ServersActionOs-GetvncconsoleResponse: - description: The remote console object. + max-ver: '2.18' + min-ver: '2.1' + ServersCreate_219: + additionalProperties: false properties: - console: + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - type: - description: The type of the remote console - enum: - - novnc - - rdp-html5 - - serial - - spice-html5 + 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 - url: - description: The URL used to connect to the console. + 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 - 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_Rebuild_20' - - $ref: '#/components/schemas/ServersAction_Rebuild_21' - - $ref: '#/components/schemas/ServersAction_Rebuild_219' - - $ref: '#/components/schemas/ServersAction_Rebuild_254' - - $ref: '#/components/schemas/ServersAction_Rebuild_257' - - $ref: '#/components/schemas/ServersAction_Rebuild_263' - - $ref: '#/components/schemas/ServersAction_Rebuild_290' - - $ref: '#/components/schemas/ServersAction_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. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), - conflict(409), gone(410) - properties: - resetNetwork: + 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 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`. + 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. - 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. + Note - If a server is locked, you must have administrator privileges to unshelve the server. + This is a top-level key in the request body, not part of the + server portion of the request body. - 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. + There are a few caveats with scheduler hints: - 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 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. - The behavior according to unshelve parameters will follow the below table. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - **Asynchronous Postconditions** + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - After you successfully unshelve a server, its status changes to `ACTIVE`. - The server appears on the compute node. + 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: - The shelved image is deleted from the list of images returned by an API call. + * `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: - **Troubleshooting** + > ``` + > "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"}] + > ``` - 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. + 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. - Normal response codes: 202 + 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. - 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_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. + **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. - Specify the `addFixedIp` action and the network ID in the request body. + 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. - 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. + 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. - Normal response codes: 202 + 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. - 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: + **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: |- - The network ID. - maxLength: 36 - minLength: 1 + 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: - - number + - 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: - - networkId + - flavorRef + - name type: object required: - - addFixedIp - summary: Add (Associate) Fixed Ip (addFixedIp Action) (DEPRECATED) + - server type: object x-openstack: - action-name: addFixedIp - max-ver: '2.43' - min-ver: '2.1' - ServersAction_Add_Floating_Ip_21: + max-ver: '2.31' + min-ver: '2.19' + ServersCreate_232: additionalProperties: false - description: |- - Adds a floating IP address to a server, which associates - that address with the server. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - 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. + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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. + 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. - **Preconditions** + Note - The server must exist. + This is a top-level key in the request body, not part of the + server portion of the request body. - You can only add a floating IP address to the server when its status is `ACTIVE` or `STOPPED` + There are a few caveats with scheduler hints: - Normal response codes: 202 + * 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. - 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`. + For these reasons, it is important to consult each cloud’s user + documentation to know what is available for scheduler hints. properties: - address: + build_near_host_ip: description: |- - The fixed IP address with which you want to associate the floating IP address. + 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 - fixed_address: + cidr: description: |- - The fixed IP address with which you want to associate the floating IP address. - oneOf: - - format: ipv4 - - format: ipv6 + 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 - 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. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - Error response codes: badRequest(400), unauthorized(401), forbidden(403), - itemNotFound(404), conflict(409) - properties: - addSecurityGroup: + 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: |- - The action to add a security group to a server. + A `server` object. properties: - name: + OS-DCF:diskConfig: description: |- - The security group name. + 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 - required: - - name - type: object - required: - - addSecurityGroup - summary: Add Security Group To A Server (addSecurityGroup Action) - type: object - x-openstack: - action-name: addSecurityGroup - ServersAction_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** + 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: - 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: + > ``` + > "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"}] + > ``` - Note that the cloud provider may still need to cleanup any orphaned resources - on the source hypervisor. + 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. - Normal response codes: 204 + 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. - 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_Create_Backup_20: - additionalProperties: false - properties: - createBackup: - additionalProperties: false - description: |- - The action. - properties: - backup_type: + **New in version 2.19** + maxLength: 255 + minLength: 0 + pattern: ^[\ + -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + type: + - 'null' + - string + flavorRef: description: |- - The type of the backup, for example, `daily`. - type: string - metadata: - additionalProperties: false + 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: |- - 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 + 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 - type: object - name: + - maxLength: 0 + type: string + key_name: description: |- - The name of the image to be backed up. - format: name_with_leading_trailing_spaces + 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 - rotation: - description: |- - The rotation of the back up image, the oldest image will be removed when image count - exceed the rotation count. + max_count: minLength: 1 - minimum: 0 + minimum: 1 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: |- @@ -32289,153 +80191,637 @@ components: maxLength: 255 type: string type: object + min_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string name: description: |- - The name of the image to be backed up. + 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 - rotation: + networks: 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]*$ + 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: - - integer + - 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: - - backup_type + - flavorRef - name - - rotation type: object required: - - createBackup - summary: Create Server Back Up (createBackup Action) + - server type: object x-openstack: - action-name: createBackup - max-ver: '2.0' - min-ver: '2.1' - ServersAction_Create_Image_20: + max-ver: '2.32' + min-ver: '2.32' + ServersCreate_233: additionalProperties: false properties: - createImage: - additionalProperties: false - description: |- - The action to create a snapshot of the image or - the volume(s) of the server. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - metadata: - additionalProperties: false + build_near_host_ip: 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 + 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 - type: object - name: + group: description: |- - The display name of an Image. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - 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 - 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_Create_Image_21: - additionalProperties: false - properties: - createImage: - additionalProperties: false + os:scheduler_hints: + additionalProperties: true description: |- - The action to create a snapshot of the image or - the volume(s) of the server. + 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: - metadata: - additionalProperties: false + build_near_host_ip: 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 + 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 - type: object - name: + group: description: |- - The display name of an Image. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - 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 - 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_Evacuate_20: - additionalProperties: false - properties: - evacuate: + server: additionalProperties: false description: |- - The action to evacuate a server to another host. + A `server` object. properties: - adminPass: + OS-DCF:diskConfig: 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. + 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 - host: + accessIPv4: 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. + 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 - pattern: ^[a-zA-Z0-9-._]*$ type: string - onSharedStorage: + 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: |- - Server on shared storage. + 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: - Note + > ``` + > "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"}] + > ``` - Starting since version 2.14, Nova automatically detects - whether the server is on shared storage or not. - Therefore this parameter was removed. + 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. - **Available until version 2.13** + 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' @@ -32462,93 +80848,172 @@ components: 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: 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 + A free form description of the server. Limited to 255 characters + in length. Before microversion 2.19 this was set to the server + name. - 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. + **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 - 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: + max_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string + metadata: + additionalProperties: false 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. + 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 - force: + networks: description: |- - Force an evacuation by not verifying the provided destination host by the - scheduler. - - Warning + 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. - 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. + 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. - 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. + 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. - **New in version 2.29** + 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.67** + **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' @@ -32575,264 +81040,504 @@ components: 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: + security_groups: 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: + 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: |- - 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-._]*$ + 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: - - evacuate - summary: Evacuate Server (evacuate Action) + - server type: object x-openstack: - action-name: evacuate - max-ver: '2.94' - min-ver: '2.68' - ServersAction_Evacuate_295: + max-ver: '2.36' + min-ver: '2.33' + ServersCreate_237: additionalProperties: false properties: - evacuate: - additionalProperties: false - description: |- - The action to evacuate a server to another host. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - adminPass: + build_near_host_ip: 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. + 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 - host: + cidr: description: |- - The name or ID of the host to which the server is evacuated. - If you omit this parameter, the scheduler chooses a host. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Warning + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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. + 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 - 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. + 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. - 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. + Note - Normal response codes: 202 + This is a top-level key in the request body, not part of the + server portion of the request body. - 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. + There are a few caveats with scheduler hints: - Specify the `injectNetworkInfo` action in the request body. + * 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. - Policy defaults enable only users with the administrative role to - perform this operation. Cloud providers can change these permissions - through the `policy.yaml` file. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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: + 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: |- - The action to lock a server. - This parameter can be `null`. - Up to microversion 2.73, this parameter should be `null`. + A `server` object. properties: - locked_reason: + 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 - 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. + 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: - 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. + > ``` + > "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"}] + > ``` - Normal response codes: 202 + 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. - 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: + 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: |- - 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** + 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' @@ -32859,89 +81564,168 @@ components: type: - boolean - string - disk_over_commit: + description: 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. + A free form description of the server. Limited to 255 characters + in length. Before microversion 2.19 this was set to the server + name. - **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 + **New in version 2.19** + maxLength: 255 + minLength: 0 + pattern: ^[\ + -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ type: - - boolean + - 'null' - string - host: + flavorRef: 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. + 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 - pattern: ^[a-zA-Z0-9-._]*$ + type: string + max_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ type: - - 'null' + - integer - 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: + metadata: + additionalProperties: false 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. + 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. - **New in version 2.25** + 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' @@ -32959,7 +81743,6 @@ components: - 'True' - YES - Yes - - auto - 'false' - no - off @@ -32969,366 +81752,585 @@ components: type: - boolean - string - host: + security_groups: description: |- - The host to which to migrate the server. If this parameter is `None`, - the scheduler chooses a host. + 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. - Warning + Note - 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 + 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: - - block_migration - - host + - flavorRef + - name + - networks type: object required: - - os-migrateLive - summary: Live-Migrate Server (os-migrateLive Action) + - server type: object x-openstack: - action-name: os-migrateLive - max-ver: '2.29' - min-ver: '2.25' - ServersAction_Migrate_Live_230: + max-ver: '2.41' + min-ver: '2.37' + ServersCreate_242: additionalProperties: false properties: - os-migrateLive: - additionalProperties: false - description: |- - The action. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - block_migration: + build_near_host_ip: 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: + 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: |- - 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 + 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: - - boolean + - array - string - host: + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: description: |- - The host to which to migrate the server. If this parameter is `None`, - the scheduler chooses a host. + Schedule the server by using a custom filter in JSON format. + For example: - Warning + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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-._]*$ + It is available when `JsonFilter` is available on cloud side. type: - - 'null' + - object - 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: + same_host: 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 + 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: - - boolean + - array - string - host: + target_cell: 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. + 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 - pattern: ^[a-zA-Z0-9-._]*$ - type: - - 'null' - - string - required: - - block_migration - - host + type: string 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_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. + 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. - You can only *SOFT* reboot a server when its status is `ACTIVE`. + Note - You can only *HARD* reboot a server when its status is one of: + This is a top-level key in the request body, not part of the + server portion of the request body. - If the server is locked, you must have administrator privileges - to reboot the server. + There are a few caveats with scheduler hints: - **Asynchronous Postconditions** + * 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. - After you successfully reboot a server, its status changes to `ACTIVE`. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), - conflict(409) - properties: - reboot: - additionalProperties: false - description: |- - The action to reboot a server. - properties: - type: + It is available when `JsonFilter` is available on cloud side. + type: + - object + - string + same_host: 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 + 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 - required: - - type type: object - required: - - reboot - summary: Reboot Server (reboot Action) - type: object - x-openstack: - action-name: reboot - ServersAction_Rebuild_20: - additionalProperties: false - properties: - rebuild: + server: additionalProperties: false description: |- - The action to rebuild a server. + 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. + 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: - - AUTO - - MANUAL - type: string - accessIPv4: - description: |- - IPv4 address that should be used to access this server. - format: ipv4 - type: string - accessIPv6: + - '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: |- - IPv6 address that should be used to access this server. - format: ipv6 - type: string - adminPass: + 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 administrative password of the server. If you omit this parameter, the operation - generates a new password. - type: string + 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 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 + 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: |- @@ -33339,13 +82341,89 @@ components: maxLength: 255 type: string type: object + min_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string name: description: |- - The server name. - format: name_with_leading_trailing_spaces + 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 @@ -33363,16 +82441,14 @@ components: type: string type: object type: array - preserve_ephemeral: + return_reservation_id: 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. + 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' @@ -33399,163 +82475,268 @@ components: 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: - - imageRef + - flavorRef + - name + - networks type: object required: - - rebuild - summary: Rebuild Server (rebuild Action) + - server type: object x-openstack: - action-name: rebuild - max-ver: '2.0' - min-ver: '2.0' - ServersAction_Rebuild_21: + max-ver: '2.51' + min-ver: '2.42' + ServersCreate_252: additionalProperties: false properties: - rebuild: - additionalProperties: false - description: |- - The action to rebuild a server. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true 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: + build_near_host_ip: description: |- - IPv4 address that should be used to access this server. - format: ipv4 + 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 - accessIPv6: + cidr: description: |- - IPv6 address that should be used to access this server. - format: ipv6 + 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 - adminPass: + different_cell: description: |- - The administrative password of the server. If you omit this parameter, the operation - generates a new password. - type: string - imageRef: + 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: |- - 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 + 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: |- - 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 + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid type: string - type: object - name: + query: description: |- - The server name. + 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 - 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. + 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. - **Available until version 2.56** + 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: - additionalProperties: false - properties: - contents: - format: base64 + 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 - path: + 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. + oneOf: + - items: + format: uuid type: string - type: object - type: array - preserve_ephemeral: + type: array + - format: uuid + type: string + query: description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + Schedule the server by using a custom filter in JSON format. + For example: - Note + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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 + It is available when `JsonFilter` is available on cloud side. type: - - boolean + - object - string - required: - - imageRef + 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 - required: - - rebuild - summary: Rebuild Server (rebuild Action) - type: object - x-openstack: - action-name: rebuild - max-ver: '2.18' - min-ver: '2.1' - ServersAction_Rebuild_219: - additionalProperties: false - properties: - rebuild: + server: additionalProperties: false description: |- - The action to rebuild a server. + A `server` object. properties: OS-DCF:diskConfig: description: |- @@ -33593,78 +82774,211 @@ components: 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: + availability_zone: description: |- - The server name. + 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 - 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** + block_device_mapping: items: additionalProperties: false properties: - contents: - format: base64 + connection_info: + maxLength: 16777215 type: string - path: + 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 - preserve_ephemeral: + block_device_mapping_v2: description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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: - Note + > ``` + > "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"}] + > ``` - This only works with baremetal servers provided by - Ironic. Passing it to any other server instance results in a - fault and will prevent the rebuild from happening. + In 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' @@ -33691,61 +83005,6 @@ components: 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_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 @@ -33760,40 +83019,41 @@ components: type: - 'null' - string - imageRef: + flavorRef: 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: + 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: |- - 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** + 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: - - type: 'null' - - maxLength: 255 - minLength: 1 + - 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: |- @@ -33803,14 +83063,90 @@ components: ^[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 + 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 @@ -33828,16 +83164,14 @@ components: type: string type: object type: array - preserve_ephemeral: + return_reservation_id: 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. + 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' @@ -33864,24 +83198,288 @@ components: 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: - - imageRef + - flavorRef + - name + - networks type: object required: - - rebuild - summary: Rebuild Server (rebuild Action) + - server type: object x-openstack: - action-name: rebuild max-ver: '2.56' - min-ver: '2.54' - ServersAction_Rebuild_257: + min-ver: '2.52' + ServersCreate_257: additionalProperties: false properties: - rebuild: + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - 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. + oneOf: + - items: + format: uuid + type: string + type: array + - 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: |- - The action to rebuild a server. + A `server` object. properties: OS-DCF:diskConfig: description: |- @@ -33919,6 +83517,237 @@ components: 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 @@ -33933,40 +83762,41 @@ components: type: - 'null' - string - imageRef: + flavorRef: 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: + 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: |- - 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** + 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: - - type: 'null' - - maxLength: 255 - minLength: 1 + - 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: |- @@ -33977,23 +83807,97 @@ components: maxLength: 255 type: string type: object + min_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string name: description: |- - The server name. + 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 - preserve_ephemeral: + networks: description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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. - Note + 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. - 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. + 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' @@ -34020,225 +83924,288 @@ components: 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 rebuild. + Configuration information or scripts to use upon launch. Must be Base64 encoded. Restricted to 65535 bytes. - If `null` is specified, the existing user_data is unset. - **New in version 2.57** + 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 + type: string required: - - imageRef + - flavorRef + - name + - networks type: object required: - - rebuild - summary: Rebuild Server (rebuild Action) + - server type: object x-openstack: - action-name: rebuild max-ver: '2.62' min-ver: '2.57' - ServersAction_Rebuild_263: + ServersCreate_263: additionalProperties: false properties: - rebuild: - additionalProperties: false - description: |- - The action to rebuild a server. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true 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: + build_near_host_ip: description: |- - IPv6 address that should be used to access this server. - format: ipv6 + 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 - adminPass: + cidr: description: |- - The administrative password of the server. If you omit this parameter, the operation - generates a new password. + 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 - description: + different_cell: 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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: - - 'null' + - array - 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: + different_host: 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** + 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: - - type: 'null' - - maxLength: 255 - minLength: 1 + - items: + format: uuid + type: string + type: array + - format: uuid type: string - metadata: - additionalProperties: false + group: 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 + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid type: string - type: object - name: + query: description: |- - The server name. + 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 - preserve_ephemeral: - description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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 + 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 + 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: - - boolean + - array - string - trusted_image_certificates: + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: 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. + Schedule the server by using a custom filter in JSON format. + For example: - If `null` is specified, the existing trusted certificate IDs are either - unset or reset to the configured defaults. + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - **New in version 2.63** + 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: - minLength: 1 + format: uuid 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 + 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 - required: - - rebuild - summary: Rebuild Server (rebuild Action) - type: object - x-openstack: - action-name: rebuild - max-ver: '2.89' - min-ver: '2.63' - ServersAction_Rebuild_290: - additionalProperties: false - properties: - rebuild: + server: additionalProperties: false description: |- - The action to rebuild a server. + A `server` object. properties: OS-DCF:diskConfig: description: |- @@ -34276,99 +84243,211 @@ components: 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: + availability_zone: description: |- - The server name. + 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 - preserve_ephemeral: + 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: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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: - Note + > ``` + > "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"}] + > ``` - This only works with baremetal servers provided by - Ironic. Passing it to any other server instance results in a - fault and will prevent the rebuild from happening. + In 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' @@ -34395,94 +84474,6 @@ components: 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_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 @@ -34497,58 +84488,41 @@ components: type: - 'null' - string - hostname: + flavorRef: 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 + The flavor reference, as an ID (including a UUID) or full URL, + for the flavor for your server instance. minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ - type: string + type: + - integer + - 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** + 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: - - type: 'null' - - maxLength: 255 - minLength: 1 + - 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: |- @@ -34559,23 +84533,97 @@ components: maxLength: 255 type: string type: object + min_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string name: description: |- - The server name. + 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 - preserve_ephemeral: + networks: description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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. - Note + 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. - 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. + 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' @@ -34602,16 +84650,53 @@ components: 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 - 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. + create requests if allowed by policy, and is not supported for + volume-backed instances. **New in version 2.63** items: @@ -34625,246 +84710,246 @@ components: uniqueItems: true user_data: description: |- - Configuration information or scripts to use upon rebuild. + Configuration information or scripts to use upon launch. Must be Base64 encoded. Restricted to 65535 bytes. - If `null` is specified, the existing user_data is unset. - **New in version 2.57** + 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 + type: string required: - - imageRef + - flavorRef + - name + - networks type: object required: - - rebuild - summary: Rebuild Server (rebuild Action) + - server type: object x-openstack: - action-name: rebuild - max-ver: '2.0' - min-ver: '2.94' - ServersAction_Remove_Fixed_Ip_21: + max-ver: '2.66' + min-ver: '2.63' + ServersCreate_267: 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. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - address: + build_near_host_ip: description: |- - The IP address. + 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 - 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: + cidr: description: |- - The floating IP address. - oneOf: - - format: ipv4 - - format: ipv6 + 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 - 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. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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: + It is available when `JsonFilter` is available on cloud side. + type: + - object + - string + same_host: description: |- - The security group name. + 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 - 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. + 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. - 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. + Note - **Asynchronous Postconditions** + This is a top-level key in the request body, not part of the + server portion of the request body. - After you successfully rescue a server and make a `GET - /servers/​{server_id}​` request, its status changes to `RESCUE`. + There are a few caveats with scheduler hints: - Normal response codes: 200 + * 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. - 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. + For these reasons, it is important to consult each cloud’s user + documentation to know what is available for scheduler hints. properties: - adminPass: - type: string - rescue_image_ref: - format: uuid + 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 - 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: + cidr: description: |- - The state of the server to be set, `active` or `error` are valid. - enum: - - active - - error + 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 - required: - - state - type: object - required: - - os-resetState - summary: Reset Server State (os-resetState Action) - type: object - x-openstack: - action-name: os-resetState - ServersAction_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. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - Error response codes: badRequest(400), unauthorized(401), forbidden(403), - itemNotFound(404), conflict(409) - properties: - resize: + 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: |- - The action to resize a server. + A `server` object. properties: OS-DCF:diskConfig: description: |- @@ -34887,534 +84972,516 @@ components: - AUTO - MANUAL type: string - flavorRef: + accessIPv4: 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. + 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: - - integer - - string - required: - - flavorRef - type: object - required: - - resize - summary: Resize Server (resize Action) - type: object - x-openstack: - action-name: resize - 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_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_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: - 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: - 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_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_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`. + 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: - **Asynchronous Postconditions** + > ``` + > "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"}] + > ``` - After you successfully unrescue a server and make a - `GET /servers/​{server_id}​` - request, its status changes to `ACTIVE`. + 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. - Normal response codes: 202 + 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. - 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 + **New in version 2.19** 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: + minLength: 0 + pattern: ^[\ + -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ 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: + flavorRef: 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 + 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 - 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 + - maxLength: 0 type: string - id: - description: |- - The UUID of the server. - format: uuid - readOnly: true + 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 - 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. + 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. - **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. + 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: - href: - format: uri + fixed_ip: + oneOf: + - format: ipv4 + - format: ipv6 type: string - rel: + port: + format: uuid + type: + - 'null' + - string + tag: + maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ type: string - type: object - type: array - security_groups: - description: |- - One or more security groups objects. - items: - properties: - name: - description: The security group name + uuid: + format: uuid 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. + - 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: - - reservation_id + - flavorRef + - name + - networks type: object - ServersCreate_20: + required: + - server + type: object + x-openstack: + max-ver: '2.73' + min-ver: '2.67' + ServersCreate_274: additionalProperties: false properties: OS-SCH-HNT:scheduler_hints: @@ -35672,14 +85739,10 @@ components: 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 + 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 @@ -35846,6 +85909,11 @@ components: - snapshot - volume type: string + tag: + maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string uuid: maxLength: 255 minLength: 1 @@ -35864,6 +85932,12 @@ components: type: - integer - string + volume_type: + maxLength: 255 + minLength: 0 + type: + - 'null' + - string type: object type: array config_drive: @@ -35900,6 +85974,20 @@ components: 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, @@ -35908,6 +85996,28 @@ components: 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. @@ -35921,14 +86031,10 @@ components: 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 + 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 @@ -35958,14 +86064,10 @@ components: - 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 + 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 @@ -36008,45 +86110,34 @@ components: 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 + 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 @@ -36092,19 +86183,53 @@ components: 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 + 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. @@ -36116,20 +86241,19 @@ components: input validation, it isn’t allowed in Nova v2.1 API. format: base64 maxLength: 65535 - type: - - 'null' - - string + type: string required: - flavorRef - name + - networks type: object required: - server type: object x-openstack: - max-ver: '2.0' - min-ver: '2.0' - ServersCreate_21: + max-ver: '2.89' + min-ver: '2.74' + ServersCreate_290: additionalProperties: false properties: OS-SCH-HNT:scheduler_hints: @@ -36557,6 +86681,11 @@ components: - snapshot - volume type: string + tag: + maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string uuid: maxLength: 255 minLength: 1 @@ -36575,6 +86704,12 @@ components: type: - integer - string + volume_type: + maxLength: 255 + minLength: 0 + type: + - 'null' + - string type: object type: array config_drive: @@ -36611,6 +86746,20 @@ components: 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, @@ -36619,6 +86768,46 @@ components: 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. @@ -36708,48 +86897,37 @@ components: 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 + 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 @@ -36804,6 +86982,44 @@ components: 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. @@ -36819,14 +87035,15 @@ components: required: - flavorRef - name + - networks type: object required: - server type: object x-openstack: - max-ver: '2.18' - min-ver: '2.1' - ServersCreate_219: + max-ver: '2.93' + min-ver: '2.90' + ServersCreate_294: additionalProperties: false properties: OS-SCH-HNT:scheduler_hints: @@ -37254,6 +87471,11 @@ components: - snapshot - volume type: string + tag: + maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string uuid: maxLength: 255 minLength: 1 @@ -37272,6 +87494,12 @@ components: type: - integer - string + volume_type: + maxLength: 255 + minLength: 0 + type: + - 'null' + - string type: object type: array config_drive: @@ -37330,6 +87558,46 @@ components: 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. @@ -37422,45 +87690,34 @@ components: 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 + 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 @@ -37515,6 +87772,44 @@ components: 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. @@ -37530,8410 +87825,6782 @@ components: required: - flavorRef - name + - networks type: object required: - server type: object x-openstack: - max-ver: '2.31' - min-ver: '2.19' - ServersCreate_232: + min-ver: '2.94' + ServersDetailDetailResponse_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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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 + OS-EXT-AZ:availability_zone: + type: string + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: + type: string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time 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. - oneOf: - - items: - format: uuid + details: type: string - type: array - - 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 + message: + type: string + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: 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: + id: + format: uuid 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 + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' 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. - oneOf: - - items: - format: uuid + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + metadata: + additionalProperties: false + patternProperties: + ^.+$: type: string - type: array - - 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: object + name: + type: + - 'null' + - string + os-extended-volumes:volumes_attached: + items: + additionalProperties: false + properties: + id: + type: string + required: + - id + type: object + type: array + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE 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 + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - flavor + - hostId + - id + - image + - key_name + - links + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.2' + min-ver: '2.1' + ServersDetailDetailResponse_2100: + additionalProperties: false + properties: + servers: 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 + A list of `server` objects. + items: + oneOf: + - additionalProperties: false properties: - connection_info: - maxLength: 16777215 + OS-DCF:diskConfig: 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). + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: enum: - - '0' - - '1' - - 'FALSE' - - false + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - - 'False' - - NO - - No - - OFF - - ON - - Off - - On - - 'TRUE' - - true - 'True' - - YES - - Yes - - 'false' - - no - - off - - on - - 'true' - - yes type: - - boolean + - 'null' - string - device_name: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + 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 - virtual_name: - maxLength: 255 + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP type: string - volume_id: + id: format: uuid type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + properties: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + type: object + - const: '' + type: string + key_name: type: - - integer + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + locked_reason: + type: + - 'null' - 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]+$ + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: 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 + 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: - - boolean + - 'null' - 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: + 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: + oneOf: + - items: + format: uuid + type: string + type: array + - 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 + status: enum: - - blank - - image - - snapshot - - volume - type: string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - uuid: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: 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 + pattern: ^[a-zA-Z0-9-]*$ type: string - port: - format: uuid + trusted_image_certificates: + items: + type: string type: + - array - '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 + updated: + format: date-time type: string - path: + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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 + required: + - OS-DCF:diskConfig + - OS-EXT-AZ:availability_zone + - OS-EXT-SRV-ATTR:hostname + - 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 + - scheduler_hints + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time + type: string + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string + required: + - created + - id + - links + - status + - tenant_id 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 + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.32' - min-ver: '2.32' - ServersCreate_233: + min-ver: '2.100' + ServersDetailDetailResponse_216: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: 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: + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - 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: + 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + fault: 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 + code: + type: integer + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + details: type: string - source_type: - enum: - - blank - - image - - snapshot - - volume + message: type: string - uuid: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._-]*$ + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: type: string - virtual_name: - maxLength: 255 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: + type: string + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' type: string - volume_id: - format: uuid + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: 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: + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.18' + min-ver: '2.16' + ServersDetailDetailResponse_219: + additionalProperties: false + properties: + servers: + description: |- + A list of `server` objects. + items: + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: 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 + code: + type: integer + created: + format: date-time type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + details: type: string - uuid: + message: type: string + required: + - code + - created + - message 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: + flavor: additionalProperties: false properties: - contents: - format: base64 - type: string - path: + id: type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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: + hostId: + type: string + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.36' - min-ver: '2.33' - ServersCreate_237: + max-ver: '2.25' + min-ver: '2.19' + ServersDetailDetailResponse_226: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - 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: + 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: 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 + code: + type: integer + created: + format: date-time type: string - virtual_name: - maxLength: 255 + details: type: string - volume_id: - format: uuid + message: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - code + - created + - message 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: + flavor: 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 + id: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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 + hostId: + type: string + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false properties: - fixed_ip: - oneOf: - - format: ipv4 - - format: ipv6 - type: string - port: - format: uuid - type: - - 'null' - - string - uuid: + id: format: uuid type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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: + - const: '' 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: + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tags + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.41' - min-ver: '2.37' - ServersCreate_242: + max-ver: '2.46' + min-ver: '2.26' + ServersDetailDetailResponse_23: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: 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: + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + fault: 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 + code: + type: integer + created: + format: date-time type: string - virtual_name: - maxLength: 255 + details: type: string - volume_id: - format: uuid + message: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - code + - created + - message 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: + flavor: 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 + id: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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 + hostId: + type: string + id: + format: uuid + type: string + image: + oneOf: + - 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: + id: format: uuid type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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: + - const: '' 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: + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - flavor + - hostId + - id + - image + - key_name + - links + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.51' - min-ver: '2.42' - ServersCreate_252: + max-ver: '2.8' + min-ver: '2.3' + ServersDetailDetailResponse_247: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: 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 + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - 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: + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: 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._-]*$ + code: + type: integer + created: + format: date-time type: string - virtual_name: - maxLength: 255 + details: type: string - volume_id: - format: uuid + message: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - code + - created + - message 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: + flavor: + additionalProperties: false + properties: + disk: + type: integer + ephemeral: + type: integer + extra_specs: additionalProperties: false - properties: - fixed_ip: - oneOf: - - format: ipv4 - - format: ipv6 - type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + patternProperties: + ^.+$: type: string - uuid: + 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: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: format: uuid type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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 + - const: '' 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: + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: + maxLength: 255 minLength: 1 - pattern: ^[^,/]*$ + pattern: ^[a-zA-Z0-9-]*$ 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 + updated: + format: date-time + type: 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tags + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.56' - min-ver: '2.52' - ServersCreate_257: + max-ver: '2.62' + min-ver: '2.47' + ServersDetailDetailResponse_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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: 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: + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: 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._-]*$ + code: + type: integer + created: + format: date-time type: string - virtual_name: - maxLength: 255 + details: type: string - volume_id: - format: uuid + message: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - code + - created + - message 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: + flavor: + additionalProperties: false + properties: + disk: + type: integer + ephemeral: + type: integer + extra_specs: additionalProperties: false - properties: - fixed_ip: - oneOf: - - format: ipv4 - - format: ipv6 - type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + patternProperties: + ^.+$: type: string - uuid: + 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: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: format: uuid type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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: + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: + maxLength: 255 minLength: 1 - pattern: ^[^,/]*$ + pattern: ^[a-zA-Z0-9-]*$ + type: string + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time + type: 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + type: array + servers_links: + items: + additionalProperties: false + properties: + href: + format: uri 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 + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array required: - - server + - servers type: object x-openstack: - max-ver: '2.62' - min-ver: '2.57' - ServersCreate_263: + max-ver: '2.68' + min-ver: '2.63' + ServersDetailDetailResponse_269: 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 + servers: + description: |- + A list of `server` objects. + items: + oneOf: + - additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid + OS-EXT-AZ:availability_zone: type: string - type: array - - 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 + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: type: string - type: array - - 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 + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - 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). + 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 + 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 + - 'null' - string - device_name: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + 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 - virtual_name: - maxLength: 255 + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP type: string - volume_id: + id: format: uuid type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: type: - - integer + - 'null' - 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]+$ + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: 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 + 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 + progress: type: - - boolean - - string - destination_type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: enum: - - local - - volume + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - device_name: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: 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 + pattern: ^[a-zA-Z0-9-]*$ type: string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time type: string - uuid: + user_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9._-]*$ + pattern: ^[a-zA-Z0-9-]*$ type: string - virtual_name: - maxLength: 255 + 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time type: string - volume_id: + 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 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string + required: + - created + - id + - links + - status + - tenant_id 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: array + servers_links: + items: + additionalProperties: false + properties: + href: + format: uri 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 + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array required: - - server + - servers type: object x-openstack: - max-ver: '2.66' - min-ver: '2.63' - ServersCreate_267: + max-ver: '2.72' + min-ver: '2.69' + ServersDetailDetailResponse_273: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + servers: 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 + A list of `server` objects. + items: + oneOf: + - additionalProperties: false properties: - connection_info: - maxLength: 16777215 + OS-DCF:diskConfig: 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 + OS-EXT-AZ:availability_zone: + type: string + OS-EXT-SRV-ATTR:host: type: - - boolean + - 'null' - 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 + OS-EXT-SRV-ATTR:hostname: type: string - volume_id: - format: uuid + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: type: - integer + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - 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]+$ + OS-EXT-SRV-ATTR:reservation_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:root_device_name: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - string + OS-SRV-USG:launched_at: + format: date-time + type: + - 'null' + - string + OS-SRV-USG:terminated_at: + format: date-time type: - - integer - 'null' - string - connection_info: - maxLength: 16777215 + accessIPv4: + oneOf: + - const: '' + - format: ipv4 type: string - delete_on_termination: + 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 + 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 + - 'null' - 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 + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + 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 - source_type: + host_status: 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 + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP type: string - volume_id: + id: format: uuid type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: type: - - integer + - 'null' - string - volume_type: - maxLength: 255 - minLength: 0 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + locked_reason: 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: + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + 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_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 + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - 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 + created: + format: date-time + type: string + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string + required: + - created + - id + - links + - status + - tenant_id 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: array + servers_links: + items: + additionalProperties: false + properties: + href: + format: uri 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 + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array required: - - server + - servers type: object x-openstack: - max-ver: '2.73' - min-ver: '2.67' - ServersCreate_274: + max-ver: '2.89' + min-ver: '2.73' + ServersDetailDetailResponse_29: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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 + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time 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. - oneOf: - - items: - format: uuid + details: type: string - type: array - - 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 + message: + type: string + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: 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: + id: + format: uuid 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 + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' 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. - oneOf: - - items: - format: uuid + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: type: string - type: array - - 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: 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE 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 + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.15' + min-ver: '2.9' + ServersDetailDetailResponse_290: + additionalProperties: false + properties: + servers: 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 + A list of `server` objects. + items: + oneOf: + - additionalProperties: false properties: - connection_info: - maxLength: 16777215 + OS-DCF:diskConfig: 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 + OS-EXT-AZ:availability_zone: + type: string + OS-EXT-SRV-ATTR:host: type: - - boolean + - 'null' - 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 + OS-EXT-SRV-ATTR:hostname: type: string - volume_id: - format: uuid + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: type: - integer + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - 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]+$ + OS-EXT-SRV-ATTR:reservation_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:root_device_name: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 type: - integer - 'null' + OS-EXT-STS:task_state: + type: + - 'null' - string - connection_info: - maxLength: 16777215 + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - delete_on_termination: + 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 + 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 + - '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: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + locked_reason: + type: + - 'null' - string - destination_type: + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: enum: - - local - - volume + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - device_name: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ - type: string - device_type: - maxLength: 255 + pattern: ^[a-zA-Z0-9-]*$ type: string - disk_bus: - maxLength: 255 + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time type: string - guest_format: + user_id: maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - image_id: - format: uuid + required: + - OS-DCF:diskConfig + - OS-EXT-AZ:availability_zone + - OS-EXT-SRV-ATTR:hostname + - 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 + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time type: string - no_device: {} - snapshot_id: + id: format: uuid type: string - source_type: - enum: - - blank - - image - - snapshot - - volume - type: string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN type: string - uuid: + tenant_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9._-]*$ + pattern: ^[a-zA-Z0-9-]*$ type: string - virtual_name: - maxLength: 255 + required: + - created + - id + - links + - status + - tenant_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.95' + min-ver: '2.90' + ServersDetailDetailResponse_296: + additionalProperties: false + properties: + servers: + description: |- + A list of `server` objects. + items: + oneOf: + - additionalProperties: false + properties: + OS-DCF:diskConfig: type: string - volume_id: - format: uuid + OS-EXT-AZ:availability_zone: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + 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 + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - string - volume_type: - maxLength: 255 - minLength: 0 + OS-EXT-SRV-ATTR:reservation_id: 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: + OS-EXT-SRV-ATTR:root_device_name: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: additionalProperties: false properties: - fixed_ip: - oneOf: - - format: ipv4 - - format: ipv6 + code: + type: integer + created: + format: date-time type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + details: type: string - uuid: - format: uuid + 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: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + 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 - 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 + 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 + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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 + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time 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. - oneOf: - - items: - format: uuid + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - type: array - - 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 + required: + - OS-DCF:diskConfig + - OS-EXT-AZ:availability_zone + - OS-EXT-SRV-ATTR:hostname + - 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 + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time 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. - oneOf: - - items: + id: format: uuid type: string - type: array - - 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 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + required: + - created + - id + - links + - status + - tenant_id + type: object + type: array + servers_links: + items: + additionalProperties: false + properties: + href: + format: uri 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 + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + required: + - servers + type: object + x-openstack: + max-ver: '2.97' + min-ver: '2.96' + ServersDetailDetailResponse_298: + additionalProperties: false + properties: + servers: 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 + A list of `server` objects. + items: + oneOf: + - additionalProperties: false properties: - connection_info: - maxLength: 16777215 + OS-DCF:diskConfig: 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). + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: enum: - - '0' - - '1' - - 'FALSE' - - false + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - - 'False' - - NO - - No - - OFF - - ON - - Off - - On - - 'TRUE' - - true - 'True' - - YES - - Yes - - 'false' - - no - - off - - on - - 'true' - - yes type: - - boolean + - 'null' - string - device_name: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + 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 - virtual_name: - maxLength: 255 + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP type: string - volume_id: + id: format: uuid type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + properties: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + type: object + - const: '' + type: string + key_name: type: - - integer + - 'null' - 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]+$ + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + 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: - - 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 + progress: type: - - boolean - - string - destination_type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: enum: - - local - - volume + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - device_name: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ + pattern: ^[a-zA-Z0-9-]*$ type: string - device_type: - maxLength: 255 + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time type: string - disk_bus: + user_id: maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - guest_format: - maxLength: 255 + required: + - OS-DCF:diskConfig + - OS-EXT-AZ:availability_zone + - OS-EXT-SRV-ATTR:hostname + - 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 + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time type: string - image_id: + id: format: uuid type: string - no_device: {} - snapshot_id: + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + required: + - created + - id + - links + - status + - tenant_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.99' + min-ver: '2.98' + ServersDiagnosticsIndexResponse_21: + additionalProperties: true + properties: {} + required: [] + type: object + x-openstack: + max-ver: '2.47' + min-ver: '2.1' + ServersDiagnosticsIndexResponse_248: + additionalProperties: false + properties: + config_drive: + description: |- + Indicates whether or not a config drive was used for this server. + + **New in version 2.48** + type: boolean + 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: + additionalProperties: false + properties: + id: + type: + - integer + - 'null' + time: + type: + - integer + - 'null' + utilisation: + type: + - integer + - 'null' + required: + - id + - time + - utilisation + type: object + type: array + 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: + additionalProperties: false + properties: + errors_count: + type: + - integer + - 'null' + read_bytes: + type: + - integer + - 'null' + read_requests: + type: + - integer + - 'null' + write_bytes: + type: + - integer + - 'null' + write_requests: + type: + - integer + - 'null' + required: + - errors_count + - read_bytes + - read_requests + - write_bytes + - write_requests + type: object + type: array + driver: + description: |- + The driver on which the VM is running. Possible values are: + + * `libvirt` + * `xenapi` + * `vmwareapi` + * `ironic` + + **New in version 2.48** + enum: + - ironic + - libvirt + - vmwareapi + - xenapi + type: string + 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: + - 'null' + - string + hypervisor_os: + description: |- + The hypervisor OS. + + **New in version 2.48** + type: + - 'null' + - string + memory_details: + additionalProperties: false + 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** + properties: + maximum: + type: + - integer + - 'null' + used: + type: + - integer + - 'null' + required: + - maximum + - used + type: object + 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: + additionalProperties: false + properties: + mac_address: + type: + - 'null' + - string + rx_drop: + type: + - integer + - 'null' + rx_errors: + type: + - integer + - 'null' + rx_octets: + type: + - integer + - 'null' + rx_packets: + type: + - integer + - 'null' + rx_rate: + type: + - integer + - 'null' + tx_drop: + type: + - integer + - 'null' + tx_errors: + type: + - integer + - 'null' + tx_octets: + type: + - integer + - 'null' + tx_packets: + type: + - integer + - 'null' + tx_rate: + type: + - integer + - 'null' + required: + - mac_address + - rx_drop + - rx_errors + - rx_octets + - rx_packets + - rx_rate + - tx_drop + - tx_errors + - tx_octets + - tx_packets + - tx_rate + type: object + type: array + num_cpus: + description: |- + The number of vCPUs. + + **New in version 2.48** + type: + - integer + - 'null' + num_disks: + description: |- + The number of disks. + + **New in version 2.48** + type: + - integer + - 'null' + num_nics: + description: |- + The number of vNICs. + + **New in version 2.48** + type: + - integer + - 'null' + 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 + uptime: + description: |- + The amount of time in seconds that the VM has been running. + + **New in version 2.48** + type: + - integer + - 'null' + required: + - config_drive + - cpu_details + - disk_details + - driver + - hypervisor + - hypervisor_os + - memory_details + - nic_details + - num_cpus + - num_disks + - num_nics + - state + - uptime + type: object + x-openstack: + min-ver: '2.48' + ServersIndexResponse_21: + additionalProperties: false + properties: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + id: + description: |- + The UUID of the server. + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + type: string + required: + - id + - links + - name + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.68' + min-ver: '2.1' + ServersIndexResponse_269: + additionalProperties: false + properties: + servers: + description: |- + A list of `server` objects. + items: + oneOf: + - additionalProperties: false + properties: + id: format: uuid type: string - source_type: - enum: - - blank - - image - - snapshot - - volume - type: string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: type: string - uuid: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._-]*$ + required: + - id + - links + - name + type: object + - additionalProperties: false + properties: + id: + format: uuid type: string - virtual_name: - maxLength: 255 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN type: string - volume_id: - format: uuid + required: + - id + - links + - status + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + min-ver: '2.69' + ServersIpShowResponse: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + required: + - addr + - version + type: object + type: array + type: object + ServersIpsIndexResponse: + additionalProperties: false + properties: + addresses: + additionalProperties: false + description: |- + The addresses information for the server. + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string - volume_type: - maxLength: 255 - minLength: 0 - type: - - 'null' - - string + version: + enum: + - 4 + - 6 + required: + - addr + - version 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 + type: object + required: + - addresses + 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 - 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 + type: object + required: + - metadata + type: object + ServersMetadataCreateResponse: + 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 - 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 + - 'null' - 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: object + required: + - metadata + type: object + ServersMetadataIndexResponse: + 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: - - 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 + - string type: object required: - - server + - metadata type: object - x-openstack: - max-ver: '2.93' - min-ver: '2.90' - ServersCreate_294: + ServersMetadataShowResponse: 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 + meta: + additionalProperties: false + description: |- + Metadata key and value pairs. The maximum size for each metadata key and value + pair is 255 bytes. + maxProperties: 1 + minProperties: 1 + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + required: + - meta + type: object + ServersMetadataUpdate: + additionalProperties: false + properties: + meta: + additionalProperties: false + maxProperties: 1 + minProperties: 1 + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + maxLength: 255 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: object + required: + - meta + type: object + ServersMetadataUpdateResponse: + additionalProperties: false + 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 + minProperties: 1 + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + required: + - meta + 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 - 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: object + required: + - metadata + type: object + ServersMetadataUpdate_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: - - array + - 'null' - 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. - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: + type: object + required: + - metadata + type: object + ServersMigrationShowResponse_223: + additionalProperties: false + properties: + migration: + additionalProperties: false + description: |- + The server migration object. + properties: + created_at: description: |- - Schedule the server by using a custom filter in JSON format. - For example: + 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) ``` - "query": "[\">=\",\"$free_ram_mb\",1024]" + CCYY-MM-DDThh:mm:ss±hh:mm ``` - It is available when `JsonFilter` is available on cloud side. + 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: - - object + - 'null' - string - same_host: + dest_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 + The target host for a migration. type: - - array + - 'null' - 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: + dest_node: 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: + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: 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: + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 + type: + - integer + - 'null' + disk_remaining_bytes: 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 + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 type: - - array - - string - different_host: + - integer + - 'null' + disk_total_bytes: 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: + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + id: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: + The ID of the server migration. + type: integer + memory_processed_bytes: 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. + The amount of memory, in bytes, that has been processed during the migration. + minimum: 1 type: - - object - - string - same_host: + - integer + - 'null' + memory_remaining_bytes: 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 + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 type: - - array - - string - target_cell: + - integer + - 'null' + memory_total_bytes: 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: + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + server_uuid: 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 + The UUID of the server. + format: uuid type: string - accessIPv4: + source_compute: description: |- - IPv4 address that should be used to access this server. - format: ipv4 - type: string - accessIPv6: + The source compute for a migration. + type: + - 'null' + - string + source_node: description: |- - IPv6 address that should be used to access this server. - format: ipv6 - type: string - adminPass: + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + status: description: |- - The administrative password of the server. If you omit this parameter, the operation - generates a new password. + The current status of the migration. type: string - availability_zone: + updated_at: 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 + 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 - 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: + required: + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes + - id + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - server_uuid + - source_compute + - source_node + - status + - updated_at + type: object + required: + - migration + type: object + x-openstack: + max-ver: '2.58' + min-ver: '2.23' + ServersMigrationShowResponse_259: + additionalProperties: false + properties: + migration: + additionalProperties: false + description: |- + The server migration object. + properties: + created_at: 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"}] - > ``` + 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) - 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. + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - 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: + 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: |- - 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 + The target compute for a migration. type: - - boolean + - 'null' - string - description: + dest_host: 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + The target host for a migration. type: - 'null' - string - flavorRef: + dest_node: description: |- - The flavor reference, as an ID (including a UUID) or full URL, - for the flavor for your server instance. - minLength: 1 + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: + description: |- + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 + type: + - integer + - 'null' + disk_remaining_bytes: + description: |- + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + disk_total_bytes: + description: |- + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + 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. + minimum: 1 + type: + - integer + - 'null' + memory_remaining_bytes: + description: |- + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + memory_total_bytes: + description: |- + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 type: - integer + - 'null' + server_uuid: + description: |- + The UUID of the server. + format: uuid + type: string + source_compute: + description: |- + The source compute for a migration. + type: + - 'null' - string - host: + source_node: 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-._]*$ + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + status: + description: |- + The current status of the migration. type: string - hostname: + updated_at: 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. + 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) - Note + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - This information is published via the metadata service and requires - application such as `cloud-init` to propagate it through to the - instance. + 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 + uuid: + description: |- + The UUID of the migration. - **New in version 2.90** - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + **New in version 2.59** + format: uuid type: string - hypervisor_hostname: + required: + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes + - id + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - server_uuid + - source_compute + - source_node + - status + - updated_at + - uuid + type: object + required: + - migration + type: object + x-openstack: + max-ver: '2.79' + min-ver: '2.59' + ServersMigrationShowResponse_280: + additionalProperties: false + properties: + migration: + additionalProperties: false + description: |- + The server migration object. + properties: + created_at: 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. + 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) - **New in version 2.74** - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + ``` + 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 - imageRef: + dest_compute: 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: + The target compute for a migration. + type: + - 'null' + - string + dest_host: 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 + The target host for a migration. + type: + - 'null' + - string + dest_node: + description: |- + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: + description: |- + The amount of disk, in bytes, that has been processed during the migration. minimum: 1 - pattern: ^[0-9]*$ type: - integer - - string - metadata: - additionalProperties: false + - 'null' + disk_remaining_bytes: 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 + The amount of disk, in bytes, that still needs to be migrated. minimum: 1 - pattern: ^[0-9]*$ type: - integer - - string - name: + - 'null' + disk_total_bytes: 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 + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + 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. + minimum: 1 + type: + - integer + - 'null' + memory_remaining_bytes: + description: |- + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + memory_total_bytes: + description: |- + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + 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** maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - networks: + server_uuid: 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: + The UUID of the server. + format: uuid + type: string + source_compute: + description: |- + The source compute for a migration. + type: + - 'null' + - string + source_node: 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 + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. type: - - boolean + - 'null' - string - security_groups: + status: 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: + The current status of the migration. + type: string + updated_at: description: |- - A list of tags. Tags have the following restrictions: + 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) - * 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. + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - **New in version 2.52** - items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ - type: string - maxItems: 50 - type: array - trusted_image_certificates: + 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: |- - 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. + The ID of the user which initiated the server migration. The value + may be `null` for older migration records. - **New in version 2.63** - items: - minLength: 1 - type: string - maxItems: 50 - minItems: 1 - type: - - array - - 'null' - uniqueItems: true - user_data: + **New in version 2.80** + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + uuid: description: |- - Configuration information or scripts to use upon launch. - Must be Base64 encoded. Restricted to 65535 bytes. - - Note + The UUID of the migration. - 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 + **New in version 2.59** + format: uuid type: string required: - - flavorRef - - name - - networks + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes + - id + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - project_id + - server_uuid + - source_compute + - source_node + - status + - updated_at + - user_id + - uuid type: object required: - - server + - migration 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. + min-ver: '2.80' + ServersMigrationsAction_Force_Complete_222: + additionalProperties: false + description: |- + Force an in-progress live migration for a given server to complete. - **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. + Specify the `force_complete` action in the request body. - **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. + Policy defaults enable only users with the administrative role to perform + this operation. Cloud providers can change these permissions through the + `policy.yaml` file. - **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. + **Preconditions** - **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: + The server OS-EXT-STS:vm_state value must be `active` and the server + OS-EXT-STS:task_state value must be `migrating`. - ``` - 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. + If the server is locked, you must have administrator privileges to force the + completion of the server migration. - The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + The migration status must be `running`. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + **Asynchronous Postconditions** - For example, `2015-08-27T09:49:58-05:00`. + After you make this request, you typically must keep polling the server status + to determine whether the request succeeded. - 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. + **Troubleshooting** - The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + 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). - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + Normal response codes: 202 - 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: + 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' + ServersMigrationsIndexResponse_223: + additionalProperties: false + properties: + migrations: + description: |- + The list of server migration objects. + items: + additionalProperties: false + 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) @@ -45946,337 +94613,95 @@ components: 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: + dest_compute: 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' + The target compute for a migration. 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: + dest_host: 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: + The target host for a migration. + type: + - 'null' + - string + dest_node: 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 + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: 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: + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 + type: + - integer + - 'null' + disk_remaining_bytes: description: |- - The server name. - type: string - os-extended-volumes:volumes_attached: + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + disk_total_bytes: description: |- - The attached volumes, if any. - items: - type: object - type: array - progress: + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + id: 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`. + The ID of the server migration. type: integer - security_groups: + memory_processed_bytes: 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: + The amount of memory, in bytes, that has been processed during the migration. + minimum: 1 + type: + - integer + - 'null' + memory_remaining_bytes: description: |- - The server status. - readOnly: true - type: string - tags: + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + memory_total_bytes: 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: + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + server_uuid: description: |- - The UUID of the tenant in a multi-tenancy cloud. + The UUID of the server. format: uuid type: string - trusted_image_certificates: + source_compute: 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 + The source compute for a migration. type: - - array - 'null' - x-openstack: - min-ver: '2.63' - updated: + - string + source_node: + description: |- + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - 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) @@ -46289,568 +94714,687 @@ components: 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 + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes - 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 + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - server_uuid + - source_compute + - source_node + - status + - updated_at type: object type: array + required: + - migrations type: object - ServersDiagnosticsListResponse: + x-openstack: + max-ver: '2.58' + min-ver: '2.23' + ServersMigrationsIndexResponse_259: additionalProperties: false properties: - config_drive: - description: |- - Indicates whether or not a config drive was used for this server. - - **New in version 2.48** - type: boolean - cpu_details: + migrations: 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** + The list of server migration objects. items: additionalProperties: false properties: - id: + 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: - - integer - 'null' - time: + - string + dest_host: + description: |- + The target host for a migration. type: - - integer - 'null' - utilisation: + - string + dest_node: + description: |- + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: + description: |- + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 type: - integer - 'null' - required: - - id - - time - - utilisation - type: object - type: array - 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: - additionalProperties: false - properties: - errors_count: + disk_remaining_bytes: + description: |- + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 type: - integer - 'null' - read_bytes: + disk_total_bytes: + description: |- + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 type: - integer - 'null' - read_requests: + 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. + minimum: 1 type: - integer - 'null' - write_bytes: + memory_remaining_bytes: + description: |- + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 type: - integer - 'null' - write_requests: + memory_total_bytes: + description: |- + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 type: - integer - 'null' - required: - - errors_count - - read_bytes - - read_requests - - write_bytes - - write_requests - type: object - type: array - driver: - description: |- - The driver on which the VM is running. Possible values are: - - * `libvirt` - * `xenapi` - * `vmwareapi` - * `ironic` - - **New in version 2.48** - enum: - - ironic - - libvirt - - vmwareapi - - xenapi - type: string - 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: - - 'null' - - string - hypervisor_os: - description: |- - The hypervisor OS. + server_uuid: + description: |- + The UUID of the server. + format: uuid + type: string + source_compute: + description: |- + The source compute for a migration. + type: + - 'null' + - string + source_node: + description: |- + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - 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) - **New in version 2.48** - type: - - 'null' - - string - memory_details: - additionalProperties: false - description: |- - The dictionary with information about VM memory usage. - Following fields are presented in the dictionary: + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - * `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) + 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 + uuid: + description: |- + The UUID of the migration. - **New in version 2.48** - properties: - maximum: - type: - - integer - - 'null' - used: - type: - - integer - - 'null' - required: - - maximum - - used - type: object - nic_details: + **New in version 2.59** + format: uuid + type: string + required: + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes + - id + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - server_uuid + - source_compute + - source_node + - status + - updated_at + - uuid + type: object + type: array + required: + - migrations + type: object + x-openstack: + max-ver: '2.79' + min-ver: '2.59' + ServersMigrationsIndexResponse_280: + additionalProperties: false + properties: + migrations: 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** + The list of server migration objects. items: additionalProperties: false properties: - mac_address: + 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: - 'null' - string - rx_drop: + dest_host: + description: |- + The target host for a migration. type: - - integer - 'null' - rx_errors: + - string + dest_node: + description: |- + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. type: - - integer - 'null' - rx_octets: + - string + disk_processed_bytes: + description: |- + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 type: - integer - 'null' - rx_packets: + disk_remaining_bytes: + description: |- + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 type: - integer - 'null' - rx_rate: + disk_total_bytes: + description: |- + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 type: - integer - 'null' - tx_drop: + 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. + minimum: 1 type: - integer - 'null' - tx_errors: + memory_remaining_bytes: + description: |- + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 type: - integer - 'null' - tx_octets: + memory_total_bytes: + description: |- + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 type: - integer - 'null' - tx_packets: + 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** + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + server_uuid: + description: |- + The UUID of the server. + format: uuid + type: string + source_compute: + description: |- + The source compute for a migration. type: - - integer - 'null' - tx_rate: + - string + source_node: + description: |- + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. type: - - integer - 'null' - required: - - mac_address - - rx_drop - - rx_errors - - rx_octets - - rx_packets - - rx_rate - - tx_drop - - tx_errors - - tx_octets - - tx_packets - - tx_rate - type: object - type: array - num_cpus: - description: |- - The number of vCPUs. - - **New in version 2.48** - type: - - integer - - 'null' - num_disks: - description: |- - The number of disks. - - **New in version 2.48** - type: - - integer - - 'null' - num_nics: - description: |- - The number of vNICs. - - **New in version 2.48** - type: - - integer - - 'null' - state: - description: |- - A string enum denoting the current state of the VM. Possible values are: - - * `pending` - * `running` - * `paused` - * `shutdown` - * `crashed` - * `suspended` + - 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) - **New in version 2.48** - enum: - - crashed - - paused - - pending - - running - - shutdown - - suspended - type: string - uptime: - description: |- - The amount of time in seconds that the VM has been running. + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - **New in version 2.48** - type: - - integer - - 'null' - required: - - config_drive - - cpu_details - - disk_details - - driver - - hypervisor - - hypervisor_os - - memory_details - - nic_details - - num_cpus - - num_disks - - num_nics - - state - - uptime - 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: + 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 UUID of the server. - format: uuid + The ID of the user which initiated the server migration. The value + may be `null` for older migration records. + + **New in version 2.80** + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - name: + uuid: description: |- - The server name. + The UUID of the migration. + + **New in version 2.59** format: uuid type: string required: + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes - 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 + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - project_id + - server_uuid + - source_compute + - source_node + - status + - updated_at + - user_id + - uuid type: object type: array + required: + - migrations type: object - ServersMetadataCreate: + x-openstack: + min-ver: '2.80' + ServersOs_Instance_ActionShowResponse_21: additionalProperties: false properties: - metadata: + instanceAction: 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 + The instance action object. + properties: + action: + description: |- + The name of the action. 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 + 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: + additionalProperties: false + properties: + event: + type: string + finish_time: + format: date-time + type: + - 'null' + - string + result: + type: + - 'null' + - 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: + type: + - 'null' + - string + required: + - event + - finish_time + - result + - start_time + type: object + type: array + instance_uuid: + description: |- + The UUID of the server. + format: uuid 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}$: + 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. maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + request_id: + description: |- + The request id generated when execute the API of this action. 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 + start_time: + format: date-time type: string - type: object - type: object - ServersMetadataUpdate: - additionalProperties: false - properties: - meta: - additionalProperties: false - maxProperties: 1 - minProperties: 1 - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + user_id: + description: |- + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. maxLength: 255 - type: string + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + required: + - action + - instance_uuid + - message + - project_id + - request_id + - start_time + - user_id type: object required: - - meta + - instanceAction type: object - ServersMetadataUpdateResponse: + x-openstack: + max-ver: '2.50' + min-ver: '2.1' + ServersOs_Instance_ActionShowResponse_251: additionalProperties: false properties: - meta: + instanceAction: additionalProperties: false description: |- - The object of detailed key metadata items. - maxProperties: 1 - minProperties: 1 - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + 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: + additionalProperties: false + properties: + event: + type: string + finish_time: + format: date-time + type: + - 'null' + - string + result: + type: + - 'null' + - 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: + type: + - 'null' + - string + required: + - event + - finish_time + - result + - start_time + type: object + type: array + instance_uuid: + description: |- + The UUID of the server. + format: uuid + 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. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + request_id: + description: |- + The request id generated when execute the API of this action. + type: string + start_time: + format: date-time + type: string + user_id: + description: |- + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: - 'null' - string + required: + - action + - events + - instance_uuid + - message + - project_id + - request_id + - start_time + - user_id type: object required: - - meta + - instanceAction type: object - ServersMetadataUpdate_All: + x-openstack: + max-ver: '2.57' + min-ver: '2.51' + ServersOs_Instance_ActionShowResponse_258: additionalProperties: false properties: - metadata: + instanceAction: 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 + The instance action object. + properties: + action: + description: |- + The name of the action. 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}$: + 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: + additionalProperties: false + properties: + event: + type: string + finish_time: + format: date-time + type: + - 'null' + - string + result: + type: + - 'null' + - 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: + type: + - 'null' + - string + required: + - event + - finish_time + - result + - start_time + type: object + type: array + instance_uuid: + description: |- + The UUID of the server. + format: uuid + 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. maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + request_id: + description: |- + The request id generated when execute the API of this action. type: string - type: object - required: - - metadata - type: object - ServersMigrationShowResponse: - properties: - migration: - description: |- - The server migration object. - properties: - created_at: + start_time: + format: date-time + type: string + updated_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) + 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 @@ -46859,82 +95403,137 @@ components: 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: string - dest_compute: - description: |- - The target compute for a migration. - type: string - dest_host: + type: + - 'null' + - string + user_id: description: |- - The target host for a migration. - type: string - dest_node: + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + required: + - action + - events + - instance_uuid + - message + - project_id + - request_id + - start_time + - updated_at + - user_id + type: object + required: + - instanceAction + type: object + x-openstack: + max-ver: '2.61' + min-ver: '2.58' + ServersOs_Instance_ActionShowResponse_262: + additionalProperties: false + properties: + instanceAction: + additionalProperties: false + description: |- + The instance action object. + properties: + action: description: |- - The target node for a migration. This will be `null` if pre-migration - checks fail due to e.g. insufficient resources. + The name of the action. 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: + events: description: |- - The amount of memory, in bytes, that has been processed during the migration. - type: integer - memory_remaining_bytes: + 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: + additionalProperties: false + properties: + event: + type: string + finish_time: + format: date-time + type: + - 'null' + - string + host: + type: string + hostId: + type: string + result: + type: + - 'null' + - 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: + type: + - 'null' + - string + required: + - event + - finish_time + - hostId + - result + - start_time + type: object + type: array + instance_uuid: description: |- - The amount of memory, in bytes, that still needs to be migrated. - type: integer - memory_total_bytes: + The UUID of the server. + format: uuid + type: string + message: description: |- - The total amount of memory, in bytes, that needs to be migrated. - type: integer + The related error message for when an action fails. + type: + - 'null' + - string 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** + The ID of the project which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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: + request_id: description: |- - The source node for a migration. This will be `null` if pre-migration - checks fail due to e.g. insufficient resources. + The request id generated when execute the API of this action. type: string - status: - description: |- - The current status of the migration. + start_time: + format: date-time 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) + 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 @@ -46943,212 +95542,44 @@ components: 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: string + type: + - 'null' + - 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** + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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' + required: + - action + - events + - instance_uuid + - message + - project_id + - request_id + - start_time + - updated_at + - user_id 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) + - instanceAction 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. This will be `null` if pre-migration - checks fail due to e.g. insufficient resources. - 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. This will be `null` if pre-migration - checks fail due to e.g. insufficient resources. - 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: + max-ver: '2.83' + min-ver: '2.62' + ServersOs_Instance_ActionShowResponse_284: + additionalProperties: false properties: instanceAction: + additionalProperties: false description: |- The instance action object. properties: @@ -47166,46 +95597,27 @@ components: **New in version 2.51** items: - description: Event + additionalProperties: false 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 + type: + - 'null' + - 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' + type: string 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 + result: + type: + - 'null' + - string start_time: description: |- The date and time when the action was started. The date and time @@ -47221,22 +95633,21 @@ components: 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 + - finish_time + - hostId + - result + - start_time type: object type: array instance_uuid: description: |- The UUID of the server. + format: uuid type: string message: description: |- @@ -47248,23 +95659,17 @@ components: description: |- The ID of the project which initiated the server action. This can be `null` for `nova-manage`-initiated actions. - type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - 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: @@ -47286,32 +95691,40 @@ components: 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. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: - 'null' - string required: - action - events + - instance_uuid + - message - project_id - request_id + - start_time + - updated_at - user_id type: object required: - instanceAction type: object - ServersOs_Instance_ActionsListResponse: + x-openstack: + min-ver: '2.84' + ServersOs_Instance_ActionsIndexResponse_21: + additionalProperties: false properties: instanceActions: description: |- List of the actions for the given instance in descending order of creation. items: - description: The instance action object. + additionalProperties: false properties: action: description: |- @@ -47320,6 +95733,7 @@ components: instance_uuid: description: |- The UUID of the server. + format: uuid type: string message: description: |- @@ -47331,7 +95745,90 @@ components: description: |- The ID of the project which initiated the server action. This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - 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 + user_id: + description: |- + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + required: + - action + - instance_uuid + - message + - project_id + - request_id + - start_time + - user_id + type: object + type: array + required: + - instanceActions + type: object + x-openstack: + max-ver: '2.57' + min-ver: '2.1' + ServersOs_Instance_ActionsIndexResponse_258: + additionalProperties: false + properties: + instanceActions: + description: |- + List of the actions for the given instance in descending order of creation. + items: + additionalProperties: false + properties: + action: + description: |- + The name of the action. + type: string + instance_uuid: + description: |- + The UUID of the server. + format: uuid 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. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string request_id: description: |- The request id generated when execute the API of this action. @@ -47369,55 +95866,67 @@ components: 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. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: - 'null' - string required: - action - - events + - instance_uuid + - message - project_id - request_id + - start_time + - updated_at - 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) + Links pertaining to the instance action. + 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.40** + **New in version 2.58** 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. + additionalProperties: false properties: href: format: uri type: string rel: - type: string + const: next + required: + - href + - rel type: object + maxItems: 1 + minItems: 1 type: array required: - instanceActions type: object + x-openstack: + max-ver: '2.57' + min-ver: '2.58' ServersOs_InterfaceCreateRequest: oneOf: - $ref: '#/components/schemas/ServersOs_InterfaceCreate_20' - $ref: '#/components/schemas/ServersOs_InterfaceCreate_249' x-openstack: discriminator: microversion - ServersOs_InterfaceCreateResponse: + ServersOs_InterfaceCreateResponse_21: + additionalProperties: false properties: interfaceAttachment: + additionalProperties: false description: |- The interface attachment. properties: @@ -47425,25 +95934,88 @@ components: description: |- Fixed IP addresses with subnet IDs. items: + additionalProperties: false properties: ip_address: - description: |- - The IP address. - oneOf: + anyOf: - format: ipv4 - format: ipv6 type: string subnet_id: - description: |- - The UUID of the subnet. format: uuid type: string + required: + - ip_address + - subnet_id type: object - type: array + type: + - array + - 'null' + mac_addr: + description: |- + The MAC address. + format: mac-address + 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 + required: + - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + type: object + required: + - interfaceAttachment + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.1' + ServersOs_InterfaceCreateResponse_270: + additionalProperties: false + properties: + interfaceAttachment: + additionalProperties: false + description: |- + The interface attachment. + properties: + fixed_ips: + description: |- + Fixed IP addresses with subnet IDs. + items: + additionalProperties: false + properties: + ip_address: + anyOf: + - format: ipv4 + - format: ipv6 + type: string + subnet_id: + format: uuid + type: string + required: + - ip_address + - subnet_id + type: object + type: + - array + - 'null' mac_addr: description: |- The MAC address. - pattern: ^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$ + format: mac-address type: string net_id: description: |- @@ -47467,12 +96039,19 @@ components: type: - 'null' - string - x-openstack: - min-ver: '2.70' required: - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + - tag type: object + required: + - interfaceAttachment type: object + x-openstack: + min-ver: '2.70' ServersOs_InterfaceCreate_20: additionalProperties: false properties: @@ -47582,40 +96161,104 @@ components: type: object type: object x-openstack: - max-ver: '2.48' - min-ver: '2.49' - ServersOs_InterfaceListResponse: + min-ver: '2.49' + ServersOs_InterfaceIndexResponse_21: + additionalProperties: false + properties: + interfaceAttachments: + description: |- + List of the interface attachments. + items: + additionalProperties: false + properties: + fixed_ips: + description: |- + Fixed IP addresses with subnet IDs. + items: + additionalProperties: false + properties: + ip_address: + anyOf: + - format: ipv4 + - format: ipv6 + type: string + subnet_id: + format: uuid + type: string + required: + - ip_address + - subnet_id + type: object + type: + - array + - 'null' + mac_addr: + description: |- + The MAC address. + format: mac-address + 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 + required: + - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + type: object + type: array + required: + - interfaceAttachments + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.1' + ServersOs_InterfaceIndexResponse_270: + additionalProperties: false properties: interfaceAttachments: description: |- List of the interface attachments. items: - description: |- - The interface attachment. + additionalProperties: false properties: fixed_ips: description: |- Fixed IP addresses with subnet IDs. items: + additionalProperties: false properties: ip_address: - description: |- - The IP address. - oneOf: + anyOf: - format: ipv4 - format: ipv6 type: string subnet_id: - description: |- - The UUID of the subnet. format: uuid type: string + required: + - ip_address + - subnet_id type: object - type: array + type: + - array + - 'null' mac_addr: description: |- The MAC address. - pattern: ^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$ + format: mac-address type: string net_id: description: |- @@ -47639,16 +96282,25 @@ components: type: - 'null' - string - x-openstack: - min-ver: '2.70' required: - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + - tag type: object type: array + required: + - interfaceAttachments type: object - ServersOs_InterfaceShowResponse: + x-openstack: + min-ver: '2.70' + ServersOs_InterfaceShowResponse_21: + additionalProperties: false properties: interfaceAttachment: + additionalProperties: false description: |- The interface attachment. properties: @@ -47656,25 +96308,88 @@ components: description: |- Fixed IP addresses with subnet IDs. items: + additionalProperties: false properties: ip_address: - description: |- - The IP address. - oneOf: + anyOf: - format: ipv4 - format: ipv6 type: string subnet_id: - description: |- - The UUID of the subnet. format: uuid type: string + required: + - ip_address + - subnet_id type: object - type: array + type: + - array + - 'null' + mac_addr: + description: |- + The MAC address. + format: mac-address + 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 + required: + - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + type: object + required: + - interfaceAttachment + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.1' + ServersOs_InterfaceShowResponse_270: + additionalProperties: false + properties: + interfaceAttachment: + additionalProperties: false + description: |- + The interface attachment. + properties: + fixed_ips: + description: |- + Fixed IP addresses with subnet IDs. + items: + additionalProperties: false + properties: + ip_address: + anyOf: + - format: ipv4 + - format: ipv6 + type: string + subnet_id: + format: uuid + type: string + required: + - ip_address + - subnet_id + type: object + type: + - array + - 'null' mac_addr: description: |- The MAC address. - pattern: ^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$ + format: mac-address type: string net_id: description: |- @@ -47698,13 +96413,20 @@ components: type: - 'null' - string - x-openstack: - min-ver: '2.70' required: - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + - tag type: object + required: + - interfaceAttachment type: object - ServersOs_Security_GroupsListResponse: + x-openstack: + min-ver: '2.70' + ServersOs_Security_GroupsIndexResponse: additionalProperties: false properties: security_groups: @@ -47712,8 +96434,6 @@ components: One or more security groups objects. items: additionalProperties: false - description: |- - Specify the `security_group` action in the request body. properties: description: description: |- @@ -47735,29 +96455,20 @@ components: 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. + The UUID of the tenant in a multi-tenancy cloud. maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9-]*$ @@ -47765,36 +96476,24 @@ components: 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 @@ -47811,7 +96510,7 @@ components: type: array tenant_id: description: |- - The UUID of the tenant that owns this security group. + The UUID of the tenant in a multi-tenancy cloud. maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9-]*$ @@ -47827,62 +96526,165 @@ components: required: - security_groups type: object - ServersOs_Server_PasswordListResponse: + ServersOs_Server_PasswordIndexResponse: + additionalProperties: false properties: password: description: |- The password returned from metadata server. - format: password type: string + required: + - password type: object - ServersOs_Virtual_InterfacesListResponse: {} - ServersOs_Volume_AttachmentShowResponse: + ServersOs_Volume_AttachmentShowResponse_20: + additionalProperties: false properties: volumeAttachment: + additionalProperties: false description: |- A dictionary representation of a volume attachment containing the fields `device`, `id`, `serverId` and `volumeId`. properties: - attachment_id: + device: description: |- - The UUID of the associated volume attachment in Cinder. - - **New in version 2.89** + Name of the device in the attachment object, such as, `/dev/vdb`. + 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 attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' - bdm_uuid: + serverId: description: |- - The UUID of the block device mapping record in Nova for the attachment. + The UUID of the server. + format: uuid + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - id + - serverId + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.0' + ServersOs_Volume_AttachmentShowResponse_270: + additionalProperties: false + properties: + volumeAttachment: + additionalProperties: false + description: |- + A dictionary representation of a volume attachment containing the fields + `device`, `id`, `serverId` and `volumeId`. + properties: + device: + description: |- + Name of the device in the attachment object, such as, `/dev/vdb`. + 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 attached volume. + format: uuid + type: string + 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.89** + **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' + required: + - id + - serverId + - tag + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + max-ver: '2.78' + min-ver: '2.70' + ServersOs_Volume_AttachmentShowResponse_279: + additionalProperties: false + properties: + volumeAttachment: + additionalProperties: false + description: |- + A dictionary representation of a volume attachment containing the fields + `device`, `id`, `serverId` and `volumeId`. + properties: 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' + 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`. - type: string + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ + type: + - 'null' + - string id: description: |- - The volume ID of the attachment. - - **Available until version 2.88** + The UUID of the attached volume. format: uuid type: string - x-openstack: - max-ver: '2.88' serverId: description: |- The UUID of the server. @@ -47893,34 +96695,35 @@ components: 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' + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string volumeId: description: |- The UUID of the attached volume. format: uuid type: string required: - - device + - delete_on_termination - id - serverId + - tag - 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: + max-ver: '2.88' + min-ver: '2.79' + ServersOs_Volume_AttachmentShowResponse_289: + additionalProperties: false properties: volumeAttachment: + additionalProperties: false description: |- A dictionary representation of a volume attachment containing the fields `device`, `id`, `serverId` and `volumeId`. @@ -47932,8 +96735,6 @@ components: **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. @@ -47941,48 +96742,133 @@ components: **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' + 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`. + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ + type: + - 'null' + - string + serverId: + description: |- + The UUID of the server. + format: uuid type: string - id: + tag: description: |- - The volume ID of the attachment. + The device tag applied to the volume block device or `null`. - **Available until version 2.88** + **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - attachment_id + - bdm_uuid + - delete_on_termination + - serverId + - tag + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + min-ver: '2.89' + 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: + properties: + attachment_id: + description: The UUID of the associated volume attachment in + Cinder. + 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. + 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. + 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 format: uuid type: string x-openstack: max-ver: '2.88' serverId: - description: |- - The UUID of the server. + 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** + description: The device tag applied to the volume block device or + null. type: - 'null' - string x-openstack: min-ver: '2.70' volumeId: - description: |- - The UUID of the attached volume. + description: The UUID of the attached volume. format: uuid type: string required: @@ -48104,7 +96990,6 @@ components: - volumeAttachment type: object x-openstack: - max-ver: '2.84' min-ver: '2.85' ServersOs_Volume_AttachmentsCreateRequest: oneOf: @@ -48113,53 +96998,156 @@ components: - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreate_279' x-openstack: discriminator: microversion - ServersOs_Volume_AttachmentsCreateResponse: + ServersOs_Volume_AttachmentsCreateResponse_20: + additionalProperties: false properties: volumeAttachment: + additionalProperties: false description: |- A dictionary representation of a volume attachment containing the fields `device`, `id`, `serverId` and `volumeId`. properties: - attachment_id: + device: description: |- - The UUID of the associated volume attachment in Cinder. - - **New in version 2.89** + Name of the device such as, `/dev/vdb`. + 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 attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' - bdm_uuid: + serverId: description: |- - The UUID of the block device mapping record in Nova for the attachment. + The UUID of the server. + format: uuid + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - id + - serverId + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.0' + ServersOs_Volume_AttachmentsCreateResponse_270: + additionalProperties: false + properties: + volumeAttachment: + additionalProperties: false + description: |- + A dictionary representation of a volume attachment containing the fields + `device`, `id`, `serverId` and `volumeId`. + properties: + device: + description: |- + Name of the device such as, `/dev/vdb`. + 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 attached volume. + format: uuid + type: string + 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.89** + **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' + required: + - device + - id + - serverId + - tag + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + max-ver: '2.78' + min-ver: '2.70' + ServersOs_Volume_AttachmentsCreateResponse_279: + additionalProperties: false + properties: + volumeAttachment: + additionalProperties: false + description: |- + A dictionary representation of a volume attachment containing the fields + `device`, `id`, `serverId` and `volumeId`. + properties: 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' + 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`. - type: string + Name of the device such as, `/dev/vdb`. + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ + type: + - 'null' + - string id: description: |- - The volume ID of the attachment. - - **Available until version 2.88** + The UUID of the attached volume. format: uuid type: string - x-openstack: - max-ver: '2.88' serverId: description: |- The UUID of the server. @@ -48170,25 +97158,31 @@ components: 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' + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string volumeId: description: |- The UUID of the attached volume. format: uuid type: string required: + - delete_on_termination - device - id - serverId + - tag - volumeId type: object required: - volumeAttachment type: object + x-openstack: + max-ver: '2.100' + min-ver: '2.79' ServersOs_Volume_AttachmentsCreate_20: additionalProperties: false properties: @@ -48355,58 +97349,158 @@ components: - volumeAttachment type: object x-openstack: - max-ver: '2.48' min-ver: '2.79' - ServersOs_Volume_AttachmentsListResponse: + ServersOs_Volume_AttachmentsIndexResponse_20: + additionalProperties: false 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`. + additionalProperties: false properties: - attachment_id: + device: description: |- - The UUID of the associated volume attachment in Cinder. - - **New in version 2.89** + Name of the device in the attachment object, such as, `/dev/vdb`. + 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 attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' - bdm_uuid: + serverId: description: |- - The UUID of the block device mapping record in Nova for the attachment. + The UUID of the server. + format: uuid + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - id + - serverId + - volumeId + type: object + type: array + required: + - volumeAttachments + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.0' + ServersOs_Volume_AttachmentsIndexResponse_270: + additionalProperties: false + properties: + volumeAttachments: + description: |- + The list of volume attachments. + items: + additionalProperties: false + properties: + device: + description: |- + Name of the device in the attachment object, such as, `/dev/vdb`. + 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 attached volume. + format: uuid + type: string + 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.89** + **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' + required: + - id + - serverId + - tag + - volumeId + type: object + type: array + required: + - volumeAttachments + type: object + x-openstack: + max-ver: '2.78' + min-ver: '2.70' + ServersOs_Volume_AttachmentsIndexResponse_279: + additionalProperties: false + properties: + volumeAttachments: + description: |- + The list of volume attachments. + items: + additionalProperties: false + properties: 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' + 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`. - type: string + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ + type: + - 'null' + - string id: description: |- - The volume ID of the attachment. - - **Available until version 2.88** + The UUID of the attached volume. format: uuid type: string - x-openstack: - max-ver: '2.88' serverId: description: |- The UUID of the server. @@ -48417,26 +97511,128 @@ components: The device tag applied to the volume block device or `null`. **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - delete_on_termination + - id + - serverId + - tag + - volumeId + type: object + type: array + required: + - volumeAttachments + type: object + x-openstack: + max-ver: '2.88' + min-ver: '2.79' + ServersOs_Volume_AttachmentsIndexResponse_289: + additionalProperties: false + properties: + volumeAttachments: + description: |- + The list of volume attachments. + items: + additionalProperties: false + properties: + attachment_id: + description: |- + The UUID of the associated volume attachment in Cinder. + + **New in version 2.89** + format: uuid + type: string + 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 + delete_on_termination: + description: |- + A flag indicating if the attached volume will be deleted when the server is + deleted. + + **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 in the attachment object, such as, `/dev/vdb`. + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ type: - 'null' - string - x-openstack: - min-ver: '2.70' + 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** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string volumeId: description: |- The UUID of the attached volume. format: uuid type: string required: - - device - - id + - attachment_id + - bdm_uuid + - delete_on_termination - serverId + - tag - volumeId type: object type: array required: - volumeAttachments type: object + x-openstack: + min-ver: '2.89' ServersRemote_ConsolesCreateRequest: oneOf: - $ref: '#/components/schemas/ServersRemote_ConsolesCreate_26' @@ -48444,10 +97640,62 @@ components: - $ref: '#/components/schemas/ServersRemote_ConsolesCreate_299' x-openstack: discriminator: microversion - ServersRemote_ConsolesCreateResponse: - description: Create Console Response + ServersRemote_ConsolesCreateResponse_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 + 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 + x-openstack: + max-ver: '2.7' + min-ver: '2.6' + ServersRemote_ConsolesCreateResponse_28: + additionalProperties: false properties: remote_console: + additionalProperties: false description: |- The remote console object. properties: @@ -48493,6 +97741,62 @@ components: required: - remote_console type: object + x-openstack: + max-ver: '2.98' + min-ver: '2.8' + ServersRemote_ConsolesCreateResponse_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 + 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 + x-openstack: + min-ver: '2.99' ServersRemote_ConsolesCreate_26: additionalProperties: false properties: @@ -48631,9 +97935,8 @@ components: - remote_console type: object x-openstack: - max-ver: '2.7' min-ver: '2.99' - ServersShareShowResponse: + ServersShareShowResponse_297: additionalProperties: false properties: share: @@ -48689,18 +97992,15 @@ components: - share title: Server share type: object - ServersSharesCreateResponse: + x-openstack: + min-ver: '2.97' + ServersSharesCreateResponse_297: 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: |- @@ -48745,6 +98045,8 @@ components: - share title: Server share type: object + x-openstack: + min-ver: '2.97' ServersSharesCreate_297: additionalProperties: false properties: @@ -48773,7 +98075,7 @@ components: type: object x-openstack: min-ver: '2.97' - ServersSharesListResponse: + ServersSharesIndexResponse_297: additionalProperties: false properties: shares: @@ -48781,13 +98083,8 @@ components: 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: |- @@ -48833,28 +98130,42 @@ components: - shares title: Server shares type: object - ServersTagShowResponse: - type: 'null' - ServersTagsListResponse: - description: Server Tags + x-openstack: + min-ver: '2.97' + ServersTagsIndexResponse_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 type: array + required: + - tags type: object - ServersTagsUpdate_AllResponse: - description: Server Tags + x-openstack: + min-ver: '2.26' + ServersTagsUpdate_AllResponse_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 type: array + required: + - tags type: object + x-openstack: + min-ver: '2.26' ServersTagsUpdate_All_226: additionalProperties: false properties: @@ -48874,65 +98185,63 @@ components: type: object x-openstack: min-ver: '2.26' - ServersTopologyListResponse: - description: NUMA topology information for a server + ServersTopologyIndexResponse_278: + additionalProperties: false properties: nodes: description: |- NUMA nodes information of a server. items: - description: NUMA node information of a server + additionalProperties: false properties: cpu_pinning: - additionalProperties: - type: integer - description: The mapping of server cores to host physical CPU + additionalProperties: false + patternProperties: + ^[0-9]+$: + type: integer 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 + items: + type: integer + type: array type: array vcpu_set: - description: A list of IDs of the virtual CPU assigned to this - NUMA node. items: type: integer type: array + required: + - memory_mb + - siblings + - vcpu_set type: object type: array + 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' + required: + - nodes + - pagesize_kb type: object + x-openstack: + min-ver: '2.78' 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: @@ -48961,30 +98270,14 @@ components: 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: diff --git a/openstack_types/data/compute/v2.yaml b/openstack_types/data/compute/v2.yaml index 7d3afbd61..d00a14489 100644 --- a/openstack_types/data/compute/v2.yaml +++ b/openstack_types/data/compute/v2.yaml @@ -24,8 +24,6 @@ paths: schema: $ref: '#/components/schemas/RootShowResponse' description: Ok - '404': - description: Error summary: List All Major Versions tags: - version @@ -43,7 +41,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ExtensionsListResponse' + $ref: '#/components/schemas/ExtensionsIndexResponse' description: Ok summary: List Extensions tags: @@ -64,8 +62,6 @@ paths: schema: $ref: '#/components/schemas/ExtensionShowResponse' description: Ok - '404': - description: Error summary: Show Extension Details tags: - extensions @@ -94,10 +90,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsListResponse' + oneOf: + - $ref: '#/components/schemas/FlavorsIndexResponse_20' + - $ref: '#/components/schemas/FlavorsIndexResponse_255' description: Ok - '400': - description: Error summary: List Flavors tags: - flavors @@ -123,7 +119,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsCreateResponse' + oneOf: + - $ref: '#/components/schemas/FlavorsCreateResponse_20' + - $ref: '#/components/schemas/FlavorsCreateResponse_2102' + - $ref: '#/components/schemas/FlavorsCreateResponse_255' + - $ref: '#/components/schemas/FlavorsCreateResponse_261' + - $ref: '#/components/schemas/FlavorsCreateResponse_275' description: Ok '400': description: Error @@ -155,10 +156,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsDetailResponse' + oneOf: + - $ref: '#/components/schemas/FlavorsDetailDetailResponse_20' + - $ref: '#/components/schemas/FlavorsDetailDetailResponse_2102' + - $ref: '#/components/schemas/FlavorsDetailDetailResponse_255' + - $ref: '#/components/schemas/FlavorsDetailDetailResponse_261' description: Ok - '400': - description: Error summary: List Flavors With Details tags: - flavors @@ -176,10 +179,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsOs_Extra_SpecsListResponse' + $ref: '#/components/schemas/FlavorsOs_Extra_SpecsIndexResponse' description: Ok - '404': - description: Error summary: List Extra Specs For A Flavor tags: - flavors @@ -227,8 +228,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete An Extra Spec For A Flavor tags: - flavors @@ -247,8 +246,6 @@ paths: schema: $ref: '#/components/schemas/FlavorsOs_Extra_SpecShowResponse' description: Ok - '404': - description: Error summary: Show An Extra Spec For A Flavor tags: - flavors @@ -299,10 +296,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorsOs_Flavor_AccessListResponse' + $ref: '#/components/schemas/FlavorsOs_Flavor_AccessIndexResponse' description: Ok - '404': - description: Error summary: List Flavor Access Information For Given Flavor tags: - flavors @@ -324,8 +319,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete Flavor tags: - flavors @@ -342,10 +335,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorShowResponse' + oneOf: + - $ref: '#/components/schemas/FlavorShowResponse_20' + - $ref: '#/components/schemas/FlavorShowResponse_2102' + - $ref: '#/components/schemas/FlavorShowResponse_255' + - $ref: '#/components/schemas/FlavorShowResponse_261' + - $ref: '#/components/schemas/FlavorShowResponse_275' description: Ok - '404': - description: Error summary: Show Flavor Details tags: - flavors @@ -375,7 +371,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FlavorUpdateResponse' + oneOf: + - $ref: '#/components/schemas/FlavorUpdateResponse_2102' + - $ref: '#/components/schemas/FlavorUpdateResponse_255' + - $ref: '#/components/schemas/FlavorUpdateResponse_261' + - $ref: '#/components/schemas/FlavorUpdateResponse_275' description: Ok '400': description: Error @@ -406,8 +406,8 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/FlavorsActionAddtenantaccessResponse' - - $ref: '#/components/schemas/FlavorsActionRemovetenantaccessResponse' + - $ref: '#/components/schemas/FlavorsAction_Add_Tenant_AccessResponse' + - $ref: '#/components/schemas/FlavorsAction_Remove_Tenant_AccessResponse' description: Ok '400': description: Error @@ -446,10 +446,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesListResponse' + $ref: '#/components/schemas/ImagesIndexResponse_21' description: Ok - '400': - description: Error summary: List Images tags: - images @@ -483,10 +481,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesDetailResponse' + $ref: '#/components/schemas/ImagesDetailDetailResponse_21' description: Ok - '400': - description: Error summary: List Images With Details tags: - images @@ -530,10 +526,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImageShowResponse' + $ref: '#/components/schemas/ImageShowResponse_21' description: Ok - '404': - description: Error summary: Show Image Details tags: - images @@ -557,7 +551,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataListResponse' + $ref: '#/components/schemas/ImagesMetadataIndexResponse_21' description: Ok '403': description: Error @@ -591,7 +585,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataCreateResponse' + $ref: '#/components/schemas/ImagesMetadataCreateResponse_21' description: Ok '400': description: Error @@ -625,7 +619,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataUpdate_AllResponse' + $ref: '#/components/schemas/ImagesMetadataUpdate_AllResponse_21' description: Ok '400': description: Error @@ -676,7 +670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataShowResponse' + $ref: '#/components/schemas/ImagesMetadataShowResponse_21' description: Ok '403': description: Error @@ -710,7 +704,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ImagesMetadataUpdateResponse' + $ref: '#/components/schemas/ImagesMetadataUpdateResponse_21' description: Ok '400': description: Error @@ -740,14 +734,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/LimitsListResponse' + oneOf: + - $ref: '#/components/schemas/LimitsIndexResponse_21' + - $ref: '#/components/schemas/LimitsIndexResponse_236' + - $ref: '#/components/schemas/LimitsIndexResponse_239' + - $ref: '#/components/schemas/LimitsIndexResponse_257' description: Ok summary: Show Rate And Absolute Limits tags: - limits /v2.1/os-agents: get: - deprecated: true description: |- Lists agent builds. @@ -757,18 +754,11 @@ paths: 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. @@ -779,19 +769,12 @@ paths: 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. @@ -803,15 +786,12 @@ paths: 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. @@ -822,13 +802,7 @@ paths: 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 @@ -846,7 +820,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_AggregatesListResponse' + oneOf: + - $ref: '#/components/schemas/Os_AggregatesIndexResponse_21' + - $ref: '#/components/schemas/Os_AggregatesIndexResponse_241' description: Ok summary: List Aggregates tags: @@ -870,7 +846,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_AggregatesCreateResponse' + oneOf: + - $ref: '#/components/schemas/Os_AggregatesCreateResponse_21' + - $ref: '#/components/schemas/Os_AggregatesCreateResponse_241' description: Ok '400': description: Error @@ -911,7 +889,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_AggregateShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_AggregateShowResponse_21' + - $ref: '#/components/schemas/Os_AggregateShowResponse_241' description: Ok '400': description: Error @@ -943,7 +923,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_AggregateUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_AggregateUpdateResponse_21' + - $ref: '#/components/schemas/Os_AggregateUpdateResponse_241' description: Ok '400': description: Error @@ -975,9 +957,12 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/Os_AggregatesActionAdd_HostResponse' - - $ref: '#/components/schemas/Os_AggregatesActionRemove_HostResponse' - - $ref: '#/components/schemas/Os_AggregatesActionSet_MetadataResponse' + - $ref: '#/components/schemas/Os_AggregatesAction_Add_HostResponse_21' + - $ref: '#/components/schemas/Os_AggregatesAction_Add_HostResponse_241' + - $ref: '#/components/schemas/Os_AggregatesAction_Remove_HostResponse_21' + - $ref: '#/components/schemas/Os_AggregatesAction_Remove_HostResponse_241' + - $ref: '#/components/schemas/Os_AggregatesAction_Set_MetadataResponse_21' + - $ref: '#/components/schemas/Os_AggregatesAction_Set_MetadataResponse_241' description: Ok '400': description: Error @@ -1008,10 +993,6 @@ paths: $ref: '#/components/schemas/Os_AggregatesImagesImages_281' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_AggregatesImagesResponse' description: Ok '400': description: Error @@ -1043,8 +1024,6 @@ paths: schema: $ref: '#/components/schemas/Os_Assisted_Volume_SnapshotsCreateResponse' description: Ok - '400': - description: Error summary: Create Assisted Volume Snapshots tags: - os-assisted-volume-snapshots @@ -1090,7 +1069,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Availability_ZoneListResponse' + $ref: '#/components/schemas/Os_Availability_ZoneIndexResponse' description: Ok summary: Get Availability Zone Information tags: @@ -1111,7 +1090,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Availability_ZoneDetailResponse' + $ref: '#/components/schemas/Os_Availability_ZoneDetailDetailResponse' description: Ok summary: Get Detailed Availability Zone Information tags: @@ -1132,7 +1111,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Baremetal_NodesListResponse' + $ref: '#/components/schemas/Os_Baremetal_NodesIndexResponse_21' description: Ok '404': description: Error @@ -1149,13 +1128,7 @@ paths: 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: @@ -1168,8 +1141,6 @@ paths: responses: '204': description: Ok - '400': - description: Error tags: - os-baremetal-nodes x-openstack: @@ -1190,7 +1161,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Baremetal_NodeShowResponse' + $ref: '#/components/schemas/Os_Baremetal_NodeShowResponse_21' description: Ok '404': description: Error @@ -1220,20 +1191,11 @@ paths: 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. @@ -1244,18 +1206,11 @@ paths: 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. @@ -1266,19 +1221,12 @@ paths: 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. @@ -1289,19 +1237,12 @@ paths: 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. @@ -1312,19 +1253,12 @@ paths: 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. @@ -1335,34 +1269,20 @@ paths: 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. @@ -1374,13 +1294,10 @@ paths: responses: '204': description: Ok - '410': - description: Error summary: Delete a Cell tags: - os-cells get: - deprecated: true description: |- Shows data for a cell. @@ -1391,20 +1308,13 @@ paths: 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. @@ -1415,19 +1325,12 @@ paths: 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. @@ -1438,13 +1341,7 @@ paths: 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 @@ -1452,7 +1349,6 @@ paths: - $ref: '#/components/parameters/os_cells_capacities_id' /v2.1/os-certificates: post: - deprecated: true description: |- Creates a root certificate. @@ -1462,38 +1358,24 @@ paths: 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. @@ -1503,18 +1385,11 @@ paths: 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. @@ -1524,13 +1399,7 @@ paths: 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 @@ -1538,19 +1407,12 @@ paths: 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}: @@ -1574,10 +1436,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Console_Auth_TokenShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Console_Auth_TokenShowResponse_21' + - $ref: '#/components/schemas/Os_Console_Auth_TokenShowResponse_299' description: Ok '400': description: Error + '401': + description: Error '404': description: Error summary: Show Console Connection Information @@ -1590,7 +1456,6 @@ paths: - $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. @@ -1601,13 +1466,7 @@ paths: 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 @@ -1629,20 +1488,11 @@ paths: 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. @@ -1653,19 +1503,12 @@ paths: 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. @@ -1677,13 +1520,10 @@ paths: 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. @@ -1694,13 +1534,7 @@ paths: 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 @@ -1708,7 +1542,6 @@ paths: - $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. @@ -1719,19 +1552,12 @@ paths: 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. @@ -1743,15 +1569,12 @@ paths: 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. @@ -1762,13 +1585,7 @@ paths: 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 @@ -1792,7 +1609,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Floating_Ip_PoolsListResponse' + $ref: '#/components/schemas/Os_Floating_Ip_PoolsIndexResponse_21' description: Ok summary: List Floating Ip Pools tags: @@ -1819,7 +1636,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Floating_IpsListResponse' + $ref: '#/components/schemas/Os_Floating_IpsIndexResponse_21' description: Ok summary: List Floating Ip Addresses tags: @@ -1850,7 +1667,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Floating_IpsCreateResponse' + $ref: '#/components/schemas/Os_Floating_IpsCreateResponse_21' description: Ok '400': description: Error @@ -1866,7 +1683,6 @@ paths: min-ver: '2.1' /v2.1/os-floating-ips-bulk: get: - deprecated: true description: |- Lists all floating IPs. @@ -1877,18 +1693,11 @@ paths: 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. @@ -1899,19 +1708,12 @@ paths: 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. @@ -1922,30 +1724,17 @@ paths: 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}: @@ -2003,7 +1792,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Floating_IpShowResponse' + $ref: '#/components/schemas/Os_Floating_IpShowResponse_21' description: Ok '400': description: Error @@ -2019,7 +1808,6 @@ paths: - $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. @@ -2038,19 +1826,12 @@ paths: 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. @@ -2065,13 +1846,7 @@ paths: 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 @@ -2094,7 +1869,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostsListResponse' + $ref: '#/components/schemas/Os_HostsIndexResponse_21' description: Ok summary: List Hosts tags: @@ -2117,10 +1892,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostShowResponse' + $ref: '#/components/schemas/Os_HostShowResponse_21' description: Ok - '404': - description: Error summary: Show Host Details tags: - os-hosts @@ -2149,7 +1922,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostUpdateResponse' + $ref: '#/components/schemas/Os_HostUpdateResponse_21' description: Ok '400': description: Error @@ -2179,7 +1952,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostsRebootResponse' + $ref: '#/components/schemas/Os_HostsRebootRebootResponse_21' description: Ok '400': description: Error @@ -2211,7 +1984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostsShutdownResponse' + $ref: '#/components/schemas/Os_HostsShutdownShutdownResponse_21' description: Ok '400': description: Error @@ -2243,7 +2016,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HostsStartupResponse' + $ref: '#/components/schemas/Os_HostsStartupStartupResponse_21' description: Ok '400': description: Error @@ -2283,7 +2056,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsListResponse' + oneOf: + - $ref: '#/components/schemas/Os_HypervisorsIndexResponse_21' + - $ref: '#/components/schemas/Os_HypervisorsIndexResponse_233' + - $ref: '#/components/schemas/Os_HypervisorsIndexResponse_253' description: Ok '400': description: Error @@ -2319,7 +2095,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsDetailResponse' + oneOf: + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_21' + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_228' + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_233' + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_253' + - $ref: '#/components/schemas/Os_HypervisorsDetailDetailResponse_288' description: Ok '400': description: Error @@ -2350,7 +2131,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsStatisticsResponse' + $ref: '#/components/schemas/Os_HypervisorsStatisticsStatisticsResponse_21' description: Ok summary: Show Hypervisor Statistics (DEPRECATED) tags: @@ -2379,7 +2160,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_HypervisorShowResponse_21' + - $ref: '#/components/schemas/Os_HypervisorShowResponse_228' + - $ref: '#/components/schemas/Os_HypervisorShowResponse_253' + - $ref: '#/components/schemas/Os_HypervisorShowResponse_288' description: Ok '400': description: Error @@ -2412,10 +2197,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsSearchResponse' + $ref: '#/components/schemas/Os_HypervisorsSearchSearchResponse_21' description: Ok - '404': - description: Error summary: Search Hypervisor (DEPRECATED) tags: - os-hypervisors @@ -2444,10 +2227,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsServersResponse' + $ref: '#/components/schemas/Os_HypervisorsServersServersResponse_21' description: Ok - '404': - description: Error summary: List Hypervisor Servers (DEPRECATED) tags: - os-hypervisors @@ -2475,7 +2256,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_HypervisorsUptimeResponse' + oneOf: + - $ref: '#/components/schemas/Os_HypervisorsUptimeUptimeResponse_21' + - $ref: '#/components/schemas/Os_HypervisorsUptimeUptimeResponse_253' description: Ok '400': description: Error @@ -2506,7 +2289,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Instance_Usage_Audit_LogListResponse' + $ref: '#/components/schemas/Os_Instance_Usage_Audit_LogIndexResponse' description: Ok summary: List Server Usage Audits tags: @@ -2527,8 +2310,6 @@ paths: 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 @@ -2553,10 +2334,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_KeypairsListResponse' + oneOf: + - $ref: '#/components/schemas/Os_KeypairsIndexResponse_20' + - $ref: '#/components/schemas/Os_KeypairsIndexResponse_22' + - $ref: '#/components/schemas/Os_KeypairsIndexResponse_235' description: Ok - '400': - description: Error summary: List Keypairs tags: - os-keypairs @@ -2581,7 +2363,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_KeypairsCreateResponse' + oneOf: + - $ref: '#/components/schemas/Os_KeypairsCreateResponse_20' + - $ref: '#/components/schemas/Os_KeypairsCreateResponse_22' + - $ref: '#/components/schemas/Os_KeypairsCreateResponse_292' description: Ok '400': description: Error @@ -2607,8 +2392,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete Keypair tags: - os-keypairs @@ -2631,10 +2414,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_KeypairShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_KeypairShowResponse_20' + - $ref: '#/components/schemas/Os_KeypairShowResponse_22' description: Ok - '404': - description: Error summary: Show Keypair Details tags: - os-keypairs @@ -2678,10 +2461,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_MigrationsListResponse' + oneOf: + - $ref: '#/components/schemas/Os_MigrationsIndexResponse_20' + - $ref: '#/components/schemas/Os_MigrationsIndexResponse_223' + - $ref: '#/components/schemas/Os_MigrationsIndexResponse_259' + - $ref: '#/components/schemas/Os_MigrationsIndexResponse_280' description: Ok - '400': - description: Error summary: List Migrations tags: - os-migrations @@ -2706,7 +2491,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_NetworksListResponse' + $ref: '#/components/schemas/Os_NetworksIndexResponse_21' description: Ok summary: List Networks tags: @@ -2715,7 +2500,6 @@ paths: max-ver: '2.35' min-ver: '2.1' post: - deprecated: true description: |- Creates a network. @@ -2730,19 +2514,12 @@ paths: 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. @@ -2757,19 +2534,12 @@ paths: 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. @@ -2785,8 +2555,6 @@ paths: responses: '204': description: Ok - '410': - description: Error summary: Delete Network tags: - os-networks @@ -2807,10 +2575,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_NetworkShowResponse' + $ref: '#/components/schemas/Os_NetworkShowResponse_21' description: Ok - '404': - description: Error summary: Show Network Details tags: - os-networks @@ -2837,17 +2603,7 @@ paths: 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}: @@ -2864,7 +2620,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse_21' + - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse_250' + - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse_257' description: Ok summary: Show the quota for Quota Class tags: @@ -2893,10 +2652,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse_21' + - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse_250' + - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse_257' description: Ok - '400': - description: Error summary: Create or Update Quotas for Quota Class tags: - quota-class-sets-os-quota-class-sets @@ -2934,10 +2694,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_SetShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_SetShowResponse_20' + - $ref: '#/components/schemas/Os_Quota_SetShowResponse_236' + - $ref: '#/components/schemas/Os_Quota_SetShowResponse_257' description: Ok - '400': - description: Error summary: Show A Quota tags: - quota-sets-os-quota-sets @@ -2968,10 +2729,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse_20' + - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse_236' + - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse_257' description: Ok - '400': - description: Error summary: Update Quotas tags: - quota-sets-os-quota-sets @@ -2989,10 +2751,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_SetsDefaultsResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_SetsDefaultsDefaultsResponse_20' + - $ref: '#/components/schemas/Os_Quota_SetsDefaultsDefaultsResponse_236' + - $ref: '#/components/schemas/Os_Quota_SetsDefaultsDefaultsResponse_257' description: Ok - '400': - description: Error summary: List Default Quotas For Tenant tags: - quota-sets-os-quota-sets @@ -3018,10 +2781,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_SetsDetailResponse' + oneOf: + - $ref: '#/components/schemas/Os_Quota_SetsDetailDetailResponse_20' + - $ref: '#/components/schemas/Os_Quota_SetsDetailDetailResponse_236' + - $ref: '#/components/schemas/Os_Quota_SetsDetailDetailResponse_257' description: Ok - '400': - description: Error summary: Show The Detail of Quota tags: - quota-sets-os-quota-sets @@ -3029,7 +2793,6 @@ paths: - $ref: '#/components/parameters/os_quota_sets_detail_id' /v2.1/os-security-group-default-rules: get: - deprecated: true description: |- Lists default security group rules. @@ -3040,18 +2803,11 @@ paths: 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. @@ -3065,19 +2821,12 @@ paths: 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. @@ -3089,13 +2838,10 @@ paths: 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. @@ -3106,13 +2852,7 @@ paths: 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 @@ -3139,7 +2879,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_Group_RulesCreateResponse' + $ref: '#/components/schemas/Os_Security_Group_RulesCreateResponse_21' description: Ok '400': description: Error @@ -3199,10 +2939,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_GroupsListResponse' + $ref: '#/components/schemas/Os_Security_GroupsIndexResponse_21' description: Ok - '404': - description: Error summary: List Security Groups tags: - os-security-groups @@ -3228,7 +2966,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_GroupsCreateResponse' + $ref: '#/components/schemas/Os_Security_GroupsCreateResponse_21' description: Ok '400': description: Error @@ -3277,7 +3015,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_GroupShowResponse' + $ref: '#/components/schemas/Os_Security_GroupShowResponse_21' description: Ok '400': description: Error @@ -3310,7 +3048,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Security_GroupUpdateResponse' + $ref: '#/components/schemas/Os_Security_GroupUpdateResponse_21' description: Ok '400': description: Error @@ -3350,10 +3088,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_20' + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_251' + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_276' + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_282' + - $ref: '#/components/schemas/Os_Server_External_EventsCreateResponse_293' description: Ok - '403': - description: Error summary: Run Events tags: - os-server-external-events @@ -3377,7 +3118,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Server_GroupsListResponse' + oneOf: + - $ref: '#/components/schemas/Os_Server_GroupsIndexResponse_21' + - $ref: '#/components/schemas/Os_Server_GroupsIndexResponse_213' + - $ref: '#/components/schemas/Os_Server_GroupsIndexResponse_215' + - $ref: '#/components/schemas/Os_Server_GroupsIndexResponse_264' description: Ok summary: List Server Groups tags: @@ -3400,7 +3145,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse_21' + - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse_213' + - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse_215' + - $ref: '#/components/schemas/Os_Server_GroupsCreateResponse_264' description: Ok '400': description: Error @@ -3423,8 +3172,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete Server Group tags: - os-server-groups @@ -3441,10 +3188,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Server_GroupShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Server_GroupShowResponse_21' + - $ref: '#/components/schemas/Os_Server_GroupShowResponse_213' + - $ref: '#/components/schemas/Os_Server_GroupShowResponse_215' + - $ref: '#/components/schemas/Os_Server_GroupShowResponse_264' description: Ok - '404': - description: Error summary: Show Server Group Details tags: - os-server-groups @@ -3469,7 +3218,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_ServicesListResponse' + oneOf: + - $ref: '#/components/schemas/Os_ServicesIndexResponse_20' + - $ref: '#/components/schemas/Os_ServicesIndexResponse_211' + - $ref: '#/components/schemas/Os_ServicesIndexResponse_253' + - $ref: '#/components/schemas/Os_ServicesIndexResponse_269' description: Ok summary: List Compute Services tags: @@ -3532,7 +3285,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_ServiceUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_ServiceUpdateResponse_20' + - $ref: '#/components/schemas/Os_ServiceUpdateResponse_253' + - $ref: '#/components/schemas/Os_ServiceUpdateResponse_269' description: Ok '400': description: Error @@ -3562,10 +3318,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Simple_Tenant_UsageListResponse' + oneOf: + - $ref: '#/components/schemas/Os_Simple_Tenant_UsageIndexResponse_21' + - $ref: '#/components/schemas/Os_Simple_Tenant_UsageIndexResponse_240' description: Ok - '400': - description: Error summary: List Tenant Usage Statistics For All Tenants tags: - os-simple-tenant-usage @@ -3592,10 +3348,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Simple_Tenant_UsageShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Simple_Tenant_UsageShowResponse_21' + - $ref: '#/components/schemas/Os_Simple_Tenant_UsageShowResponse_240' description: Ok - '400': - description: Error summary: Show Usage Statistics For Tenant tags: - os-simple-tenant-usage @@ -3622,7 +3378,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_SnapshotsListResponse' + $ref: '#/components/schemas/Os_SnapshotsIndexResponse_21' description: Ok summary: List Snapshots tags: @@ -3649,7 +3405,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_SnapshotsCreateResponse' + $ref: '#/components/schemas/Os_SnapshotsCreateResponse_21' description: Ok '400': description: Error @@ -3679,7 +3435,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_SnapshotsDetailResponse' + $ref: '#/components/schemas/Os_SnapshotsDetailDetailResponse_21' description: Ok summary: List Snapshots With Details tags: @@ -3702,8 +3458,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Delete Snapshot tags: - os-snapshots @@ -3724,10 +3478,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_SnapshotShowResponse' + $ref: '#/components/schemas/Os_SnapshotShowResponse_21' description: Ok - '404': - description: Error summary: Show Snapshot Details tags: - os-snapshots @@ -3755,7 +3507,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Tenant_NetworksListResponse' + $ref: '#/components/schemas/Os_Tenant_NetworksIndexResponse_21' description: Ok summary: List Project Networks tags: @@ -3764,7 +3516,6 @@ paths: max-ver: '2.35' min-ver: '2.1' post: - deprecated: true description: |- Creates a project network. @@ -3781,19 +3532,12 @@ paths: 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. @@ -3809,8 +3553,6 @@ paths: responses: '204': description: Ok - '410': - description: Error summary: Delete Project Network tags: - os-tenant-networks @@ -3832,10 +3574,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Tenant_NetworkShowResponse' + $ref: '#/components/schemas/Os_Tenant_NetworkShowResponse_21' description: Ok - '404': - description: Error summary: Show Project Network Details tags: - os-tenant-networks @@ -3862,7 +3602,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_VolumesListResponse' + $ref: '#/components/schemas/Os_VolumesIndexResponse_21' description: Ok summary: List Volumes tags: @@ -3890,7 +3630,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_VolumesCreateResponse' + $ref: '#/components/schemas/Os_VolumesCreateResponse_21' description: Ok '400': description: Error @@ -3922,7 +3662,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_VolumesDetailResponse' + $ref: '#/components/schemas/Os_VolumesDetailDetailResponse_21' description: Ok summary: List Volumes With Details tags: @@ -3967,10 +3707,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_VolumeShowResponse' + $ref: '#/components/schemas/Os_VolumeShowResponse_21' description: Ok - '404': - description: Error summary: Show Volume Details tags: - os-volumes @@ -4048,7 +3786,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootListResponse' + oneOf: + - $ref: '#/components/schemas/Os_Volumes_BootIndexResponse_21' + - $ref: '#/components/schemas/Os_Volumes_BootIndexResponse_269' description: Ok '400': description: Error @@ -4074,7 +3814,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootCreateResponse' + $ref: '#/components/schemas/Os_Volumes_BootCreateResponse_21' description: Ok '400': description: Error @@ -4156,7 +3896,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootDetailResponse' + oneOf: + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_21' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_2100' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_216' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_219' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_226' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_23' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_247' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_263' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_269' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_273' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_29' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_290' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_296' + - $ref: '#/components/schemas/Os_Volumes_BootDetailDetailResponse_298' description: Ok '400': description: Error @@ -4195,10 +3949,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootShowResponse' + oneOf: + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_20' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_2100' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_216' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_219' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_226' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_23' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_247' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_263' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_269' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_271' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_273' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_29' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_290' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_296' + - $ref: '#/components/schemas/Os_Volumes_BootShowResponse_298' description: Ok - '404': - description: Error tags: - os-volumes_boot x-openstack: @@ -4221,10 +3988,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_20' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_2100' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_219' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_226' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_247' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_263' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_271' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_273' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_275' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_29' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_296' + - $ref: '#/components/schemas/Os_Volumes_BootUpdateResponse_298' description: Ok - '404': - description: Error tags: - os-volumes_boot x-openstack: @@ -4257,15 +4034,21 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/Os_Volumes_BootActionConfirmresizeResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionCreateimageResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionOs-StartResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionOs-StopResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionRebootResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionRebuildResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionResizeResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionRevertresizeResponse' - - $ref: '#/components/schemas/Os_Volumes_BootActionTrigger_Crash_DumpResponse' + - $ref: '#/components/schemas/Os_Volumes_BootAction_Create_ImageResponse_245' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_20' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_2100' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_219' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_226' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_247' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_254' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_257' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_263' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_271' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_273' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_275' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_29' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_296' + - $ref: '#/components/schemas/Os_Volumes_BootAction_RebuildResponse_298' description: Ok '400': description: Error @@ -4363,7 +4146,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersListResponse' + oneOf: + - $ref: '#/components/schemas/ServersIndexResponse_21' + - $ref: '#/components/schemas/ServersIndexResponse_269' description: Ok '400': description: Error @@ -4514,7 +4299,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersDetailResponse' + oneOf: + - $ref: '#/components/schemas/ServersDetailDetailResponse_21' + - $ref: '#/components/schemas/ServersDetailDetailResponse_2100' + - $ref: '#/components/schemas/ServersDetailDetailResponse_216' + - $ref: '#/components/schemas/ServersDetailDetailResponse_219' + - $ref: '#/components/schemas/ServersDetailDetailResponse_226' + - $ref: '#/components/schemas/ServersDetailDetailResponse_23' + - $ref: '#/components/schemas/ServersDetailDetailResponse_247' + - $ref: '#/components/schemas/ServersDetailDetailResponse_263' + - $ref: '#/components/schemas/ServersDetailDetailResponse_269' + - $ref: '#/components/schemas/ServersDetailDetailResponse_273' + - $ref: '#/components/schemas/ServersDetailDetailResponse_29' + - $ref: '#/components/schemas/ServersDetailDetailResponse_290' + - $ref: '#/components/schemas/ServersDetailDetailResponse_296' + - $ref: '#/components/schemas/ServersDetailDetailResponse_298' description: Ok '400': description: Error @@ -4583,10 +4382,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServerShowResponse' + oneOf: + - $ref: '#/components/schemas/ServerShowResponse_20' + - $ref: '#/components/schemas/ServerShowResponse_2100' + - $ref: '#/components/schemas/ServerShowResponse_216' + - $ref: '#/components/schemas/ServerShowResponse_219' + - $ref: '#/components/schemas/ServerShowResponse_226' + - $ref: '#/components/schemas/ServerShowResponse_23' + - $ref: '#/components/schemas/ServerShowResponse_247' + - $ref: '#/components/schemas/ServerShowResponse_263' + - $ref: '#/components/schemas/ServerShowResponse_269' + - $ref: '#/components/schemas/ServerShowResponse_271' + - $ref: '#/components/schemas/ServerShowResponse_273' + - $ref: '#/components/schemas/ServerShowResponse_29' + - $ref: '#/components/schemas/ServerShowResponse_290' + - $ref: '#/components/schemas/ServerShowResponse_296' + - $ref: '#/components/schemas/ServerShowResponse_298' description: Ok - '404': - description: Error summary: Show Server Details tags: - servers @@ -4611,10 +4423,20 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServerUpdateResponse' + oneOf: + - $ref: '#/components/schemas/ServerUpdateResponse_20' + - $ref: '#/components/schemas/ServerUpdateResponse_2100' + - $ref: '#/components/schemas/ServerUpdateResponse_219' + - $ref: '#/components/schemas/ServerUpdateResponse_226' + - $ref: '#/components/schemas/ServerUpdateResponse_247' + - $ref: '#/components/schemas/ServerUpdateResponse_263' + - $ref: '#/components/schemas/ServerUpdateResponse_271' + - $ref: '#/components/schemas/ServerUpdateResponse_273' + - $ref: '#/components/schemas/ServerUpdateResponse_275' + - $ref: '#/components/schemas/ServerUpdateResponse_29' + - $ref: '#/components/schemas/ServerUpdateResponse_296' + - $ref: '#/components/schemas/ServerUpdateResponse_298' description: Ok - '404': - description: Error summary: Update Server tags: - servers @@ -4677,16 +4499,29 @@ paths: 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' + - $ref: '#/components/schemas/ServersActionGet_Console_OutputResponse' + - $ref: '#/components/schemas/ServersActionGet_Rdp_ConsoleResponse_21' + - $ref: '#/components/schemas/ServersActionGet_Serial_ConsoleResponse_21' + - $ref: '#/components/schemas/ServersActionGet_Spice_ConsoleResponse_21' + - $ref: '#/components/schemas/ServersActionGet_Vnc_ConsoleResponse_21' + - $ref: '#/components/schemas/ServersAction_Create_BackupResponse_245' + - $ref: '#/components/schemas/ServersAction_Create_ImageResponse_245' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_20' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_2100' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_219' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_226' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_247' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_254' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_257' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_263' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_271' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_273' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_275' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_29' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_296' + - $ref: '#/components/schemas/ServersAction_RebuildResponse_298' + - $ref: '#/components/schemas/ServersAction_RescueResponse' description: Ok '202': description: Accepted @@ -4709,15 +4544,12 @@ paths: 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. @@ -4727,20 +4559,13 @@ paths: 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. @@ -4751,19 +4576,12 @@ paths: 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. @@ -4775,13 +4593,10 @@ paths: responses: '204': description: Ok - '410': - description: Error summary: Delete Console tags: - servers get: - deprecated: true description: |- Shows console details for a server. @@ -4792,13 +4607,7 @@ paths: 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 @@ -4823,7 +4632,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersDiagnosticsListResponse' + oneOf: + - $ref: '#/components/schemas/ServersDiagnosticsIndexResponse_21' + - $ref: '#/components/schemas/ServersDiagnosticsIndexResponse_248' description: Ok '400': description: Error @@ -4856,10 +4667,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersIpsListResponse' + $ref: '#/components/schemas/ServersIpsIndexResponse' description: Ok - '404': - description: Error summary: List Ips tags: - servers @@ -4885,8 +4694,6 @@ paths: schema: $ref: '#/components/schemas/ServersIpShowResponse' description: Ok - '404': - description: Error summary: Show Ip Details tags: - servers @@ -4909,10 +4716,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersMetadataListResponse' + $ref: '#/components/schemas/ServersMetadataIndexResponse' description: Ok - '404': - description: Error summary: List All Metadata tags: - servers @@ -5026,8 +4831,6 @@ paths: schema: $ref: '#/components/schemas/ServersMetadataShowResponse' description: Ok - '404': - description: Error summary: Show Metadata Item Details tags: - servers @@ -5089,10 +4892,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersMigrationsListResponse' + oneOf: + - $ref: '#/components/schemas/ServersMigrationsIndexResponse_223' + - $ref: '#/components/schemas/ServersMigrationsIndexResponse_259' + - $ref: '#/components/schemas/ServersMigrationsIndexResponse_280' description: Ok - '404': - description: Error summary: List Migrations tags: - server-migrations @@ -5168,10 +4972,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersMigrationShowResponse' + oneOf: + - $ref: '#/components/schemas/ServersMigrationShowResponse_223' + - $ref: '#/components/schemas/ServersMigrationShowResponse_259' + - $ref: '#/components/schemas/ServersMigrationShowResponse_280' description: Ok - '404': - description: Error summary: Show Migration Details tags: - server-migrations @@ -5234,7 +5039,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Instance_ActionsListResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Instance_ActionsIndexResponse_21' + - $ref: '#/components/schemas/ServersOs_Instance_ActionsIndexResponse_258' description: Ok '400': description: Error @@ -5269,10 +5076,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_21' + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_251' + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_258' + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_262' + - $ref: '#/components/schemas/ServersOs_Instance_ActionShowResponse_284' description: Ok - '404': - description: Error summary: Show Server Action Details tags: - servers @@ -5294,7 +5104,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_InterfaceListResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_InterfaceIndexResponse_21' + - $ref: '#/components/schemas/ServersOs_InterfaceIndexResponse_270' description: Ok '404': description: Error @@ -5324,7 +5136,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_InterfaceCreateResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_InterfaceCreateResponse_21' + - $ref: '#/components/schemas/ServersOs_InterfaceCreateResponse_270' description: Ok '400': description: Error @@ -5378,7 +5192,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_InterfaceShowResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_InterfaceShowResponse_21' + - $ref: '#/components/schemas/ServersOs_InterfaceShowResponse_270' description: Ok '403': description: Error @@ -5404,10 +5220,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Security_GroupsListResponse' + $ref: '#/components/schemas/ServersOs_Security_GroupsIndexResponse' description: Ok - '404': - description: Error summary: List Security Groups By Server tags: - servers @@ -5432,8 +5246,6 @@ paths: responses: '204': description: Ok - '404': - description: Error summary: Clear Admin Password tags: - servers @@ -5461,10 +5273,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Server_PasswordListResponse' + $ref: '#/components/schemas/ServersOs_Server_PasswordIndexResponse' description: Ok - '404': - description: Error summary: Show Server Password tags: - servers @@ -5472,7 +5282,6 @@ paths: - $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. @@ -5487,13 +5296,7 @@ paths: 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 @@ -5516,10 +5319,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsListResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsIndexResponse_20' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsIndexResponse_270' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsIndexResponse_279' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsIndexResponse_289' description: Ok - '404': - description: Error summary: List volume attachments for an instance tags: - servers @@ -5543,7 +5348,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateResponse_20' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateResponse_270' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreateResponse_279' description: Ok '400': description: Error @@ -5592,10 +5400,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse' + oneOf: + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse_20' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse_270' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse_279' + - $ref: '#/components/schemas/ServersOs_Volume_AttachmentShowResponse_289' description: Ok - '404': - description: Error summary: Show a detail of a volume attachment tags: - servers @@ -5662,7 +5472,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersRemote_ConsolesCreateResponse' + oneOf: + - $ref: '#/components/schemas/ServersRemote_ConsolesCreateResponse_26' + - $ref: '#/components/schemas/ServersRemote_ConsolesCreateResponse_28' + - $ref: '#/components/schemas/ServersRemote_ConsolesCreateResponse_299' description: Ok '400': description: Error @@ -5691,7 +5504,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersSharesListResponse' + $ref: '#/components/schemas/ServersSharesIndexResponse_297' description: Ok '400': description: Error @@ -5724,7 +5537,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersSharesCreateResponse' + $ref: '#/components/schemas/ServersSharesCreateResponse_297' description: Ok '400': description: Error @@ -5777,7 +5590,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersShareShowResponse' + $ref: '#/components/schemas/ServersShareShowResponse_297' description: Ok '400': description: Error @@ -5827,10 +5640,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersTagsListResponse' + $ref: '#/components/schemas/ServersTagsIndexResponse_226' description: Ok - '404': - description: Error summary: List Tags tags: - server-tags @@ -5856,7 +5667,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersTagsUpdate_AllResponse' + $ref: '#/components/schemas/ServersTagsUpdate_AllResponse_226' description: Ok '404': description: Error @@ -5899,13 +5710,7 @@ paths: 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 @@ -5957,10 +5762,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ServersTopologyListResponse' + $ref: '#/components/schemas/ServersTopologyIndexResponse_278' description: Ok - '404': - description: Error summary: Show Server Topology tags: - servers @@ -5978,8 +5781,6 @@ paths: schema: $ref: '#/components/schemas/VersionShowResponse' description: Ok - '404': - description: Error tags: - version parameters: @@ -6006,7 +5807,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_limit: in: query @@ -6019,7 +5819,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_marker: in: query @@ -6027,7 +5826,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_minDisk: in: query @@ -6035,7 +5833,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_minRam: in: query @@ -6043,7 +5840,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_name: in: query @@ -6051,7 +5847,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.102' flavors_detail_sort_dir: in: query @@ -6062,7 +5857,6 @@ components: - desc type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_detail_sort_key: in: query @@ -6085,7 +5879,6 @@ components: - vcpus type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_id: description: id parameter for /v2.1/flavors/{id} API @@ -6100,7 +5893,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_limit: in: query @@ -6113,7 +5905,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_marker: in: query @@ -6121,7 +5912,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_minDisk: in: query @@ -6129,7 +5919,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_minRam: in: query @@ -6137,7 +5926,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_name: in: query @@ -6145,7 +5933,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.102' flavors_os_extra_specs_flavor_id: description: flavor_id parameter for @@ -6180,7 +5967,6 @@ components: - desc type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' flavors_sort_key: in: query @@ -6203,7 +5989,6 @@ components: - vcpus type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' images_changes-since: in: query @@ -6416,9 +6201,6 @@ components: 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 @@ -6453,7 +6235,6 @@ components: 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 @@ -7000,7 +6781,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' resource_link: identity/v3/user.id os_quota_sets_defaults_id: @@ -7023,7 +6803,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' resource_link: identity/v3/user.id os_quota_sets_id: @@ -7092,7 +6871,6 @@ components: 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 @@ -7112,7 +6890,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' os_server_groups_offset: in: query @@ -7125,7 +6902,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' os_services_binary: in: query @@ -7133,7 +6909,6 @@ components: schema: type: string x-openstack: - max-ver: '2.74' min-ver: '2.0' os_services_host: in: query @@ -7141,7 +6916,6 @@ components: 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 @@ -8403,18 +8177,12 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_access_ip_v6: in: query name: access_ip_v6 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_action_id: description: id parameter for /v2.1/servers/{id}/action API in: path @@ -8427,35 +8195,23 @@ components: name: all_tenants schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_auto_disk_config: in: query name: auto_disk_config schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_availability_zone: in: query name: availability_zone schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_block_device_mapping: in: query name: block_device_mapping schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_changes-before: in: query name: changes-before @@ -8463,8 +8219,6 @@ components: format: date-time type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.66' servers_changes-since: in: query @@ -8472,18 +8226,12 @@ components: schema: format: date-time type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_config_drive: in: query name: config_drive schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_consoles_id: description: id parameter for /v2.1/servers/{server_id}/consoles/{id} API in: path @@ -8505,78 +8253,51 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_deleted: in: query name: deleted schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_description: in: query name: description schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_access_ip_v4: in: query name: access_ip_v4 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_access_ip_v6: in: query name: access_ip_v6 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_all_tenants: in: query name: all_tenants schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_auto_disk_config: in: query name: auto_disk_config schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_availability_zone: in: query name: availability_zone schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_block_device_mapping: in: query name: block_device_mapping schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_changes-before: in: query name: changes-before @@ -8584,8 +8305,6 @@ components: format: date-time type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.66' servers_detail_changes-since: in: query @@ -8593,165 +8312,108 @@ components: schema: format: date-time type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_config_drive: in: query name: config_drive schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_created_at: in: query name: created_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_deleted: in: query name: deleted schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_description: in: query name: description schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_display_description: in: query name: display_description schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_display_name: in: query name: display_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_flavor: in: query name: flavor schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_host: in: query name: host schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_hostname: in: query name: hostname schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_image: in: query name: image schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_image_ref: in: query name: image_ref schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_info_cache: in: query name: info_cache schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_ip: in: query name: ip schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_ip6: in: query name: ip6 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_kernel_id: in: query name: kernel_id schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_key_name: in: query name: key_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_launch_index: in: query name: launch_index schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_launched_at: in: query name: launched_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_limit: in: query name: limit @@ -8762,17 +8424,12 @@ components: type: - integer - string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_locked: in: query name: locked schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.73' servers_detail_locked_by: in: query @@ -8780,43 +8437,28 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_marker: in: query name: marker schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_metadata: in: query name: metadata schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_name: in: query name: name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_node: in: query name: node schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_not-tags: in: query name: not-tags @@ -8824,8 +8466,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_detail_not-tags-any: in: query @@ -8834,43 +8474,30 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_detail_pci_devices: in: query name: pci_devices schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_power_state: in: query name: power_state schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_progress: in: query name: progress schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_project_id: in: query name: project_id schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' resource_link: identity/v3/project.id servers_detail_ramdisk_id: in: query @@ -8878,59 +8505,38 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_reservation_id: in: query name: reservation_id schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_root_device_name: in: query name: root_device_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_security_groups: in: query name: security_groups schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_services: in: query name: services schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_soft_deleted: in: query name: soft_deleted schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_sort_dir: in: query name: sort_dir schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_sort_key: in: query name: sort_key @@ -8967,25 +8573,16 @@ components: - uuid - vm_state type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_status: in: query name: status schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_system_metadata: in: query name: system_metadata schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_tags: in: query name: tags @@ -8993,8 +8590,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_detail_tags-any: in: query @@ -9003,59 +8598,40 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_detail_task_state: in: query name: task_state schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_tenant_id: in: query name: tenant_id schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_terminated_at: in: query name: terminated_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_user_id: in: query name: user_id schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' resource_link: identity/v3/user.id servers_detail_uuid: in: query name: uuid schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_detail_vm_state: in: query name: vm_state schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_diagnostics_server_id: description: server_id parameter for /v2.1/servers/{server_id}/diagnostics API @@ -9070,44 +8646,29 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_display_name: in: query name: display_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_flavor: in: query name: flavor schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_host: in: query name: host schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_hostname: in: query name: hostname schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_id: description: id parameter for /v2.1/servers/{id} API in: path @@ -9120,43 +8681,28 @@ components: name: image schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_image_ref: in: query name: image_ref schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_info_cache: in: query name: info_cache schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_ip: in: query name: ip schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_ip6: in: query name: ip6 schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_ips_id: description: id parameter for /v2.1/servers/{server_id}/ips/{id} API in: path @@ -9178,35 +8724,23 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_key_name: in: query name: key_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_launch_index: in: query name: launch_index schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_launched_at: in: query name: launched_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_limit: in: query name: limit @@ -9217,17 +8751,12 @@ components: type: - integer - string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_locked: in: query name: locked schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.73' servers_locked_by: in: query @@ -9235,25 +8764,16 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_marker: in: query name: marker schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_metadata: in: query name: metadata schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_metadata_id: description: id parameter for /v2.1/servers/{server_id}/metadata/{id} API in: path @@ -9307,18 +8827,12 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_node: in: query name: node schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_not-tags: in: query name: not-tags @@ -9326,8 +8840,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_not-tags-any: in: query @@ -9336,8 +8848,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_os_instance_actions_changes-before: in: query @@ -9456,7 +8966,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' servers_os_volume_attachments_offset: in: query @@ -9469,7 +8978,6 @@ components: - integer - string x-openstack: - max-ver: '2.74' min-ver: '2.0' servers_os_volume_attachments_server_id: description: server_id parameter for @@ -9484,35 +8992,24 @@ components: name: pci_devices schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_power_state: in: query name: power_state schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_progress: in: query name: progress schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_project_id: in: query name: project_id schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' resource_link: identity/v3/project.id servers_ramdisk_id: in: query @@ -9520,9 +9017,6 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_remote_consoles_server_id: description: server_id parameter for /v2.1/servers/{server_id}/remote-consoles API @@ -9537,34 +9031,22 @@ components: schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_root_device_name: in: query name: root_device_name schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_security_groups: in: query name: security_groups schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_services: in: query name: services schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_shares_id: description: id parameter for /v2.1/servers/{server_id}/shares/{id} API in: path @@ -9585,17 +9067,11 @@ components: name: soft_deleted schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_sort_dir: in: query name: sort_dir schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_sort_key: in: query name: sort_key @@ -9632,25 +9108,16 @@ components: - uuid - vm_state type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_status: in: query name: status schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_system_metadata: in: query name: system_metadata schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_tags: in: query name: tags @@ -9658,8 +9125,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_tags-any: in: query @@ -9668,8 +9133,6 @@ components: format: regex type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' min-ver: '2.26' servers_tags_id: description: id parameter for /v2.1/servers/{server_id}/tags/{id} API @@ -9691,26 +9154,17 @@ components: name: task_state schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_tenant_id: in: query name: tenant_id schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_terminated_at: in: query name: terminated_at schema: format: regex type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_topology_server_id: description: server_id parameter for /v2.1/servers/{server_id}/topology API @@ -9725,25 +9179,17 @@ components: schema: type: string x-openstack: - max-ver: '2.25' - max_ver: '2.74' resource_link: identity/v3/user.id servers_uuid: in: query name: uuid schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' servers_vm_state: in: query name: vm_state schema: type: string - x-openstack: - max-ver: '2.25' - max_ver: '2.74' versions_id: description: id parameter for /v2.1/versions/{id} API in: path @@ -9753,9 +9199,10 @@ components: type: string schemas: ExtensionShowResponse: - description: An extension object. + additionalProperties: false properties: extension: + additionalProperties: false description: |- An `extension` object. properties: @@ -9772,13 +9219,9 @@ components: 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 + format: url type: string rel: type: string @@ -9808,19 +9251,23 @@ components: type: string required: - alias + - description + - links - name + - namespace + - updated type: object required: - extension type: object - ExtensionsListResponse: - description: An extension object. + ExtensionsIndexResponse: + additionalProperties: false properties: extensions: description: |- List of `extension` objects. items: - description: An extension object. + additionalProperties: false properties: alias: description: |- @@ -9835,13 +9282,9 @@ components: 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 + format: url type: string rel: type: string @@ -9871,13 +9314,118 @@ components: type: string required: - alias + - description + - links - name + - namespace + - updated type: object type: array required: - extensions type: object - FlavorShowResponse: + FlavorShowResponse_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-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`. + + **Available until version 2.101** + 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 + 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 + 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 + - disk + - id + - links + - name + - os-flavor-access:is_public + - ram + - rxtx_factor + - swap + - vcpus + type: object + required: + - flavor + type: object + x-openstack: + max-ver: '2.54' + min-ver: '2.0' + FlavorShowResponse_2102: additionalProperties: false properties: flavor: @@ -9983,7 +9531,9 @@ components: required: - flavor type: object - FlavorUpdateResponse: + x-openstack: + min-ver: '2.102' + FlavorShowResponse_255: additionalProperties: false properties: flavor: @@ -9992,6 +9542,15 @@ components: 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`. + + **Available until version 2.101** + type: boolean OS-FLV-EXT-DATA:ephemeral: description: |- The size of the ephemeral disk that will be created, in @@ -10002,6 +9561,8 @@ components: description: description: |- The description of the flavor. + + **New in version 2.55** type: - 'null' - string @@ -10016,19 +9577,6 @@ components: 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 @@ -10060,19 +9608,23 @@ components: 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. - 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 @@ -10081,13 +9633,17 @@ components: - name - os-flavor-access:is_public - ram + - rxtx_factor - swap - vcpus type: object required: - flavor type: object - FlavorUpdate_255: + x-openstack: + max-ver: '2.60' + min-ver: '2.55' + FlavorShowResponse_261: additionalProperties: false properties: flavor: @@ -10096,160 +9652,242 @@ components: 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`. + + **Available until version 2.101** + 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: |- - 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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 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: + max-ver: '2.74' + min-ver: '2.61' + FlavorShowResponse_275: 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: + flavor: additionalProperties: false description: |- - The action. + The ID and links for the flavor for your server instance. A flavor is a combination + of memory, disk size, and CPUs. properties: - tenant: + OS-FLV-DISABLED:disabled: 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. + 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`. - Specify the `removeTenantAccess` action and the `tenant` in the request body. + **Available until version 2.101** + 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. - Normal response codes: 200 + **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. - Error response codes: badRequest(400), unauthorized(401), forbidden(403), - itemNotFound(404), conflict(409) - properties: - removeTenantAccess: - additionalProperties: false - description: |- - The action. - properties: - tenant: + **New in version 2.61** + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + maxLength: 255 + type: string + type: object + id: description: |- - The UUID of the tenant in a multi-tenancy cloud. - maxLength: 255 - minLength: 1 + 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: - - tenant + - 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: - - removeTenantAccess - summary: Remove Flavor Access From Tenant (removeTenantAccess Action) + - flavor type: object x-openstack: - action-name: removeTenantAccess - FlavorsCreateRequest: - oneOf: - - $ref: '#/components/schemas/FlavorsCreate_20' - - $ref: '#/components/schemas/FlavorsCreate_21' - - $ref: '#/components/schemas/FlavorsCreate_2102' - - $ref: '#/components/schemas/FlavorsCreate_255' - x-openstack: - discriminator: microversion - FlavorsCreateResponse: + max-ver: '2.101' + min-ver: '2.75' + FlavorUpdateResponse_2102: additionalProperties: false properties: flavor: @@ -10268,8 +9906,6 @@ components: description: description: |- The description of the flavor. - - **New in version 2.55** type: - 'null' - string @@ -10355,7 +9991,9 @@ components: required: - flavor type: object - FlavorsCreate_20: + x-openstack: + min-ver: '2.102' + FlavorUpdateResponse_255: additionalProperties: false properties: flavor: @@ -10364,129 +10002,106 @@ components: 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`. + + **Available until version 2.101** + type: boolean 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]+$ + 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: - - integer + - '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 + 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 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. _-]+(?= 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 + 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 + 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 + 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_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_RebuildResponse_20: + additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + type: string + accessIPv4: + oneOf: + - const: '' + - format: ipv4 + type: string + accessIPv6: + oneOf: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object + adminPass: + type: + - 'null' + - string + created: + format: date-time + type: 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: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: + type: string + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - no_device: {} - snapshot_id: - format: uuid + rel: + enum: + - bookmark + - self type: string - virtual_name: - maxLength: 255 + required: + - href + - rel + type: object + type: array + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: + type: + - 'null' + - string + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - flavor + - hostId + - id + - image + - links + - metadata + - name + - progress + - status + - tenant_id + - updated + - user_id + type: object + required: + - server + type: object + x-openstack: + action-name: rebuild + max-ver: '2.8' + min-ver: '2.0' + ServersAction_RebuildResponse_2100: + 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 + - 'null' + 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 + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + properties: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - volume_id: - format: uuid + rel: + enum: + - bookmark + - self type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - href + - rel type: object type: array - block_device_mapping_v2: + 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: - 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 + default: false + type: boolean + id: type: string - image_id: - format: uuid + 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 - no_device: {} - snapshot_id: + type: + - array + - string + different_host: + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + group: + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + type: + - object + - string + same_host: + items: 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: + - array + - string + target_cell: + format: name + maxLength: 255 + minLength: 1 + type: string + type: object + security_groups: + items: + additionalProperties: false + properties: + name: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - name 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 + server_groups: + items: + format: uuid + type: string + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + 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: - - boolean + - array + - 'null' + updated: + format: date-time + type: string + user_data: + format: base64 + maxLength: 65535 + type: + - 'null' - string - description: + user_id: maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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 + min-ver: '2.100' + ServersAction_RebuildResponse_219: + additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + type: string + accessIPv4: + oneOf: + - const: '' + - format: ipv4 + type: string + accessIPv6: + oneOf: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object + adminPass: type: - 'null' - string - flavorRef: - minLength: 1 + created: + format: date-time + type: string + description: type: - - integer + - 'null' - string - imageRef: - oneOf: - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - - maxLength: 0 + details: type: string - key_name: - format: name - maxLength: 255 - minLength: 1 + message: + type: string + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: type: string - max_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ - type: - - integer - - string + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean 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]*$ + name: type: - - integer + - 'null' - string - name: - format: name + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - networks: + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - links + - locked + - metadata + - name + - progress + - status + - tenant_id + - updated + - user_id + type: object + required: + - server + type: object + x-openstack: + action-name: rebuild + max-ver: '2.25' + min-ver: '2.19' + ServersAction_RebuildResponse_226: + additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: - - items: + - const: '' + - format: ipv4 + type: string + accessIPv6: + oneOf: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: additionalProperties: false properties: - fixed_ip: + addr: oneOf: - format: ipv4 - format: ipv6 type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object + adminPass: + type: + - '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: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - uuid: - format: uuid + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel type: object type: array - - enum: - - auto - - none + type: object + hostId: + type: string + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' type: string - personality: + links: items: additionalProperties: false properties: - contents: - format: base64 + href: + format: uri type: string - path: + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel 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 + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: type: - - boolean + - 'null' - string - security_groups: - items: - additionalProperties: false - properties: - name: - format: name - maxLength: 255 - minLength: 1 - type: string - type: object - type: array + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array - user_data: - format: base64 - maxLength: 65535 + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string required: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - links + - locked + - metadata - name - - networks + - progress + - status + - tags + - tenant_id + - updated + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.56' - min-ver: '2.52' - Os_Volumes_BootCreate_257: + action-name: rebuild + max-ver: '2.46' + min-ver: '2.26' + ServersAction_RebuildResponse_247: additionalProperties: false properties: - OS-SCH-HNT:scheduler_hints: - additionalProperties: true + server: + additionalProperties: false properties: - build_near_host_ip: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: + - const: '' - 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: + accessIPv6: oneOf: - - items: - format: uuid - type: string + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object type: array - - format: uuid - type: string - query: - type: - - object - - string - same_host: - items: - format: uuid - type: string + type: object + adminPass: type: - - array + - 'null' - 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.:]+$ + created: + format: date-time type: string - different_cell: - items: - type: string + description: type: - - array + - 'null' - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid + details: 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: + 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 - availability_zone: - format: name - maxLength: 255 - minLength: 1 + id: 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: + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + links: 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 + href: + format: uri type: string - source_type: + rel: 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 + - bookmark + - self type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - href + - rel 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: type: - 'null' - string - flavorRef: - minLength: 1 + progress: type: - - integer - - string - imageRef: - oneOf: - - format: uuid - type: string - - maxLength: 0 - type: string - key_name: - format: name + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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 + updated: + format: date-time + type: string + user_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - networks: + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - links + - locked + - metadata + - name + - progress + - status + - tags + - tenant_id + - updated + - user_id + type: object + required: + - server + type: object + x-openstack: + action-name: rebuild + max-ver: '2.53' + min-ver: '2.47' + ServersAction_RebuildResponse_254: + additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: - - items: + - const: '' + - format: ipv4 + type: string + accessIPv6: + oneOf: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: additionalProperties: false properties: - fixed_ip: + addr: 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 + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version type: object type: array - - enum: - - auto - - none + type: object + adminPass: + type: + - '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 - 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 + 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 + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: type: - - boolean + - 'null' - string - security_groups: + links: items: additionalProperties: false properties: - name: - format: name - maxLength: 255 - minLength: 1 + href: + format: uri + type: string + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel type: object type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: + type: + - 'null' + - string + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array - user_data: - format: base64 - maxLength: 65535 + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string required: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata - name - - networks + - progress + - status + - tags + - tenant_id + - updated + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.62' - min-ver: '2.57' - Os_Volumes_BootCreate_263: + action-name: rebuild + max-ver: '2.56' + min-ver: '2.54' + ServersAction_RebuildResponse_257: additionalProperties: false properties: - OS-SCH-HNT:scheduler_hints: - additionalProperties: true + server: + additionalProperties: false properties: - build_near_host_ip: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: + - const: '' - 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: + accessIPv6: oneOf: - - items: - format: uuid - type: string + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object type: array - - format: uuid - type: string - query: + type: object + adminPass: type: - - object + - 'null' - string - same_host: - items: - format: uuid - type: string + created: + format: date-time + type: string + description: type: - - array + - 'null' - 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 + 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 - cidr: - pattern: ^/[0-9a-f.:]+$ + id: type: string - different_cell: - items: - type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: type: - - array + - 'null' - string - different_host: - oneOf: - - items: - format: uuid + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - type: array - - format: uuid - type: string - group: - oneOf: - - items: - format: uuid + rel: + enum: + - bookmark + - self type: string - type: array - - format: uuid + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: type: string - query: + type: object + name: type: - - object + - 'null' - string - same_host: + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: items: - format: uuid type: string + maxItems: 50 + type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_data: + format: base64 + maxLength: 65535 type: - - array + - 'null' - string - target_cell: - format: name + user_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata + - name + - progress + - status + - tags + - tenant_id + - updated + - user_data + - user_id type: object + required: + - server + type: object + x-openstack: + action-name: rebuild + max-ver: '2.62' + min-ver: '2.57' + ServersAction_RebuildResponse_263: + additionalProperties: false + properties: server: additionalProperties: false properties: OS-DCF:diskConfig: - enum: - - AUTO - - MANUAL type: string accessIPv4: - format: ipv4 + oneOf: + - const: '' + - format: ipv4 type: string accessIPv6: - format: ipv6 + oneOf: + - const: '' + - format: ipv6 type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object 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 + - 'null' - string + created: + format: date-time + type: string description: - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ type: - 'null' - string - flavorRef: - minLength: 1 - type: - - integer - - string - imageRef: - oneOf: - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - - maxLength: 0 + details: 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: + message: + type: string + required: + - code + - created + - message + type: object + flavor: additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: - maxLength: 255 + 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 - min_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ - type: - - integer - - string - name: - format: name - maxLength: 255 - minLength: 1 + hostId: type: string - networks: + id: + type: string + image: 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 + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' 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 + key_name: type: - - boolean + - 'null' - string - security_groups: + links: items: additionalProperties: false properties: - name: - format: name - maxLength: 255 - minLength: 1 + href: + format: uri + type: string + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel type: object type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: + type: + - 'null' + - string + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string trusted_image_certificates: items: - minLength: 1 type: string - maxItems: 50 - minItems: 1 type: - array - 'null' - uniqueItems: true + 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: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata - name - - networks + - progress + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_data + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.66' + action-name: rebuild + max-ver: '2.70' min-ver: '2.63' - Os_Volumes_BootCreate_267: + ServersAction_RebuildResponse_271: 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + oneOf: + - const: '' + - format: ipv4 type: string accessIPv6: - format: ipv6 + oneOf: + - const: '' + - format: ipv6 type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object 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 + - 'null' - string + created: + format: date-time + type: string description: - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ type: - 'null' - string - flavorRef: - minLength: 1 - type: - - integer - - string - imageRef: - oneOf: - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - - maxLength: 0 + 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 + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' type: string key_name: - format: name - maxLength: 255 - minLength: 1 - type: string - max_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ type: - - integer + - 'null' - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean 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 + - 'null' - string - security_groups: + progress: + type: + - 'null' + - number + server_groups: items: - additionalProperties: false - properties: - name: - format: name - maxLength: 255 - minLength: 1 - type: string - type: object + format: uuid + type: string + maxLength: 1 type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string trusted_image_certificates: items: - minLength: 1 type: string - maxItems: 50 - minItems: 1 type: - array - 'null' - uniqueItems: true + 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: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata - name - - networks + - progress + - server_groups + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_data + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.73' - min-ver: '2.67' - Os_Volumes_BootCreate_274: + action-name: rebuild + max-ver: '2.72' + min-ver: '2.71' + ServersAction_RebuildResponse_273: additionalProperties: false properties: - OS-SCH-HNT:scheduler_hints: - additionalProperties: true + server: + additionalProperties: false properties: - build_near_host_ip: + OS-DCF:diskConfig: + type: string + accessIPv4: oneOf: + - const: '' - 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: + accessIPv6: oneOf: - - items: - format: uuid - type: string + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object type: array - - format: uuid - type: string - query: - type: - - object - - string - same_host: - items: - format: uuid - type: string + type: object + adminPass: type: - - array + - 'null' - 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.:]+$ + created: + format: date-time type: string - different_cell: - items: - type: string + description: type: - - array + - 'null' - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid + details: 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: + 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 - availability_zone: - format: name - maxLength: 255 - minLength: 1 + id: 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 + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - source_type: + rel: 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 + - bookmark + - self type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string - volume_type: - maxLength: 255 - minLength: 0 - type: - - 'null' - - string + required: + - href + - rel 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 + locked: + type: boolean + locked_reason: type: - - boolean + - 'null' - string - description: - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: type: - 'null' - string - flavorRef: - minLength: 1 + progress: type: - - integer - - string - host: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + - 'null' + - number + server_groups: + items: + format: uuid + type: string + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - hypervisor_hostname: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + pattern: ^[a-zA-Z0-9-]*$ type: string - imageRef: - oneOf: - - format: uuid - type: string - - maxLength: 0 - type: string - key_name: - format: name + 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 - max_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ + required: + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - description + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - locked_reason + - metadata + - name + - progress + - 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 + max-ver: '2.74' + min-ver: '2.73' + ServersAction_RebuildResponse_275: + 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 + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - 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]*$ + 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 + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' - string - name: - format: name - maxLength: 255 - minLength: 1 + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - networks: + accessIPv6: oneOf: - - items: + - const: '' + - format: ipv6 + type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: additionalProperties: false properties: - fixed_ip: + 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 - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ - type: string - uuid: - format: uuid - 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 - - enum: - - auto - - none + 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 - 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 + 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: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + 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 + progress: type: - - boolean - - string + - 'null' + - number security_groups: items: additionalProperties: false properties: name: - format: name - maxLength: 255 - minLength: 1 type: string + required: + - name type: object type: array + server_groups: + items: + format: uuid + type: string + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string trusted_image_certificates: items: - minLength: 1 type: string - maxItems: 50 - minItems: 1 type: - array - 'null' - uniqueItems: true + 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: - - flavorRef + - 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 - - networks + - os-extended-volumes:volumes_attached + - progress + - server_groups + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_data + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.89' - min-ver: '2.74' - Os_Volumes_BootCreate_290: + action-name: rebuild + max-ver: '2.95' + min-ver: '2.75' + ServersAction_RebuildResponse_29: 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + oneOf: + - const: '' + - format: ipv4 type: string accessIPv6: - format: ipv6 + oneOf: + - const: '' + - format: ipv6 type: string + addresses: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + type: number + required: + - addr + - version + type: object + type: array + type: object 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-._]*$ + created: + format: date-time type: string - imageRef: - oneOf: - - format: uuid + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time type: string - - maxLength: 0 + details: 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 + message: 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: + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: + type: string + links: + 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: ^[^,/]*$ + href: + format: uri type: string - uuid: - format: uuid + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel type: object type: array - - enum: - - auto - - none + type: object + hostId: + type: string + id: + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' 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: + links: items: additionalProperties: false properties: - name: - format: name - maxLength: 255 - minLength: 1 + href: + format: uri + type: string + rel: + enum: + - bookmark + - self type: string + required: + - href + - rel 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 + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: type: - - array - 'null' - uniqueItems: true - user_data: - format: base64 - maxLength: 65535 + - string + progress: + type: + - 'null' + - number + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: string + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string required: - - flavorRef + - OS-DCF:diskConfig + - accessIPv4 + - accessIPv6 + - addresses + - created + - flavor + - hostId + - id + - image + - links + - locked + - metadata - name - - networks + - progress + - status + - tenant_id + - updated + - user_id type: object required: - server type: object x-openstack: - max-ver: '2.93' - min-ver: '2.90' - Os_Volumes_BootCreate_294: + action-name: rebuild + max-ver: '2.18' + min-ver: '2.9' + ServersAction_RebuildResponse_296: additionalProperties: false properties: - OS-SCH-HNT:scheduler_hints: - additionalProperties: true + server: + additionalProperties: false properties: - build_near_host_ip: - oneOf: - - format: ipv4 - - format: ipv6 + OS-DCF:diskConfig: type: string - cidr: - pattern: ^/[0-9a-f.:]+$ + OS-EXT-AZ:availability_zone: type: string - different_cell: - items: - type: string + OS-EXT-SRV-ATTR:host: type: - - array + - 'null' - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: + OS-EXT-SRV-ATTR:hostname: + type: string + OS-EXT-SRV-ATTR:hypervisor_hostname: type: - - object + - 'null' - string - same_host: - items: - format: uuid - type: string + OS-EXT-SRV-ATTR:instance_name: + type: string + OS-EXT-SRV-ATTR:kernel_id: type: - - array + - 'null' - 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 + OS-EXT-SRV-ATTR:launch_index: type: - - array + - integer + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: + OS-EXT-SRV-ATTR:reservation_id: type: - - object + - 'null' - string - same_host: - items: - format: uuid - type: string + OS-EXT-SRV-ATTR:root_device_name: type: - - array + - 'null' - string - target_cell: - format: name - maxLength: 255 - minLength: 1 - type: string - type: object - server: - additionalProperties: false - properties: - OS-DCF:diskConfig: + OS-EXT-STS:power_state: 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 + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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: - 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 + - 'null' - string + created: + format: date-time + type: 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-._]*$ + 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 - hostname: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + host_status: type: string - hypervisor_hostname: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + id: type: string - imageRef: + image: oneOf: - - format: uuid - type: string - - maxLength: 0 + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' type: string key_name: - format: name - maxLength: 255 - minLength: 1 - type: string - max_count: - minLength: 1 - minimum: 1 - pattern: ^[0-9]*$ type: - - integer + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + locked_reason: + type: + - 'null' - 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]*$ + name: type: - - integer + - 'null' - 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 + 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: - - boolean + - 'null' - string + progress: + type: + - 'null' + - number security_groups: items: additionalProperties: false properties: name: - format: name - maxLength: 255 - minLength: 1 type: string + required: + - name type: object type: array + server_groups: + items: + format: uuid + type: string + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string tags: items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ type: string maxItems: 50 type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string trusted_image_certificates: items: - minLength: 1 type: string - maxItems: 50 - minItems: 1 type: - array - 'null' - uniqueItems: true + updated: + format: date-time + type: string user_data: format: base64 maxLength: 65535 - type: string - required: - - flavorRef - - name - - networks - type: object - required: - - server - type: object - x-openstack: - max-ver: '2.102' - min-ver: '2.94' - Os_Volumes_BootDetailResponse: - additionalProperties: false - properties: - servers: - items: - oneOf: - - 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 - - 'null' - 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-SRV-ATTR:user_data: - format: base64 - maxLength: 65535 - type: - - 'null' - - string - OS-EXT-STS:power_state: - enum: - - - - 0 - - 1 - - 3 - - 4 - - 6 - - 7 - type: - - integer - - 'null' - OS-EXT-STS:task_state: - type: - - 'null' - - string - OS-EXT-STS:vm_state: - type: - - 'null' - - 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 - config_drive: - enum: - - '' - - - - 'False' - - 'True' - type: - - 'null' - - string - created: - format: date-time - type: string - description: - type: - - 'null' - - string - fault: + 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 + - 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 + max-ver: '2.97' + min-ver: '2.96' + ServersAction_RebuildResponse_298: + 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 + - 'null' + 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 + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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: - code: - type: integer - created: - format: date-time + OS-EXT-IPS-MAC:mac_addr: + format: mac-address type: string - details: + OS-EXT-IPS:type: + enum: + - fixed + - floating type: string - message: + addr: + oneOf: + - format: ipv4 + - format: ipv6 type: string + version: + enum: + - 4 + - 6 + type: number required: - - code - - created - - message + - OS-EXT-IPS-MAC:mac_addr + - OS-EXT-IPS:type + - addr + - version type: object - flavor: - additionalProperties: false - properties: - disk: - type: integer - ephemeral: - type: integer - extra_specs: + 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: + format: uuid + type: string + links: + items: 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: - enum: - - '' - - DOWN - - MAINTENANCE - - UNKNOWN - - UP - type: string - id: - format: uuid - type: string - image: - oneOf: - - additionalProperties: false properties: - id: - format: uuid + href: + format: uri type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - properties: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9_:. ]{1,255}$: - maxLength: 255 - type: - - 'null' - - string - type: object + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel type: object - - const: '' - type: string - key_name: - type: - - 'null' - - string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - 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 + type: array 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + patternProperties: + ^[a-zA-Z0-9_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string type: object - type: array - status: - enum: - - ACTIVE - - BUILD - - DELETED - - ERROR - - HARD_REBOOT - - MIGRATING - - PASSWORD - - PAUSED - - REBOOT - - REBUILD - - RESCUE - - RESIZE - - REVERT_RESIZE - - SHELVED - - SHELVED_OFFLOADED - - SHUTOFF - - SOFT_DELETED - - SUSPENDED - - UNKNOWN - - VERIFY_RESIZE - type: string - tags: - items: - type: string - maxItems: 50 - type: array - tenant_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri type: string - trusted_image_certificates: - items: - type: string - type: - - array - - 'null' - updated: - format: date-time + rel: + enum: + - bookmark + - self type: string - user_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ + 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: - - OS-DCF:diskConfig - - OS-EXT-AZ:availability_zone - - OS-EXT-SRV-ATTR:hostname - - 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 + - delete_on_termination - id - - image - - key_name - - links - - locked - - locked_reason - - metadata - - name - - os-extended-volumes:volumes_attached - - pinned_availability_zone - - scheduler_hints - - status - - tags - - tenant_id - - trusted_image_certificates - - updated - - user_id type: object - - additionalProperties: false + type: array + pinned_availability_zone: + type: + - 'null' + - string + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false properties: - created: - format: date-time - type: string - id: - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - status: - const: UNKNOWN - type: string - tenant_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ + name: type: string required: - - created - - id - - links - - status - - tenant_id + - name type: object - type: array - servers_links: - items: - additionalProperties: false - properties: - href: - format: uri + type: array + server_groups: + items: + format: uuid type: string - rel: - const: next - required: - - href - - rel - type: object - maxItems: 1 - minItems: 1 - type: array + maxLength: 1 + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + 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 + - server_groups + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_data + - user_id + type: object required: - - servers + - server type: object - Os_Volumes_BootListResponse: + x-openstack: + action-name: rebuild + max-ver: '2.99' + min-ver: '2.98' + ServersAction_Rebuild_20: additionalProperties: false properties: - servers: - items: - oneOf: - - additionalProperties: false + 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: - id: - format: uuid + contents: + format: base64 type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - name: + path: type: string - required: - - id - - links - - name type: object - - additionalProperties: false + 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_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: - id: - format: uuid + contents: + format: base64 type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - status: - const: UNKNOWN + path: type: string - required: - - id - - links - - status type: object - type: array - servers_links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - const: next - required: - - href - - rel - type: object - maxItems: 1 - minItems: 1 - type: array + 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: - - servers + - rebuild + summary: Rebuild Server (rebuild Action) type: object - Os_Volumes_BootShowResponse: + x-openstack: + action-name: rebuild + max-ver: '2.18' + min-ver: '2.1' + ServersAction_Rebuild_219: additionalProperties: false properties: - server: - oneOf: - - 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 - - 'null' - 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-SRV-ATTR:user_data: - format: base64 - maxLength: 65535 - type: - - 'null' - - string - OS-EXT-STS:power_state: - enum: - - - - 0 - - 1 - - 3 - - 4 - - 6 - - 7 - type: - - integer - - 'null' - OS-EXT-STS:task_state: - type: - - 'null' - - string - OS-EXT-STS:vm_state: - type: - - 'null' - - 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 - config_drive: - enum: - - '' - - - - 'False' - - 'True' - type: - - '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: - enum: - - '' - - DOWN - - MAINTENANCE - - UNKNOWN - - UP - type: string - id: - format: uuid - type: string - image: - oneOf: - - additionalProperties: false - properties: - id: - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - properties: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9_:. ]{1,255}$: - maxLength: 255 - type: - - 'null' - - string - type: object - type: object - - const: '' - type: string - key_name: - type: - - 'null' - - string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - 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: - oneOf: - - items: - format: uuid - type: string - type: array - - 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: - enum: - - ACTIVE - - BUILD - - DELETED - - ERROR - - HARD_REBOOT - - MIGRATING - - PASSWORD - - PAUSED - - REBOOT - - REBUILD - - RESCUE - - RESIZE - - REVERT_RESIZE - - SHELVED - - SHELVED_OFFLOADED - - SHUTOFF - - SOFT_DELETED - - SUSPENDED - - UNKNOWN - - VERIFY_RESIZE + 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 - tags: - items: + 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 - maxItems: 50 - type: array - tenant_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ - type: string - trusted_image_certificates: - items: + path: type: string - type: - - array - - 'null' - updated: - format: date-time + 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_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 - user_id: + 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 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ type: string - required: - - OS-DCF:diskConfig - - OS-EXT-AZ:availability_zone - - OS-EXT-SRV-ATTR:hostname - - 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 - - scheduler_hints - - server_groups - - status - - tags - - tenant_id - - trusted_image_certificates - - updated - - user_id type: object - - additionalProperties: false - properties: - OS-EXT-AZ:availability_zone: - type: string - OS-EXT-STS:power_state: - enum: - - - - 0 - - 1 - - 3 - - 4 - - 6 - - 7 - type: - - integer - - 'null' - created: - format: date-time - type: string - 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 - id: - format: uuid - type: string - image: - oneOf: - - additionalProperties: false - properties: - id: - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - type: object - - const: '' - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - server_groups: - items: - format: uuid + 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 - maxLength: 1 - type: array - status: - const: UNKNOWN - type: string - tenant_id: - maxLength: 255 + 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_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 - pattern: ^[a-zA-Z0-9-]*$ type: string - user_id: + 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 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ type: string - required: - - OS-EXT-AZ:availability_zone - - OS-EXT-STS:power_state - - created - - flavor - - id - - image - - links - - server_groups - - status - - tenant_id - - user_id 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: - - server + - rebuild + summary: Rebuild Server (rebuild Action) 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: + action-name: rebuild + max-ver: '2.62' + min-ver: '2.57' + ServersAction_Rebuild_263: additionalProperties: false properties: - server: + 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 - OS-EXT-AZ:availability_zone: + accessIPv4: + description: |- + IPv4 address that should be used to access this server. + format: ipv4 type: string - OS-EXT-SRV-ATTR:host: - type: - - 'null' - - string - OS-EXT-SRV-ATTR:hostname: + accessIPv6: + description: |- + IPv6 address that should be used to access this server. + format: ipv6 type: string - OS-EXT-SRV-ATTR:hypervisor_hostname: - type: - - 'null' - - string - OS-EXT-SRV-ATTR:instance_name: + adminPass: + description: |- + The administrative password of the server. If you omit this parameter, the operation + generates a new password. 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: + 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 - OS-EXT-SRV-ATTR:reservation_id: + 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: - - 'null' + - boolean - string - OS-EXT-SRV-ATTR:root_device_name: + 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' - - string - OS-EXT-SRV-ATTR:user_data: + 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 - OS-EXT-STS:power_state: + 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_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: - - - - 0 - - 1 - - 3 - - 4 - - 6 - - 7 - type: - - integer - - 'null' - OS-EXT-STS:task_state: - type: - - 'null' - - string - OS-EXT-STS:vm_state: - type: - - 'null' - - string - OS-SRV-USG:launched_at: - format: date-time - type: - - 'null' - - string - OS-SRV-USG:terminated_at: - format: date-time - type: - - 'null' - - string + - AUTO + - MANUAL + type: string accessIPv4: - oneOf: - - const: '' - - format: ipv4 + description: |- + IPv4 address that should be used to access this server. + format: ipv4 type: string accessIPv6: - oneOf: - - const: '' - - format: ipv6 + description: |- + IPv6 address that should be used to access this server. + 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 - config_drive: - type: - - boolean - - 'null' - - string - created: - format: date-time + 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 - 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: + 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 - image: - oneOf: - - additionalProperties: false - properties: - id: - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - properties: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9_:. ]{1,255}$: - maxLength: 255 - type: - - 'null' - - string - type: object - type: object - - const: '' - type: string - key_name: - type: - - 'null' - - string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - locked: - type: boolean - locked_reason: - 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: - - 'null' + - boolean - string - os-extended-volumes:volumes_attached: + 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: - 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: + 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 - progress: + 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_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' - - number - scheduler_hints: - additionalProperties: true - properties: - build_near_host_ip: - oneOf: - - format: ipv4 - - format: ipv6 - type: string - cidr: - pattern: ^/[0-9a-f.:]+$ + - 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 - different_cell: - items: - type: string - type: - - array - - string - different_host: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - group: - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: - type: - - object - - string - same_host: - items: - format: uuid - type: string - type: - - array - - string - target_cell: - format: name + 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 - 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: - enum: - - ACTIVE - - BUILD - - DELETED - - ERROR - - HARD_REBOOT - - MIGRATING - - PASSWORD - - PAUSED - - REBOOT - - REBUILD - - RESCUE - - RESIZE - - REVERT_RESIZE - - SHELVED - - SHELVED_OFFLOADED - - SHUTOFF - - SOFT_DELETED - - SUSPENDED - - UNKNOWN - - VERIFY_RESIZE - type: string - tags: - items: - type: string - maxItems: 50 - type: array - tenant_id: + name: + description: |- + The server name. + format: name maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ 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' - updated: - format: date-time - type: string - user_id: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-]*$ + 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 + min-ver: '2.94' + 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: - - 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 - - links - - locked - - locked_reason - - metadata - - name - - os-extended-volumes:volumes_attached - - pinned_availability_zone - - scheduler_hints - - server_groups - - status - - tags - - tenant_id - - trusted_image_certificates - - updated - - user_id + - 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: - - server + - removeFloatingIp + summary: Remove (Disassociate) Floating Ip (removeFloatingIp Action) + (DEPRECATED) type: object - Os_Volumes_BootUpdate_20: - additionalProperties: false + 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: - server: + removeSecurityGroup: additionalProperties: false + description: |- + The action to remove a security group from the server. 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 + description: |- + The security group name. minLength: 1 type: string + required: + - name type: object required: - - server + - removeSecurityGroup + summary: Remove Security Group From A Server (removeSecurityGroup Action) type: object x-openstack: - max-ver: '2.0' - min-ver: '2.0' - Os_Volumes_BootUpdate_21: + 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: - server: + rescue: additionalProperties: false + description: |- + The action to rescue a server. properties: - OS-DCF:diskConfig: - enum: - - AUTO - - MANUAL - type: string - accessIPv4: - format: ipv4 - type: string - accessIPv6: - format: ipv6 + adminPass: type: string - name: - format: name - maxLength: 255 - minLength: 1 + rescue_image_ref: + format: uuid type: string - type: object + type: + - 'null' + - object required: - - server + - rescue + summary: Rescue Server (rescue Action) type: object x-openstack: - max-ver: '2.18' - min-ver: '2.1' - Os_Volumes_BootUpdate_219: + action-name: rescue + ServersAction_RescueResponse: additionalProperties: false properties: - server: + adminPass: + type: string + 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: - OS-DCF:diskConfig: + state: + description: |- + The state of the server to be set, `active` or `error` are valid. 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 + - active + - error type: string + required: + - state type: object required: - - server + - os-resetState + summary: Reset Server State (os-resetState Action) type: object x-openstack: - max-ver: '2.89' - min-ver: '2.19' - Os_Volumes_BootUpdate_290: + action-name: os-resetState + ServersAction_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: - server: + 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 - accessIPv4: - format: ipv4 - type: string - accessIPv6: - format: ipv6 - type: string - description: - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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: - - 'null' + - integer - 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 + required: + - flavorRef type: object required: - - server + - resize + summary: Resize Server (resize Action) type: object x-openstack: - max-ver: '2.93' - min-ver: '2.90' - Os_Volumes_BootUpdate_294: + action-name: resize + 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: - 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 + resume: {} required: - - server + - resume + summary: Resume Suspended Server (resume Action) type: object x-openstack: - max-ver: '2.102' - min-ver: '2.94' - RootShowResponse: + action-name: resume + ServersAction_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: - 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: + revertResize: {} + required: + - revertResize + summary: Revert Resized Server (revertResize Action) + type: object + x-openstack: + action-name: revertResize + ServersAction_Shelve: + additionalProperties: false + description: |- + Shelves a server. - * `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. + Specify the `shelve` action in the request body. - Note + 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. - 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 + 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: - - version + - shelveOffload + summary: Shelf-Offload (Remove) Server (shelveOffload Action) type: object - ServerShowResponse: - properties: - server: - description: |- - A `server` object. - properties: - OS-DCF:diskConfig: - description: |- - Disk configuration. The value is either: + x-openstack: + action-name: shelveOffload + ServersAction_Start: + additionalProperties: false + description: |- + Starts a stopped server and changes its status to `ACTIVE`. - * `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. + Specify the `os-start` action in the request body. - **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. + **Preconditions** - **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. + The server status must be `SHUTOFF`. - Note + If the server is locked, you must have administrator privileges + to start the server. - This information is published via the metadata service and requires - application such as `cloud-init` to propagate it through to the - instance. + **Asynchronous Postconditions** - **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. + After you successfully start a server, its status changes to `ACTIVE`. - **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. + **Troubleshooting** - **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. + 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. - **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. + Normal response codes: 202 - **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. + 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: + additionalProperties: false + description: |- + Stops a running server and changes its status to `SHUTOFF`. - **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. + Specify the `os-stop` action in the request body. - **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. + **Preconditions** - **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. + The server status must be `ACTIVE` or `ERROR`. - **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: + If the server is locked, you must have administrator privileges + to stop the server. - ``` - 0: NOSTATE - 1: RUNNING - 3: PAUSED - 4: SHUTDOWN - 6: CRASHED - 7: SUSPENDED - ``` + **Asynchronous Postconditions** - **New in version 2.75** - type: integer - OS-EXT-STS:task_state: - description: |- - The task state of the instance. + 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. - **New in version 2.75** - type: string - OS-EXT-STS:vm_state: - description: |- - The VM state. + Normal response codes: 202 - **New in version 2.75** - type: string - OS-SRV-USG:launched_at: - description: |- - The date and time when the server was launched. + 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`. - The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + Specify the `suspend` action in the request body. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + 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. - For example, `2015-08-27T09:49:58-05:00`. + Normal response codes: 202 - 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`. + 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_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_Unlock_21: + additionalProperties: false + description: |- + Unlocks a locked server. - **New in version 2.75** - type: string - OS-SRV-USG:terminated_at: - description: |- - The date and time when the server was deleted. + Specify the `unlock` action in the request body. - The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + 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. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + Normal response codes: 202 - 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`. + 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`. - **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`. + Specify the `unpause` action in the request body. - **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) + 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. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + Normal response codes: 202 - 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. + 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`. - **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) + Specify the `unrescue` action in the request body. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + **Preconditions** - 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. + The server must exist. - 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. + You can only unrescue a server when its status is `RESCUE`. - **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. + **Asynchronous Postconditions** - **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. + After you successfully unrescue a server and make a + `GET /servers/​{server_id}​` + request, its status changes to `ACTIVE`. - **New in version 2.47** - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: - maxLength: 255 - type: string - type: object - x-openstack: - min-ver: '2.47' + 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 + min-ver: '2.91' + 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: + - additionalProperties: false + properties: + reservation_id: + type: string + required: + - reservation_id + - additionalProperties: false + properties: + server: + additionalProperties: false + properties: + OS-DCF:diskConfig: + enum: + - AUTO + - MANUAL + type: string + adminPass: + type: string id: - description: |- - The UUID of the server. + format: uuid 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. + additionalProperties: false properties: href: format: uri type: string rel: + enum: + - bookmark + - self type: string + required: + - href + - rel 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' + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + required: + - OS-DCF:diskConfig + - id + - links + - security_groups type: object - hostId: + required: + - server + type: object + ServersCreate_20: + additionalProperties: false + properties: + OS-SCH-HNT:scheduler_hints: + additionalProperties: true + properties: + build_near_host_ip: 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. + 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 - host_status: + cidr: 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' + 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: - - 'null' + - array - string - x-openstack: - min-ver: '2.16' - id: - description: Id of the server - format: uuid - readOnly: true - type: string - image: + different_host: 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. + 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: - - 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: + - items: + format: uuid 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: array + - format: uuid 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: + group: description: |- - One or more security groups objects. - - **New in version 2.75** - items: - properties: - name: - description: The security group name + 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. + oneOf: + - items: + format: uuid type: string - type: object - type: array - server_groups: + type: array + - format: uuid + type: string + query: description: |- - The UUIDs of the server groups to which the server belongs. Currently - this can contain at most one entry. + Schedule the server by using a custom filter in JSON format. + For example: - **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. + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - **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: + It is available when `JsonFilter` is available on cloud side. + type: + - object + - string + same_host: 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** + 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 - - '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: + - string + target_cell: description: |- - The user ID of the user who owns the server. + 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 - 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: + os:scheduler_hints: + additionalProperties: true 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. + 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. - **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. + Note - **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. + This is a top-level key in the request body, not part of the + server portion of the request body. - **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. + There are a few caveats with scheduler hints: - **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. + * 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. - **New in version 2.75** - type: string - x-openstack: - min-ver: '2.3' - OS-EXT-SRV-ATTR:root_device_name: + 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: |- - The root device name for the instance - By default, it appears in the response for administrative users only. - - **New in version 2.75** + 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 - x-openstack: - min-ver: '2.3' - OS-EXT-SRV-ATTR:user_data: + cidr: 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** + 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 - x-openstack: - min-ver: '2.3' - OS-EXT-STS:power_state: + different_cell: 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: + 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: |- - The task state of the instance. - - **New in version 2.75** - type: string - OS-EXT-STS:vm_state: + 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 VM state. - - **New in version 2.75** - type: string - OS-SRV-USG:launched_at: + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: 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): + Schedule the server by using a custom filter in JSON format. + For example: ``` - CCYY-MM-DDThh:mm:ss±hh:mm + "query": "[\">=\",\"$free_ram_mb\",1024]" ``` - 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** + 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 - OS-SRV-USG:terminated_at: + type: object + server: + additionalProperties: false + description: |- + A `server` object. + properties: + OS-DCF:diskConfig: 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`. + 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: - **New in version 2.75** + * `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. May be - automatically set by the provider. + 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. May be - automatically set by the provider. + IPv6 address that should be used to access this server. 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: + adminPass: 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** + The administrative password of the server. If you omit this parameter, the operation + generates a new password. type: string - created: + availability_zone: 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 - ``` + Key pair name. - 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. + Note - **New in version 2.19** + 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 - 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: + 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: |- - 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. + 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: - **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. + > ``` + > "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"}] + > ``` - **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. + 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. - **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: + 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: |- - 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** + 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: - - '' - - DOWN - - MAINTENANCE - - UNKNOWN - - UP - - 'null' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - NO + - No + - OFF + - ON + - Off + - On + - 'TRUE' + - true + - 'True' + - YES + - Yes + - 'false' + - no + - off + - on + - 'true' + - yes type: - - 'null' + - boolean - 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: - - '' + 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: |- - The name of associated key pair, if any. + Key pair name. - **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. + Note - **New in version 2.9** - type: boolean - x-openstack: - min-ver: '2.9' + 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: |- - A dictionary of metadata key-and-value pairs, which is maintained for backward - compatibility. + 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: |- - The server name. + 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 - os-extended-volumes:volumes_attached: + networks: description: |- - The attached volumes, if any. + 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. - **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. + 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. - **New in version 2.75** + 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: - name: - description: The security group name + 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 - server_groups: + personality: description: |- - The UUIDs of the server groups to which the server belongs. Currently - this can contain at most one entry. + 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. - **New in version 2.71** + **Available until version 2.56** items: - type: string + additionalProperties: false + properties: + contents: + format: base64 + type: string + path: + type: string + type: object type: array - x-openstack: - min-ver: '2.71' - status: + return_reservation_id: description: |- - The server status. - readOnly: true - type: string - tags: + 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: |- - A list of tags. The maximum count of tags in this list is 50. - - **New in version 2.26** + 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: - type: string + 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 - 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: + user_data: 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. + Configuration information or scripts to use upon launch. + Must be Base64 encoded. Restricted to 65535 bytes. - **New in version 2.63** - items: - type: string + 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: - - 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 + - string required: - - flavor - - id - - image + - flavorRef - 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: + ServersCreate_21: additionalProperties: false properties: - server: - additionalProperties: false - description: |- - A `server` object. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true 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: + build_near_host_ip: description: |- - IPv6 address that should be used to access this server. - format: ipv6 + 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 - name: + cidr: description: |- - The server name. - format: name - maxLength: 255 - minLength: 1 + 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 - 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: + different_cell: 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: + 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: |- - IPv4 address that should be used to access this server. - format: ipv4 - type: string - accessIPv6: + 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: |- - IPv6 address that should be used to access this server. - format: ipv6 - type: string - 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: 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. + Schedule the server by using a custom filter in JSON format. + For example: - **New in version 2.19** - maxLength: 255 - minLength: 0 - pattern: ^[\ - -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` + + It is available when `JsonFilter` is available on cloud side. type: - - 'null' + - object - string - name: + same_host: description: |- - The server name. + 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 - required: - - server - type: object - x-openstack: - max-ver: '2.89' - min-ver: '2.19' - ServerUpdate_290: - additionalProperties: false - properties: - server: - additionalProperties: false + minLength: 1 + type: string + type: object + os:scheduler_hints: + additionalProperties: true 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: + 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. - * `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: + 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: |- - IPv4 address that should be used to access this server. - format: ipv4 + 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 - accessIPv6: + cidr: description: |- - IPv6 address that should be used to access this server. - format: ipv6 + 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 - description: + different_cell: 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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: - - 'null' + - array - string - hostname: + different_host: 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 + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - This information is published via the metadata service and requires - application such as `cloud-init` to propagate it through to the - instance. + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - **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: + It is available when `JsonFilter` is available on cloud side. + type: + - object + - string + same_host: description: |- - The server name. + 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 - required: - - server - type: object - x-openstack: - max-ver: '2.93' - min-ver: '2.90' - ServerUpdate_294: - additionalProperties: false - properties: server: additionalProperties: false description: |- @@ -31313,972 +78488,1699 @@ components: 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: + adminPass: 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-._]*$ + The administrative password of the server. If you omit this parameter, the operation + generates a new password. type: string - name: + availability_zone: description: |- - The server name. + 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 - 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_Create_Image_20' - - $ref: '#/components/schemas/ServersAction_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: + 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: |- - 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. + 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: - The only supported connection type is `spice-html5`. The `type` parameter - should be set to `spice-html5`. + > ``` + > "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"}] + > ``` - Normal response codes: 200 + 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. - 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: + 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: |- - The type of SPICE console. The only valid value is `spice-html5`. + 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: - - spice-html5 + - '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 - 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: + max_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string + metadata: + additionalProperties: false description: |- - The type of VNC console. The only valid value is `novnc`. - enum: - - novnc - - xvpvnc + 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 - 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. + 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. - The only supported connect type is `rdp-html5`. The `type` parameter should - be set as `rdp-html5`. + 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. - Specify the `os-getRDPConsole` action in the request body. + 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. - Normal response codes: 200 + 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. - 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 + **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: - - novnc - - rdp-html5 - - serial - - spice-html5 - type: string - url: - description: The URL used to connect to the console. + - '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: - - type - - url + - flavorRef + - name type: object required: - - console + - server type: object x-openstack: - action-name: os-getSPICEConsole - ServersActionOs-GetvncconsoleResponse: - description: The remote console object. + max-ver: '2.18' + min-ver: '2.1' + ServersCreate_219: + additionalProperties: false properties: - console: + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - type: - description: The type of the remote console - enum: - - novnc - - rdp-html5 - - serial - - spice-html5 + 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 - url: - description: The URL used to connect to the console. + 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 - 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_Rebuild_20' - - $ref: '#/components/schemas/ServersAction_Rebuild_21' - - $ref: '#/components/schemas/ServersAction_Rebuild_219' - - $ref: '#/components/schemas/ServersAction_Rebuild_254' - - $ref: '#/components/schemas/ServersAction_Rebuild_257' - - $ref: '#/components/schemas/ServersAction_Rebuild_263' - - $ref: '#/components/schemas/ServersAction_Rebuild_290' - - $ref: '#/components/schemas/ServersAction_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. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), - conflict(409), gone(410) - properties: - resetNetwork: + 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 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`. + 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. - 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. + Note - If a server is locked, you must have administrator privileges to unshelve the server. + This is a top-level key in the request body, not part of the + server portion of the request body. - 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. + There are a few caveats with scheduler hints: - 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 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. - The behavior according to unshelve parameters will follow the below table. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - **Asynchronous Postconditions** + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - After you successfully unshelve a server, its status changes to `ACTIVE`. - The server appears on the compute node. + 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: - The shelved image is deleted from the list of images returned by an API call. + * `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: - **Troubleshooting** + > ``` + > "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"}] + > ``` - 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. + 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. - Normal response codes: 202 + 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. - 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_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. + **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. - Specify the `addFixedIp` action and the network ID in the request body. + 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. - 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. + 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. - Normal response codes: 202 + 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. - 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: + **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: |- - The network ID. - maxLength: 36 - minLength: 1 + 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: - - number + - 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: - - networkId + - flavorRef + - name type: object required: - - addFixedIp - summary: Add (Associate) Fixed Ip (addFixedIp Action) (DEPRECATED) + - server type: object x-openstack: - action-name: addFixedIp - max-ver: '2.43' - min-ver: '2.1' - ServersAction_Add_Floating_Ip_21: + max-ver: '2.31' + min-ver: '2.19' + ServersCreate_232: additionalProperties: false - description: |- - Adds a floating IP address to a server, which associates - that address with the server. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - 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. + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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. + 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. - **Preconditions** + Note - The server must exist. + This is a top-level key in the request body, not part of the + server portion of the request body. - You can only add a floating IP address to the server when its status is `ACTIVE` or `STOPPED` + There are a few caveats with scheduler hints: - Normal response codes: 202 + * 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. - 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`. + For these reasons, it is important to consult each cloud’s user + documentation to know what is available for scheduler hints. properties: - address: + build_near_host_ip: description: |- - The fixed IP address with which you want to associate the floating IP address. + 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 - fixed_address: + cidr: description: |- - The fixed IP address with which you want to associate the floating IP address. - oneOf: - - format: ipv4 - - format: ipv6 + 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 - 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. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - Error response codes: badRequest(400), unauthorized(401), forbidden(403), - itemNotFound(404), conflict(409) - properties: - addSecurityGroup: + 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: |- - The action to add a security group to a server. + A `server` object. properties: - name: + OS-DCF:diskConfig: description: |- - The security group name. + 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 - required: - - name - type: object - required: - - addSecurityGroup - summary: Add Security Group To A Server (addSecurityGroup Action) - type: object - x-openstack: - action-name: addSecurityGroup - ServersAction_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** + 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: - 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: + > ``` + > "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"}] + > ``` - Note that the cloud provider may still need to cleanup any orphaned resources - on the source hypervisor. + 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. - Normal response codes: 204 + 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. - 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_Create_Backup_20: - additionalProperties: false - properties: - createBackup: - additionalProperties: false - description: |- - The action. - properties: - backup_type: + **New in version 2.19** + maxLength: 255 + minLength: 0 + pattern: ^[\ + -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + type: + - 'null' + - string + flavorRef: description: |- - The type of the backup, for example, `daily`. - type: string - metadata: - additionalProperties: false + 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: |- - 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 + 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 - type: object - name: + - maxLength: 0 + type: string + key_name: description: |- - The name of the image to be backed up. - format: name_with_leading_trailing_spaces + 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 - rotation: - description: |- - The rotation of the back up image, the oldest image will be removed when image count - exceed the rotation count. + max_count: minLength: 1 - minimum: 0 + minimum: 1 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: |- @@ -32289,153 +80191,637 @@ components: maxLength: 255 type: string type: object + min_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string name: description: |- - The name of the image to be backed up. + 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 - rotation: + networks: 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]*$ + 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: - - integer + - 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: - - backup_type + - flavorRef - name - - rotation type: object required: - - createBackup - summary: Create Server Back Up (createBackup Action) + - server type: object x-openstack: - action-name: createBackup - max-ver: '2.0' - min-ver: '2.1' - ServersAction_Create_Image_20: + max-ver: '2.32' + min-ver: '2.32' + ServersCreate_233: additionalProperties: false properties: - createImage: - additionalProperties: false - description: |- - The action to create a snapshot of the image or - the volume(s) of the server. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - metadata: - additionalProperties: false + build_near_host_ip: 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 + 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 - type: object - name: + group: description: |- - The display name of an Image. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - 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 - 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_Create_Image_21: - additionalProperties: false - properties: - createImage: - additionalProperties: false + os:scheduler_hints: + additionalProperties: true description: |- - The action to create a snapshot of the image or - the volume(s) of the server. + 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: - metadata: - additionalProperties: false + build_near_host_ip: 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 + 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 - type: object - name: + group: description: |- - The display name of an Image. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - 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 - 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_Evacuate_20: - additionalProperties: false - properties: - evacuate: + server: additionalProperties: false description: |- - The action to evacuate a server to another host. + A `server` object. properties: - adminPass: + OS-DCF:diskConfig: 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. + 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 - host: + accessIPv4: 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. + 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 - pattern: ^[a-zA-Z0-9-._]*$ type: string - onSharedStorage: + 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: |- - Server on shared storage. + 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: - Note + > ``` + > "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"}] + > ``` - Starting since version 2.14, Nova automatically detects - whether the server is on shared storage or not. - Therefore this parameter was removed. + 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. - **Available until version 2.13** + 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' @@ -32462,93 +80848,172 @@ components: 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: 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 + A free form description of the server. Limited to 255 characters + in length. Before microversion 2.19 this was set to the server + name. - 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. + **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 - 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: + max_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string + metadata: + additionalProperties: false 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. + 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 - force: + networks: description: |- - Force an evacuation by not verifying the provided destination host by the - scheduler. - - Warning + 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. - 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. + 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. - 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. + 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. - **New in version 2.29** + 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.67** + **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' @@ -32575,264 +81040,504 @@ components: 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: + security_groups: 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: + 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: |- - 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-._]*$ + 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: - - evacuate - summary: Evacuate Server (evacuate Action) + - server type: object x-openstack: - action-name: evacuate - max-ver: '2.94' - min-ver: '2.68' - ServersAction_Evacuate_295: + max-ver: '2.36' + min-ver: '2.33' + ServersCreate_237: additionalProperties: false properties: - evacuate: - additionalProperties: false - description: |- - The action to evacuate a server to another host. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - adminPass: + build_near_host_ip: 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. + 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 - host: + cidr: description: |- - The name or ID of the host to which the server is evacuated. - If you omit this parameter, the scheduler chooses a host. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Warning + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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. + 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 - 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. + 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. - 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. + Note - Normal response codes: 202 + This is a top-level key in the request body, not part of the + server portion of the request body. - 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. + There are a few caveats with scheduler hints: - Specify the `injectNetworkInfo` action in the request body. + * 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. - Policy defaults enable only users with the administrative role to - perform this operation. Cloud providers can change these permissions - through the `policy.yaml` file. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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: + 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: |- - The action to lock a server. - This parameter can be `null`. - Up to microversion 2.73, this parameter should be `null`. + A `server` object. properties: - locked_reason: + 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 - 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. + 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: - 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. + > ``` + > "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"}] + > ``` - Normal response codes: 202 + 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. - 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: + 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: |- - 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** + 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' @@ -32859,89 +81564,168 @@ components: type: - boolean - string - disk_over_commit: + description: 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. + A free form description of the server. Limited to 255 characters + in length. Before microversion 2.19 this was set to the server + name. - **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 + **New in version 2.19** + maxLength: 255 + minLength: 0 + pattern: ^[\ + -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ type: - - boolean + - 'null' - string - host: + flavorRef: 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. + 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 - pattern: ^[a-zA-Z0-9-._]*$ + type: string + max_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ type: - - 'null' + - integer - 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: + metadata: + additionalProperties: false 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. + 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. - **New in version 2.25** + 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' @@ -32959,7 +81743,6 @@ components: - 'True' - YES - Yes - - auto - 'false' - no - off @@ -32969,366 +81752,585 @@ components: type: - boolean - string - host: + security_groups: description: |- - The host to which to migrate the server. If this parameter is `None`, - the scheduler chooses a host. + 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. - Warning + Note - 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 + 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: - - block_migration - - host + - flavorRef + - name + - networks type: object required: - - os-migrateLive - summary: Live-Migrate Server (os-migrateLive Action) + - server type: object x-openstack: - action-name: os-migrateLive - max-ver: '2.29' - min-ver: '2.25' - ServersAction_Migrate_Live_230: + max-ver: '2.41' + min-ver: '2.37' + ServersCreate_242: additionalProperties: false properties: - os-migrateLive: - additionalProperties: false - description: |- - The action. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - block_migration: + build_near_host_ip: 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: + 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: |- - 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 + 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: - - boolean + - array - string - host: + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: description: |- - The host to which to migrate the server. If this parameter is `None`, - the scheduler chooses a host. + Schedule the server by using a custom filter in JSON format. + For example: - Warning + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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-._]*$ + It is available when `JsonFilter` is available on cloud side. type: - - 'null' + - object - 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: + same_host: 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 + 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: - - boolean + - array - string - host: + target_cell: 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. + 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 - pattern: ^[a-zA-Z0-9-._]*$ - type: - - 'null' - - string - required: - - block_migration - - host + type: string 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_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. + 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. - You can only *SOFT* reboot a server when its status is `ACTIVE`. + Note - You can only *HARD* reboot a server when its status is one of: + This is a top-level key in the request body, not part of the + server portion of the request body. - If the server is locked, you must have administrator privileges - to reboot the server. + There are a few caveats with scheduler hints: - **Asynchronous Postconditions** + * 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. - After you successfully reboot a server, its status changes to `ACTIVE`. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), - conflict(409) - properties: - reboot: - additionalProperties: false - description: |- - The action to reboot a server. - properties: - type: + It is available when `JsonFilter` is available on cloud side. + type: + - object + - string + same_host: 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 + 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 - required: - - type type: object - required: - - reboot - summary: Reboot Server (reboot Action) - type: object - x-openstack: - action-name: reboot - ServersAction_Rebuild_20: - additionalProperties: false - properties: - rebuild: + server: additionalProperties: false description: |- - The action to rebuild a server. + 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. + 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: - - AUTO - - MANUAL - type: string - accessIPv4: - description: |- - IPv4 address that should be used to access this server. - format: ipv4 - type: string - accessIPv6: + - '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: |- - IPv6 address that should be used to access this server. - format: ipv6 - type: string - adminPass: + 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 administrative password of the server. If you omit this parameter, the operation - generates a new password. - type: string + 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 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 + 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: |- @@ -33339,13 +82341,89 @@ components: maxLength: 255 type: string type: object + min_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string name: description: |- - The server name. - format: name_with_leading_trailing_spaces + 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 @@ -33363,16 +82441,14 @@ components: type: string type: object type: array - preserve_ephemeral: + return_reservation_id: 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. + 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' @@ -33399,163 +82475,268 @@ components: 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: - - imageRef + - flavorRef + - name + - networks type: object required: - - rebuild - summary: Rebuild Server (rebuild Action) + - server type: object x-openstack: - action-name: rebuild - max-ver: '2.0' - min-ver: '2.0' - ServersAction_Rebuild_21: + max-ver: '2.51' + min-ver: '2.42' + ServersCreate_252: additionalProperties: false properties: - rebuild: - additionalProperties: false - description: |- - The action to rebuild a server. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true 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: + build_near_host_ip: description: |- - IPv4 address that should be used to access this server. - format: ipv4 + 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 - accessIPv6: + cidr: description: |- - IPv6 address that should be used to access this server. - format: ipv6 + 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 - adminPass: + different_cell: description: |- - The administrative password of the server. If you omit this parameter, the operation - generates a new password. - type: string - imageRef: + 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: |- - 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 + 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: |- - 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 + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid type: string - type: object - name: + query: description: |- - The server name. + 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 - 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. + 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. - **Available until version 2.56** + 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: - additionalProperties: false - properties: - contents: - format: base64 + 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 - path: + 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. + oneOf: + - items: + format: uuid type: string - type: object - type: array - preserve_ephemeral: + type: array + - format: uuid + type: string + query: description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + Schedule the server by using a custom filter in JSON format. + For example: - Note + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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 + It is available when `JsonFilter` is available on cloud side. type: - - boolean + - object - string - required: - - imageRef + 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 - required: - - rebuild - summary: Rebuild Server (rebuild Action) - type: object - x-openstack: - action-name: rebuild - max-ver: '2.18' - min-ver: '2.1' - ServersAction_Rebuild_219: - additionalProperties: false - properties: - rebuild: + server: additionalProperties: false description: |- - The action to rebuild a server. + A `server` object. properties: OS-DCF:diskConfig: description: |- @@ -33593,78 +82774,211 @@ components: 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: + availability_zone: description: |- - The server name. + 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 - 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** + block_device_mapping: items: additionalProperties: false properties: - contents: - format: base64 + connection_info: + maxLength: 16777215 type: string - path: + 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 - preserve_ephemeral: + block_device_mapping_v2: description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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: - Note + > ``` + > "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"}] + > ``` - This only works with baremetal servers provided by - Ironic. Passing it to any other server instance results in a - fault and will prevent the rebuild from happening. + In 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' @@ -33691,61 +83005,6 @@ components: 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_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 @@ -33760,40 +83019,41 @@ components: type: - 'null' - string - imageRef: + flavorRef: 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: + 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: |- - 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** + 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: - - type: 'null' - - maxLength: 255 - minLength: 1 + - 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: |- @@ -33803,14 +83063,90 @@ components: ^[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 + 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 @@ -33828,16 +83164,14 @@ components: type: string type: object type: array - preserve_ephemeral: + return_reservation_id: 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. + 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' @@ -33864,24 +83198,288 @@ components: 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: - - imageRef + - flavorRef + - name + - networks type: object required: - - rebuild - summary: Rebuild Server (rebuild Action) + - server type: object x-openstack: - action-name: rebuild max-ver: '2.56' - min-ver: '2.54' - ServersAction_Rebuild_257: + min-ver: '2.52' + ServersCreate_257: additionalProperties: false properties: - rebuild: + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - 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. + oneOf: + - items: + format: uuid + type: string + type: array + - 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: |- - The action to rebuild a server. + A `server` object. properties: OS-DCF:diskConfig: description: |- @@ -33919,6 +83517,237 @@ components: 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 @@ -33933,40 +83762,41 @@ components: type: - 'null' - string - imageRef: + flavorRef: 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: + 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: |- - 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** + 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: - - type: 'null' - - maxLength: 255 - minLength: 1 + - 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: |- @@ -33977,23 +83807,97 @@ components: maxLength: 255 type: string type: object + min_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string name: description: |- - The server name. + 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 - preserve_ephemeral: + networks: description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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. - Note + 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. - 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. + 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' @@ -34020,225 +83924,288 @@ components: 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 rebuild. + Configuration information or scripts to use upon launch. Must be Base64 encoded. Restricted to 65535 bytes. - If `null` is specified, the existing user_data is unset. - **New in version 2.57** + 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 + type: string required: - - imageRef + - flavorRef + - name + - networks type: object required: - - rebuild - summary: Rebuild Server (rebuild Action) + - server type: object x-openstack: - action-name: rebuild max-ver: '2.62' min-ver: '2.57' - ServersAction_Rebuild_263: + ServersCreate_263: additionalProperties: false properties: - rebuild: - additionalProperties: false - description: |- - The action to rebuild a server. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true 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: + build_near_host_ip: description: |- - IPv6 address that should be used to access this server. - format: ipv6 + 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 - adminPass: + cidr: description: |- - The administrative password of the server. If you omit this parameter, the operation - generates a new password. + 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 - description: + different_cell: 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + 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: - - 'null' + - array - 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: + different_host: 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** + 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: - - type: 'null' - - maxLength: 255 - minLength: 1 + - items: + format: uuid + type: string + type: array + - format: uuid type: string - metadata: - additionalProperties: false + group: 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 + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid type: string - type: object - name: + query: description: |- - The server name. + 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 - preserve_ephemeral: - description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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 + 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 + 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: - - boolean + - array - string - trusted_image_certificates: + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: 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. + Schedule the server by using a custom filter in JSON format. + For example: - If `null` is specified, the existing trusted certificate IDs are either - unset or reset to the configured defaults. + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - **New in version 2.63** + 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: - minLength: 1 + format: uuid 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 + 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 - required: - - rebuild - summary: Rebuild Server (rebuild Action) - type: object - x-openstack: - action-name: rebuild - max-ver: '2.89' - min-ver: '2.63' - ServersAction_Rebuild_290: - additionalProperties: false - properties: - rebuild: + server: additionalProperties: false description: |- - The action to rebuild a server. + A `server` object. properties: OS-DCF:diskConfig: description: |- @@ -34276,99 +84243,211 @@ components: 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: + availability_zone: description: |- - The server name. + 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 - preserve_ephemeral: + 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: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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: - Note + > ``` + > "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"}] + > ``` - This only works with baremetal servers provided by - Ironic. Passing it to any other server instance results in a - fault and will prevent the rebuild from happening. + In 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' @@ -34395,94 +84474,6 @@ components: 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_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 @@ -34497,58 +84488,41 @@ components: type: - 'null' - string - hostname: + flavorRef: 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 + The flavor reference, as an ID (including a UUID) or full URL, + for the flavor for your server instance. minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ - type: string + type: + - integer + - 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** + 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: - - type: 'null' - - maxLength: 255 - minLength: 1 + - 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: |- @@ -34559,23 +84533,97 @@ components: maxLength: 255 type: string type: object + min_count: + minLength: 1 + minimum: 1 + pattern: ^[0-9]*$ + type: + - integer + - string name: description: |- - The server name. + 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 - preserve_ephemeral: + networks: description: |- - Indicates whether the server is rebuilt with the preservation of the ephemeral - partition (`true`). + 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. - Note + 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. - 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. + 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' @@ -34602,16 +84650,53 @@ components: 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 - 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. + create requests if allowed by policy, and is not supported for + volume-backed instances. **New in version 2.63** items: @@ -34625,246 +84710,246 @@ components: uniqueItems: true user_data: description: |- - Configuration information or scripts to use upon rebuild. + Configuration information or scripts to use upon launch. Must be Base64 encoded. Restricted to 65535 bytes. - If `null` is specified, the existing user_data is unset. - **New in version 2.57** + 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 + type: string required: - - imageRef + - flavorRef + - name + - networks type: object required: - - rebuild - summary: Rebuild Server (rebuild Action) + - server type: object x-openstack: - action-name: rebuild - max-ver: '2.0' - min-ver: '2.94' - ServersAction_Remove_Fixed_Ip_21: + max-ver: '2.66' + min-ver: '2.63' + ServersCreate_267: 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. + OS-SCH-HNT:scheduler_hints: + additionalProperties: true properties: - address: + build_near_host_ip: description: |- - The IP address. + 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 - 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: + cidr: description: |- - The floating IP address. - oneOf: - - format: ipv4 - - format: ipv6 + 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 - 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. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - 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: + It is available when `JsonFilter` is available on cloud side. + type: + - object + - string + same_host: description: |- - The security group name. + 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 - 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. + 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. - 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. + Note - **Asynchronous Postconditions** + This is a top-level key in the request body, not part of the + server portion of the request body. - After you successfully rescue a server and make a `GET - /servers/​{server_id}​` request, its status changes to `RESCUE`. + There are a few caveats with scheduler hints: - Normal response codes: 200 + * 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. - 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. + For these reasons, it is important to consult each cloud’s user + documentation to know what is available for scheduler hints. properties: - adminPass: - type: string - rescue_image_ref: - format: uuid + 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 - 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: + cidr: description: |- - The state of the server to be set, `active` or `error` are valid. - enum: - - active - - error + 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 - required: - - state - type: object - required: - - os-resetState - summary: Reset Server State (os-resetState Action) - type: object - x-openstack: - action-name: os-resetState - ServersAction_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. + 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. + oneOf: + - items: + format: uuid + type: string + type: array + - format: uuid + type: string + query: + description: |- + Schedule the server by using a custom filter in JSON format. + For example: - Normal response codes: 202 + ``` + "query": "[\">=\",\"$free_ram_mb\",1024]" + ``` - Error response codes: badRequest(400), unauthorized(401), forbidden(403), - itemNotFound(404), conflict(409) - properties: - resize: + 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: |- - The action to resize a server. + A `server` object. properties: OS-DCF:diskConfig: description: |- @@ -34887,534 +84972,516 @@ components: - AUTO - MANUAL type: string - flavorRef: + accessIPv4: 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. + 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: - - integer - - string - required: - - flavorRef - type: object - required: - - resize - summary: Resize Server (resize Action) - type: object - x-openstack: - action-name: resize - 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_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_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: - 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: - 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_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_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`. + 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: - **Asynchronous Postconditions** + > ``` + > "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"}] + > ``` - After you successfully unrescue a server and make a - `GET /servers/​{server_id}​` - request, its status changes to `ACTIVE`. + 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. - Normal response codes: 202 + 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. - 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 + **New in version 2.19** 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: + minLength: 0 + pattern: ^[\ + -\~ -¬®-ͷͺ-Ϳ΄-ΊΌΎ-ΡΣ-ԯԱ-Ֆՙ-֊֍-֏֑-ׇא-תׯ-״؆-؛؝-ۜ۞-܍ܐ-݊ݍ-ޱ߀-ߺ߽-࠭࠰-࠾ࡀ-࡛࡞ࡠ-ࡪࡰ-ࢎ࢘-ࣣ࣡-ঃঅ-ঌএ-ঐও-নপ-রলশ-হ়-ৄে-ৈো-ৎৗড়-ঢ়য়-ৣ০-৾ਁ-ਃਅ-ਊਏ-ਐਓ-ਨਪ-ਰਲ-ਲ਼ਵ-ਸ਼ਸ-ਹ਼ਾ-ੂੇ-ੈੋ-੍ੑਖ਼-ੜਫ਼੦-੶ઁ-ઃઅ-ઍએ-ઑઓ-નપ-રલ-ળવ-હ઼-ૅે-ૉો-્ૐૠ-ૣ૦-૱ૹ-૿ଁ-ଃଅ-ଌଏ-ଐଓ-ନପ-ରଲ-ଳଵ-ହ଼-ୄେ-ୈୋ-୍୕-ୗଡ଼-ଢ଼ୟ-ୣ୦-୷ஂ-ஃஅ-ஊஎ-ஐஒ-கங-சஜஞ-டண-தந-பம-ஹா-ூெ-ைொ-்ௐௗ௦-௺ఀ-ఌఎ-ఐఒ-నప-హ఼-ౄె-ైొ-్ౕ-ౖౘ-ౚౝౠ-ౣ౦-౯౷-ಌಎ-ಐಒ-ನಪ-ಳವ-ಹ಼-ೄೆ-ೈೊ-್ೕ-ೖೝ-ೞೠ-ೣ೦-೯ೱ-ೳഀ-ഌഎ-ഐഒ-ൄെ-ൈൊ-൏ൔ-ൣ൦-ൿඁ-ඃඅ-ඖක-නඳ-රලව-ෆ්ා-ුූෘ-ෟ෦-෯ෲ-෴ก-ฺ฿-๛ກ-ຂຄຆ-ຊຌ-ຣລວ-ຽເ-ໄໆ່-໎໐-໙ໜ-ໟༀ-ཇཉ-ཬཱ-ྗྙ-ྼ྾-࿌࿎-࿚က-ჅჇჍა-ቈቊ-ቍቐ-ቖቘቚ-ቝበ-ኈኊ-ኍነ-ኰኲ-ኵኸ-ኾዀዂ-ዅወ-ዖዘ-ጐጒ-ጕጘ-ፚ፝-፼ᎀ-᎙Ꭰ-Ᏽᏸ-ᏽ᐀-᚜ᚠ-ᛸᜀ-᜕ᜟ-᜶ᝀ-ᝓᝠ-ᝬᝮ-ᝰᝲ-ᝳក-៝០-៩៰-៹᠀-᠍᠏-᠙ᠠ-ᡸᢀ-ᢪᢰ-ᣵᤀ-ᤞᤠ-ᤫᤰ-᤻᥀᥄-ᥭᥰ-ᥴᦀ-ᦫᦰ-ᧉ᧐-᧚᧞-ᨛ᨞-ᩞ᩠-᩿᩼-᪉᪐-᪙᪠-᪭᪰-ᫎᬀ-ᭌ᭐-᭾ᮀ-᯳᯼-᰷᰻-᱉ᱍ-ᲈᲐ-ᲺᲽ-᳇᳐-ᳺᴀ-ἕἘ-Ἕἠ-ὅὈ-Ὅὐ-ὗὙὛὝὟ-ώᾀ-ᾴᾶ-ῄῆ-ΐῖ-Ί῝-`ῲ-ῴῶ-῾ - ‐-‧ - ⁰-ⁱ⁴-₎ₐ-ₜ₠-⃀⃐-⃰℀-↋←-␦⑀-⑊①-⭳⭶-⮕⮗-ⳳ⳹-ⴥⴧⴭⴰ-ⵧⵯ-⵰⵿-ⶖⶠ-ⶦⶨ-ⶮⶰ-ⶶⶸ-ⶾⷀ-ⷆⷈ-ⷎⷐ-ⷖⷘ-ⷞⷠ-⹝⺀-⺙⺛-⻳⼀-⿕⿰-⿻　-〿ぁ-ゖ゙-ヿㄅ-ㄯㄱ-ㆎ㆐-㇣ㇰ-㈞㈠-ꒌ꒐-꓆ꓐ-ꘫꙀ-꛷꜀-ꟊꟐ-ꟑꟓꟕ-ꟙꟲ-꠬꠰-꠹ꡀ-꡷ꢀ-ꣅ꣎-꣙꣠-꥓꥟-ꥼꦀ-꧍ꧏ-꧙꧞-ꧾꨀ-ꨶꩀ-ꩍ꩐-꩙꩜-ꫂꫛ-꫶ꬁ-ꬆꬉ-ꬎꬑ-ꬖꬠ-ꬦꬨ-ꬮꬰ-꭫ꭰ-꯭꯰-꯹가-힣ힰ-ퟆퟋ-ퟻ豈-舘並-龎ff-stﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ 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: + flavorRef: 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 + 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 - 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 + - maxLength: 0 type: string - id: - description: |- - The UUID of the server. - format: uuid - readOnly: true + 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 - 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. + 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. - **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. + 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: - href: - format: uri + fixed_ip: + oneOf: + - format: ipv4 + - format: ipv6 type: string - rel: + port: + format: uuid + type: + - 'null' + - string + tag: + maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ type: string - type: object - type: array - security_groups: - description: |- - One or more security groups objects. - items: - properties: - name: - description: The security group name + uuid: + format: uuid 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. + - 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: - - reservation_id + - flavorRef + - name + - networks type: object - ServersCreate_20: + required: + - server + type: object + x-openstack: + max-ver: '2.73' + min-ver: '2.67' + ServersCreate_274: additionalProperties: false properties: OS-SCH-HNT:scheduler_hints: @@ -35672,14 +85739,10 @@ components: 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 + 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 @@ -35846,6 +85909,11 @@ components: - snapshot - volume type: string + tag: + maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string uuid: maxLength: 255 minLength: 1 @@ -35864,6 +85932,12 @@ components: type: - integer - string + volume_type: + maxLength: 255 + minLength: 0 + type: + - 'null' + - string type: object type: array config_drive: @@ -35900,6 +85974,20 @@ components: 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, @@ -35908,6 +85996,28 @@ components: 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. @@ -35921,14 +86031,10 @@ components: 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 + 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 @@ -35958,14 +86064,10 @@ components: - 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 + 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 @@ -36008,45 +86110,34 @@ components: 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 + 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 @@ -36092,19 +86183,53 @@ components: 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 + 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. @@ -36116,20 +86241,19 @@ components: input validation, it isn’t allowed in Nova v2.1 API. format: base64 maxLength: 65535 - type: - - 'null' - - string + type: string required: - flavorRef - name + - networks type: object required: - server type: object x-openstack: - max-ver: '2.0' - min-ver: '2.0' - ServersCreate_21: + max-ver: '2.89' + min-ver: '2.74' + ServersCreate_290: additionalProperties: false properties: OS-SCH-HNT:scheduler_hints: @@ -36557,6 +86681,11 @@ components: - snapshot - volume type: string + tag: + maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string uuid: maxLength: 255 minLength: 1 @@ -36575,6 +86704,12 @@ components: type: - integer - string + volume_type: + maxLength: 255 + minLength: 0 + type: + - 'null' + - string type: object type: array config_drive: @@ -36611,6 +86746,20 @@ components: 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, @@ -36619,6 +86768,46 @@ components: 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. @@ -36708,48 +86897,37 @@ components: 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 + 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 @@ -36804,6 +86982,44 @@ components: 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. @@ -36819,14 +87035,15 @@ components: required: - flavorRef - name + - networks type: object required: - server type: object x-openstack: - max-ver: '2.18' - min-ver: '2.1' - ServersCreate_219: + max-ver: '2.93' + min-ver: '2.90' + ServersCreate_294: additionalProperties: false properties: OS-SCH-HNT:scheduler_hints: @@ -37254,6 +87471,11 @@ components: - snapshot - volume type: string + tag: + maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string uuid: maxLength: 255 minLength: 1 @@ -37272,6 +87494,12 @@ components: type: - integer - string + volume_type: + maxLength: 255 + minLength: 0 + type: + - 'null' + - string type: object type: array config_drive: @@ -37330,6 +87558,46 @@ components: 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. @@ -37422,45 +87690,34 @@ components: 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 + 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 @@ -37515,6 +87772,44 @@ components: 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. @@ -37530,8410 +87825,6782 @@ components: required: - flavorRef - name + - networks type: object required: - server type: object x-openstack: - max-ver: '2.31' - min-ver: '2.19' - ServersCreate_232: + min-ver: '2.94' + ServersDetailDetailResponse_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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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 + OS-EXT-AZ:availability_zone: + type: string + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: + type: string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time 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. - oneOf: - - items: - format: uuid + details: type: string - type: array - - 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 + message: + type: string + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: 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: + id: + format: uuid 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 + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' 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. - oneOf: - - items: - format: uuid + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + metadata: + additionalProperties: false + patternProperties: + ^.+$: type: string - type: array - - 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: object + name: + type: + - 'null' + - string + os-extended-volumes:volumes_attached: + items: + additionalProperties: false + properties: + id: + type: string + required: + - id + type: object + type: array + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE 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 + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - flavor + - hostId + - id + - image + - key_name + - links + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.2' + min-ver: '2.1' + ServersDetailDetailResponse_2100: + additionalProperties: false + properties: + servers: 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 + A list of `server` objects. + items: + oneOf: + - additionalProperties: false properties: - connection_info: - maxLength: 16777215 + OS-DCF:diskConfig: 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). + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: enum: - - '0' - - '1' - - 'FALSE' - - false + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - - 'False' - - NO - - No - - OFF - - ON - - Off - - On - - 'TRUE' - - true - 'True' - - YES - - Yes - - 'false' - - no - - off - - on - - 'true' - - yes type: - - boolean + - 'null' - string - device_name: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + 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 - virtual_name: - maxLength: 255 + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP type: string - volume_id: + id: format: uuid type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + properties: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + type: object + - const: '' + type: string + key_name: type: - - integer + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + locked_reason: + type: + - 'null' - 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]+$ + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: 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 + 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: - - boolean + - 'null' - 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: + 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: + oneOf: + - items: + format: uuid + type: string + type: array + - 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 + status: enum: - - blank - - image - - snapshot - - volume - type: string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - uuid: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: 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 + pattern: ^[a-zA-Z0-9-]*$ type: string - port: - format: uuid + trusted_image_certificates: + items: + type: string type: + - array - '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 + updated: + format: date-time type: string - path: + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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 + required: + - OS-DCF:diskConfig + - OS-EXT-AZ:availability_zone + - OS-EXT-SRV-ATTR:hostname + - 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 + - scheduler_hints + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time + type: string + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string + required: + - created + - id + - links + - status + - tenant_id 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 + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.32' - min-ver: '2.32' - ServersCreate_233: + min-ver: '2.100' + ServersDetailDetailResponse_216: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: 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: + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - 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: + 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + fault: 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 + code: + type: integer + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + details: type: string - source_type: - enum: - - blank - - image - - snapshot - - volume + message: type: string - uuid: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._-]*$ + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: type: string - virtual_name: - maxLength: 255 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: + type: string + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' type: string - volume_id: - format: uuid + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: 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: + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.18' + min-ver: '2.16' + ServersDetailDetailResponse_219: + additionalProperties: false + properties: + servers: + description: |- + A list of `server` objects. + items: + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: 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 + code: + type: integer + created: + format: date-time type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + details: type: string - uuid: + message: type: string + required: + - code + - created + - message 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: + flavor: additionalProperties: false properties: - contents: - format: base64 - type: string - path: + id: type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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: + hostId: + type: string + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.36' - min-ver: '2.33' - ServersCreate_237: + max-ver: '2.25' + min-ver: '2.19' + ServersDetailDetailResponse_226: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - 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: + 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: 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 + code: + type: integer + created: + format: date-time type: string - virtual_name: - maxLength: 255 + details: type: string - volume_id: - format: uuid + message: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - code + - created + - message 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: + flavor: 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 + id: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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 + hostId: + type: string + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false properties: - fixed_ip: - oneOf: - - format: ipv4 - - format: ipv6 - type: string - port: - format: uuid - type: - - 'null' - - string - uuid: + id: format: uuid type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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: + - const: '' 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: + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tags + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.41' - min-ver: '2.37' - ServersCreate_242: + max-ver: '2.46' + min-ver: '2.26' + ServersDetailDetailResponse_23: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: 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: + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + fault: 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 + code: + type: integer + created: + format: date-time type: string - virtual_name: - maxLength: 255 + details: type: string - volume_id: - format: uuid + message: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - code + - created + - message 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: + flavor: 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 + id: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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 + hostId: + type: string + id: + format: uuid + type: string + image: + oneOf: + - 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: + id: format: uuid type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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: + - const: '' 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: + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - flavor + - hostId + - id + - image + - key_name + - links + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.51' - min-ver: '2.42' - ServersCreate_252: + max-ver: '2.8' + min-ver: '2.3' + ServersDetailDetailResponse_247: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: 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 + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - 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: + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: 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._-]*$ + code: + type: integer + created: + format: date-time type: string - virtual_name: - maxLength: 255 + details: type: string - volume_id: - format: uuid + message: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - code + - created + - message 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: + flavor: + additionalProperties: false + properties: + disk: + type: integer + ephemeral: + type: integer + extra_specs: additionalProperties: false - properties: - fixed_ip: - oneOf: - - format: ipv4 - - format: ipv6 - type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + patternProperties: + ^.+$: type: string - uuid: + 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: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: format: uuid type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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 + - const: '' 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: + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: + maxLength: 255 minLength: 1 - pattern: ^[^,/]*$ + pattern: ^[a-zA-Z0-9-]*$ 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 + updated: + format: date-time + type: 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tags + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: - - server + - servers type: object x-openstack: - max-ver: '2.56' - min-ver: '2.52' - ServersCreate_257: + max-ver: '2.62' + min-ver: '2.47' + ServersDetailDetailResponse_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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-AZ:availability_zone: 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: + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: 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: + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: 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._-]*$ + code: + type: integer + created: + format: date-time type: string - virtual_name: - maxLength: 255 + details: type: string - volume_id: - format: uuid + message: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string + required: + - code + - created + - message 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: + flavor: + additionalProperties: false + properties: + disk: + type: integer + ephemeral: + type: integer + extra_specs: additionalProperties: false - properties: - fixed_ip: - oneOf: - - format: ipv4 - - format: ipv6 - type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + patternProperties: + ^.+$: type: string - uuid: + 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: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: format: uuid type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array 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: + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: + maxLength: 255 minLength: 1 - pattern: ^[^,/]*$ + pattern: ^[a-zA-Z0-9-]*$ + type: string + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time + type: 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + type: array + servers_links: + items: + additionalProperties: false + properties: + href: + format: uri 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 + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array required: - - server + - servers type: object x-openstack: - max-ver: '2.62' - min-ver: '2.57' - ServersCreate_263: + max-ver: '2.68' + min-ver: '2.63' + ServersDetailDetailResponse_269: 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 + servers: + description: |- + A list of `server` objects. + items: + oneOf: + - additionalProperties: false + properties: + OS-DCF:diskConfig: 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. - oneOf: - - items: - format: uuid + OS-EXT-AZ:availability_zone: type: string - type: array - - 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 + OS-EXT-SRV-ATTR:host: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:hostname: 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. - oneOf: - - items: - format: uuid + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: type: string - type: array - - 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 + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: + type: + - integer + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - 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). + 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 + 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 + - 'null' - string - device_name: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + 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 - virtual_name: - maxLength: 255 + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP type: string - volume_id: + id: format: uuid type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: type: - - integer + - 'null' - 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]+$ + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: + type: string + type: object + name: 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 + 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 + progress: type: - - boolean - - string - destination_type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: enum: - - local - - volume + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - device_name: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: 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 + pattern: ^[a-zA-Z0-9-]*$ type: string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time type: string - uuid: + user_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9._-]*$ + pattern: ^[a-zA-Z0-9-]*$ type: string - virtual_name: - maxLength: 255 + 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 + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time type: string - volume_id: + 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 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string + required: + - created + - id + - links + - status + - tenant_id 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: array + servers_links: + items: + additionalProperties: false + properties: + href: + format: uri 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 + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array required: - - server + - servers type: object x-openstack: - max-ver: '2.66' - min-ver: '2.63' - ServersCreate_267: + max-ver: '2.72' + min-ver: '2.69' + ServersDetailDetailResponse_273: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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. - oneOf: - - items: - format: uuid - type: string - type: array - - 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 + servers: 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 + A list of `server` objects. + items: + oneOf: + - additionalProperties: false properties: - connection_info: - maxLength: 16777215 + OS-DCF:diskConfig: 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 + OS-EXT-AZ:availability_zone: + type: string + OS-EXT-SRV-ATTR:host: type: - - boolean + - 'null' - 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 + OS-EXT-SRV-ATTR:hostname: type: string - volume_id: - format: uuid + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: type: - integer + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - 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]+$ + OS-EXT-SRV-ATTR:reservation_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:root_device_name: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - string + OS-SRV-USG:launched_at: + format: date-time + type: + - 'null' + - string + OS-SRV-USG:terminated_at: + format: date-time type: - - integer - 'null' - string - connection_info: - maxLength: 16777215 + accessIPv4: + oneOf: + - const: '' + - format: ipv4 type: string - delete_on_termination: + 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 + 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 + - 'null' - 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 + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + 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 - source_type: + host_status: 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 + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP type: string - volume_id: + id: format: uuid type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: type: - - integer + - 'null' - string - volume_type: - maxLength: 255 - minLength: 0 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + locked_reason: 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: + metadata: 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 + patternProperties: + ^.+$: 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 + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + 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_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 + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - 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 + created: + format: date-time + type: string + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string + required: + - created + - id + - links + - status + - tenant_id 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: array + servers_links: + items: + additionalProperties: false + properties: + href: + format: uri 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 + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array required: - - server + - servers type: object x-openstack: - max-ver: '2.73' - min-ver: '2.67' - ServersCreate_274: + max-ver: '2.89' + min-ver: '2.73' + ServersDetailDetailResponse_29: 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: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + OS-DCF:diskConfig: 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 + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + fault: + additionalProperties: false + properties: + code: + type: integer + created: + format: date-time 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. - oneOf: - - items: - format: uuid + details: type: string - type: array - - 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 + message: + type: string + required: + - code + - created + - message + type: object + flavor: + additionalProperties: false + properties: + id: + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + hostId: 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: + id: + format: uuid 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 + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' 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. - oneOf: - - items: - format: uuid + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + metadata: + additionalProperties: false + patternProperties: + ^.+$: type: string - type: array - - 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: 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE 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 + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + updated: + format: date-time + type: 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 + - flavor + - hostId + - id + - image + - key_name + - links + - locked + - metadata + - name + - os-extended-volumes:volumes_attached + - status + - tenant_id + - updated + - user_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.15' + min-ver: '2.9' + ServersDetailDetailResponse_290: + additionalProperties: false + properties: + servers: 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 + A list of `server` objects. + items: + oneOf: + - additionalProperties: false properties: - connection_info: - maxLength: 16777215 + OS-DCF:diskConfig: 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 + OS-EXT-AZ:availability_zone: + type: string + OS-EXT-SRV-ATTR:host: type: - - boolean + - 'null' - 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 + OS-EXT-SRV-ATTR:hostname: type: string - volume_id: - format: uuid + OS-EXT-SRV-ATTR:hypervisor_hostname: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:instance_name: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + OS-EXT-SRV-ATTR:kernel_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:launch_index: type: - integer + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - 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]+$ + OS-EXT-SRV-ATTR:reservation_id: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:root_device_name: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 type: - integer - 'null' + OS-EXT-STS:task_state: + type: + - 'null' - string - connection_info: - maxLength: 16777215 + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 - delete_on_termination: + 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 + 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 + - '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: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + locked: + type: boolean + locked_reason: + type: + - 'null' - string - destination_type: + 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 + progress: + type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: enum: - - local - - volume + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - device_name: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ - type: string - device_type: - maxLength: 255 + pattern: ^[a-zA-Z0-9-]*$ type: string - disk_bus: - maxLength: 255 + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time type: string - guest_format: + user_id: maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - image_id: - format: uuid + required: + - OS-DCF:diskConfig + - OS-EXT-AZ:availability_zone + - OS-EXT-SRV-ATTR:hostname + - 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 + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time type: string - no_device: {} - snapshot_id: + id: format: uuid type: string - source_type: - enum: - - blank - - image - - snapshot - - volume - type: string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN type: string - uuid: + tenant_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9._-]*$ + pattern: ^[a-zA-Z0-9-]*$ type: string - virtual_name: - maxLength: 255 + required: + - created + - id + - links + - status + - tenant_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.95' + min-ver: '2.90' + ServersDetailDetailResponse_296: + additionalProperties: false + properties: + servers: + description: |- + A list of `server` objects. + items: + oneOf: + - additionalProperties: false + properties: + OS-DCF:diskConfig: type: string - volume_id: - format: uuid + OS-EXT-AZ:availability_zone: type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + 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 + - 'null' + OS-EXT-SRV-ATTR:ramdisk_id: + type: + - 'null' - string - volume_type: - maxLength: 255 - minLength: 0 + OS-EXT-SRV-ATTR:reservation_id: 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: + OS-EXT-SRV-ATTR:root_device_name: + type: + - 'null' + - string + OS-EXT-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: + enum: + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - + - 'False' + - 'True' + type: + - 'null' + - string + created: + format: date-time + type: string + description: + type: + - 'null' + - string + fault: additionalProperties: false properties: - fixed_ip: - oneOf: - - format: ipv4 - - format: ipv6 + code: + type: integer + created: + format: date-time type: string - port: - format: uuid - type: - - 'null' - - string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + details: type: string - uuid: - format: uuid + 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: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP + type: string + id: + format: uuid + type: string + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + type: object + - const: '' + type: string + key_name: + type: + - 'null' + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + 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 - 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 + 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 + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: + enum: + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE + type: string + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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 + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time 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. - oneOf: - - items: - format: uuid + user_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - type: array - - 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 + required: + - OS-DCF:diskConfig + - OS-EXT-AZ:availability_zone + - OS-EXT-SRV-ATTR:hostname + - 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 + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time 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. - oneOf: - - items: + id: format: uuid type: string - type: array - - 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 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + required: + - created + - id + - links + - status + - tenant_id + type: object + type: array + servers_links: + items: + additionalProperties: false + properties: + href: + format: uri 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 + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + required: + - servers + type: object + x-openstack: + max-ver: '2.97' + min-ver: '2.96' + ServersDetailDetailResponse_298: + additionalProperties: false + properties: + servers: 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 + A list of `server` objects. + items: + oneOf: + - additionalProperties: false properties: - connection_info: - maxLength: 16777215 + OS-DCF:diskConfig: 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). + 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 + - 'null' + 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-SRV-ATTR:user_data: + format: base64 + maxLength: 65535 + type: + - 'null' + - string + OS-EXT-STS:power_state: enum: - - '0' - - '1' - - 'FALSE' - - false + - + - 0 + - 1 + - 3 + - 4 + - 6 + - 7 + type: + - integer + - 'null' + OS-EXT-STS:task_state: + type: + - 'null' + - string + OS-EXT-STS:vm_state: + type: + - 'null' + - 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 + config_drive: + enum: + - '' + - - 'False' - - NO - - No - - OFF - - ON - - Off - - On - - 'TRUE' - - true - 'True' - - YES - - Yes - - 'false' - - no - - off - - on - - 'true' - - yes type: - - boolean + - 'null' - string - device_name: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ + created: + format: date-time type: string - no_device: {} - snapshot_id: - format: uuid + 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 - virtual_name: - maxLength: 255 + host_status: + enum: + - '' + - DOWN + - MAINTENANCE + - UNKNOWN + - UP type: string - volume_id: + id: format: uuid type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ + image: + oneOf: + - additionalProperties: false + properties: + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + properties: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + type: object + - const: '' + type: string + key_name: type: - - integer + - 'null' - 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]+$ + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + 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: - - 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 + progress: type: - - boolean - - string - destination_type: + - 'null' + - number + security_groups: + items: + additionalProperties: false + properties: + name: + type: string + required: + - name + type: object + type: array + status: enum: - - local - - volume + - ACTIVE + - BUILD + - DELETED + - ERROR + - HARD_REBOOT + - MIGRATING + - PASSWORD + - PAUSED + - REBOOT + - REBUILD + - RESCUE + - RESIZE + - REVERT_RESIZE + - SHELVED + - SHELVED_OFFLOADED + - SHUTOFF + - SOFT_DELETED + - SUSPENDED + - UNKNOWN + - VERIFY_RESIZE type: string - device_name: + tags: + items: + type: string + maxItems: 50 + type: array + tenant_id: maxLength: 255 minLength: 1 - pattern: ^[a-zA-Z0-9._/-]*$ + pattern: ^[a-zA-Z0-9-]*$ type: string - device_type: - maxLength: 255 + trusted_image_certificates: + items: + type: string + type: + - array + - 'null' + updated: + format: date-time type: string - disk_bus: + user_id: maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - guest_format: - maxLength: 255 + required: + - OS-DCF:diskConfig + - OS-EXT-AZ:availability_zone + - OS-EXT-SRV-ATTR:hostname + - 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 + - status + - tags + - tenant_id + - trusted_image_certificates + - updated + - user_id + type: object + - additionalProperties: false + properties: + created: + format: date-time type: string - image_id: + id: format: uuid type: string - no_device: {} - snapshot_id: + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN + type: string + tenant_id: + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + required: + - created + - id + - links + - status + - tenant_id + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.99' + min-ver: '2.98' + ServersDiagnosticsIndexResponse_21: + additionalProperties: true + properties: {} + required: [] + type: object + x-openstack: + max-ver: '2.47' + min-ver: '2.1' + ServersDiagnosticsIndexResponse_248: + additionalProperties: false + properties: + config_drive: + description: |- + Indicates whether or not a config drive was used for this server. + + **New in version 2.48** + type: boolean + 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: + additionalProperties: false + properties: + id: + type: + - integer + - 'null' + time: + type: + - integer + - 'null' + utilisation: + type: + - integer + - 'null' + required: + - id + - time + - utilisation + type: object + type: array + 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: + additionalProperties: false + properties: + errors_count: + type: + - integer + - 'null' + read_bytes: + type: + - integer + - 'null' + read_requests: + type: + - integer + - 'null' + write_bytes: + type: + - integer + - 'null' + write_requests: + type: + - integer + - 'null' + required: + - errors_count + - read_bytes + - read_requests + - write_bytes + - write_requests + type: object + type: array + driver: + description: |- + The driver on which the VM is running. Possible values are: + + * `libvirt` + * `xenapi` + * `vmwareapi` + * `ironic` + + **New in version 2.48** + enum: + - ironic + - libvirt + - vmwareapi + - xenapi + type: string + 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: + - 'null' + - string + hypervisor_os: + description: |- + The hypervisor OS. + + **New in version 2.48** + type: + - 'null' + - string + memory_details: + additionalProperties: false + 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** + properties: + maximum: + type: + - integer + - 'null' + used: + type: + - integer + - 'null' + required: + - maximum + - used + type: object + 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: + additionalProperties: false + properties: + mac_address: + type: + - 'null' + - string + rx_drop: + type: + - integer + - 'null' + rx_errors: + type: + - integer + - 'null' + rx_octets: + type: + - integer + - 'null' + rx_packets: + type: + - integer + - 'null' + rx_rate: + type: + - integer + - 'null' + tx_drop: + type: + - integer + - 'null' + tx_errors: + type: + - integer + - 'null' + tx_octets: + type: + - integer + - 'null' + tx_packets: + type: + - integer + - 'null' + tx_rate: + type: + - integer + - 'null' + required: + - mac_address + - rx_drop + - rx_errors + - rx_octets + - rx_packets + - rx_rate + - tx_drop + - tx_errors + - tx_octets + - tx_packets + - tx_rate + type: object + type: array + num_cpus: + description: |- + The number of vCPUs. + + **New in version 2.48** + type: + - integer + - 'null' + num_disks: + description: |- + The number of disks. + + **New in version 2.48** + type: + - integer + - 'null' + num_nics: + description: |- + The number of vNICs. + + **New in version 2.48** + type: + - integer + - 'null' + 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 + uptime: + description: |- + The amount of time in seconds that the VM has been running. + + **New in version 2.48** + type: + - integer + - 'null' + required: + - config_drive + - cpu_details + - disk_details + - driver + - hypervisor + - hypervisor_os + - memory_details + - nic_details + - num_cpus + - num_disks + - num_nics + - state + - uptime + type: object + x-openstack: + min-ver: '2.48' + ServersIndexResponse_21: + additionalProperties: false + properties: + servers: + description: |- + A list of `server` objects. + items: + additionalProperties: false + properties: + id: + description: |- + The UUID of the server. + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + type: string + required: + - id + - links + - name + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + max-ver: '2.68' + min-ver: '2.1' + ServersIndexResponse_269: + additionalProperties: false + properties: + servers: + description: |- + A list of `server` objects. + items: + oneOf: + - additionalProperties: false + properties: + id: format: uuid type: string - source_type: - enum: - - blank - - image - - snapshot - - volume - type: string - tag: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: type: string - uuid: - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9._-]*$ + required: + - id + - links + - name + type: object + - additionalProperties: false + properties: + id: + format: uuid type: string - virtual_name: - maxLength: 255 + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + status: + const: UNKNOWN type: string - volume_id: - format: uuid + required: + - id + - links + - status + type: object + type: array + servers_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: + - servers + type: object + x-openstack: + min-ver: '2.69' + ServersIpShowResponse: + additionalProperties: false + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 + type: string + version: + enum: + - 4 + - 6 + required: + - addr + - version + type: object + type: array + type: object + ServersIpsIndexResponse: + additionalProperties: false + properties: + addresses: + additionalProperties: false + description: |- + The addresses information for the server. + patternProperties: + ^.+$: + items: + additionalProperties: false + properties: + addr: + oneOf: + - format: ipv4 + - format: ipv6 type: string - volume_size: - maximum: 2147483647 - minimum: 1 - pattern: ^[0-9]+$ - type: - - integer - - string - volume_type: - maxLength: 255 - minLength: 0 - type: - - 'null' - - string + version: + enum: + - 4 + - 6 + required: + - addr + - version 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 + type: object + required: + - addresses + 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 - 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 + type: object + required: + - metadata + type: object + ServersMetadataCreateResponse: + 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 - 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 + - 'null' - 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: object + required: + - metadata + type: object + ServersMetadataIndexResponse: + 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: - - 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 + - string type: object required: - - server + - metadata type: object - x-openstack: - max-ver: '2.93' - min-ver: '2.90' - ServersCreate_294: + ServersMetadataShowResponse: 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 + meta: + additionalProperties: false + description: |- + Metadata key and value pairs. The maximum size for each metadata key and value + pair is 255 bytes. + maxProperties: 1 + minProperties: 1 + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + required: + - meta + type: object + ServersMetadataUpdate: + additionalProperties: false + properties: + meta: + additionalProperties: false + maxProperties: 1 + minProperties: 1 + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + maxLength: 255 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: object + required: + - meta + type: object + ServersMetadataUpdateResponse: + additionalProperties: false + 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 + minProperties: 1 + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + maxLength: 255 + type: + - 'null' + - string + type: object + required: + - meta + 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 - 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: object + required: + - metadata + type: object + ServersMetadataUpdate_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: - - array + - 'null' - 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. - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: + type: object + required: + - metadata + type: object + ServersMigrationShowResponse_223: + additionalProperties: false + properties: + migration: + additionalProperties: false + description: |- + The server migration object. + properties: + created_at: description: |- - Schedule the server by using a custom filter in JSON format. - For example: + 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) ``` - "query": "[\">=\",\"$free_ram_mb\",1024]" + CCYY-MM-DDThh:mm:ss±hh:mm ``` - It is available when `JsonFilter` is available on cloud side. + 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: - - object + - 'null' - string - same_host: + dest_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 + The target host for a migration. type: - - array + - 'null' - 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: + dest_node: 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: + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: 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: + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 + type: + - integer + - 'null' + disk_remaining_bytes: 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 + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 type: - - array - - string - different_host: + - integer + - 'null' + disk_total_bytes: 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: + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + id: 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. - oneOf: - - items: - format: uuid - type: string - type: array - - format: uuid - type: string - query: + The ID of the server migration. + type: integer + memory_processed_bytes: 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. + The amount of memory, in bytes, that has been processed during the migration. + minimum: 1 type: - - object - - string - same_host: + - integer + - 'null' + memory_remaining_bytes: 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 + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 type: - - array - - string - target_cell: + - integer + - 'null' + memory_total_bytes: 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: + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + server_uuid: 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 + The UUID of the server. + format: uuid type: string - accessIPv4: + source_compute: description: |- - IPv4 address that should be used to access this server. - format: ipv4 - type: string - accessIPv6: + The source compute for a migration. + type: + - 'null' + - string + source_node: description: |- - IPv6 address that should be used to access this server. - format: ipv6 - type: string - adminPass: + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + status: description: |- - The administrative password of the server. If you omit this parameter, the operation - generates a new password. + The current status of the migration. type: string - availability_zone: + updated_at: 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 + 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 - 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: + required: + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes + - id + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - server_uuid + - source_compute + - source_node + - status + - updated_at + type: object + required: + - migration + type: object + x-openstack: + max-ver: '2.58' + min-ver: '2.23' + ServersMigrationShowResponse_259: + additionalProperties: false + properties: + migration: + additionalProperties: false + description: |- + The server migration object. + properties: + created_at: 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"}] - > ``` + 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) - 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. + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - 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: + 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: |- - 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 + The target compute for a migration. type: - - boolean + - 'null' - string - description: + dest_host: 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ﬓ-ﬗיִ-זּטּ-לּמּנּ-סּףּ-פּצּ-﯂ﯓ-ﶏﶒ-ﷇ﷏ﷰ-︙︠-﹒﹔-﹦﹨-﹫ﹰ-ﹴﹶ-ﻼ！-ﾾￂ-ￇￊ-ￏￒ-ￗￚ-ￜ￠-￦￨-￮-�]*$ + The target host for a migration. type: - 'null' - string - flavorRef: + dest_node: description: |- - The flavor reference, as an ID (including a UUID) or full URL, - for the flavor for your server instance. - minLength: 1 + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: + description: |- + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 + type: + - integer + - 'null' + disk_remaining_bytes: + description: |- + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + disk_total_bytes: + description: |- + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + 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. + minimum: 1 + type: + - integer + - 'null' + memory_remaining_bytes: + description: |- + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + memory_total_bytes: + description: |- + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 type: - integer + - 'null' + server_uuid: + description: |- + The UUID of the server. + format: uuid + type: string + source_compute: + description: |- + The source compute for a migration. + type: + - 'null' - string - host: + source_node: 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-._]*$ + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + status: + description: |- + The current status of the migration. type: string - hostname: + updated_at: 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. + 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) - Note + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - This information is published via the metadata service and requires - application such as `cloud-init` to propagate it through to the - instance. + 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 + uuid: + description: |- + The UUID of the migration. - **New in version 2.90** - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + **New in version 2.59** + format: uuid type: string - hypervisor_hostname: + required: + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes + - id + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - server_uuid + - source_compute + - source_node + - status + - updated_at + - uuid + type: object + required: + - migration + type: object + x-openstack: + max-ver: '2.79' + min-ver: '2.59' + ServersMigrationShowResponse_280: + additionalProperties: false + properties: + migration: + additionalProperties: false + description: |- + The server migration object. + properties: + created_at: 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. + 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) - **New in version 2.74** - maxLength: 255 - minLength: 1 - pattern: ^[a-zA-Z0-9-._]*$ + ``` + 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 - imageRef: + dest_compute: 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: + The target compute for a migration. + type: + - 'null' + - string + dest_host: 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 + The target host for a migration. + type: + - 'null' + - string + dest_node: + description: |- + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: + description: |- + The amount of disk, in bytes, that has been processed during the migration. minimum: 1 - pattern: ^[0-9]*$ type: - integer - - string - metadata: - additionalProperties: false + - 'null' + disk_remaining_bytes: 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 + The amount of disk, in bytes, that still needs to be migrated. minimum: 1 - pattern: ^[0-9]*$ type: - integer - - string - name: + - 'null' + disk_total_bytes: 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 + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + 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. + minimum: 1 + type: + - integer + - 'null' + memory_remaining_bytes: + description: |- + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + memory_total_bytes: + description: |- + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + 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** maxLength: 255 minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - networks: + server_uuid: 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: + The UUID of the server. + format: uuid + type: string + source_compute: + description: |- + The source compute for a migration. + type: + - 'null' + - string + source_node: 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 + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. type: - - boolean + - 'null' - string - security_groups: + status: 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: + The current status of the migration. + type: string + updated_at: description: |- - A list of tags. Tags have the following restrictions: + 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) - * 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. + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - **New in version 2.52** - items: - maxLength: 60 - minLength: 1 - pattern: ^[^,/]*$ - type: string - maxItems: 50 - type: array - trusted_image_certificates: + 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: |- - 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. + The ID of the user which initiated the server migration. The value + may be `null` for older migration records. - **New in version 2.63** - items: - minLength: 1 - type: string - maxItems: 50 - minItems: 1 - type: - - array - - 'null' - uniqueItems: true - user_data: + **New in version 2.80** + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + uuid: description: |- - Configuration information or scripts to use upon launch. - Must be Base64 encoded. Restricted to 65535 bytes. - - Note + The UUID of the migration. - 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 + **New in version 2.59** + format: uuid type: string required: - - flavorRef - - name - - networks + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes + - id + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - project_id + - server_uuid + - source_compute + - source_node + - status + - updated_at + - user_id + - uuid type: object required: - - server + - migration 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. + min-ver: '2.80' + ServersMigrationsAction_Force_Complete_222: + additionalProperties: false + description: |- + Force an in-progress live migration for a given server to complete. - **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. + Specify the `force_complete` action in the request body. - **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. + Policy defaults enable only users with the administrative role to perform + this operation. Cloud providers can change these permissions through the + `policy.yaml` file. - **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. + **Preconditions** - **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: + The server OS-EXT-STS:vm_state value must be `active` and the server + OS-EXT-STS:task_state value must be `migrating`. - ``` - 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. + If the server is locked, you must have administrator privileges to force the + completion of the server migration. - The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + The migration status must be `running`. - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + **Asynchronous Postconditions** - For example, `2015-08-27T09:49:58-05:00`. + After you make this request, you typically must keep polling the server status + to determine whether the request succeeded. - 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. + **Troubleshooting** - The date and time stamp format is [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601): + 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). - ``` - CCYY-MM-DDThh:mm:ss±hh:mm - ``` + Normal response codes: 202 - 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: + 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' + ServersMigrationsIndexResponse_223: + additionalProperties: false + properties: + migrations: + description: |- + The list of server migration objects. + items: + additionalProperties: false + 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) @@ -45946,337 +94613,95 @@ components: 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: + dest_compute: 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' + The target compute for a migration. 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: + dest_host: 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: + The target host for a migration. + type: + - 'null' + - string + dest_node: 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 + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: 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: + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 + type: + - integer + - 'null' + disk_remaining_bytes: description: |- - The server name. - type: string - os-extended-volumes:volumes_attached: + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + disk_total_bytes: description: |- - The attached volumes, if any. - items: - type: object - type: array - progress: + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + id: 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`. + The ID of the server migration. type: integer - security_groups: + memory_processed_bytes: 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: + The amount of memory, in bytes, that has been processed during the migration. + minimum: 1 + type: + - integer + - 'null' + memory_remaining_bytes: description: |- - The server status. - readOnly: true - type: string - tags: + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + memory_total_bytes: 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: + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 + type: + - integer + - 'null' + server_uuid: description: |- - The UUID of the tenant in a multi-tenancy cloud. + The UUID of the server. format: uuid type: string - trusted_image_certificates: + source_compute: 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 + The source compute for a migration. type: - - array - 'null' - x-openstack: - min-ver: '2.63' - updated: + - string + source_node: + description: |- + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - 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) @@ -46289,568 +94714,687 @@ components: 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 + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes - 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 + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - server_uuid + - source_compute + - source_node + - status + - updated_at type: object type: array + required: + - migrations type: object - ServersDiagnosticsListResponse: + x-openstack: + max-ver: '2.58' + min-ver: '2.23' + ServersMigrationsIndexResponse_259: additionalProperties: false properties: - config_drive: - description: |- - Indicates whether or not a config drive was used for this server. - - **New in version 2.48** - type: boolean - cpu_details: + migrations: 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** + The list of server migration objects. items: additionalProperties: false properties: - id: + 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: - - integer - 'null' - time: + - string + dest_host: + description: |- + The target host for a migration. type: - - integer - 'null' - utilisation: + - string + dest_node: + description: |- + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - string + disk_processed_bytes: + description: |- + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 type: - integer - 'null' - required: - - id - - time - - utilisation - type: object - type: array - 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: - additionalProperties: false - properties: - errors_count: + disk_remaining_bytes: + description: |- + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 type: - integer - 'null' - read_bytes: + disk_total_bytes: + description: |- + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 type: - integer - 'null' - read_requests: + 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. + minimum: 1 type: - integer - 'null' - write_bytes: + memory_remaining_bytes: + description: |- + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 type: - integer - 'null' - write_requests: + memory_total_bytes: + description: |- + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 type: - integer - 'null' - required: - - errors_count - - read_bytes - - read_requests - - write_bytes - - write_requests - type: object - type: array - driver: - description: |- - The driver on which the VM is running. Possible values are: - - * `libvirt` - * `xenapi` - * `vmwareapi` - * `ironic` - - **New in version 2.48** - enum: - - ironic - - libvirt - - vmwareapi - - xenapi - type: string - 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: - - 'null' - - string - hypervisor_os: - description: |- - The hypervisor OS. + server_uuid: + description: |- + The UUID of the server. + format: uuid + type: string + source_compute: + description: |- + The source compute for a migration. + type: + - 'null' + - string + source_node: + description: |- + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. + type: + - 'null' + - 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) - **New in version 2.48** - type: - - 'null' - - string - memory_details: - additionalProperties: false - description: |- - The dictionary with information about VM memory usage. - Following fields are presented in the dictionary: + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - * `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) + 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 + uuid: + description: |- + The UUID of the migration. - **New in version 2.48** - properties: - maximum: - type: - - integer - - 'null' - used: - type: - - integer - - 'null' - required: - - maximum - - used - type: object - nic_details: + **New in version 2.59** + format: uuid + type: string + required: + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes + - id + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - server_uuid + - source_compute + - source_node + - status + - updated_at + - uuid + type: object + type: array + required: + - migrations + type: object + x-openstack: + max-ver: '2.79' + min-ver: '2.59' + ServersMigrationsIndexResponse_280: + additionalProperties: false + properties: + migrations: 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** + The list of server migration objects. items: additionalProperties: false properties: - mac_address: + 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: - 'null' - string - rx_drop: + dest_host: + description: |- + The target host for a migration. type: - - integer - 'null' - rx_errors: + - string + dest_node: + description: |- + The target node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. type: - - integer - 'null' - rx_octets: + - string + disk_processed_bytes: + description: |- + The amount of disk, in bytes, that has been processed during the migration. + minimum: 1 type: - integer - 'null' - rx_packets: + disk_remaining_bytes: + description: |- + The amount of disk, in bytes, that still needs to be migrated. + minimum: 1 type: - integer - 'null' - rx_rate: + disk_total_bytes: + description: |- + The total amount of disk, in bytes, that needs to be migrated. + minimum: 1 type: - integer - 'null' - tx_drop: + 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. + minimum: 1 type: - integer - 'null' - tx_errors: + memory_remaining_bytes: + description: |- + The amount of memory, in bytes, that still needs to be migrated. + minimum: 1 type: - integer - 'null' - tx_octets: + memory_total_bytes: + description: |- + The total amount of memory, in bytes, that needs to be migrated. + minimum: 1 type: - integer - 'null' - tx_packets: + 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** + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: string + server_uuid: + description: |- + The UUID of the server. + format: uuid + type: string + source_compute: + description: |- + The source compute for a migration. type: - - integer - 'null' - tx_rate: + - string + source_node: + description: |- + The source node for a migration. This will be `null` if pre-migration + checks fail due to e.g. insufficient resources. type: - - integer - 'null' - required: - - mac_address - - rx_drop - - rx_errors - - rx_octets - - rx_packets - - rx_rate - - tx_drop - - tx_errors - - tx_octets - - tx_packets - - tx_rate - type: object - type: array - num_cpus: - description: |- - The number of vCPUs. - - **New in version 2.48** - type: - - integer - - 'null' - num_disks: - description: |- - The number of disks. - - **New in version 2.48** - type: - - integer - - 'null' - num_nics: - description: |- - The number of vNICs. - - **New in version 2.48** - type: - - integer - - 'null' - state: - description: |- - A string enum denoting the current state of the VM. Possible values are: - - * `pending` - * `running` - * `paused` - * `shutdown` - * `crashed` - * `suspended` + - 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) - **New in version 2.48** - enum: - - crashed - - paused - - pending - - running - - shutdown - - suspended - type: string - uptime: - description: |- - The amount of time in seconds that the VM has been running. + ``` + CCYY-MM-DDThh:mm:ss±hh:mm + ``` - **New in version 2.48** - type: - - integer - - 'null' - required: - - config_drive - - cpu_details - - disk_details - - driver - - hypervisor - - hypervisor_os - - memory_details - - nic_details - - num_cpus - - num_disks - - num_nics - - state - - uptime - 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: + 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 UUID of the server. - format: uuid + The ID of the user which initiated the server migration. The value + may be `null` for older migration records. + + **New in version 2.80** + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: string - name: + uuid: description: |- - The server name. + The UUID of the migration. + + **New in version 2.59** format: uuid type: string required: + - created_at + - dest_compute + - dest_host + - dest_node + - disk_processed_bytes + - disk_remaining_bytes + - disk_total_bytes - 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 + - memory_processed_bytes + - memory_remaining_bytes + - memory_total_bytes + - project_id + - server_uuid + - source_compute + - source_node + - status + - updated_at + - user_id + - uuid type: object type: array + required: + - migrations type: object - ServersMetadataCreate: + x-openstack: + min-ver: '2.80' + ServersOs_Instance_ActionShowResponse_21: additionalProperties: false properties: - metadata: + instanceAction: 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 + The instance action object. + properties: + action: + description: |- + The name of the action. 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 + 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: + additionalProperties: false + properties: + event: + type: string + finish_time: + format: date-time + type: + - 'null' + - string + result: + type: + - 'null' + - 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: + type: + - 'null' + - string + required: + - event + - finish_time + - result + - start_time + type: object + type: array + instance_uuid: + description: |- + The UUID of the server. + format: uuid 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}$: + 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. maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + request_id: + description: |- + The request id generated when execute the API of this action. 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 + start_time: + format: date-time type: string - type: object - type: object - ServersMetadataUpdate: - additionalProperties: false - properties: - meta: - additionalProperties: false - maxProperties: 1 - minProperties: 1 - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + user_id: + description: |- + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. maxLength: 255 - type: string + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + required: + - action + - instance_uuid + - message + - project_id + - request_id + - start_time + - user_id type: object required: - - meta + - instanceAction type: object - ServersMetadataUpdateResponse: + x-openstack: + max-ver: '2.50' + min-ver: '2.1' + ServersOs_Instance_ActionShowResponse_251: additionalProperties: false properties: - meta: + instanceAction: additionalProperties: false description: |- - The object of detailed key metadata items. - maxProperties: 1 - minProperties: 1 - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + 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: + additionalProperties: false + properties: + event: + type: string + finish_time: + format: date-time + type: + - 'null' + - string + result: + type: + - 'null' + - 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: + type: + - 'null' + - string + required: + - event + - finish_time + - result + - start_time + type: object + type: array + instance_uuid: + description: |- + The UUID of the server. + format: uuid + 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. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + request_id: + description: |- + The request id generated when execute the API of this action. + type: string + start_time: + format: date-time + type: string + user_id: + description: |- + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: - 'null' - string + required: + - action + - events + - instance_uuid + - message + - project_id + - request_id + - start_time + - user_id type: object required: - - meta + - instanceAction type: object - ServersMetadataUpdate_All: + x-openstack: + max-ver: '2.57' + min-ver: '2.51' + ServersOs_Instance_ActionShowResponse_258: additionalProperties: false properties: - metadata: + instanceAction: 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 + The instance action object. + properties: + action: + description: |- + The name of the action. 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}$: + 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: + additionalProperties: false + properties: + event: + type: string + finish_time: + format: date-time + type: + - 'null' + - string + result: + type: + - 'null' + - 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: + type: + - 'null' + - string + required: + - event + - finish_time + - result + - start_time + type: object + type: array + instance_uuid: + description: |- + The UUID of the server. + format: uuid + 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. maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + request_id: + description: |- + The request id generated when execute the API of this action. type: string - type: object - required: - - metadata - type: object - ServersMigrationShowResponse: - properties: - migration: - description: |- - The server migration object. - properties: - created_at: + start_time: + format: date-time + type: string + updated_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) + 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 @@ -46859,82 +95403,137 @@ components: 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: string - dest_compute: - description: |- - The target compute for a migration. - type: string - dest_host: + type: + - 'null' + - string + user_id: description: |- - The target host for a migration. - type: string - dest_node: + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + required: + - action + - events + - instance_uuid + - message + - project_id + - request_id + - start_time + - updated_at + - user_id + type: object + required: + - instanceAction + type: object + x-openstack: + max-ver: '2.61' + min-ver: '2.58' + ServersOs_Instance_ActionShowResponse_262: + additionalProperties: false + properties: + instanceAction: + additionalProperties: false + description: |- + The instance action object. + properties: + action: description: |- - The target node for a migration. This will be `null` if pre-migration - checks fail due to e.g. insufficient resources. + The name of the action. 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: + events: description: |- - The amount of memory, in bytes, that has been processed during the migration. - type: integer - memory_remaining_bytes: + 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: + additionalProperties: false + properties: + event: + type: string + finish_time: + format: date-time + type: + - 'null' + - string + host: + type: string + hostId: + type: string + result: + type: + - 'null' + - 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: + type: + - 'null' + - string + required: + - event + - finish_time + - hostId + - result + - start_time + type: object + type: array + instance_uuid: description: |- - The amount of memory, in bytes, that still needs to be migrated. - type: integer - memory_total_bytes: + The UUID of the server. + format: uuid + type: string + message: description: |- - The total amount of memory, in bytes, that needs to be migrated. - type: integer + The related error message for when an action fails. + type: + - 'null' + - string 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** + The ID of the project which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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: + request_id: description: |- - The source node for a migration. This will be `null` if pre-migration - checks fail due to e.g. insufficient resources. + The request id generated when execute the API of this action. type: string - status: - description: |- - The current status of the migration. + start_time: + format: date-time 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) + 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 @@ -46943,212 +95542,44 @@ components: 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: string + type: + - 'null' + - 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** + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ 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' + required: + - action + - events + - instance_uuid + - message + - project_id + - request_id + - start_time + - updated_at + - user_id 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) + - instanceAction 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. This will be `null` if pre-migration - checks fail due to e.g. insufficient resources. - 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. This will be `null` if pre-migration - checks fail due to e.g. insufficient resources. - 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: + max-ver: '2.83' + min-ver: '2.62' + ServersOs_Instance_ActionShowResponse_284: + additionalProperties: false properties: instanceAction: + additionalProperties: false description: |- The instance action object. properties: @@ -47166,46 +95597,27 @@ components: **New in version 2.51** items: - description: Event + additionalProperties: false 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 + type: + - 'null' + - 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' + type: string 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 + result: + type: + - 'null' + - string start_time: description: |- The date and time when the action was started. The date and time @@ -47221,22 +95633,21 @@ components: 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 + - finish_time + - hostId + - result + - start_time type: object type: array instance_uuid: description: |- The UUID of the server. + format: uuid type: string message: description: |- @@ -47248,23 +95659,17 @@ components: description: |- The ID of the project which initiated the server action. This can be `null` for `nova-manage`-initiated actions. - type: string + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - 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: @@ -47286,32 +95691,40 @@ components: 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. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: - 'null' - string required: - action - events + - instance_uuid + - message - project_id - request_id + - start_time + - updated_at - user_id type: object required: - instanceAction type: object - ServersOs_Instance_ActionsListResponse: + x-openstack: + min-ver: '2.84' + ServersOs_Instance_ActionsIndexResponse_21: + additionalProperties: false properties: instanceActions: description: |- List of the actions for the given instance in descending order of creation. items: - description: The instance action object. + additionalProperties: false properties: action: description: |- @@ -47320,6 +95733,7 @@ components: instance_uuid: description: |- The UUID of the server. + format: uuid type: string message: description: |- @@ -47331,7 +95745,90 @@ components: description: |- The ID of the project which initiated the server action. This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - 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 + user_id: + description: |- + The ID of the user which initiated the server action. + This can be `null` for `nova-manage`-initiated actions. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string + required: + - action + - instance_uuid + - message + - project_id + - request_id + - start_time + - user_id + type: object + type: array + required: + - instanceActions + type: object + x-openstack: + max-ver: '2.57' + min-ver: '2.1' + ServersOs_Instance_ActionsIndexResponse_258: + additionalProperties: false + properties: + instanceActions: + description: |- + List of the actions for the given instance in descending order of creation. + items: + additionalProperties: false + properties: + action: + description: |- + The name of the action. + type: string + instance_uuid: + description: |- + The UUID of the server. + format: uuid 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. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ + type: + - 'null' + - string request_id: description: |- The request id generated when execute the API of this action. @@ -47369,55 +95866,67 @@ components: 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. + maxLength: 255 + minLength: 1 + pattern: ^[a-zA-Z0-9-]*$ type: - 'null' - string required: - action - - events + - instance_uuid + - message - project_id - request_id + - start_time + - updated_at - 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) + Links pertaining to the instance action. + 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.40** + **New in version 2.58** 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. + additionalProperties: false properties: href: format: uri type: string rel: - type: string + const: next + required: + - href + - rel type: object + maxItems: 1 + minItems: 1 type: array required: - instanceActions type: object + x-openstack: + max-ver: '2.57' + min-ver: '2.58' ServersOs_InterfaceCreateRequest: oneOf: - $ref: '#/components/schemas/ServersOs_InterfaceCreate_20' - $ref: '#/components/schemas/ServersOs_InterfaceCreate_249' x-openstack: discriminator: microversion - ServersOs_InterfaceCreateResponse: + ServersOs_InterfaceCreateResponse_21: + additionalProperties: false properties: interfaceAttachment: + additionalProperties: false description: |- The interface attachment. properties: @@ -47425,25 +95934,88 @@ components: description: |- Fixed IP addresses with subnet IDs. items: + additionalProperties: false properties: ip_address: - description: |- - The IP address. - oneOf: + anyOf: - format: ipv4 - format: ipv6 type: string subnet_id: - description: |- - The UUID of the subnet. format: uuid type: string + required: + - ip_address + - subnet_id type: object - type: array + type: + - array + - 'null' + mac_addr: + description: |- + The MAC address. + format: mac-address + 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 + required: + - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + type: object + required: + - interfaceAttachment + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.1' + ServersOs_InterfaceCreateResponse_270: + additionalProperties: false + properties: + interfaceAttachment: + additionalProperties: false + description: |- + The interface attachment. + properties: + fixed_ips: + description: |- + Fixed IP addresses with subnet IDs. + items: + additionalProperties: false + properties: + ip_address: + anyOf: + - format: ipv4 + - format: ipv6 + type: string + subnet_id: + format: uuid + type: string + required: + - ip_address + - subnet_id + type: object + type: + - array + - 'null' mac_addr: description: |- The MAC address. - pattern: ^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$ + format: mac-address type: string net_id: description: |- @@ -47467,12 +96039,19 @@ components: type: - 'null' - string - x-openstack: - min-ver: '2.70' required: - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + - tag type: object + required: + - interfaceAttachment type: object + x-openstack: + min-ver: '2.70' ServersOs_InterfaceCreate_20: additionalProperties: false properties: @@ -47582,40 +96161,104 @@ components: type: object type: object x-openstack: - max-ver: '2.48' - min-ver: '2.49' - ServersOs_InterfaceListResponse: + min-ver: '2.49' + ServersOs_InterfaceIndexResponse_21: + additionalProperties: false + properties: + interfaceAttachments: + description: |- + List of the interface attachments. + items: + additionalProperties: false + properties: + fixed_ips: + description: |- + Fixed IP addresses with subnet IDs. + items: + additionalProperties: false + properties: + ip_address: + anyOf: + - format: ipv4 + - format: ipv6 + type: string + subnet_id: + format: uuid + type: string + required: + - ip_address + - subnet_id + type: object + type: + - array + - 'null' + mac_addr: + description: |- + The MAC address. + format: mac-address + 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 + required: + - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + type: object + type: array + required: + - interfaceAttachments + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.1' + ServersOs_InterfaceIndexResponse_270: + additionalProperties: false properties: interfaceAttachments: description: |- List of the interface attachments. items: - description: |- - The interface attachment. + additionalProperties: false properties: fixed_ips: description: |- Fixed IP addresses with subnet IDs. items: + additionalProperties: false properties: ip_address: - description: |- - The IP address. - oneOf: + anyOf: - format: ipv4 - format: ipv6 type: string subnet_id: - description: |- - The UUID of the subnet. format: uuid type: string + required: + - ip_address + - subnet_id type: object - type: array + type: + - array + - 'null' mac_addr: description: |- The MAC address. - pattern: ^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$ + format: mac-address type: string net_id: description: |- @@ -47639,16 +96282,25 @@ components: type: - 'null' - string - x-openstack: - min-ver: '2.70' required: - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + - tag type: object type: array + required: + - interfaceAttachments type: object - ServersOs_InterfaceShowResponse: + x-openstack: + min-ver: '2.70' + ServersOs_InterfaceShowResponse_21: + additionalProperties: false properties: interfaceAttachment: + additionalProperties: false description: |- The interface attachment. properties: @@ -47656,25 +96308,88 @@ components: description: |- Fixed IP addresses with subnet IDs. items: + additionalProperties: false properties: ip_address: - description: |- - The IP address. - oneOf: + anyOf: - format: ipv4 - format: ipv6 type: string subnet_id: - description: |- - The UUID of the subnet. format: uuid type: string + required: + - ip_address + - subnet_id type: object - type: array + type: + - array + - 'null' + mac_addr: + description: |- + The MAC address. + format: mac-address + 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 + required: + - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + type: object + required: + - interfaceAttachment + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.1' + ServersOs_InterfaceShowResponse_270: + additionalProperties: false + properties: + interfaceAttachment: + additionalProperties: false + description: |- + The interface attachment. + properties: + fixed_ips: + description: |- + Fixed IP addresses with subnet IDs. + items: + additionalProperties: false + properties: + ip_address: + anyOf: + - format: ipv4 + - format: ipv6 + type: string + subnet_id: + format: uuid + type: string + required: + - ip_address + - subnet_id + type: object + type: + - array + - 'null' mac_addr: description: |- The MAC address. - pattern: ^([0-9a-fA-F]{2})(:[0-9a-fA-F]{2}){5}$ + format: mac-address type: string net_id: description: |- @@ -47698,13 +96413,20 @@ components: type: - 'null' - string - x-openstack: - min-ver: '2.70' required: - fixed_ips + - mac_addr + - net_id + - port_id + - port_state + - tag type: object + required: + - interfaceAttachment type: object - ServersOs_Security_GroupsListResponse: + x-openstack: + min-ver: '2.70' + ServersOs_Security_GroupsIndexResponse: additionalProperties: false properties: security_groups: @@ -47712,8 +96434,6 @@ components: One or more security groups objects. items: additionalProperties: false - description: |- - Specify the `security_group` action in the request body. properties: description: description: |- @@ -47735,29 +96455,20 @@ components: 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. + The UUID of the tenant in a multi-tenancy cloud. maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9-]*$ @@ -47765,36 +96476,24 @@ components: 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 @@ -47811,7 +96510,7 @@ components: type: array tenant_id: description: |- - The UUID of the tenant that owns this security group. + The UUID of the tenant in a multi-tenancy cloud. maxLength: 255 minLength: 1 pattern: ^[a-zA-Z0-9-]*$ @@ -47827,62 +96526,165 @@ components: required: - security_groups type: object - ServersOs_Server_PasswordListResponse: + ServersOs_Server_PasswordIndexResponse: + additionalProperties: false properties: password: description: |- The password returned from metadata server. - format: password type: string + required: + - password type: object - ServersOs_Virtual_InterfacesListResponse: {} - ServersOs_Volume_AttachmentShowResponse: + ServersOs_Volume_AttachmentShowResponse_20: + additionalProperties: false properties: volumeAttachment: + additionalProperties: false description: |- A dictionary representation of a volume attachment containing the fields `device`, `id`, `serverId` and `volumeId`. properties: - attachment_id: + device: description: |- - The UUID of the associated volume attachment in Cinder. - - **New in version 2.89** + Name of the device in the attachment object, such as, `/dev/vdb`. + 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 attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' - bdm_uuid: + serverId: description: |- - The UUID of the block device mapping record in Nova for the attachment. + The UUID of the server. + format: uuid + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - id + - serverId + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.0' + ServersOs_Volume_AttachmentShowResponse_270: + additionalProperties: false + properties: + volumeAttachment: + additionalProperties: false + description: |- + A dictionary representation of a volume attachment containing the fields + `device`, `id`, `serverId` and `volumeId`. + properties: + device: + description: |- + Name of the device in the attachment object, such as, `/dev/vdb`. + 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 attached volume. + format: uuid + type: string + 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.89** + **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' + required: + - id + - serverId + - tag + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + max-ver: '2.78' + min-ver: '2.70' + ServersOs_Volume_AttachmentShowResponse_279: + additionalProperties: false + properties: + volumeAttachment: + additionalProperties: false + description: |- + A dictionary representation of a volume attachment containing the fields + `device`, `id`, `serverId` and `volumeId`. + properties: 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' + 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`. - type: string + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ + type: + - 'null' + - string id: description: |- - The volume ID of the attachment. - - **Available until version 2.88** + The UUID of the attached volume. format: uuid type: string - x-openstack: - max-ver: '2.88' serverId: description: |- The UUID of the server. @@ -47893,34 +96695,35 @@ components: 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' + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string volumeId: description: |- The UUID of the attached volume. format: uuid type: string required: - - device + - delete_on_termination - id - serverId + - tag - 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: + max-ver: '2.88' + min-ver: '2.79' + ServersOs_Volume_AttachmentShowResponse_289: + additionalProperties: false properties: volumeAttachment: + additionalProperties: false description: |- A dictionary representation of a volume attachment containing the fields `device`, `id`, `serverId` and `volumeId`. @@ -47932,8 +96735,6 @@ components: **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. @@ -47941,48 +96742,133 @@ components: **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' + 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`. + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ + type: + - 'null' + - string + serverId: + description: |- + The UUID of the server. + format: uuid type: string - id: + tag: description: |- - The volume ID of the attachment. + The device tag applied to the volume block device or `null`. - **Available until version 2.88** + **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - attachment_id + - bdm_uuid + - delete_on_termination + - serverId + - tag + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + min-ver: '2.89' + 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: + properties: + attachment_id: + description: The UUID of the associated volume attachment in + Cinder. + 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. + 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. + 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 format: uuid type: string x-openstack: max-ver: '2.88' serverId: - description: |- - The UUID of the server. + 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** + description: The device tag applied to the volume block device or + null. type: - 'null' - string x-openstack: min-ver: '2.70' volumeId: - description: |- - The UUID of the attached volume. + description: The UUID of the attached volume. format: uuid type: string required: @@ -48104,7 +96990,6 @@ components: - volumeAttachment type: object x-openstack: - max-ver: '2.84' min-ver: '2.85' ServersOs_Volume_AttachmentsCreateRequest: oneOf: @@ -48113,53 +96998,156 @@ components: - $ref: '#/components/schemas/ServersOs_Volume_AttachmentsCreate_279' x-openstack: discriminator: microversion - ServersOs_Volume_AttachmentsCreateResponse: + ServersOs_Volume_AttachmentsCreateResponse_20: + additionalProperties: false properties: volumeAttachment: + additionalProperties: false description: |- A dictionary representation of a volume attachment containing the fields `device`, `id`, `serverId` and `volumeId`. properties: - attachment_id: + device: description: |- - The UUID of the associated volume attachment in Cinder. - - **New in version 2.89** + Name of the device such as, `/dev/vdb`. + 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 attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' - bdm_uuid: + serverId: description: |- - The UUID of the block device mapping record in Nova for the attachment. + The UUID of the server. + format: uuid + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - id + - serverId + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.0' + ServersOs_Volume_AttachmentsCreateResponse_270: + additionalProperties: false + properties: + volumeAttachment: + additionalProperties: false + description: |- + A dictionary representation of a volume attachment containing the fields + `device`, `id`, `serverId` and `volumeId`. + properties: + device: + description: |- + Name of the device such as, `/dev/vdb`. + 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 attached volume. + format: uuid + type: string + 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.89** + **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' + required: + - device + - id + - serverId + - tag + - volumeId + type: object + required: + - volumeAttachment + type: object + x-openstack: + max-ver: '2.78' + min-ver: '2.70' + ServersOs_Volume_AttachmentsCreateResponse_279: + additionalProperties: false + properties: + volumeAttachment: + additionalProperties: false + description: |- + A dictionary representation of a volume attachment containing the fields + `device`, `id`, `serverId` and `volumeId`. + properties: 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' + 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`. - type: string + Name of the device such as, `/dev/vdb`. + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ + type: + - 'null' + - string id: description: |- - The volume ID of the attachment. - - **Available until version 2.88** + The UUID of the attached volume. format: uuid type: string - x-openstack: - max-ver: '2.88' serverId: description: |- The UUID of the server. @@ -48170,25 +97158,31 @@ components: 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' + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string volumeId: description: |- The UUID of the attached volume. format: uuid type: string required: + - delete_on_termination - device - id - serverId + - tag - volumeId type: object required: - volumeAttachment type: object + x-openstack: + max-ver: '2.100' + min-ver: '2.79' ServersOs_Volume_AttachmentsCreate_20: additionalProperties: false properties: @@ -48355,58 +97349,158 @@ components: - volumeAttachment type: object x-openstack: - max-ver: '2.48' min-ver: '2.79' - ServersOs_Volume_AttachmentsListResponse: + ServersOs_Volume_AttachmentsIndexResponse_20: + additionalProperties: false 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`. + additionalProperties: false properties: - attachment_id: + device: description: |- - The UUID of the associated volume attachment in Cinder. - - **New in version 2.89** + Name of the device in the attachment object, such as, `/dev/vdb`. + 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 attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' - bdm_uuid: + serverId: description: |- - The UUID of the block device mapping record in Nova for the attachment. + The UUID of the server. + format: uuid + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - id + - serverId + - volumeId + type: object + type: array + required: + - volumeAttachments + type: object + x-openstack: + max-ver: '2.69' + min-ver: '2.0' + ServersOs_Volume_AttachmentsIndexResponse_270: + additionalProperties: false + properties: + volumeAttachments: + description: |- + The list of volume attachments. + items: + additionalProperties: false + properties: + device: + description: |- + Name of the device in the attachment object, such as, `/dev/vdb`. + 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 attached volume. + format: uuid + type: string + 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.89** + **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. format: uuid type: string - x-openstack: - min-ver: '2.89' + required: + - id + - serverId + - tag + - volumeId + type: object + type: array + required: + - volumeAttachments + type: object + x-openstack: + max-ver: '2.78' + min-ver: '2.70' + ServersOs_Volume_AttachmentsIndexResponse_279: + additionalProperties: false + properties: + volumeAttachments: + description: |- + The list of volume attachments. + items: + additionalProperties: false + properties: 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' + 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`. - type: string + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ + type: + - 'null' + - string id: description: |- - The volume ID of the attachment. - - **Available until version 2.88** + The UUID of the attached volume. format: uuid type: string - x-openstack: - max-ver: '2.88' serverId: description: |- The UUID of the server. @@ -48417,26 +97511,128 @@ components: The device tag applied to the volume block device or `null`. **New in version 2.70** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string + volumeId: + description: |- + The UUID of the attached volume. + format: uuid + type: string + required: + - delete_on_termination + - id + - serverId + - tag + - volumeId + type: object + type: array + required: + - volumeAttachments + type: object + x-openstack: + max-ver: '2.88' + min-ver: '2.79' + ServersOs_Volume_AttachmentsIndexResponse_289: + additionalProperties: false + properties: + volumeAttachments: + description: |- + The list of volume attachments. + items: + additionalProperties: false + properties: + attachment_id: + description: |- + The UUID of the associated volume attachment in Cinder. + + **New in version 2.89** + format: uuid + type: string + 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 + delete_on_termination: + description: |- + A flag indicating if the attached volume will be deleted when the server is + deleted. + + **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 in the attachment object, such as, `/dev/vdb`. + pattern: (^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$ type: - 'null' - string - x-openstack: - min-ver: '2.70' + 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** + oneOf: + - type: 'null' + - maxLength: 60 + minLength: 1 + pattern: ^[^,/]*$ + type: string volumeId: description: |- The UUID of the attached volume. format: uuid type: string required: - - device - - id + - attachment_id + - bdm_uuid + - delete_on_termination - serverId + - tag - volumeId type: object type: array required: - volumeAttachments type: object + x-openstack: + min-ver: '2.89' ServersRemote_ConsolesCreateRequest: oneOf: - $ref: '#/components/schemas/ServersRemote_ConsolesCreate_26' @@ -48444,10 +97640,62 @@ components: - $ref: '#/components/schemas/ServersRemote_ConsolesCreate_299' x-openstack: discriminator: microversion - ServersRemote_ConsolesCreateResponse: - description: Create Console Response + ServersRemote_ConsolesCreateResponse_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 + 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 + x-openstack: + max-ver: '2.7' + min-ver: '2.6' + ServersRemote_ConsolesCreateResponse_28: + additionalProperties: false properties: remote_console: + additionalProperties: false description: |- The remote console object. properties: @@ -48493,6 +97741,62 @@ components: required: - remote_console type: object + x-openstack: + max-ver: '2.98' + min-ver: '2.8' + ServersRemote_ConsolesCreateResponse_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 + 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 + x-openstack: + min-ver: '2.99' ServersRemote_ConsolesCreate_26: additionalProperties: false properties: @@ -48631,9 +97935,8 @@ components: - remote_console type: object x-openstack: - max-ver: '2.7' min-ver: '2.99' - ServersShareShowResponse: + ServersShareShowResponse_297: additionalProperties: false properties: share: @@ -48689,18 +97992,15 @@ components: - share title: Server share type: object - ServersSharesCreateResponse: + x-openstack: + min-ver: '2.97' + ServersSharesCreateResponse_297: 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: |- @@ -48745,6 +98045,8 @@ components: - share title: Server share type: object + x-openstack: + min-ver: '2.97' ServersSharesCreate_297: additionalProperties: false properties: @@ -48773,7 +98075,7 @@ components: type: object x-openstack: min-ver: '2.97' - ServersSharesListResponse: + ServersSharesIndexResponse_297: additionalProperties: false properties: shares: @@ -48781,13 +98083,8 @@ components: 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: |- @@ -48833,28 +98130,42 @@ components: - shares title: Server shares type: object - ServersTagShowResponse: - type: 'null' - ServersTagsListResponse: - description: Server Tags + x-openstack: + min-ver: '2.97' + ServersTagsIndexResponse_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 type: array + required: + - tags type: object - ServersTagsUpdate_AllResponse: - description: Server Tags + x-openstack: + min-ver: '2.26' + ServersTagsUpdate_AllResponse_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 type: array + required: + - tags type: object + x-openstack: + min-ver: '2.26' ServersTagsUpdate_All_226: additionalProperties: false properties: @@ -48874,65 +98185,63 @@ components: type: object x-openstack: min-ver: '2.26' - ServersTopologyListResponse: - description: NUMA topology information for a server + ServersTopologyIndexResponse_278: + additionalProperties: false properties: nodes: description: |- NUMA nodes information of a server. items: - description: NUMA node information of a server + additionalProperties: false properties: cpu_pinning: - additionalProperties: - type: integer - description: The mapping of server cores to host physical CPU + additionalProperties: false + patternProperties: + ^[0-9]+$: + type: integer 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 + items: + type: integer + type: array type: array vcpu_set: - description: A list of IDs of the virtual CPU assigned to this - NUMA node. items: type: integer type: array + required: + - memory_mb + - siblings + - vcpu_set type: object type: array + 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' + required: + - nodes + - pagesize_kb type: object + x-openstack: + min-ver: '2.78' 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: @@ -48961,30 +98270,14 @@ components: 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: diff --git a/openstack_types/data/container-infrastructure-management/v1.12.yaml b/openstack_types/data/container-infrastructure-management/v1.12.yaml index 519ea0da2..c983d1141 100644 --- a/openstack_types/data/container-infrastructure-management/v1.12.yaml +++ b/openstack_types/data/container-infrastructure-management/v1.12.yaml @@ -87,7 +87,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ClustersCreateResponse' + oneOf: + - $ref: '#/components/schemas/ClustersCreateResponse' + - $ref: '#/components/schemas/ClustersPostResponse' description: Ok summary: Create new cluster tags: @@ -187,13 +189,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ClustersNodegroupsGet_OneResponse' + oneOf: + - $ref: '#/components/schemas/ClustersNodegroupsGet_AllResponse' + - $ref: '#/components/schemas/ClustersNodegroupsGet_OneResponse' description: Ok '202': content: application/json: schema: - $ref: '#/components/schemas/ClustersNodegroupsCreateResponse' + oneOf: + - $ref: '#/components/schemas/ClustersNodegroupsCreateResponse' + - $ref: '#/components/schemas/ClustersNodegroupsPostResponse' description: Ok tags: - clusters @@ -2902,6 +2908,8 @@ components: model and the API representation of a cluster\nID." properties: uuid: + description: |- + The UUID of the cluster. format: uuid type: string type: object diff --git a/openstack_types/data/container-infrastructure-management/v1.yaml b/openstack_types/data/container-infrastructure-management/v1.yaml index 519ea0da2..c983d1141 100644 --- a/openstack_types/data/container-infrastructure-management/v1.yaml +++ b/openstack_types/data/container-infrastructure-management/v1.yaml @@ -87,7 +87,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ClustersCreateResponse' + oneOf: + - $ref: '#/components/schemas/ClustersCreateResponse' + - $ref: '#/components/schemas/ClustersPostResponse' description: Ok summary: Create new cluster tags: @@ -187,13 +189,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ClustersNodegroupsGet_OneResponse' + oneOf: + - $ref: '#/components/schemas/ClustersNodegroupsGet_AllResponse' + - $ref: '#/components/schemas/ClustersNodegroupsGet_OneResponse' description: Ok '202': content: application/json: schema: - $ref: '#/components/schemas/ClustersNodegroupsCreateResponse' + oneOf: + - $ref: '#/components/schemas/ClustersNodegroupsCreateResponse' + - $ref: '#/components/schemas/ClustersNodegroupsPostResponse' description: Ok tags: - clusters @@ -2902,6 +2908,8 @@ components: model and the API representation of a cluster\nID." properties: uuid: + description: |- + The UUID of the cluster. format: uuid type: string type: object diff --git a/openstack_types/data/dns/v2.1.yaml b/openstack_types/data/dns/v2.1.yaml index f3f49b62e..895f035f0 100644 --- a/openstack_types/data/dns/v2.1.yaml +++ b/openstack_types/data/dns/v2.1.yaml @@ -15,10 +15,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BlacklistsListResponse' description: Ok summary: List Blacklists tags: @@ -34,10 +30,6 @@ paths: $ref: '#/components/schemas/BlacklistsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/BlacklistsCreateResponse' description: Ok summary: Create Blacklist tags: @@ -62,10 +54,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BlacklistShowResponse' description: Ok summary: Show Blacklist tags: @@ -87,10 +75,6 @@ paths: $ref: '#/components/schemas/BlacklistUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BlacklistUpdateResponse' description: Ok summary: Update Blacklist tags: @@ -123,10 +107,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoolsListResponse' description: Ok summary: List all Pools tags: @@ -142,10 +122,6 @@ paths: $ref: '#/components/schemas/PoolsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PoolsCreateResponse' description: Ok tags: - pools @@ -172,10 +148,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoolShowResponse' description: Ok summary: Show a Pool tags: @@ -193,10 +165,6 @@ paths: $ref: '#/components/schemas/PoolUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoolUpdateResponse' description: Ok tags: - pools @@ -309,10 +277,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RecordsetShowResponse' description: Ok tags: - recordsets @@ -386,10 +350,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Service_StatusesListResponse' description: Ok summary: List Statuses tags: @@ -404,10 +364,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Service_StatusShowResponse' description: Ok summary: Show a Service Status tags: @@ -424,10 +380,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TldsListResponse' description: Ok summary: List Tlds tags: @@ -443,10 +395,6 @@ paths: $ref: '#/components/schemas/TldsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/TldsCreateResponse' description: Ok summary: Create Tld tags: @@ -471,10 +419,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TldShowResponse' description: Ok summary: Show Tld tags: @@ -492,10 +436,6 @@ paths: $ref: '#/components/schemas/TldUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TldUpdateResponse' description: Ok summary: Update Tld tags: @@ -510,10 +450,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TsigkeysListResponse' description: Ok summary: List Tsigkeys tags: @@ -529,10 +465,6 @@ paths: $ref: '#/components/schemas/TsigkeysCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/TsigkeysCreateResponse' description: Ok summary: Create Tsigkeys tags: @@ -557,10 +489,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TsigkeyShowResponse' description: Ok summary: Show a Tsigkey tags: @@ -578,10 +506,6 @@ paths: $ref: '#/components/schemas/TsigkeyUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TsigkeyUpdateResponse' description: Ok summary: Update Tsigkey tags: @@ -642,10 +566,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksExportsListResponse' description: Ok summary: List all Zone Exports tags: @@ -660,10 +580,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksExportShowResponse' description: Ok tags: - zone-exports @@ -678,10 +594,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksExportsExportListResponse' description: Ok summary: Retrieve a Zone Export from the Designate Datastore tags: @@ -712,10 +624,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksImportsListResponse' description: Ok summary: List all Zone Imports tags: @@ -731,10 +639,6 @@ paths: $ref: '#/components/schemas/ZonesTasksImportsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksImportsCreateResponse' description: Ok summary: Create a Zone Import tags: @@ -749,10 +653,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksImportShowResponse' description: Ok tags: - zone-imports @@ -786,10 +686,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_AcceptsListResponse' description: Ok summary: List Zone Transfer Accepts tags: @@ -805,10 +701,6 @@ paths: $ref: '#/components/schemas/ZonesTasksTransfer_AcceptsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_AcceptsCreateResponse' description: Ok summary: Create Zone Transfer Accept tags: @@ -823,10 +715,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_AcceptShowResponse' description: Ok tags: - zone-ownership-transfers-accepts @@ -843,10 +731,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_RequestsListResponse' description: Ok summary: List Zone Transfer Requests tags: @@ -869,10 +753,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_RequestShowResponse' description: Ok summary: Show a Zone Transfer Request tags: @@ -889,10 +769,6 @@ paths: $ref: '#/components/schemas/ZonesTasksTransfer_RequestUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_RequestUpdateResponse' description: Ok summary: Update a Zone Transfer Request tags: @@ -1163,10 +1039,6 @@ paths: $ref: '#/components/schemas/ZonesTasksAbandonCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksAbandonCreateResponse' description: Ok summary: Abandon Zone tags: @@ -1185,10 +1057,6 @@ paths: $ref: '#/components/schemas/ZonesTasksExportCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksExportCreateResponse' description: Ok summary: Create a Zone Export tags: @@ -1211,10 +1079,6 @@ paths: $ref: '#/components/schemas/ZonesTasksPool_MoveCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksPool_MoveCreateResponse' description: Ok summary: Pool Move Zone tags: @@ -1235,10 +1099,6 @@ paths: $ref: '#/components/schemas/ZonesTasksTransfer_RequestsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_RequestsCreateResponse' description: Ok summary: Create Zone Transfer Request tags: @@ -1262,10 +1122,6 @@ paths: $ref: '#/components/schemas/ZonesTasksXfrCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksXfrCreateResponse' description: Ok summary: Manually Trigger an Update of a Secondary Zone tags: @@ -1628,28 +1484,16 @@ components: schema: type: string schemas: - BlacklistShowResponse: - description: Response of the blacklists/blacklist_id:get operation - type: object BlacklistUpdateRequest: description: Request of the blacklists/blacklist_id:patch operation type: object x-openstack: action-name: update - BlacklistUpdateResponse: - description: Response of the blacklists/blacklist_id:patch operation - type: object BlacklistsCreateRequest: description: Request of the blacklists:post operation type: object x-openstack: action-name: create - BlacklistsCreateResponse: - description: Response of the blacklists:post operation - type: object - BlacklistsListResponse: - description: Response of the blacklists:get operation - type: object LimitsListResponse: properties: max_page_limit: @@ -1685,28 +1529,16 @@ components: The lowest ttl allowed on this system type: integer type: object - PoolShowResponse: - description: Response of the pools/pool_id:get operation - type: object PoolUpdateRequest: description: Request of the pools/pool_id:patch operation type: object x-openstack: action-name: update - PoolUpdateResponse: - description: Response of the pools/pool_id:patch operation - type: object PoolsCreateRequest: description: Request of the pools:post operation type: object x-openstack: action-name: create - PoolsCreateResponse: - description: Response of the pools:post operation - type: object - PoolsListResponse: - description: Response of the pools:get operation - type: object QuotaShowResponse: properties: api_export_size: @@ -1759,9 +1591,6 @@ components: zones: type: integer type: object - RecordsetShowResponse: - description: Response of the recordsets/recordset_id:get operation - type: object RecordsetsListResponse: additionalProperties: false properties: @@ -2142,56 +1971,26 @@ components: readOnly: true type: object type: object - Service_StatusShowResponse: - description: Response of the service_statuses/service_id:get operation - type: object - Service_StatusesListResponse: - description: Response of the service_statuses:get operation - type: object - TldShowResponse: - description: Response of the tlds/tld_id:get operation - type: object TldUpdateRequest: description: Request of the tlds/tld_id:patch operation type: object x-openstack: action-name: update - TldUpdateResponse: - description: Response of the tlds/tld_id:patch operation - type: object TldsCreateRequest: description: Request of the tlds:post operation type: object x-openstack: action-name: create - TldsCreateResponse: - description: Response of the tlds:post operation - type: object - TldsListResponse: - description: Response of the tlds:get operation - type: object - TsigkeyShowResponse: - description: Response of the tsigkeys/tsigkey_id:get operation - type: object TsigkeyUpdateRequest: description: Request of the tsigkeys/tsigkey_id:patch operation type: object x-openstack: action-name: update - TsigkeyUpdateResponse: - description: Response of the tsigkeys/tsigkey_id:patch operation - type: object TsigkeysCreateRequest: description: Request of the tsigkeys:post operation type: object x-openstack: action-name: create - TsigkeysCreateResponse: - description: Response of the tsigkeys:post operation - type: object - TsigkeysListResponse: - description: Response of the tsigkeys:get operation - type: object ZoneShowResponse: additionalProperties: false description: DNS Zone @@ -2354,8 +2153,6 @@ components: TTL (Time to Live) for the zone. type: integer type: object - x-openstack: - action-name: update ZoneUpdateResponse: additionalProperties: false description: DNS Zone @@ -2642,8 +2439,6 @@ components: readOnly: true type: integer type: object - x-openstack: - action-name: create ZonesCreateResponse: additionalProperties: false description: DNS Zone @@ -3123,8 +2918,6 @@ components: TTL (Time to Live) for the recordset. type: integer type: object - x-openstack: - action-name: update ZonesRecordsetUpdateResponse: additionalProperties: false description: Zone Record object @@ -3369,8 +3162,6 @@ components: readOnly: true type: string type: object - x-openstack: - action-name: create ZonesRecordsetsCreateResponse: additionalProperties: false description: Zone Record object @@ -3854,99 +3645,43 @@ components: type: object x-openstack: action-name: create - ZonesTasksAbandonCreateResponse: - description: Response of the zones/zone_id/tasks/abandon:post operation - type: object ZonesTasksExportCreateRequest: description: Request of the zones/zone_id/tasks/export:post operation type: object x-openstack: action-name: create - ZonesTasksExportCreateResponse: - description: Response of the zones/zone_id/tasks/export:post operation - type: object - ZonesTasksExportShowResponse: - description: Response of the zones/tasks/exports/export_id:get operation - type: object - ZonesTasksExportsExportListResponse: - description: Response of the zones/tasks/exports/export_id/export:get - operation - type: object - ZonesTasksExportsListResponse: - description: Response of the zones/tasks/exports:get operation - type: object - ZonesTasksImportShowResponse: - description: Response of the zones/tasks/imports/import_id:get operation - type: object ZonesTasksImportsCreateRequest: description: Request of the zones/tasks/imports:post operation type: object x-openstack: action-name: create - ZonesTasksImportsCreateResponse: - description: Response of the zones/tasks/imports:post operation - type: object - ZonesTasksImportsListResponse: - description: Response of the zones/tasks/imports:get operation - type: object ZonesTasksPool_MoveCreateRequest: description: Request of the zones/zone_id/tasks/pool_move:post operation type: object x-openstack: action-name: create - ZonesTasksPool_MoveCreateResponse: - description: Response of the zones/zone_id/tasks/pool_move:post operation - type: object - ZonesTasksTransfer_AcceptShowResponse: - description: Response of the - zones/tasks/transfer_accepts/transfer_accept_id:get operation - type: object ZonesTasksTransfer_AcceptsCreateRequest: description: Request of the zones/tasks/transfer_accepts:post operation type: object x-openstack: action-name: create - ZonesTasksTransfer_AcceptsCreateResponse: - description: Response of the zones/tasks/transfer_accepts:post operation - type: object - ZonesTasksTransfer_AcceptsListResponse: - description: Response of the zones/tasks/transfer_accepts:get operation - type: object - ZonesTasksTransfer_RequestShowResponse: - description: Response of the - zones/tasks/transfer_requests/zone_transfer_request_id:get operation - type: object ZonesTasksTransfer_RequestUpdateRequest: description: Request of the zones/tasks/transfer_requests/zone_transfer_request_id:patch operation type: object x-openstack: action-name: update - ZonesTasksTransfer_RequestUpdateResponse: - description: Response of the - zones/tasks/transfer_requests/zone_transfer_request_id:patch operation - type: object ZonesTasksTransfer_RequestsCreateRequest: description: Request of the zones/zone_id/tasks/transfer_requests:post operation type: object x-openstack: action-name: create - ZonesTasksTransfer_RequestsCreateResponse: - description: Response of the zones/zone_id/tasks/transfer_requests:post - operation - type: object - ZonesTasksTransfer_RequestsListResponse: - description: Response of the zones/tasks/transfer_requests:get operation - type: object ZonesTasksXfrCreateRequest: description: Request of the zones/zone_id/tasks/xfr:post operation type: object x-openstack: action-name: create - ZonesTasksXfrCreateResponse: - description: Response of the zones/zone_id/tasks/xfr:post operation - type: object securitySchemes: ApiKeyAuth: in: header diff --git a/openstack_types/data/dns/v2.yaml b/openstack_types/data/dns/v2.yaml index f3f49b62e..895f035f0 100644 --- a/openstack_types/data/dns/v2.yaml +++ b/openstack_types/data/dns/v2.yaml @@ -15,10 +15,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BlacklistsListResponse' description: Ok summary: List Blacklists tags: @@ -34,10 +30,6 @@ paths: $ref: '#/components/schemas/BlacklistsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/BlacklistsCreateResponse' description: Ok summary: Create Blacklist tags: @@ -62,10 +54,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BlacklistShowResponse' description: Ok summary: Show Blacklist tags: @@ -87,10 +75,6 @@ paths: $ref: '#/components/schemas/BlacklistUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/BlacklistUpdateResponse' description: Ok summary: Update Blacklist tags: @@ -123,10 +107,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoolsListResponse' description: Ok summary: List all Pools tags: @@ -142,10 +122,6 @@ paths: $ref: '#/components/schemas/PoolsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PoolsCreateResponse' description: Ok tags: - pools @@ -172,10 +148,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoolShowResponse' description: Ok summary: Show a Pool tags: @@ -193,10 +165,6 @@ paths: $ref: '#/components/schemas/PoolUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoolUpdateResponse' description: Ok tags: - pools @@ -309,10 +277,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RecordsetShowResponse' description: Ok tags: - recordsets @@ -386,10 +350,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Service_StatusesListResponse' description: Ok summary: List Statuses tags: @@ -404,10 +364,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Service_StatusShowResponse' description: Ok summary: Show a Service Status tags: @@ -424,10 +380,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TldsListResponse' description: Ok summary: List Tlds tags: @@ -443,10 +395,6 @@ paths: $ref: '#/components/schemas/TldsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/TldsCreateResponse' description: Ok summary: Create Tld tags: @@ -471,10 +419,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TldShowResponse' description: Ok summary: Show Tld tags: @@ -492,10 +436,6 @@ paths: $ref: '#/components/schemas/TldUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TldUpdateResponse' description: Ok summary: Update Tld tags: @@ -510,10 +450,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TsigkeysListResponse' description: Ok summary: List Tsigkeys tags: @@ -529,10 +465,6 @@ paths: $ref: '#/components/schemas/TsigkeysCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/TsigkeysCreateResponse' description: Ok summary: Create Tsigkeys tags: @@ -557,10 +489,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TsigkeyShowResponse' description: Ok summary: Show a Tsigkey tags: @@ -578,10 +506,6 @@ paths: $ref: '#/components/schemas/TsigkeyUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TsigkeyUpdateResponse' description: Ok summary: Update Tsigkey tags: @@ -642,10 +566,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksExportsListResponse' description: Ok summary: List all Zone Exports tags: @@ -660,10 +580,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksExportShowResponse' description: Ok tags: - zone-exports @@ -678,10 +594,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksExportsExportListResponse' description: Ok summary: Retrieve a Zone Export from the Designate Datastore tags: @@ -712,10 +624,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksImportsListResponse' description: Ok summary: List all Zone Imports tags: @@ -731,10 +639,6 @@ paths: $ref: '#/components/schemas/ZonesTasksImportsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksImportsCreateResponse' description: Ok summary: Create a Zone Import tags: @@ -749,10 +653,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksImportShowResponse' description: Ok tags: - zone-imports @@ -786,10 +686,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_AcceptsListResponse' description: Ok summary: List Zone Transfer Accepts tags: @@ -805,10 +701,6 @@ paths: $ref: '#/components/schemas/ZonesTasksTransfer_AcceptsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_AcceptsCreateResponse' description: Ok summary: Create Zone Transfer Accept tags: @@ -823,10 +715,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_AcceptShowResponse' description: Ok tags: - zone-ownership-transfers-accepts @@ -843,10 +731,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_RequestsListResponse' description: Ok summary: List Zone Transfer Requests tags: @@ -869,10 +753,6 @@ paths: - $ref: '#/components/parameters/x-auth-sudo-project-id' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_RequestShowResponse' description: Ok summary: Show a Zone Transfer Request tags: @@ -889,10 +769,6 @@ paths: $ref: '#/components/schemas/ZonesTasksTransfer_RequestUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_RequestUpdateResponse' description: Ok summary: Update a Zone Transfer Request tags: @@ -1163,10 +1039,6 @@ paths: $ref: '#/components/schemas/ZonesTasksAbandonCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksAbandonCreateResponse' description: Ok summary: Abandon Zone tags: @@ -1185,10 +1057,6 @@ paths: $ref: '#/components/schemas/ZonesTasksExportCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksExportCreateResponse' description: Ok summary: Create a Zone Export tags: @@ -1211,10 +1079,6 @@ paths: $ref: '#/components/schemas/ZonesTasksPool_MoveCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksPool_MoveCreateResponse' description: Ok summary: Pool Move Zone tags: @@ -1235,10 +1099,6 @@ paths: $ref: '#/components/schemas/ZonesTasksTransfer_RequestsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksTransfer_RequestsCreateResponse' description: Ok summary: Create Zone Transfer Request tags: @@ -1262,10 +1122,6 @@ paths: $ref: '#/components/schemas/ZonesTasksXfrCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ZonesTasksXfrCreateResponse' description: Ok summary: Manually Trigger an Update of a Secondary Zone tags: @@ -1628,28 +1484,16 @@ components: schema: type: string schemas: - BlacklistShowResponse: - description: Response of the blacklists/blacklist_id:get operation - type: object BlacklistUpdateRequest: description: Request of the blacklists/blacklist_id:patch operation type: object x-openstack: action-name: update - BlacklistUpdateResponse: - description: Response of the blacklists/blacklist_id:patch operation - type: object BlacklistsCreateRequest: description: Request of the blacklists:post operation type: object x-openstack: action-name: create - BlacklistsCreateResponse: - description: Response of the blacklists:post operation - type: object - BlacklistsListResponse: - description: Response of the blacklists:get operation - type: object LimitsListResponse: properties: max_page_limit: @@ -1685,28 +1529,16 @@ components: The lowest ttl allowed on this system type: integer type: object - PoolShowResponse: - description: Response of the pools/pool_id:get operation - type: object PoolUpdateRequest: description: Request of the pools/pool_id:patch operation type: object x-openstack: action-name: update - PoolUpdateResponse: - description: Response of the pools/pool_id:patch operation - type: object PoolsCreateRequest: description: Request of the pools:post operation type: object x-openstack: action-name: create - PoolsCreateResponse: - description: Response of the pools:post operation - type: object - PoolsListResponse: - description: Response of the pools:get operation - type: object QuotaShowResponse: properties: api_export_size: @@ -1759,9 +1591,6 @@ components: zones: type: integer type: object - RecordsetShowResponse: - description: Response of the recordsets/recordset_id:get operation - type: object RecordsetsListResponse: additionalProperties: false properties: @@ -2142,56 +1971,26 @@ components: readOnly: true type: object type: object - Service_StatusShowResponse: - description: Response of the service_statuses/service_id:get operation - type: object - Service_StatusesListResponse: - description: Response of the service_statuses:get operation - type: object - TldShowResponse: - description: Response of the tlds/tld_id:get operation - type: object TldUpdateRequest: description: Request of the tlds/tld_id:patch operation type: object x-openstack: action-name: update - TldUpdateResponse: - description: Response of the tlds/tld_id:patch operation - type: object TldsCreateRequest: description: Request of the tlds:post operation type: object x-openstack: action-name: create - TldsCreateResponse: - description: Response of the tlds:post operation - type: object - TldsListResponse: - description: Response of the tlds:get operation - type: object - TsigkeyShowResponse: - description: Response of the tsigkeys/tsigkey_id:get operation - type: object TsigkeyUpdateRequest: description: Request of the tsigkeys/tsigkey_id:patch operation type: object x-openstack: action-name: update - TsigkeyUpdateResponse: - description: Response of the tsigkeys/tsigkey_id:patch operation - type: object TsigkeysCreateRequest: description: Request of the tsigkeys:post operation type: object x-openstack: action-name: create - TsigkeysCreateResponse: - description: Response of the tsigkeys:post operation - type: object - TsigkeysListResponse: - description: Response of the tsigkeys:get operation - type: object ZoneShowResponse: additionalProperties: false description: DNS Zone @@ -2354,8 +2153,6 @@ components: TTL (Time to Live) for the zone. type: integer type: object - x-openstack: - action-name: update ZoneUpdateResponse: additionalProperties: false description: DNS Zone @@ -2642,8 +2439,6 @@ components: readOnly: true type: integer type: object - x-openstack: - action-name: create ZonesCreateResponse: additionalProperties: false description: DNS Zone @@ -3123,8 +2918,6 @@ components: TTL (Time to Live) for the recordset. type: integer type: object - x-openstack: - action-name: update ZonesRecordsetUpdateResponse: additionalProperties: false description: Zone Record object @@ -3369,8 +3162,6 @@ components: readOnly: true type: string type: object - x-openstack: - action-name: create ZonesRecordsetsCreateResponse: additionalProperties: false description: Zone Record object @@ -3854,99 +3645,43 @@ components: type: object x-openstack: action-name: create - ZonesTasksAbandonCreateResponse: - description: Response of the zones/zone_id/tasks/abandon:post operation - type: object ZonesTasksExportCreateRequest: description: Request of the zones/zone_id/tasks/export:post operation type: object x-openstack: action-name: create - ZonesTasksExportCreateResponse: - description: Response of the zones/zone_id/tasks/export:post operation - type: object - ZonesTasksExportShowResponse: - description: Response of the zones/tasks/exports/export_id:get operation - type: object - ZonesTasksExportsExportListResponse: - description: Response of the zones/tasks/exports/export_id/export:get - operation - type: object - ZonesTasksExportsListResponse: - description: Response of the zones/tasks/exports:get operation - type: object - ZonesTasksImportShowResponse: - description: Response of the zones/tasks/imports/import_id:get operation - type: object ZonesTasksImportsCreateRequest: description: Request of the zones/tasks/imports:post operation type: object x-openstack: action-name: create - ZonesTasksImportsCreateResponse: - description: Response of the zones/tasks/imports:post operation - type: object - ZonesTasksImportsListResponse: - description: Response of the zones/tasks/imports:get operation - type: object ZonesTasksPool_MoveCreateRequest: description: Request of the zones/zone_id/tasks/pool_move:post operation type: object x-openstack: action-name: create - ZonesTasksPool_MoveCreateResponse: - description: Response of the zones/zone_id/tasks/pool_move:post operation - type: object - ZonesTasksTransfer_AcceptShowResponse: - description: Response of the - zones/tasks/transfer_accepts/transfer_accept_id:get operation - type: object ZonesTasksTransfer_AcceptsCreateRequest: description: Request of the zones/tasks/transfer_accepts:post operation type: object x-openstack: action-name: create - ZonesTasksTransfer_AcceptsCreateResponse: - description: Response of the zones/tasks/transfer_accepts:post operation - type: object - ZonesTasksTransfer_AcceptsListResponse: - description: Response of the zones/tasks/transfer_accepts:get operation - type: object - ZonesTasksTransfer_RequestShowResponse: - description: Response of the - zones/tasks/transfer_requests/zone_transfer_request_id:get operation - type: object ZonesTasksTransfer_RequestUpdateRequest: description: Request of the zones/tasks/transfer_requests/zone_transfer_request_id:patch operation type: object x-openstack: action-name: update - ZonesTasksTransfer_RequestUpdateResponse: - description: Response of the - zones/tasks/transfer_requests/zone_transfer_request_id:patch operation - type: object ZonesTasksTransfer_RequestsCreateRequest: description: Request of the zones/zone_id/tasks/transfer_requests:post operation type: object x-openstack: action-name: create - ZonesTasksTransfer_RequestsCreateResponse: - description: Response of the zones/zone_id/tasks/transfer_requests:post - operation - type: object - ZonesTasksTransfer_RequestsListResponse: - description: Response of the zones/tasks/transfer_requests:get operation - type: object ZonesTasksXfrCreateRequest: description: Request of the zones/zone_id/tasks/xfr:post operation type: object x-openstack: action-name: create - ZonesTasksXfrCreateResponse: - description: Response of the zones/zone_id/tasks/xfr:post operation - type: object securitySchemes: ApiKeyAuth: in: header diff --git a/openstack_types/data/identity/keystone_rust.yaml b/openstack_types/data/identity/keystone_rust.yaml index 6092a2979..16d3ae657 100644 --- a/openstack_types/data/identity/keystone_rust.yaml +++ b/openstack_types/data/identity/keystone_rust.yaml @@ -21,6 +21,52 @@ paths: application/json: schema: $ref: '#/components/schemas/Versions' + /health: + get: + tags: + - health + summary: Health check endpoint. + description: |- + Perform diverse checks to identify the overall status of the system. It can be `OK`, + `SERVICE_UNAVAILABLE`. In difference to the `/ready` check this does not return + `SERVICE_UNAVAILABLE` when components are in the degraded state to prevent from the restart. It + is similar to the `/live` check. + operationId: health + responses: + '200': + description: Service is healthy + content: + application/json: + schema: + $ref: '#/components/schemas/HealthResponse' + '503': + description: Service is unhealthy + content: + application/json: + schema: + $ref: '#/components/schemas/HealthResponse' + /ready: + get: + tags: + - health + summary: Readiness health check endpoint. + description: |- + Perform relevant checks only returning `OK` when all of them are ok. Any check in the + degraded/warn state would result in `SERVICE_UNAVAILABLE` response. + operationId: ready + responses: + '200': + description: Service is healthy + content: + application/json: + schema: + $ref: '#/components/schemas/HealthResponse' + '503': + description: Service is unhealthy + content: + application/json: + schema: + $ref: '#/components/schemas/HealthResponse' /v3: get: tags: @@ -141,8 +187,7 @@ paths: get: tags: - groups - summary: List groups - description: List groups + summary: List user groups. operationId: list parameters: - name: domain_id @@ -173,8 +218,7 @@ paths: post: tags: - groups - summary: Create group - description: Create new Group + summary: Create new user group. operationId: create requestBody: content: @@ -193,8 +237,7 @@ paths: get: tags: - groups - summary: Get single group - description: Get group by ID + summary: Get a single user group by ID. operationId: show parameters: - name: group_id @@ -214,9 +257,8 @@ paths: delete: tags: - groups - summary: Delete group - description: Delete group by ID - operationId: remove + summary: Delete group by ID. + operationId: delete parameters: - name: group_id in: path @@ -1238,8 +1280,7 @@ paths: get: tags: - groups - summary: List groups - description: List groups + summary: List user groups. operationId: list parameters: - name: domain_id @@ -1270,8 +1311,7 @@ paths: post: tags: - groups - summary: Create group - description: Create new Group + summary: Create new user group. operationId: create requestBody: content: @@ -1290,8 +1330,7 @@ paths: get: tags: - groups - summary: Get single group - description: Get group by ID + summary: Get a single user group by ID. operationId: show parameters: - name: group_id @@ -1311,9 +1350,8 @@ paths: delete: tags: - groups - summary: Delete group - description: Delete group by ID - operationId: remove + summary: Delete group by ID. + operationId: delete parameters: - name: group_id in: path @@ -2661,6 +2699,20 @@ components: - Optional - OptionalWithCredentialIDList - Required + DatabaseStatus: + type: object + description: Health status of the database. + required: + - status + properties: + message: + type: + - string + - 'null' + description: The error message. + status: + $ref: '#/components/schemas/HealthStatus' + description: Status of database. Domain: type: object description: Domain information. @@ -2792,6 +2844,44 @@ components: group: $ref: '#/components/schemas/Group' description: group object. + HealthComponents: + type: object + description: The health components of the system. + required: + - raft + - database + - policy + properties: + database: + $ref: '#/components/schemas/DatabaseStatus' + description: Status of the database. + policy: + $ref: '#/components/schemas/PolicyStatus' + description: Status of the policy enforcement engine. + raft: + $ref: '#/components/schemas/RaftStatus' + description: Status of the raft storage. + HealthResponse: + type: object + description: Health check response. + required: + - status + - components + properties: + components: + $ref: '#/components/schemas/HealthComponents' + description: Individual health checks. + status: + $ref: '#/components/schemas/HealthStatus' + description: Overall health status of the system. + HealthStatus: + type: string + description: The health status. + enum: + - skipped + - ok + - warn + - error HmacGetSecretInput: type: object description: |- @@ -3969,6 +4059,20 @@ components: user: $ref: '#/components/schemas/UserPassword' description: A user object. + PolicyStatus: + type: object + description: Health status of the policy engine. + required: + - status + properties: + message: + type: + - string + - 'null' + description: The error message. + status: + $ref: '#/components/schemas/HealthStatus' + description: Status of Raft cluster. Project: type: object description: Project information. @@ -4235,6 +4339,20 @@ components: user_verification: $ref: '#/components/schemas/UserVerificationPolicy' description: The verification policy the browser will request. + RaftStatus: + type: object + description: Health status of the Raft storage. + required: + - status + properties: + message: + type: + - string + - 'null' + description: The error message. + status: + $ref: '#/components/schemas/HealthStatus' + description: Status of Raft cluster. RegistrationExtensionsClientOutputs: type: object description: |- diff --git a/openstack_types/data/identity/v3.14.yaml b/openstack_types/data/identity/v3.14.yaml index ad5238bcd..b052977c9 100644 --- a/openstack_types/data/identity/v3.14.yaml +++ b/openstack_types/data/identity/v3.14.yaml @@ -12,10 +12,6 @@ paths: operationId: versions:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RootGetResponse' description: Ok '403': description: Error @@ -43,10 +39,6 @@ paths: operationId: version:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RootGetResponse' description: Ok '403': description: Error @@ -211,10 +203,6 @@ paths: operationId: OS-EP-FILTER/endpoint_groups/endpoint_group_id/endpoints:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsEndpointsGetResponse' description: Ok '403': description: Error @@ -244,10 +232,6 @@ paths: operationId: OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsProjectsGetResponse' description: Ok '403': description: Error @@ -292,10 +276,6 @@ paths: OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects/project_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsProjectGetResponse' description: Ok '403': description: Error @@ -332,10 +312,6 @@ paths: $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsProjectPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsProjectPutResponse' description: Ok '403': description: Error @@ -350,10 +326,6 @@ paths: operationId: OS-EP-FILTER/endpoints/endpoint_id/projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpointsProjectsGetResponse' description: Ok '403': description: Error @@ -383,10 +355,6 @@ paths: operationId: OS-EP-FILTER/projects/project_id/endpoint_groups:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpoint_GroupsGetResponse' description: Ok '403': description: Error @@ -416,10 +384,6 @@ paths: operationId: OS-EP-FILTER/projects/project_id/endpoints:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpointsGetResponse' description: Ok '403': description: Error @@ -462,10 +426,6 @@ paths: operationId: OS-EP-FILTER/projects/project_id/endpoints/endpoint_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpointGetResponse' description: Ok '403': description: Error @@ -500,10 +460,6 @@ paths: $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpointPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpointPutResponse' description: Ok '403': description: Error @@ -1256,10 +1212,6 @@ paths: OS-INHERIT/domains/domain_id/groups/group_id/roles/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsGroupsRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1317,10 +1269,6 @@ paths: OS-INHERIT/domains/domain_id/groups/group_id/roles/role_id/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsGroupsRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1366,10 +1314,6 @@ paths: $ref: '#/components/schemas/Os_InheritDomainsGroupsRolesInherited_To_ProjectsPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsGroupsRolesInherited_To_ProjectsPutResponse' description: Ok '403': description: Error @@ -1390,10 +1334,6 @@ paths: OS-INHERIT/domains/domain_id/users/user_id/roles/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsUsersRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1451,10 +1391,6 @@ paths: OS-INHERIT/domains/domain_id/users/user_id/roles/role_id/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsUsersRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1502,10 +1438,6 @@ paths: $ref: '#/components/schemas/Os_InheritDomainsUsersRolesInherited_To_ProjectsPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsUsersRolesInherited_To_ProjectsPutResponse' description: Ok '403': description: Error @@ -1541,10 +1473,6 @@ paths: OS-INHERIT/projects/project_id/groups/group_id/roles/role_id/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritProjectsGroupsRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1590,10 +1518,6 @@ paths: $ref: '#/components/schemas/Os_InheritProjectsGroupsRolesInherited_To_ProjectsPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritProjectsGroupsRolesInherited_To_ProjectsPutResponse' description: Ok '403': description: Error @@ -1629,10 +1553,6 @@ paths: OS-INHERIT/projects/project_id/users/user_id/roles/role_id/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritProjectsUsersRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1678,10 +1598,6 @@ paths: $ref: '#/components/schemas/Os_InheritProjectsUsersRolesInherited_To_ProjectsPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritProjectsUsersRolesInherited_To_ProjectsPutResponse' description: Ok '403': description: Error @@ -1697,10 +1613,6 @@ paths: operationId: OS-OAUTH1/access_token:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1Access_TokenGetResponse' description: Ok '403': description: Error @@ -1732,10 +1644,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1Access_TokenPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1Access_TokenPostResponse' description: Ok '403': description: Error @@ -1757,10 +1665,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1AuthorizePutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1AuthorizePutResponse' description: Ok '403': description: Error @@ -1775,10 +1679,6 @@ paths: operationId: OS-OAUTH1/consumers:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1ConsumersGetResponse' description: Ok '403': description: Error @@ -1810,10 +1710,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1ConsumersPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1ConsumersPostResponse' description: Ok '403': description: Error @@ -1841,10 +1737,6 @@ paths: operationId: OS-OAUTH1/consumers/consumer_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1ConsumerGetResponse' description: Ok '403': description: Error @@ -1878,10 +1770,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1ConsumerPatchRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1ConsumerPatchResponse' description: Ok '403': description: Error @@ -1896,10 +1784,6 @@ paths: operationId: OS-OAUTH1/request_token:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1Request_TokenGetResponse' description: Ok '403': description: Error @@ -1931,10 +1815,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1Request_TokenPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1Request_TokenPostResponse' description: Ok '403': description: Error @@ -1962,10 +1842,6 @@ paths: operationId: OS-OAUTH2/token:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth2TokenGetResponse' description: Ok '403': description: Error @@ -1997,10 +1873,6 @@ paths: $ref: '#/components/schemas/Os_Oauth2TokenPatchRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth2TokenPatchResponse' description: Ok '403': description: Error @@ -2021,10 +1893,6 @@ paths: $ref: '#/components/schemas/Os_Oauth2TokenPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth2TokenPostResponse' description: Ok '403': description: Error @@ -2043,10 +1911,6 @@ paths: $ref: '#/components/schemas/Os_Oauth2TokenPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth2TokenPutResponse' description: Ok '403': description: Error @@ -2061,10 +1925,6 @@ paths: operationId: OS-REVOKE/events:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_RevokeEventsGetResponse' description: Ok '403': description: Error @@ -2092,10 +1952,6 @@ paths: operationId: OS-SIMPLE-CERT/ca:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Simple_CertCaGetResponse' description: Ok '403': description: Error @@ -2123,10 +1979,6 @@ paths: operationId: OS-SIMPLE-CERT/certificates:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Simple_CertCertificatesGetResponse' description: Ok '403': description: Error @@ -2273,10 +2125,6 @@ paths: operationId: OS-TRUST/trusts/trust_id/roles:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_TrustTrustsRolesGetResponse' description: Ok '403': description: Error @@ -2306,10 +2154,6 @@ paths: operationId: OS-TRUST/trusts/trust_id/roles/role_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_TrustTrustsRoleGetResponse' description: Ok '403': description: Error @@ -2394,10 +2238,6 @@ paths: operationId: auth/OS-FEDERATION/saml2:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AuthOs_FederationSaml2GetResponse' description: Ok '403': description: Error @@ -2449,10 +2289,6 @@ paths: operationId: auth/OS-FEDERATION/saml2/ecp:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AuthOs_FederationSaml2EcpGetResponse' description: Ok '403': description: Error @@ -2843,10 +2679,6 @@ paths: operationId: auth/tokens/OS-PKI/revoked:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AuthTokensOs_PkiRevokedGetResponse' description: Ok '403': description: Error @@ -3820,10 +3652,6 @@ paths: operationId: ec2tokens:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Ec2TokensGetResponse' description: Ok '403': description: Error @@ -3857,10 +3685,6 @@ paths: $ref: '#/components/schemas/Ec2TokensPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Ec2TokensPostResponse' description: Ok '403': description: Error @@ -4024,10 +3848,6 @@ paths: operationId: endpoints/endpoint_id/OS-ENDPOINT-POLICY/policy:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EndpointsOs_Endpoint_PolicyPolicyGetResponse' description: Ok '403': description: Error @@ -4512,10 +4332,6 @@ paths: operationId: policies:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesGetResponse' description: Ok '403': description: Error @@ -4550,10 +4366,6 @@ paths: $ref: '#/components/schemas/PoliciesPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesPostResponse' description: Ok '403': description: Error @@ -4587,10 +4399,6 @@ paths: operationId: policies/policy_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyGetResponse' description: Ok '403': description: Error @@ -4627,10 +4435,6 @@ paths: $ref: '#/components/schemas/PolicyPatchRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyPatchResponse' description: Ok '403': description: Error @@ -4646,10 +4450,6 @@ paths: operationId: policies/policy_id/OS-ENDPOINT-POLICY/endpoints:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyEndpointsGetResponse' description: Ok '403': description: Error @@ -4694,10 +4494,6 @@ paths: policies/policy_id/OS-ENDPOINT-POLICY/endpoints/endpoint_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyEndpointGetResponse' description: Ok '403': description: Error @@ -4734,10 +4530,6 @@ paths: $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyEndpointPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyEndpointPutResponse' description: Ok '403': description: Error @@ -4766,10 +4558,6 @@ paths: operationId: policies/policy_id/OS-ENDPOINT-POLICY/services/service_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServiceGetResponse' description: Ok '403': description: Error @@ -4805,10 +4593,6 @@ paths: $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicePutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicePutResponse' description: Ok '403': description: Error @@ -4838,10 +4622,6 @@ paths: policies/policy_id/OS-ENDPOINT-POLICY/services/service_id/regions/region_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicesRegionGetResponse' description: Ok '403': description: Error @@ -4879,10 +4659,6 @@ paths: $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicesRegionPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicesRegionPutResponse' description: Ok '403': description: Error @@ -6177,10 +5953,6 @@ paths: operationId: s3tokens:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/S3TokensGetResponse' description: Ok '403': description: Error @@ -6214,10 +5986,6 @@ paths: $ref: '#/components/schemas/S3TokensPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/S3TokensPostResponse' description: Ok '403': description: Error @@ -6765,10 +6533,6 @@ paths: operationId: users/user_id/OS-OAUTH1/access_tokens:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersOs_Oauth1Access_TokensGetResponse' description: Ok '403': description: Error @@ -6817,10 +6581,6 @@ paths: operationId: users/user_id/OS-OAUTH1/access_tokens/access_token_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersOs_Oauth1Access_TokenGetResponse' description: Ok '403': description: Error @@ -6857,10 +6617,6 @@ paths: users/user_id/OS-OAUTH1/access_tokens/access_token_id/roles:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersOs_Oauth1Access_TokensRolesGetResponse' description: Ok '403': description: Error @@ -6899,10 +6655,6 @@ paths: users/user_id/OS-OAUTH1/access_tokens/access_token_id/roles/role_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersOs_Oauth1Access_TokensRoleGetResponse' description: Ok '403': description: Error @@ -7169,10 +6921,6 @@ paths: operationId: users/user_id/credentials/OS-EC2:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersCredentialsOs_Ec2GetResponse' description: Ok '403': description: Error @@ -7210,10 +6958,6 @@ paths: $ref: '#/components/schemas/UsersCredentialsOs_Ec2PostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersCredentialsOs_Ec2PostResponse' description: Ok '403': description: Error @@ -7245,10 +6989,6 @@ paths: operationId: users/user_id/credentials/OS-EC2/credential_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersCredentialsOs_Ec2GetResponse' description: Ok '403': description: Error @@ -9387,9 +9127,6 @@ components: type: object type: object type: object - AuthOs_FederationSaml2EcpGetResponse: - description: Response of the auth/OS-FEDERATION/saml2/ecp:get operation - type: object AuthOs_FederationSaml2EcpPostRequest: definitions: user_domain: @@ -9607,9 +9344,6 @@ components: description: SAML assertion in XML format format: xml type: string - AuthOs_FederationSaml2GetResponse: - description: Response of the auth/OS-FEDERATION/saml2:get operation - type: object AuthOs_FederationSaml2PostRequest: definitions: user_domain: @@ -10386,9 +10120,6 @@ components: type: object type: object type: object - AuthTokensOs_PkiRevokedGetResponse: - description: Response of the auth/tokens/OS-PKI/revoked:get operation - type: object AuthTokensPostRequest: definitions: user_domain: @@ -10811,7 +10542,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links for the `credential` resource. properties: self: format: uri @@ -10888,7 +10619,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links for the `credential` resource. properties: self: format: uri @@ -10920,8 +10651,7 @@ components: A list of `credential` objects. items: additionalProperties: true - description: |- - A `credential` object. + description: A credential object. properties: blob: description: |- @@ -10935,7 +10665,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links for the `credentials` resource. properties: self: format: uri @@ -10961,8 +10691,7 @@ components: type: array links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -11056,7 +10785,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links for the `credential` resource. properties: self: format: uri @@ -11163,7 +10892,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links to the `domain` resource. properties: self: format: uri @@ -11172,7 +10901,7 @@ components: type: object name: description: |- - The name of the project. + The name of the domain. maxLength: 64 minLength: 1 pattern: '[\S]+' @@ -11193,8 +10922,6 @@ components: - 'null' type: object tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -11349,7 +11076,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links to the `domain` resource. properties: self: format: uri @@ -11358,7 +11085,7 @@ components: type: object name: description: |- - The name of the project. + The name of the domain. maxLength: 64 minLength: 1 pattern: '[\S]+' @@ -11379,8 +11106,6 @@ components: - 'null' type: object tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -11402,8 +11127,6 @@ components: A list of `domain` objects items: additionalProperties: false - description: |- - A `domain` object properties: description: description: |- @@ -11450,7 +11173,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links to the `domain` resource. properties: self: format: uri @@ -11459,16 +11182,13 @@ components: type: object name: description: |- - The name of the project. + The name of the domain. maxLength: 64 minLength: 1 pattern: '[\S]+' type: string options: additionalProperties: false - description: |- - The resource options for the role. Available resource options are - `immutable`. properties: immutable: enum: @@ -11480,8 +11200,6 @@ components: - 'null' type: object tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -11495,8 +11213,7 @@ components: type: array links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -11520,43 +11237,118 @@ components: global response limit type: boolean type: object - DomainsPost: + DomainsGroupsRolesGetResponse: additionalProperties: false properties: - domain: - description: |- - A `domain` object + links: + additionalProperties: false + description: Links for the collection of resources. properties: - description: - description: |- - The description of the domain. - maxLength: 255 + next: + format: uri type: - 'null' - string - enabled: - description: |- - If set to `true`, domain is created enabled. If set to - `false`, domain is created disabled. The default is `true`. - - Users can only authorize against an enabled domain (and any of its - projects). In addition, users can only authenticate if the domain that owns - them is also enabled. Disabling a domain prevents both of these things. - enum: - - '' - - '0' - - '1' - - 'FALSE' - - false - - 'False' - - N - - OFF - - ON - - 'TRUE' - - true - - 'True' - - Y - - 'false' + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + roles: + items: + additionalProperties: false + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean + type: object + DomainsPost: + additionalProperties: false + properties: + domain: + description: |- + A `domain` object + properties: + description: + description: |- + The description of the domain. + maxLength: 255 + type: + - 'null' + - string + enabled: + description: |- + If set to `true`, domain is created enabled. If set to + `false`, domain is created disabled. The default is `true`. + + Users can only authorize against an enabled domain (and any of its + projects). In addition, users can only authenticate if the domain that owns + them is also enabled. Disabling a domain prevents both of these things. + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' - n - no - off @@ -11669,7 +11461,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links to the `domain` resource. properties: self: format: uri @@ -11678,7 +11470,7 @@ components: type: object name: description: |- - The name of the project. + The name of the domain. maxLength: 64 minLength: 1 pattern: '[\S]+' @@ -11699,8 +11491,6 @@ components: - 'null' type: object tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -11714,17 +11504,86 @@ components: required: - domain type: object - Ec2TokensGetResponse: - description: Response of the ec2tokens:get operation + DomainsUsersRolesGetResponse: + additionalProperties: false + properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + roles: + items: + additionalProperties: false + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object Ec2TokensPostRequest: description: Request of the ec2tokens:post operation type: object x-openstack: action-name: POST - Ec2TokensPostResponse: - description: Response of the ec2tokens:post operation - type: object Endpoint: properties: endpoint: @@ -11785,6 +11644,78 @@ components: type: string type: object type: object + EndpointGetResponse: + additionalProperties: false + description: An endpoint object + properties: + endpoint: + additionalProperties: true + description: An endpoint object + properties: + description: + description: A description of the endpoint. + type: + - 'null' + - string + enabled: + description: Indicates whether the endpoint appears in the service + catalog -false. The endpoint does not appear in the service + catalog. -true. The endpoint appears in the service catalog. + type: boolean + id: + description: The endpoint ID + readOnly: true + type: string + interface: + description: 'The interface type, which describes the visibility of + the endpoint. Value is: -public. Visible by end users on a publicly + available network interface. -internal. Visible by end users on an + unmetered internal network interface. -admin. Visible by administrative + users on a secure network interface.' + enum: + - admin + - internal + - public + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the endpoint. + type: string + region: + description: (Deprecated in v3.2) The geographic location of the + service endpoint. + type: + - 'null' + - string + x-openstack: + max-ver: 3.2 + region_id: + description: (Since v3.2) The ID of the region that contains the + service endpoint. + type: + - 'null' + - string + x-openstack: + min-ver: 3.2 + service_id: + description: The UUID of the service to which the endpoint belongs + type: string + url: + description: The endpoint URL. + maxLength: 225 + minLength: 0 + pattern: ^[a-zA-Z0-9+.-]+:.+ + type: string + type: object + type: object EndpointPatch: additionalProperties: false description: An endpoint object @@ -11864,31 +11795,110 @@ components: required: - endpoint type: object - EndpointsGetResponse: + EndpointPatchResponse: + additionalProperties: false + description: An endpoint object properties: - endpoints: - description: |- - A list of `endpoint` objects. - items: - description: |- - An `endpoint` object. - properties: - enabled: - description: |- - Indicates whether the endpoint appears in the - service catalog: - `false`. The endpoint does not appear in the - service catalog. - `true`. The endpoint appears in the service - catalog. - type: boolean - id: - description: |- - The endpoint ID. - format: uuid - readOnly: true - type: string - interface: - description: |- - The interface type, which describes the + endpoint: + additionalProperties: true + description: An endpoint object + properties: + description: + description: A description of the endpoint. + type: + - 'null' + - string + enabled: + description: Indicates whether the endpoint appears in the service + catalog -false. The endpoint does not appear in the service + catalog. -true. The endpoint appears in the service catalog. + type: boolean + id: + description: The endpoint ID + readOnly: true + type: string + interface: + description: 'The interface type, which describes the visibility of + the endpoint. Value is: -public. Visible by end users on a publicly + available network interface. -internal. Visible by end users on an + unmetered internal network interface. -admin. Visible by administrative + users on a secure network interface.' + enum: + - admin + - internal + - public + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the endpoint. + type: string + region: + description: (Deprecated in v3.2) The geographic location of the + service endpoint. + type: + - 'null' + - string + x-openstack: + max-ver: 3.2 + region_id: + description: (Since v3.2) The ID of the region that contains the + service endpoint. + type: + - 'null' + - string + x-openstack: + min-ver: 3.2 + service_id: + description: The UUID of the service to which the endpoint belongs + type: string + url: + description: The endpoint URL. + maxLength: 225 + minLength: 0 + pattern: ^[a-zA-Z0-9+.-]+:.+ + type: string + type: object + type: object + EndpointsGetResponse: + additionalProperties: false + properties: + endpoints: + description: |- + A list of `endpoint` objects. + items: + additionalProperties: true + description: An endpoint object + properties: + description: + description: |- + The endpoint description. It is returned only when set on the + resource. + type: + - 'null' + - string + enabled: + description: |- + Indicates whether the endpoint appears in the + service catalog: - `false`. The endpoint does not appear in the + service catalog. - `true`. The endpoint appears in the service + catalog. + type: boolean + id: + description: |- + The endpoint ID. + readOnly: true + type: string + interface: + description: |- + The interface type, which describes the visibility of the endpoint. Value is: - `public`. Visible by end users on a publicly available network interface. - `internal`. Visible by end users on an unmetered internal @@ -11899,38 +11909,82 @@ components: - internal - public type: string + links: + additionalProperties: false + description: |- + The links for the `endpoints` resource. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: |- + (Deprecated) The endpoint name. The field will only be returned in responses + when set on the resource. + + This field is deprecated as it provides no value. Endpoints are better + described by the combination of service, region and interface they describe + or by their ID. + type: string region: description: |- (Deprecated in v3.2) The geographic location of the service endpoint. - type: string + type: + - 'null' + - string x-openstack: - max-ver: '3.2' + max-ver: 3.2 region_id: description: |- (Since v3.2) The ID of the region that contains the service endpoint. - format: uuid - type: string + type: + - 'null' + - string x-openstack: - min-ver: '3.2' + min-ver: 3.2 service_id: description: |- The UUID of the service to which the endpoint belongs. - format: uuid type: string url: description: |- The endpoint URL. - format: uri + maxLength: 225 + minLength: 0 + pattern: ^[a-zA-Z0-9+.-]+:.+ type: string type: object type: array - type: object - EndpointsOs_Endpoint_PolicyPolicyGetResponse: - description: Response of the - endpoints/endpoint_id/OS-ENDPOINT-POLICY/policy:get operation + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object EndpointsPost: additionalProperties: false @@ -12015,6 +12069,78 @@ components: - url type: object type: object + EndpointsPostResponse: + additionalProperties: false + description: An endpoint object + properties: + endpoint: + additionalProperties: true + description: An endpoint object + properties: + description: + description: A description of the endpoint. + type: + - 'null' + - string + enabled: + description: Indicates whether the endpoint appears in the service + catalog -false. The endpoint does not appear in the service + catalog. -true. The endpoint appears in the service catalog. + type: boolean + id: + description: The endpoint ID + readOnly: true + type: string + interface: + description: 'The interface type, which describes the visibility of + the endpoint. Value is: -public. Visible by end users on a publicly + available network interface. -internal. Visible by end users on an + unmetered internal network interface. -admin. Visible by administrative + users on a secure network interface.' + enum: + - admin + - internal + - public + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the endpoint. + type: string + region: + description: (Deprecated in v3.2) The geographic location of the + service endpoint. + type: + - 'null' + - string + x-openstack: + max-ver: 3.2 + region_id: + description: (Since v3.2) The ID of the region that contains the + service endpoint. + type: + - 'null' + - string + x-openstack: + min-ver: 3.2 + service_id: + description: The UUID of the service to which the endpoint belongs + type: string + url: + description: The endpoint URL. + maxLength: 225 + minLength: 0 + pattern: ^[a-zA-Z0-9+.-]+:.+ + type: string + type: object + type: object GroupGetResponse: additionalProperties: false properties: @@ -12031,7 +12157,7 @@ components: - string domain_id: description: |- - The ID of the domain. + The ID of the domain of the group. type: string id: description: |- @@ -12087,7 +12213,7 @@ components: - string domain_id: description: |- - The ID of the domain. + The ID of the domain of the group. type: string id: description: |- @@ -12109,8 +12235,6 @@ components: A list of `group` objects items: additionalProperties: true - description: |- - A `group` object properties: description: description: |- @@ -12120,7 +12244,7 @@ components: - string domain_id: description: |- - The ID of the domain. + The ID of the domain of the group. type: string id: description: |- @@ -12135,7 +12259,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -12214,7 +12338,7 @@ components: - string domain_id: description: |- - The ID of the domain. + The ID of the domain of the group. type: string id: description: |- @@ -12233,8 +12357,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -12258,16 +12381,11 @@ components: global response limit type: boolean users: - description: |- - A list of `user` objects items: additionalProperties: true - description: |- - A `user` object properties: default_project_id: - description: |- - The ID of the default project for the user. + description: The ID of the default project for the user. type: - 'null' - string @@ -12277,31 +12395,18 @@ components: - 'null' - string domain_id: - description: |- - The ID of the domain. + description: The ID of the domain. type: string enabled: - description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + description: If the user is enabled, this value is true. If the + user is disabled, this value is false. type: boolean federated: - description: |- - List of federated objects associated with a user. Each object in the list - contains the `idp_id` and `protocols`. `protocols` is a list of - objects, each of which contains `protocol_id` and `unique_id` of - the protocol and user respectively. For example: - - ``` - "federated": [ - { - "idp_id": "efbab5a6acad4d108fec6c63d9609d83", - "protocols": [ - {"protocol_id": "mapped", "unique_id": "test@example.com"} - ] - } - ] - ``` + description: List of federated objects associated with a user. + Each object in the list contains the idp_id and protocols. + protocols is a list of objects, each of which contains + protocol_id and unique_id of the protocol and user + respectively. items: properties: idp_id: @@ -12327,13 +12432,11 @@ components: type: object type: array id: - description: |- - The user ID. + description: The user ID. type: string links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -12353,8 +12456,8 @@ components: - self type: object name: - description: |- - The user name. Must be unique within the owning domain. + description: The user name. Must be unique within the owning + domain. type: string options: additionalProperties: false @@ -12420,14 +12523,9 @@ components: uniqueItems: true type: object password_expires_at: - description: |- - The date and time when the password expires. The time zone - is UTC. - - This is a response object attribute; not valid for requests. - A `null` value indicates that the password never expires. - - **New in version 3.7** + description: The date and time when the password expires. The + time zone is UTC. A null value indicates that the password + never expires. format: date-time type: - 'null' @@ -12629,8 +12727,7 @@ components: A list of `limits` objects items: additionalProperties: false - description: |- - A `limit` object + description: A limit object. properties: description: description: |- @@ -12656,8 +12753,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -12705,7 +12801,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -12779,7 +12875,7 @@ components: - string domain_id: description: |- - The name of the domain. + The ID of the domain. Either this or the project ID must be supplied. maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9-]+$ @@ -12788,7 +12884,7 @@ components: - string project_id: description: |- - The ID for the project. + The ID of the project. Either this or the domain ID must be supplied. maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9-]+$ @@ -12839,8 +12935,7 @@ components: A list of `limits` objects items: additionalProperties: false - description: |- - A `limit` object + description: A limit object. properties: description: description: |- @@ -12969,8 +13064,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -13101,8 +13195,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -13117,10 +13210,6 @@ components: type: string type: object type: object - Os_Ep_FilterEndpoint_GroupsEndpointsGetResponse: - description: Response of the - OS-EP-FILTER/endpoint_groups/endpoint_group_id/endpoints:get operation - type: object Os_Ep_FilterEndpoint_GroupsGetResponse: additionalProperties: false properties: @@ -13178,8 +13267,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -13196,8 +13284,7 @@ components: type: array links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -13337,8 +13424,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -13353,11 +13439,6 @@ components: type: string type: object type: object - Os_Ep_FilterEndpoint_GroupsProjectGetResponse: - description: Response of the - OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects/project_id:get - operation - type: object Os_Ep_FilterEndpoint_GroupsProjectPutRequest: description: Request of the OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects/project_id:put @@ -13365,41 +13446,12 @@ components: type: object x-openstack: action-name: PUT - Os_Ep_FilterEndpoint_GroupsProjectPutResponse: - description: Response of the - OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects/project_id:put - operation - type: object - Os_Ep_FilterEndpoint_GroupsProjectsGetResponse: - description: Response of the - OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects:get operation - type: object - Os_Ep_FilterEndpointsProjectsGetResponse: - description: Response of the - OS-EP-FILTER/endpoints/endpoint_id/projects:get operation - type: object - Os_Ep_FilterProjectsEndpointGetResponse: - description: Response of the - OS-EP-FILTER/projects/project_id/endpoints/endpoint_id:get operation - type: object Os_Ep_FilterProjectsEndpointPutRequest: description: Request of the OS-EP-FILTER/projects/project_id/endpoints/endpoint_id:put operation type: object x-openstack: action-name: PUT - Os_Ep_FilterProjectsEndpointPutResponse: - description: Response of the - OS-EP-FILTER/projects/project_id/endpoints/endpoint_id:put operation - type: object - Os_Ep_FilterProjectsEndpoint_GroupsGetResponse: - description: Response of the - OS-EP-FILTER/projects/project_id/endpoint_groups:get operation - type: object - Os_Ep_FilterProjectsEndpointsGetResponse: - description: Response of the - OS-EP-FILTER/projects/project_id/endpoints:get operation - type: object Os_FederationDomainsGetResponse: properties: domains: @@ -13461,33 +13513,102 @@ components: type: array type: object Os_FederationIdentity_ProviderGetResponse: + additionalProperties: true properties: - identity_provider: - properties: - authorization_ttl: - description: The length of validity in minutes for group - memberships carried over through mapping and persisted in the - database. - type: integer - description: - description: The Identity Provider description - type: string - domain_id: - description: The ID of a domain that is associated with the - Identity Provider. - format: uuid - type: string - enabled: - description: Whether the Identity Provider is enabled or not - type: boolean - id: - description: The Identity Provider unique ID - type: string - remote_ids: - description: List of the unique Identity Provider’s remote IDs - items: + identity_providers: + description: A list of identity provider objects + items: + additionalProperties: true + description: An identity provider object + properties: + authorization_ttl: + description: The length of validity in minutes for group + memberships carried over through mapping and persisted in the + database. If left unset, the default value configured in + keystone will be used, if enabled. + minimum: 0 + type: + - integer + - 'null' + description: + description: The identity provider description + type: + - 'null' + - string + enabled: + description: Whether the identity provider is enabled or not + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' + - n + - no + - off + - on + - 'true' + - y + - yes + type: + - boolean + - 'null' + - string + id: + description: The identity provider ID + readOnly: true type: string - type: array + links: + additionalProperties: false + properties: + protocols: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object + remote_ids: + description: List of the unique identity provider's remote IDs + items: + maxLength: 64 + type: string + type: + - array + - 'null' + uniqueItems: true + type: object + type: array + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self type: object type: object Os_FederationIdentity_ProviderPatch: @@ -13553,33 +13674,79 @@ components: - identity_provider type: object Os_FederationIdentity_ProviderPatchResponse: + additionalProperties: false + description: An identity provider object properties: identity_provider: + additionalProperties: true + description: An identity provider object properties: authorization_ttl: description: The length of validity in minutes for group memberships carried over through mapping and persisted in the - database. - type: integer + database. If left unset, the default value configured in + keystone will be used, if enabled. + minimum: 0 + type: + - integer + - 'null' description: - description: The Identity Provider description - type: string - domain_id: - description: The ID of a domain that is associated with the - Identity Provider. - format: uuid - type: string + description: The identity provider description + type: + - 'null' + - string enabled: - description: Whether the Identity Provider is enabled or not - type: boolean + description: Whether the identity provider is enabled or not + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' + - n + - no + - off + - on + - 'true' + - y + - yes + type: + - boolean + - 'null' + - string id: - description: The Identity Provider unique ID + description: The identity provider ID + readOnly: true type: string + links: + additionalProperties: false + properties: + protocols: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object remote_ids: - description: List of the unique Identity Provider’s remote IDs + description: List of the unique identity provider's remote IDs items: + maxLength: 64 type: string - type: array + type: + - array + - 'null' + uniqueItems: true type: object type: object Os_FederationIdentity_ProviderPut: @@ -13653,81 +13820,217 @@ components: type: object type: object Os_FederationIdentity_ProviderPutResponse: + additionalProperties: false + description: An identity provider object properties: identity_provider: + additionalProperties: true + description: An identity provider object properties: authorization_ttl: description: The length of validity in minutes for group memberships carried over through mapping and persisted in the - database. - type: integer + database. If left unset, the default value configured in + keystone will be used, if enabled. + minimum: 0 + type: + - integer + - 'null' description: - description: The Identity Provider description - type: string - domain_id: - description: The ID of a domain that is associated with the - Identity Provider. - format: uuid - type: string + description: The identity provider description + type: + - 'null' + - string enabled: - description: Whether the Identity Provider is enabled or not - type: boolean + description: Whether the identity provider is enabled or not + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' + - n + - no + - off + - on + - 'true' + - y + - yes + type: + - boolean + - 'null' + - string id: - description: The Identity Provider unique ID + description: The identity provider ID + readOnly: true type: string + links: + additionalProperties: false + properties: + protocols: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object remote_ids: - description: List of the unique Identity Provider’s remote IDs + description: List of the unique identity provider's remote IDs items: + maxLength: 64 type: string - type: array + type: + - array + - 'null' + uniqueItems: true type: object type: object Os_FederationIdentity_ProvidersGetResponse: + additionalProperties: true properties: identity_providers: + description: A list of identity provider objects items: + additionalProperties: true + description: An identity provider object properties: authorization_ttl: description: The length of validity in minutes for group memberships carried over through mapping and persisted in the - database. - type: integer + database. If left unset, the default value configured in + keystone will be used, if enabled. + minimum: 0 + type: + - integer + - 'null' description: - description: The Identity Provider description - type: string - domain_id: - description: The ID of a domain that is associated with the - Identity Provider. - format: uuid - type: string + description: The identity provider description + type: + - 'null' + - string enabled: - description: Whether the Identity Provider is enabled or not - type: boolean + description: Whether the identity provider is enabled or not + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' + - n + - no + - off + - on + - 'true' + - y + - yes + type: + - boolean + - 'null' + - string id: - description: The Identity Provider unique ID + description: The identity provider ID + readOnly: true type: string + links: + additionalProperties: false + properties: + protocols: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object remote_ids: - description: List of the unique Identity Provider’s remote IDs + description: List of the unique identity provider's remote IDs items: + maxLength: 64 type: string - type: array + type: + - array + - 'null' + uniqueItems: true type: object type: array + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object type: object Os_FederationIdentity_ProvidersProtocolGetResponse: + additionalProperties: false properties: protocol: + additionalProperties: false + description: A federation protocol object. properties: id: - description: The federation protocol ID - format: uuid + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + links: + additionalProperties: false + properties: + identity_provider: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object mapping_id: + maxLength: 64 + minLength: 1 type: string remote_id_attribute: maxLength: 64 type: string + required: + - id + - mapping_id type: object + required: + - protocol type: object Os_FederationIdentity_ProvidersProtocolPatch: additionalProperties: false @@ -13750,19 +14053,42 @@ components: - protocol type: object Os_FederationIdentity_ProvidersProtocolPatchResponse: + additionalProperties: false properties: protocol: + additionalProperties: false + description: A federation protocol object. properties: id: - description: The federation protocol ID - format: uuid + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + links: + additionalProperties: false + properties: + identity_provider: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object mapping_id: + maxLength: 64 + minLength: 1 type: string remote_id_attribute: maxLength: 64 type: string + required: + - id + - mapping_id type: object + required: + - protocol type: object Os_FederationIdentity_ProvidersProtocolPut: additionalProperties: false @@ -13786,19 +14112,42 @@ components: - protocol type: object Os_FederationIdentity_ProvidersProtocolPutResponse: + additionalProperties: false properties: protocol: + additionalProperties: false + description: A federation protocol object. properties: id: - description: The federation protocol ID - format: uuid + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + links: + additionalProperties: false + properties: + identity_provider: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object mapping_id: + maxLength: 64 + minLength: 1 type: string remote_id_attribute: maxLength: 64 type: string + required: + - id + - mapping_id type: object + required: + - protocol type: object Os_FederationIdentity_ProvidersProtocolsAuthGetResponse: properties: @@ -14044,21 +14393,71 @@ components: type: object type: object Os_FederationIdentity_ProvidersProtocolsGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object protocols: items: + additionalProperties: false + description: A federation protocol object. properties: id: - description: The federation protocol ID - format: uuid + maxLength: 64 + minLength: 1 + type: string + idp_id: + description: The identity provider ID + readOnly: true type: string + links: + additionalProperties: false + properties: + identity_provider: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object mapping_id: + maxLength: 64 + minLength: 1 type: string remote_id_attribute: maxLength: 64 - type: string + type: + - 'null' + - string + required: + - id + - idp_id + - mapping_id + - remote_id_attribute type: object type: array + required: + - protocols type: object Os_FederationMappingGetResponse: properties: @@ -15252,8 +15651,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -15388,8 +15786,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -15526,8 +15923,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -15552,8 +15948,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -15623,8 +16018,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -15649,11 +16043,6 @@ components: global response limit type: boolean type: object - Os_InheritDomainsGroupsRolesInherited_To_ProjectsGetResponse: - description: Response of the - OS-INHERIT/domains/domain_id/groups/group_id/roles/role_id/inherited_to_projects:get - operation - type: object Os_InheritDomainsGroupsRolesInherited_To_ProjectsPutRequest: description: Request of the OS-INHERIT/domains/domain_id/groups/group_id/roles/role_id/inherited_to_projects:put @@ -15661,16 +16050,6 @@ components: type: object x-openstack: action-name: PUT - Os_InheritDomainsGroupsRolesInherited_To_ProjectsPutResponse: - description: Response of the - OS-INHERIT/domains/domain_id/groups/group_id/roles/role_id/inherited_to_projects:put - operation - type: object - Os_InheritDomainsUsersRolesInherited_To_ProjectsGetResponse: - description: Response of the - OS-INHERIT/domains/domain_id/users/user_id/roles/role_id/inherited_to_projects:get - operation - type: object Os_InheritDomainsUsersRolesInherited_To_ProjectsPutRequest: description: Request of the OS-INHERIT/domains/domain_id/users/user_id/roles/role_id/inherited_to_projects:put @@ -15678,16 +16057,6 @@ components: type: object x-openstack: action-name: PUT - Os_InheritDomainsUsersRolesInherited_To_ProjectsPutResponse: - description: Response of the - OS-INHERIT/domains/domain_id/users/user_id/roles/role_id/inherited_to_projects:put - operation - type: object - Os_InheritProjectsGroupsRolesInherited_To_ProjectsGetResponse: - description: Response of the - OS-INHERIT/projects/project_id/groups/group_id/roles/role_id/inherited_to_projects:get - operation - type: object Os_InheritProjectsGroupsRolesInherited_To_ProjectsPutRequest: description: Request of the OS-INHERIT/projects/project_id/groups/group_id/roles/role_id/inherited_to_projects:put @@ -15695,16 +16064,6 @@ components: type: object x-openstack: action-name: PUT - Os_InheritProjectsGroupsRolesInherited_To_ProjectsPutResponse: - description: Response of the - OS-INHERIT/projects/project_id/groups/group_id/roles/role_id/inherited_to_projects:put - operation - type: object - Os_InheritProjectsUsersRolesInherited_To_ProjectsGetResponse: - description: Response of the - OS-INHERIT/projects/project_id/users/user_id/roles/role_id/inherited_to_projects:get - operation - type: object Os_InheritProjectsUsersRolesInherited_To_ProjectsPutRequest: description: Request of the OS-INHERIT/projects/project_id/users/user_id/roles/role_id/inherited_to_projects:put @@ -15712,103 +16071,48 @@ components: type: object x-openstack: action-name: PUT - Os_InheritProjectsUsersRolesInherited_To_ProjectsPutResponse: - description: Response of the - OS-INHERIT/projects/project_id/users/user_id/roles/role_id/inherited_to_projects:put - operation - type: object - Os_Oauth1Access_TokenGetResponse: - description: Response of the OS-OAUTH1/access_token:get operation - type: object Os_Oauth1Access_TokenPostRequest: description: Request of the OS-OAUTH1/access_token:post operation type: object x-openstack: action-name: POST - Os_Oauth1Access_TokenPostResponse: - description: Response of the OS-OAUTH1/access_token:post operation - type: object Os_Oauth1AuthorizePutRequest: description: Request of the OS-OAUTH1/authorize/request_token_id:put operation type: object x-openstack: action-name: PUT - Os_Oauth1AuthorizePutResponse: - description: Response of the OS-OAUTH1/authorize/request_token_id:put - operation - type: object - Os_Oauth1ConsumerGetResponse: - description: Response of the OS-OAUTH1/consumers/consumer_id:get operation - type: object Os_Oauth1ConsumerPatchRequest: description: Request of the OS-OAUTH1/consumers/consumer_id:patch operation type: object x-openstack: action-name: PATCH - Os_Oauth1ConsumerPatchResponse: - description: Response of the OS-OAUTH1/consumers/consumer_id:patch - operation - type: object - Os_Oauth1ConsumersGetResponse: - description: Response of the OS-OAUTH1/consumers:get operation - type: object Os_Oauth1ConsumersPostRequest: description: Request of the OS-OAUTH1/consumers:post operation type: object x-openstack: action-name: POST - Os_Oauth1ConsumersPostResponse: - description: Response of the OS-OAUTH1/consumers:post operation - type: object - Os_Oauth1Request_TokenGetResponse: - description: Response of the OS-OAUTH1/request_token:get operation - type: object Os_Oauth1Request_TokenPostRequest: description: Request of the OS-OAUTH1/request_token:post operation type: object x-openstack: action-name: POST - Os_Oauth1Request_TokenPostResponse: - description: Response of the OS-OAUTH1/request_token:post operation - type: object - Os_Oauth2TokenGetResponse: - description: Response of the OS-OAUTH2/token:get operation - type: object Os_Oauth2TokenPatchRequest: description: Request of the OS-OAUTH2/token:patch operation type: object x-openstack: action-name: PATCH - Os_Oauth2TokenPatchResponse: - description: Response of the OS-OAUTH2/token:patch operation - type: object Os_Oauth2TokenPostRequest: description: Request of the OS-OAUTH2/token:post operation type: object x-openstack: action-name: POST - Os_Oauth2TokenPostResponse: - description: Response of the OS-OAUTH2/token:post operation - type: object Os_Oauth2TokenPutRequest: description: Request of the OS-OAUTH2/token:put operation type: object x-openstack: action-name: PUT - Os_Oauth2TokenPutResponse: - description: Response of the OS-OAUTH2/token:put operation - type: object - Os_RevokeEventsGetResponse: - description: Response of the OS-REVOKE/events:get operation - type: object - Os_Simple_CertCaGetResponse: - description: Response of the OS-SIMPLE-CERT/ca:get operation - type: object - Os_Simple_CertCertificatesGetResponse: - description: Response of the OS-SIMPLE-CERT/certificates:get operation - type: object Os_TrustTrustGetResponse: additionalProperties: false description: A trust object @@ -15852,8 +16156,7 @@ components: type: boolean links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -15945,8 +16248,7 @@ components: type: string links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -15966,8 +16268,7 @@ components: - self type: object name: - description: |- - The resource name. + description: The resource name. maxLength: 255 minLength: 1 pattern: '[\S]+' @@ -15988,8 +16289,7 @@ components: type: array roles_links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16023,8 +16323,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16090,8 +16389,7 @@ components: type: boolean links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16186,8 +16484,7 @@ components: type: string links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16207,8 +16504,7 @@ components: - self type: object name: - description: |- - The resource name. + description: The resource name. maxLength: 255 minLength: 1 pattern: '[\S]+' @@ -16229,8 +16525,7 @@ components: type: array roles_links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16418,8 +16713,7 @@ components: type: boolean links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16511,8 +16805,7 @@ components: type: string links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16532,8 +16825,7 @@ components: - self type: object name: - description: |- - The resource name. + description: The resource name. maxLength: 255 minLength: 1 pattern: '[\S]+' @@ -16554,8 +16846,7 @@ components: type: array roles_links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16584,21 +16875,6 @@ components: type: string type: object type: object - Os_TrustTrustsRoleGetResponse: - description: Response of the OS-TRUST/trusts/trust_id/roles/role_id:get - operation - type: object - Os_TrustTrustsRolesGetResponse: - description: Response of the OS-TRUST/trusts/trust_id/roles:get operation - type: object - PoliciesGetResponse: - description: Response of the policies:get operation - type: object - PoliciesOs_Endpoint_PolicyEndpointGetResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/endpoints/endpoint_id:get - operation - type: object PoliciesOs_Endpoint_PolicyEndpointPutRequest: description: Request of the policies/policy_id/OS-ENDPOINT-POLICY/endpoints/endpoint_id:put @@ -16606,34 +16882,12 @@ components: type: object x-openstack: action-name: PUT - PoliciesOs_Endpoint_PolicyEndpointPutResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/endpoints/endpoint_id:put - operation - type: object - PoliciesOs_Endpoint_PolicyEndpointsGetResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/endpoints:get operation - type: object - PoliciesOs_Endpoint_PolicyServiceGetResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/services/service_id:get operation - type: object PoliciesOs_Endpoint_PolicyServicePutRequest: description: Request of the policies/policy_id/OS-ENDPOINT-POLICY/services/service_id:put operation type: object x-openstack: action-name: PUT - PoliciesOs_Endpoint_PolicyServicePutResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/services/service_id:put operation - type: object - PoliciesOs_Endpoint_PolicyServicesRegionGetResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/services/service_id/regions/region_id:get - operation - type: object PoliciesOs_Endpoint_PolicyServicesRegionPutRequest: description: Request of the policies/policy_id/OS-ENDPOINT-POLICY/services/service_id/regions/region_id:put @@ -16641,30 +16895,16 @@ components: type: object x-openstack: action-name: PUT - PoliciesOs_Endpoint_PolicyServicesRegionPutResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/services/service_id/regions/region_id:put - operation - type: object PoliciesPostRequest: description: Request of the policies:post operation type: object x-openstack: action-name: POST - PoliciesPostResponse: - description: Response of the policies:post operation - type: object - PolicyGetResponse: - description: Response of the policies/policy_id:get operation - type: object PolicyPatchRequest: description: Request of the policies/policy_id:patch operation type: object x-openstack: action-name: PATCH - PolicyPatchResponse: - description: Response of the policies/policy_id:patch operation - type: object ProjectGetResponse: additionalProperties: false properties: @@ -16690,8 +16930,8 @@ components: - string enabled: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -16725,8 +16965,8 @@ components: type: string is_domain: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -16797,8 +17037,6 @@ components: - 'null' - string tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -16916,8 +17154,8 @@ components: - string enabled: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -16951,8 +17189,8 @@ components: type: string is_domain: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17023,8 +17261,6 @@ components: - 'null' - string tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -17041,8 +17277,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -17066,8 +17301,6 @@ components: A list of `project` objects items: additionalProperties: true - description: |- - A `project` object properties: description: description: |- @@ -17086,8 +17319,8 @@ components: - string enabled: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17121,8 +17354,8 @@ components: type: string is_domain: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17168,9 +17401,6 @@ components: type: string options: additionalProperties: false - description: |- - The resource options for the project. Available resource options are - `immutable`. properties: immutable: enum: @@ -17211,6 +17441,81 @@ components: global response limit type: boolean type: object + ProjectsGroupsRolesGetResponse: + additionalProperties: false + properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + roles: + items: + additionalProperties: false + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean + type: object ProjectsPost: additionalProperties: false properties: @@ -17391,8 +17696,8 @@ components: - string enabled: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17426,8 +17731,8 @@ components: type: string is_domain: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17498,8 +17803,6 @@ components: - 'null' - string tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -17516,8 +17819,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -17561,8 +17863,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -17588,6 +17889,81 @@ components: type: string type: array type: object + ProjectsUsersRolesGetResponse: + additionalProperties: false + properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + roles: + items: + additionalProperties: false + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean + type: object Region: properties: region: @@ -17611,6 +17987,52 @@ components: type: string type: object type: object + RegionGetResponse: + additionalProperties: false + properties: + region: + additionalProperties: true + description: A region object. + properties: + description: + description: The resource description. + maxLength: 255 + type: + - 'null' + - string + id: + description: The region ID. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + parent_region_id: + description: To make this region a child of another region, set + this parameter to the ID of the parent region. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + required: + - description + - id + - links + - parent_region_id + type: object + required: + - region + type: object RegionPatch: additionalProperties: false properties: @@ -17647,6 +18069,52 @@ components: required: - region type: object + RegionPatchResponse: + additionalProperties: false + properties: + region: + additionalProperties: true + description: A region object. + properties: + description: + description: The resource description. + maxLength: 255 + type: + - 'null' + - string + id: + description: The region ID. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + parent_region_id: + description: To make this region a child of another region, set + this parameter to the ID of the parent region. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + required: + - description + - id + - links + - parent_region_id + type: object + required: + - region + type: object RegionPut: additionalProperties: false properties: @@ -17700,8 +18168,7 @@ components: - string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -17726,64 +18193,162 @@ components: - region type: object RegionsGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: |- + The links for the `region` resource. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object regions: description: |- A list of `region` object items: - description: |- - A `region` object + additionalProperties: true + description: A region object. properties: description: description: |- The region description. - type: string + maxLength: 255 + type: + - 'null' + - string id: description: |- The ID for the region. - format: uuid + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string readOnly: true - type: string - parent_id: - description: To make this region a child of another region, set - this parameter to the ID of the parent region. - format: uuid - type: string + type: object + parent_region_id: + description: |- + To make this region a child of another region, + set this parameter to the ID of the parent region. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + required: + - description + - id + - links + - parent_region_id type: object type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean + required: + - regions + type: object + RegionsPost: + additionalProperties: false + properties: + region: + additionalProperties: true + description: |- + A `region` object + properties: + description: + description: |- + The region description. + maxLength: 255 + type: + - 'null' + - string + id: + description: |- + The ID for the region. + maxLength: 255 + minLength: 0 + type: + - 'null' + - string + parent_region_id: + description: |- + To make this region a child of another region, + set this parameter to the ID of the parent region. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + type: object + required: + - region type: object - RegionsPost: + RegionsPostResponse: additionalProperties: false properties: region: additionalProperties: true - description: |- - A `region` object + description: A region object. properties: description: - description: |- - The region description. + description: The resource description. maxLength: 255 type: - 'null' - string id: - description: |- - The ID for the region. + description: The region ID. maxLength: 255 - minLength: 0 + minLength: 1 type: - 'null' - string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object parent_region_id: - description: |- - To make this region a child of another region, - set this parameter to the ID of the parent region. + description: To make this region a child of another region, set + this parameter to the ID of the parent region. maxLength: 255 minLength: 1 type: - 'null' - string + required: + - description + - id + - links + - parent_region_id type: object required: - region @@ -17968,7 +18533,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -17992,8 +18557,7 @@ components: A list of `registered_limits` objects items: additionalProperties: false - description: |- - A `registered_limit` objects + description: A registered limit object. properties: default_limit: description: |- @@ -18016,8 +18580,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -18114,8 +18677,7 @@ components: A list of `registered_limits` objects items: additionalProperties: false - description: |- - A `registered_limit` objects + description: A registered limit object. properties: default_limit: description: |- @@ -18236,6 +18798,54 @@ components: type: object type: object type: object + RoleGetResponse: + additionalProperties: false + properties: + role: + additionalProperties: true + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: object RolePatch: additionalProperties: false properties: @@ -18285,13 +18895,60 @@ components: required: - role type: object + RolePatchResponse: + additionalProperties: false + properties: + role: + additionalProperties: true + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: object Role_AssignmentsGetResponse: additionalProperties: false properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -18477,86 +19134,125 @@ components: type: boolean type: object Role_InferencesGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object role_inferences: + additionalProperties: false description: |- An array of `role_inference` object. items: + additionalProperties: false properties: implies: description: |- An implied role object. items: - description: |- - A prior role object. + additionalProperties: false + description: An implied role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: array prior_role: + additionalProperties: false description: |- A prior role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: object type: array type: object RolesGetResponse: + additionalProperties: false properties: links: - additionalProperties: - format: uri - type: - - 'null' - - string + additionalProperties: false + description: |- + The link to the resources in question. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self type: object roles: description: |- A list of `role` objects items: - description: |- - A `role` object + additionalProperties: true + description: A role object. properties: description: description: |- @@ -18567,26 +19263,20 @@ components: domain_id: description: |- The ID of the domain. - maxLength: 64 - minLength: 1 - pattern: ^[a-zA-Z0-9-]+$ type: - 'null' - string id: description: |- The role ID. - format: uuid - readOnly: true type: string links: - additionalProperties: - format: uri - type: - - 'null' - - string - description: |- - The link to the resources in question. + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string readOnly: true type: object name: @@ -18594,13 +19284,9 @@ components: The role name. maxLength: 255 minLength: 1 - pattern: '[\S]+' type: string options: additionalProperties: false - description: |- - The resource options for the role. Available resource options are - `immutable`. properties: immutable: enum: @@ -18613,10 +19299,37 @@ components: type: object type: object type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object RolesImpliesGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object role_inference: + additionalProperties: false description: |- Role inference object that contains `prior_role` object and `implies` object. @@ -18625,178 +19338,220 @@ components: description: |- An array of implied role objects. items: - description: |- - A prior role object. + additionalProperties: false + description: An implied role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: - description: |- - The link to the resources in question. + additionalProperties: false + description: The link to the resource in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: array prior_role: + additionalProperties: false description: |- A prior role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: object type: object RolesImplyGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object role_inference: + additionalProperties: false description: |- Role inference object that contains `prior_role` object and `implies` object. properties: implies: + additionalProperties: false description: |- - A prior role object. + An implied role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: - description: |- - The link to the resources in question. + additionalProperties: false + description: The link to the resource in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object prior_role: + additionalProperties: false description: |- A prior role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: object type: object RolesImplyPutResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object role_inference: + additionalProperties: false description: |- Role inference object that contains `prior_role` object and `implies` object. properties: implies: + additionalProperties: false description: |- - A prior role object. + An implied role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: - description: |- - The link to the resources in question. + additionalProperties: false + description: The link to the resource in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object prior_role: + additionalProperties: false description: |- A prior role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: object @@ -18815,8 +19570,6 @@ components: description: |- A list of `role` objects items: - description: |- - A prior role object. properties: description: description: The role description. @@ -18893,20 +19646,59 @@ components: required: - role type: object - RootGetResponse: - description: Response of the versions:get operation - type: object - S3TokensGetResponse: - description: Response of the s3tokens:get operation + RolesPostResponse: + additionalProperties: false + properties: + role: + additionalProperties: true + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object type: object S3TokensPostRequest: description: Request of the s3tokens:post operation type: object x-openstack: action-name: POST - S3TokensPostResponse: - description: Response of the s3tokens:post operation - type: object Service: properties: service: @@ -18918,11 +19710,8 @@ components: The service description. type: string enabled: - description: |- - Defines whether the service and its endpoints - appear in the service catalog: - `false`. The service and its - endpoints do not appear in the service catalog. - `true`. The - service and its endpoints appear in the service catalog. + description: Defines whether the service and its endpoints appear + in the service catalog. type: boolean id: description: |- @@ -18943,6 +19732,47 @@ components: type: string type: object type: object + ServiceGetResponse: + additionalProperties: false + description: A service object. + properties: + service: + additionalProperties: true + description: A service object + properties: + enabled: + description: Defines whether the service and its endpoints appear + in the service catalog - false. The service and its endpoints do + not appear in the service catalog - true. + type: boolean + id: + description: The UUID of the service to which the endpoint + belongs. + readOnly: true + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The service name. + maxLength: 255 + minLength: 0 + type: string + type: + description: The service type, which describes the API implemented + by the service. Value is compute, ec2, identity, image, network, + or volume. + maxLength: 255 + minLength: 1 + type: string + type: object + type: object ServicePatch: description: A service object. properties: @@ -18978,19 +19808,78 @@ components: required: - service type: object + ServicePatchResponse: + additionalProperties: false + description: A service object. + properties: + service: + additionalProperties: true + description: A service object + properties: + enabled: + description: Defines whether the service and its endpoints appear + in the service catalog - false. The service and its endpoints do + not appear in the service catalog - true. + type: boolean + id: + description: The UUID of the service to which the endpoint + belongs. + readOnly: true + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The service name. + maxLength: 255 + minLength: 0 + type: string + type: + description: The service type, which describes the API implemented + by the service. Value is compute, ec2, identity, image, network, + or volume. + maxLength: 255 + minLength: 1 + type: string + type: object + type: object ServicesGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object services: description: |- A list of `service` object. items: - description: |- - A `service` object. + additionalProperties: true + description: A service object properties: - description: - description: |- - The service description. - type: string enabled: description: |- Defines whether the service and its endpoints @@ -19002,21 +19891,38 @@ components: description: |- The UUID of the service to which the endpoint belongs. - format: uuid readOnly: true type: string + links: + additionalProperties: false + description: |- + The links for the `service` resource. + properties: + self: + format: uri + type: string + readOnly: true + type: object name: description: |- The service name. + maxLength: 255 + minLength: 0 type: string type: description: |- The service type, which describes the API implemented by the service. Value is `compute`, `ec2`, `identity`, `image`, `network`, or `volume`. + maxLength: 255 + minLength: 1 type: string type: object type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object ServicesPost: description: A service object. @@ -19034,21 +19940,62 @@ components: service and its endpoints appear in the service catalog. type: boolean name: - description: |- - The service name. + description: |- + The service name. + maxLength: 255 + minLength: 1 + type: string + type: + description: |- + The service type, which describes the API + implemented by the service. Value is `compute`, `ec2`, + `identity`, `image`, `network`, or `volume`. + maxLength: 255 + minLength: 1 + type: string + required: + - type + type: object + type: object + ServicesPostResponse: + additionalProperties: false + description: A service object. + properties: + service: + additionalProperties: true + description: A service object + properties: + enabled: + description: Defines whether the service and its endpoints appear + in the service catalog - false. The service and its endpoints do + not appear in the service catalog - true. + type: boolean + id: + description: The UUID of the service to which the endpoint + belongs. + readOnly: true + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The service name. maxLength: 255 - minLength: 1 + minLength: 0 type: string type: - description: |- - The service type, which describes the API - implemented by the service. Value is `compute`, `ec2`, - `identity`, `image`, `network`, or `volume`. + description: The service type, which describes the API implemented + by the service. Value is compute, ec2, identity, image, network, + or volume. maxLength: 255 minLength: 1 type: string - required: - - type type: object type: object SystemGroupsRolesGetResponse: @@ -19057,7 +20004,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -19099,8 +20046,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -19137,7 +20083,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -19179,8 +20125,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -19778,8 +20723,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -19830,8 +20774,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -19869,8 +20812,7 @@ components: type: array links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -19899,20 +20841,47 @@ components: type: object UsersApplication_CredentialGetResponse: additionalProperties: false + description: An application credential object. properties: application_credential: + additionalProperties: false + description: An application credential object. properties: access_rules: - description: A list of access_rules objects + description: A list of access_rules objects. items: properties: id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string method: + description: The request method that the application + credential is permitted to use for a given API endpoint. + enum: + - DELETE + - GET + - HEAD + - PATCH + - POST + - PUT type: string path: + description: The API path that the application credential is + permitted to access. + maxLength: 225 + minLength: 0 + pattern: ^/\.* type: string service: + description: The service type identifier for the service + that the application credential is permitted to access. + Must be a service type that is listed in the service + catalog and not a code name for a service. + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string type: object type: array @@ -19923,63 +20892,132 @@ components: - 'null' - string expires_at: + description: The expiration time of the application credential, if + one was specified. type: - 'null' - string id: - description: The ID of the application credential. - format: uuid + description: The UUID of the application credential readOnly: true type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object name: description: The name of the application credential. Must be unique to a user. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string project_id: description: The ID of the project the application credential was created for and that authentication requests using this application credential will be scoped to. - format: uuid type: string roles: - description: An optional list of role objects, identified by ID or - name. The list may only contain roles that the user has assigned - on the project. If not provided, the roles assigned to the - application credential will be the same as the roles in the - current token. + description: A list of one or more roles that this application + credential has associated with its project. A token using this + application credential will have these same roles. items: + additionalProperties: false properties: + description: + description: A description about the role. + type: + - 'null' + - string + domain_id: + description: The ID of the domain of the role. + type: + - 'null' + - string id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string name: + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + options: + description: The resource options for the role. Available + resource options are immutable. + type: + - 'null' + - object type: object type: array + system: + type: + - 'null' + - string unrestricted: - description: An optional flag to restrict whether the application - credential may be used for the creation or destruction of other - application credentials or trusts. Defaults to false. - type: boolean + description: A flag indicating whether the application credential + may be used for creation or destruction of other application + credentials or trusts. + type: + - boolean + - 'null' + user_id: + description: The ID of the user. + type: string type: object - required: - - application_credential type: object UsersApplication_CredentialsGetResponse: + additionalProperties: false properties: application_credentials: + description: A list of application credentials items: + additionalProperties: false + description: An application credential object. properties: access_rules: - description: A list of access_rules objects + description: A list of access_rules objects. items: properties: id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string method: + description: The request method that the application + credential is permitted to use for a given API endpoint. + enum: + - DELETE + - GET + - HEAD + - PATCH + - POST + - PUT type: string path: + description: The API path that the application credential + is permitted to access. + maxLength: 225 + minLength: 0 + pattern: ^/\.* type: string service: + description: The service type identifier for the service + that the application credential is permitted to access. + Must be a service type that is listed in the service + catalog and not a code name for a service. + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string type: object type: array @@ -19990,48 +21028,113 @@ components: - 'null' - string expires_at: + description: The expiration time of the application credential, + if one was specified. type: - 'null' - string id: - description: The ID of the application credential. - format: uuid + description: The UUID of the application credential readOnly: true type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object name: description: The name of the application credential. Must be unique to a user. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string project_id: description: The ID of the project the application credential was created for and that authentication requests using this application credential will be scoped to. - format: uuid type: string roles: - description: An optional list of role objects, identified by ID - or name. The list may only contain roles that the user has - assigned on the project. If not provided, the roles assigned - to the application credential will be the same as the roles in - the current token. + description: A list of one or more roles that this application + credential has associated with its project. A token using this + application credential will have these same roles. items: + additionalProperties: false properties: + description: + description: A description about the role. + type: + - 'null' + - string + domain_id: + description: The ID of the domain of the role. + type: + - 'null' + - string id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string name: + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + options: + description: The resource options for the role. Available + resource options are immutable. + type: + - 'null' + - object type: object type: array + system: + type: + - 'null' + - string unrestricted: - description: An optional flag to restrict whether the - application credential may be used for the creation or - destruction of other application credentials or trusts. - Defaults to false. - type: boolean + description: A flag indicating whether the application + credential may be used for creation or destruction of other + application credentials or trusts. + type: + - boolean + - 'null' + user_id: + description: The ID of the user. + type: string type: object type: array - required: - - application_credentials + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object UsersApplication_CredentialsPost: additionalProperties: false @@ -20160,20 +21263,47 @@ components: type: object UsersApplication_CredentialsPostResponse: additionalProperties: false + description: An application credential object. properties: application_credential: + additionalProperties: false + description: An application credential object. properties: access_rules: - description: A list of access_rules objects + description: A list of access_rules objects. items: properties: id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string method: + description: The request method that the application + credential is permitted to use for a given API endpoint. + enum: + - DELETE + - GET + - HEAD + - PATCH + - POST + - PUT type: string path: + description: The API path that the application credential is + permitted to access. + maxLength: 225 + minLength: 0 + pattern: ^/\.* type: string service: + description: The service type identifier for the service + that the application credential is permitted to access. + Must be a service type that is listed in the service + catalog and not a code name for a service. + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string type: object type: array @@ -20184,57 +21314,91 @@ components: - 'null' - string expires_at: + description: The expiration time of the application credential, if + one was specified. type: - 'null' - string id: - description: The ID of the application credential. - format: uuid + description: The UUID of the application credential readOnly: true type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object name: description: The name of the application credential. Must be unique to a user. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string project_id: description: The ID of the project the application credential was created for and that authentication requests using this application credential will be scoped to. - format: uuid type: string roles: - description: An optional list of role objects, identified by ID or - name. The list may only contain roles that the user has assigned - on the project. If not provided, the roles assigned to the - application credential will be the same as the roles in the - current token. + description: A list of one or more roles that this application + credential has associated with its project. A token using this + application credential will have these same roles. items: + additionalProperties: false properties: + description: + description: A description about the role. + type: + - 'null' + - string + domain_id: + description: The ID of the domain of the role. + type: + - 'null' + - string id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string name: + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + options: + description: The resource options for the role. Available + resource options are immutable. + type: + - 'null' + - object type: object type: array secret: - description: The secret for the application credential, either - generated by the server or provided by the user. This is only - ever shown once in the response to a create request. It is not - stored nor ever shown again. If the secret is lost, a new - application credential must be created. + description: The secret that the application credential will be + created with. type: string + system: + type: + - 'null' + - string unrestricted: - description: An optional flag to restrict whether the application - credential may be used for the creation or destruction of other - application credentials or trusts. Defaults to false. - type: boolean + description: A flag indicating whether the application credential + may be used for creation or destruction of other application + credentials or trusts. + type: + - boolean + - 'null' + user_id: + description: The ID of the user. + type: string type: object - required: - - application_credential - type: object - UsersCredentialsOs_Ec2GetResponse: - description: Response of the users/user_id/credentials/OS-EC2:get - operation type: object UsersCredentialsOs_Ec2PostRequest: description: Request of the users/user_id/credentials/OS-EC2:post @@ -20242,17 +21406,12 @@ components: type: object x-openstack: action-name: POST - UsersCredentialsOs_Ec2PostResponse: - description: Response of the users/user_id/credentials/OS-EC2:post - operation - type: object UsersGetResponse: additionalProperties: false properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -20280,8 +21439,6 @@ components: A list of `user` objects items: additionalProperties: true - description: |- - A `user` object properties: default_project_id: description: |- @@ -20304,22 +21461,11 @@ components: If the user is disabled, this value is `false`. type: boolean federated: - description: |- - List of federated objects associated with a user. Each object in the list - contains the `idp_id` and `protocols`. `protocols` is a list of - objects, each of which contains `protocol_id` and `unique_id` of - the protocol and user respectively. For example: - - ``` - "federated": [ - { - "idp_id": "efbab5a6acad4d108fec6c63d9609d83", - "protocols": [ - {"protocol_id": "mapped", "unique_id": "test@example.com"} - ] - } - ] - ``` + description: List of federated objects associated with a user. + Each object in the list contains the idp_id and protocols. + protocols is a list of objects, each of which contains + protocol_id and unique_id of the protocol and user + respectively. items: properties: idp_id: @@ -20496,24 +21642,6 @@ components: type: object type: array type: object - UsersOs_Oauth1Access_TokenGetResponse: - description: Response of the - users/user_id/OS-OAUTH1/access_tokens/access_token_id:get operation - type: object - UsersOs_Oauth1Access_TokensGetResponse: - description: Response of the users/user_id/OS-OAUTH1/access_tokens:get - operation - type: object - UsersOs_Oauth1Access_TokensRoleGetResponse: - description: Response of the - users/user_id/OS-OAUTH1/access_tokens/access_token_id/roles/role_id:get - operation - type: object - UsersOs_Oauth1Access_TokensRolesGetResponse: - description: Response of the - users/user_id/OS-OAUTH1/access_tokens/access_token_id/roles:get - operation - type: object UsersPasswordPostRequest: properties: user: diff --git a/openstack_types/data/identity/v3.yaml b/openstack_types/data/identity/v3.yaml index ad5238bcd..b052977c9 100644 --- a/openstack_types/data/identity/v3.yaml +++ b/openstack_types/data/identity/v3.yaml @@ -12,10 +12,6 @@ paths: operationId: versions:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RootGetResponse' description: Ok '403': description: Error @@ -43,10 +39,6 @@ paths: operationId: version:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RootGetResponse' description: Ok '403': description: Error @@ -211,10 +203,6 @@ paths: operationId: OS-EP-FILTER/endpoint_groups/endpoint_group_id/endpoints:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsEndpointsGetResponse' description: Ok '403': description: Error @@ -244,10 +232,6 @@ paths: operationId: OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsProjectsGetResponse' description: Ok '403': description: Error @@ -292,10 +276,6 @@ paths: OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects/project_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsProjectGetResponse' description: Ok '403': description: Error @@ -332,10 +312,6 @@ paths: $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsProjectPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpoint_GroupsProjectPutResponse' description: Ok '403': description: Error @@ -350,10 +326,6 @@ paths: operationId: OS-EP-FILTER/endpoints/endpoint_id/projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterEndpointsProjectsGetResponse' description: Ok '403': description: Error @@ -383,10 +355,6 @@ paths: operationId: OS-EP-FILTER/projects/project_id/endpoint_groups:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpoint_GroupsGetResponse' description: Ok '403': description: Error @@ -416,10 +384,6 @@ paths: operationId: OS-EP-FILTER/projects/project_id/endpoints:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpointsGetResponse' description: Ok '403': description: Error @@ -462,10 +426,6 @@ paths: operationId: OS-EP-FILTER/projects/project_id/endpoints/endpoint_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpointGetResponse' description: Ok '403': description: Error @@ -500,10 +460,6 @@ paths: $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpointPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Ep_FilterProjectsEndpointPutResponse' description: Ok '403': description: Error @@ -1256,10 +1212,6 @@ paths: OS-INHERIT/domains/domain_id/groups/group_id/roles/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsGroupsRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1317,10 +1269,6 @@ paths: OS-INHERIT/domains/domain_id/groups/group_id/roles/role_id/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsGroupsRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1366,10 +1314,6 @@ paths: $ref: '#/components/schemas/Os_InheritDomainsGroupsRolesInherited_To_ProjectsPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsGroupsRolesInherited_To_ProjectsPutResponse' description: Ok '403': description: Error @@ -1390,10 +1334,6 @@ paths: OS-INHERIT/domains/domain_id/users/user_id/roles/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsUsersRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1451,10 +1391,6 @@ paths: OS-INHERIT/domains/domain_id/users/user_id/roles/role_id/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsUsersRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1502,10 +1438,6 @@ paths: $ref: '#/components/schemas/Os_InheritDomainsUsersRolesInherited_To_ProjectsPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritDomainsUsersRolesInherited_To_ProjectsPutResponse' description: Ok '403': description: Error @@ -1541,10 +1473,6 @@ paths: OS-INHERIT/projects/project_id/groups/group_id/roles/role_id/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritProjectsGroupsRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1590,10 +1518,6 @@ paths: $ref: '#/components/schemas/Os_InheritProjectsGroupsRolesInherited_To_ProjectsPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritProjectsGroupsRolesInherited_To_ProjectsPutResponse' description: Ok '403': description: Error @@ -1629,10 +1553,6 @@ paths: OS-INHERIT/projects/project_id/users/user_id/roles/role_id/inherited_to_projects:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritProjectsUsersRolesInherited_To_ProjectsGetResponse' description: Ok '403': description: Error @@ -1678,10 +1598,6 @@ paths: $ref: '#/components/schemas/Os_InheritProjectsUsersRolesInherited_To_ProjectsPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_InheritProjectsUsersRolesInherited_To_ProjectsPutResponse' description: Ok '403': description: Error @@ -1697,10 +1613,6 @@ paths: operationId: OS-OAUTH1/access_token:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1Access_TokenGetResponse' description: Ok '403': description: Error @@ -1732,10 +1644,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1Access_TokenPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1Access_TokenPostResponse' description: Ok '403': description: Error @@ -1757,10 +1665,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1AuthorizePutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1AuthorizePutResponse' description: Ok '403': description: Error @@ -1775,10 +1679,6 @@ paths: operationId: OS-OAUTH1/consumers:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1ConsumersGetResponse' description: Ok '403': description: Error @@ -1810,10 +1710,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1ConsumersPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1ConsumersPostResponse' description: Ok '403': description: Error @@ -1841,10 +1737,6 @@ paths: operationId: OS-OAUTH1/consumers/consumer_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1ConsumerGetResponse' description: Ok '403': description: Error @@ -1878,10 +1770,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1ConsumerPatchRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1ConsumerPatchResponse' description: Ok '403': description: Error @@ -1896,10 +1784,6 @@ paths: operationId: OS-OAUTH1/request_token:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1Request_TokenGetResponse' description: Ok '403': description: Error @@ -1931,10 +1815,6 @@ paths: $ref: '#/components/schemas/Os_Oauth1Request_TokenPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth1Request_TokenPostResponse' description: Ok '403': description: Error @@ -1962,10 +1842,6 @@ paths: operationId: OS-OAUTH2/token:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth2TokenGetResponse' description: Ok '403': description: Error @@ -1997,10 +1873,6 @@ paths: $ref: '#/components/schemas/Os_Oauth2TokenPatchRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth2TokenPatchResponse' description: Ok '403': description: Error @@ -2021,10 +1893,6 @@ paths: $ref: '#/components/schemas/Os_Oauth2TokenPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth2TokenPostResponse' description: Ok '403': description: Error @@ -2043,10 +1911,6 @@ paths: $ref: '#/components/schemas/Os_Oauth2TokenPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Oauth2TokenPutResponse' description: Ok '403': description: Error @@ -2061,10 +1925,6 @@ paths: operationId: OS-REVOKE/events:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_RevokeEventsGetResponse' description: Ok '403': description: Error @@ -2092,10 +1952,6 @@ paths: operationId: OS-SIMPLE-CERT/ca:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Simple_CertCaGetResponse' description: Ok '403': description: Error @@ -2123,10 +1979,6 @@ paths: operationId: OS-SIMPLE-CERT/certificates:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Simple_CertCertificatesGetResponse' description: Ok '403': description: Error @@ -2273,10 +2125,6 @@ paths: operationId: OS-TRUST/trusts/trust_id/roles:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_TrustTrustsRolesGetResponse' description: Ok '403': description: Error @@ -2306,10 +2154,6 @@ paths: operationId: OS-TRUST/trusts/trust_id/roles/role_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_TrustTrustsRoleGetResponse' description: Ok '403': description: Error @@ -2394,10 +2238,6 @@ paths: operationId: auth/OS-FEDERATION/saml2:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AuthOs_FederationSaml2GetResponse' description: Ok '403': description: Error @@ -2449,10 +2289,6 @@ paths: operationId: auth/OS-FEDERATION/saml2/ecp:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AuthOs_FederationSaml2EcpGetResponse' description: Ok '403': description: Error @@ -2843,10 +2679,6 @@ paths: operationId: auth/tokens/OS-PKI/revoked:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/AuthTokensOs_PkiRevokedGetResponse' description: Ok '403': description: Error @@ -3820,10 +3652,6 @@ paths: operationId: ec2tokens:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Ec2TokensGetResponse' description: Ok '403': description: Error @@ -3857,10 +3685,6 @@ paths: $ref: '#/components/schemas/Ec2TokensPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Ec2TokensPostResponse' description: Ok '403': description: Error @@ -4024,10 +3848,6 @@ paths: operationId: endpoints/endpoint_id/OS-ENDPOINT-POLICY/policy:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/EndpointsOs_Endpoint_PolicyPolicyGetResponse' description: Ok '403': description: Error @@ -4512,10 +4332,6 @@ paths: operationId: policies:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesGetResponse' description: Ok '403': description: Error @@ -4550,10 +4366,6 @@ paths: $ref: '#/components/schemas/PoliciesPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesPostResponse' description: Ok '403': description: Error @@ -4587,10 +4399,6 @@ paths: operationId: policies/policy_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyGetResponse' description: Ok '403': description: Error @@ -4627,10 +4435,6 @@ paths: $ref: '#/components/schemas/PolicyPatchRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PolicyPatchResponse' description: Ok '403': description: Error @@ -4646,10 +4450,6 @@ paths: operationId: policies/policy_id/OS-ENDPOINT-POLICY/endpoints:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyEndpointsGetResponse' description: Ok '403': description: Error @@ -4694,10 +4494,6 @@ paths: policies/policy_id/OS-ENDPOINT-POLICY/endpoints/endpoint_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyEndpointGetResponse' description: Ok '403': description: Error @@ -4734,10 +4530,6 @@ paths: $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyEndpointPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyEndpointPutResponse' description: Ok '403': description: Error @@ -4766,10 +4558,6 @@ paths: operationId: policies/policy_id/OS-ENDPOINT-POLICY/services/service_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServiceGetResponse' description: Ok '403': description: Error @@ -4805,10 +4593,6 @@ paths: $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicePutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicePutResponse' description: Ok '403': description: Error @@ -4838,10 +4622,6 @@ paths: policies/policy_id/OS-ENDPOINT-POLICY/services/service_id/regions/region_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicesRegionGetResponse' description: Ok '403': description: Error @@ -4879,10 +4659,6 @@ paths: $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicesRegionPutRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/PoliciesOs_Endpoint_PolicyServicesRegionPutResponse' description: Ok '403': description: Error @@ -6177,10 +5953,6 @@ paths: operationId: s3tokens:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/S3TokensGetResponse' description: Ok '403': description: Error @@ -6214,10 +5986,6 @@ paths: $ref: '#/components/schemas/S3TokensPostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/S3TokensPostResponse' description: Ok '403': description: Error @@ -6765,10 +6533,6 @@ paths: operationId: users/user_id/OS-OAUTH1/access_tokens:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersOs_Oauth1Access_TokensGetResponse' description: Ok '403': description: Error @@ -6817,10 +6581,6 @@ paths: operationId: users/user_id/OS-OAUTH1/access_tokens/access_token_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersOs_Oauth1Access_TokenGetResponse' description: Ok '403': description: Error @@ -6857,10 +6617,6 @@ paths: users/user_id/OS-OAUTH1/access_tokens/access_token_id/roles:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersOs_Oauth1Access_TokensRolesGetResponse' description: Ok '403': description: Error @@ -6899,10 +6655,6 @@ paths: users/user_id/OS-OAUTH1/access_tokens/access_token_id/roles/role_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersOs_Oauth1Access_TokensRoleGetResponse' description: Ok '403': description: Error @@ -7169,10 +6921,6 @@ paths: operationId: users/user_id/credentials/OS-EC2:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersCredentialsOs_Ec2GetResponse' description: Ok '403': description: Error @@ -7210,10 +6958,6 @@ paths: $ref: '#/components/schemas/UsersCredentialsOs_Ec2PostRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersCredentialsOs_Ec2PostResponse' description: Ok '403': description: Error @@ -7245,10 +6989,6 @@ paths: operationId: users/user_id/credentials/OS-EC2/credential_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/UsersCredentialsOs_Ec2GetResponse' description: Ok '403': description: Error @@ -9387,9 +9127,6 @@ components: type: object type: object type: object - AuthOs_FederationSaml2EcpGetResponse: - description: Response of the auth/OS-FEDERATION/saml2/ecp:get operation - type: object AuthOs_FederationSaml2EcpPostRequest: definitions: user_domain: @@ -9607,9 +9344,6 @@ components: description: SAML assertion in XML format format: xml type: string - AuthOs_FederationSaml2GetResponse: - description: Response of the auth/OS-FEDERATION/saml2:get operation - type: object AuthOs_FederationSaml2PostRequest: definitions: user_domain: @@ -10386,9 +10120,6 @@ components: type: object type: object type: object - AuthTokensOs_PkiRevokedGetResponse: - description: Response of the auth/tokens/OS-PKI/revoked:get operation - type: object AuthTokensPostRequest: definitions: user_domain: @@ -10811,7 +10542,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links for the `credential` resource. properties: self: format: uri @@ -10888,7 +10619,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links for the `credential` resource. properties: self: format: uri @@ -10920,8 +10651,7 @@ components: A list of `credential` objects. items: additionalProperties: true - description: |- - A `credential` object. + description: A credential object. properties: blob: description: |- @@ -10935,7 +10665,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links for the `credentials` resource. properties: self: format: uri @@ -10961,8 +10691,7 @@ components: type: array links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -11056,7 +10785,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links for the `credential` resource. properties: self: format: uri @@ -11163,7 +10892,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links to the `domain` resource. properties: self: format: uri @@ -11172,7 +10901,7 @@ components: type: object name: description: |- - The name of the project. + The name of the domain. maxLength: 64 minLength: 1 pattern: '[\S]+' @@ -11193,8 +10922,6 @@ components: - 'null' type: object tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -11349,7 +11076,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links to the `domain` resource. properties: self: format: uri @@ -11358,7 +11085,7 @@ components: type: object name: description: |- - The name of the project. + The name of the domain. maxLength: 64 minLength: 1 pattern: '[\S]+' @@ -11379,8 +11106,6 @@ components: - 'null' type: object tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -11402,8 +11127,6 @@ components: A list of `domain` objects items: additionalProperties: false - description: |- - A `domain` object properties: description: description: |- @@ -11450,7 +11173,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links to the `domain` resource. properties: self: format: uri @@ -11459,16 +11182,13 @@ components: type: object name: description: |- - The name of the project. + The name of the domain. maxLength: 64 minLength: 1 pattern: '[\S]+' type: string options: additionalProperties: false - description: |- - The resource options for the role. Available resource options are - `immutable`. properties: immutable: enum: @@ -11480,8 +11200,6 @@ components: - 'null' type: object tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -11495,8 +11213,7 @@ components: type: array links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -11520,43 +11237,118 @@ components: global response limit type: boolean type: object - DomainsPost: + DomainsGroupsRolesGetResponse: additionalProperties: false properties: - domain: - description: |- - A `domain` object + links: + additionalProperties: false + description: Links for the collection of resources. properties: - description: - description: |- - The description of the domain. - maxLength: 255 + next: + format: uri type: - 'null' - string - enabled: - description: |- - If set to `true`, domain is created enabled. If set to - `false`, domain is created disabled. The default is `true`. - - Users can only authorize against an enabled domain (and any of its - projects). In addition, users can only authenticate if the domain that owns - them is also enabled. Disabling a domain prevents both of these things. - enum: - - '' - - '0' - - '1' - - 'FALSE' - - false - - 'False' - - N - - OFF - - ON - - 'TRUE' - - true - - 'True' - - Y - - 'false' + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + roles: + items: + additionalProperties: false + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean + type: object + DomainsPost: + additionalProperties: false + properties: + domain: + description: |- + A `domain` object + properties: + description: + description: |- + The description of the domain. + maxLength: 255 + type: + - 'null' + - string + enabled: + description: |- + If set to `true`, domain is created enabled. If set to + `false`, domain is created disabled. The default is `true`. + + Users can only authorize against an enabled domain (and any of its + projects). In addition, users can only authenticate if the domain that owns + them is also enabled. Disabling a domain prevents both of these things. + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' - n - no - off @@ -11669,7 +11461,7 @@ components: links: additionalProperties: false description: |- - The link to the resources in question. + The links to the `domain` resource. properties: self: format: uri @@ -11678,7 +11470,7 @@ components: type: object name: description: |- - The name of the project. + The name of the domain. maxLength: 64 minLength: 1 pattern: '[\S]+' @@ -11699,8 +11491,6 @@ components: - 'null' type: object tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -11714,17 +11504,86 @@ components: required: - domain type: object - Ec2TokensGetResponse: - description: Response of the ec2tokens:get operation + DomainsUsersRolesGetResponse: + additionalProperties: false + properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + roles: + items: + additionalProperties: false + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object Ec2TokensPostRequest: description: Request of the ec2tokens:post operation type: object x-openstack: action-name: POST - Ec2TokensPostResponse: - description: Response of the ec2tokens:post operation - type: object Endpoint: properties: endpoint: @@ -11785,6 +11644,78 @@ components: type: string type: object type: object + EndpointGetResponse: + additionalProperties: false + description: An endpoint object + properties: + endpoint: + additionalProperties: true + description: An endpoint object + properties: + description: + description: A description of the endpoint. + type: + - 'null' + - string + enabled: + description: Indicates whether the endpoint appears in the service + catalog -false. The endpoint does not appear in the service + catalog. -true. The endpoint appears in the service catalog. + type: boolean + id: + description: The endpoint ID + readOnly: true + type: string + interface: + description: 'The interface type, which describes the visibility of + the endpoint. Value is: -public. Visible by end users on a publicly + available network interface. -internal. Visible by end users on an + unmetered internal network interface. -admin. Visible by administrative + users on a secure network interface.' + enum: + - admin + - internal + - public + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the endpoint. + type: string + region: + description: (Deprecated in v3.2) The geographic location of the + service endpoint. + type: + - 'null' + - string + x-openstack: + max-ver: 3.2 + region_id: + description: (Since v3.2) The ID of the region that contains the + service endpoint. + type: + - 'null' + - string + x-openstack: + min-ver: 3.2 + service_id: + description: The UUID of the service to which the endpoint belongs + type: string + url: + description: The endpoint URL. + maxLength: 225 + minLength: 0 + pattern: ^[a-zA-Z0-9+.-]+:.+ + type: string + type: object + type: object EndpointPatch: additionalProperties: false description: An endpoint object @@ -11864,31 +11795,110 @@ components: required: - endpoint type: object - EndpointsGetResponse: + EndpointPatchResponse: + additionalProperties: false + description: An endpoint object properties: - endpoints: - description: |- - A list of `endpoint` objects. - items: - description: |- - An `endpoint` object. - properties: - enabled: - description: |- - Indicates whether the endpoint appears in the - service catalog: - `false`. The endpoint does not appear in the - service catalog. - `true`. The endpoint appears in the service - catalog. - type: boolean - id: - description: |- - The endpoint ID. - format: uuid - readOnly: true - type: string - interface: - description: |- - The interface type, which describes the + endpoint: + additionalProperties: true + description: An endpoint object + properties: + description: + description: A description of the endpoint. + type: + - 'null' + - string + enabled: + description: Indicates whether the endpoint appears in the service + catalog -false. The endpoint does not appear in the service + catalog. -true. The endpoint appears in the service catalog. + type: boolean + id: + description: The endpoint ID + readOnly: true + type: string + interface: + description: 'The interface type, which describes the visibility of + the endpoint. Value is: -public. Visible by end users on a publicly + available network interface. -internal. Visible by end users on an + unmetered internal network interface. -admin. Visible by administrative + users on a secure network interface.' + enum: + - admin + - internal + - public + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the endpoint. + type: string + region: + description: (Deprecated in v3.2) The geographic location of the + service endpoint. + type: + - 'null' + - string + x-openstack: + max-ver: 3.2 + region_id: + description: (Since v3.2) The ID of the region that contains the + service endpoint. + type: + - 'null' + - string + x-openstack: + min-ver: 3.2 + service_id: + description: The UUID of the service to which the endpoint belongs + type: string + url: + description: The endpoint URL. + maxLength: 225 + minLength: 0 + pattern: ^[a-zA-Z0-9+.-]+:.+ + type: string + type: object + type: object + EndpointsGetResponse: + additionalProperties: false + properties: + endpoints: + description: |- + A list of `endpoint` objects. + items: + additionalProperties: true + description: An endpoint object + properties: + description: + description: |- + The endpoint description. It is returned only when set on the + resource. + type: + - 'null' + - string + enabled: + description: |- + Indicates whether the endpoint appears in the + service catalog: - `false`. The endpoint does not appear in the + service catalog. - `true`. The endpoint appears in the service + catalog. + type: boolean + id: + description: |- + The endpoint ID. + readOnly: true + type: string + interface: + description: |- + The interface type, which describes the visibility of the endpoint. Value is: - `public`. Visible by end users on a publicly available network interface. - `internal`. Visible by end users on an unmetered internal @@ -11899,38 +11909,82 @@ components: - internal - public type: string + links: + additionalProperties: false + description: |- + The links for the `endpoints` resource. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: |- + (Deprecated) The endpoint name. The field will only be returned in responses + when set on the resource. + + This field is deprecated as it provides no value. Endpoints are better + described by the combination of service, region and interface they describe + or by their ID. + type: string region: description: |- (Deprecated in v3.2) The geographic location of the service endpoint. - type: string + type: + - 'null' + - string x-openstack: - max-ver: '3.2' + max-ver: 3.2 region_id: description: |- (Since v3.2) The ID of the region that contains the service endpoint. - format: uuid - type: string + type: + - 'null' + - string x-openstack: - min-ver: '3.2' + min-ver: 3.2 service_id: description: |- The UUID of the service to which the endpoint belongs. - format: uuid type: string url: description: |- The endpoint URL. - format: uri + maxLength: 225 + minLength: 0 + pattern: ^[a-zA-Z0-9+.-]+:.+ type: string type: object type: array - type: object - EndpointsOs_Endpoint_PolicyPolicyGetResponse: - description: Response of the - endpoints/endpoint_id/OS-ENDPOINT-POLICY/policy:get operation + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object EndpointsPost: additionalProperties: false @@ -12015,6 +12069,78 @@ components: - url type: object type: object + EndpointsPostResponse: + additionalProperties: false + description: An endpoint object + properties: + endpoint: + additionalProperties: true + description: An endpoint object + properties: + description: + description: A description of the endpoint. + type: + - 'null' + - string + enabled: + description: Indicates whether the endpoint appears in the service + catalog -false. The endpoint does not appear in the service + catalog. -true. The endpoint appears in the service catalog. + type: boolean + id: + description: The endpoint ID + readOnly: true + type: string + interface: + description: 'The interface type, which describes the visibility of + the endpoint. Value is: -public. Visible by end users on a publicly + available network interface. -internal. Visible by end users on an + unmetered internal network interface. -admin. Visible by administrative + users on a secure network interface.' + enum: + - admin + - internal + - public + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the endpoint. + type: string + region: + description: (Deprecated in v3.2) The geographic location of the + service endpoint. + type: + - 'null' + - string + x-openstack: + max-ver: 3.2 + region_id: + description: (Since v3.2) The ID of the region that contains the + service endpoint. + type: + - 'null' + - string + x-openstack: + min-ver: 3.2 + service_id: + description: The UUID of the service to which the endpoint belongs + type: string + url: + description: The endpoint URL. + maxLength: 225 + minLength: 0 + pattern: ^[a-zA-Z0-9+.-]+:.+ + type: string + type: object + type: object GroupGetResponse: additionalProperties: false properties: @@ -12031,7 +12157,7 @@ components: - string domain_id: description: |- - The ID of the domain. + The ID of the domain of the group. type: string id: description: |- @@ -12087,7 +12213,7 @@ components: - string domain_id: description: |- - The ID of the domain. + The ID of the domain of the group. type: string id: description: |- @@ -12109,8 +12235,6 @@ components: A list of `group` objects items: additionalProperties: true - description: |- - A `group` object properties: description: description: |- @@ -12120,7 +12244,7 @@ components: - string domain_id: description: |- - The ID of the domain. + The ID of the domain of the group. type: string id: description: |- @@ -12135,7 +12259,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -12214,7 +12338,7 @@ components: - string domain_id: description: |- - The ID of the domain. + The ID of the domain of the group. type: string id: description: |- @@ -12233,8 +12357,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -12258,16 +12381,11 @@ components: global response limit type: boolean users: - description: |- - A list of `user` objects items: additionalProperties: true - description: |- - A `user` object properties: default_project_id: - description: |- - The ID of the default project for the user. + description: The ID of the default project for the user. type: - 'null' - string @@ -12277,31 +12395,18 @@ components: - 'null' - string domain_id: - description: |- - The ID of the domain. + description: The ID of the domain. type: string enabled: - description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + description: If the user is enabled, this value is true. If the + user is disabled, this value is false. type: boolean federated: - description: |- - List of federated objects associated with a user. Each object in the list - contains the `idp_id` and `protocols`. `protocols` is a list of - objects, each of which contains `protocol_id` and `unique_id` of - the protocol and user respectively. For example: - - ``` - "federated": [ - { - "idp_id": "efbab5a6acad4d108fec6c63d9609d83", - "protocols": [ - {"protocol_id": "mapped", "unique_id": "test@example.com"} - ] - } - ] - ``` + description: List of federated objects associated with a user. + Each object in the list contains the idp_id and protocols. + protocols is a list of objects, each of which contains + protocol_id and unique_id of the protocol and user + respectively. items: properties: idp_id: @@ -12327,13 +12432,11 @@ components: type: object type: array id: - description: |- - The user ID. + description: The user ID. type: string links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -12353,8 +12456,8 @@ components: - self type: object name: - description: |- - The user name. Must be unique within the owning domain. + description: The user name. Must be unique within the owning + domain. type: string options: additionalProperties: false @@ -12420,14 +12523,9 @@ components: uniqueItems: true type: object password_expires_at: - description: |- - The date and time when the password expires. The time zone - is UTC. - - This is a response object attribute; not valid for requests. - A `null` value indicates that the password never expires. - - **New in version 3.7** + description: The date and time when the password expires. The + time zone is UTC. A null value indicates that the password + never expires. format: date-time type: - 'null' @@ -12629,8 +12727,7 @@ components: A list of `limits` objects items: additionalProperties: false - description: |- - A `limit` object + description: A limit object. properties: description: description: |- @@ -12656,8 +12753,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -12705,7 +12801,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -12779,7 +12875,7 @@ components: - string domain_id: description: |- - The name of the domain. + The ID of the domain. Either this or the project ID must be supplied. maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9-]+$ @@ -12788,7 +12884,7 @@ components: - string project_id: description: |- - The ID for the project. + The ID of the project. Either this or the domain ID must be supplied. maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9-]+$ @@ -12839,8 +12935,7 @@ components: A list of `limits` objects items: additionalProperties: false - description: |- - A `limit` object + description: A limit object. properties: description: description: |- @@ -12969,8 +13064,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -13101,8 +13195,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -13117,10 +13210,6 @@ components: type: string type: object type: object - Os_Ep_FilterEndpoint_GroupsEndpointsGetResponse: - description: Response of the - OS-EP-FILTER/endpoint_groups/endpoint_group_id/endpoints:get operation - type: object Os_Ep_FilterEndpoint_GroupsGetResponse: additionalProperties: false properties: @@ -13178,8 +13267,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -13196,8 +13284,7 @@ components: type: array links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -13337,8 +13424,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -13353,11 +13439,6 @@ components: type: string type: object type: object - Os_Ep_FilterEndpoint_GroupsProjectGetResponse: - description: Response of the - OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects/project_id:get - operation - type: object Os_Ep_FilterEndpoint_GroupsProjectPutRequest: description: Request of the OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects/project_id:put @@ -13365,41 +13446,12 @@ components: type: object x-openstack: action-name: PUT - Os_Ep_FilterEndpoint_GroupsProjectPutResponse: - description: Response of the - OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects/project_id:put - operation - type: object - Os_Ep_FilterEndpoint_GroupsProjectsGetResponse: - description: Response of the - OS-EP-FILTER/endpoint_groups/endpoint_group_id/projects:get operation - type: object - Os_Ep_FilterEndpointsProjectsGetResponse: - description: Response of the - OS-EP-FILTER/endpoints/endpoint_id/projects:get operation - type: object - Os_Ep_FilterProjectsEndpointGetResponse: - description: Response of the - OS-EP-FILTER/projects/project_id/endpoints/endpoint_id:get operation - type: object Os_Ep_FilterProjectsEndpointPutRequest: description: Request of the OS-EP-FILTER/projects/project_id/endpoints/endpoint_id:put operation type: object x-openstack: action-name: PUT - Os_Ep_FilterProjectsEndpointPutResponse: - description: Response of the - OS-EP-FILTER/projects/project_id/endpoints/endpoint_id:put operation - type: object - Os_Ep_FilterProjectsEndpoint_GroupsGetResponse: - description: Response of the - OS-EP-FILTER/projects/project_id/endpoint_groups:get operation - type: object - Os_Ep_FilterProjectsEndpointsGetResponse: - description: Response of the - OS-EP-FILTER/projects/project_id/endpoints:get operation - type: object Os_FederationDomainsGetResponse: properties: domains: @@ -13461,33 +13513,102 @@ components: type: array type: object Os_FederationIdentity_ProviderGetResponse: + additionalProperties: true properties: - identity_provider: - properties: - authorization_ttl: - description: The length of validity in minutes for group - memberships carried over through mapping and persisted in the - database. - type: integer - description: - description: The Identity Provider description - type: string - domain_id: - description: The ID of a domain that is associated with the - Identity Provider. - format: uuid - type: string - enabled: - description: Whether the Identity Provider is enabled or not - type: boolean - id: - description: The Identity Provider unique ID - type: string - remote_ids: - description: List of the unique Identity Provider’s remote IDs - items: + identity_providers: + description: A list of identity provider objects + items: + additionalProperties: true + description: An identity provider object + properties: + authorization_ttl: + description: The length of validity in minutes for group + memberships carried over through mapping and persisted in the + database. If left unset, the default value configured in + keystone will be used, if enabled. + minimum: 0 + type: + - integer + - 'null' + description: + description: The identity provider description + type: + - 'null' + - string + enabled: + description: Whether the identity provider is enabled or not + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' + - n + - no + - off + - on + - 'true' + - y + - yes + type: + - boolean + - 'null' + - string + id: + description: The identity provider ID + readOnly: true type: string - type: array + links: + additionalProperties: false + properties: + protocols: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object + remote_ids: + description: List of the unique identity provider's remote IDs + items: + maxLength: 64 + type: string + type: + - array + - 'null' + uniqueItems: true + type: object + type: array + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self type: object type: object Os_FederationIdentity_ProviderPatch: @@ -13553,33 +13674,79 @@ components: - identity_provider type: object Os_FederationIdentity_ProviderPatchResponse: + additionalProperties: false + description: An identity provider object properties: identity_provider: + additionalProperties: true + description: An identity provider object properties: authorization_ttl: description: The length of validity in minutes for group memberships carried over through mapping and persisted in the - database. - type: integer + database. If left unset, the default value configured in + keystone will be used, if enabled. + minimum: 0 + type: + - integer + - 'null' description: - description: The Identity Provider description - type: string - domain_id: - description: The ID of a domain that is associated with the - Identity Provider. - format: uuid - type: string + description: The identity provider description + type: + - 'null' + - string enabled: - description: Whether the Identity Provider is enabled or not - type: boolean + description: Whether the identity provider is enabled or not + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' + - n + - no + - off + - on + - 'true' + - y + - yes + type: + - boolean + - 'null' + - string id: - description: The Identity Provider unique ID + description: The identity provider ID + readOnly: true type: string + links: + additionalProperties: false + properties: + protocols: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object remote_ids: - description: List of the unique Identity Provider’s remote IDs + description: List of the unique identity provider's remote IDs items: + maxLength: 64 type: string - type: array + type: + - array + - 'null' + uniqueItems: true type: object type: object Os_FederationIdentity_ProviderPut: @@ -13653,81 +13820,217 @@ components: type: object type: object Os_FederationIdentity_ProviderPutResponse: + additionalProperties: false + description: An identity provider object properties: identity_provider: + additionalProperties: true + description: An identity provider object properties: authorization_ttl: description: The length of validity in minutes for group memberships carried over through mapping and persisted in the - database. - type: integer + database. If left unset, the default value configured in + keystone will be used, if enabled. + minimum: 0 + type: + - integer + - 'null' description: - description: The Identity Provider description - type: string - domain_id: - description: The ID of a domain that is associated with the - Identity Provider. - format: uuid - type: string + description: The identity provider description + type: + - 'null' + - string enabled: - description: Whether the Identity Provider is enabled or not - type: boolean + description: Whether the identity provider is enabled or not + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' + - n + - no + - off + - on + - 'true' + - y + - yes + type: + - boolean + - 'null' + - string id: - description: The Identity Provider unique ID + description: The identity provider ID + readOnly: true type: string + links: + additionalProperties: false + properties: + protocols: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object remote_ids: - description: List of the unique Identity Provider’s remote IDs + description: List of the unique identity provider's remote IDs items: + maxLength: 64 type: string - type: array + type: + - array + - 'null' + uniqueItems: true type: object type: object Os_FederationIdentity_ProvidersGetResponse: + additionalProperties: true properties: identity_providers: + description: A list of identity provider objects items: + additionalProperties: true + description: An identity provider object properties: authorization_ttl: description: The length of validity in minutes for group memberships carried over through mapping and persisted in the - database. - type: integer + database. If left unset, the default value configured in + keystone will be used, if enabled. + minimum: 0 + type: + - integer + - 'null' description: - description: The Identity Provider description - type: string - domain_id: - description: The ID of a domain that is associated with the - Identity Provider. - format: uuid - type: string + description: The identity provider description + type: + - 'null' + - string enabled: - description: Whether the Identity Provider is enabled or not - type: boolean + description: Whether the identity provider is enabled or not + enum: + - '' + - '0' + - '1' + - 'FALSE' + - false + - 'False' + - N + - OFF + - ON + - 'TRUE' + - true + - 'True' + - Y + - 'false' + - n + - no + - off + - on + - 'true' + - y + - yes + type: + - boolean + - 'null' + - string id: - description: The Identity Provider unique ID + description: The identity provider ID + readOnly: true type: string + links: + additionalProperties: false + properties: + protocols: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object remote_ids: - description: List of the unique Identity Provider’s remote IDs + description: List of the unique identity provider's remote IDs items: + maxLength: 64 type: string - type: array + type: + - array + - 'null' + uniqueItems: true type: object type: array + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object type: object Os_FederationIdentity_ProvidersProtocolGetResponse: + additionalProperties: false properties: protocol: + additionalProperties: false + description: A federation protocol object. properties: id: - description: The federation protocol ID - format: uuid + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + links: + additionalProperties: false + properties: + identity_provider: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object mapping_id: + maxLength: 64 + minLength: 1 type: string remote_id_attribute: maxLength: 64 type: string + required: + - id + - mapping_id type: object + required: + - protocol type: object Os_FederationIdentity_ProvidersProtocolPatch: additionalProperties: false @@ -13750,19 +14053,42 @@ components: - protocol type: object Os_FederationIdentity_ProvidersProtocolPatchResponse: + additionalProperties: false properties: protocol: + additionalProperties: false + description: A federation protocol object. properties: id: - description: The federation protocol ID - format: uuid + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + links: + additionalProperties: false + properties: + identity_provider: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object mapping_id: + maxLength: 64 + minLength: 1 type: string remote_id_attribute: maxLength: 64 type: string + required: + - id + - mapping_id type: object + required: + - protocol type: object Os_FederationIdentity_ProvidersProtocolPut: additionalProperties: false @@ -13786,19 +14112,42 @@ components: - protocol type: object Os_FederationIdentity_ProvidersProtocolPutResponse: + additionalProperties: false properties: protocol: + additionalProperties: false + description: A federation protocol object. properties: id: - description: The federation protocol ID - format: uuid + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + links: + additionalProperties: false + properties: + identity_provider: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object mapping_id: + maxLength: 64 + minLength: 1 type: string remote_id_attribute: maxLength: 64 type: string + required: + - id + - mapping_id type: object + required: + - protocol type: object Os_FederationIdentity_ProvidersProtocolsAuthGetResponse: properties: @@ -14044,21 +14393,71 @@ components: type: object type: object Os_FederationIdentity_ProvidersProtocolsGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object protocols: items: + additionalProperties: false + description: A federation protocol object. properties: id: - description: The federation protocol ID - format: uuid + maxLength: 64 + minLength: 1 + type: string + idp_id: + description: The identity provider ID + readOnly: true type: string + links: + additionalProperties: false + properties: + identity_provider: + format: uri + type: string + self: + format: uri + type: string + readOnly: true + type: object mapping_id: + maxLength: 64 + minLength: 1 type: string remote_id_attribute: maxLength: 64 - type: string + type: + - 'null' + - string + required: + - id + - idp_id + - mapping_id + - remote_id_attribute type: object type: array + required: + - protocols type: object Os_FederationMappingGetResponse: properties: @@ -15252,8 +15651,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -15388,8 +15786,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -15526,8 +15923,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -15552,8 +15948,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -15623,8 +16018,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -15649,11 +16043,6 @@ components: global response limit type: boolean type: object - Os_InheritDomainsGroupsRolesInherited_To_ProjectsGetResponse: - description: Response of the - OS-INHERIT/domains/domain_id/groups/group_id/roles/role_id/inherited_to_projects:get - operation - type: object Os_InheritDomainsGroupsRolesInherited_To_ProjectsPutRequest: description: Request of the OS-INHERIT/domains/domain_id/groups/group_id/roles/role_id/inherited_to_projects:put @@ -15661,16 +16050,6 @@ components: type: object x-openstack: action-name: PUT - Os_InheritDomainsGroupsRolesInherited_To_ProjectsPutResponse: - description: Response of the - OS-INHERIT/domains/domain_id/groups/group_id/roles/role_id/inherited_to_projects:put - operation - type: object - Os_InheritDomainsUsersRolesInherited_To_ProjectsGetResponse: - description: Response of the - OS-INHERIT/domains/domain_id/users/user_id/roles/role_id/inherited_to_projects:get - operation - type: object Os_InheritDomainsUsersRolesInherited_To_ProjectsPutRequest: description: Request of the OS-INHERIT/domains/domain_id/users/user_id/roles/role_id/inherited_to_projects:put @@ -15678,16 +16057,6 @@ components: type: object x-openstack: action-name: PUT - Os_InheritDomainsUsersRolesInherited_To_ProjectsPutResponse: - description: Response of the - OS-INHERIT/domains/domain_id/users/user_id/roles/role_id/inherited_to_projects:put - operation - type: object - Os_InheritProjectsGroupsRolesInherited_To_ProjectsGetResponse: - description: Response of the - OS-INHERIT/projects/project_id/groups/group_id/roles/role_id/inherited_to_projects:get - operation - type: object Os_InheritProjectsGroupsRolesInherited_To_ProjectsPutRequest: description: Request of the OS-INHERIT/projects/project_id/groups/group_id/roles/role_id/inherited_to_projects:put @@ -15695,16 +16064,6 @@ components: type: object x-openstack: action-name: PUT - Os_InheritProjectsGroupsRolesInherited_To_ProjectsPutResponse: - description: Response of the - OS-INHERIT/projects/project_id/groups/group_id/roles/role_id/inherited_to_projects:put - operation - type: object - Os_InheritProjectsUsersRolesInherited_To_ProjectsGetResponse: - description: Response of the - OS-INHERIT/projects/project_id/users/user_id/roles/role_id/inherited_to_projects:get - operation - type: object Os_InheritProjectsUsersRolesInherited_To_ProjectsPutRequest: description: Request of the OS-INHERIT/projects/project_id/users/user_id/roles/role_id/inherited_to_projects:put @@ -15712,103 +16071,48 @@ components: type: object x-openstack: action-name: PUT - Os_InheritProjectsUsersRolesInherited_To_ProjectsPutResponse: - description: Response of the - OS-INHERIT/projects/project_id/users/user_id/roles/role_id/inherited_to_projects:put - operation - type: object - Os_Oauth1Access_TokenGetResponse: - description: Response of the OS-OAUTH1/access_token:get operation - type: object Os_Oauth1Access_TokenPostRequest: description: Request of the OS-OAUTH1/access_token:post operation type: object x-openstack: action-name: POST - Os_Oauth1Access_TokenPostResponse: - description: Response of the OS-OAUTH1/access_token:post operation - type: object Os_Oauth1AuthorizePutRequest: description: Request of the OS-OAUTH1/authorize/request_token_id:put operation type: object x-openstack: action-name: PUT - Os_Oauth1AuthorizePutResponse: - description: Response of the OS-OAUTH1/authorize/request_token_id:put - operation - type: object - Os_Oauth1ConsumerGetResponse: - description: Response of the OS-OAUTH1/consumers/consumer_id:get operation - type: object Os_Oauth1ConsumerPatchRequest: description: Request of the OS-OAUTH1/consumers/consumer_id:patch operation type: object x-openstack: action-name: PATCH - Os_Oauth1ConsumerPatchResponse: - description: Response of the OS-OAUTH1/consumers/consumer_id:patch - operation - type: object - Os_Oauth1ConsumersGetResponse: - description: Response of the OS-OAUTH1/consumers:get operation - type: object Os_Oauth1ConsumersPostRequest: description: Request of the OS-OAUTH1/consumers:post operation type: object x-openstack: action-name: POST - Os_Oauth1ConsumersPostResponse: - description: Response of the OS-OAUTH1/consumers:post operation - type: object - Os_Oauth1Request_TokenGetResponse: - description: Response of the OS-OAUTH1/request_token:get operation - type: object Os_Oauth1Request_TokenPostRequest: description: Request of the OS-OAUTH1/request_token:post operation type: object x-openstack: action-name: POST - Os_Oauth1Request_TokenPostResponse: - description: Response of the OS-OAUTH1/request_token:post operation - type: object - Os_Oauth2TokenGetResponse: - description: Response of the OS-OAUTH2/token:get operation - type: object Os_Oauth2TokenPatchRequest: description: Request of the OS-OAUTH2/token:patch operation type: object x-openstack: action-name: PATCH - Os_Oauth2TokenPatchResponse: - description: Response of the OS-OAUTH2/token:patch operation - type: object Os_Oauth2TokenPostRequest: description: Request of the OS-OAUTH2/token:post operation type: object x-openstack: action-name: POST - Os_Oauth2TokenPostResponse: - description: Response of the OS-OAUTH2/token:post operation - type: object Os_Oauth2TokenPutRequest: description: Request of the OS-OAUTH2/token:put operation type: object x-openstack: action-name: PUT - Os_Oauth2TokenPutResponse: - description: Response of the OS-OAUTH2/token:put operation - type: object - Os_RevokeEventsGetResponse: - description: Response of the OS-REVOKE/events:get operation - type: object - Os_Simple_CertCaGetResponse: - description: Response of the OS-SIMPLE-CERT/ca:get operation - type: object - Os_Simple_CertCertificatesGetResponse: - description: Response of the OS-SIMPLE-CERT/certificates:get operation - type: object Os_TrustTrustGetResponse: additionalProperties: false description: A trust object @@ -15852,8 +16156,7 @@ components: type: boolean links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -15945,8 +16248,7 @@ components: type: string links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -15966,8 +16268,7 @@ components: - self type: object name: - description: |- - The resource name. + description: The resource name. maxLength: 255 minLength: 1 pattern: '[\S]+' @@ -15988,8 +16289,7 @@ components: type: array roles_links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16023,8 +16323,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16090,8 +16389,7 @@ components: type: boolean links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16186,8 +16484,7 @@ components: type: string links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16207,8 +16504,7 @@ components: - self type: object name: - description: |- - The resource name. + description: The resource name. maxLength: 255 minLength: 1 pattern: '[\S]+' @@ -16229,8 +16525,7 @@ components: type: array roles_links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16418,8 +16713,7 @@ components: type: boolean links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16511,8 +16805,7 @@ components: type: string links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16532,8 +16825,7 @@ components: - self type: object name: - description: |- - The resource name. + description: The resource name. maxLength: 255 minLength: 1 pattern: '[\S]+' @@ -16554,8 +16846,7 @@ components: type: array roles_links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -16584,21 +16875,6 @@ components: type: string type: object type: object - Os_TrustTrustsRoleGetResponse: - description: Response of the OS-TRUST/trusts/trust_id/roles/role_id:get - operation - type: object - Os_TrustTrustsRolesGetResponse: - description: Response of the OS-TRUST/trusts/trust_id/roles:get operation - type: object - PoliciesGetResponse: - description: Response of the policies:get operation - type: object - PoliciesOs_Endpoint_PolicyEndpointGetResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/endpoints/endpoint_id:get - operation - type: object PoliciesOs_Endpoint_PolicyEndpointPutRequest: description: Request of the policies/policy_id/OS-ENDPOINT-POLICY/endpoints/endpoint_id:put @@ -16606,34 +16882,12 @@ components: type: object x-openstack: action-name: PUT - PoliciesOs_Endpoint_PolicyEndpointPutResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/endpoints/endpoint_id:put - operation - type: object - PoliciesOs_Endpoint_PolicyEndpointsGetResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/endpoints:get operation - type: object - PoliciesOs_Endpoint_PolicyServiceGetResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/services/service_id:get operation - type: object PoliciesOs_Endpoint_PolicyServicePutRequest: description: Request of the policies/policy_id/OS-ENDPOINT-POLICY/services/service_id:put operation type: object x-openstack: action-name: PUT - PoliciesOs_Endpoint_PolicyServicePutResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/services/service_id:put operation - type: object - PoliciesOs_Endpoint_PolicyServicesRegionGetResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/services/service_id/regions/region_id:get - operation - type: object PoliciesOs_Endpoint_PolicyServicesRegionPutRequest: description: Request of the policies/policy_id/OS-ENDPOINT-POLICY/services/service_id/regions/region_id:put @@ -16641,30 +16895,16 @@ components: type: object x-openstack: action-name: PUT - PoliciesOs_Endpoint_PolicyServicesRegionPutResponse: - description: Response of the - policies/policy_id/OS-ENDPOINT-POLICY/services/service_id/regions/region_id:put - operation - type: object PoliciesPostRequest: description: Request of the policies:post operation type: object x-openstack: action-name: POST - PoliciesPostResponse: - description: Response of the policies:post operation - type: object - PolicyGetResponse: - description: Response of the policies/policy_id:get operation - type: object PolicyPatchRequest: description: Request of the policies/policy_id:patch operation type: object x-openstack: action-name: PATCH - PolicyPatchResponse: - description: Response of the policies/policy_id:patch operation - type: object ProjectGetResponse: additionalProperties: false properties: @@ -16690,8 +16930,8 @@ components: - string enabled: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -16725,8 +16965,8 @@ components: type: string is_domain: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -16797,8 +17037,6 @@ components: - 'null' - string tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -16916,8 +17154,8 @@ components: - string enabled: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -16951,8 +17189,8 @@ components: type: string is_domain: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17023,8 +17261,6 @@ components: - 'null' - string tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -17041,8 +17277,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -17066,8 +17301,6 @@ components: A list of `project` objects items: additionalProperties: true - description: |- - A `project` object properties: description: description: |- @@ -17086,8 +17319,8 @@ components: - string enabled: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17121,8 +17354,8 @@ components: type: string is_domain: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17168,9 +17401,6 @@ components: type: string options: additionalProperties: false - description: |- - The resource options for the project. Available resource options are - `immutable`. properties: immutable: enum: @@ -17211,6 +17441,81 @@ components: global response limit type: boolean type: object + ProjectsGroupsRolesGetResponse: + additionalProperties: false + properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + roles: + items: + additionalProperties: false + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean + type: object ProjectsPost: additionalProperties: false properties: @@ -17391,8 +17696,8 @@ components: - string enabled: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17426,8 +17731,8 @@ components: type: string is_domain: description: |- - If the user is enabled, this value is `true`. - If the user is disabled, this value is `false`. + If set to `true`, project is enabled. If set to + `false`, project is disabled. enum: - '' - '0' @@ -17498,8 +17803,6 @@ components: - 'null' - string tags: - description: |- - A list of simple strings assigned to a project. items: maxLength: 255 minLength: 1 @@ -17516,8 +17819,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -17561,8 +17863,7 @@ components: properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -17588,6 +17889,81 @@ components: type: string type: array type: object + ProjectsUsersRolesGetResponse: + additionalProperties: false + properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + roles: + items: + additionalProperties: false + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean + type: object Region: properties: region: @@ -17611,6 +17987,52 @@ components: type: string type: object type: object + RegionGetResponse: + additionalProperties: false + properties: + region: + additionalProperties: true + description: A region object. + properties: + description: + description: The resource description. + maxLength: 255 + type: + - 'null' + - string + id: + description: The region ID. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + parent_region_id: + description: To make this region a child of another region, set + this parameter to the ID of the parent region. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + required: + - description + - id + - links + - parent_region_id + type: object + required: + - region + type: object RegionPatch: additionalProperties: false properties: @@ -17647,6 +18069,52 @@ components: required: - region type: object + RegionPatchResponse: + additionalProperties: false + properties: + region: + additionalProperties: true + description: A region object. + properties: + description: + description: The resource description. + maxLength: 255 + type: + - 'null' + - string + id: + description: The region ID. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + parent_region_id: + description: To make this region a child of another region, set + this parameter to the ID of the parent region. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + required: + - description + - id + - links + - parent_region_id + type: object + required: + - region + type: object RegionPut: additionalProperties: false properties: @@ -17700,8 +18168,7 @@ components: - string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -17726,64 +18193,162 @@ components: - region type: object RegionsGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: |- + The links for the `region` resource. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object regions: description: |- A list of `region` object items: - description: |- - A `region` object + additionalProperties: true + description: A region object. properties: description: description: |- The region description. - type: string + maxLength: 255 + type: + - 'null' + - string id: description: |- The ID for the region. - format: uuid + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string readOnly: true - type: string - parent_id: - description: To make this region a child of another region, set - this parameter to the ID of the parent region. - format: uuid - type: string + type: object + parent_region_id: + description: |- + To make this region a child of another region, + set this parameter to the ID of the parent region. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + required: + - description + - id + - links + - parent_region_id type: object type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean + required: + - regions + type: object + RegionsPost: + additionalProperties: false + properties: + region: + additionalProperties: true + description: |- + A `region` object + properties: + description: + description: |- + The region description. + maxLength: 255 + type: + - 'null' + - string + id: + description: |- + The ID for the region. + maxLength: 255 + minLength: 0 + type: + - 'null' + - string + parent_region_id: + description: |- + To make this region a child of another region, + set this parameter to the ID of the parent region. + maxLength: 255 + minLength: 1 + type: + - 'null' + - string + type: object + required: + - region type: object - RegionsPost: + RegionsPostResponse: additionalProperties: false properties: region: additionalProperties: true - description: |- - A `region` object + description: A region object. properties: description: - description: |- - The region description. + description: The resource description. maxLength: 255 type: - 'null' - string id: - description: |- - The ID for the region. + description: The region ID. maxLength: 255 - minLength: 0 + minLength: 1 type: - 'null' - string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object parent_region_id: - description: |- - To make this region a child of another region, - set this parameter to the ID of the parent region. + description: To make this region a child of another region, set + this parameter to the ID of the parent region. maxLength: 255 minLength: 1 type: - 'null' - string + required: + - description + - id + - links + - parent_region_id type: object required: - region @@ -17968,7 +18533,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -17992,8 +18557,7 @@ components: A list of `registered_limits` objects items: additionalProperties: false - description: |- - A `registered_limit` objects + description: A registered limit object. properties: default_limit: description: |- @@ -18016,8 +18580,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -18114,8 +18677,7 @@ components: A list of `registered_limits` objects items: additionalProperties: false - description: |- - A `registered_limit` objects + description: A registered limit object. properties: default_limit: description: |- @@ -18236,6 +18798,54 @@ components: type: object type: object type: object + RoleGetResponse: + additionalProperties: false + properties: + role: + additionalProperties: true + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: object RolePatch: additionalProperties: false properties: @@ -18285,13 +18895,60 @@ components: required: - role type: object + RolePatchResponse: + additionalProperties: false + properties: + role: + additionalProperties: true + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object + type: object Role_AssignmentsGetResponse: additionalProperties: false properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -18477,86 +19134,125 @@ components: type: boolean type: object Role_InferencesGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object role_inferences: + additionalProperties: false description: |- An array of `role_inference` object. items: + additionalProperties: false properties: implies: description: |- An implied role object. items: - description: |- - A prior role object. + additionalProperties: false + description: An implied role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: array prior_role: + additionalProperties: false description: |- A prior role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: object type: array type: object RolesGetResponse: + additionalProperties: false properties: links: - additionalProperties: - format: uri - type: - - 'null' - - string + additionalProperties: false + description: |- + The link to the resources in question. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self type: object roles: description: |- A list of `role` objects items: - description: |- - A `role` object + additionalProperties: true + description: A role object. properties: description: description: |- @@ -18567,26 +19263,20 @@ components: domain_id: description: |- The ID of the domain. - maxLength: 64 - minLength: 1 - pattern: ^[a-zA-Z0-9-]+$ type: - 'null' - string id: description: |- The role ID. - format: uuid - readOnly: true type: string links: - additionalProperties: - format: uri - type: - - 'null' - - string - description: |- - The link to the resources in question. + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string readOnly: true type: object name: @@ -18594,13 +19284,9 @@ components: The role name. maxLength: 255 minLength: 1 - pattern: '[\S]+' type: string options: additionalProperties: false - description: |- - The resource options for the role. Available resource options are - `immutable`. properties: immutable: enum: @@ -18613,10 +19299,37 @@ components: type: object type: object type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object RolesImpliesGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object role_inference: + additionalProperties: false description: |- Role inference object that contains `prior_role` object and `implies` object. @@ -18625,178 +19338,220 @@ components: description: |- An array of implied role objects. items: - description: |- - A prior role object. + additionalProperties: false + description: An implied role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: - description: |- - The link to the resources in question. + additionalProperties: false + description: The link to the resource in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: array prior_role: + additionalProperties: false description: |- A prior role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: object type: object RolesImplyGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object role_inference: + additionalProperties: false description: |- Role inference object that contains `prior_role` object and `implies` object. properties: implies: + additionalProperties: false description: |- - A prior role object. + An implied role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: - description: |- - The link to the resources in question. + additionalProperties: false + description: The link to the resource in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object prior_role: + additionalProperties: false description: |- A prior role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: object type: object RolesImplyPutResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object role_inference: + additionalProperties: false description: |- Role inference object that contains `prior_role` object and `implies` object. properties: implies: + additionalProperties: false description: |- - A prior role object. + An implied role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: - description: |- - The link to the resources in question. + additionalProperties: false + description: The link to the resource in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object prior_role: + additionalProperties: false description: |- A prior role object. properties: - description: - description: The role description. - type: string id: description: |- The role ID. - format: uuid type: string links: + additionalProperties: false description: |- The link to the resources in question. properties: self: - description: The link to the resource in question. format: uri type: string + readOnly: true type: object name: description: |- The role name. + maxLength: 255 + minLength: 1 type: string type: object type: object @@ -18815,8 +19570,6 @@ components: description: |- A list of `role` objects items: - description: |- - A prior role object. properties: description: description: The role description. @@ -18893,20 +19646,59 @@ components: required: - role type: object - RootGetResponse: - description: Response of the versions:get operation - type: object - S3TokensGetResponse: - description: Response of the s3tokens:get operation + RolesPostResponse: + additionalProperties: false + properties: + role: + additionalProperties: true + description: A role object. + properties: + description: + description: The role description. + type: + - 'null' + - string + domain_id: + description: The ID of the domain. + type: + - 'null' + - string + id: + description: The ID of the role. + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The name of the role. + maxLength: 255 + minLength: 1 + type: string + options: + additionalProperties: false + properties: + immutable: + enum: + - + - false + - true + type: + - boolean + - 'null' + type: object + type: object type: object S3TokensPostRequest: description: Request of the s3tokens:post operation type: object x-openstack: action-name: POST - S3TokensPostResponse: - description: Response of the s3tokens:post operation - type: object Service: properties: service: @@ -18918,11 +19710,8 @@ components: The service description. type: string enabled: - description: |- - Defines whether the service and its endpoints - appear in the service catalog: - `false`. The service and its - endpoints do not appear in the service catalog. - `true`. The - service and its endpoints appear in the service catalog. + description: Defines whether the service and its endpoints appear + in the service catalog. type: boolean id: description: |- @@ -18943,6 +19732,47 @@ components: type: string type: object type: object + ServiceGetResponse: + additionalProperties: false + description: A service object. + properties: + service: + additionalProperties: true + description: A service object + properties: + enabled: + description: Defines whether the service and its endpoints appear + in the service catalog - false. The service and its endpoints do + not appear in the service catalog - true. + type: boolean + id: + description: The UUID of the service to which the endpoint + belongs. + readOnly: true + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The service name. + maxLength: 255 + minLength: 0 + type: string + type: + description: The service type, which describes the API implemented + by the service. Value is compute, ec2, identity, image, network, + or volume. + maxLength: 255 + minLength: 1 + type: string + type: object + type: object ServicePatch: description: A service object. properties: @@ -18978,19 +19808,78 @@ components: required: - service type: object + ServicePatchResponse: + additionalProperties: false + description: A service object. + properties: + service: + additionalProperties: true + description: A service object + properties: + enabled: + description: Defines whether the service and its endpoints appear + in the service catalog - false. The service and its endpoints do + not appear in the service catalog - true. + type: boolean + id: + description: The UUID of the service to which the endpoint + belongs. + readOnly: true + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The service name. + maxLength: 255 + minLength: 0 + type: string + type: + description: The service type, which describes the API implemented + by the service. Value is compute, ec2, identity, image, network, + or volume. + maxLength: 255 + minLength: 1 + type: string + type: object + type: object ServicesGetResponse: + additionalProperties: false properties: + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object services: description: |- A list of `service` object. items: - description: |- - A `service` object. + additionalProperties: true + description: A service object properties: - description: - description: |- - The service description. - type: string enabled: description: |- Defines whether the service and its endpoints @@ -19002,21 +19891,38 @@ components: description: |- The UUID of the service to which the endpoint belongs. - format: uuid readOnly: true type: string + links: + additionalProperties: false + description: |- + The links for the `service` resource. + properties: + self: + format: uri + type: string + readOnly: true + type: object name: description: |- The service name. + maxLength: 255 + minLength: 0 type: string type: description: |- The service type, which describes the API implemented by the service. Value is `compute`, `ec2`, `identity`, `image`, `network`, or `volume`. + maxLength: 255 + minLength: 1 type: string type: object type: array + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object ServicesPost: description: A service object. @@ -19034,21 +19940,62 @@ components: service and its endpoints appear in the service catalog. type: boolean name: - description: |- - The service name. + description: |- + The service name. + maxLength: 255 + minLength: 1 + type: string + type: + description: |- + The service type, which describes the API + implemented by the service. Value is `compute`, `ec2`, + `identity`, `image`, `network`, or `volume`. + maxLength: 255 + minLength: 1 + type: string + required: + - type + type: object + type: object + ServicesPostResponse: + additionalProperties: false + description: A service object. + properties: + service: + additionalProperties: true + description: A service object + properties: + enabled: + description: Defines whether the service and its endpoints appear + in the service catalog - false. The service and its endpoints do + not appear in the service catalog - true. + type: boolean + id: + description: The UUID of the service to which the endpoint + belongs. + readOnly: true + type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object + name: + description: The service name. maxLength: 255 - minLength: 1 + minLength: 0 type: string type: - description: |- - The service type, which describes the API - implemented by the service. Value is `compute`, `ec2`, - `identity`, `image`, `network`, or `volume`. + description: The service type, which describes the API implemented + by the service. Value is compute, ec2, identity, image, network, + or volume. maxLength: 255 minLength: 1 type: string - required: - - type type: object type: object SystemGroupsRolesGetResponse: @@ -19057,7 +20004,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -19099,8 +20046,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -19137,7 +20083,7 @@ components: links: additionalProperties: false description: |- - The links for the `user` resource. + The link to the resources in question. properties: next: format: uri @@ -19179,8 +20125,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -19778,8 +20723,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -19830,8 +20774,7 @@ components: type: string links: additionalProperties: false - description: |- - The link to the resources in question. + description: The link to the resource in question. properties: self: format: uri @@ -19869,8 +20812,7 @@ components: type: array links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -19899,20 +20841,47 @@ components: type: object UsersApplication_CredentialGetResponse: additionalProperties: false + description: An application credential object. properties: application_credential: + additionalProperties: false + description: An application credential object. properties: access_rules: - description: A list of access_rules objects + description: A list of access_rules objects. items: properties: id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string method: + description: The request method that the application + credential is permitted to use for a given API endpoint. + enum: + - DELETE + - GET + - HEAD + - PATCH + - POST + - PUT type: string path: + description: The API path that the application credential is + permitted to access. + maxLength: 225 + minLength: 0 + pattern: ^/\.* type: string service: + description: The service type identifier for the service + that the application credential is permitted to access. + Must be a service type that is listed in the service + catalog and not a code name for a service. + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string type: object type: array @@ -19923,63 +20892,132 @@ components: - 'null' - string expires_at: + description: The expiration time of the application credential, if + one was specified. type: - 'null' - string id: - description: The ID of the application credential. - format: uuid + description: The UUID of the application credential readOnly: true type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object name: description: The name of the application credential. Must be unique to a user. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string project_id: description: The ID of the project the application credential was created for and that authentication requests using this application credential will be scoped to. - format: uuid type: string roles: - description: An optional list of role objects, identified by ID or - name. The list may only contain roles that the user has assigned - on the project. If not provided, the roles assigned to the - application credential will be the same as the roles in the - current token. + description: A list of one or more roles that this application + credential has associated with its project. A token using this + application credential will have these same roles. items: + additionalProperties: false properties: + description: + description: A description about the role. + type: + - 'null' + - string + domain_id: + description: The ID of the domain of the role. + type: + - 'null' + - string id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string name: + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + options: + description: The resource options for the role. Available + resource options are immutable. + type: + - 'null' + - object type: object type: array + system: + type: + - 'null' + - string unrestricted: - description: An optional flag to restrict whether the application - credential may be used for the creation or destruction of other - application credentials or trusts. Defaults to false. - type: boolean + description: A flag indicating whether the application credential + may be used for creation or destruction of other application + credentials or trusts. + type: + - boolean + - 'null' + user_id: + description: The ID of the user. + type: string type: object - required: - - application_credential type: object UsersApplication_CredentialsGetResponse: + additionalProperties: false properties: application_credentials: + description: A list of application credentials items: + additionalProperties: false + description: An application credential object. properties: access_rules: - description: A list of access_rules objects + description: A list of access_rules objects. items: properties: id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string method: + description: The request method that the application + credential is permitted to use for a given API endpoint. + enum: + - DELETE + - GET + - HEAD + - PATCH + - POST + - PUT type: string path: + description: The API path that the application credential + is permitted to access. + maxLength: 225 + minLength: 0 + pattern: ^/\.* type: string service: + description: The service type identifier for the service + that the application credential is permitted to access. + Must be a service type that is listed in the service + catalog and not a code name for a service. + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string type: object type: array @@ -19990,48 +21028,113 @@ components: - 'null' - string expires_at: + description: The expiration time of the application credential, + if one was specified. type: - 'null' - string id: - description: The ID of the application credential. - format: uuid + description: The UUID of the application credential readOnly: true type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object name: description: The name of the application credential. Must be unique to a user. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string project_id: description: The ID of the project the application credential was created for and that authentication requests using this application credential will be scoped to. - format: uuid type: string roles: - description: An optional list of role objects, identified by ID - or name. The list may only contain roles that the user has - assigned on the project. If not provided, the roles assigned - to the application credential will be the same as the roles in - the current token. + description: A list of one or more roles that this application + credential has associated with its project. A token using this + application credential will have these same roles. items: + additionalProperties: false properties: + description: + description: A description about the role. + type: + - 'null' + - string + domain_id: + description: The ID of the domain of the role. + type: + - 'null' + - string id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string name: + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + options: + description: The resource options for the role. Available + resource options are immutable. + type: + - 'null' + - object type: object type: array + system: + type: + - 'null' + - string unrestricted: - description: An optional flag to restrict whether the - application credential may be used for the creation or - destruction of other application credentials or trusts. - Defaults to false. - type: boolean + description: A flag indicating whether the application + credential may be used for creation or destruction of other + application credentials or trusts. + type: + - boolean + - 'null' + user_id: + description: The ID of the user. + type: string type: object type: array - required: - - application_credentials + links: + additionalProperties: false + description: Links for the collection of resources. + properties: + next: + format: uri + type: + - 'null' + - string + previous: + format: uri + type: + - 'null' + - string + self: + format: uri + type: string + readOnly: true + required: + - self + type: object + truncated: + description: Flag indicating that the amount of entities exceeds + global response limit + type: boolean type: object UsersApplication_CredentialsPost: additionalProperties: false @@ -20160,20 +21263,47 @@ components: type: object UsersApplication_CredentialsPostResponse: additionalProperties: false + description: An application credential object. properties: application_credential: + additionalProperties: false + description: An application credential object. properties: access_rules: - description: A list of access_rules objects + description: A list of access_rules objects. items: properties: id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string method: + description: The request method that the application + credential is permitted to use for a given API endpoint. + enum: + - DELETE + - GET + - HEAD + - PATCH + - POST + - PUT type: string path: + description: The API path that the application credential is + permitted to access. + maxLength: 225 + minLength: 0 + pattern: ^/\.* type: string service: + description: The service type identifier for the service + that the application credential is permitted to access. + Must be a service type that is listed in the service + catalog and not a code name for a service. + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string type: object type: array @@ -20184,57 +21314,91 @@ components: - 'null' - string expires_at: + description: The expiration time of the application credential, if + one was specified. type: - 'null' - string id: - description: The ID of the application credential. - format: uuid + description: The UUID of the application credential readOnly: true type: string + links: + additionalProperties: false + description: The link to the resource in question. + properties: + self: + format: uri + type: string + readOnly: true + type: object name: description: The name of the application credential. Must be unique to a user. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string project_id: description: The ID of the project the application credential was created for and that authentication requests using this application credential will be scoped to. - format: uuid type: string roles: - description: An optional list of role objects, identified by ID or - name. The list may only contain roles that the user has assigned - on the project. If not provided, the roles assigned to the - application credential will be the same as the roles in the - current token. + description: A list of one or more roles that this application + credential has associated with its project. A token using this + application credential will have these same roles. items: + additionalProperties: false properties: + description: + description: A description about the role. + type: + - 'null' + - string + domain_id: + description: The ID of the domain of the role. + type: + - 'null' + - string id: + maxLength: 64 + minLength: 1 + pattern: ^[a-zA-Z0-9-]+$ type: string name: + description: The resource name. + maxLength: 255 + minLength: 1 + pattern: '[\S]+' type: string + options: + description: The resource options for the role. Available + resource options are immutable. + type: + - 'null' + - object type: object type: array secret: - description: The secret for the application credential, either - generated by the server or provided by the user. This is only - ever shown once in the response to a create request. It is not - stored nor ever shown again. If the secret is lost, a new - application credential must be created. + description: The secret that the application credential will be + created with. type: string + system: + type: + - 'null' + - string unrestricted: - description: An optional flag to restrict whether the application - credential may be used for the creation or destruction of other - application credentials or trusts. Defaults to false. - type: boolean + description: A flag indicating whether the application credential + may be used for creation or destruction of other application + credentials or trusts. + type: + - boolean + - 'null' + user_id: + description: The ID of the user. + type: string type: object - required: - - application_credential - type: object - UsersCredentialsOs_Ec2GetResponse: - description: Response of the users/user_id/credentials/OS-EC2:get - operation type: object UsersCredentialsOs_Ec2PostRequest: description: Request of the users/user_id/credentials/OS-EC2:post @@ -20242,17 +21406,12 @@ components: type: object x-openstack: action-name: POST - UsersCredentialsOs_Ec2PostResponse: - description: Response of the users/user_id/credentials/OS-EC2:post - operation - type: object UsersGetResponse: additionalProperties: false properties: links: additionalProperties: false - description: |- - The links for the `user` resource. + description: Links for the collection of resources. properties: next: format: uri @@ -20280,8 +21439,6 @@ components: A list of `user` objects items: additionalProperties: true - description: |- - A `user` object properties: default_project_id: description: |- @@ -20304,22 +21461,11 @@ components: If the user is disabled, this value is `false`. type: boolean federated: - description: |- - List of federated objects associated with a user. Each object in the list - contains the `idp_id` and `protocols`. `protocols` is a list of - objects, each of which contains `protocol_id` and `unique_id` of - the protocol and user respectively. For example: - - ``` - "federated": [ - { - "idp_id": "efbab5a6acad4d108fec6c63d9609d83", - "protocols": [ - {"protocol_id": "mapped", "unique_id": "test@example.com"} - ] - } - ] - ``` + description: List of federated objects associated with a user. + Each object in the list contains the idp_id and protocols. + protocols is a list of objects, each of which contains + protocol_id and unique_id of the protocol and user + respectively. items: properties: idp_id: @@ -20496,24 +21642,6 @@ components: type: object type: array type: object - UsersOs_Oauth1Access_TokenGetResponse: - description: Response of the - users/user_id/OS-OAUTH1/access_tokens/access_token_id:get operation - type: object - UsersOs_Oauth1Access_TokensGetResponse: - description: Response of the users/user_id/OS-OAUTH1/access_tokens:get - operation - type: object - UsersOs_Oauth1Access_TokensRoleGetResponse: - description: Response of the - users/user_id/OS-OAUTH1/access_tokens/access_token_id/roles/role_id:get - operation - type: object - UsersOs_Oauth1Access_TokensRolesGetResponse: - description: Response of the - users/user_id/OS-OAUTH1/access_tokens/access_token_id/roles:get - operation - type: object UsersPasswordPostRequest: properties: user: diff --git a/openstack_types/data/image/v2.16.yaml b/openstack_types/data/image/v2.16.yaml index 39f469362..726af62a5 100644 --- a/openstack_types/data/image/v2.16.yaml +++ b/openstack_types/data/image/v2.16.yaml @@ -32,10 +32,6 @@ paths: operationId: cache:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CacheGet_Cache_StateResponse' description: Ok summary: Query cache status tags: @@ -74,10 +70,6 @@ paths: $ref: '#/components/schemas/CacheQueue_Image_From_ApiRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CacheQueue_Image_From_ApiResponse' description: Ok summary: Queue image tags: @@ -374,10 +366,6 @@ paths: $ref: '#/components/schemas/ImagesActionsDeactivateDeactivateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ImagesActionsDeactivateResponse' description: Ok summary: Deactivate image tags: @@ -408,10 +396,6 @@ paths: $ref: '#/components/schemas/ImagesActionsReactivateReactivateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ImagesActionsReactivateResponse' description: Ok summary: Reactivate image tags: @@ -444,7 +428,7 @@ paths: responses: '200': content: - application/json: + application/octet-stream: schema: $ref: '#/components/schemas/ImagesFileDownloadResponse' description: Ok @@ -459,7 +443,7 @@ paths: description: Ok '206': content: - application/json: + application/octet-stream: schema: $ref: '#/components/schemas/ImagesFileDownloadResponse' description: Ok @@ -867,10 +851,6 @@ paths: $ref: '#/components/schemas/ImagesStageStageRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ImagesStageResponse' description: Ok summary: Stage binary image data tags: @@ -895,10 +875,6 @@ paths: $ref: '#/components/schemas/ImagesTagUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ImagesTagUpdateResponse' description: Ok tags: - images @@ -2142,15 +2118,9 @@ components: schema: type: string schemas: - CacheGet_Cache_StateResponse: - description: Response of the cache:get operation - type: object CacheQueue_Image_From_ApiRequest: description: Request of the cache/image_id:put operation type: object - CacheQueue_Image_From_ApiResponse: - description: Response of the cache/image_id:put operation - type: object ImageShowResponse: additionalProperties: type: string @@ -2808,18 +2778,10 @@ components: description: Request of the images/image_id/actions/deactivate:post operation type: object - ImagesActionsDeactivateResponse: - description: Response of the images/image_id/actions/deactivate:post - operation - type: object ImagesActionsReactivateReactivateRequest: description: Request of the images/image_id/actions/reactivate:post operation type: object - ImagesActionsReactivateResponse: - description: Response of the images/image_id/actions/reactivate:post - operation - type: object ImagesCreateRequest: additionalProperties: type: string @@ -4011,18 +3973,12 @@ components: schema: type: string type: object - ImagesStageResponse: - description: Response of the images/image_id/stage:put operation - type: object ImagesStageStageRequest: description: Request of the images/image_id/stage:put operation type: object ImagesTagUpdateRequest: description: Request of the images/image_id/tags/tag_value:put operation type: object - ImagesTagUpdateResponse: - description: Response of the images/image_id/tags/tag_value:put operation - type: object ImagesTasksGet_Task_InfoResponse: properties: first: diff --git a/openstack_types/data/image/v2.yaml b/openstack_types/data/image/v2.yaml index 39f469362..726af62a5 100644 --- a/openstack_types/data/image/v2.yaml +++ b/openstack_types/data/image/v2.yaml @@ -32,10 +32,6 @@ paths: operationId: cache:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CacheGet_Cache_StateResponse' description: Ok summary: Query cache status tags: @@ -74,10 +70,6 @@ paths: $ref: '#/components/schemas/CacheQueue_Image_From_ApiRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CacheQueue_Image_From_ApiResponse' description: Ok summary: Queue image tags: @@ -374,10 +366,6 @@ paths: $ref: '#/components/schemas/ImagesActionsDeactivateDeactivateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ImagesActionsDeactivateResponse' description: Ok summary: Deactivate image tags: @@ -408,10 +396,6 @@ paths: $ref: '#/components/schemas/ImagesActionsReactivateReactivateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ImagesActionsReactivateResponse' description: Ok summary: Reactivate image tags: @@ -444,7 +428,7 @@ paths: responses: '200': content: - application/json: + application/octet-stream: schema: $ref: '#/components/schemas/ImagesFileDownloadResponse' description: Ok @@ -459,7 +443,7 @@ paths: description: Ok '206': content: - application/json: + application/octet-stream: schema: $ref: '#/components/schemas/ImagesFileDownloadResponse' description: Ok @@ -867,10 +851,6 @@ paths: $ref: '#/components/schemas/ImagesStageStageRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ImagesStageResponse' description: Ok summary: Stage binary image data tags: @@ -895,10 +875,6 @@ paths: $ref: '#/components/schemas/ImagesTagUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ImagesTagUpdateResponse' description: Ok tags: - images @@ -2142,15 +2118,9 @@ components: schema: type: string schemas: - CacheGet_Cache_StateResponse: - description: Response of the cache:get operation - type: object CacheQueue_Image_From_ApiRequest: description: Request of the cache/image_id:put operation type: object - CacheQueue_Image_From_ApiResponse: - description: Response of the cache/image_id:put operation - type: object ImageShowResponse: additionalProperties: type: string @@ -2808,18 +2778,10 @@ components: description: Request of the images/image_id/actions/deactivate:post operation type: object - ImagesActionsDeactivateResponse: - description: Response of the images/image_id/actions/deactivate:post - operation - type: object ImagesActionsReactivateReactivateRequest: description: Request of the images/image_id/actions/reactivate:post operation type: object - ImagesActionsReactivateResponse: - description: Response of the images/image_id/actions/reactivate:post - operation - type: object ImagesCreateRequest: additionalProperties: type: string @@ -4011,18 +3973,12 @@ components: schema: type: string type: object - ImagesStageResponse: - description: Response of the images/image_id/stage:put operation - type: object ImagesStageStageRequest: description: Request of the images/image_id/stage:put operation type: object ImagesTagUpdateRequest: description: Request of the images/image_id/tags/tag_value:put operation type: object - ImagesTagUpdateResponse: - description: Response of the images/image_id/tags/tag_value:put operation - type: object ImagesTasksGet_Task_InfoResponse: properties: first: diff --git a/openstack_types/data/load-balancer/v2.27.yaml b/openstack_types/data/load-balancer/v2.27.yaml index b3bcabe30..8b162bd1d 100644 --- a/openstack_types/data/load-balancer/v2.27.yaml +++ b/openstack_types/data/load-balancer/v2.27.yaml @@ -1607,10 +1607,6 @@ paths: $ref: '#/components/schemas/MembersRootPUT' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/LbaasPoolsMembersCreateResponse' description: Ok summary: Batch Update Members tags: @@ -1843,7 +1839,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QuotaPUT' + $ref: '#/components/schemas/QuotaRootPUT' responses: '202': content: @@ -9762,11 +9758,11 @@ components: type: array type: object LbaasQuotaGetResponse: - description: Wrapper object for quotas responses. + description: Base type for complex types properties: quota: description: |- - Individual quota definitions. + Base type for complex types properties: health_monitor: maximum: 2000000000 @@ -9827,14 +9823,19 @@ components: maximum: 2000000000 minimum: -1 type: integer + project_id: + type: string + tenant_id: + maxLength: 36 + type: string type: object type: object LbaasQuotaUpdateResponse: - description: Wrapper object for quotas responses. + description: Base type for complex types properties: quota: description: |- - Individual quota definitions. + Base type for complex types properties: health_monitor: maximum: 2000000000 @@ -9895,6 +9896,11 @@ components: maximum: 2000000000 minimum: -1 type: integer + project_id: + type: string + tenant_id: + maxLength: 36 + type: string type: object type: object LbaasQuotasListResponse: @@ -9903,48 +9909,66 @@ components: quotas: items: description: |- - Wrapper object for get all quotas responses. + Base type for complex types properties: health_monitor: + maximum: 2000000000 + minimum: -1 type: integer healthmonitor: description: |- The configured health monitor quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer l7policy: description: |- The configured l7policy quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer l7rule: description: |- The configured l7rule quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer listener: description: |- The configured listener quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer load_balancer: + maximum: 2000000000 + minimum: -1 type: integer loadbalancer: description: |- The configured load balancer quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer member: description: |- The configured member quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer pool: description: |- The configured pool quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer project_id: description: |- @@ -12738,12 +12762,12 @@ components: type: array type: object type: object - QuotaPUT: - description: Overall object for quota PUT request. + QuotaRootPUT: + description: Base type for complex types properties: quota: description: |- - Individual quota definitions. + Base type for complex types properties: health_monitor: maximum: 2000000000 diff --git a/openstack_types/data/load-balancer/v2.yaml b/openstack_types/data/load-balancer/v2.yaml index b3bcabe30..8b162bd1d 100644 --- a/openstack_types/data/load-balancer/v2.yaml +++ b/openstack_types/data/load-balancer/v2.yaml @@ -1607,10 +1607,6 @@ paths: $ref: '#/components/schemas/MembersRootPUT' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/LbaasPoolsMembersCreateResponse' description: Ok summary: Batch Update Members tags: @@ -1843,7 +1839,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/QuotaPUT' + $ref: '#/components/schemas/QuotaRootPUT' responses: '202': content: @@ -9762,11 +9758,11 @@ components: type: array type: object LbaasQuotaGetResponse: - description: Wrapper object for quotas responses. + description: Base type for complex types properties: quota: description: |- - Individual quota definitions. + Base type for complex types properties: health_monitor: maximum: 2000000000 @@ -9827,14 +9823,19 @@ components: maximum: 2000000000 minimum: -1 type: integer + project_id: + type: string + tenant_id: + maxLength: 36 + type: string type: object type: object LbaasQuotaUpdateResponse: - description: Wrapper object for quotas responses. + description: Base type for complex types properties: quota: description: |- - Individual quota definitions. + Base type for complex types properties: health_monitor: maximum: 2000000000 @@ -9895,6 +9896,11 @@ components: maximum: 2000000000 minimum: -1 type: integer + project_id: + type: string + tenant_id: + maxLength: 36 + type: string type: object type: object LbaasQuotasListResponse: @@ -9903,48 +9909,66 @@ components: quotas: items: description: |- - Wrapper object for get all quotas responses. + Base type for complex types properties: health_monitor: + maximum: 2000000000 + minimum: -1 type: integer healthmonitor: description: |- The configured health monitor quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer l7policy: description: |- The configured l7policy quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer l7rule: description: |- The configured l7rule quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer listener: description: |- The configured listener quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer load_balancer: + maximum: 2000000000 + minimum: -1 type: integer loadbalancer: description: |- The configured load balancer quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer member: description: |- The configured member quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer pool: description: |- The configured pool quota limit. A setting of `null` means it is using the deployment default quota. A setting of `-1` means unlimited. + maximum: 2000000000 + minimum: -1 type: integer project_id: description: |- @@ -12738,12 +12762,12 @@ components: type: array type: object type: object - QuotaPUT: - description: Overall object for quota PUT request. + QuotaRootPUT: + description: Base type for complex types properties: quota: description: |- - Individual quota definitions. + Base type for complex types properties: health_monitor: maximum: 2000000000 diff --git a/openstack_types/data/placement/v1.39.yaml b/openstack_types/data/placement/v1.39.yaml index 48dfd1722..cc941099e 100644 --- a/openstack_types/data/placement/v1.39.yaml +++ b/openstack_types/data/placement/v1.39.yaml @@ -17,10 +17,6 @@ paths: operationId: :get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RootHomeResponse' description: Ok summary: List Versions tags: @@ -738,10 +734,6 @@ paths: operationId: resource_providers/uuid/usages:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Resource_ProvidersUsagesList_UsagesResponse' description: Ok summary: List resource provider usages tags: @@ -3071,12 +3063,6 @@ components: required: - traits type: object - Resource_ProvidersUsagesList_UsagesResponse: - description: Response of the resource_providers/uuid/usages:get operation - type: object - RootHomeResponse: - description: Response of the :get operation - type: object TraitsList_TraitsResponse: additionalProperties: false properties: diff --git a/openstack_types/data/placement/v1.yaml b/openstack_types/data/placement/v1.yaml index 48dfd1722..cc941099e 100644 --- a/openstack_types/data/placement/v1.yaml +++ b/openstack_types/data/placement/v1.yaml @@ -17,10 +17,6 @@ paths: operationId: :get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RootHomeResponse' description: Ok summary: List Versions tags: @@ -738,10 +734,6 @@ paths: operationId: resource_providers/uuid/usages:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Resource_ProvidersUsagesList_UsagesResponse' description: Ok summary: List resource provider usages tags: @@ -3071,12 +3063,6 @@ components: required: - traits type: object - Resource_ProvidersUsagesList_UsagesResponse: - description: Response of the resource_providers/uuid/usages:get operation - type: object - RootHomeResponse: - description: Response of the :get operation - type: object TraitsList_TraitsResponse: additionalProperties: false properties: diff --git a/openstack_types/data/shared-file-system/v2.95.yaml b/openstack_types/data/shared-file-system/v2.95.yaml index 3bf07c51c..c8acff2d2 100644 --- a/openstack_types/data/shared-file-system/v2.95.yaml +++ b/openstack_types/data/shared-file-system/v2.95.yaml @@ -18,10 +18,6 @@ paths: operationId: :get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RootListResponse' description: Ok summary: List All Major Versions tags: @@ -36,7 +32,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Availability_ZonesListResponse' + $ref: '#/components/schemas/Availability_ZonesIndexResponse_27' description: Ok tags: - availability-zones @@ -47,10 +43,6 @@ paths: operationId: extensions:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionsListResponse' description: Ok tags: - extensions @@ -63,10 +55,6 @@ paths: $ref: '#/components/schemas/ExtensionsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionsCreateResponse' description: Ok tags: - extensions @@ -82,10 +70,6 @@ paths: operationId: extensions/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionShowResponse' description: Ok tags: - extensions @@ -98,10 +82,6 @@ paths: operationId: limits:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LimitsListResponse' description: Ok tags: - limits @@ -128,7 +108,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MessagesListResponse' + oneOf: + - $ref: '#/components/schemas/MessagesIndexResponse_237' + - $ref: '#/components/schemas/MessagesIndexResponse_252' description: Ok tags: - messages @@ -155,7 +137,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MessageShowResponse' + $ref: '#/components/schemas/MessageShowResponse_237' description: Ok tags: - messages @@ -172,7 +154,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Availability_ZoneListResponse' + $ref: '#/components/schemas/Os_Availability_ZoneIndexResponse_20' description: Ok tags: - os-availability-zone @@ -188,7 +170,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse' + $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse_20' description: Ok tags: - os-quota-class-sets @@ -210,7 +192,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse' + $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse_20' description: Ok tags: - os-quota-class-sets @@ -234,10 +216,6 @@ paths: operationId: os-quota-sets/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Quota_SetShowResponse' description: Ok tags: - os-quota-sets @@ -256,10 +234,6 @@ paths: $ref: '#/components/schemas/Os_Quota_SetUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse' description: Ok tags: - os-quota-sets @@ -272,10 +246,6 @@ paths: operationId: os-quota-sets/id/defaults:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Quota_SetsDefaultsResponse' description: Ok tags: - os-quota-sets @@ -290,10 +260,6 @@ paths: operationId: os-services:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_ServicesListResponse' description: Ok tags: - os-services @@ -313,10 +279,6 @@ paths: $ref: '#/components/schemas/Os_ServiceUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_ServiceUpdateResponse' description: Ok tags: - os-services @@ -339,10 +301,6 @@ paths: $ref: '#/components/schemas/Os_Share_ManageCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Share_ManageCreateResponse' description: Ok tags: - os-share-manage @@ -364,10 +322,6 @@ paths: $ref: '#/components/schemas/Os_Share_UnmanageUnmanageUnmanageRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Share_UnmanageUnmanageResponse' description: Ok tags: - os-share-unmanage @@ -381,10 +335,6 @@ paths: operationId: qos-types:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesListResponse' description: Ok tags: - qos-types @@ -401,10 +351,6 @@ paths: $ref: '#/components/schemas/Qos_TypesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesCreateResponse' description: Ok tags: - qos-types @@ -428,10 +374,6 @@ paths: operationId: qos-types/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypeShowResponse' description: Ok tags: - qos-types @@ -450,10 +392,6 @@ paths: $ref: '#/components/schemas/Qos_TypeUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypeUpdateResponse' description: Ok tags: - qos-types @@ -466,10 +404,6 @@ paths: operationId: qos-types/id/specs:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesSpecsListResponse' description: Ok tags: - qos-types @@ -488,10 +422,6 @@ paths: $ref: '#/components/schemas/Qos_TypesSpecsCreateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesSpecsCreateResponse' description: Ok tags: - qos-types @@ -515,10 +445,6 @@ paths: operationId: qos-types/id/specs/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesSpecShowResponse' description: Ok tags: - qos-types @@ -538,10 +464,6 @@ paths: $ref: '#/components/schemas/Qos_TypesSpecUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesSpecUpdateResponse' description: Ok tags: - qos-types @@ -555,7 +477,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Quota_Class_SetShowResponse' + oneOf: + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_10' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_240' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_253' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_262' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_27' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_280' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_290' description: Ok tags: - quota-class-sets @@ -575,7 +504,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_240' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_253' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_262' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_27' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_280' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_290' description: Ok tags: - quota-class-sets @@ -595,10 +530,6 @@ paths: operationId: quota-sets/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Quota_SetShowResponse' description: Ok tags: - quota-sets @@ -615,10 +546,6 @@ paths: $ref: '#/components/schemas/Quota_SetUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Quota_SetUpdateResponse' description: Ok tags: - quota-sets @@ -629,10 +556,6 @@ paths: operationId: quota-sets/id/defaults:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Quota_SetsDefaultsResponse' description: Ok tags: - quota-sets @@ -645,10 +568,6 @@ paths: operationId: quota-sets/id/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Quota_SetsDetailResponse' description: Ok tags: - quota-sets @@ -682,7 +601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Resource_LocksListResponse' + $ref: '#/components/schemas/Resource_LocksIndexResponse_281' description: Ok tags: - resource-locks @@ -702,7 +621,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Resource_LocksCreateResponse' + $ref: '#/components/schemas/Resource_LocksCreateResponse_281' description: Ok tags: - resource-locks @@ -729,7 +648,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Resource_LockShowResponse' + $ref: '#/components/schemas/Resource_LockShowResponse_281' description: Ok tags: - resource-locks @@ -751,7 +670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Resource_LockUpdateResponse' + $ref: '#/components/schemas/Resource_LockUpdateResponse_281' description: Ok tags: - resource-locks @@ -765,10 +684,6 @@ paths: operationId: scheduler-stats/pools:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Scheduler_StatsPoolsPools_ListResponse' description: Ok tags: - scheduler-stats @@ -783,10 +698,6 @@ paths: operationId: scheduler-stats/pools/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Scheduler_StatsPoolsDetailPools_DetailResponse' description: Ok tags: - scheduler-stats @@ -800,10 +711,6 @@ paths: operationId: security-services:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServicesListResponse' description: Ok tags: - security-services @@ -818,10 +725,6 @@ paths: $ref: '#/components/schemas/Security_ServicesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServicesCreateResponse' description: Ok tags: - security-services @@ -832,10 +735,6 @@ paths: operationId: security-services/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServicesDetailResponse' description: Ok tags: - security-services @@ -855,10 +754,6 @@ paths: operationId: security-services/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServiceShowResponse' description: Ok tags: - security-services @@ -875,10 +770,6 @@ paths: $ref: '#/components/schemas/Security_ServiceUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServiceUpdateResponse' description: Ok tags: - security-services @@ -888,10 +779,6 @@ paths: operationId: services:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ServicesListResponse' description: Ok tags: - services @@ -910,10 +797,6 @@ paths: $ref: '#/components/schemas/ServicesEnsure_SharesEnsure_Shares_286' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ServicesEnsure_SharesResponse' description: Ok tags: - services @@ -932,10 +815,6 @@ paths: $ref: '#/components/schemas/ServiceUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUpdateResponse' description: Ok tags: - services @@ -948,10 +827,6 @@ paths: operationId: share-access-rules:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Access_RulesListResponse' description: Ok tags: - share-access-rules @@ -970,10 +845,6 @@ paths: $ref: '#/components/schemas/Share_Access_RulesMetadataUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Access_RulesMetadataUpdateResponse' description: Ok tags: - share-access-rules @@ -1001,10 +872,6 @@ paths: operationId: share-access-rules/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Access_RuleShowResponse' description: Ok tags: - share-access-rules @@ -1023,10 +890,6 @@ paths: $ref: '#/components/schemas/Share_Access_RuleUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Access_RuleUpdateResponse' description: Ok tags: - share-access-rules @@ -1039,10 +902,6 @@ paths: operationId: share-backups:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsListResponse' description: Ok tags: - share-backups @@ -1059,10 +918,6 @@ paths: $ref: '#/components/schemas/Share_BackupsCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsCreateResponse' description: Ok tags: - share-backups @@ -1075,10 +930,6 @@ paths: operationId: share-backups/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsDetailResponse' description: Ok tags: - share-backups @@ -1102,10 +953,6 @@ paths: operationId: share-backups/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupShowResponse' description: Ok tags: - share-backups @@ -1124,10 +971,6 @@ paths: $ref: '#/components/schemas/Share_BackupUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupUpdateResponse' description: Ok tags: - share-backups @@ -1149,16 +992,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsActionReset_StatusResponse' description: Ok '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsActionRestoreResponse' description: Ok tags: - share-backups @@ -1170,10 +1005,6 @@ paths: operationId: share-group-snapshots:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotsListResponse' description: Ok tags: - share-group-snapshots @@ -1190,10 +1021,6 @@ paths: $ref: '#/components/schemas/Share_Group_SnapshotsCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotsCreateResponse' description: Ok tags: - share-group-snapshots @@ -1208,10 +1035,6 @@ paths: operationId: share-group-snapshots/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotsDetailResponse' description: Ok tags: - share-group-snapshots @@ -1235,10 +1058,6 @@ paths: operationId: share-group-snapshots/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotShowResponse' description: Ok tags: - share-group-snapshots @@ -1257,10 +1076,6 @@ paths: $ref: '#/components/schemas/Share_Group_SnapshotUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotUpdateResponse' description: Ok tags: - share-group-snapshots @@ -1283,12 +1098,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_Group_SnapshotsActionForce_DeleteResponse' - - $ref: '#/components/schemas/Share_Group_SnapshotsActionReset_StatusResponse' description: Ok tags: - share-group-snapshots @@ -1298,10 +1107,6 @@ paths: operationId: share-group-snapshots/id/members:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotsMembersResponse' description: Ok tags: - share-group-snapshots @@ -1316,10 +1121,6 @@ paths: operationId: share-group-types:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesListResponse' description: Ok tags: - share-group-types @@ -1336,10 +1137,6 @@ paths: $ref: '#/components/schemas/Share_Group_TypesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesCreateResponse' description: Ok tags: - share-group-types @@ -1352,10 +1149,6 @@ paths: operationId: share-group-types/default:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesDefaultResponse' description: Ok tags: - share-group-types @@ -1379,10 +1172,6 @@ paths: operationId: share-group-types/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypeShowResponse' description: Ok tags: - share-group-types @@ -1397,10 +1186,6 @@ paths: operationId: share-group-types/id/access:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesAccessShare_Group_Type_AccessResponse' description: Ok tags: - share-group-types @@ -1427,14 +1212,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_Group_TypesActionAddprojectaccessResponse' - - $ref: '#/components/schemas/Share_Group_TypesActionCreateResponse' - - $ref: '#/components/schemas/Share_Group_TypesActionDeleteResponse' - - $ref: '#/components/schemas/Share_Group_TypesActionRemoveprojectaccessResponse' description: Ok tags: - share-group-types @@ -1444,10 +1221,6 @@ paths: operationId: share-group-types/id/group-specs:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesGroup_SpecsListResponse' description: Ok tags: - share-group-types @@ -1466,10 +1239,6 @@ paths: $ref: '#/components/schemas/Share_Group_TypesGroup_SpecsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesGroup_SpecsCreateResponse' description: Ok tags: - share-group-types @@ -1493,10 +1262,6 @@ paths: operationId: share-group-types/id/group-specs/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesGroup_SpecShowResponse' description: Ok tags: - share-group-types @@ -1516,10 +1281,6 @@ paths: $ref: '#/components/schemas/Share_Group_TypesGroup_SpecUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesGroup_SpecUpdateResponse' description: Ok tags: - share-group-types @@ -1532,10 +1293,6 @@ paths: operationId: share-groups:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupsListResponse' description: Ok tags: - share-groups @@ -1552,10 +1309,6 @@ paths: $ref: '#/components/schemas/Share_GroupsCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupsCreateResponse' description: Ok tags: - share-groups @@ -1568,10 +1321,6 @@ paths: operationId: share-groups/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupsDetailResponse' description: Ok tags: - share-groups @@ -1595,10 +1344,6 @@ paths: operationId: share-groups/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupShowResponse' description: Ok tags: - share-groups @@ -1617,10 +1362,6 @@ paths: $ref: '#/components/schemas/Share_GroupUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupUpdateResponse' description: Ok tags: - share-groups @@ -1643,12 +1384,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_GroupsActionForce_DeleteResponse' - - $ref: '#/components/schemas/Share_GroupsActionReset_StatusResponse' description: Ok tags: - share-groups @@ -1659,10 +1394,6 @@ paths: operationId: share-networks:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksListResponse' description: Ok tags: - share-networks @@ -1677,10 +1408,6 @@ paths: $ref: '#/components/schemas/Share_NetworksCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksCreateResponse' description: Ok tags: - share-networks @@ -1691,10 +1418,6 @@ paths: operationId: share-networks/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksDetailResponse' description: Ok tags: - share-networks @@ -1714,10 +1437,6 @@ paths: operationId: share-networks/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworkShowResponse' description: Ok tags: - share-networks @@ -1734,10 +1453,6 @@ paths: $ref: '#/components/schemas/Share_NetworkUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworkUpdateResponse' description: Ok tags: - share-networks @@ -1762,23 +1477,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_NetworksActionAdd_Security_ServiceResponse' - - $ref: '#/components/schemas/Share_NetworksActionRemove_Security_ServiceResponse' - - $ref: '#/components/schemas/Share_NetworksActionReset_StatusResponse' description: Ok '202': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_NetworksActionAdd_Security_Service_CheckResponse' - - $ref: '#/components/schemas/Share_NetworksActionShare_Network_Subnet_Create_CheckResponse' - - $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_ServiceResponse' - - $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_Service_CheckResponse' description: Ok tags: - share-networks @@ -1789,10 +1489,6 @@ paths: operationId: share-networks/share_network_id/subnets:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsListResponse' description: Ok tags: - share-networks @@ -1811,10 +1507,6 @@ paths: $ref: '#/components/schemas/Share_NetworksSubnetsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsCreateResponse' description: Ok tags: - share-networks @@ -1828,10 +1520,6 @@ paths: share-networks/share_network_id/subnets/resource_id/metadata:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataList_MetadataResponse' description: Ok tags: - share-networks @@ -1852,10 +1540,6 @@ paths: $ref: '#/components/schemas/Share_NetworksSubnetsMetadataCreate_MetadataRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataCreate_MetadataResponse' description: Ok tags: - share-networks @@ -1873,10 +1557,6 @@ paths: $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_All_MetadataRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_All_MetadataResponse' description: Ok tags: - share-networks @@ -1902,10 +1582,6 @@ paths: share-networks/share_network_id/subnets/resource_id/metadata/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataShow_MetadataResponse' description: Ok tags: - share-networks @@ -1927,10 +1603,6 @@ paths: $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_Metadata_ItemRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_Metadata_ItemResponse' description: Ok tags: - share-networks @@ -1956,10 +1628,6 @@ paths: share-networks/share_network_id/subnets/share_network_subnet_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetShowResponse' description: Ok tags: - share-networks @@ -1976,10 +1644,6 @@ paths: operationId: share-replicas:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasListResponse' description: Ok tags: - share-replicas @@ -1996,10 +1660,6 @@ paths: $ref: '#/components/schemas/Share_ReplicasCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasCreateResponse' description: Ok tags: - share-replicas @@ -2014,10 +1674,6 @@ paths: operationId: share-replicas/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasDetailResponse' description: Ok tags: - share-replicas @@ -2043,10 +1699,6 @@ paths: operationId: share-replicas/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicaShowResponse' description: Ok tags: - share-replicas @@ -2074,21 +1726,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_ReplicasActionForce_DeleteResponse' - - $ref: '#/components/schemas/Share_ReplicasActionReset_Replica_StateResponse' - - $ref: '#/components/schemas/Share_ReplicasActionReset_StatusResponse' description: Ok '202': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_ReplicasActionPromoteResponse' - - $ref: '#/components/schemas/Share_ReplicasActionResyncResponse' description: Ok tags: - share-replicas @@ -2099,10 +1738,6 @@ paths: operationId: share-replicas/resource_id/metadata:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataList_MetadataResponse' description: Ok tags: - share-replicas @@ -2119,10 +1754,6 @@ paths: $ref: '#/components/schemas/Share_ReplicasMetadataCreate_MetadataRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataCreate_MetadataResponse' description: Ok tags: - share-replicas @@ -2137,10 +1768,6 @@ paths: $ref: '#/components/schemas/Share_ReplicasMetadataUpdate_All_MetadataRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataUpdate_All_MetadataResponse' description: Ok tags: - share-replicas @@ -2160,10 +1787,6 @@ paths: operationId: share-replicas/resource_id/metadata/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataShow_MetadataResponse' description: Ok tags: - share-replicas @@ -2181,10 +1804,6 @@ paths: $ref: '#/components/schemas/Share_ReplicasMetadataUpdate_Metadata_ItemRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataUpdate_Metadata_ItemResponse' description: Ok tags: - share-replicas @@ -2196,10 +1815,6 @@ paths: operationId: share-replicas/share_replica_id/export-locations:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasExport_LocationsListResponse' description: Ok tags: - share-replicas @@ -2215,10 +1830,6 @@ paths: share-replicas/share_replica_id/export-locations/export_location_uuid:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasExport_LocationShowResponse' description: Ok tags: - share-replicas @@ -2235,10 +1846,6 @@ paths: operationId: share-servers:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ServersListResponse' description: Ok tags: - share-servers @@ -2252,10 +1859,6 @@ paths: $ref: '#/components/schemas/Share_ServersManageManageRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ServersManageResponse' description: Ok tags: - share-servers @@ -2277,10 +1880,6 @@ paths: operationId: share-servers/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ServerShowResponse' description: Ok tags: - share-servers @@ -2308,24 +1907,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_ServersActionMigration_CheckResponse' - - $ref: '#/components/schemas/Share_ServersActionMigration_CompleteResponse' - - $ref: '#/components/schemas/Share_ServersActionMigration_Get_ProgressResponse' - - $ref: '#/components/schemas/Share_ServersActionReset_StatusResponse' - - $ref: '#/components/schemas/Share_ServersActionReset_Task_StateResponse' - - $ref: '#/components/schemas/Share_ServersActionUnmanageResponse' description: Ok '202': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_ServersActionMigration_CancelResponse' - - $ref: '#/components/schemas/Share_ServersActionMigration_StartResponse' description: Ok tags: - share-servers @@ -2336,10 +1919,6 @@ paths: operationId: share-servers/id/details:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ServersDetailsResponse' description: Ok tags: - share-servers @@ -2352,10 +1931,6 @@ paths: operationId: share-transfers:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransfersListResponse' description: Ok tags: - share-transfers @@ -2372,10 +1947,6 @@ paths: $ref: '#/components/schemas/Share_TransfersCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransfersCreateResponse' description: Ok tags: - share-transfers @@ -2388,10 +1959,6 @@ paths: operationId: share-transfers/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransfersDetailResponse' description: Ok tags: - share-transfers @@ -2415,10 +1982,6 @@ paths: operationId: share-transfers/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransferShowResponse' description: Ok tags: - share-transfers @@ -2440,10 +2003,6 @@ paths: $ref: '#/components/schemas/Share_TransfersAcceptAcceptRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransfersAcceptResponse' description: Ok tags: - share-transfers @@ -2455,10 +2014,6 @@ paths: operationId: share_instances:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_InstancesListResponse' description: Ok tags: - share_instances @@ -2470,10 +2025,6 @@ paths: operationId: share_instances/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_InstanceShowResponse' description: Ok tags: - share_instances @@ -2499,14 +2050,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_InstancesActionForce_DeleteResponse' - - $ref: '#/components/schemas/Share_InstancesActionOs-Force_DeleteResponse' - - $ref: '#/components/schemas/Share_InstancesActionOs-Reset_StatusResponse' - - $ref: '#/components/schemas/Share_InstancesActionReset_StatusResponse' description: Ok tags: - share_instances @@ -2520,7 +2063,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Share_InstancesExport_LocationsListResponse' + oneOf: + - $ref: '#/components/schemas/Share_InstancesExport_LocationsIndexResponse_214' + - $ref: '#/components/schemas/Share_InstancesExport_LocationsIndexResponse_287' + - $ref: '#/components/schemas/Share_InstancesExport_LocationsIndexResponse_29' description: Ok tags: - share_instances @@ -2539,7 +2085,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse' + oneOf: + - $ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse_214' + - $ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse_287' + - $ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse_29' description: Ok tags: - share_instances @@ -2555,10 +2104,6 @@ paths: operationId: shares:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesListResponse' description: Ok tags: - shares @@ -2574,10 +2119,6 @@ paths: $ref: '#/components/schemas/SharesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesCreateResponse' description: Ok tags: - shares @@ -2591,10 +2132,6 @@ paths: operationId: shares/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesDetailResponse' description: Ok tags: - shares @@ -2610,10 +2147,6 @@ paths: $ref: '#/components/schemas/SharesManageManageRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesManageResponse' description: Ok tags: - shares @@ -2635,10 +2168,6 @@ paths: operationId: shares/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ShareShowResponse' description: Ok tags: - shares @@ -2655,10 +2184,6 @@ paths: $ref: '#/components/schemas/ShareUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ShareUpdateResponse' description: Ok tags: - shares @@ -2703,29 +2228,8 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/SharesActionAccess_ListResponse' - - $ref: '#/components/schemas/SharesActionAllow_AccessResponse' - - $ref: '#/components/schemas/SharesActionDeny_AccessResponse' - - $ref: '#/components/schemas/SharesActionExtendResponse' - - $ref: '#/components/schemas/SharesActionForce_DeleteResponse' - - $ref: '#/components/schemas/SharesActionMigration_CancelResponse' - - $ref: '#/components/schemas/SharesActionMigration_CompleteResponse' - - $ref: '#/components/schemas/SharesActionMigration_Get_ProgressResponse' - - $ref: '#/components/schemas/SharesActionMigration_StartResponse' - - $ref: '#/components/schemas/SharesActionOs-Access_ListResponse' - - $ref: '#/components/schemas/SharesActionOs-Allow_AccessResponse' - - $ref: '#/components/schemas/SharesActionOs-Deny_AccessResponse' - - $ref: '#/components/schemas/SharesActionOs-ExtendResponse' - - $ref: '#/components/schemas/SharesActionOs-Force_DeleteResponse' - - $ref: '#/components/schemas/SharesActionOs-Reset_StatusResponse' - - $ref: '#/components/schemas/SharesActionOs-ShrinkResponse' - - $ref: '#/components/schemas/SharesActionReset_StatusResponse' - - $ref: '#/components/schemas/SharesActionReset_Task_StateResponse' - - $ref: '#/components/schemas/SharesActionRestoreResponse' - - $ref: '#/components/schemas/SharesActionRevertResponse' - - $ref: '#/components/schemas/SharesActionShrinkResponse' - - $ref: '#/components/schemas/SharesActionSoft_DeleteResponse' - - $ref: '#/components/schemas/SharesActionUnmanageResponse' + - $ref: '#/components/schemas/SharesActionMigration_Get_ProgressResponse_222' + - $ref: '#/components/schemas/SharesActionMigration_Get_ProgressResponse_259' description: Ok tags: - shares @@ -2736,10 +2240,6 @@ paths: operationId: shares/resource_id/metadata:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataList_MetadataResponse' description: Ok tags: - shares @@ -2756,10 +2256,6 @@ paths: $ref: '#/components/schemas/SharesMetadataCreate_MetadataRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataCreate_MetadataResponse' description: Ok tags: - shares @@ -2774,10 +2270,6 @@ paths: $ref: '#/components/schemas/SharesMetadataUpdate_All_MetadataRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataUpdate_All_MetadataResponse' description: Ok tags: - shares @@ -2797,10 +2289,6 @@ paths: operationId: shares/resource_id/metadata/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataShow_MetadataResponse' description: Ok tags: - shares @@ -2818,10 +2306,6 @@ paths: $ref: '#/components/schemas/SharesMetadataUpdate_Metadata_ItemRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataUpdate_Metadata_ItemResponse' description: Ok tags: - shares @@ -2838,7 +2322,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsListResponse' + oneOf: + - $ref: '#/components/schemas/SharesExport_LocationsIndexResponse_214' + - $ref: '#/components/schemas/SharesExport_LocationsIndexResponse_247' + - $ref: '#/components/schemas/SharesExport_LocationsIndexResponse_287' + - $ref: '#/components/schemas/SharesExport_LocationsIndexResponse_29' description: Ok tags: - shares @@ -2858,7 +2346,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationShowResponse' + oneOf: + - $ref: '#/components/schemas/SharesExport_LocationShowResponse_214' + - $ref: '#/components/schemas/SharesExport_LocationShowResponse_247' + - $ref: '#/components/schemas/SharesExport_LocationShowResponse_287' + - $ref: '#/components/schemas/SharesExport_LocationShowResponse_29' description: Ok tags: - shares @@ -2878,7 +2370,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataList_MetadataResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataIndex_MetadataResponse_287' description: Ok tags: - shares @@ -2901,7 +2393,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataCreate_MetadataResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataCreate_MetadataResponse_287' description: Ok tags: - shares @@ -2921,7 +2413,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_All_MetadataResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_All_MetadataResponse_287' description: Ok tags: - shares @@ -2949,7 +2441,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataShow_MetadataResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataShow_MetadataResponse_287' description: Ok tags: - shares @@ -2974,7 +2466,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse_287' description: Ok tags: - shares @@ -2985,10 +2477,6 @@ paths: operationId: shares/share_id/instances:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesInstancesGet_Share_InstancesResponse' description: Ok tags: - shares @@ -3003,10 +2491,6 @@ paths: operationId: snapshot-instances:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesListResponse' description: Ok tags: - snapshot-instances @@ -3019,10 +2503,6 @@ paths: operationId: snapshot-instances/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesDetailResponse' description: Ok tags: - snapshot-instances @@ -3033,10 +2513,6 @@ paths: operationId: snapshot-instances/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstanceShowResponse' description: Ok tags: - snapshot-instances @@ -3059,10 +2535,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesActionReset_StatusResponse' description: Ok tags: - snapshot-instances @@ -3071,10 +2543,6 @@ paths: operationId: snapshot-instances/snapshot_instance_id/export-locations:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesExport_LocationsListResponse' description: Ok tags: - snapshot-instances @@ -3088,10 +2556,6 @@ paths: snapshot-instances/snapshot_instance_id/export-locations/export_location_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesExport_LocationShowResponse' description: Ok tags: - snapshot-instances @@ -3126,7 +2590,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SnapshotsListResponse' + oneOf: + - $ref: '#/components/schemas/SnapshotsIndexResponse_20' + - $ref: '#/components/schemas/SnapshotsIndexResponse_236' + - $ref: '#/components/schemas/SnapshotsIndexResponse_273' + - $ref: '#/components/schemas/SnapshotsIndexResponse_279' description: Ok tags: - snapshots @@ -3143,10 +2611,6 @@ paths: $ref: '#/components/schemas/SnapshotsCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsCreateResponse' description: Ok tags: - snapshots @@ -3157,10 +2621,6 @@ paths: operationId: snapshots/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsDetailResponse' description: Ok tags: - snapshots @@ -3176,10 +2636,6 @@ paths: $ref: '#/components/schemas/SnapshotsManageManageRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsManageResponse' description: Ok tags: - snapshots @@ -3204,7 +2660,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SnapshotShowResponse' + oneOf: + - $ref: '#/components/schemas/SnapshotShowResponse_20' + - $ref: '#/components/schemas/SnapshotShowResponse_212' + - $ref: '#/components/schemas/SnapshotShowResponse_217' + - $ref: '#/components/schemas/SnapshotShowResponse_273' description: Ok tags: - snapshots @@ -3223,10 +2683,6 @@ paths: $ref: '#/components/schemas/SnapshotUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotUpdateResponse' description: Ok tags: - snapshots @@ -3251,22 +2707,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SnapshotsActionDeny_AccessResponse' - - $ref: '#/components/schemas/SnapshotsActionForce_DeleteResponse' - - $ref: '#/components/schemas/SnapshotsActionOs-Force_DeleteResponse' - - $ref: '#/components/schemas/SnapshotsActionOs-Reset_StatusResponse' - - $ref: '#/components/schemas/SnapshotsActionReset_StatusResponse' - - $ref: '#/components/schemas/SnapshotsActionUnmanageResponse' description: Ok '202': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsActionAllow_AccessResponse' description: Ok tags: - snapshots @@ -3277,10 +2719,6 @@ paths: operationId: snapshots/resource_id/metadata:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataList_MetadataResponse' description: Ok tags: - snapshots @@ -3297,10 +2735,6 @@ paths: $ref: '#/components/schemas/SnapshotsMetadataCreate_MetadataRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataCreate_MetadataResponse' description: Ok tags: - snapshots @@ -3315,10 +2749,6 @@ paths: $ref: '#/components/schemas/SnapshotsMetadataUpdate_All_MetadataRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataUpdate_All_MetadataResponse' description: Ok tags: - snapshots @@ -3338,10 +2768,6 @@ paths: operationId: snapshots/resource_id/metadata/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataShow_MetadataResponse' description: Ok tags: - snapshots @@ -3359,10 +2785,6 @@ paths: $ref: '#/components/schemas/SnapshotsMetadataUpdate_Metadata_ItemRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataUpdate_Metadata_ItemResponse' description: Ok tags: - snapshots @@ -3373,10 +2795,6 @@ paths: operationId: snapshots/snapshot_id/access-list:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsAccess_ListResponse' description: Ok tags: - snapshots @@ -3389,10 +2807,6 @@ paths: operationId: snapshots/snapshot_id/export-locations:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsExport_LocationsListResponse' description: Ok tags: - snapshots @@ -3405,10 +2819,6 @@ paths: operationId: snapshots/snapshot_id/export-locations/export_location_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsExport_LocationShowResponse' description: Ok tags: - snapshots @@ -3424,10 +2834,6 @@ paths: operationId: types:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesListResponse' description: Ok tags: - types @@ -3441,10 +2847,6 @@ paths: $ref: '#/components/schemas/TypesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesCreateResponse' description: Ok tags: - types @@ -3458,10 +2860,6 @@ paths: operationId: types/default:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesDefaultResponse' description: Ok tags: - types @@ -3481,10 +2879,6 @@ paths: operationId: types/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypeShowResponse' description: Ok tags: - types @@ -3501,10 +2895,6 @@ paths: $ref: '#/components/schemas/TypeUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypeUpdateResponse' description: Ok tags: - types @@ -3529,15 +2919,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/TypesActionAddprojectaccessResponse' - - $ref: '#/components/schemas/TypesActionCreateResponse' - - $ref: '#/components/schemas/TypesActionDeleteResponse' - - $ref: '#/components/schemas/TypesActionRemoveprojectaccessResponse' - - $ref: '#/components/schemas/TypesActionUpdateResponse' description: Ok tags: - types @@ -3546,10 +2927,6 @@ paths: operationId: types/id/os-share-type-access:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesOs_Share_Type_AccessOs-Share-Type-AccessResponse' description: Ok tags: - types @@ -3560,10 +2937,6 @@ paths: operationId: types/id/share_type_access:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesShare_Type_AccessResponse' description: Ok tags: - types @@ -3576,10 +2949,6 @@ paths: operationId: types/type_id/extra_specs:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesExtra_SpecsListResponse' description: Ok tags: - types @@ -3594,10 +2963,6 @@ paths: $ref: '#/components/schemas/TypesExtra_SpecsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesExtra_SpecsCreateResponse' description: Ok tags: - types @@ -3621,10 +2986,6 @@ paths: operationId: types/type_id/extra_specs/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesExtra_SpecShowResponse' description: Ok tags: - types @@ -3640,10 +3001,6 @@ paths: $ref: '#/components/schemas/TypesExtra_SpecUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesExtra_SpecUpdateResponse' description: Ok tags: - types @@ -3697,7 +3054,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_created_before: in: query @@ -3706,7 +3062,6 @@ components: format: date-time type: string x-openstack: - max-ver: '2.51' min-ver: '2.52' messages_created_since: in: query @@ -3715,7 +3070,6 @@ components: format: date-time type: string x-openstack: - max-ver: '2.51' min-ver: '2.52' messages_detail_id: in: query @@ -3723,7 +3077,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_edit_id: description: id parameter for /messages/{id}/edit API @@ -3751,7 +3104,6 @@ components: - integer - string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_message_level: in: query @@ -3759,7 +3111,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_offset: in: query @@ -3773,7 +3124,6 @@ components: - integer - string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_request_id: in: query @@ -3781,7 +3131,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_resource_id: in: query @@ -3789,7 +3138,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_resource_type: in: query @@ -3797,7 +3145,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_sort_dir: in: query @@ -3806,7 +3153,6 @@ components: default: desc type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_sort_key: in: query @@ -3815,7 +3161,6 @@ components: default: created_at type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' os_availability_zone_edit_id: description: id parameter for /os-availability-zone/{id}/edit API @@ -4781,9 +4126,6 @@ components: type: - boolean - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_description: in: query name: description @@ -4791,9 +4133,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_description_: in: query name: description~ @@ -4801,9 +4140,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_edit_id: description: id parameter for /snapshots/{id}/edit API in: path @@ -4845,9 +4181,6 @@ components: type: - integer - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_metadata: in: query name: metadata @@ -4855,9 +4188,6 @@ components: maxLength: 4096 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_metadata_key: description: key parameter for /snapshots/{resource_id}/metadata/{key} API in: path @@ -4880,9 +4210,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_name_: in: query name: name~ @@ -4890,9 +4217,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_offset: in: query name: offset @@ -4904,9 +4228,6 @@ components: type: - integer - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_project_id: in: query name: project_id @@ -4915,8 +4236,6 @@ components: minLength: 1 type: string x-openstack: - max-ver: '2.35' - max_ver: '2.78' resource_link: identity/v3/project.id snapshots_share_id: in: query @@ -4925,9 +4244,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_size: in: query name: size @@ -4939,9 +4255,6 @@ components: type: - integer - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_sort_dir: in: query name: sort_dir @@ -4949,9 +4262,6 @@ components: default: desc description: Sort direction type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_sort_key: in: query name: sort_key @@ -4959,9 +4269,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_status: in: query name: status @@ -4969,9 +4276,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_with_count: in: query name: with_count @@ -5008,9 +4312,6 @@ components: type: - boolean - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' types_action_id: description: id parameter for /types/{id}/action API in: path @@ -5083,7 +4384,7 @@ components: schema: type: string schemas: - Availability_ZonesListResponse: + Availability_ZonesIndexResponse_27: additionalProperties: false properties: availability_zones: @@ -5111,24 +4412,14 @@ components: required: - availability_zones type: object - ExtensionShowResponse: - description: Response of the extensions/id:get operation - type: object + x-openstack: + min-ver: '2.7' ExtensionsCreateRequest: description: Request of the extensions:post operation type: object x-openstack: action-name: create - ExtensionsCreateResponse: - description: Response of the extensions:post operation - type: object - ExtensionsListResponse: - description: Response of the extensions:get operation - type: object - LimitsListResponse: - description: Response of the limits:get operation - type: object - MessageShowResponse: + MessageShowResponse_237: additionalProperties: false properties: message: @@ -5196,7 +4487,98 @@ components: required: - message type: object - MessagesListResponse: + x-openstack: + min-ver: '2.37' + MessagesIndexResponse_237: + additionalProperties: false + properties: + messages: + items: + additionalProperties: false + properties: + action_id: + type: string + created_at: + format: date-time + type: string + detail_id: + type: string + expires_at: + format: date-time + type: string + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + message_level: + enum: + - ERROR + type: string + project_id: + type: string + request_id: + type: string + resource_id: + format: uuid + type: string + resource_type: + type: string + user_message: + type: string + required: + - action_id + - created_at + - detail_id + - expires_at + - id + - links + - message_level + - project_id + - request_id + - resource_id + - resource_type + - user_message + type: object + type: array + messages_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: + - messages + type: object + x-openstack: + max-ver: '2.51' + min-ver: '2.37' + MessagesIndexResponse_252: additionalProperties: false properties: messages: @@ -5282,7 +4664,9 @@ components: required: - messages type: object - Os_Availability_ZoneListResponse: + x-openstack: + min-ver: '2.52' + Os_Availability_ZoneIndexResponse_20: additionalProperties: false properties: availability_zones: @@ -5310,7 +4694,10 @@ components: required: - availability_zones type: object - Os_Quota_Class_SetShowResponse: + x-openstack: + max-ver: '2.6' + min-ver: '2.0' + Os_Quota_Class_SetShowResponse_20: additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: @@ -5346,7 +4733,10 @@ components: required: - quota_class_set type: object - Os_Quota_Class_SetUpdateResponse: + x-openstack: + max-ver: '2.6' + min-ver: '2.0' + Os_Quota_Class_SetUpdateResponse_20: additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: @@ -5382,6 +4772,9 @@ components: required: - quota_class_set type: object + x-openstack: + max-ver: '2.6' + min-ver: '2.0' Os_Quota_Class_SetUpdate_20: additionalProperties: true description: "A ``quota_class_set`` object.\n" @@ -5416,121 +4809,98 @@ components: x-openstack: max-ver: '2.6' min-ver: '2.0' - Os_Quota_SetShowResponse: - description: Response of the os-quota-sets/id:get operation - type: object Os_Quota_SetUpdateRequest: description: Request of the os-quota-sets/id:put operation type: object x-openstack: action-name: update - Os_Quota_SetUpdateResponse: - description: Response of the os-quota-sets/id:put operation - type: object - Os_Quota_SetsDefaultsResponse: - description: Response of the os-quota-sets/id/defaults:get operation - type: object Os_ServiceUpdateRequest: description: Request of the os-services/id:put operation type: object x-openstack: action-name: update - Os_ServiceUpdateResponse: - description: Response of the os-services/id:put operation - type: object - Os_ServicesListResponse: - description: Response of the os-services:get operation - type: object Os_Share_ManageCreateRequest: description: Request of the os-share-manage:post operation type: object x-openstack: action-name: create - Os_Share_ManageCreateResponse: - description: Response of the os-share-manage:post operation - type: object - Os_Share_UnmanageUnmanageResponse: - description: Response of the os-share-unmanage/id/unmanage:post operation - type: object Os_Share_UnmanageUnmanageUnmanageRequest: description: Request of the os-share-unmanage/id/unmanage:post operation type: object x-openstack: action-name: unmanage - Qos_TypeShowResponse: - description: Response of the qos-types/id:get operation - type: object Qos_TypeUpdateRequest: description: Request of the qos-types/id:put operation type: object x-openstack: action-name: update - Qos_TypeUpdateResponse: - description: Response of the qos-types/id:put operation - type: object Qos_TypesCreateRequest: description: Request of the qos-types:post operation type: object x-openstack: action-name: create - Qos_TypesCreateResponse: - description: Response of the qos-types:post operation - type: object - Qos_TypesListResponse: - description: Response of the qos-types:get operation - type: object - Qos_TypesSpecShowResponse: - description: Response of the qos-types/id/specs/key:get operation - type: object Qos_TypesSpecUpdateRequest: description: Request of the qos-types/id/specs/key:put operation type: object x-openstack: action-name: update - Qos_TypesSpecUpdateResponse: - description: Response of the qos-types/id/specs/key:put operation - type: object Qos_TypesSpecsCreateRequest: description: Request of the qos-types/id/specs:post operation type: object x-openstack: action-name: create - Qos_TypesSpecsCreateResponse: - description: Response of the qos-types/id/specs:post operation - type: object - Qos_TypesSpecsListResponse: - description: Response of the qos-types/id/specs:get operation - type: object - Quota_Class_SetShowResponse: + Quota_Class_SetShowResponse_10: additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: additionalProperties: false properties: - backup_gigabytes: - description: "The number of gigabytes for the backups allowed for each - project.\n" + gigabytes: + description: "The number of gigabytes allowed for each project.\n" type: integer - backups: - description: "The number of backups allowed for each project.\n" + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" type: integer - encryption_keys: - description: "The number of encryption keys allowed for each project.\n" + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.39' + min-ver: '1.0' + Quota_Class_SetShowResponse_240: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: gigabytes: description: "The number of gigabytes allowed for each project.\n" type: integer id: description: "A ``quota_class_set`` id.\n" type: string - per_share_gigabytes: - description: "The number of gigabytes per share allowed for each project.\n" - type: integer - replica_gigabytes: - description: "The number of gigabytes for the share replicas allowed - for each project.\n" - type: integer share_group_snapshots: description: "The number of share group snapshots allowed for each project or user.\n" @@ -5542,9 +4912,6 @@ components: share_networks: description: "The number of share networks allowed for each project.\n" type: integer - share_replicas: - description: "The number of share replicas allowed for each project.\n" - type: integer shares: description: "The number of shares allowed for each project.\n" type: integer @@ -5556,16 +4923,10 @@ components: description: "The number of snapshots allowed for each project.\n" type: integer required: - - backup_gigabytes - - backups - - encryption_keys - gigabytes - - per_share_gigabytes - - replica_gigabytes - share_group_snapshots - share_groups - share_networks - - share_replicas - shares - snapshot_gigabytes - snapshots @@ -5573,41 +4934,22 @@ components: required: - quota_class_set type: object - Quota_Class_SetUpdateRequest: - oneOf: - - $ref: '#/components/schemas/Quota_Class_SetUpdate_253' - - $ref: '#/components/schemas/Quota_Class_SetUpdate_262' - - $ref: '#/components/schemas/Quota_Class_SetUpdate_27' - - $ref: '#/components/schemas/Quota_Class_SetUpdate_280' - - $ref: '#/components/schemas/Quota_Class_SetUpdate_290' x-openstack: - discriminator: microversion - Quota_Class_SetUpdateResponse: + max-ver: '2.52' + min-ver: '2.40' + Quota_Class_SetShowResponse_253: additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: additionalProperties: false properties: - backup_gigabytes: - description: "The number of gigabytes for the backups allowed for each - project.\n" - type: integer - backups: - description: "The number of backups allowed for each project.\n" - type: integer - encryption_keys: - description: "The number of encryption keys allowed for each project.\n" - type: integer gigabytes: description: "The number of gigabytes allowed for each project.\n" type: integer id: description: "A ``quota_class_set`` id.\n" type: string - per_share_gigabytes: - description: "The number of gigabytes per share allowed for each project.\n" - type: integer replica_gigabytes: description: "The number of gigabytes for the share replicas allowed for each project.\n" @@ -5637,11 +4979,7 @@ components: description: "The number of snapshots allowed for each project.\n" type: integer required: - - backup_gigabytes - - backups - - encryption_keys - gigabytes - - per_share_gigabytes - replica_gigabytes - share_group_snapshots - share_groups @@ -5654,84 +4992,64 @@ components: required: - quota_class_set type: object - Quota_Class_SetUpdate_253: - additionalProperties: true + x-openstack: + max-ver: '2.61' + min-ver: '2.53' + Quota_Class_SetShowResponse_262: + additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" + additionalProperties: false properties: gigabytes: - description: "The number of gigabytes for the project.\n" + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + per_share_gigabytes: + description: "The number of gigabytes per share allowed for each project.\n" type: integer replica_gigabytes: - description: "The number of gigabytes for share replicas for the project.\n" + description: "The number of gigabytes for the share replicas allowed + for each project.\n" + type: integer + share_group_snapshots: + description: "The number of share group snapshots allowed for each project + or user.\n" type: integer share_groups: description: "The number of share groups allowed for each project or user.\n" type: integer share_networks: - description: "The number of share networks for the project.\n" + description: "The number of share networks allowed for each project.\n" type: integer share_replicas: - description: "The number of share replicas allowed for each project - or user.\n" + description: "The number of share replicas allowed for each project.\n" type: integer shares: - description: "The number of shares for the project.\n" + description: "The number of shares allowed for each project.\n" type: integer snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" + description: "The number of gigabytes for the snapshots allowed for + each project.\n" type: integer snapshots: - description: "The number of snapshots for the project.\n" - type: integer - type: object - required: - - quota_class_set - type: object - x-openstack: - max-ver: '2.61' - min-ver: '2.53' - Quota_Class_SetUpdate_262: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" - properties: - quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" - properties: - gigabytes: - description: "The number of gigabytes for the project.\n" - type: integer - per_share_gigabytes: - description: "The number of gigabytes per share allowed for each project.\n" - type: integer - replica_gigabytes: - description: "The number of gigabytes for share replicas for the project.\n" - type: integer - share_groups: - description: "The number of share groups allowed for each project or - user.\n" - type: integer - share_networks: - description: "The number of share networks for the project.\n" - type: integer - share_replicas: - description: "The number of share replicas allowed for each project - or user.\n" - type: integer - shares: - description: "The number of shares for the project.\n" - type: integer - snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" - type: integer - snapshots: - description: "The number of snapshots for the project.\n" + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - gigabytes + - per_share_gigabytes + - replica_gigabytes + - share_group_snapshots + - share_groups + - share_networks + - share_replicas + - shares + - snapshot_gigabytes + - snapshots type: object required: - quota_class_set @@ -5739,83 +5057,108 @@ components: x-openstack: max-ver: '2.79' min-ver: '2.62' - Quota_Class_SetUpdate_27: - additionalProperties: true + Quota_Class_SetShowResponse_27: + additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" + additionalProperties: false properties: gigabytes: - description: "The number of gigabytes for the project.\n" - type: integer - share_groups: - description: "The number of share groups allowed for each project or - user.\n" + description: "The number of gigabytes allowed for each project.\n" type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string share_networks: - description: "The number of share networks for the project.\n" + description: "The number of share networks allowed for each project.\n" type: integer shares: - description: "The number of shares for the project.\n" + description: "The number of shares allowed for each project.\n" type: integer snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" + description: "The number of gigabytes for the snapshots allowed for + each project.\n" type: integer snapshots: - description: "The number of snapshots for the project.\n" + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots type: object required: - quota_class_set type: object x-openstack: - max-ver: '2.52' min-ver: '2.7' - Quota_Class_SetUpdate_280: - additionalProperties: true + Quota_Class_SetShowResponse_280: + additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" + additionalProperties: false properties: backup_gigabytes: - description: "The number of gigabytes for the backups for the\nproject.\n" + description: "The number of gigabytes for the backups allowed for each + project.\n" type: integer backups: - description: "The number of backups for the project.\n" + description: "The number of backups allowed for each project.\n" type: integer gigabytes: - description: "The number of gigabytes for the project.\n" + description: "The number of gigabytes allowed for each project.\n" type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string per_share_gigabytes: description: "The number of gigabytes per share allowed for each project.\n" type: integer replica_gigabytes: - description: "The number of gigabytes for share replicas for the project.\n" + description: "The number of gigabytes for the share replicas allowed + for each project.\n" + type: integer + share_group_snapshots: + description: "The number of share group snapshots allowed for each project + or user.\n" type: integer share_groups: description: "The number of share groups allowed for each project or user.\n" type: integer share_networks: - description: "The number of share networks for the project.\n" + description: "The number of share networks allowed for each project.\n" type: integer share_replicas: - description: "The number of share replicas allowed for each project - or user.\n" + description: "The number of share replicas allowed for each project.\n" type: integer shares: - description: "The number of shares for the project.\n" + description: "The number of shares allowed for each project.\n" type: integer snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" + description: "The number of gigabytes for the snapshots allowed for + each project.\n" type: integer snapshots: - description: "The number of snapshots for the project.\n" + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - backup_gigabytes + - backups + - gigabytes + - per_share_gigabytes + - replica_gigabytes + - share_group_snapshots + - share_groups + - share_networks + - share_replicas + - shares + - snapshot_gigabytes + - snapshots type: object required: - quota_class_set @@ -5823,137 +5166,619 @@ components: x-openstack: max-ver: '2.89' min-ver: '2.80' - Quota_Class_SetUpdate_290: - additionalProperties: true + Quota_Class_SetShowResponse_290: + additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" + additionalProperties: false properties: backup_gigabytes: - description: "The number of gigabytes for the backups for the\nproject.\n" + description: "The number of gigabytes for the backups allowed for each + project.\n" type: integer backups: - description: "The number of backups for the project.\n" + description: "The number of backups allowed for each project.\n" type: integer encryption_keys: description: "The number of encryption keys allowed for each project.\n" type: integer gigabytes: - description: "The number of gigabytes for the project.\n" + description: "The number of gigabytes allowed for each project.\n" type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string per_share_gigabytes: description: "The number of gigabytes per share allowed for each project.\n" type: integer replica_gigabytes: - description: "The number of gigabytes for share replicas for the project.\n" + description: "The number of gigabytes for the share replicas allowed + for each project.\n" + type: integer + share_group_snapshots: + description: "The number of share group snapshots allowed for each project + or user.\n" type: integer share_groups: description: "The number of share groups allowed for each project or user.\n" type: integer share_networks: - description: "The number of share networks for the project.\n" + description: "The number of share networks allowed for each project.\n" type: integer share_replicas: - description: "The number of share replicas allowed for each project - or user.\n" + description: "The number of share replicas allowed for each project.\n" type: integer shares: - description: "The number of shares for the project.\n" + description: "The number of shares allowed for each project.\n" type: integer snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" + description: "The number of gigabytes for the snapshots allowed for + each project.\n" type: integer snapshots: - description: "The number of snapshots for the project.\n" + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - backup_gigabytes + - backups + - encryption_keys + - gigabytes + - per_share_gigabytes + - replica_gigabytes + - share_group_snapshots + - share_groups + - share_networks + - share_replicas + - shares + - snapshot_gigabytes + - snapshots type: object required: - quota_class_set type: object x-openstack: - max-ver: '2.52' min-ver: '2.90' - Quota_SetShowResponse: - description: Response of the quota-sets/id:get operation - type: object - Quota_SetUpdateRequest: - description: Request of the quota-sets/id:put operation - type: object + Quota_Class_SetUpdateRequest: + oneOf: + - $ref: '#/components/schemas/Quota_Class_SetUpdate_253' + - $ref: '#/components/schemas/Quota_Class_SetUpdate_262' + - $ref: '#/components/schemas/Quota_Class_SetUpdate_27' + - $ref: '#/components/schemas/Quota_Class_SetUpdate_280' + - $ref: '#/components/schemas/Quota_Class_SetUpdate_290' x-openstack: - action-name: update - Quota_SetUpdateResponse: - description: Response of the quota-sets/id:put operation - type: object - Quota_SetsDefaultsResponse: - description: Response of the quota-sets/id/defaults:get operation - type: object - Quota_SetsDetailResponse: - description: Response of the quota-sets/id/detail:get operation - type: object - Resource_LockShowResponse: + discriminator: microversion + Quota_Class_SetUpdateResponse_240: additionalProperties: false + description: "A ``quota_class_set`` object.\n" properties: - resource_lock: + quota_class_set: additionalProperties: false - description: "A resource lock object when making resource lock requests. - All other\nparameters are included in this object.\n" properties: - created_at: - description: "The date and time stamp when the resource was created - within the service's\ndatabase.\n\nThe date and time stamp format - is `ISO 8601\n`_:\n\n::\n\n\ - \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, - returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" - format: date-time - type: string + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer id: - description: "The UUID identifying the specific resource lock.\n" - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - lock_context: - description: "The lock creator's context. Resource locks can be created - by users with\ndifferent roles. If a user with ``admin`` role creates - the lock, the value\nof this field is ``admin``. If a user with ``service`` - role creates the\nlock, the value of this field is ``service``. For - all other contexts, the\nvalue of this field is ``user``. This field - also determines the user's\nrole that is required to unlock or manipulate - a lock by virtue of the\nservice's default RBAC.\n" - type: string - lock_reason: - description: "A blob of text representing the reason for the specific - resource lock.\n" - type: - - 'null' - - string - project_id: - description: "The ID of the project that the resource lock was created - for.\n" - format: uuid + description: "A ``quota_class_set`` id.\n" type: string - resource_action: - description: "The action pertaining to a resource that the resource - lock prevents. For\nexample, if a resource lock prevents deletion - of a share, the value of\n``resource_action`` is ``delete``. Resource + share_group_snapshots: + description: "The number of share group snapshots allowed for each project + or user.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_group_snapshots + - share_groups + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.52' + min-ver: '2.40' + Quota_Class_SetUpdateResponse_253: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.61' + min-ver: '2.53' + Quota_Class_SetUpdateResponse_262: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.79' + min-ver: '2.62' + Quota_Class_SetUpdateResponse_27: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.39' + min-ver: '2.7' + Quota_Class_SetUpdateResponse_280: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.89' + min-ver: '2.80' + Quota_Class_SetUpdateResponse_290: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + min-ver: '2.90' + Quota_Class_SetUpdate_253: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + replica_gigabytes: + description: "The number of gigabytes for share replicas for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + share_replicas: + description: "The number of share replicas allowed for each project + or user.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.61' + min-ver: '2.53' + Quota_Class_SetUpdate_262: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + per_share_gigabytes: + description: "The number of gigabytes per share allowed for each project.\n" + type: integer + replica_gigabytes: + description: "The number of gigabytes for share replicas for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + share_replicas: + description: "The number of share replicas allowed for each project + or user.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.79' + min-ver: '2.62' + Quota_Class_SetUpdate_27: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.52' + min-ver: '2.7' + Quota_Class_SetUpdate_280: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + backup_gigabytes: + description: "The number of gigabytes for the backups for the\nproject.\n" + type: integer + backups: + description: "The number of backups for the project.\n" + type: integer + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + per_share_gigabytes: + description: "The number of gigabytes per share allowed for each project.\n" + type: integer + replica_gigabytes: + description: "The number of gigabytes for share replicas for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + share_replicas: + description: "The number of share replicas allowed for each project + or user.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.89' + min-ver: '2.80' + Quota_Class_SetUpdate_290: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + backup_gigabytes: + description: "The number of gigabytes for the backups for the\nproject.\n" + type: integer + backups: + description: "The number of backups for the project.\n" + type: integer + encryption_keys: + description: "The number of encryption keys allowed for each project.\n" + type: integer + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + per_share_gigabytes: + description: "The number of gigabytes per share allowed for each project.\n" + type: integer + replica_gigabytes: + description: "The number of gigabytes for share replicas for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + share_replicas: + description: "The number of share replicas allowed for each project + or user.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + min-ver: '2.90' + Quota_SetUpdateRequest: + description: Request of the quota-sets/id:put operation + type: object + x-openstack: + action-name: update + Resource_LockShowResponse_281: + additionalProperties: false + properties: + resource_lock: + additionalProperties: false + description: "A resource lock object when making resource lock requests. + All other\nparameters are included in this object.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + type: string + id: + description: "The UUID identifying the specific resource lock.\n" + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + lock_context: + description: "The lock creator's context. Resource locks can be created + by users with\ndifferent roles. If a user with ``admin`` role creates + the lock, the value\nof this field is ``admin``. If a user with ``service`` + role creates the\nlock, the value of this field is ``service``. For + all other contexts, the\nvalue of this field is ``user``. This field + also determines the user's\nrole that is required to unlock or manipulate + a lock by virtue of the\nservice's default RBAC.\n" + type: string + lock_reason: + description: "A blob of text representing the reason for the specific + resource lock.\n" + type: + - 'null' + - string + project_id: + description: "The ID of the project that the resource lock was created + for.\n" + format: uuid + type: string + resource_action: + description: "The action pertaining to a resource that the resource + lock prevents. For\nexample, if a resource lock prevents deletion + of a share, the value of\n``resource_action`` is ``delete``. Resource locks are not supported for\nall API actions.\n" enum: - delete @@ -6005,7 +5830,9 @@ components: required: - resource_lock type: object - Resource_LockUpdateResponse: + x-openstack: + min-ver: '2.81' + Resource_LockUpdateResponse_281: additionalProperties: false properties: resource_lock: @@ -6117,6 +5944,8 @@ components: required: - resource_lock type: object + x-openstack: + min-ver: '2.81' Resource_LockUpdate_281: additionalProperties: true properties: @@ -6150,7 +5979,7 @@ components: type: object x-openstack: min-ver: '2.81' - Resource_LocksCreateResponse: + Resource_LocksCreateResponse_281: additionalProperties: false properties: resource_lock: @@ -6262,6 +6091,8 @@ components: required: - resource_lock type: object + x-openstack: + min-ver: '2.81' Resource_LocksCreate_281: additionalProperties: true properties: @@ -6319,7 +6150,7 @@ components: type: object x-openstack: min-ver: '2.81' - Resource_LocksListResponse: + Resource_LocksIndexResponse_281: additionalProperties: false properties: count: @@ -6456,48 +6287,23 @@ components: required: - resource_locks type: object - RootListResponse: - description: Response of the :get operation - type: object - Scheduler_StatsPoolsDetailPools_DetailResponse: - description: Response of the scheduler-stats/pools/detail:get operation - type: object - Scheduler_StatsPoolsPools_ListResponse: - description: Response of the scheduler-stats/pools:get operation - type: object - Security_ServiceShowResponse: - description: Response of the security-services/id:get operation - type: object + x-openstack: + min-ver: '2.81' Security_ServiceUpdateRequest: description: Request of the security-services/id:put operation type: object x-openstack: action-name: update - Security_ServiceUpdateResponse: - description: Response of the security-services/id:put operation - type: object Security_ServicesCreateRequest: description: Request of the security-services:post operation type: object x-openstack: action-name: create - Security_ServicesCreateResponse: - description: Response of the security-services:post operation - type: object - Security_ServicesDetailResponse: - description: Response of the security-services/detail:get operation - type: object - Security_ServicesListResponse: - description: Response of the security-services:get operation - type: object ServiceUpdateRequest: description: Request of the services/id:put operation type: object x-openstack: action-name: update - ServiceUpdateResponse: - description: Response of the services/id:put operation - type: object ServicesEnsure_SharesEnsure_Shares_286: additionalProperties: false properties: @@ -6516,57 +6322,27 @@ components: type: object x-openstack: min-ver: '2.86' - ServicesEnsure_SharesResponse: - type: 'null' - ServicesListResponse: - description: Response of the services:get operation - type: object - ShareShowResponse: - description: Response of the shares/id:get operation - type: object ShareUpdateRequest: description: Request of the shares/id:put operation type: object x-openstack: action-name: update - ShareUpdateResponse: - description: Response of the shares/id:put operation - type: object - Share_Access_RuleShowResponse: - description: Response of the share-access-rules/id:get operation - type: object Share_Access_RuleUpdateRequest: description: Request of the share-access-rules/id:put operation type: object x-openstack: action-name: update - Share_Access_RuleUpdateResponse: - description: Response of the share-access-rules/id:put operation - type: object - Share_Access_RulesListResponse: - description: Response of the share-access-rules:get operation - type: object Share_Access_RulesMetadataUpdateRequest: description: Request of the share-access-rules/access_id/metadata:put operation type: object x-openstack: action-name: update - Share_Access_RulesMetadataUpdateResponse: - description: Response of the share-access-rules/access_id/metadata:put - operation - type: object - Share_BackupShowResponse: - description: Response of the share-backups/id:get operation - type: object Share_BackupUpdateRequest: description: Request of the share-backups/id:put operation type: object x-openstack: action-name: update - Share_BackupUpdateResponse: - description: Response of the share-backups/id:put operation - type: object Share_BackupsActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -6575,12 +6351,6 @@ components: type: object x-openstack: action-name: reset_status - Share_BackupsActionReset_StatusResponse: - description: Response of the share-backups/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_BackupsActionRestoreRequest: description: Empty body for restore action properties: @@ -6589,47 +6359,21 @@ components: type: object x-openstack: action-name: restore - Share_BackupsActionRestoreResponse: - description: Response of the share-backups/id/action:post:restore action - type: object - x-openstack: - action-name: restore Share_BackupsCreateRequest: description: Request of the share-backups:post operation type: object x-openstack: action-name: create - Share_BackupsCreateResponse: - description: Response of the share-backups:post operation - type: object - Share_BackupsDetailResponse: - description: Response of the share-backups/detail:get operation - type: object - Share_BackupsListResponse: - description: Response of the share-backups:get operation - type: object - Share_GroupShowResponse: - description: Response of the share-groups/id:get operation - type: object Share_GroupUpdateRequest: description: Request of the share-groups/id:put operation type: object x-openstack: action-name: update - Share_GroupUpdateResponse: - description: Response of the share-groups/id:put operation - type: object - Share_Group_SnapshotShowResponse: - description: Response of the share-group-snapshots/id:get operation - type: object Share_Group_SnapshotUpdateRequest: description: Request of the share-group-snapshots/id:put operation type: object x-openstack: action-name: update - Share_Group_SnapshotUpdateResponse: - description: Response of the share-group-snapshots/id:put operation - type: object Share_Group_SnapshotsActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -6638,12 +6382,6 @@ components: type: object x-openstack: action-name: force_delete - Share_Group_SnapshotsActionForce_DeleteResponse: - description: Response of the - share-group-snapshots/id/action:post:force_delete action - type: object - x-openstack: - action-name: force_delete Share_Group_SnapshotsActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -6652,36 +6390,11 @@ components: type: object x-openstack: action-name: reset_status - Share_Group_SnapshotsActionReset_StatusResponse: - description: Response of the - share-group-snapshots/id/action:post:reset_status action - type: object - x-openstack: - action-name: reset_status Share_Group_SnapshotsCreateRequest: description: Request of the share-group-snapshots:post operation type: object x-openstack: action-name: create - Share_Group_SnapshotsCreateResponse: - description: Response of the share-group-snapshots:post operation - type: object - Share_Group_SnapshotsDetailResponse: - description: Response of the share-group-snapshots/detail:get operation - type: object - Share_Group_SnapshotsListResponse: - description: Response of the share-group-snapshots:get operation - type: object - Share_Group_SnapshotsMembersResponse: - description: Response of the share-group-snapshots/id/members:get - operation - type: object - Share_Group_TypeShowResponse: - description: Response of the share-group-types/id:get operation - type: object - Share_Group_TypesAccessShare_Group_Type_AccessResponse: - description: Response of the share-group-types/id/access:get operation - type: object Share_Group_TypesActionAddprojectaccessRequest: description: Empty body for addProjectAccess action properties: @@ -6690,12 +6403,6 @@ components: type: object x-openstack: action-name: addProjectAccess - Share_Group_TypesActionAddprojectaccessResponse: - description: Response of the - share-group-types/id/action:post:addProjectAccess action - type: object - x-openstack: - action-name: addProjectAccess Share_Group_TypesActionCreateRequest: description: Empty body for create action properties: @@ -6704,12 +6411,6 @@ components: type: object x-openstack: action-name: create - Share_Group_TypesActionCreateResponse: - description: Response of the share-group-types/id/action:post:create - action - type: object - x-openstack: - action-name: create Share_Group_TypesActionDeleteRequest: description: Empty body for delete action properties: @@ -6718,12 +6419,6 @@ components: type: object x-openstack: action-name: delete - Share_Group_TypesActionDeleteResponse: - description: Response of the share-group-types/id/action:post:delete - action - type: object - x-openstack: - action-name: delete Share_Group_TypesActionRemoveprojectaccessRequest: description: Empty body for removeProjectAccess action properties: @@ -6732,56 +6427,23 @@ components: type: object x-openstack: action-name: removeProjectAccess - Share_Group_TypesActionRemoveprojectaccessResponse: - description: Response of the - share-group-types/id/action:post:removeProjectAccess action - type: object - x-openstack: - action-name: removeProjectAccess Share_Group_TypesCreateRequest: description: Request of the share-group-types:post operation type: object x-openstack: action-name: create - Share_Group_TypesCreateResponse: - description: Response of the share-group-types:post:create action - type: object - x-openstack: - action-name: create - Share_Group_TypesDefaultResponse: - description: Response of the share-group-types/default:get operation - type: object - Share_Group_TypesGroup_SpecShowResponse: - description: Response of the share-group-types/id/group-specs/key:get - operation - type: object Share_Group_TypesGroup_SpecUpdateRequest: description: Request of the share-group-types/id/group-specs/key:put operation type: object x-openstack: action-name: update - Share_Group_TypesGroup_SpecUpdateResponse: - description: Response of the share-group-types/id/group-specs/key:put - operation - type: object Share_Group_TypesGroup_SpecsCreateRequest: description: Request of the share-group-types/id/group-specs:post operation type: object x-openstack: action-name: create - Share_Group_TypesGroup_SpecsCreateResponse: - description: Response of the share-group-types/id/group-specs:post - operation - type: object - Share_Group_TypesGroup_SpecsListResponse: - description: Response of the share-group-types/id/group-specs:get - operation - type: object - Share_Group_TypesListResponse: - description: Response of the share-group-types:get operation - type: object Share_GroupsActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -6790,12 +6452,6 @@ components: type: object x-openstack: action-name: force_delete - Share_GroupsActionForce_DeleteResponse: - description: Response of the share-groups/id/action:post:force_delete - action - type: object - x-openstack: - action-name: force_delete Share_GroupsActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -6804,29 +6460,11 @@ components: type: object x-openstack: action-name: reset_status - Share_GroupsActionReset_StatusResponse: - description: Response of the share-groups/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_GroupsCreateRequest: description: Request of the share-groups:post operation type: object x-openstack: action-name: create - Share_GroupsCreateResponse: - description: Response of the share-groups:post operation - type: object - Share_GroupsDetailResponse: - description: Response of the share-groups/detail:get operation - type: object - Share_GroupsListResponse: - description: Response of the share-groups:get operation - type: object - Share_InstanceShowResponse: - description: Response of the share_instances/id:get operation - type: object Share_InstancesActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -6835,12 +6473,6 @@ components: type: object x-openstack: action-name: force_delete - Share_InstancesActionForce_DeleteResponse: - description: Response of the share_instances/id/action:post:force_delete - action - type: object - x-openstack: - action-name: force_delete Share_InstancesActionOs-Force_DeleteRequest: description: Empty body for os-force_delete action properties: @@ -6849,12 +6481,6 @@ components: type: object x-openstack: action-name: os-force_delete - Share_InstancesActionOs-Force_DeleteResponse: - description: Response of the - share_instances/id/action:post:os-force_delete action - type: object - x-openstack: - action-name: os-force_delete Share_InstancesActionOs-Reset_StatusRequest: description: Empty body for os-reset_status action properties: @@ -6863,12 +6489,6 @@ components: type: object x-openstack: action-name: os-reset_status - Share_InstancesActionOs-Reset_StatusResponse: - description: Response of the - share_instances/id/action:post:os-reset_status action - type: object - x-openstack: - action-name: os-reset_status Share_InstancesActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -6877,13 +6497,73 @@ components: type: object x-openstack: action-name: reset_status - Share_InstancesActionReset_StatusResponse: - description: Response of the share_instances/id/action:post:reset_status - action + Share_InstancesExport_LocationShowResponse_214: + additionalProperties: false + properties: + export_location: + additionalProperties: false + description: "The export location. For newer API versions it is available + in\nseparate APIs. See sections `Share export locations\n<#share-share-export-locations>`_ + and `Share instance export\nlocations <#share-share-instance-export-locations>`_.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + readonly: true + type: string + id: + description: "The share export location UUID.\n" + readonly: true + type: string + is_admin_only: + description: "Defines purpose of an export location. If set to\n``true``, + then it is expected to be used for service needs and by\nadministrators + only. If it is set to ``false``, then this export\nlocation can be + used by end users. This parameter is only available to\nusers with + an \"administrator\" role, and cannot be controlled via policy\n.json.\n" + type: boolean + path: + description: "The export location path that should be used for mount + operation.\n" + type: string + preferred: + description: "Drivers may use this field to identify which export locations\n\ + are most efficient and should be used preferentially by clients.\n\ + By default it is set to ``false`` value.\n" + type: boolean + share_instance_id: + description: "The UUID of the share instance that this\nexport location + belongs to. This parameter is only available to users\nwith an \"\ + administrator\" role, and cannot be controlled via policy.yaml.\n" + type: string + updated_at: + description: "The date and time stamp when the resource was last updated + within the\nservice's database. If a resource was never updated after + it was\ncreated, the value of this parameter is set to ``null``.\n\ + \nThe date and time stamp format is `ISO 8601\n`_:\n\ + \n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n" + format: date-time + readonly: true + type: string + required: + - created_at + - id + - path + - preferred + - updated_at + type: object + required: + - export_location type: object x-openstack: - action-name: reset_status - Share_InstancesExport_LocationShowResponse: + max-ver: '2.86' + min-ver: '2.14' + Share_InstancesExport_LocationShowResponse_287: additionalProperties: false properties: export_location: @@ -6953,7 +6633,113 @@ components: required: - export_location type: object - Share_InstancesExport_LocationsListResponse: + x-openstack: + min-ver: '2.87' + Share_InstancesExport_LocationShowResponse_29: + additionalProperties: false + properties: + export_location: + additionalProperties: false + description: "The export location. For newer API versions it is available + in\nseparate APIs. See sections `Share export locations\n<#share-share-export-locations>`_ + and `Share instance export\nlocations <#share-share-instance-export-locations>`_.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + readonly: true + type: string + id: + description: "The share export location UUID.\n" + readonly: true + type: string + is_admin_only: + description: "Defines purpose of an export location. If set to\n``true``, + then it is expected to be used for service needs and by\nadministrators + only. If it is set to ``false``, then this export\nlocation can be + used by end users. This parameter is only available to\nusers with + an \"administrator\" role, and cannot be controlled via policy\n.json.\n" + type: boolean + path: + description: "The export location path that should be used for mount + operation.\n" + type: string + share_instance_id: + description: "The UUID of the share instance that this\nexport location + belongs to. This parameter is only available to users\nwith an \"\ + administrator\" role, and cannot be controlled via policy.yaml.\n" + type: string + updated_at: + description: "The date and time stamp when the resource was last updated + within the\nservice's database. If a resource was never updated after + it was\ncreated, the value of this parameter is set to ``null``.\n\ + \nThe date and time stamp format is `ISO 8601\n`_:\n\ + \n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n" + format: date-time + readonly: true + type: string + required: + - created_at + - id + - path + - updated_at + type: object + required: + - export_location + type: object + x-openstack: + max-ver: '2.13' + min-ver: '2.9' + Share_InstancesExport_LocationsIndexResponse_214: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + description: "The share export location UUID.\n" + type: string + is_admin_only: + description: "Defines purpose of an export location. If set to\n``true``, + then it is expected to be used for service needs and by\nadministrators + only. If it is set to ``false``, then this export\nlocation can + be used by end users. This parameter is only available to\nusers + with an \"administrator\" role, and cannot be controlled via policy\n\ + .json.\n" + type: boolean + path: + description: "The export location path that should be used for mount + operation.\n" + type: string + preferred: + description: "Drivers may use this field to identify which export + locations\nare most efficient and should be used preferentially + by clients.\nBy default it is set to ``false`` value.\n" + type: boolean + share_instance_id: + description: "The UUID of the share instance that this\nexport location + belongs to. This parameter is only available to users\nwith an \"\ + administrator\" role, and cannot be controlled via policy.yaml.\n" + type: string + required: + - id + - path + - preferred + type: object + type: array + required: + - export_locations + type: object + x-openstack: + max-ver: '2.86' + min-ver: '2.14' + Share_InstancesExport_LocationsIndexResponse_287: additionalProperties: false properties: export_locations: @@ -7001,20 +6787,51 @@ components: required: - export_locations type: object - Share_InstancesListResponse: - description: Response of the share_instances:get operation - type: object - Share_NetworkShowResponse: - description: Response of the share-networks/id:get operation + x-openstack: + min-ver: '2.87' + Share_InstancesExport_LocationsIndexResponse_29: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + description: "The share export location UUID.\n" + type: string + is_admin_only: + description: "Defines purpose of an export location. If set to\n``true``, + then it is expected to be used for service needs and by\nadministrators + only. If it is set to ``false``, then this export\nlocation can + be used by end users. This parameter is only available to\nusers + with an \"administrator\" role, and cannot be controlled via policy\n\ + .json.\n" + type: boolean + path: + description: "The export location path that should be used for mount + operation.\n" + type: string + share_instance_id: + description: "The UUID of the share instance that this\nexport location + belongs to. This parameter is only available to users\nwith an \"\ + administrator\" role, and cannot be controlled via policy.yaml.\n" + type: string + required: + - id + - path + type: object + type: array + required: + - export_locations type: object + x-openstack: + max-ver: '2.13' + min-ver: '2.9' Share_NetworkUpdateRequest: description: Request of the share-networks/id:put operation type: object x-openstack: action-name: update - Share_NetworkUpdateResponse: - description: Response of the share-networks/id:put operation - type: object Share_NetworksActionAdd_Security_ServiceRequest: description: Empty body for add_security_service action properties: @@ -7023,12 +6840,6 @@ components: type: object x-openstack: action-name: add_security_service - Share_NetworksActionAdd_Security_ServiceResponse: - description: Response of the - share-networks/id/action:post:add_security_service action - type: object - x-openstack: - action-name: add_security_service Share_NetworksActionAdd_Security_Service_CheckRequest: description: Empty body for add_security_service_check action properties: @@ -7037,12 +6848,6 @@ components: type: object x-openstack: action-name: add_security_service_check - Share_NetworksActionAdd_Security_Service_CheckResponse: - description: Response of the - share-networks/id/action:post:add_security_service_check action - type: object - x-openstack: - action-name: add_security_service_check Share_NetworksActionRemove_Security_ServiceRequest: description: Empty body for remove_security_service action properties: @@ -7051,12 +6856,6 @@ components: type: object x-openstack: action-name: remove_security_service - Share_NetworksActionRemove_Security_ServiceResponse: - description: Response of the - share-networks/id/action:post:remove_security_service action - type: object - x-openstack: - action-name: remove_security_service Share_NetworksActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -7065,12 +6864,6 @@ components: type: object x-openstack: action-name: reset_status - Share_NetworksActionReset_StatusResponse: - description: Response of the share-networks/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_NetworksActionShare_Network_Subnet_Create_CheckRequest: description: Empty body for share_network_subnet_create_check action properties: @@ -7079,12 +6872,6 @@ components: type: object x-openstack: action-name: share_network_subnet_create_check - Share_NetworksActionShare_Network_Subnet_Create_CheckResponse: - description: Response of the - share-networks/id/action:post:share_network_subnet_create_check action - type: object - x-openstack: - action-name: share_network_subnet_create_check Share_NetworksActionUpdate_Security_ServiceRequest: description: Empty body for update_security_service action properties: @@ -7093,12 +6880,6 @@ components: type: object x-openstack: action-name: update_security_service - Share_NetworksActionUpdate_Security_ServiceResponse: - description: Response of the - share-networks/id/action:post:update_security_service action - type: object - x-openstack: - action-name: update_security_service Share_NetworksActionUpdate_Security_Service_CheckRequest: description: Empty body for update_security_service_check action properties: @@ -7107,45 +6888,17 @@ components: type: object x-openstack: action-name: update_security_service_check - Share_NetworksActionUpdate_Security_Service_CheckResponse: - description: Response of the - share-networks/id/action:post:update_security_service_check action - type: object - x-openstack: - action-name: update_security_service_check Share_NetworksCreateRequest: description: Request of the share-networks:post operation type: object x-openstack: action-name: create - Share_NetworksCreateResponse: - description: Response of the share-networks:post operation - type: object - Share_NetworksDetailResponse: - description: Response of the share-networks/detail:get operation - type: object - Share_NetworksListResponse: - description: Response of the share-networks:get operation - type: object - Share_NetworksSubnetShowResponse: - description: Response of the - share-networks/share_network_id/subnets/share_network_subnet_id:get - operation - type: object Share_NetworksSubnetsCreateRequest: description: Request of the share-networks/share_network_id/subnets:post operation type: object x-openstack: action-name: create - Share_NetworksSubnetsCreateResponse: - description: Response of the share-networks/share_network_id/subnets:post - operation - type: object - Share_NetworksSubnetsListResponse: - description: Response of the share-networks/share_network_id/subnets:get - operation - type: object Share_NetworksSubnetsMetadataCreate_MetadataRequest: description: Request of the share-networks/share_network_id/subnets/resource_id/metadata:post @@ -7153,21 +6906,6 @@ components: type: object x-openstack: action-name: create_metadata - Share_NetworksSubnetsMetadataCreate_MetadataResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata:post - operation - type: object - Share_NetworksSubnetsMetadataList_MetadataResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata:get - operation - type: object - Share_NetworksSubnetsMetadataShow_MetadataResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata/key:get - operation - type: object Share_NetworksSubnetsMetadataUpdate_All_MetadataRequest: description: Request of the share-networks/share_network_id/subnets/resource_id/metadata:put @@ -7175,11 +6913,6 @@ components: type: object x-openstack: action-name: update_all_metadata - Share_NetworksSubnetsMetadataUpdate_All_MetadataResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata:put - operation - type: object Share_NetworksSubnetsMetadataUpdate_Metadata_ItemRequest: description: Request of the share-networks/share_network_id/subnets/resource_id/metadata/key:post @@ -7187,14 +6920,6 @@ components: type: object x-openstack: action-name: update_metadata_item - Share_NetworksSubnetsMetadataUpdate_Metadata_ItemResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata/key:post - operation - type: object - Share_ReplicaShowResponse: - description: Response of the share-replicas/id:get operation - type: object Share_ReplicasActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -7203,12 +6928,6 @@ components: type: object x-openstack: action-name: force_delete - Share_ReplicasActionForce_DeleteResponse: - description: Response of the share-replicas/id/action:post:force_delete - action - type: object - x-openstack: - action-name: force_delete Share_ReplicasActionPromoteRequest: description: Empty body for promote action properties: @@ -7217,11 +6936,6 @@ components: type: object x-openstack: action-name: promote - Share_ReplicasActionPromoteResponse: - description: Response of the share-replicas/id/action:post:promote action - type: object - x-openstack: - action-name: promote Share_ReplicasActionReset_Replica_StateRequest: description: Empty body for reset_replica_state action properties: @@ -7230,12 +6944,6 @@ components: type: object x-openstack: action-name: reset_replica_state - Share_ReplicasActionReset_Replica_StateResponse: - description: Response of the - share-replicas/id/action:post:reset_replica_state action - type: object - x-openstack: - action-name: reset_replica_state Share_ReplicasActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -7244,12 +6952,6 @@ components: type: object x-openstack: action-name: reset_status - Share_ReplicasActionReset_StatusResponse: - description: Response of the share-replicas/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_ReplicasActionResyncRequest: description: Empty body for resync action properties: @@ -7258,75 +6960,29 @@ components: type: object x-openstack: action-name: resync - Share_ReplicasActionResyncResponse: - description: Response of the share-replicas/id/action:post:resync action - type: object - x-openstack: - action-name: resync Share_ReplicasCreateRequest: description: Request of the share-replicas:post operation type: object x-openstack: action-name: create - Share_ReplicasCreateResponse: - description: Response of the share-replicas:post operation - type: object - Share_ReplicasDetailResponse: - description: Response of the share-replicas/detail:get operation - type: object - Share_ReplicasExport_LocationShowResponse: - description: Response of the - share-replicas/share_replica_id/export-locations/export_location_uuid:get - operation - type: object - Share_ReplicasExport_LocationsListResponse: - description: Response of the - share-replicas/share_replica_id/export-locations:get operation - type: object - Share_ReplicasListResponse: - description: Response of the share-replicas:get operation - type: object Share_ReplicasMetadataCreate_MetadataRequest: description: Request of the share-replicas/resource_id/metadata:post operation type: object x-openstack: action-name: create_metadata - Share_ReplicasMetadataCreate_MetadataResponse: - description: Response of the share-replicas/resource_id/metadata:post - operation - type: object - Share_ReplicasMetadataList_MetadataResponse: - description: Response of the share-replicas/resource_id/metadata:get - operation - type: object - Share_ReplicasMetadataShow_MetadataResponse: - description: Response of the share-replicas/resource_id/metadata/key:get - operation - type: object Share_ReplicasMetadataUpdate_All_MetadataRequest: description: Request of the share-replicas/resource_id/metadata:put operation type: object x-openstack: action-name: update_all_metadata - Share_ReplicasMetadataUpdate_All_MetadataResponse: - description: Response of the share-replicas/resource_id/metadata:put - operation - type: object Share_ReplicasMetadataUpdate_Metadata_ItemRequest: description: Request of the share-replicas/resource_id/metadata/key:post operation type: object x-openstack: action-name: update_metadata_item - Share_ReplicasMetadataUpdate_Metadata_ItemResponse: - description: Response of the share-replicas/resource_id/metadata/key:post - operation - type: object - Share_ServerShowResponse: - description: Response of the share-servers/id:get operation - type: object Share_ServersActionMigration_CancelRequest: description: Empty body for migration_cancel action properties: @@ -7335,12 +6991,6 @@ components: type: object x-openstack: action-name: migration_cancel - Share_ServersActionMigration_CancelResponse: - description: Response of the share-servers/id/action:post:migration_cancel - action - type: object - x-openstack: - action-name: migration_cancel Share_ServersActionMigration_CheckRequest: description: Empty body for migration_check action properties: @@ -7349,12 +6999,6 @@ components: type: object x-openstack: action-name: migration_check - Share_ServersActionMigration_CheckResponse: - description: Response of the share-servers/id/action:post:migration_check - action - type: object - x-openstack: - action-name: migration_check Share_ServersActionMigration_CompleteRequest: description: Empty body for migration_complete action properties: @@ -7363,12 +7007,6 @@ components: type: object x-openstack: action-name: migration_complete - Share_ServersActionMigration_CompleteResponse: - description: Response of the - share-servers/id/action:post:migration_complete action - type: object - x-openstack: - action-name: migration_complete Share_ServersActionMigration_Get_ProgressRequest: description: Empty body for migration_get_progress action properties: @@ -7377,12 +7015,6 @@ components: type: object x-openstack: action-name: migration_get_progress - Share_ServersActionMigration_Get_ProgressResponse: - description: Response of the - share-servers/id/action:post:migration_get_progress action - type: object - x-openstack: - action-name: migration_get_progress Share_ServersActionMigration_StartRequest: description: Empty body for migration_start action properties: @@ -7391,12 +7023,6 @@ components: type: object x-openstack: action-name: migration_start - Share_ServersActionMigration_StartResponse: - description: Response of the share-servers/id/action:post:migration_start - action - type: object - x-openstack: - action-name: migration_start Share_ServersActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -7405,12 +7031,6 @@ components: type: object x-openstack: action-name: reset_status - Share_ServersActionReset_StatusResponse: - description: Response of the share-servers/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_ServersActionReset_Task_StateRequest: description: Empty body for reset_task_state action properties: @@ -7419,12 +7039,6 @@ components: type: object x-openstack: action-name: reset_task_state - Share_ServersActionReset_Task_StateResponse: - description: Response of the share-servers/id/action:post:reset_task_state - action - type: object - x-openstack: - action-name: reset_task_state Share_ServersActionUnmanageRequest: description: Empty body for unmanage action properties: @@ -7433,50 +7047,21 @@ components: type: object x-openstack: action-name: unmanage - Share_ServersActionUnmanageResponse: - description: Response of the share-servers/id/action:post:unmanage action - type: object - x-openstack: - action-name: unmanage - Share_ServersDetailsResponse: - description: Response of the share-servers/id/details:get operation - type: object - Share_ServersListResponse: - description: Response of the share-servers:get operation - type: object Share_ServersManageManageRequest: description: Request of the share-servers/manage:post operation type: object x-openstack: action-name: manage - Share_ServersManageResponse: - description: Response of the share-servers/manage:post operation - type: object - Share_TransferShowResponse: - description: Response of the share-transfers/id:get operation - type: object Share_TransfersAcceptAcceptRequest: description: Request of the share-transfers/id/accept:post operation type: object x-openstack: action-name: accept - Share_TransfersAcceptResponse: - description: Response of the share-transfers/id/accept:post operation - type: object Share_TransfersCreateRequest: description: Request of the share-transfers:post operation type: object x-openstack: action-name: create - Share_TransfersCreateResponse: - description: Response of the share-transfers:post operation - type: object - Share_TransfersDetailResponse: - description: Response of the share-transfers/detail:get operation - type: object - Share_TransfersListResponse: - description: Response of the share-transfers:get operation - type: object SharesActionAccess_ListRequest: description: Empty body for access_list action properties: @@ -7485,11 +7070,6 @@ components: type: object x-openstack: action-name: access_list - SharesActionAccess_ListResponse: - description: Response of the shares/id/action:post:access_list action - type: object - x-openstack: - action-name: access_list SharesActionAllow_AccessRequest: description: Empty body for allow_access action properties: @@ -7498,11 +7078,6 @@ components: type: object x-openstack: action-name: allow_access - SharesActionAllow_AccessResponse: - description: Response of the shares/id/action:post:allow_access action - type: object - x-openstack: - action-name: allow_access SharesActionDeny_AccessRequest: description: Empty body for deny_access action properties: @@ -7511,11 +7086,6 @@ components: type: object x-openstack: action-name: deny_access - SharesActionDeny_AccessResponse: - description: Response of the shares/id/action:post:deny_access action - type: object - x-openstack: - action-name: deny_access SharesActionExtendRequest: oneOf: - $ref: '#/components/schemas/SharesActionExtend_264' @@ -7523,10 +7093,6 @@ components: x-openstack: action-name: extend discriminator: microversion - SharesActionExtendResponse: - type: 'null' - x-openstack: - action-name: extend SharesActionExtend_264: additionalProperties: false properties: @@ -7580,7 +7146,6 @@ components: type: object x-openstack: action-name: extend - max-ver: '2.63' min-ver: '2.64' SharesActionExtend_27: additionalProperties: false @@ -7630,14 +7195,6 @@ components: action-name: os-extend max-ver: '2.6' min-ver: '2.0' - SharesActionForce_DeleteResponse: - type: 'null' - x-openstack: - action-name: force_delete - SharesActionMigration_CancelResponse: - type: 'null' - x-openstack: - action-name: migration_cancel SharesActionMigration_Cancel_222: additionalProperties: false properties: @@ -7648,10 +7205,6 @@ components: x-openstack: action-name: migration_cancel min-ver: '2.22' - SharesActionMigration_CompleteResponse: - type: 'null' - x-openstack: - action-name: migration_complete SharesActionMigration_Complete_222: additionalProperties: false properties: @@ -7662,7 +7215,23 @@ components: x-openstack: action-name: migration_complete min-ver: '2.22' - SharesActionMigration_Get_ProgressResponse: + SharesActionMigration_Get_ProgressResponse_222: + additionalProperties: false + properties: + task_state: {} + total_progress: + max: 100 + min: 0 + type: integer + required: + - task_state + - total_progress + type: object + x-openstack: + action-name: migration_get_progress + max-ver: '2.58' + min-ver: '2.22' + SharesActionMigration_Get_ProgressResponse_259: additionalProperties: false properties: details: {} @@ -7678,6 +7247,7 @@ components: type: object x-openstack: action-name: migration_get_progress + min-ver: '2.59' SharesActionMigration_Get_Progress_222: additionalProperties: false properties: @@ -7688,10 +7258,6 @@ components: x-openstack: action-name: migration_get_progress min-ver: '2.22' - SharesActionMigration_StartResponse: - type: 'null' - x-openstack: - action-name: migration_start SharesActionMigration_Start_229: additionalProperties: false properties: @@ -7884,11 +7450,6 @@ components: type: object x-openstack: action-name: os-access_list - SharesActionOs-Access_ListResponse: - description: Response of the shares/id/action:post:os-access_list action - type: object - x-openstack: - action-name: os-access_list SharesActionOs-Allow_AccessRequest: description: Empty body for os-allow_access action properties: @@ -7897,11 +7458,6 @@ components: type: object x-openstack: action-name: os-allow_access - SharesActionOs-Allow_AccessResponse: - description: Response of the shares/id/action:post:os-allow_access action - type: object - x-openstack: - action-name: os-allow_access SharesActionOs-Deny_AccessRequest: description: Empty body for os-deny_access action properties: @@ -7910,35 +7466,6 @@ components: type: object x-openstack: action-name: os-deny_access - SharesActionOs-Deny_AccessResponse: - description: Response of the shares/id/action:post:os-deny_access action - type: object - x-openstack: - action-name: os-deny_access - SharesActionOs-ExtendResponse: - type: 'null' - x-openstack: - action-name: os-extend - SharesActionOs-Force_DeleteResponse: - type: 'null' - x-openstack: - action-name: os-force_delete - SharesActionOs-Reset_StatusResponse: - type: 'null' - x-openstack: - action-name: os-reset_status - SharesActionOs-ShrinkResponse: - type: 'null' - x-openstack: - action-name: os-shrink - SharesActionReset_StatusResponse: - type: 'null' - x-openstack: - action-name: reset_status - SharesActionReset_Task_StateResponse: - type: 'null' - x-openstack: - action-name: reset_task_state SharesActionReset_Task_State_222: additionalProperties: false properties: @@ -7993,14 +7520,6 @@ components: x-openstack: action-name: reset_task_state min-ver: '2.22' - SharesActionRestoreResponse: - type: 'null' - x-openstack: - action-name: restore - SharesActionRevertResponse: - type: 'null' - x-openstack: - action-name: revert SharesActionRevert_227: additionalProperties: false properties: @@ -8234,10 +7753,6 @@ components: x-openstack: action-name: soft_delete min-ver: '2.69' - SharesActionShrinkResponse: - type: 'null' - x-openstack: - action-name: shrink SharesActionShrink_27: additionalProperties: false properties: @@ -8285,14 +7800,6 @@ components: action-name: os-shrink max-ver: '2.6' min-ver: '2.0' - SharesActionSoft_DeleteResponse: - type: 'null' - x-openstack: - action-name: soft_delete - SharesActionUnmanageResponse: - type: 'null' - x-openstack: - action-name: unmanage SharesActionUnmanage_27: additionalProperties: false properties: @@ -8308,13 +7815,114 @@ components: type: object x-openstack: action-name: create - SharesCreateResponse: - description: Response of the shares:post operation + SharesExport_LocationShowResponse_214: + additionalProperties: false + properties: + export_location: + additionalProperties: false + properties: + created_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: created_at + id: + readonly: true + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + preferred: + type: boolean + x-openstack: + apiref: export_location_preferred + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + updated_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: updated_at + required: + - created_at + - id + - path + - preferred + - updated_at + type: object + x-openstack: + apiref: export_location + required: + - export_location type: object - SharesDetailResponse: - description: Response of the shares/detail:get operation + x-openstack: + max-ver: '2.86' + min-ver: '2.14' + SharesExport_LocationShowResponse_247: + additionalProperties: false + properties: + export_location: + additionalProperties: false + properties: + created_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: created_at + id: + readonly: true + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + preferred: + type: boolean + x-openstack: + apiref: export_location_preferred + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + updated_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: updated_at + required: + - created_at + - id + - path + - preferred + - updated_at + type: object + x-openstack: + apiref: export_location + required: + - export_location type: object - SharesExport_LocationShowResponse: + x-openstack: + min-ver: '2.47' + SharesExport_LocationShowResponse_287: additionalProperties: false properties: export_location: @@ -8335,6 +7943,14 @@ components: type: boolean x-openstack: apiref: export_location_is_admin_only + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object path: type: string x-openstack: @@ -8356,6 +7972,7 @@ components: required: - created_at - id + - metadata - path - preferred - updated_at @@ -8363,9 +7980,139 @@ components: x-openstack: apiref: export_location required: - - export_location + - export_location + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationShowResponse_29: + additionalProperties: false + properties: + export_location: + additionalProperties: false + properties: + created_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: created_at + id: + readonly: true + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + updated_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: updated_at + required: + - created_at + - id + - path + - updated_at + type: object + x-openstack: + apiref: export_location + required: + - export_location + type: object + x-openstack: + max-ver: '2.13' + min-ver: '2.9' + SharesExport_LocationsIndexResponse_214: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + preferred: + type: boolean + x-openstack: + apiref: export_location_preferred + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + required: + - id + - path + - preferred + type: object + type: array + required: + - export_locations + type: object + x-openstack: + apiref: export_locations + max-ver: '2.86' + min-ver: '2.14' + SharesExport_LocationsIndexResponse_247: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + preferred: + type: boolean + x-openstack: + apiref: export_location_preferred + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + required: + - id + - path + - preferred + type: object + type: array + required: + - export_locations type: object - SharesExport_LocationsListResponse: + x-openstack: + apiref: export_locations + min-ver: '2.47' + SharesExport_LocationsIndexResponse_287: additionalProperties: false properties: export_locations: @@ -8380,6 +8127,11 @@ components: type: boolean x-openstack: apiref: export_location_is_admin_only + metadata: + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: object path: type: string x-openstack: @@ -8394,6 +8146,7 @@ components: apiref: share_instance_id required: - id + - metadata - path - preferred type: object @@ -8403,7 +8156,43 @@ components: type: object x-openstack: apiref: export_locations - SharesExport_LocationsMetadataCreate_MetadataResponse: + min-ver: '2.87' + SharesExport_LocationsIndexResponse_29: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + required: + - id + - path + type: object + type: array + required: + - export_locations + type: object + x-openstack: + apiref: export_locations + max-ver: '2.13' + min-ver: '2.9' + SharesExport_LocationsMetadataCreate_MetadataResponse_287: additionalProperties: false properties: metadata: @@ -8417,6 +8206,8 @@ components: required: - metadata type: object + x-openstack: + min-ver: '2.87' SharesExport_LocationsMetadataCreate_Metadata_287: additionalProperties: false properties: @@ -8433,7 +8224,7 @@ components: type: object x-openstack: min-ver: '2.87' - SharesExport_LocationsMetadataList_MetadataResponse: + SharesExport_LocationsMetadataIndex_MetadataResponse_287: additionalProperties: false properties: meta: @@ -8447,7 +8238,9 @@ components: required: - meta type: object - SharesExport_LocationsMetadataShow_MetadataResponse: + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataShow_MetadataResponse_287: additionalProperties: false properties: meta: @@ -8459,114 +8252,374 @@ components: - 'null' - object required: - - meta + - meta + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataUpdate_All_MetadataResponse_287: + additionalProperties: false + properties: + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object + required: + - metadata + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataUpdate_All_Metadata_287: + additionalProperties: true + properties: + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object + required: + - metadata + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse_287: + additionalProperties: false + properties: + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object + required: + - metadata + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataUpdate_Metadata_Item_287: + additionalProperties: true + properties: + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object + required: + - metadata + type: object + x-openstack: + min-ver: '2.87' + SharesManageManageRequest: + description: Request of the shares/manage:post operation + type: object + x-openstack: + action-name: manage + SharesMetadataCreate_MetadataRequest: + description: Request of the shares/resource_id/metadata:post operation + type: object + x-openstack: + action-name: create_metadata + SharesMetadataUpdate_All_MetadataRequest: + description: Request of the shares/resource_id/metadata:put operation + type: object + x-openstack: + action-name: update_all_metadata + SharesMetadataUpdate_Metadata_ItemRequest: + description: Request of the shares/resource_id/metadata/key:post operation + type: object + x-openstack: + action-name: update_metadata_item + SnapshotShowResponse_20: + additionalProperties: false + properties: + snapshot: + additionalProperties: false + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + type: string + description: + description: "The user defined description of the resource.\n" + type: + - 'null' + - string + id: + description: "The UUID of the snapshot.\n" + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: "The user defined name of the resource.\n" + type: + - 'null' + - string + share_id: + description: "The UUID of the source share that was used to\ncreate + the snapshot.\n" + type: string + share_proto: + description: "The file system protocol of a share snapshot. A\nvalid + value is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``,\n``CephFS`` or + ``MAPRFS``. ``CephFS`` is supported starting\nwith API v2.13.\n" + type: string + share_size: + description: "The share snapshot size, in GiBs.\n" + type: + - integer + - 'null' + size: + description: "The snapshot size, in GiBs.\n" + type: + - integer + - 'null' + status: + description: "The snapshot status, which can be ``available``,\n``error``, + ``creating``, ``deleting``, ``manage_starting``,\n``manage_error``, + ``unmanage_starting``, ``unmanage_error`` or\n``error_deleting``.\n" + type: string + required: + - created_at + - description + - id + - links + - name + - share_id + - share_proto + - share_size + - size + - status + type: object + required: + - snapshot type: object - SharesExport_LocationsMetadataUpdate_All_MetadataResponse: + x-openstack: + max-ver: '2.11' + min-ver: '2.0' + SnapshotShowResponse_212: additionalProperties: false properties: - metadata: + snapshot: additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" type: string - type: - - 'null' - - object - required: - - metadata - type: object - SharesExport_LocationsMetadataUpdate_All_Metadata_287: - additionalProperties: true - properties: - metadata: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + description: + description: "The user defined description of the resource.\n" + type: + - 'null' + - string + id: + description: "The UUID of the snapshot.\n" + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: "The user defined name of the resource.\n" + type: + - 'null' + - string + provider_location: + description: "Provider location of the snapshot on the backend.\n" + type: + - 'null' + - string + share_id: + description: "The UUID of the source share that was used to\ncreate + the snapshot.\n" type: string - type: - - 'null' - - object + share_proto: + description: "The file system protocol of a share snapshot. A\nvalid + value is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``,\n``CephFS`` or + ``MAPRFS``. ``CephFS`` is supported starting\nwith API v2.13.\n" + type: string + share_size: + description: "The share snapshot size, in GiBs.\n" + type: + - integer + - 'null' + size: + description: "The snapshot size, in GiBs.\n" + type: + - integer + - 'null' + status: + description: "The snapshot status, which can be ``available``,\n``error``, + ``creating``, ``deleting``, ``manage_starting``,\n``manage_error``, + ``unmanage_starting``, ``unmanage_error`` or\n``error_deleting``.\n" + type: string + required: + - created_at + - description + - id + - links + - name + - share_id + - share_proto + - share_size + - size + - status + type: object required: - - metadata + - snapshot type: object x-openstack: - min-ver: '2.87' - SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse: + max-ver: '2.16' + min-ver: '2.12' + SnapshotShowResponse_217: additionalProperties: false properties: - metadata: + snapshot: additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" type: string - type: - - 'null' - - object - required: - - metadata - type: object - SharesExport_LocationsMetadataUpdate_Metadata_Item_287: - additionalProperties: true - properties: - metadata: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + description: + description: "The user defined description of the resource.\n" + type: + - 'null' + - string + id: + description: "The UUID of the snapshot.\n" + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: "The user defined name of the resource.\n" + type: + - 'null' + - string + project_id: + description: "ID of the project that the snapshot belongs to.\n" type: string - type: - - 'null' - - object + provider_location: + description: "Provider location of the snapshot on the backend.\n" + type: + - 'null' + - string + share_id: + description: "The UUID of the source share that was used to\ncreate + the snapshot.\n" + type: string + share_proto: + description: "The file system protocol of a share snapshot. A\nvalid + value is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``,\n``CephFS`` or + ``MAPRFS``. ``CephFS`` is supported starting\nwith API v2.13.\n" + type: string + share_size: + description: "The share snapshot size, in GiBs.\n" + type: + - integer + - 'null' + size: + description: "The snapshot size, in GiBs.\n" + type: + - integer + - 'null' + status: + description: "The snapshot status, which can be ``available``,\n``error``, + ``creating``, ``deleting``, ``manage_starting``,\n``manage_error``, + ``unmanage_starting``, ``unmanage_error`` or\n``error_deleting``.\n" + type: string + user_id: + description: "ID of the user that the snapshot was created by.\n" + type: string + required: + - created_at + - description + - id + - links + - name + - project_id + - share_id + - share_proto + - share_size + - size + - status + - user_id + type: object required: - - metadata - type: object - x-openstack: - min-ver: '2.87' - SharesInstancesGet_Share_InstancesResponse: - description: Response of the shares/share_id/instances:get operation - type: object - SharesListResponse: - description: Response of the shares:get operation - type: object - SharesManageManageRequest: - description: Request of the shares/manage:post operation - type: object - x-openstack: - action-name: manage - SharesManageResponse: - description: Response of the shares/manage:post operation - type: object - SharesMetadataCreate_MetadataRequest: - description: Request of the shares/resource_id/metadata:post operation - type: object - x-openstack: - action-name: create_metadata - SharesMetadataCreate_MetadataResponse: - description: Response of the shares/resource_id/metadata:post operation - type: object - SharesMetadataList_MetadataResponse: - description: Response of the shares/resource_id/metadata:get operation - type: object - SharesMetadataShow_MetadataResponse: - description: Response of the shares/resource_id/metadata/key:get operation - type: object - SharesMetadataUpdate_All_MetadataRequest: - description: Request of the shares/resource_id/metadata:put operation - type: object - x-openstack: - action-name: update_all_metadata - SharesMetadataUpdate_All_MetadataResponse: - description: Response of the shares/resource_id/metadata:put operation - type: object - SharesMetadataUpdate_Metadata_ItemRequest: - description: Request of the shares/resource_id/metadata/key:post operation + - snapshot type: object x-openstack: - action-name: update_metadata_item - SharesMetadataUpdate_Metadata_ItemResponse: - description: Response of the shares/resource_id/metadata/key:post - operation - type: object - SnapshotShowResponse: + max-ver: '2.72' + min-ver: '2.17' + SnapshotShowResponse_273: additionalProperties: false properties: snapshot: @@ -8669,17 +8722,13 @@ components: required: - snapshot type: object + x-openstack: + min-ver: '2.73' SnapshotUpdateRequest: description: Request of the snapshots/id:put operation type: object x-openstack: action-name: update - SnapshotUpdateResponse: - description: Response of the snapshots/id:put operation - type: object - Snapshot_InstanceShowResponse: - description: Response of the snapshot-instances/id:get operation - type: object Snapshot_InstancesActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -8688,31 +8737,6 @@ components: type: object x-openstack: action-name: reset_status - Snapshot_InstancesActionReset_StatusResponse: - description: Response of the - snapshot-instances/id/action:post:reset_status action - type: object - x-openstack: - action-name: reset_status - Snapshot_InstancesDetailResponse: - description: Response of the snapshot-instances/detail:get operation - type: object - Snapshot_InstancesExport_LocationShowResponse: - description: Response of the - snapshot-instances/snapshot_instance_id/export-locations/export_location_id:get - operation - type: object - Snapshot_InstancesExport_LocationsListResponse: - description: Response of the - snapshot-instances/snapshot_instance_id/export-locations:get operation - type: object - Snapshot_InstancesListResponse: - description: Response of the snapshot-instances:get operation - type: object - SnapshotsAccess_ListResponse: - description: Response of the snapshots/snapshot_id/access-list:get - operation - type: object SnapshotsActionAllow_AccessRequest: description: Empty body for allow_access action properties: @@ -8721,11 +8745,6 @@ components: type: object x-openstack: action-name: allow_access - SnapshotsActionAllow_AccessResponse: - description: Response of the snapshots/id/action:post:allow_access action - type: object - x-openstack: - action-name: allow_access SnapshotsActionDeny_AccessRequest: description: Empty body for deny_access action properties: @@ -8734,11 +8753,6 @@ components: type: object x-openstack: action-name: deny_access - SnapshotsActionDeny_AccessResponse: - description: Response of the snapshots/id/action:post:deny_access action - type: object - x-openstack: - action-name: deny_access SnapshotsActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -8747,11 +8761,6 @@ components: type: object x-openstack: action-name: force_delete - SnapshotsActionForce_DeleteResponse: - description: Response of the snapshots/id/action:post:force_delete action - type: object - x-openstack: - action-name: force_delete SnapshotsActionOs-Force_DeleteRequest: description: Empty body for os-force_delete action properties: @@ -8760,12 +8769,6 @@ components: type: object x-openstack: action-name: os-force_delete - SnapshotsActionOs-Force_DeleteResponse: - description: Response of the snapshots/id/action:post:os-force_delete - action - type: object - x-openstack: - action-name: os-force_delete SnapshotsActionOs-Reset_StatusRequest: description: Empty body for os-reset_status action properties: @@ -8774,12 +8777,6 @@ components: type: object x-openstack: action-name: os-reset_status - SnapshotsActionOs-Reset_StatusResponse: - description: Response of the snapshots/id/action:post:os-reset_status - action - type: object - x-openstack: - action-name: os-reset_status SnapshotsActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -8788,11 +8785,6 @@ components: type: object x-openstack: action-name: reset_status - SnapshotsActionReset_StatusResponse: - description: Response of the snapshots/id/action:post:reset_status action - type: object - x-openstack: - action-name: reset_status SnapshotsActionUnmanageRequest: description: Empty body for unmanage action properties: @@ -8801,31 +8793,207 @@ components: type: object x-openstack: action-name: unmanage - SnapshotsActionUnmanageResponse: - description: Response of the snapshots/id/action:post:unmanage action - type: object - x-openstack: - action-name: unmanage SnapshotsCreateRequest: description: Request of the snapshots:post operation type: object x-openstack: action-name: create - SnapshotsCreateResponse: - description: Response of the snapshots:post operation - type: object - SnapshotsDetailResponse: - description: Response of the snapshots/detail:get operation + SnapshotsIndexResponse_20: + additionalProperties: false + properties: + count: + minimum: 0 + type: integer + share_snapshots_links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + snapshots: + items: + additionalProperties: false + properties: + id: + description: The UUID of the snapshot. + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: The user-defined name of the snapshot. + type: + - 'null' + - string + required: + - id + - links + - name + type: object + type: array + required: + - snapshots type: object - SnapshotsExport_LocationShowResponse: - description: Response of the - snapshots/snapshot_id/export-locations/export_location_id:get operation + x-openstack: + max-ver: '2.35' + min-ver: '2.0' + SnapshotsIndexResponse_236: + additionalProperties: false + properties: + count: + minimum: 0 + type: integer + share_snapshots_links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + snapshots: + items: + additionalProperties: false + properties: + id: + description: The UUID of the snapshot. + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: The user-defined name of the snapshot. + type: + - 'null' + - string + required: + - id + - links + - name + type: object + type: array + required: + - snapshots type: object - SnapshotsExport_LocationsListResponse: - description: Response of the snapshots/snapshot_id/export-locations:get - operation + x-openstack: + max-ver: '2.72' + min-ver: '2.36' + SnapshotsIndexResponse_273: + additionalProperties: false + properties: + count: + minimum: 0 + type: integer + share_snapshots_links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + snapshots: + items: + additionalProperties: false + properties: + id: + description: The UUID of the snapshot. + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: The user-defined name of the snapshot. + type: + - 'null' + - string + required: + - id + - links + - name + type: object + type: array + required: + - snapshots type: object - SnapshotsListResponse: + x-openstack: + max-ver: '2.78' + min-ver: '2.73' + SnapshotsIndexResponse_279: additionalProperties: false properties: count: @@ -8887,60 +9055,34 @@ components: required: - snapshots type: object + x-openstack: + min-ver: '2.79' SnapshotsManageManageRequest: description: Request of the snapshots/manage:post operation type: object x-openstack: action-name: manage - SnapshotsManageResponse: - description: Response of the snapshots/manage:post operation - type: object SnapshotsMetadataCreate_MetadataRequest: description: Request of the snapshots/resource_id/metadata:post operation type: object x-openstack: action-name: create_metadata - SnapshotsMetadataCreate_MetadataResponse: - description: Response of the snapshots/resource_id/metadata:post operation - type: object - SnapshotsMetadataList_MetadataResponse: - description: Response of the snapshots/resource_id/metadata:get operation - type: object - SnapshotsMetadataShow_MetadataResponse: - description: Response of the snapshots/resource_id/metadata/key:get - operation - type: object SnapshotsMetadataUpdate_All_MetadataRequest: description: Request of the snapshots/resource_id/metadata:put operation type: object x-openstack: action-name: update_all_metadata - SnapshotsMetadataUpdate_All_MetadataResponse: - description: Response of the snapshots/resource_id/metadata:put operation - type: object SnapshotsMetadataUpdate_Metadata_ItemRequest: description: Request of the snapshots/resource_id/metadata/key:post operation type: object x-openstack: action-name: update_metadata_item - SnapshotsMetadataUpdate_Metadata_ItemResponse: - description: Response of the snapshots/resource_id/metadata/key:post - operation - type: object - TypeShowResponse: - description: Response of the types/id:get operation - type: object TypeUpdateRequest: description: Request of the types/id:put operation type: object x-openstack: action-name: update - TypeUpdateResponse: - description: Response of the types/id:put:update action - type: object - x-openstack: - action-name: update TypesActionAddprojectaccessRequest: description: Empty body for addProjectAccess action properties: @@ -8949,11 +9091,6 @@ components: type: object x-openstack: action-name: addProjectAccess - TypesActionAddprojectaccessResponse: - description: Response of the types/id/action:post:addProjectAccess action - type: object - x-openstack: - action-name: addProjectAccess TypesActionCreateRequest: description: Empty body for create action properties: @@ -8962,11 +9099,6 @@ components: type: object x-openstack: action-name: create - TypesActionCreateResponse: - description: Response of the types/id/action:post:create action - type: object - x-openstack: - action-name: create TypesActionDeleteRequest: description: Empty body for delete action properties: @@ -8975,11 +9107,6 @@ components: type: object x-openstack: action-name: delete - TypesActionDeleteResponse: - description: Response of the types/id/action:post:delete action - type: object - x-openstack: - action-name: delete TypesActionRemoveprojectaccessRequest: description: Empty body for removeProjectAccess action properties: @@ -8988,12 +9115,6 @@ components: type: object x-openstack: action-name: removeProjectAccess - TypesActionRemoveprojectaccessResponse: - description: Response of the types/id/action:post:removeProjectAccess - action - type: object - x-openstack: - action-name: removeProjectAccess TypesActionUpdateRequest: description: Empty body for update action properties: @@ -9002,55 +9123,21 @@ components: type: object x-openstack: action-name: update - TypesActionUpdateResponse: - description: Response of the types/id/action:post:update action - type: object - x-openstack: - action-name: update TypesCreateRequest: description: Request of the types:post operation type: object x-openstack: action-name: create - TypesCreateResponse: - description: Response of the types:post:create action - type: object - x-openstack: - action-name: create - TypesDefaultResponse: - description: Response of the types/default:get operation - type: object - TypesExtra_SpecShowResponse: - description: Response of the types/type_id/extra_specs/id:get operation - type: object TypesExtra_SpecUpdateRequest: description: Request of the types/type_id/extra_specs/id:put operation type: object x-openstack: action-name: update - TypesExtra_SpecUpdateResponse: - description: Response of the types/type_id/extra_specs/id:put operation - type: object TypesExtra_SpecsCreateRequest: description: Request of the types/type_id/extra_specs:post operation type: object x-openstack: action-name: create - TypesExtra_SpecsCreateResponse: - description: Response of the types/type_id/extra_specs:post operation - type: object - TypesExtra_SpecsListResponse: - description: Response of the types/type_id/extra_specs:get operation - type: object - TypesListResponse: - description: Response of the types:get operation - type: object - TypesOs_Share_Type_AccessOs-Share-Type-AccessResponse: - description: Response of the types/id/os-share-type-access:get operation - type: object - TypesShare_Type_AccessResponse: - description: Response of the types/id/share_type_access:get operation - type: object securitySchemes: ApiKeyAuth: in: header diff --git a/openstack_types/data/shared-file-system/v2.yaml b/openstack_types/data/shared-file-system/v2.yaml index 3bf07c51c..c8acff2d2 100644 --- a/openstack_types/data/shared-file-system/v2.yaml +++ b/openstack_types/data/shared-file-system/v2.yaml @@ -18,10 +18,6 @@ paths: operationId: :get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/RootListResponse' description: Ok summary: List All Major Versions tags: @@ -36,7 +32,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Availability_ZonesListResponse' + $ref: '#/components/schemas/Availability_ZonesIndexResponse_27' description: Ok tags: - availability-zones @@ -47,10 +43,6 @@ paths: operationId: extensions:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionsListResponse' description: Ok tags: - extensions @@ -63,10 +55,6 @@ paths: $ref: '#/components/schemas/ExtensionsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionsCreateResponse' description: Ok tags: - extensions @@ -82,10 +70,6 @@ paths: operationId: extensions/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ExtensionShowResponse' description: Ok tags: - extensions @@ -98,10 +82,6 @@ paths: operationId: limits:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/LimitsListResponse' description: Ok tags: - limits @@ -128,7 +108,9 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MessagesListResponse' + oneOf: + - $ref: '#/components/schemas/MessagesIndexResponse_237' + - $ref: '#/components/schemas/MessagesIndexResponse_252' description: Ok tags: - messages @@ -155,7 +137,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/MessageShowResponse' + $ref: '#/components/schemas/MessageShowResponse_237' description: Ok tags: - messages @@ -172,7 +154,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Availability_ZoneListResponse' + $ref: '#/components/schemas/Os_Availability_ZoneIndexResponse_20' description: Ok tags: - os-availability-zone @@ -188,7 +170,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse' + $ref: '#/components/schemas/Os_Quota_Class_SetShowResponse_20' description: Ok tags: - os-quota-class-sets @@ -210,7 +192,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse' + $ref: '#/components/schemas/Os_Quota_Class_SetUpdateResponse_20' description: Ok tags: - os-quota-class-sets @@ -234,10 +216,6 @@ paths: operationId: os-quota-sets/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Quota_SetShowResponse' description: Ok tags: - os-quota-sets @@ -256,10 +234,6 @@ paths: $ref: '#/components/schemas/Os_Quota_SetUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Quota_SetUpdateResponse' description: Ok tags: - os-quota-sets @@ -272,10 +246,6 @@ paths: operationId: os-quota-sets/id/defaults:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Quota_SetsDefaultsResponse' description: Ok tags: - os-quota-sets @@ -290,10 +260,6 @@ paths: operationId: os-services:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_ServicesListResponse' description: Ok tags: - os-services @@ -313,10 +279,6 @@ paths: $ref: '#/components/schemas/Os_ServiceUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_ServiceUpdateResponse' description: Ok tags: - os-services @@ -339,10 +301,6 @@ paths: $ref: '#/components/schemas/Os_Share_ManageCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Share_ManageCreateResponse' description: Ok tags: - os-share-manage @@ -364,10 +322,6 @@ paths: $ref: '#/components/schemas/Os_Share_UnmanageUnmanageUnmanageRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Os_Share_UnmanageUnmanageResponse' description: Ok tags: - os-share-unmanage @@ -381,10 +335,6 @@ paths: operationId: qos-types:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesListResponse' description: Ok tags: - qos-types @@ -401,10 +351,6 @@ paths: $ref: '#/components/schemas/Qos_TypesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesCreateResponse' description: Ok tags: - qos-types @@ -428,10 +374,6 @@ paths: operationId: qos-types/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypeShowResponse' description: Ok tags: - qos-types @@ -450,10 +392,6 @@ paths: $ref: '#/components/schemas/Qos_TypeUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypeUpdateResponse' description: Ok tags: - qos-types @@ -466,10 +404,6 @@ paths: operationId: qos-types/id/specs:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesSpecsListResponse' description: Ok tags: - qos-types @@ -488,10 +422,6 @@ paths: $ref: '#/components/schemas/Qos_TypesSpecsCreateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesSpecsCreateResponse' description: Ok tags: - qos-types @@ -515,10 +445,6 @@ paths: operationId: qos-types/id/specs/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesSpecShowResponse' description: Ok tags: - qos-types @@ -538,10 +464,6 @@ paths: $ref: '#/components/schemas/Qos_TypesSpecUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Qos_TypesSpecUpdateResponse' description: Ok tags: - qos-types @@ -555,7 +477,14 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Quota_Class_SetShowResponse' + oneOf: + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_10' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_240' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_253' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_262' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_27' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_280' + - $ref: '#/components/schemas/Quota_Class_SetShowResponse_290' description: Ok tags: - quota-class-sets @@ -575,7 +504,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse' + oneOf: + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_240' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_253' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_262' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_27' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_280' + - $ref: '#/components/schemas/Quota_Class_SetUpdateResponse_290' description: Ok tags: - quota-class-sets @@ -595,10 +530,6 @@ paths: operationId: quota-sets/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Quota_SetShowResponse' description: Ok tags: - quota-sets @@ -615,10 +546,6 @@ paths: $ref: '#/components/schemas/Quota_SetUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Quota_SetUpdateResponse' description: Ok tags: - quota-sets @@ -629,10 +556,6 @@ paths: operationId: quota-sets/id/defaults:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Quota_SetsDefaultsResponse' description: Ok tags: - quota-sets @@ -645,10 +568,6 @@ paths: operationId: quota-sets/id/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Quota_SetsDetailResponse' description: Ok tags: - quota-sets @@ -682,7 +601,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Resource_LocksListResponse' + $ref: '#/components/schemas/Resource_LocksIndexResponse_281' description: Ok tags: - resource-locks @@ -702,7 +621,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Resource_LocksCreateResponse' + $ref: '#/components/schemas/Resource_LocksCreateResponse_281' description: Ok tags: - resource-locks @@ -729,7 +648,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Resource_LockShowResponse' + $ref: '#/components/schemas/Resource_LockShowResponse_281' description: Ok tags: - resource-locks @@ -751,7 +670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Resource_LockUpdateResponse' + $ref: '#/components/schemas/Resource_LockUpdateResponse_281' description: Ok tags: - resource-locks @@ -765,10 +684,6 @@ paths: operationId: scheduler-stats/pools:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Scheduler_StatsPoolsPools_ListResponse' description: Ok tags: - scheduler-stats @@ -783,10 +698,6 @@ paths: operationId: scheduler-stats/pools/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Scheduler_StatsPoolsDetailPools_DetailResponse' description: Ok tags: - scheduler-stats @@ -800,10 +711,6 @@ paths: operationId: security-services:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServicesListResponse' description: Ok tags: - security-services @@ -818,10 +725,6 @@ paths: $ref: '#/components/schemas/Security_ServicesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServicesCreateResponse' description: Ok tags: - security-services @@ -832,10 +735,6 @@ paths: operationId: security-services/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServicesDetailResponse' description: Ok tags: - security-services @@ -855,10 +754,6 @@ paths: operationId: security-services/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServiceShowResponse' description: Ok tags: - security-services @@ -875,10 +770,6 @@ paths: $ref: '#/components/schemas/Security_ServiceUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Security_ServiceUpdateResponse' description: Ok tags: - security-services @@ -888,10 +779,6 @@ paths: operationId: services:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ServicesListResponse' description: Ok tags: - services @@ -910,10 +797,6 @@ paths: $ref: '#/components/schemas/ServicesEnsure_SharesEnsure_Shares_286' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/ServicesEnsure_SharesResponse' description: Ok tags: - services @@ -932,10 +815,6 @@ paths: $ref: '#/components/schemas/ServiceUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceUpdateResponse' description: Ok tags: - services @@ -948,10 +827,6 @@ paths: operationId: share-access-rules:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Access_RulesListResponse' description: Ok tags: - share-access-rules @@ -970,10 +845,6 @@ paths: $ref: '#/components/schemas/Share_Access_RulesMetadataUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Access_RulesMetadataUpdateResponse' description: Ok tags: - share-access-rules @@ -1001,10 +872,6 @@ paths: operationId: share-access-rules/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Access_RuleShowResponse' description: Ok tags: - share-access-rules @@ -1023,10 +890,6 @@ paths: $ref: '#/components/schemas/Share_Access_RuleUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Access_RuleUpdateResponse' description: Ok tags: - share-access-rules @@ -1039,10 +902,6 @@ paths: operationId: share-backups:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsListResponse' description: Ok tags: - share-backups @@ -1059,10 +918,6 @@ paths: $ref: '#/components/schemas/Share_BackupsCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsCreateResponse' description: Ok tags: - share-backups @@ -1075,10 +930,6 @@ paths: operationId: share-backups/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsDetailResponse' description: Ok tags: - share-backups @@ -1102,10 +953,6 @@ paths: operationId: share-backups/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupShowResponse' description: Ok tags: - share-backups @@ -1124,10 +971,6 @@ paths: $ref: '#/components/schemas/Share_BackupUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupUpdateResponse' description: Ok tags: - share-backups @@ -1149,16 +992,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsActionReset_StatusResponse' description: Ok '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_BackupsActionRestoreResponse' description: Ok tags: - share-backups @@ -1170,10 +1005,6 @@ paths: operationId: share-group-snapshots:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotsListResponse' description: Ok tags: - share-group-snapshots @@ -1190,10 +1021,6 @@ paths: $ref: '#/components/schemas/Share_Group_SnapshotsCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotsCreateResponse' description: Ok tags: - share-group-snapshots @@ -1208,10 +1035,6 @@ paths: operationId: share-group-snapshots/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotsDetailResponse' description: Ok tags: - share-group-snapshots @@ -1235,10 +1058,6 @@ paths: operationId: share-group-snapshots/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotShowResponse' description: Ok tags: - share-group-snapshots @@ -1257,10 +1076,6 @@ paths: $ref: '#/components/schemas/Share_Group_SnapshotUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotUpdateResponse' description: Ok tags: - share-group-snapshots @@ -1283,12 +1098,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_Group_SnapshotsActionForce_DeleteResponse' - - $ref: '#/components/schemas/Share_Group_SnapshotsActionReset_StatusResponse' description: Ok tags: - share-group-snapshots @@ -1298,10 +1107,6 @@ paths: operationId: share-group-snapshots/id/members:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_SnapshotsMembersResponse' description: Ok tags: - share-group-snapshots @@ -1316,10 +1121,6 @@ paths: operationId: share-group-types:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesListResponse' description: Ok tags: - share-group-types @@ -1336,10 +1137,6 @@ paths: $ref: '#/components/schemas/Share_Group_TypesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesCreateResponse' description: Ok tags: - share-group-types @@ -1352,10 +1149,6 @@ paths: operationId: share-group-types/default:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesDefaultResponse' description: Ok tags: - share-group-types @@ -1379,10 +1172,6 @@ paths: operationId: share-group-types/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypeShowResponse' description: Ok tags: - share-group-types @@ -1397,10 +1186,6 @@ paths: operationId: share-group-types/id/access:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesAccessShare_Group_Type_AccessResponse' description: Ok tags: - share-group-types @@ -1427,14 +1212,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_Group_TypesActionAddprojectaccessResponse' - - $ref: '#/components/schemas/Share_Group_TypesActionCreateResponse' - - $ref: '#/components/schemas/Share_Group_TypesActionDeleteResponse' - - $ref: '#/components/schemas/Share_Group_TypesActionRemoveprojectaccessResponse' description: Ok tags: - share-group-types @@ -1444,10 +1221,6 @@ paths: operationId: share-group-types/id/group-specs:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesGroup_SpecsListResponse' description: Ok tags: - share-group-types @@ -1466,10 +1239,6 @@ paths: $ref: '#/components/schemas/Share_Group_TypesGroup_SpecsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesGroup_SpecsCreateResponse' description: Ok tags: - share-group-types @@ -1493,10 +1262,6 @@ paths: operationId: share-group-types/id/group-specs/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesGroup_SpecShowResponse' description: Ok tags: - share-group-types @@ -1516,10 +1281,6 @@ paths: $ref: '#/components/schemas/Share_Group_TypesGroup_SpecUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_Group_TypesGroup_SpecUpdateResponse' description: Ok tags: - share-group-types @@ -1532,10 +1293,6 @@ paths: operationId: share-groups:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupsListResponse' description: Ok tags: - share-groups @@ -1552,10 +1309,6 @@ paths: $ref: '#/components/schemas/Share_GroupsCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupsCreateResponse' description: Ok tags: - share-groups @@ -1568,10 +1321,6 @@ paths: operationId: share-groups/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupsDetailResponse' description: Ok tags: - share-groups @@ -1595,10 +1344,6 @@ paths: operationId: share-groups/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupShowResponse' description: Ok tags: - share-groups @@ -1617,10 +1362,6 @@ paths: $ref: '#/components/schemas/Share_GroupUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_GroupUpdateResponse' description: Ok tags: - share-groups @@ -1643,12 +1384,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_GroupsActionForce_DeleteResponse' - - $ref: '#/components/schemas/Share_GroupsActionReset_StatusResponse' description: Ok tags: - share-groups @@ -1659,10 +1394,6 @@ paths: operationId: share-networks:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksListResponse' description: Ok tags: - share-networks @@ -1677,10 +1408,6 @@ paths: $ref: '#/components/schemas/Share_NetworksCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksCreateResponse' description: Ok tags: - share-networks @@ -1691,10 +1418,6 @@ paths: operationId: share-networks/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksDetailResponse' description: Ok tags: - share-networks @@ -1714,10 +1437,6 @@ paths: operationId: share-networks/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworkShowResponse' description: Ok tags: - share-networks @@ -1734,10 +1453,6 @@ paths: $ref: '#/components/schemas/Share_NetworkUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworkUpdateResponse' description: Ok tags: - share-networks @@ -1762,23 +1477,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_NetworksActionAdd_Security_ServiceResponse' - - $ref: '#/components/schemas/Share_NetworksActionRemove_Security_ServiceResponse' - - $ref: '#/components/schemas/Share_NetworksActionReset_StatusResponse' description: Ok '202': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_NetworksActionAdd_Security_Service_CheckResponse' - - $ref: '#/components/schemas/Share_NetworksActionShare_Network_Subnet_Create_CheckResponse' - - $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_ServiceResponse' - - $ref: '#/components/schemas/Share_NetworksActionUpdate_Security_Service_CheckResponse' description: Ok tags: - share-networks @@ -1789,10 +1489,6 @@ paths: operationId: share-networks/share_network_id/subnets:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsListResponse' description: Ok tags: - share-networks @@ -1811,10 +1507,6 @@ paths: $ref: '#/components/schemas/Share_NetworksSubnetsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsCreateResponse' description: Ok tags: - share-networks @@ -1828,10 +1520,6 @@ paths: share-networks/share_network_id/subnets/resource_id/metadata:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataList_MetadataResponse' description: Ok tags: - share-networks @@ -1852,10 +1540,6 @@ paths: $ref: '#/components/schemas/Share_NetworksSubnetsMetadataCreate_MetadataRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataCreate_MetadataResponse' description: Ok tags: - share-networks @@ -1873,10 +1557,6 @@ paths: $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_All_MetadataRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_All_MetadataResponse' description: Ok tags: - share-networks @@ -1902,10 +1582,6 @@ paths: share-networks/share_network_id/subnets/resource_id/metadata/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataShow_MetadataResponse' description: Ok tags: - share-networks @@ -1927,10 +1603,6 @@ paths: $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_Metadata_ItemRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetsMetadataUpdate_Metadata_ItemResponse' description: Ok tags: - share-networks @@ -1956,10 +1628,6 @@ paths: share-networks/share_network_id/subnets/share_network_subnet_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_NetworksSubnetShowResponse' description: Ok tags: - share-networks @@ -1976,10 +1644,6 @@ paths: operationId: share-replicas:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasListResponse' description: Ok tags: - share-replicas @@ -1996,10 +1660,6 @@ paths: $ref: '#/components/schemas/Share_ReplicasCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasCreateResponse' description: Ok tags: - share-replicas @@ -2014,10 +1674,6 @@ paths: operationId: share-replicas/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasDetailResponse' description: Ok tags: - share-replicas @@ -2043,10 +1699,6 @@ paths: operationId: share-replicas/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicaShowResponse' description: Ok tags: - share-replicas @@ -2074,21 +1726,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_ReplicasActionForce_DeleteResponse' - - $ref: '#/components/schemas/Share_ReplicasActionReset_Replica_StateResponse' - - $ref: '#/components/schemas/Share_ReplicasActionReset_StatusResponse' description: Ok '202': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_ReplicasActionPromoteResponse' - - $ref: '#/components/schemas/Share_ReplicasActionResyncResponse' description: Ok tags: - share-replicas @@ -2099,10 +1738,6 @@ paths: operationId: share-replicas/resource_id/metadata:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataList_MetadataResponse' description: Ok tags: - share-replicas @@ -2119,10 +1754,6 @@ paths: $ref: '#/components/schemas/Share_ReplicasMetadataCreate_MetadataRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataCreate_MetadataResponse' description: Ok tags: - share-replicas @@ -2137,10 +1768,6 @@ paths: $ref: '#/components/schemas/Share_ReplicasMetadataUpdate_All_MetadataRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataUpdate_All_MetadataResponse' description: Ok tags: - share-replicas @@ -2160,10 +1787,6 @@ paths: operationId: share-replicas/resource_id/metadata/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataShow_MetadataResponse' description: Ok tags: - share-replicas @@ -2181,10 +1804,6 @@ paths: $ref: '#/components/schemas/Share_ReplicasMetadataUpdate_Metadata_ItemRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasMetadataUpdate_Metadata_ItemResponse' description: Ok tags: - share-replicas @@ -2196,10 +1815,6 @@ paths: operationId: share-replicas/share_replica_id/export-locations:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasExport_LocationsListResponse' description: Ok tags: - share-replicas @@ -2215,10 +1830,6 @@ paths: share-replicas/share_replica_id/export-locations/export_location_uuid:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ReplicasExport_LocationShowResponse' description: Ok tags: - share-replicas @@ -2235,10 +1846,6 @@ paths: operationId: share-servers:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ServersListResponse' description: Ok tags: - share-servers @@ -2252,10 +1859,6 @@ paths: $ref: '#/components/schemas/Share_ServersManageManageRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ServersManageResponse' description: Ok tags: - share-servers @@ -2277,10 +1880,6 @@ paths: operationId: share-servers/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ServerShowResponse' description: Ok tags: - share-servers @@ -2308,24 +1907,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_ServersActionMigration_CheckResponse' - - $ref: '#/components/schemas/Share_ServersActionMigration_CompleteResponse' - - $ref: '#/components/schemas/Share_ServersActionMigration_Get_ProgressResponse' - - $ref: '#/components/schemas/Share_ServersActionReset_StatusResponse' - - $ref: '#/components/schemas/Share_ServersActionReset_Task_StateResponse' - - $ref: '#/components/schemas/Share_ServersActionUnmanageResponse' description: Ok '202': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_ServersActionMigration_CancelResponse' - - $ref: '#/components/schemas/Share_ServersActionMigration_StartResponse' description: Ok tags: - share-servers @@ -2336,10 +1919,6 @@ paths: operationId: share-servers/id/details:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_ServersDetailsResponse' description: Ok tags: - share-servers @@ -2352,10 +1931,6 @@ paths: operationId: share-transfers:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransfersListResponse' description: Ok tags: - share-transfers @@ -2372,10 +1947,6 @@ paths: $ref: '#/components/schemas/Share_TransfersCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransfersCreateResponse' description: Ok tags: - share-transfers @@ -2388,10 +1959,6 @@ paths: operationId: share-transfers/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransfersDetailResponse' description: Ok tags: - share-transfers @@ -2415,10 +1982,6 @@ paths: operationId: share-transfers/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransferShowResponse' description: Ok tags: - share-transfers @@ -2440,10 +2003,6 @@ paths: $ref: '#/components/schemas/Share_TransfersAcceptAcceptRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_TransfersAcceptResponse' description: Ok tags: - share-transfers @@ -2455,10 +2014,6 @@ paths: operationId: share_instances:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_InstancesListResponse' description: Ok tags: - share_instances @@ -2470,10 +2025,6 @@ paths: operationId: share_instances/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Share_InstanceShowResponse' description: Ok tags: - share_instances @@ -2499,14 +2050,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/Share_InstancesActionForce_DeleteResponse' - - $ref: '#/components/schemas/Share_InstancesActionOs-Force_DeleteResponse' - - $ref: '#/components/schemas/Share_InstancesActionOs-Reset_StatusResponse' - - $ref: '#/components/schemas/Share_InstancesActionReset_StatusResponse' description: Ok tags: - share_instances @@ -2520,7 +2063,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Share_InstancesExport_LocationsListResponse' + oneOf: + - $ref: '#/components/schemas/Share_InstancesExport_LocationsIndexResponse_214' + - $ref: '#/components/schemas/Share_InstancesExport_LocationsIndexResponse_287' + - $ref: '#/components/schemas/Share_InstancesExport_LocationsIndexResponse_29' description: Ok tags: - share_instances @@ -2539,7 +2085,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse' + oneOf: + - $ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse_214' + - $ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse_287' + - $ref: '#/components/schemas/Share_InstancesExport_LocationShowResponse_29' description: Ok tags: - share_instances @@ -2555,10 +2104,6 @@ paths: operationId: shares:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesListResponse' description: Ok tags: - shares @@ -2574,10 +2119,6 @@ paths: $ref: '#/components/schemas/SharesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesCreateResponse' description: Ok tags: - shares @@ -2591,10 +2132,6 @@ paths: operationId: shares/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesDetailResponse' description: Ok tags: - shares @@ -2610,10 +2147,6 @@ paths: $ref: '#/components/schemas/SharesManageManageRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesManageResponse' description: Ok tags: - shares @@ -2635,10 +2168,6 @@ paths: operationId: shares/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ShareShowResponse' description: Ok tags: - shares @@ -2655,10 +2184,6 @@ paths: $ref: '#/components/schemas/ShareUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/ShareUpdateResponse' description: Ok tags: - shares @@ -2703,29 +2228,8 @@ paths: application/json: schema: oneOf: - - $ref: '#/components/schemas/SharesActionAccess_ListResponse' - - $ref: '#/components/schemas/SharesActionAllow_AccessResponse' - - $ref: '#/components/schemas/SharesActionDeny_AccessResponse' - - $ref: '#/components/schemas/SharesActionExtendResponse' - - $ref: '#/components/schemas/SharesActionForce_DeleteResponse' - - $ref: '#/components/schemas/SharesActionMigration_CancelResponse' - - $ref: '#/components/schemas/SharesActionMigration_CompleteResponse' - - $ref: '#/components/schemas/SharesActionMigration_Get_ProgressResponse' - - $ref: '#/components/schemas/SharesActionMigration_StartResponse' - - $ref: '#/components/schemas/SharesActionOs-Access_ListResponse' - - $ref: '#/components/schemas/SharesActionOs-Allow_AccessResponse' - - $ref: '#/components/schemas/SharesActionOs-Deny_AccessResponse' - - $ref: '#/components/schemas/SharesActionOs-ExtendResponse' - - $ref: '#/components/schemas/SharesActionOs-Force_DeleteResponse' - - $ref: '#/components/schemas/SharesActionOs-Reset_StatusResponse' - - $ref: '#/components/schemas/SharesActionOs-ShrinkResponse' - - $ref: '#/components/schemas/SharesActionReset_StatusResponse' - - $ref: '#/components/schemas/SharesActionReset_Task_StateResponse' - - $ref: '#/components/schemas/SharesActionRestoreResponse' - - $ref: '#/components/schemas/SharesActionRevertResponse' - - $ref: '#/components/schemas/SharesActionShrinkResponse' - - $ref: '#/components/schemas/SharesActionSoft_DeleteResponse' - - $ref: '#/components/schemas/SharesActionUnmanageResponse' + - $ref: '#/components/schemas/SharesActionMigration_Get_ProgressResponse_222' + - $ref: '#/components/schemas/SharesActionMigration_Get_ProgressResponse_259' description: Ok tags: - shares @@ -2736,10 +2240,6 @@ paths: operationId: shares/resource_id/metadata:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataList_MetadataResponse' description: Ok tags: - shares @@ -2756,10 +2256,6 @@ paths: $ref: '#/components/schemas/SharesMetadataCreate_MetadataRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataCreate_MetadataResponse' description: Ok tags: - shares @@ -2774,10 +2270,6 @@ paths: $ref: '#/components/schemas/SharesMetadataUpdate_All_MetadataRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataUpdate_All_MetadataResponse' description: Ok tags: - shares @@ -2797,10 +2289,6 @@ paths: operationId: shares/resource_id/metadata/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataShow_MetadataResponse' description: Ok tags: - shares @@ -2818,10 +2306,6 @@ paths: $ref: '#/components/schemas/SharesMetadataUpdate_Metadata_ItemRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesMetadataUpdate_Metadata_ItemResponse' description: Ok tags: - shares @@ -2838,7 +2322,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsListResponse' + oneOf: + - $ref: '#/components/schemas/SharesExport_LocationsIndexResponse_214' + - $ref: '#/components/schemas/SharesExport_LocationsIndexResponse_247' + - $ref: '#/components/schemas/SharesExport_LocationsIndexResponse_287' + - $ref: '#/components/schemas/SharesExport_LocationsIndexResponse_29' description: Ok tags: - shares @@ -2858,7 +2346,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationShowResponse' + oneOf: + - $ref: '#/components/schemas/SharesExport_LocationShowResponse_214' + - $ref: '#/components/schemas/SharesExport_LocationShowResponse_247' + - $ref: '#/components/schemas/SharesExport_LocationShowResponse_287' + - $ref: '#/components/schemas/SharesExport_LocationShowResponse_29' description: Ok tags: - shares @@ -2878,7 +2370,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataList_MetadataResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataIndex_MetadataResponse_287' description: Ok tags: - shares @@ -2901,7 +2393,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataCreate_MetadataResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataCreate_MetadataResponse_287' description: Ok tags: - shares @@ -2921,7 +2413,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_All_MetadataResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_All_MetadataResponse_287' description: Ok tags: - shares @@ -2949,7 +2441,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataShow_MetadataResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataShow_MetadataResponse_287' description: Ok tags: - shares @@ -2974,7 +2466,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse' + $ref: '#/components/schemas/SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse_287' description: Ok tags: - shares @@ -2985,10 +2477,6 @@ paths: operationId: shares/share_id/instances:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SharesInstancesGet_Share_InstancesResponse' description: Ok tags: - shares @@ -3003,10 +2491,6 @@ paths: operationId: snapshot-instances:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesListResponse' description: Ok tags: - snapshot-instances @@ -3019,10 +2503,6 @@ paths: operationId: snapshot-instances/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesDetailResponse' description: Ok tags: - snapshot-instances @@ -3033,10 +2513,6 @@ paths: operationId: snapshot-instances/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstanceShowResponse' description: Ok tags: - snapshot-instances @@ -3059,10 +2535,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesActionReset_StatusResponse' description: Ok tags: - snapshot-instances @@ -3071,10 +2543,6 @@ paths: operationId: snapshot-instances/snapshot_instance_id/export-locations:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesExport_LocationsListResponse' description: Ok tags: - snapshot-instances @@ -3088,10 +2556,6 @@ paths: snapshot-instances/snapshot_instance_id/export-locations/export_location_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/Snapshot_InstancesExport_LocationShowResponse' description: Ok tags: - snapshot-instances @@ -3126,7 +2590,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SnapshotsListResponse' + oneOf: + - $ref: '#/components/schemas/SnapshotsIndexResponse_20' + - $ref: '#/components/schemas/SnapshotsIndexResponse_236' + - $ref: '#/components/schemas/SnapshotsIndexResponse_273' + - $ref: '#/components/schemas/SnapshotsIndexResponse_279' description: Ok tags: - snapshots @@ -3143,10 +2611,6 @@ paths: $ref: '#/components/schemas/SnapshotsCreateRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsCreateResponse' description: Ok tags: - snapshots @@ -3157,10 +2621,6 @@ paths: operationId: snapshots/detail:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsDetailResponse' description: Ok tags: - snapshots @@ -3176,10 +2636,6 @@ paths: $ref: '#/components/schemas/SnapshotsManageManageRequest' responses: '202': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsManageResponse' description: Ok tags: - snapshots @@ -3204,7 +2660,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SnapshotShowResponse' + oneOf: + - $ref: '#/components/schemas/SnapshotShowResponse_20' + - $ref: '#/components/schemas/SnapshotShowResponse_212' + - $ref: '#/components/schemas/SnapshotShowResponse_217' + - $ref: '#/components/schemas/SnapshotShowResponse_273' description: Ok tags: - snapshots @@ -3223,10 +2683,6 @@ paths: $ref: '#/components/schemas/SnapshotUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotUpdateResponse' description: Ok tags: - snapshots @@ -3251,22 +2707,8 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SnapshotsActionDeny_AccessResponse' - - $ref: '#/components/schemas/SnapshotsActionForce_DeleteResponse' - - $ref: '#/components/schemas/SnapshotsActionOs-Force_DeleteResponse' - - $ref: '#/components/schemas/SnapshotsActionOs-Reset_StatusResponse' - - $ref: '#/components/schemas/SnapshotsActionReset_StatusResponse' - - $ref: '#/components/schemas/SnapshotsActionUnmanageResponse' description: Ok '202': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsActionAllow_AccessResponse' description: Ok tags: - snapshots @@ -3277,10 +2719,6 @@ paths: operationId: snapshots/resource_id/metadata:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataList_MetadataResponse' description: Ok tags: - snapshots @@ -3297,10 +2735,6 @@ paths: $ref: '#/components/schemas/SnapshotsMetadataCreate_MetadataRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataCreate_MetadataResponse' description: Ok tags: - snapshots @@ -3315,10 +2749,6 @@ paths: $ref: '#/components/schemas/SnapshotsMetadataUpdate_All_MetadataRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataUpdate_All_MetadataResponse' description: Ok tags: - snapshots @@ -3338,10 +2768,6 @@ paths: operationId: snapshots/resource_id/metadata/key:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataShow_MetadataResponse' description: Ok tags: - snapshots @@ -3359,10 +2785,6 @@ paths: $ref: '#/components/schemas/SnapshotsMetadataUpdate_Metadata_ItemRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsMetadataUpdate_Metadata_ItemResponse' description: Ok tags: - snapshots @@ -3373,10 +2795,6 @@ paths: operationId: snapshots/snapshot_id/access-list:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsAccess_ListResponse' description: Ok tags: - snapshots @@ -3389,10 +2807,6 @@ paths: operationId: snapshots/snapshot_id/export-locations:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsExport_LocationsListResponse' description: Ok tags: - snapshots @@ -3405,10 +2819,6 @@ paths: operationId: snapshots/snapshot_id/export-locations/export_location_id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/SnapshotsExport_LocationShowResponse' description: Ok tags: - snapshots @@ -3424,10 +2834,6 @@ paths: operationId: types:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesListResponse' description: Ok tags: - types @@ -3441,10 +2847,6 @@ paths: $ref: '#/components/schemas/TypesCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesCreateResponse' description: Ok tags: - types @@ -3458,10 +2860,6 @@ paths: operationId: types/default:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesDefaultResponse' description: Ok tags: - types @@ -3481,10 +2879,6 @@ paths: operationId: types/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypeShowResponse' description: Ok tags: - types @@ -3501,10 +2895,6 @@ paths: $ref: '#/components/schemas/TypeUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypeUpdateResponse' description: Ok tags: - types @@ -3529,15 +2919,6 @@ paths: discriminator: action responses: '201': - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/TypesActionAddprojectaccessResponse' - - $ref: '#/components/schemas/TypesActionCreateResponse' - - $ref: '#/components/schemas/TypesActionDeleteResponse' - - $ref: '#/components/schemas/TypesActionRemoveprojectaccessResponse' - - $ref: '#/components/schemas/TypesActionUpdateResponse' description: Ok tags: - types @@ -3546,10 +2927,6 @@ paths: operationId: types/id/os-share-type-access:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesOs_Share_Type_AccessOs-Share-Type-AccessResponse' description: Ok tags: - types @@ -3560,10 +2937,6 @@ paths: operationId: types/id/share_type_access:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesShare_Type_AccessResponse' description: Ok tags: - types @@ -3576,10 +2949,6 @@ paths: operationId: types/type_id/extra_specs:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesExtra_SpecsListResponse' description: Ok tags: - types @@ -3594,10 +2963,6 @@ paths: $ref: '#/components/schemas/TypesExtra_SpecsCreateRequest' responses: '201': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesExtra_SpecsCreateResponse' description: Ok tags: - types @@ -3621,10 +2986,6 @@ paths: operationId: types/type_id/extra_specs/id:get responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesExtra_SpecShowResponse' description: Ok tags: - types @@ -3640,10 +3001,6 @@ paths: $ref: '#/components/schemas/TypesExtra_SpecUpdateRequest' responses: '200': - content: - application/json: - schema: - $ref: '#/components/schemas/TypesExtra_SpecUpdateResponse' description: Ok tags: - types @@ -3697,7 +3054,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_created_before: in: query @@ -3706,7 +3062,6 @@ components: format: date-time type: string x-openstack: - max-ver: '2.51' min-ver: '2.52' messages_created_since: in: query @@ -3715,7 +3070,6 @@ components: format: date-time type: string x-openstack: - max-ver: '2.51' min-ver: '2.52' messages_detail_id: in: query @@ -3723,7 +3077,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_edit_id: description: id parameter for /messages/{id}/edit API @@ -3751,7 +3104,6 @@ components: - integer - string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_message_level: in: query @@ -3759,7 +3111,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_offset: in: query @@ -3773,7 +3124,6 @@ components: - integer - string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_request_id: in: query @@ -3781,7 +3131,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_resource_id: in: query @@ -3789,7 +3138,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_resource_type: in: query @@ -3797,7 +3145,6 @@ components: schema: type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_sort_dir: in: query @@ -3806,7 +3153,6 @@ components: default: desc type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' messages_sort_key: in: query @@ -3815,7 +3161,6 @@ components: default: created_at type: string x-openstack: - max-ver: '2.51' min-ver: '2.37' os_availability_zone_edit_id: description: id parameter for /os-availability-zone/{id}/edit API @@ -4781,9 +4126,6 @@ components: type: - boolean - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_description: in: query name: description @@ -4791,9 +4133,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_description_: in: query name: description~ @@ -4801,9 +4140,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_edit_id: description: id parameter for /snapshots/{id}/edit API in: path @@ -4845,9 +4181,6 @@ components: type: - integer - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_metadata: in: query name: metadata @@ -4855,9 +4188,6 @@ components: maxLength: 4096 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_metadata_key: description: key parameter for /snapshots/{resource_id}/metadata/{key} API in: path @@ -4880,9 +4210,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_name_: in: query name: name~ @@ -4890,9 +4217,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_offset: in: query name: offset @@ -4904,9 +4228,6 @@ components: type: - integer - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_project_id: in: query name: project_id @@ -4915,8 +4236,6 @@ components: minLength: 1 type: string x-openstack: - max-ver: '2.35' - max_ver: '2.78' resource_link: identity/v3/project.id snapshots_share_id: in: query @@ -4925,9 +4244,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_size: in: query name: size @@ -4939,9 +4255,6 @@ components: type: - integer - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_sort_dir: in: query name: sort_dir @@ -4949,9 +4262,6 @@ components: default: desc description: Sort direction type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_sort_key: in: query name: sort_key @@ -4959,9 +4269,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_status: in: query name: status @@ -4969,9 +4276,6 @@ components: maxLength: 255 minLength: 1 type: string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' snapshots_with_count: in: query name: with_count @@ -5008,9 +4312,6 @@ components: type: - boolean - string - x-openstack: - max-ver: '2.35' - max_ver: '2.78' types_action_id: description: id parameter for /types/{id}/action API in: path @@ -5083,7 +4384,7 @@ components: schema: type: string schemas: - Availability_ZonesListResponse: + Availability_ZonesIndexResponse_27: additionalProperties: false properties: availability_zones: @@ -5111,24 +4412,14 @@ components: required: - availability_zones type: object - ExtensionShowResponse: - description: Response of the extensions/id:get operation - type: object + x-openstack: + min-ver: '2.7' ExtensionsCreateRequest: description: Request of the extensions:post operation type: object x-openstack: action-name: create - ExtensionsCreateResponse: - description: Response of the extensions:post operation - type: object - ExtensionsListResponse: - description: Response of the extensions:get operation - type: object - LimitsListResponse: - description: Response of the limits:get operation - type: object - MessageShowResponse: + MessageShowResponse_237: additionalProperties: false properties: message: @@ -5196,7 +4487,98 @@ components: required: - message type: object - MessagesListResponse: + x-openstack: + min-ver: '2.37' + MessagesIndexResponse_237: + additionalProperties: false + properties: + messages: + items: + additionalProperties: false + properties: + action_id: + type: string + created_at: + format: date-time + type: string + detail_id: + type: string + expires_at: + format: date-time + type: string + id: + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + message_level: + enum: + - ERROR + type: string + project_id: + type: string + request_id: + type: string + resource_id: + format: uuid + type: string + resource_type: + type: string + user_message: + type: string + required: + - action_id + - created_at + - detail_id + - expires_at + - id + - links + - message_level + - project_id + - request_id + - resource_id + - resource_type + - user_message + type: object + type: array + messages_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: + - messages + type: object + x-openstack: + max-ver: '2.51' + min-ver: '2.37' + MessagesIndexResponse_252: additionalProperties: false properties: messages: @@ -5282,7 +4664,9 @@ components: required: - messages type: object - Os_Availability_ZoneListResponse: + x-openstack: + min-ver: '2.52' + Os_Availability_ZoneIndexResponse_20: additionalProperties: false properties: availability_zones: @@ -5310,7 +4694,10 @@ components: required: - availability_zones type: object - Os_Quota_Class_SetShowResponse: + x-openstack: + max-ver: '2.6' + min-ver: '2.0' + Os_Quota_Class_SetShowResponse_20: additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: @@ -5346,7 +4733,10 @@ components: required: - quota_class_set type: object - Os_Quota_Class_SetUpdateResponse: + x-openstack: + max-ver: '2.6' + min-ver: '2.0' + Os_Quota_Class_SetUpdateResponse_20: additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: @@ -5382,6 +4772,9 @@ components: required: - quota_class_set type: object + x-openstack: + max-ver: '2.6' + min-ver: '2.0' Os_Quota_Class_SetUpdate_20: additionalProperties: true description: "A ``quota_class_set`` object.\n" @@ -5416,121 +4809,98 @@ components: x-openstack: max-ver: '2.6' min-ver: '2.0' - Os_Quota_SetShowResponse: - description: Response of the os-quota-sets/id:get operation - type: object Os_Quota_SetUpdateRequest: description: Request of the os-quota-sets/id:put operation type: object x-openstack: action-name: update - Os_Quota_SetUpdateResponse: - description: Response of the os-quota-sets/id:put operation - type: object - Os_Quota_SetsDefaultsResponse: - description: Response of the os-quota-sets/id/defaults:get operation - type: object Os_ServiceUpdateRequest: description: Request of the os-services/id:put operation type: object x-openstack: action-name: update - Os_ServiceUpdateResponse: - description: Response of the os-services/id:put operation - type: object - Os_ServicesListResponse: - description: Response of the os-services:get operation - type: object Os_Share_ManageCreateRequest: description: Request of the os-share-manage:post operation type: object x-openstack: action-name: create - Os_Share_ManageCreateResponse: - description: Response of the os-share-manage:post operation - type: object - Os_Share_UnmanageUnmanageResponse: - description: Response of the os-share-unmanage/id/unmanage:post operation - type: object Os_Share_UnmanageUnmanageUnmanageRequest: description: Request of the os-share-unmanage/id/unmanage:post operation type: object x-openstack: action-name: unmanage - Qos_TypeShowResponse: - description: Response of the qos-types/id:get operation - type: object Qos_TypeUpdateRequest: description: Request of the qos-types/id:put operation type: object x-openstack: action-name: update - Qos_TypeUpdateResponse: - description: Response of the qos-types/id:put operation - type: object Qos_TypesCreateRequest: description: Request of the qos-types:post operation type: object x-openstack: action-name: create - Qos_TypesCreateResponse: - description: Response of the qos-types:post operation - type: object - Qos_TypesListResponse: - description: Response of the qos-types:get operation - type: object - Qos_TypesSpecShowResponse: - description: Response of the qos-types/id/specs/key:get operation - type: object Qos_TypesSpecUpdateRequest: description: Request of the qos-types/id/specs/key:put operation type: object x-openstack: action-name: update - Qos_TypesSpecUpdateResponse: - description: Response of the qos-types/id/specs/key:put operation - type: object Qos_TypesSpecsCreateRequest: description: Request of the qos-types/id/specs:post operation type: object x-openstack: action-name: create - Qos_TypesSpecsCreateResponse: - description: Response of the qos-types/id/specs:post operation - type: object - Qos_TypesSpecsListResponse: - description: Response of the qos-types/id/specs:get operation - type: object - Quota_Class_SetShowResponse: + Quota_Class_SetShowResponse_10: additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: additionalProperties: false properties: - backup_gigabytes: - description: "The number of gigabytes for the backups allowed for each - project.\n" + gigabytes: + description: "The number of gigabytes allowed for each project.\n" type: integer - backups: - description: "The number of backups allowed for each project.\n" + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" type: integer - encryption_keys: - description: "The number of encryption keys allowed for each project.\n" + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.39' + min-ver: '1.0' + Quota_Class_SetShowResponse_240: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: gigabytes: description: "The number of gigabytes allowed for each project.\n" type: integer id: description: "A ``quota_class_set`` id.\n" type: string - per_share_gigabytes: - description: "The number of gigabytes per share allowed for each project.\n" - type: integer - replica_gigabytes: - description: "The number of gigabytes for the share replicas allowed - for each project.\n" - type: integer share_group_snapshots: description: "The number of share group snapshots allowed for each project or user.\n" @@ -5542,9 +4912,6 @@ components: share_networks: description: "The number of share networks allowed for each project.\n" type: integer - share_replicas: - description: "The number of share replicas allowed for each project.\n" - type: integer shares: description: "The number of shares allowed for each project.\n" type: integer @@ -5556,16 +4923,10 @@ components: description: "The number of snapshots allowed for each project.\n" type: integer required: - - backup_gigabytes - - backups - - encryption_keys - gigabytes - - per_share_gigabytes - - replica_gigabytes - share_group_snapshots - share_groups - share_networks - - share_replicas - shares - snapshot_gigabytes - snapshots @@ -5573,41 +4934,22 @@ components: required: - quota_class_set type: object - Quota_Class_SetUpdateRequest: - oneOf: - - $ref: '#/components/schemas/Quota_Class_SetUpdate_253' - - $ref: '#/components/schemas/Quota_Class_SetUpdate_262' - - $ref: '#/components/schemas/Quota_Class_SetUpdate_27' - - $ref: '#/components/schemas/Quota_Class_SetUpdate_280' - - $ref: '#/components/schemas/Quota_Class_SetUpdate_290' x-openstack: - discriminator: microversion - Quota_Class_SetUpdateResponse: + max-ver: '2.52' + min-ver: '2.40' + Quota_Class_SetShowResponse_253: additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: additionalProperties: false properties: - backup_gigabytes: - description: "The number of gigabytes for the backups allowed for each - project.\n" - type: integer - backups: - description: "The number of backups allowed for each project.\n" - type: integer - encryption_keys: - description: "The number of encryption keys allowed for each project.\n" - type: integer gigabytes: description: "The number of gigabytes allowed for each project.\n" type: integer id: description: "A ``quota_class_set`` id.\n" type: string - per_share_gigabytes: - description: "The number of gigabytes per share allowed for each project.\n" - type: integer replica_gigabytes: description: "The number of gigabytes for the share replicas allowed for each project.\n" @@ -5637,11 +4979,7 @@ components: description: "The number of snapshots allowed for each project.\n" type: integer required: - - backup_gigabytes - - backups - - encryption_keys - gigabytes - - per_share_gigabytes - replica_gigabytes - share_group_snapshots - share_groups @@ -5654,84 +4992,64 @@ components: required: - quota_class_set type: object - Quota_Class_SetUpdate_253: - additionalProperties: true + x-openstack: + max-ver: '2.61' + min-ver: '2.53' + Quota_Class_SetShowResponse_262: + additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" + additionalProperties: false properties: gigabytes: - description: "The number of gigabytes for the project.\n" + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + per_share_gigabytes: + description: "The number of gigabytes per share allowed for each project.\n" type: integer replica_gigabytes: - description: "The number of gigabytes for share replicas for the project.\n" + description: "The number of gigabytes for the share replicas allowed + for each project.\n" + type: integer + share_group_snapshots: + description: "The number of share group snapshots allowed for each project + or user.\n" type: integer share_groups: description: "The number of share groups allowed for each project or user.\n" type: integer share_networks: - description: "The number of share networks for the project.\n" + description: "The number of share networks allowed for each project.\n" type: integer share_replicas: - description: "The number of share replicas allowed for each project - or user.\n" + description: "The number of share replicas allowed for each project.\n" type: integer shares: - description: "The number of shares for the project.\n" + description: "The number of shares allowed for each project.\n" type: integer snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" + description: "The number of gigabytes for the snapshots allowed for + each project.\n" type: integer snapshots: - description: "The number of snapshots for the project.\n" - type: integer - type: object - required: - - quota_class_set - type: object - x-openstack: - max-ver: '2.61' - min-ver: '2.53' - Quota_Class_SetUpdate_262: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" - properties: - quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" - properties: - gigabytes: - description: "The number of gigabytes for the project.\n" - type: integer - per_share_gigabytes: - description: "The number of gigabytes per share allowed for each project.\n" - type: integer - replica_gigabytes: - description: "The number of gigabytes for share replicas for the project.\n" - type: integer - share_groups: - description: "The number of share groups allowed for each project or - user.\n" - type: integer - share_networks: - description: "The number of share networks for the project.\n" - type: integer - share_replicas: - description: "The number of share replicas allowed for each project - or user.\n" - type: integer - shares: - description: "The number of shares for the project.\n" - type: integer - snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" - type: integer - snapshots: - description: "The number of snapshots for the project.\n" + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - gigabytes + - per_share_gigabytes + - replica_gigabytes + - share_group_snapshots + - share_groups + - share_networks + - share_replicas + - shares + - snapshot_gigabytes + - snapshots type: object required: - quota_class_set @@ -5739,83 +5057,108 @@ components: x-openstack: max-ver: '2.79' min-ver: '2.62' - Quota_Class_SetUpdate_27: - additionalProperties: true + Quota_Class_SetShowResponse_27: + additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" + additionalProperties: false properties: gigabytes: - description: "The number of gigabytes for the project.\n" - type: integer - share_groups: - description: "The number of share groups allowed for each project or - user.\n" + description: "The number of gigabytes allowed for each project.\n" type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string share_networks: - description: "The number of share networks for the project.\n" + description: "The number of share networks allowed for each project.\n" type: integer shares: - description: "The number of shares for the project.\n" + description: "The number of shares allowed for each project.\n" type: integer snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" + description: "The number of gigabytes for the snapshots allowed for + each project.\n" type: integer snapshots: - description: "The number of snapshots for the project.\n" + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots type: object required: - quota_class_set type: object x-openstack: - max-ver: '2.52' min-ver: '2.7' - Quota_Class_SetUpdate_280: - additionalProperties: true + Quota_Class_SetShowResponse_280: + additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" + additionalProperties: false properties: backup_gigabytes: - description: "The number of gigabytes for the backups for the\nproject.\n" + description: "The number of gigabytes for the backups allowed for each + project.\n" type: integer backups: - description: "The number of backups for the project.\n" + description: "The number of backups allowed for each project.\n" type: integer gigabytes: - description: "The number of gigabytes for the project.\n" + description: "The number of gigabytes allowed for each project.\n" type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string per_share_gigabytes: description: "The number of gigabytes per share allowed for each project.\n" type: integer replica_gigabytes: - description: "The number of gigabytes for share replicas for the project.\n" + description: "The number of gigabytes for the share replicas allowed + for each project.\n" + type: integer + share_group_snapshots: + description: "The number of share group snapshots allowed for each project + or user.\n" type: integer share_groups: description: "The number of share groups allowed for each project or user.\n" type: integer share_networks: - description: "The number of share networks for the project.\n" + description: "The number of share networks allowed for each project.\n" type: integer share_replicas: - description: "The number of share replicas allowed for each project - or user.\n" + description: "The number of share replicas allowed for each project.\n" type: integer shares: - description: "The number of shares for the project.\n" + description: "The number of shares allowed for each project.\n" type: integer snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" + description: "The number of gigabytes for the snapshots allowed for + each project.\n" type: integer snapshots: - description: "The number of snapshots for the project.\n" + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - backup_gigabytes + - backups + - gigabytes + - per_share_gigabytes + - replica_gigabytes + - share_group_snapshots + - share_groups + - share_networks + - share_replicas + - shares + - snapshot_gigabytes + - snapshots type: object required: - quota_class_set @@ -5823,137 +5166,619 @@ components: x-openstack: max-ver: '2.89' min-ver: '2.80' - Quota_Class_SetUpdate_290: - additionalProperties: true + Quota_Class_SetShowResponse_290: + additionalProperties: false description: "A ``quota_class_set`` object.\n" properties: quota_class_set: - additionalProperties: true - description: "A ``quota_class_set`` object.\n" + additionalProperties: false properties: backup_gigabytes: - description: "The number of gigabytes for the backups for the\nproject.\n" + description: "The number of gigabytes for the backups allowed for each + project.\n" type: integer backups: - description: "The number of backups for the project.\n" + description: "The number of backups allowed for each project.\n" type: integer encryption_keys: description: "The number of encryption keys allowed for each project.\n" type: integer gigabytes: - description: "The number of gigabytes for the project.\n" + description: "The number of gigabytes allowed for each project.\n" type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string per_share_gigabytes: description: "The number of gigabytes per share allowed for each project.\n" type: integer replica_gigabytes: - description: "The number of gigabytes for share replicas for the project.\n" + description: "The number of gigabytes for the share replicas allowed + for each project.\n" + type: integer + share_group_snapshots: + description: "The number of share group snapshots allowed for each project + or user.\n" type: integer share_groups: description: "The number of share groups allowed for each project or user.\n" type: integer share_networks: - description: "The number of share networks for the project.\n" + description: "The number of share networks allowed for each project.\n" type: integer share_replicas: - description: "The number of share replicas allowed for each project - or user.\n" + description: "The number of share replicas allowed for each project.\n" type: integer shares: - description: "The number of shares for the project.\n" + description: "The number of shares allowed for each project.\n" type: integer snapshot_gigabytes: - description: "The number of gigabytes for the snapshots for the\nproject.\n" + description: "The number of gigabytes for the snapshots allowed for + each project.\n" type: integer snapshots: - description: "The number of snapshots for the project.\n" + description: "The number of snapshots allowed for each project.\n" type: integer + required: + - backup_gigabytes + - backups + - encryption_keys + - gigabytes + - per_share_gigabytes + - replica_gigabytes + - share_group_snapshots + - share_groups + - share_networks + - share_replicas + - shares + - snapshot_gigabytes + - snapshots type: object required: - quota_class_set type: object x-openstack: - max-ver: '2.52' min-ver: '2.90' - Quota_SetShowResponse: - description: Response of the quota-sets/id:get operation - type: object - Quota_SetUpdateRequest: - description: Request of the quota-sets/id:put operation - type: object + Quota_Class_SetUpdateRequest: + oneOf: + - $ref: '#/components/schemas/Quota_Class_SetUpdate_253' + - $ref: '#/components/schemas/Quota_Class_SetUpdate_262' + - $ref: '#/components/schemas/Quota_Class_SetUpdate_27' + - $ref: '#/components/schemas/Quota_Class_SetUpdate_280' + - $ref: '#/components/schemas/Quota_Class_SetUpdate_290' x-openstack: - action-name: update - Quota_SetUpdateResponse: - description: Response of the quota-sets/id:put operation - type: object - Quota_SetsDefaultsResponse: - description: Response of the quota-sets/id/defaults:get operation - type: object - Quota_SetsDetailResponse: - description: Response of the quota-sets/id/detail:get operation - type: object - Resource_LockShowResponse: + discriminator: microversion + Quota_Class_SetUpdateResponse_240: additionalProperties: false + description: "A ``quota_class_set`` object.\n" properties: - resource_lock: + quota_class_set: additionalProperties: false - description: "A resource lock object when making resource lock requests. - All other\nparameters are included in this object.\n" properties: - created_at: - description: "The date and time stamp when the resource was created - within the service's\ndatabase.\n\nThe date and time stamp format - is `ISO 8601\n`_:\n\n::\n\n\ - \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, - returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" - format: date-time - type: string + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer id: - description: "The UUID identifying the specific resource lock.\n" - format: uuid - type: string - links: - items: - additionalProperties: false - properties: - href: - format: uri - type: string - rel: - enum: - - bookmark - - self - type: string - required: - - href - - rel - type: object - type: array - lock_context: - description: "The lock creator's context. Resource locks can be created - by users with\ndifferent roles. If a user with ``admin`` role creates - the lock, the value\nof this field is ``admin``. If a user with ``service`` - role creates the\nlock, the value of this field is ``service``. For - all other contexts, the\nvalue of this field is ``user``. This field - also determines the user's\nrole that is required to unlock or manipulate - a lock by virtue of the\nservice's default RBAC.\n" - type: string - lock_reason: - description: "A blob of text representing the reason for the specific - resource lock.\n" - type: - - 'null' - - string - project_id: - description: "The ID of the project that the resource lock was created - for.\n" - format: uuid + description: "A ``quota_class_set`` id.\n" type: string - resource_action: - description: "The action pertaining to a resource that the resource - lock prevents. For\nexample, if a resource lock prevents deletion - of a share, the value of\n``resource_action`` is ``delete``. Resource + share_group_snapshots: + description: "The number of share group snapshots allowed for each project + or user.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_group_snapshots + - share_groups + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.52' + min-ver: '2.40' + Quota_Class_SetUpdateResponse_253: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.61' + min-ver: '2.53' + Quota_Class_SetUpdateResponse_262: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.79' + min-ver: '2.62' + Quota_Class_SetUpdateResponse_27: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.39' + min-ver: '2.7' + Quota_Class_SetUpdateResponse_280: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.89' + min-ver: '2.80' + Quota_Class_SetUpdateResponse_290: + additionalProperties: false + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: false + properties: + gigabytes: + description: "The number of gigabytes allowed for each project.\n" + type: integer + id: + description: "A ``quota_class_set`` id.\n" + type: string + share_networks: + description: "The number of share networks allowed for each project.\n" + type: integer + shares: + description: "The number of shares allowed for each project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots allowed for + each project.\n" + type: integer + snapshots: + description: "The number of snapshots allowed for each project.\n" + type: integer + required: + - gigabytes + - share_networks + - shares + - snapshot_gigabytes + - snapshots + type: object + required: + - quota_class_set + type: object + x-openstack: + min-ver: '2.90' + Quota_Class_SetUpdate_253: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + replica_gigabytes: + description: "The number of gigabytes for share replicas for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + share_replicas: + description: "The number of share replicas allowed for each project + or user.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.61' + min-ver: '2.53' + Quota_Class_SetUpdate_262: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + per_share_gigabytes: + description: "The number of gigabytes per share allowed for each project.\n" + type: integer + replica_gigabytes: + description: "The number of gigabytes for share replicas for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + share_replicas: + description: "The number of share replicas allowed for each project + or user.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.79' + min-ver: '2.62' + Quota_Class_SetUpdate_27: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.52' + min-ver: '2.7' + Quota_Class_SetUpdate_280: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + backup_gigabytes: + description: "The number of gigabytes for the backups for the\nproject.\n" + type: integer + backups: + description: "The number of backups for the project.\n" + type: integer + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + per_share_gigabytes: + description: "The number of gigabytes per share allowed for each project.\n" + type: integer + replica_gigabytes: + description: "The number of gigabytes for share replicas for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + share_replicas: + description: "The number of share replicas allowed for each project + or user.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + max-ver: '2.89' + min-ver: '2.80' + Quota_Class_SetUpdate_290: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + quota_class_set: + additionalProperties: true + description: "A ``quota_class_set`` object.\n" + properties: + backup_gigabytes: + description: "The number of gigabytes for the backups for the\nproject.\n" + type: integer + backups: + description: "The number of backups for the project.\n" + type: integer + encryption_keys: + description: "The number of encryption keys allowed for each project.\n" + type: integer + gigabytes: + description: "The number of gigabytes for the project.\n" + type: integer + per_share_gigabytes: + description: "The number of gigabytes per share allowed for each project.\n" + type: integer + replica_gigabytes: + description: "The number of gigabytes for share replicas for the project.\n" + type: integer + share_groups: + description: "The number of share groups allowed for each project or + user.\n" + type: integer + share_networks: + description: "The number of share networks for the project.\n" + type: integer + share_replicas: + description: "The number of share replicas allowed for each project + or user.\n" + type: integer + shares: + description: "The number of shares for the project.\n" + type: integer + snapshot_gigabytes: + description: "The number of gigabytes for the snapshots for the\nproject.\n" + type: integer + snapshots: + description: "The number of snapshots for the project.\n" + type: integer + type: object + required: + - quota_class_set + type: object + x-openstack: + min-ver: '2.90' + Quota_SetUpdateRequest: + description: Request of the quota-sets/id:put operation + type: object + x-openstack: + action-name: update + Resource_LockShowResponse_281: + additionalProperties: false + properties: + resource_lock: + additionalProperties: false + description: "A resource lock object when making resource lock requests. + All other\nparameters are included in this object.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + type: string + id: + description: "The UUID identifying the specific resource lock.\n" + format: uuid + type: string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + lock_context: + description: "The lock creator's context. Resource locks can be created + by users with\ndifferent roles. If a user with ``admin`` role creates + the lock, the value\nof this field is ``admin``. If a user with ``service`` + role creates the\nlock, the value of this field is ``service``. For + all other contexts, the\nvalue of this field is ``user``. This field + also determines the user's\nrole that is required to unlock or manipulate + a lock by virtue of the\nservice's default RBAC.\n" + type: string + lock_reason: + description: "A blob of text representing the reason for the specific + resource lock.\n" + type: + - 'null' + - string + project_id: + description: "The ID of the project that the resource lock was created + for.\n" + format: uuid + type: string + resource_action: + description: "The action pertaining to a resource that the resource + lock prevents. For\nexample, if a resource lock prevents deletion + of a share, the value of\n``resource_action`` is ``delete``. Resource locks are not supported for\nall API actions.\n" enum: - delete @@ -6005,7 +5830,9 @@ components: required: - resource_lock type: object - Resource_LockUpdateResponse: + x-openstack: + min-ver: '2.81' + Resource_LockUpdateResponse_281: additionalProperties: false properties: resource_lock: @@ -6117,6 +5944,8 @@ components: required: - resource_lock type: object + x-openstack: + min-ver: '2.81' Resource_LockUpdate_281: additionalProperties: true properties: @@ -6150,7 +5979,7 @@ components: type: object x-openstack: min-ver: '2.81' - Resource_LocksCreateResponse: + Resource_LocksCreateResponse_281: additionalProperties: false properties: resource_lock: @@ -6262,6 +6091,8 @@ components: required: - resource_lock type: object + x-openstack: + min-ver: '2.81' Resource_LocksCreate_281: additionalProperties: true properties: @@ -6319,7 +6150,7 @@ components: type: object x-openstack: min-ver: '2.81' - Resource_LocksListResponse: + Resource_LocksIndexResponse_281: additionalProperties: false properties: count: @@ -6456,48 +6287,23 @@ components: required: - resource_locks type: object - RootListResponse: - description: Response of the :get operation - type: object - Scheduler_StatsPoolsDetailPools_DetailResponse: - description: Response of the scheduler-stats/pools/detail:get operation - type: object - Scheduler_StatsPoolsPools_ListResponse: - description: Response of the scheduler-stats/pools:get operation - type: object - Security_ServiceShowResponse: - description: Response of the security-services/id:get operation - type: object + x-openstack: + min-ver: '2.81' Security_ServiceUpdateRequest: description: Request of the security-services/id:put operation type: object x-openstack: action-name: update - Security_ServiceUpdateResponse: - description: Response of the security-services/id:put operation - type: object Security_ServicesCreateRequest: description: Request of the security-services:post operation type: object x-openstack: action-name: create - Security_ServicesCreateResponse: - description: Response of the security-services:post operation - type: object - Security_ServicesDetailResponse: - description: Response of the security-services/detail:get operation - type: object - Security_ServicesListResponse: - description: Response of the security-services:get operation - type: object ServiceUpdateRequest: description: Request of the services/id:put operation type: object x-openstack: action-name: update - ServiceUpdateResponse: - description: Response of the services/id:put operation - type: object ServicesEnsure_SharesEnsure_Shares_286: additionalProperties: false properties: @@ -6516,57 +6322,27 @@ components: type: object x-openstack: min-ver: '2.86' - ServicesEnsure_SharesResponse: - type: 'null' - ServicesListResponse: - description: Response of the services:get operation - type: object - ShareShowResponse: - description: Response of the shares/id:get operation - type: object ShareUpdateRequest: description: Request of the shares/id:put operation type: object x-openstack: action-name: update - ShareUpdateResponse: - description: Response of the shares/id:put operation - type: object - Share_Access_RuleShowResponse: - description: Response of the share-access-rules/id:get operation - type: object Share_Access_RuleUpdateRequest: description: Request of the share-access-rules/id:put operation type: object x-openstack: action-name: update - Share_Access_RuleUpdateResponse: - description: Response of the share-access-rules/id:put operation - type: object - Share_Access_RulesListResponse: - description: Response of the share-access-rules:get operation - type: object Share_Access_RulesMetadataUpdateRequest: description: Request of the share-access-rules/access_id/metadata:put operation type: object x-openstack: action-name: update - Share_Access_RulesMetadataUpdateResponse: - description: Response of the share-access-rules/access_id/metadata:put - operation - type: object - Share_BackupShowResponse: - description: Response of the share-backups/id:get operation - type: object Share_BackupUpdateRequest: description: Request of the share-backups/id:put operation type: object x-openstack: action-name: update - Share_BackupUpdateResponse: - description: Response of the share-backups/id:put operation - type: object Share_BackupsActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -6575,12 +6351,6 @@ components: type: object x-openstack: action-name: reset_status - Share_BackupsActionReset_StatusResponse: - description: Response of the share-backups/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_BackupsActionRestoreRequest: description: Empty body for restore action properties: @@ -6589,47 +6359,21 @@ components: type: object x-openstack: action-name: restore - Share_BackupsActionRestoreResponse: - description: Response of the share-backups/id/action:post:restore action - type: object - x-openstack: - action-name: restore Share_BackupsCreateRequest: description: Request of the share-backups:post operation type: object x-openstack: action-name: create - Share_BackupsCreateResponse: - description: Response of the share-backups:post operation - type: object - Share_BackupsDetailResponse: - description: Response of the share-backups/detail:get operation - type: object - Share_BackupsListResponse: - description: Response of the share-backups:get operation - type: object - Share_GroupShowResponse: - description: Response of the share-groups/id:get operation - type: object Share_GroupUpdateRequest: description: Request of the share-groups/id:put operation type: object x-openstack: action-name: update - Share_GroupUpdateResponse: - description: Response of the share-groups/id:put operation - type: object - Share_Group_SnapshotShowResponse: - description: Response of the share-group-snapshots/id:get operation - type: object Share_Group_SnapshotUpdateRequest: description: Request of the share-group-snapshots/id:put operation type: object x-openstack: action-name: update - Share_Group_SnapshotUpdateResponse: - description: Response of the share-group-snapshots/id:put operation - type: object Share_Group_SnapshotsActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -6638,12 +6382,6 @@ components: type: object x-openstack: action-name: force_delete - Share_Group_SnapshotsActionForce_DeleteResponse: - description: Response of the - share-group-snapshots/id/action:post:force_delete action - type: object - x-openstack: - action-name: force_delete Share_Group_SnapshotsActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -6652,36 +6390,11 @@ components: type: object x-openstack: action-name: reset_status - Share_Group_SnapshotsActionReset_StatusResponse: - description: Response of the - share-group-snapshots/id/action:post:reset_status action - type: object - x-openstack: - action-name: reset_status Share_Group_SnapshotsCreateRequest: description: Request of the share-group-snapshots:post operation type: object x-openstack: action-name: create - Share_Group_SnapshotsCreateResponse: - description: Response of the share-group-snapshots:post operation - type: object - Share_Group_SnapshotsDetailResponse: - description: Response of the share-group-snapshots/detail:get operation - type: object - Share_Group_SnapshotsListResponse: - description: Response of the share-group-snapshots:get operation - type: object - Share_Group_SnapshotsMembersResponse: - description: Response of the share-group-snapshots/id/members:get - operation - type: object - Share_Group_TypeShowResponse: - description: Response of the share-group-types/id:get operation - type: object - Share_Group_TypesAccessShare_Group_Type_AccessResponse: - description: Response of the share-group-types/id/access:get operation - type: object Share_Group_TypesActionAddprojectaccessRequest: description: Empty body for addProjectAccess action properties: @@ -6690,12 +6403,6 @@ components: type: object x-openstack: action-name: addProjectAccess - Share_Group_TypesActionAddprojectaccessResponse: - description: Response of the - share-group-types/id/action:post:addProjectAccess action - type: object - x-openstack: - action-name: addProjectAccess Share_Group_TypesActionCreateRequest: description: Empty body for create action properties: @@ -6704,12 +6411,6 @@ components: type: object x-openstack: action-name: create - Share_Group_TypesActionCreateResponse: - description: Response of the share-group-types/id/action:post:create - action - type: object - x-openstack: - action-name: create Share_Group_TypesActionDeleteRequest: description: Empty body for delete action properties: @@ -6718,12 +6419,6 @@ components: type: object x-openstack: action-name: delete - Share_Group_TypesActionDeleteResponse: - description: Response of the share-group-types/id/action:post:delete - action - type: object - x-openstack: - action-name: delete Share_Group_TypesActionRemoveprojectaccessRequest: description: Empty body for removeProjectAccess action properties: @@ -6732,56 +6427,23 @@ components: type: object x-openstack: action-name: removeProjectAccess - Share_Group_TypesActionRemoveprojectaccessResponse: - description: Response of the - share-group-types/id/action:post:removeProjectAccess action - type: object - x-openstack: - action-name: removeProjectAccess Share_Group_TypesCreateRequest: description: Request of the share-group-types:post operation type: object x-openstack: action-name: create - Share_Group_TypesCreateResponse: - description: Response of the share-group-types:post:create action - type: object - x-openstack: - action-name: create - Share_Group_TypesDefaultResponse: - description: Response of the share-group-types/default:get operation - type: object - Share_Group_TypesGroup_SpecShowResponse: - description: Response of the share-group-types/id/group-specs/key:get - operation - type: object Share_Group_TypesGroup_SpecUpdateRequest: description: Request of the share-group-types/id/group-specs/key:put operation type: object x-openstack: action-name: update - Share_Group_TypesGroup_SpecUpdateResponse: - description: Response of the share-group-types/id/group-specs/key:put - operation - type: object Share_Group_TypesGroup_SpecsCreateRequest: description: Request of the share-group-types/id/group-specs:post operation type: object x-openstack: action-name: create - Share_Group_TypesGroup_SpecsCreateResponse: - description: Response of the share-group-types/id/group-specs:post - operation - type: object - Share_Group_TypesGroup_SpecsListResponse: - description: Response of the share-group-types/id/group-specs:get - operation - type: object - Share_Group_TypesListResponse: - description: Response of the share-group-types:get operation - type: object Share_GroupsActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -6790,12 +6452,6 @@ components: type: object x-openstack: action-name: force_delete - Share_GroupsActionForce_DeleteResponse: - description: Response of the share-groups/id/action:post:force_delete - action - type: object - x-openstack: - action-name: force_delete Share_GroupsActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -6804,29 +6460,11 @@ components: type: object x-openstack: action-name: reset_status - Share_GroupsActionReset_StatusResponse: - description: Response of the share-groups/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_GroupsCreateRequest: description: Request of the share-groups:post operation type: object x-openstack: action-name: create - Share_GroupsCreateResponse: - description: Response of the share-groups:post operation - type: object - Share_GroupsDetailResponse: - description: Response of the share-groups/detail:get operation - type: object - Share_GroupsListResponse: - description: Response of the share-groups:get operation - type: object - Share_InstanceShowResponse: - description: Response of the share_instances/id:get operation - type: object Share_InstancesActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -6835,12 +6473,6 @@ components: type: object x-openstack: action-name: force_delete - Share_InstancesActionForce_DeleteResponse: - description: Response of the share_instances/id/action:post:force_delete - action - type: object - x-openstack: - action-name: force_delete Share_InstancesActionOs-Force_DeleteRequest: description: Empty body for os-force_delete action properties: @@ -6849,12 +6481,6 @@ components: type: object x-openstack: action-name: os-force_delete - Share_InstancesActionOs-Force_DeleteResponse: - description: Response of the - share_instances/id/action:post:os-force_delete action - type: object - x-openstack: - action-name: os-force_delete Share_InstancesActionOs-Reset_StatusRequest: description: Empty body for os-reset_status action properties: @@ -6863,12 +6489,6 @@ components: type: object x-openstack: action-name: os-reset_status - Share_InstancesActionOs-Reset_StatusResponse: - description: Response of the - share_instances/id/action:post:os-reset_status action - type: object - x-openstack: - action-name: os-reset_status Share_InstancesActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -6877,13 +6497,73 @@ components: type: object x-openstack: action-name: reset_status - Share_InstancesActionReset_StatusResponse: - description: Response of the share_instances/id/action:post:reset_status - action + Share_InstancesExport_LocationShowResponse_214: + additionalProperties: false + properties: + export_location: + additionalProperties: false + description: "The export location. For newer API versions it is available + in\nseparate APIs. See sections `Share export locations\n<#share-share-export-locations>`_ + and `Share instance export\nlocations <#share-share-instance-export-locations>`_.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + readonly: true + type: string + id: + description: "The share export location UUID.\n" + readonly: true + type: string + is_admin_only: + description: "Defines purpose of an export location. If set to\n``true``, + then it is expected to be used for service needs and by\nadministrators + only. If it is set to ``false``, then this export\nlocation can be + used by end users. This parameter is only available to\nusers with + an \"administrator\" role, and cannot be controlled via policy\n.json.\n" + type: boolean + path: + description: "The export location path that should be used for mount + operation.\n" + type: string + preferred: + description: "Drivers may use this field to identify which export locations\n\ + are most efficient and should be used preferentially by clients.\n\ + By default it is set to ``false`` value.\n" + type: boolean + share_instance_id: + description: "The UUID of the share instance that this\nexport location + belongs to. This parameter is only available to users\nwith an \"\ + administrator\" role, and cannot be controlled via policy.yaml.\n" + type: string + updated_at: + description: "The date and time stamp when the resource was last updated + within the\nservice's database. If a resource was never updated after + it was\ncreated, the value of this parameter is set to ``null``.\n\ + \nThe date and time stamp format is `ISO 8601\n`_:\n\ + \n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n" + format: date-time + readonly: true + type: string + required: + - created_at + - id + - path + - preferred + - updated_at + type: object + required: + - export_location type: object x-openstack: - action-name: reset_status - Share_InstancesExport_LocationShowResponse: + max-ver: '2.86' + min-ver: '2.14' + Share_InstancesExport_LocationShowResponse_287: additionalProperties: false properties: export_location: @@ -6953,7 +6633,113 @@ components: required: - export_location type: object - Share_InstancesExport_LocationsListResponse: + x-openstack: + min-ver: '2.87' + Share_InstancesExport_LocationShowResponse_29: + additionalProperties: false + properties: + export_location: + additionalProperties: false + description: "The export location. For newer API versions it is available + in\nseparate APIs. See sections `Share export locations\n<#share-share-export-locations>`_ + and `Share instance export\nlocations <#share-share-instance-export-locations>`_.\n" + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + format: date-time + readonly: true + type: string + id: + description: "The share export location UUID.\n" + readonly: true + type: string + is_admin_only: + description: "Defines purpose of an export location. If set to\n``true``, + then it is expected to be used for service needs and by\nadministrators + only. If it is set to ``false``, then this export\nlocation can be + used by end users. This parameter is only available to\nusers with + an \"administrator\" role, and cannot be controlled via policy\n.json.\n" + type: boolean + path: + description: "The export location path that should be used for mount + operation.\n" + type: string + share_instance_id: + description: "The UUID of the share instance that this\nexport location + belongs to. This parameter is only available to users\nwith an \"\ + administrator\" role, and cannot be controlled via policy.yaml.\n" + type: string + updated_at: + description: "The date and time stamp when the resource was last updated + within the\nservice's database. If a resource was never updated after + it was\ncreated, the value of this parameter is set to ``null``.\n\ + \nThe date and time stamp format is `ISO 8601\n`_:\n\ + \n::\n\n CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2016-12-31T13:14:15-05:00``.\n" + format: date-time + readonly: true + type: string + required: + - created_at + - id + - path + - updated_at + type: object + required: + - export_location + type: object + x-openstack: + max-ver: '2.13' + min-ver: '2.9' + Share_InstancesExport_LocationsIndexResponse_214: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + description: "The share export location UUID.\n" + type: string + is_admin_only: + description: "Defines purpose of an export location. If set to\n``true``, + then it is expected to be used for service needs and by\nadministrators + only. If it is set to ``false``, then this export\nlocation can + be used by end users. This parameter is only available to\nusers + with an \"administrator\" role, and cannot be controlled via policy\n\ + .json.\n" + type: boolean + path: + description: "The export location path that should be used for mount + operation.\n" + type: string + preferred: + description: "Drivers may use this field to identify which export + locations\nare most efficient and should be used preferentially + by clients.\nBy default it is set to ``false`` value.\n" + type: boolean + share_instance_id: + description: "The UUID of the share instance that this\nexport location + belongs to. This parameter is only available to users\nwith an \"\ + administrator\" role, and cannot be controlled via policy.yaml.\n" + type: string + required: + - id + - path + - preferred + type: object + type: array + required: + - export_locations + type: object + x-openstack: + max-ver: '2.86' + min-ver: '2.14' + Share_InstancesExport_LocationsIndexResponse_287: additionalProperties: false properties: export_locations: @@ -7001,20 +6787,51 @@ components: required: - export_locations type: object - Share_InstancesListResponse: - description: Response of the share_instances:get operation - type: object - Share_NetworkShowResponse: - description: Response of the share-networks/id:get operation + x-openstack: + min-ver: '2.87' + Share_InstancesExport_LocationsIndexResponse_29: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + description: "The share export location UUID.\n" + type: string + is_admin_only: + description: "Defines purpose of an export location. If set to\n``true``, + then it is expected to be used for service needs and by\nadministrators + only. If it is set to ``false``, then this export\nlocation can + be used by end users. This parameter is only available to\nusers + with an \"administrator\" role, and cannot be controlled via policy\n\ + .json.\n" + type: boolean + path: + description: "The export location path that should be used for mount + operation.\n" + type: string + share_instance_id: + description: "The UUID of the share instance that this\nexport location + belongs to. This parameter is only available to users\nwith an \"\ + administrator\" role, and cannot be controlled via policy.yaml.\n" + type: string + required: + - id + - path + type: object + type: array + required: + - export_locations type: object + x-openstack: + max-ver: '2.13' + min-ver: '2.9' Share_NetworkUpdateRequest: description: Request of the share-networks/id:put operation type: object x-openstack: action-name: update - Share_NetworkUpdateResponse: - description: Response of the share-networks/id:put operation - type: object Share_NetworksActionAdd_Security_ServiceRequest: description: Empty body for add_security_service action properties: @@ -7023,12 +6840,6 @@ components: type: object x-openstack: action-name: add_security_service - Share_NetworksActionAdd_Security_ServiceResponse: - description: Response of the - share-networks/id/action:post:add_security_service action - type: object - x-openstack: - action-name: add_security_service Share_NetworksActionAdd_Security_Service_CheckRequest: description: Empty body for add_security_service_check action properties: @@ -7037,12 +6848,6 @@ components: type: object x-openstack: action-name: add_security_service_check - Share_NetworksActionAdd_Security_Service_CheckResponse: - description: Response of the - share-networks/id/action:post:add_security_service_check action - type: object - x-openstack: - action-name: add_security_service_check Share_NetworksActionRemove_Security_ServiceRequest: description: Empty body for remove_security_service action properties: @@ -7051,12 +6856,6 @@ components: type: object x-openstack: action-name: remove_security_service - Share_NetworksActionRemove_Security_ServiceResponse: - description: Response of the - share-networks/id/action:post:remove_security_service action - type: object - x-openstack: - action-name: remove_security_service Share_NetworksActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -7065,12 +6864,6 @@ components: type: object x-openstack: action-name: reset_status - Share_NetworksActionReset_StatusResponse: - description: Response of the share-networks/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_NetworksActionShare_Network_Subnet_Create_CheckRequest: description: Empty body for share_network_subnet_create_check action properties: @@ -7079,12 +6872,6 @@ components: type: object x-openstack: action-name: share_network_subnet_create_check - Share_NetworksActionShare_Network_Subnet_Create_CheckResponse: - description: Response of the - share-networks/id/action:post:share_network_subnet_create_check action - type: object - x-openstack: - action-name: share_network_subnet_create_check Share_NetworksActionUpdate_Security_ServiceRequest: description: Empty body for update_security_service action properties: @@ -7093,12 +6880,6 @@ components: type: object x-openstack: action-name: update_security_service - Share_NetworksActionUpdate_Security_ServiceResponse: - description: Response of the - share-networks/id/action:post:update_security_service action - type: object - x-openstack: - action-name: update_security_service Share_NetworksActionUpdate_Security_Service_CheckRequest: description: Empty body for update_security_service_check action properties: @@ -7107,45 +6888,17 @@ components: type: object x-openstack: action-name: update_security_service_check - Share_NetworksActionUpdate_Security_Service_CheckResponse: - description: Response of the - share-networks/id/action:post:update_security_service_check action - type: object - x-openstack: - action-name: update_security_service_check Share_NetworksCreateRequest: description: Request of the share-networks:post operation type: object x-openstack: action-name: create - Share_NetworksCreateResponse: - description: Response of the share-networks:post operation - type: object - Share_NetworksDetailResponse: - description: Response of the share-networks/detail:get operation - type: object - Share_NetworksListResponse: - description: Response of the share-networks:get operation - type: object - Share_NetworksSubnetShowResponse: - description: Response of the - share-networks/share_network_id/subnets/share_network_subnet_id:get - operation - type: object Share_NetworksSubnetsCreateRequest: description: Request of the share-networks/share_network_id/subnets:post operation type: object x-openstack: action-name: create - Share_NetworksSubnetsCreateResponse: - description: Response of the share-networks/share_network_id/subnets:post - operation - type: object - Share_NetworksSubnetsListResponse: - description: Response of the share-networks/share_network_id/subnets:get - operation - type: object Share_NetworksSubnetsMetadataCreate_MetadataRequest: description: Request of the share-networks/share_network_id/subnets/resource_id/metadata:post @@ -7153,21 +6906,6 @@ components: type: object x-openstack: action-name: create_metadata - Share_NetworksSubnetsMetadataCreate_MetadataResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata:post - operation - type: object - Share_NetworksSubnetsMetadataList_MetadataResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata:get - operation - type: object - Share_NetworksSubnetsMetadataShow_MetadataResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata/key:get - operation - type: object Share_NetworksSubnetsMetadataUpdate_All_MetadataRequest: description: Request of the share-networks/share_network_id/subnets/resource_id/metadata:put @@ -7175,11 +6913,6 @@ components: type: object x-openstack: action-name: update_all_metadata - Share_NetworksSubnetsMetadataUpdate_All_MetadataResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata:put - operation - type: object Share_NetworksSubnetsMetadataUpdate_Metadata_ItemRequest: description: Request of the share-networks/share_network_id/subnets/resource_id/metadata/key:post @@ -7187,14 +6920,6 @@ components: type: object x-openstack: action-name: update_metadata_item - Share_NetworksSubnetsMetadataUpdate_Metadata_ItemResponse: - description: Response of the - share-networks/share_network_id/subnets/resource_id/metadata/key:post - operation - type: object - Share_ReplicaShowResponse: - description: Response of the share-replicas/id:get operation - type: object Share_ReplicasActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -7203,12 +6928,6 @@ components: type: object x-openstack: action-name: force_delete - Share_ReplicasActionForce_DeleteResponse: - description: Response of the share-replicas/id/action:post:force_delete - action - type: object - x-openstack: - action-name: force_delete Share_ReplicasActionPromoteRequest: description: Empty body for promote action properties: @@ -7217,11 +6936,6 @@ components: type: object x-openstack: action-name: promote - Share_ReplicasActionPromoteResponse: - description: Response of the share-replicas/id/action:post:promote action - type: object - x-openstack: - action-name: promote Share_ReplicasActionReset_Replica_StateRequest: description: Empty body for reset_replica_state action properties: @@ -7230,12 +6944,6 @@ components: type: object x-openstack: action-name: reset_replica_state - Share_ReplicasActionReset_Replica_StateResponse: - description: Response of the - share-replicas/id/action:post:reset_replica_state action - type: object - x-openstack: - action-name: reset_replica_state Share_ReplicasActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -7244,12 +6952,6 @@ components: type: object x-openstack: action-name: reset_status - Share_ReplicasActionReset_StatusResponse: - description: Response of the share-replicas/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_ReplicasActionResyncRequest: description: Empty body for resync action properties: @@ -7258,75 +6960,29 @@ components: type: object x-openstack: action-name: resync - Share_ReplicasActionResyncResponse: - description: Response of the share-replicas/id/action:post:resync action - type: object - x-openstack: - action-name: resync Share_ReplicasCreateRequest: description: Request of the share-replicas:post operation type: object x-openstack: action-name: create - Share_ReplicasCreateResponse: - description: Response of the share-replicas:post operation - type: object - Share_ReplicasDetailResponse: - description: Response of the share-replicas/detail:get operation - type: object - Share_ReplicasExport_LocationShowResponse: - description: Response of the - share-replicas/share_replica_id/export-locations/export_location_uuid:get - operation - type: object - Share_ReplicasExport_LocationsListResponse: - description: Response of the - share-replicas/share_replica_id/export-locations:get operation - type: object - Share_ReplicasListResponse: - description: Response of the share-replicas:get operation - type: object Share_ReplicasMetadataCreate_MetadataRequest: description: Request of the share-replicas/resource_id/metadata:post operation type: object x-openstack: action-name: create_metadata - Share_ReplicasMetadataCreate_MetadataResponse: - description: Response of the share-replicas/resource_id/metadata:post - operation - type: object - Share_ReplicasMetadataList_MetadataResponse: - description: Response of the share-replicas/resource_id/metadata:get - operation - type: object - Share_ReplicasMetadataShow_MetadataResponse: - description: Response of the share-replicas/resource_id/metadata/key:get - operation - type: object Share_ReplicasMetadataUpdate_All_MetadataRequest: description: Request of the share-replicas/resource_id/metadata:put operation type: object x-openstack: action-name: update_all_metadata - Share_ReplicasMetadataUpdate_All_MetadataResponse: - description: Response of the share-replicas/resource_id/metadata:put - operation - type: object Share_ReplicasMetadataUpdate_Metadata_ItemRequest: description: Request of the share-replicas/resource_id/metadata/key:post operation type: object x-openstack: action-name: update_metadata_item - Share_ReplicasMetadataUpdate_Metadata_ItemResponse: - description: Response of the share-replicas/resource_id/metadata/key:post - operation - type: object - Share_ServerShowResponse: - description: Response of the share-servers/id:get operation - type: object Share_ServersActionMigration_CancelRequest: description: Empty body for migration_cancel action properties: @@ -7335,12 +6991,6 @@ components: type: object x-openstack: action-name: migration_cancel - Share_ServersActionMigration_CancelResponse: - description: Response of the share-servers/id/action:post:migration_cancel - action - type: object - x-openstack: - action-name: migration_cancel Share_ServersActionMigration_CheckRequest: description: Empty body for migration_check action properties: @@ -7349,12 +6999,6 @@ components: type: object x-openstack: action-name: migration_check - Share_ServersActionMigration_CheckResponse: - description: Response of the share-servers/id/action:post:migration_check - action - type: object - x-openstack: - action-name: migration_check Share_ServersActionMigration_CompleteRequest: description: Empty body for migration_complete action properties: @@ -7363,12 +7007,6 @@ components: type: object x-openstack: action-name: migration_complete - Share_ServersActionMigration_CompleteResponse: - description: Response of the - share-servers/id/action:post:migration_complete action - type: object - x-openstack: - action-name: migration_complete Share_ServersActionMigration_Get_ProgressRequest: description: Empty body for migration_get_progress action properties: @@ -7377,12 +7015,6 @@ components: type: object x-openstack: action-name: migration_get_progress - Share_ServersActionMigration_Get_ProgressResponse: - description: Response of the - share-servers/id/action:post:migration_get_progress action - type: object - x-openstack: - action-name: migration_get_progress Share_ServersActionMigration_StartRequest: description: Empty body for migration_start action properties: @@ -7391,12 +7023,6 @@ components: type: object x-openstack: action-name: migration_start - Share_ServersActionMigration_StartResponse: - description: Response of the share-servers/id/action:post:migration_start - action - type: object - x-openstack: - action-name: migration_start Share_ServersActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -7405,12 +7031,6 @@ components: type: object x-openstack: action-name: reset_status - Share_ServersActionReset_StatusResponse: - description: Response of the share-servers/id/action:post:reset_status - action - type: object - x-openstack: - action-name: reset_status Share_ServersActionReset_Task_StateRequest: description: Empty body for reset_task_state action properties: @@ -7419,12 +7039,6 @@ components: type: object x-openstack: action-name: reset_task_state - Share_ServersActionReset_Task_StateResponse: - description: Response of the share-servers/id/action:post:reset_task_state - action - type: object - x-openstack: - action-name: reset_task_state Share_ServersActionUnmanageRequest: description: Empty body for unmanage action properties: @@ -7433,50 +7047,21 @@ components: type: object x-openstack: action-name: unmanage - Share_ServersActionUnmanageResponse: - description: Response of the share-servers/id/action:post:unmanage action - type: object - x-openstack: - action-name: unmanage - Share_ServersDetailsResponse: - description: Response of the share-servers/id/details:get operation - type: object - Share_ServersListResponse: - description: Response of the share-servers:get operation - type: object Share_ServersManageManageRequest: description: Request of the share-servers/manage:post operation type: object x-openstack: action-name: manage - Share_ServersManageResponse: - description: Response of the share-servers/manage:post operation - type: object - Share_TransferShowResponse: - description: Response of the share-transfers/id:get operation - type: object Share_TransfersAcceptAcceptRequest: description: Request of the share-transfers/id/accept:post operation type: object x-openstack: action-name: accept - Share_TransfersAcceptResponse: - description: Response of the share-transfers/id/accept:post operation - type: object Share_TransfersCreateRequest: description: Request of the share-transfers:post operation type: object x-openstack: action-name: create - Share_TransfersCreateResponse: - description: Response of the share-transfers:post operation - type: object - Share_TransfersDetailResponse: - description: Response of the share-transfers/detail:get operation - type: object - Share_TransfersListResponse: - description: Response of the share-transfers:get operation - type: object SharesActionAccess_ListRequest: description: Empty body for access_list action properties: @@ -7485,11 +7070,6 @@ components: type: object x-openstack: action-name: access_list - SharesActionAccess_ListResponse: - description: Response of the shares/id/action:post:access_list action - type: object - x-openstack: - action-name: access_list SharesActionAllow_AccessRequest: description: Empty body for allow_access action properties: @@ -7498,11 +7078,6 @@ components: type: object x-openstack: action-name: allow_access - SharesActionAllow_AccessResponse: - description: Response of the shares/id/action:post:allow_access action - type: object - x-openstack: - action-name: allow_access SharesActionDeny_AccessRequest: description: Empty body for deny_access action properties: @@ -7511,11 +7086,6 @@ components: type: object x-openstack: action-name: deny_access - SharesActionDeny_AccessResponse: - description: Response of the shares/id/action:post:deny_access action - type: object - x-openstack: - action-name: deny_access SharesActionExtendRequest: oneOf: - $ref: '#/components/schemas/SharesActionExtend_264' @@ -7523,10 +7093,6 @@ components: x-openstack: action-name: extend discriminator: microversion - SharesActionExtendResponse: - type: 'null' - x-openstack: - action-name: extend SharesActionExtend_264: additionalProperties: false properties: @@ -7580,7 +7146,6 @@ components: type: object x-openstack: action-name: extend - max-ver: '2.63' min-ver: '2.64' SharesActionExtend_27: additionalProperties: false @@ -7630,14 +7195,6 @@ components: action-name: os-extend max-ver: '2.6' min-ver: '2.0' - SharesActionForce_DeleteResponse: - type: 'null' - x-openstack: - action-name: force_delete - SharesActionMigration_CancelResponse: - type: 'null' - x-openstack: - action-name: migration_cancel SharesActionMigration_Cancel_222: additionalProperties: false properties: @@ -7648,10 +7205,6 @@ components: x-openstack: action-name: migration_cancel min-ver: '2.22' - SharesActionMigration_CompleteResponse: - type: 'null' - x-openstack: - action-name: migration_complete SharesActionMigration_Complete_222: additionalProperties: false properties: @@ -7662,7 +7215,23 @@ components: x-openstack: action-name: migration_complete min-ver: '2.22' - SharesActionMigration_Get_ProgressResponse: + SharesActionMigration_Get_ProgressResponse_222: + additionalProperties: false + properties: + task_state: {} + total_progress: + max: 100 + min: 0 + type: integer + required: + - task_state + - total_progress + type: object + x-openstack: + action-name: migration_get_progress + max-ver: '2.58' + min-ver: '2.22' + SharesActionMigration_Get_ProgressResponse_259: additionalProperties: false properties: details: {} @@ -7678,6 +7247,7 @@ components: type: object x-openstack: action-name: migration_get_progress + min-ver: '2.59' SharesActionMigration_Get_Progress_222: additionalProperties: false properties: @@ -7688,10 +7258,6 @@ components: x-openstack: action-name: migration_get_progress min-ver: '2.22' - SharesActionMigration_StartResponse: - type: 'null' - x-openstack: - action-name: migration_start SharesActionMigration_Start_229: additionalProperties: false properties: @@ -7884,11 +7450,6 @@ components: type: object x-openstack: action-name: os-access_list - SharesActionOs-Access_ListResponse: - description: Response of the shares/id/action:post:os-access_list action - type: object - x-openstack: - action-name: os-access_list SharesActionOs-Allow_AccessRequest: description: Empty body for os-allow_access action properties: @@ -7897,11 +7458,6 @@ components: type: object x-openstack: action-name: os-allow_access - SharesActionOs-Allow_AccessResponse: - description: Response of the shares/id/action:post:os-allow_access action - type: object - x-openstack: - action-name: os-allow_access SharesActionOs-Deny_AccessRequest: description: Empty body for os-deny_access action properties: @@ -7910,35 +7466,6 @@ components: type: object x-openstack: action-name: os-deny_access - SharesActionOs-Deny_AccessResponse: - description: Response of the shares/id/action:post:os-deny_access action - type: object - x-openstack: - action-name: os-deny_access - SharesActionOs-ExtendResponse: - type: 'null' - x-openstack: - action-name: os-extend - SharesActionOs-Force_DeleteResponse: - type: 'null' - x-openstack: - action-name: os-force_delete - SharesActionOs-Reset_StatusResponse: - type: 'null' - x-openstack: - action-name: os-reset_status - SharesActionOs-ShrinkResponse: - type: 'null' - x-openstack: - action-name: os-shrink - SharesActionReset_StatusResponse: - type: 'null' - x-openstack: - action-name: reset_status - SharesActionReset_Task_StateResponse: - type: 'null' - x-openstack: - action-name: reset_task_state SharesActionReset_Task_State_222: additionalProperties: false properties: @@ -7993,14 +7520,6 @@ components: x-openstack: action-name: reset_task_state min-ver: '2.22' - SharesActionRestoreResponse: - type: 'null' - x-openstack: - action-name: restore - SharesActionRevertResponse: - type: 'null' - x-openstack: - action-name: revert SharesActionRevert_227: additionalProperties: false properties: @@ -8234,10 +7753,6 @@ components: x-openstack: action-name: soft_delete min-ver: '2.69' - SharesActionShrinkResponse: - type: 'null' - x-openstack: - action-name: shrink SharesActionShrink_27: additionalProperties: false properties: @@ -8285,14 +7800,6 @@ components: action-name: os-shrink max-ver: '2.6' min-ver: '2.0' - SharesActionSoft_DeleteResponse: - type: 'null' - x-openstack: - action-name: soft_delete - SharesActionUnmanageResponse: - type: 'null' - x-openstack: - action-name: unmanage SharesActionUnmanage_27: additionalProperties: false properties: @@ -8308,13 +7815,114 @@ components: type: object x-openstack: action-name: create - SharesCreateResponse: - description: Response of the shares:post operation + SharesExport_LocationShowResponse_214: + additionalProperties: false + properties: + export_location: + additionalProperties: false + properties: + created_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: created_at + id: + readonly: true + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + preferred: + type: boolean + x-openstack: + apiref: export_location_preferred + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + updated_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: updated_at + required: + - created_at + - id + - path + - preferred + - updated_at + type: object + x-openstack: + apiref: export_location + required: + - export_location type: object - SharesDetailResponse: - description: Response of the shares/detail:get operation + x-openstack: + max-ver: '2.86' + min-ver: '2.14' + SharesExport_LocationShowResponse_247: + additionalProperties: false + properties: + export_location: + additionalProperties: false + properties: + created_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: created_at + id: + readonly: true + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + preferred: + type: boolean + x-openstack: + apiref: export_location_preferred + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + updated_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: updated_at + required: + - created_at + - id + - path + - preferred + - updated_at + type: object + x-openstack: + apiref: export_location + required: + - export_location type: object - SharesExport_LocationShowResponse: + x-openstack: + min-ver: '2.47' + SharesExport_LocationShowResponse_287: additionalProperties: false properties: export_location: @@ -8335,6 +7943,14 @@ components: type: boolean x-openstack: apiref: export_location_is_admin_only + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object path: type: string x-openstack: @@ -8356,6 +7972,7 @@ components: required: - created_at - id + - metadata - path - preferred - updated_at @@ -8363,9 +7980,139 @@ components: x-openstack: apiref: export_location required: - - export_location + - export_location + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationShowResponse_29: + additionalProperties: false + properties: + export_location: + additionalProperties: false + properties: + created_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: created_at + id: + readonly: true + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + updated_at: + format: date-time + readonly: true + type: string + x-openstack: + apiref: updated_at + required: + - created_at + - id + - path + - updated_at + type: object + x-openstack: + apiref: export_location + required: + - export_location + type: object + x-openstack: + max-ver: '2.13' + min-ver: '2.9' + SharesExport_LocationsIndexResponse_214: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + preferred: + type: boolean + x-openstack: + apiref: export_location_preferred + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + required: + - id + - path + - preferred + type: object + type: array + required: + - export_locations + type: object + x-openstack: + apiref: export_locations + max-ver: '2.86' + min-ver: '2.14' + SharesExport_LocationsIndexResponse_247: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + preferred: + type: boolean + x-openstack: + apiref: export_location_preferred + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + required: + - id + - path + - preferred + type: object + type: array + required: + - export_locations type: object - SharesExport_LocationsListResponse: + x-openstack: + apiref: export_locations + min-ver: '2.47' + SharesExport_LocationsIndexResponse_287: additionalProperties: false properties: export_locations: @@ -8380,6 +8127,11 @@ components: type: boolean x-openstack: apiref: export_location_is_admin_only + metadata: + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: object path: type: string x-openstack: @@ -8394,6 +8146,7 @@ components: apiref: share_instance_id required: - id + - metadata - path - preferred type: object @@ -8403,7 +8156,43 @@ components: type: object x-openstack: apiref: export_locations - SharesExport_LocationsMetadataCreate_MetadataResponse: + min-ver: '2.87' + SharesExport_LocationsIndexResponse_29: + additionalProperties: false + properties: + export_locations: + items: + additionalProperties: false + properties: + id: + type: string + x-openstack: + apiref: export_location_id + is_admin_only: + type: boolean + x-openstack: + apiref: export_location_is_admin_only + path: + type: string + x-openstack: + apiref: export_location_path + share_instance_id: + type: string + x-openstack: + apiref: share_instance_id + required: + - id + - path + type: object + type: array + required: + - export_locations + type: object + x-openstack: + apiref: export_locations + max-ver: '2.13' + min-ver: '2.9' + SharesExport_LocationsMetadataCreate_MetadataResponse_287: additionalProperties: false properties: metadata: @@ -8417,6 +8206,8 @@ components: required: - metadata type: object + x-openstack: + min-ver: '2.87' SharesExport_LocationsMetadataCreate_Metadata_287: additionalProperties: false properties: @@ -8433,7 +8224,7 @@ components: type: object x-openstack: min-ver: '2.87' - SharesExport_LocationsMetadataList_MetadataResponse: + SharesExport_LocationsMetadataIndex_MetadataResponse_287: additionalProperties: false properties: meta: @@ -8447,7 +8238,9 @@ components: required: - meta type: object - SharesExport_LocationsMetadataShow_MetadataResponse: + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataShow_MetadataResponse_287: additionalProperties: false properties: meta: @@ -8459,114 +8252,374 @@ components: - 'null' - object required: - - meta + - meta + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataUpdate_All_MetadataResponse_287: + additionalProperties: false + properties: + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object + required: + - metadata + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataUpdate_All_Metadata_287: + additionalProperties: true + properties: + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object + required: + - metadata + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse_287: + additionalProperties: false + properties: + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object + required: + - metadata + type: object + x-openstack: + min-ver: '2.87' + SharesExport_LocationsMetadataUpdate_Metadata_Item_287: + additionalProperties: true + properties: + metadata: + additionalProperties: false + patternProperties: + ^[a-zA-Z0-9-_:. ]{1,255}$: + type: string + type: + - 'null' + - object + required: + - metadata + type: object + x-openstack: + min-ver: '2.87' + SharesManageManageRequest: + description: Request of the shares/manage:post operation + type: object + x-openstack: + action-name: manage + SharesMetadataCreate_MetadataRequest: + description: Request of the shares/resource_id/metadata:post operation + type: object + x-openstack: + action-name: create_metadata + SharesMetadataUpdate_All_MetadataRequest: + description: Request of the shares/resource_id/metadata:put operation + type: object + x-openstack: + action-name: update_all_metadata + SharesMetadataUpdate_Metadata_ItemRequest: + description: Request of the shares/resource_id/metadata/key:post operation + type: object + x-openstack: + action-name: update_metadata_item + SnapshotShowResponse_20: + additionalProperties: false + properties: + snapshot: + additionalProperties: false + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" + type: string + description: + description: "The user defined description of the resource.\n" + type: + - 'null' + - string + id: + description: "The UUID of the snapshot.\n" + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: "The user defined name of the resource.\n" + type: + - 'null' + - string + share_id: + description: "The UUID of the source share that was used to\ncreate + the snapshot.\n" + type: string + share_proto: + description: "The file system protocol of a share snapshot. A\nvalid + value is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``,\n``CephFS`` or + ``MAPRFS``. ``CephFS`` is supported starting\nwith API v2.13.\n" + type: string + share_size: + description: "The share snapshot size, in GiBs.\n" + type: + - integer + - 'null' + size: + description: "The snapshot size, in GiBs.\n" + type: + - integer + - 'null' + status: + description: "The snapshot status, which can be ``available``,\n``error``, + ``creating``, ``deleting``, ``manage_starting``,\n``manage_error``, + ``unmanage_starting``, ``unmanage_error`` or\n``error_deleting``.\n" + type: string + required: + - created_at + - description + - id + - links + - name + - share_id + - share_proto + - share_size + - size + - status + type: object + required: + - snapshot type: object - SharesExport_LocationsMetadataUpdate_All_MetadataResponse: + x-openstack: + max-ver: '2.11' + min-ver: '2.0' + SnapshotShowResponse_212: additionalProperties: false properties: - metadata: + snapshot: additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" type: string - type: - - 'null' - - object - required: - - metadata - type: object - SharesExport_LocationsMetadataUpdate_All_Metadata_287: - additionalProperties: true - properties: - metadata: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + description: + description: "The user defined description of the resource.\n" + type: + - 'null' + - string + id: + description: "The UUID of the snapshot.\n" + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: "The user defined name of the resource.\n" + type: + - 'null' + - string + provider_location: + description: "Provider location of the snapshot on the backend.\n" + type: + - 'null' + - string + share_id: + description: "The UUID of the source share that was used to\ncreate + the snapshot.\n" type: string - type: - - 'null' - - object + share_proto: + description: "The file system protocol of a share snapshot. A\nvalid + value is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``,\n``CephFS`` or + ``MAPRFS``. ``CephFS`` is supported starting\nwith API v2.13.\n" + type: string + share_size: + description: "The share snapshot size, in GiBs.\n" + type: + - integer + - 'null' + size: + description: "The snapshot size, in GiBs.\n" + type: + - integer + - 'null' + status: + description: "The snapshot status, which can be ``available``,\n``error``, + ``creating``, ``deleting``, ``manage_starting``,\n``manage_error``, + ``unmanage_starting``, ``unmanage_error`` or\n``error_deleting``.\n" + type: string + required: + - created_at + - description + - id + - links + - name + - share_id + - share_proto + - share_size + - size + - status + type: object required: - - metadata + - snapshot type: object x-openstack: - min-ver: '2.87' - SharesExport_LocationsMetadataUpdate_Metadata_ItemResponse: + max-ver: '2.16' + min-ver: '2.12' + SnapshotShowResponse_217: additionalProperties: false properties: - metadata: + snapshot: additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + properties: + created_at: + description: "The date and time stamp when the resource was created + within the service's\ndatabase.\n\nThe date and time stamp format + is `ISO 8601\n`_:\n\n::\n\n\ + \ CCYY-MM-DDThh:mm:ss±hh:mm\n\nThe ``±hh:mm`` value, if included, + returns the time zone as an\noffset from UTC.\n\nFor example, ``2019-03-27T09:49:58-05:00``.\n" type: string - type: - - 'null' - - object - required: - - metadata - type: object - SharesExport_LocationsMetadataUpdate_Metadata_Item_287: - additionalProperties: true - properties: - metadata: - additionalProperties: false - patternProperties: - ^[a-zA-Z0-9-_:. ]{1,255}$: + description: + description: "The user defined description of the resource.\n" + type: + - 'null' + - string + id: + description: "The UUID of the snapshot.\n" + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: "The user defined name of the resource.\n" + type: + - 'null' + - string + project_id: + description: "ID of the project that the snapshot belongs to.\n" type: string - type: - - 'null' - - object + provider_location: + description: "Provider location of the snapshot on the backend.\n" + type: + - 'null' + - string + share_id: + description: "The UUID of the source share that was used to\ncreate + the snapshot.\n" + type: string + share_proto: + description: "The file system protocol of a share snapshot. A\nvalid + value is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``,\n``CephFS`` or + ``MAPRFS``. ``CephFS`` is supported starting\nwith API v2.13.\n" + type: string + share_size: + description: "The share snapshot size, in GiBs.\n" + type: + - integer + - 'null' + size: + description: "The snapshot size, in GiBs.\n" + type: + - integer + - 'null' + status: + description: "The snapshot status, which can be ``available``,\n``error``, + ``creating``, ``deleting``, ``manage_starting``,\n``manage_error``, + ``unmanage_starting``, ``unmanage_error`` or\n``error_deleting``.\n" + type: string + user_id: + description: "ID of the user that the snapshot was created by.\n" + type: string + required: + - created_at + - description + - id + - links + - name + - project_id + - share_id + - share_proto + - share_size + - size + - status + - user_id + type: object required: - - metadata - type: object - x-openstack: - min-ver: '2.87' - SharesInstancesGet_Share_InstancesResponse: - description: Response of the shares/share_id/instances:get operation - type: object - SharesListResponse: - description: Response of the shares:get operation - type: object - SharesManageManageRequest: - description: Request of the shares/manage:post operation - type: object - x-openstack: - action-name: manage - SharesManageResponse: - description: Response of the shares/manage:post operation - type: object - SharesMetadataCreate_MetadataRequest: - description: Request of the shares/resource_id/metadata:post operation - type: object - x-openstack: - action-name: create_metadata - SharesMetadataCreate_MetadataResponse: - description: Response of the shares/resource_id/metadata:post operation - type: object - SharesMetadataList_MetadataResponse: - description: Response of the shares/resource_id/metadata:get operation - type: object - SharesMetadataShow_MetadataResponse: - description: Response of the shares/resource_id/metadata/key:get operation - type: object - SharesMetadataUpdate_All_MetadataRequest: - description: Request of the shares/resource_id/metadata:put operation - type: object - x-openstack: - action-name: update_all_metadata - SharesMetadataUpdate_All_MetadataResponse: - description: Response of the shares/resource_id/metadata:put operation - type: object - SharesMetadataUpdate_Metadata_ItemRequest: - description: Request of the shares/resource_id/metadata/key:post operation + - snapshot type: object x-openstack: - action-name: update_metadata_item - SharesMetadataUpdate_Metadata_ItemResponse: - description: Response of the shares/resource_id/metadata/key:post - operation - type: object - SnapshotShowResponse: + max-ver: '2.72' + min-ver: '2.17' + SnapshotShowResponse_273: additionalProperties: false properties: snapshot: @@ -8669,17 +8722,13 @@ components: required: - snapshot type: object + x-openstack: + min-ver: '2.73' SnapshotUpdateRequest: description: Request of the snapshots/id:put operation type: object x-openstack: action-name: update - SnapshotUpdateResponse: - description: Response of the snapshots/id:put operation - type: object - Snapshot_InstanceShowResponse: - description: Response of the snapshot-instances/id:get operation - type: object Snapshot_InstancesActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -8688,31 +8737,6 @@ components: type: object x-openstack: action-name: reset_status - Snapshot_InstancesActionReset_StatusResponse: - description: Response of the - snapshot-instances/id/action:post:reset_status action - type: object - x-openstack: - action-name: reset_status - Snapshot_InstancesDetailResponse: - description: Response of the snapshot-instances/detail:get operation - type: object - Snapshot_InstancesExport_LocationShowResponse: - description: Response of the - snapshot-instances/snapshot_instance_id/export-locations/export_location_id:get - operation - type: object - Snapshot_InstancesExport_LocationsListResponse: - description: Response of the - snapshot-instances/snapshot_instance_id/export-locations:get operation - type: object - Snapshot_InstancesListResponse: - description: Response of the snapshot-instances:get operation - type: object - SnapshotsAccess_ListResponse: - description: Response of the snapshots/snapshot_id/access-list:get - operation - type: object SnapshotsActionAllow_AccessRequest: description: Empty body for allow_access action properties: @@ -8721,11 +8745,6 @@ components: type: object x-openstack: action-name: allow_access - SnapshotsActionAllow_AccessResponse: - description: Response of the snapshots/id/action:post:allow_access action - type: object - x-openstack: - action-name: allow_access SnapshotsActionDeny_AccessRequest: description: Empty body for deny_access action properties: @@ -8734,11 +8753,6 @@ components: type: object x-openstack: action-name: deny_access - SnapshotsActionDeny_AccessResponse: - description: Response of the snapshots/id/action:post:deny_access action - type: object - x-openstack: - action-name: deny_access SnapshotsActionForce_DeleteRequest: description: Empty body for force_delete action properties: @@ -8747,11 +8761,6 @@ components: type: object x-openstack: action-name: force_delete - SnapshotsActionForce_DeleteResponse: - description: Response of the snapshots/id/action:post:force_delete action - type: object - x-openstack: - action-name: force_delete SnapshotsActionOs-Force_DeleteRequest: description: Empty body for os-force_delete action properties: @@ -8760,12 +8769,6 @@ components: type: object x-openstack: action-name: os-force_delete - SnapshotsActionOs-Force_DeleteResponse: - description: Response of the snapshots/id/action:post:os-force_delete - action - type: object - x-openstack: - action-name: os-force_delete SnapshotsActionOs-Reset_StatusRequest: description: Empty body for os-reset_status action properties: @@ -8774,12 +8777,6 @@ components: type: object x-openstack: action-name: os-reset_status - SnapshotsActionOs-Reset_StatusResponse: - description: Response of the snapshots/id/action:post:os-reset_status - action - type: object - x-openstack: - action-name: os-reset_status SnapshotsActionReset_StatusRequest: description: Empty body for reset_status action properties: @@ -8788,11 +8785,6 @@ components: type: object x-openstack: action-name: reset_status - SnapshotsActionReset_StatusResponse: - description: Response of the snapshots/id/action:post:reset_status action - type: object - x-openstack: - action-name: reset_status SnapshotsActionUnmanageRequest: description: Empty body for unmanage action properties: @@ -8801,31 +8793,207 @@ components: type: object x-openstack: action-name: unmanage - SnapshotsActionUnmanageResponse: - description: Response of the snapshots/id/action:post:unmanage action - type: object - x-openstack: - action-name: unmanage SnapshotsCreateRequest: description: Request of the snapshots:post operation type: object x-openstack: action-name: create - SnapshotsCreateResponse: - description: Response of the snapshots:post operation - type: object - SnapshotsDetailResponse: - description: Response of the snapshots/detail:get operation + SnapshotsIndexResponse_20: + additionalProperties: false + properties: + count: + minimum: 0 + type: integer + share_snapshots_links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + snapshots: + items: + additionalProperties: false + properties: + id: + description: The UUID of the snapshot. + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: The user-defined name of the snapshot. + type: + - 'null' + - string + required: + - id + - links + - name + type: object + type: array + required: + - snapshots type: object - SnapshotsExport_LocationShowResponse: - description: Response of the - snapshots/snapshot_id/export-locations/export_location_id:get operation + x-openstack: + max-ver: '2.35' + min-ver: '2.0' + SnapshotsIndexResponse_236: + additionalProperties: false + properties: + count: + minimum: 0 + type: integer + share_snapshots_links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + snapshots: + items: + additionalProperties: false + properties: + id: + description: The UUID of the snapshot. + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: The user-defined name of the snapshot. + type: + - 'null' + - string + required: + - id + - links + - name + type: object + type: array + required: + - snapshots type: object - SnapshotsExport_LocationsListResponse: - description: Response of the snapshots/snapshot_id/export-locations:get - operation + x-openstack: + max-ver: '2.72' + min-ver: '2.36' + SnapshotsIndexResponse_273: + additionalProperties: false + properties: + count: + minimum: 0 + type: integer + share_snapshots_links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + const: next + required: + - href + - rel + type: object + maxItems: 1 + minItems: 1 + type: array + snapshots: + items: + additionalProperties: false + properties: + id: + description: The UUID of the snapshot. + type: + - integer + - string + links: + items: + additionalProperties: false + properties: + href: + format: uri + type: string + rel: + enum: + - bookmark + - self + type: string + required: + - href + - rel + type: object + type: array + name: + description: The user-defined name of the snapshot. + type: + - 'null' + - string + required: + - id + - links + - name + type: object + type: array + required: + - snapshots type: object - SnapshotsListResponse: + x-openstack: + max-ver: '2.78' + min-ver: '2.73' + SnapshotsIndexResponse_279: additionalProperties: false properties: count: @@ -8887,60 +9055,34 @@ components: required: - snapshots type: object + x-openstack: + min-ver: '2.79' SnapshotsManageManageRequest: description: Request of the snapshots/manage:post operation type: object x-openstack: action-name: manage - SnapshotsManageResponse: - description: Response of the snapshots/manage:post operation - type: object SnapshotsMetadataCreate_MetadataRequest: description: Request of the snapshots/resource_id/metadata:post operation type: object x-openstack: action-name: create_metadata - SnapshotsMetadataCreate_MetadataResponse: - description: Response of the snapshots/resource_id/metadata:post operation - type: object - SnapshotsMetadataList_MetadataResponse: - description: Response of the snapshots/resource_id/metadata:get operation - type: object - SnapshotsMetadataShow_MetadataResponse: - description: Response of the snapshots/resource_id/metadata/key:get - operation - type: object SnapshotsMetadataUpdate_All_MetadataRequest: description: Request of the snapshots/resource_id/metadata:put operation type: object x-openstack: action-name: update_all_metadata - SnapshotsMetadataUpdate_All_MetadataResponse: - description: Response of the snapshots/resource_id/metadata:put operation - type: object SnapshotsMetadataUpdate_Metadata_ItemRequest: description: Request of the snapshots/resource_id/metadata/key:post operation type: object x-openstack: action-name: update_metadata_item - SnapshotsMetadataUpdate_Metadata_ItemResponse: - description: Response of the snapshots/resource_id/metadata/key:post - operation - type: object - TypeShowResponse: - description: Response of the types/id:get operation - type: object TypeUpdateRequest: description: Request of the types/id:put operation type: object x-openstack: action-name: update - TypeUpdateResponse: - description: Response of the types/id:put:update action - type: object - x-openstack: - action-name: update TypesActionAddprojectaccessRequest: description: Empty body for addProjectAccess action properties: @@ -8949,11 +9091,6 @@ components: type: object x-openstack: action-name: addProjectAccess - TypesActionAddprojectaccessResponse: - description: Response of the types/id/action:post:addProjectAccess action - type: object - x-openstack: - action-name: addProjectAccess TypesActionCreateRequest: description: Empty body for create action properties: @@ -8962,11 +9099,6 @@ components: type: object x-openstack: action-name: create - TypesActionCreateResponse: - description: Response of the types/id/action:post:create action - type: object - x-openstack: - action-name: create TypesActionDeleteRequest: description: Empty body for delete action properties: @@ -8975,11 +9107,6 @@ components: type: object x-openstack: action-name: delete - TypesActionDeleteResponse: - description: Response of the types/id/action:post:delete action - type: object - x-openstack: - action-name: delete TypesActionRemoveprojectaccessRequest: description: Empty body for removeProjectAccess action properties: @@ -8988,12 +9115,6 @@ components: type: object x-openstack: action-name: removeProjectAccess - TypesActionRemoveprojectaccessResponse: - description: Response of the types/id/action:post:removeProjectAccess - action - type: object - x-openstack: - action-name: removeProjectAccess TypesActionUpdateRequest: description: Empty body for update action properties: @@ -9002,55 +9123,21 @@ components: type: object x-openstack: action-name: update - TypesActionUpdateResponse: - description: Response of the types/id/action:post:update action - type: object - x-openstack: - action-name: update TypesCreateRequest: description: Request of the types:post operation type: object x-openstack: action-name: create - TypesCreateResponse: - description: Response of the types:post:create action - type: object - x-openstack: - action-name: create - TypesDefaultResponse: - description: Response of the types/default:get operation - type: object - TypesExtra_SpecShowResponse: - description: Response of the types/type_id/extra_specs/id:get operation - type: object TypesExtra_SpecUpdateRequest: description: Request of the types/type_id/extra_specs/id:put operation type: object x-openstack: action-name: update - TypesExtra_SpecUpdateResponse: - description: Response of the types/type_id/extra_specs/id:put operation - type: object TypesExtra_SpecsCreateRequest: description: Request of the types/type_id/extra_specs:post operation type: object x-openstack: action-name: create - TypesExtra_SpecsCreateResponse: - description: Response of the types/type_id/extra_specs:post operation - type: object - TypesExtra_SpecsListResponse: - description: Response of the types/type_id/extra_specs:get operation - type: object - TypesListResponse: - description: Response of the types:get operation - type: object - TypesOs_Share_Type_AccessOs-Share-Type-AccessResponse: - description: Response of the types/id/os-share-type-access:get operation - type: object - TypesShare_Type_AccessResponse: - description: Response of the types/id/share_type_access:get operation - type: object securitySchemes: ApiKeyAuth: in: header