summaryrefslogtreecommitdiff
path: root/api-ref/source/servers.inc
Commit message (Collapse)AuthorAgeFilesLines
* Microversion 2.94: FQDN in hostnameArtom Lifshitz2023-01-171-0/+5
| | | | | | | | | | | | | Extend microversion 2.90 to allow FQDNs in the hostname parameter. Multi-create with --hostname continues to be refused, returning error 400 to the user. This simplifies the code by not needing to handle any sort of suffix or prefix mangling of the FQDN to handle multiple instances. No other changes are made - not Neutron integration, metadata API changes (the FQDN will appear as-is in places where the hostname currently appears), etc. Change-Id: I47e397dc6da8263762479cc8ae4f8777a6d9d811 Implements: bp/fqdn-in-hostname
* Doc: Fix list servers detailed response paramPatrick Hampson2022-10-281-1/+1
| | | | Change-Id: If94895d0fc4b5a59febd02e127fbf93959084fee
* api: Add support for 'hostname' parameterStephen Finucane2021-01-141-23/+31
| | | | | | | | | Add microversion 2.90, which allows allows users to configure the hostname that will be exposed via the nova metadata service when creating their instance. Change-Id: I95047c1689ac14fa73eba48e19dc438988b78aad Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Non-Admin user can filter their instances by more filtersVictor Coutellier2020-03-151-1/+11
| | | | | | | | | | | | | | Microversion bump to allow non-admin user to use more filters key when listing instances. In order to stay coherent, all existing instance filters who are related to a field readable by default to non admin users when showing instance details, should be allowed by default without policy modification. Implements: blueprint non-admin-filter-instance-by-az Change-Id: Ia66d3a1ceb74ed521cf44922929b2a502f3ee935
* docs: update SUSPENDED server status wrt supported driversMatt Riedemann2019-11-141-2/+1
| | | | | | | | | | | | | | | | | | Two things here: 1. The API guide was missing the hyper-v driver which supports the suspend operation. Rather than hard-code a list of supported drivers in the doc, this change just links to the entry in the feature support matrix. 2. The supported hypervisors mention in the API reference is removed because the end user using the API should not need to know or care what backend hypervisor on which their server is running. They can either suspend or not, but we don't need to mention the supporting drivers for that in the API reference. Change-Id: Ib76779a8e34b2c68b0f4af190f71576180360d0f Related-Bug: #1815403
* Merge ""SUSPENDED" description changed in server_concepts guide and API REF"Zuul2019-11-141-7/+7
|\
| * "SUSPENDED" description changed in server_concepts guide and API REFSharat Sharma2019-11-131-7/+7
| | | | | | | | | | | | | | | | The description of "SUSPENDED" server status was misguiding. Rewording it to make it more accurate. Change-Id: Ie93b3b38c2000f7e9caa3ca89dea4ec04ed15067 Closes-Bug: #1815403
* | api-ref: Fix security groups parametersTakashi NATSUME2019-10-071-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The security groups parameters are optional in the response of the following APIs. - GET /servers/detail - GET /servers/{server_id} - PUT /servers/{server_id} - POST /servers/{server_id}/action (rebuild) So fix them. Change-Id: Icc2315fd8b8c085de9d560de6ddf4c05aaaf6acb Closes-Bug: #1846656
* | Update api-ref for 2.75 to add config_drive in server update responseGhanshyam Mann2019-08-201-0/+1
| | | | | | | | | | | | | | | | | | | | | | In 2.75, we missed to add the config_drive field in api-ref for update server response - I9d257a003d315b84b937dcef91f3cb41f3e24b53. This commit updates the api-ref. Change-Id: I46ab0b8650bf50a5384bb56027cdf0dc2a9bb2fe Partial-Implements: blueprint api-consistency-cleanup
* | Multiple API cleanup changesGhanshyam Mann2019-08-121-4/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This microversion implements below API cleanups: 1. 400 for unknown param for query param and for request body. 2. Making server representation always consistent among all APIs returning the complete server representation. 3. Change the default return value of ``swap`` field from the empty string to 0 (integer) in flavor APIs. 4. Return ``servers`` field always in the response of GET hypervisors API even there are no servers on hypervisor Details: https://specs.openstack.org/openstack/nova-specs/specs/train/approved/api-consistency-cleanup.html Partial-Implements: blueprint api-consistency-cleanup Change-Id: I9d257a003d315b84b937dcef91f3cb41f3e24b53
* | Update api-ref locationAndreas Jaeger2019-07-221-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The api documentation is now published on docs.openstack.org instead of developer.openstack.org. Update all links that are changed to the new location. Note that Neutron publishes to api-ref/network, not networking anymore. Note that redirects will be set up as well but let's point now to the new location. For details, see: http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
* | Add host and hypervisor_hostname flag to create serverzhu.boxiang2019-07-091-0/+7
| | | | | | | | | | | | | | | | | | Add a new microversion that adds two new params to create server named 'host' and 'hypervisor_hostname'. Part of Blueprint: add-host-and-hypervisor-hostname-flag-to-create-server Change-Id: I3afea20edaf738da253ede44b4a07414ededafd6
* | conf: Rename 'configuration drive' to 'config drive'Stephen Finucane2019-06-201-1/+1
|/ | | | | | | Keeps dansmith happy. Change-Id: Ifd8537692de98ee02ff7333812d2877273a0a388 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Merge "Update description of valid whitelist for non-admin user"Zuul2019-05-231-1/+3
|\
| * Update description of valid whitelist for non-admin user翟小君2019-05-221-1/+3
| | | | | | | | | | | | | | | | | | | | | | Non-admin user can filter instance by instance-uuid and other filter keys with being configured using the "os_compute_api: servers:allow_all_filters" policy rule. The policy rule was added with Ia5504da9a00bad689766aeda20255e10b7629f63. Closes-Bug:1819425 Change-Id: I74146b4370b6017cb199466258165fc6df080082
* | api-ref: mention default project filtering when listing serversMatt Riedemann2019-05-171-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This removes the "all" wording from the List Servers API reference docs since it could be confused with actually returning all servers across all tenants (the all_tenants filters). It also mentions that by default only servers associated with the project making the request are returned, i.e. the project associated with the auth token on the request. This is probably fairly obvious and automatic to anyone that's worked with openstack for a long time but might not be for a new user and is not really documented anywhere in the API reference or API guide that I could find. Change-Id: Ie28164e4813a7a48addcd80d81c72c978ac9f395
* | Merge "api-ref: fix mention of all_tenants filter for non-admins"Zuul2019-05-131-1/+0
|\ \
| * | api-ref: fix mention of all_tenants filter for non-adminsMatt Riedemann2019-05-071-1/+0
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The API reference for listing servers says that the all_tenants filter parameter is available for non-admins which is likely a mistake because of it being in the _get_server_search_options method, but all_tenants is admin-only by default policy because of the os_compute_api:servers:index:get_all_tenants and os_compute_api:servers:detail:get_all_tenants policy rules. This change fixes the API reference to remove all_tenants from the list of non-admin filter parameters and also adds a note to the _get_server_search_options method to avoid future confusion. Change-Id: I0e937afbdf8e19d2efd626047913d4c8a9b88b76 Closes-Bug: #1828042
* | Microversion 2.73: Support adding the reason behind a server lockSurya Seetharaman2019-05-111-6/+12
|/ | | | | | | | | | | | | | | | | | | | | | This patch adds a new parameter ``locked_reason`` to ``POST /servers/{server_id}/action`` request where the action is lock. It enables the user to specify a reason when locking a server. The locked_reason will be exposed through ``GET servers/{server_id}``, ``GET /servers/detail``, ``POST /servers/{server_id}/action`` where the action is rebuild and ``PUT servers/{server_id}`` requests' responses. The InstanceActionNotification will emit the locked_reason along with the other instance details. This patch hence changes the payload object to include the "locked_reason" field. Note that "locked" will be allowed as a valid filtering/sorting parameter for ``GET /servers/detail`` and ``GET /servers`` from this new microversion. Implements blueprint add-locked-reason Change-Id: I46edd595e7417c584106487123774a73c6dbe65e
* Adds the server group info into show server detail API.Yongli He2019-02-281-0/+2
| | | | | | | | | | | The server-groups UUID add to response of 'GET /servers/{id}', 'PUT /servers/{server_id}" and rebuild API 'POST /servers/{server_id}/action'. Change-Id: I4a2a584df56ece7beb8b12c0ce9b0e6b30237120 Implements: blueprint show-server-group Co-authored-by: Gerry Kopec <Gerry.Kopec@windriver.com> Signed-off-by: Yongli He <yongli.he@intel.com>
* API microversion 2.69: Handles Down Cells DocumentationSurya Seetharaman2019-02-201-0/+24
| | | | | | | | | This patch adds the documentation around the work regarding handling down cells that was introduced in v2.69. Related to blueprint handling-down-cell Change-Id: I78ed924a802307a992ff90e61ae7ff07c2cc39d1
* API microversion 2.69: Handles Down CellsSurya Seetharaman2019-02-151-0/+27
| | | | | | | | | | | This patch introduces a new API microversion which will be used to alter the responses of ``GET /servers``, ``GET /servers/detail``, ``GET /servers/{server_id}`` and ``GET /os-services`` when a cell is down to return minimal constructs with missing keys. Implements blueprint handling-down-cell Change-Id: Id9f12532897912b39093f63e9286540d9029edeb
* Fix block_device_mapping_v2 mention in server create API referenceMatt Riedemann2018-10-171-1/+1
| | | | | | | The parameter is "block_device_mapping_v2" with underscores not dashes. Change-Id: I10300b5614b6fd91a1992e6e22fb776815206795
* Add microversion 2.67 to support volume_typezhangbailin2018-10-121-0/+1
| | | | | | | | Add a new microversion 2.67 to support specify ``volume_type`` when boot instances. Part of bp boot-instance-specific-storage-backend Change-Id: I13102243f7ce36a5d44c1790f3a633703373ebf7
* Merge "Remove deprecated hide_server_address_states option"Zuul2018-09-211-6/+0
|\
| * Remove deprecated hide_server_address_states optionMatt Riedemann2018-09-191-6/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | The hide_server_address_states config option and related policy rule were deprecated in Queens: I6040e8c2b3e132b0dfd09f82ae041b4786a63483 They are now removed in Stein as part of the API extension merge effort. Part of blueprint api-extensions-merge-stein Change-Id: Ib3582038274dedbf524ffcaffe818ff0e751489d
* | Resource retrieving: add changes-before filterzhangbailin2018-09-191-0/+3
|/ | | | | | | | | | | | This adds the changes-before filter to the servers, os-instance-actions and os-migrations APIs for filtering resources which were last updated before or equal to the given time. The changes-before filter, like the changes-since filter, will return deleted server resources. Part of bp support-to-query-nova-resources-filter-by-changes-before Change-Id: If91c179e3823c8b0da744a9363906b0f7b05c326
* api-ref: Example verification for servers.incTakashi NATSUME2018-07-091-18/+11
| | | | | | | This patch verifies request and response bodies in servers.inc. Change-Id: I9266e7513ed6eb00599dc766081ce81014a209bb Closes-Bug: #1739573
* api-ref: Fix parameters about trusted certificate IDsTakashi NATSUME2018-06-221-1/+1
| | | | | | | | | | | | | | Fix the location of the 'trusted_image_certificates' parameter in the parameter list of the request body in the "Create Server" API. Add an additional description that explains the value is null if the trusted certificate IDs are not set in the description for the 'trusted_image_certificates' parameter in the response body. Change-Id: Ibd3763044068c64b88a28d6c541c569233e112f8 Closes-Bug: #1777394
* Add trusted_image_certificates to REST APIBrianna Poulos2018-06-131-6/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change adds support for the trusted_image_certificates parameter, which is used to define a list of trusted certificate IDs that can be used during image signature verification and certificate validation. The parameter may contain a list of strings, each string representing the ID of a trusted certificate. The list is restricted to a maximum of 50 IDs. The list of certificate IDs will be stored in the trusted_certs field of the instance InstanceExtra and will be used to verify the validity of the signing certificate of a signed instance image. The trusted_image_certificates request parameter can be passed to the server create and rebuild APIs (if allowed by policy): * POST /servers * POST /servers/{server_id}/action (rebuild) The following policy rules were added to restrict the usage of the ``trusted_image_certificates`` request parameter in the server create and rebuild APIs: * os_compute_api:servers:create:trusted_certs * os_compute_api:servers:rebuild:trusted_certs The trusted_image_certificates parameter will be in the response body of the following APIs (not restricted by policy): * GET /servers/detail * GET /servers/{server_id} * PUT /servers/{server_id} * POST /servers/{server_id}/action (rebuild) APIImpact Implements blueprint: nova-validate-certificates Change-Id: Iedd3fea0e86648fae364f075915555dcb2c4f199
* [doc] Add soft_deleted flagjichen2018-05-091-0/+2
| | | | | | | | | soft_deleted is support in query but we didn't mention in the doc https://github.com/openstack/nova/blob/bcb405e871a447df57ea420402919a256f5d0be9/nova/db/sqlalchemy/api.py#L2127 Change-Id: I1c5577a501144170e82c96c04cffbf32dcaa5cff Closes-Bug: 1765575
* api-ref: Parameter verification for servers.inc (3/3)Takashi NATSUME2018-04-111-47/+35
| | | | | | | | | | | | This patch completes parameter verification for servers.inc. * Verifies remaining parameters * Sorts parameters * Adds missing parameters * Removing unncessary parameters Change-Id: If01b2dcfa9df8c0e80ad1da65115204fe321891b Closes-Bug: #1738930
* api-ref: Parameter verification for servers.inc (2/3)Takashi NATSUME2018-04-111-6/+31
| | | | | | | | This patch verifies BDM, fault and scheduler hint parameters. A subsequent patch will verify other parameters. Change-Id: If57aa3e37ebaa6fa13718480bb216d10664aa5b1 Partial-Bug: #1738930
* api-ref: Parameter verification for servers.inc (1/3)Takashi NATSUME2018-03-271-10/+10
| | | | | | | | This patch verifies query parameters. Subsequent patches will verify other parameters. Change-Id: I6078c0c8ebc888dc120f446f228a3b0433b89a76 Partial-Bug: #1738930
* Add server filters whitelist in server api-refghanshyam2018-01-301-0/+27
| | | | | | | | | We maintain the whitelist for valid server filters key but have not documented those clearly. This patch adds whitelist for non-admin and admin users. Change-Id: Idc031916c804a18876551113a0fd57d4a463cd63
* Deprecate file injectionMatt Riedemann2017-12-121-0/+4
| | | | | | | | | | | | | | | | This microversion makes the following changes: 1. Deprecates personality files from POST /servers and the rebuild server action APIs. 2. Adds the ability to pass new user_data to the rebuild server action API. 3. Personality / file injection related limits and quota resources are removed from the limits, os-quota-sets and os-quota-class-sets APIs. Implements blueprint deprecate-file-injection Change-Id: Ia89eeb6725459c35369e8f790f68ad9180bd3aba
* Merge "block_device_mapping_v2.bus_type is missing from api-ref"Zuul2017-11-141-0/+1
|\
| * block_device_mapping_v2.bus_type is missing from api-refKevin_Zheng2017-11-091-0/+1
| | | | | | | | | | | | | | | | block_device_mapping_v2.bus_type is missing from POST /servers API reference. This patch add it. Change-Id: I998cf6195d72c80649e9e0fd43be0cf37f8e2f48 Closes-Bug: #1713895
* | api-ref: fix server status values in GET /servers docsMatt Riedemann2017-10-111-5/+9
|/ | | | | | | | | | | | | | | The server status values exposed out of the API and used for filtering when listing instances comes from the values in nova.api.openstack.common._STATE_MAP. Some of the values listed in the docs were incorrectly using variable names from the code, which don't necessarily match the actual value exposed out of the API. The compute API server concepts guide actually had this all correct, so this just updates the API reference. Change-Id: I30b6f27c6e7fc9365c203b620b311785f8b4b489 Closes-Bug: #1722403
* Correct statement in api-refyushangbin2017-08-211-1/+1
| | | | Change-Id: Idc69876695e04d85df942ea2374d89342b27dc0f
* Support tag instances when boot(4/4)Kevin_Zheng2017-07-171-0/+1
| | | | | | | | | | | This is the 4th patch of the series, this patch adds a new microversion in API to support adding tags when booting instances. Implemetes: blueprint support-tag-instance-when-boot Change-Id: Ifcaaf285c8f98a1d0e8bbbc87b2f57fbce057346
* show flavor info in server detailsChris Friesen2017-06-021-8/+41
| | | | | | | | | | | | | Add a new microversion to change the flavor field in the server details to display a subset of the flavor information instead of just a link to the original flavor. This is more reliable since it shows the actual instance size, while the flavor may have been deleted/recreated in the meantime or the flavor extra-specs may have been modified. Implements: blueprint instance-flavor-api Change-Id: If646149efb7eec8c90bf7d07c39ff4c495349941
* Merge "Fix api-ref for create servers response"Jenkins2017-04-111-34/+1
|\
| * Fix api-ref for create servers responseghanshyam2017-04-111-34/+1
| | | | | | | | | | | | | | | | | | | | | | create server API only return few elements in response not all which are currently shown in api-ref. This commit fix that. Part of bp/api-ref-in-rst-pike Change-Id: I782e97bc3ffb1e1c192b5a63736e524917739e4b
* | Merge "api-ref: fix os-extended-volumes:volumes_attached in servers responses"Jenkins2017-04-111-2/+4
|\ \ | |/
| * api-ref: fix os-extended-volumes:volumes_attached in servers responsesMatt Riedemann2017-04-071-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are two main changes here: 1. The contents of the os-extended-volumes:volumes_attached list are described, which are the id and delete_on_termination keys, the latter being introduced in the GET /servers response in 2.3. 2. The os-extended-volumes:volumes_attached parameters are removed from the PUT /servers and POST /servers responses, since we don't actually include those in the response for create and update operations, only GET /servers/{server_id} and GET /servers/detail operations. Note: create server is fixed in a follow up patch. Change-Id: Ic92055e3095d220a3a11e35628f04e9e67c6b71a Closes-Bug: #1675559
* | Merge "Add empty flavor object info in server api-ref"Jenkins2017-04-071-3/+3
|\ \ | |/ |/|
| * Add empty flavor object info in server api-refghanshyam2017-04-051-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | In case flavor information is not present in sysmeta then GET/PUT server response can have flavor as empty object. ref- http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/compute/views/servers.py#n252 Having that mentioned in api-ref will be nice to understand it clearly. Closes-Bug: #1677999 Change-Id: I350dc33df0cb03eb86df1f142e58ae34b02a1334
* | Merge "Fix api-ref for adminPass behavior"Jenkins2017-03-311-1/+2
|\ \ | |/ |/|
| * Fix api-ref for adminPass behaviorghanshyam2017-03-281-1/+2
| | | | | | | | | | | | | | | | | | | | | | This commit fix the below doc issue for adminPass -'adminPass' attrbiure is only return in response if 'enable_instance_password' configuration option is set to true - evacuate API stop returning adminPass from 2.14 microversion so max version for this field is 2.13. - if 'adminPass' is not present in request then, operation auto generate one. Change-Id: I636657ed30b33da0a2df73b222c4ce5d8388a3d8
View Lorry Controller Status