OpenStack Compute (Nova)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

7410 lines
201KB

  1. # variables in header
  2. image_location:
  3. description: |
  4. The image location URL of the image or backup created, HTTP header
  5. "Location: <image location URL>" will be returned.
  6. .. note:: The URL returned may not be accessible to users and should not
  7. be relied upon. Use microversion 2.45 or simply parse the image ID out
  8. of the URL in the Location response header.
  9. in: header
  10. required: true
  11. type: string
  12. max_version: 2.44
  13. server_location:
  14. description: |
  15. The location URL of the server, HTTP header
  16. "Location: <server location URL>" will be returned.
  17. in: header
  18. required: true
  19. type: string
  20. tag_location:
  21. description: |
  22. The location of the tag. It's individual tag URL which can be used for
  23. checking the existence of the tag on the server or deleting the tag from the server.
  24. in: header
  25. required: true
  26. type: string
  27. x-compute-request-id_resp:
  28. description: |
  29. The local request ID, which is a unique ID generated automatically
  30. for tracking each request to nova.
  31. It is associated with the request and appears in the log lines
  32. for that request.
  33. By default, the middleware configuration
  34. ensures that the local request ID appears in the log files.
  35. .. note::
  36. This header exists for backward compatibility.
  37. in: header
  38. required: true
  39. type: string
  40. x-openstack-request-id_req:
  41. description: |
  42. The global request ID, which is a unique common ID
  43. for tracking each request in OpenStack components.
  44. The format of the global request ID must be ``req-`` + UUID (UUID4).
  45. If not in accordance with the format, it is ignored.
  46. It is associated with the request and appears in the log lines
  47. for that request.
  48. By default, the middleware configuration ensures that
  49. the global request ID appears in the log files.
  50. in: header
  51. required: false
  52. type: string
  53. min_version: 2.46
  54. x-openstack-request-id_resp:
  55. description: |
  56. The local request ID, which is a unique ID generated automatically
  57. for tracking each request to nova.
  58. It is associated with the request and appears in the log lines
  59. for that request.
  60. By default, the middleware configuration
  61. ensures that the local request ID appears in the log files.
  62. in: header
  63. required: true
  64. type: string
  65. min_version: 2.46
  66. # variables in path
  67. agent_build_id:
  68. description: |
  69. The id of the agent build.
  70. in: path
  71. required: true
  72. type: string
  73. aggregate_id:
  74. description: |
  75. The aggregate ID.
  76. in: path
  77. required: true
  78. type: integer
  79. api_version:
  80. in: path
  81. required: true
  82. type: string
  83. description: >
  84. The API version as returned in the links from the ``GET /`` call.
  85. before_timestamp:
  86. description: |
  87. Filters the response by the date and time before which to list usage
  88. audits.
  89. The date and time stamp format is as follows:
  90. ::
  91. CCYY-MM-DD hh:mm:ss.NNNNNN
  92. For example, ``2015-08-27 09:49:58`` or ``2015-08-27 09:49:58.123456``.
  93. in: path
  94. required: true
  95. type: string
  96. cell_id:
  97. description: |
  98. The UUID of the cell.
  99. in: path
  100. required: true
  101. type: string
  102. console_id:
  103. description: |
  104. The UUID of the console.
  105. in: path
  106. required: true
  107. type: string
  108. console_token:
  109. description: |
  110. Console authentication token.
  111. in: path
  112. required: true
  113. type: string
  114. # Used in the request path for PUT /os-services/disable-log-reason before
  115. # microversion 2.53.
  116. disabled_reason:
  117. description: |
  118. The reason for disabling a service.
  119. in: path
  120. required: false
  121. type: string
  122. domain:
  123. description: |
  124. The registered DNS domain that the DNS drivers publish.
  125. in: path
  126. required: true
  127. type: string
  128. fixed_ip_path:
  129. description: |
  130. The fixed IP of interest to you.
  131. in: path
  132. required: true
  133. type: string
  134. flavor_extra_spec_key:
  135. description: |
  136. The extra spec key for the flavor.
  137. in: path
  138. required: true
  139. type: string
  140. flavor_id:
  141. description: |
  142. The ID of the flavor.
  143. in: path
  144. required: true
  145. type: string
  146. floating_ip_id:
  147. description: |
  148. The ID of the floating IP address.
  149. in: path
  150. required: true
  151. type: string
  152. host_name:
  153. description: |
  154. The name of the host.
  155. in: path
  156. required: true
  157. type: string
  158. hypervisor_hostname_pattern:
  159. description: |
  160. The hypervisor host name or a portion of it.
  161. The hypervisor hosts are selected with the host name matching this pattern.
  162. in: path
  163. required: true
  164. type: string
  165. hypervisor_id:
  166. description: |
  167. The ID of the hypervisor.
  168. in: path
  169. required: true
  170. type: integer
  171. max_version: 2.52
  172. hypervisor_id_uuid:
  173. description: |
  174. The ID of the hypervisor as a UUID.
  175. in: path
  176. required: true
  177. type: string
  178. min_version: 2.53
  179. image_id:
  180. description: |
  181. The UUID of the image.
  182. in: path
  183. required: true
  184. type: string
  185. instance_id:
  186. description: |
  187. The UUID of the instance.
  188. in: path
  189. required: true
  190. type: string
  191. ip:
  192. description: |
  193. The IP address.
  194. in: path
  195. required: true
  196. type: string
  197. key:
  198. description: |
  199. The metadata item key, as a string. Maximum length is 255 characters.
  200. in: path
  201. required: true
  202. type: string
  203. keypair_name_path:
  204. description: |
  205. The keypair name.
  206. in: path
  207. required: true
  208. type: string
  209. migration_id_path:
  210. description: |
  211. The ID of the server migration.
  212. in: path
  213. required: true
  214. type: integer
  215. network_id:
  216. description: |
  217. The UUID of the network.
  218. in: path
  219. required: true
  220. type: string
  221. network_label:
  222. description: |
  223. The network label, such as ``public`` or ``private``.
  224. in: path
  225. required: true
  226. type: string
  227. node_id:
  228. description: |
  229. The node ID.
  230. in: path
  231. required: true
  232. type: string
  233. port_id_path:
  234. description: |
  235. The UUID of the port.
  236. in: path
  237. required: true
  238. type: string
  239. quota_class_id: &quota_class_id
  240. description: |
  241. The ID of the quota class.
  242. Nova supports the ``default`` Quota Class only.
  243. in: path
  244. required: true
  245. type: string
  246. request_id:
  247. description: |
  248. The ID of the request.
  249. in: path
  250. required: true
  251. type: string
  252. security_group_default_rule_id:
  253. description: |
  254. The UUID of the security group rule.
  255. in: path
  256. required: true
  257. type: string
  258. security_group_id:
  259. description: |
  260. The ID of the security group.
  261. in: path
  262. required: true
  263. type: string
  264. security_group_rule_id:
  265. description: |
  266. The ID of the security group rule.
  267. in: path
  268. required: true
  269. type: string
  270. server_group_id:
  271. description: |
  272. The UUID of the server group.
  273. in: path
  274. required: true
  275. type: string
  276. server_id_path:
  277. description: |
  278. The UUID of the server.
  279. in: path
  280. required: true
  281. type: string
  282. service_id_path_2_52:
  283. description: |
  284. The id of the service.
  285. .. note:: This may not uniquely identify a service in a multi-cell
  286. deployment.
  287. in: path
  288. required: true
  289. type: integer
  290. max_version: 2.52
  291. service_id_path_2_53:
  292. description: |
  293. The id of the service as a uuid. This uniquely identifies the service in a
  294. multi-cell deployment.
  295. in: path
  296. required: true
  297. type: string
  298. min_version: 2.53
  299. service_id_path_2_53_no_version:
  300. description: |
  301. The id of the service as a uuid. This uniquely identifies the service in a
  302. multi-cell deployment.
  303. in: path
  304. required: true
  305. type: string
  306. snapshot_id_path:
  307. description: |
  308. The UUID of the snapshot.
  309. in: path
  310. required: true
  311. type: string
  312. tag:
  313. description: |
  314. The tag as a string.
  315. in: path
  316. required: true
  317. type: string
  318. tenant_id:
  319. description: |
  320. The UUID of the tenant in a multi-tenancy cloud.
  321. in: path
  322. required: true
  323. type: string
  324. volume_id_attached_path:
  325. description: |
  326. The UUID of the attached volume.
  327. in: path
  328. required: true
  329. type: string
  330. volume_id_path:
  331. description: |
  332. The unique ID for a volume.
  333. in: path
  334. required: true
  335. type: string
  336. volume_id_swap_src:
  337. description: |
  338. The UUID of the volume being replaced.
  339. in: path
  340. required: true
  341. type: string
  342. volume_id_to_detach_path:
  343. description: |
  344. The UUID of the volume to detach.
  345. in: path
  346. required: true
  347. type: string
  348. # variables in query
  349. access_ip_v4_query_server:
  350. in: query
  351. required: false
  352. type: string
  353. description: |
  354. Filter server list result by IPv4 address that should be used
  355. to access the server.
  356. access_ip_v6_query_server:
  357. in: query
  358. required: false
  359. type: string
  360. description: |
  361. Filter server list result by IPv6 address that should be used
  362. to access the server.
  363. all_projects:
  364. description: |
  365. Administrator only. Lists server groups for all projects. For example:
  366. ``GET /os-server-groups?all_projects=True``
  367. If you specify a tenant ID for a non-administrative user with this query parameter,
  368. the call lists all server groups for the tenant, or project, rather than for
  369. all projects.
  370. Value of this query parameter is not checked, only presence is considered
  371. as request for all projects.
  372. in: query
  373. required: false
  374. type: string
  375. all_tenants:
  376. description: |
  377. Specify the ``all_tenants`` query parameter to ping instances
  378. for all tenants. By default this is only allowed by admin users.
  379. Value of this query parameter is not checked, only presence
  380. is considered as request for all tenants.
  381. in: query
  382. required: false
  383. type: string
  384. all_tenants_query:
  385. description: |
  386. Specify the ``all_tenants`` query parameter to list all instances
  387. for all projects. By default this is only allowed by administrators.
  388. If the value of this parameter is not specified, it is treated as
  389. ``True``. If the value is specified, ``1``, ``t``, ``true``,
  390. ``on``, ``y`` and ``yes`` are treated as ``True``. ``0``, ``f``,
  391. ``false``, ``off``, ``n`` and ``no`` are treated as ``False``.
  392. (They are case-insensitive.)
  393. in: query
  394. required: false
  395. type: boolean
  396. all_tenants_sec_grp_query:
  397. description: |
  398. Specify the ``all_tenants`` query parameter to list all security
  399. groups for all projects. This is only allowed for admin users.
  400. Value of this query parameter is not checked, only presence
  401. is considered as request for all tenants.
  402. in: query
  403. required: false
  404. type: string
  405. availability_zone_query_server:
  406. description: |
  407. Filter the server list result by server availability zone.
  408. This parameter is only valid when specified by administrators.
  409. If non-admin users specify this parameter, it is ignored.
  410. in: query
  411. required: false
  412. type: string
  413. binary_query:
  414. description: |
  415. Filter the service list result by binary name of the service.
  416. in: query
  417. required: false
  418. type: string
  419. changes-since:
  420. description: |
  421. Filters the response by a date and time when the image last changed status.
  422. Use this query parameter to check for changes since a previous request rather
  423. than re-downloading and re-parsing the full status at each polling interval.
  424. If data has changed, the call returns only the items changed since the ``changes-since``
  425. time. If data has not changed since the ``changes-since`` time, the call returns an
  426. empty list.
  427. To enable you to keep track of changes, this filter also displays images
  428. that were deleted if the ``changes-since`` value specifies a date in the last 30 days.
  429. Items deleted more than 30 days ago might be returned, but it is not guaranteed.
  430. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  431. ::
  432. CCYY-MM-DDThh:mm:ss±hh:mm
  433. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  434. For example, ``2015-08-27T09:49:58-05:00``.
  435. If you omit the time zone, the UTC time zone is assumed.
  436. in: query
  437. required: false
  438. type: string
  439. changes_before_instance_action:
  440. description: |
  441. Filters the response by a date and time stamp when the instance actions last changed.
  442. Those instances that changed before or equal to the specified date and time stamp
  443. are returned.
  444. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  445. ::
  446. CCYY-MM-DDThh:mm:ss±hh:mm
  447. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  448. For example, ``2015-08-27T09:49:58-05:00``.
  449. If you omit the time zone, the UTC time zone is assumed.
  450. When both ``changes-since`` and ``changes-before`` are specified,
  451. the value of the ``changes-before`` must be later than or equal to
  452. the value of the ``changes-since`` otherwise API will return 400.
  453. in: query
  454. required: false
  455. type: string
  456. min_version: 2.66
  457. changes_before_migration:
  458. description: |
  459. Filters the response by a date and time stamp when the migration last
  460. changed. Those migrations that changed before or equal to the specified date and time
  461. stamp are returned.
  462. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  463. ::
  464. CCYY-MM-DDThh:mm:ss±hh:mm
  465. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  466. For example, ``2015-08-27T09:49:58-05:00``.
  467. If you omit the time zone, the UTC time zone is assumed.
  468. When both ``changes-since`` and ``changes-before`` are specified,
  469. the value of the ``changes-before`` must be later than or equal to
  470. the value of the ``changes-since`` otherwise API will return 400.
  471. in: query
  472. required: false
  473. type: string
  474. min_version: 2.66
  475. changes_before_server:
  476. description: |
  477. Filters the response by a date and time stamp when the server last changed.
  478. Those servers that changed before or equal to the specified date and time stamp
  479. are returned. To help keep track of changes this may also return recently deleted
  480. servers.
  481. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  482. ::
  483. CCYY-MM-DDThh:mm:ss±hh:mm
  484. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  485. For example, ``2015-08-27T09:49:58-05:00``.
  486. If you omit the time zone, the UTC time zone is assumed.
  487. When both ``changes-since`` and ``changes-before`` are specified,
  488. the value of the ``changes-before`` must be later than or equal to
  489. the value of the ``changes-since`` otherwise API will return 400.
  490. in: query
  491. required: false
  492. type: string
  493. min_version: 2.66
  494. changes_since_instance_action:
  495. description: |
  496. Filters the response by a date and time stamp when the instance action last
  497. changed.
  498. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  499. ::
  500. CCYY-MM-DDThh:mm:ss±hh:mm
  501. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  502. For example, ``2015-08-27T09:49:58-05:00``.
  503. If you omit the time zone, the UTC time zone is assumed.
  504. When both ``changes-since`` and ``changes-before`` are specified,
  505. the value of the ``changes-since`` must be earlier than or equal to
  506. the value of the ``changes-before`` otherwise API will return 400.
  507. in: query
  508. required: false
  509. type: string
  510. min_version: 2.58
  511. changes_since_migration:
  512. description: |
  513. Filters the response by a date and time stamp when the migration last
  514. changed. Those changed after the specified date and time stamp are returned.
  515. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  516. ::
  517. CCYY-MM-DDThh:mm:ss±hh:mm
  518. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  519. For example, ``2015-08-27T09:49:58-05:00``.
  520. If you omit the time zone, the UTC time zone is assumed.
  521. When both ``changes-since`` and ``changes-before`` are specified,
  522. the value of the ``changes-since`` must be earlier than or equal to
  523. the value of the ``changes-before`` otherwise API will return 400.
  524. in: query
  525. required: false
  526. type: string
  527. min_version: 2.59
  528. changes_since_server:
  529. description: |
  530. Filters the response by a date and time stamp when the server last
  531. changed status. To help keep track of changes this may also return
  532. recently deleted servers.
  533. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  534. ::
  535. CCYY-MM-DDThh:mm:ss±hh:mm
  536. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  537. For example, ``2015-08-27T09:49:58-05:00``.
  538. If you omit the time zone, the UTC time zone is assumed.
  539. When both ``changes-since`` and ``changes-before`` are specified,
  540. the value of the ``changes-since`` must be earlier than or equal to
  541. the value of the ``changes-before`` otherwise API will return 400.
  542. in: query
  543. required: false
  544. type: string
  545. config_drive_query_server:
  546. description: |
  547. Filter the server list result by the config drive setting of the server.
  548. This parameter is only valid when specified by administrators.
  549. If non-admin users specify this parameter, it is ignored.
  550. in: query
  551. required: false
  552. type: string
  553. created_at_query_server:
  554. description: |
  555. Filter the server list result by a date and time stamp when server was created.
  556. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  557. ::
  558. CCYY-MM-DDThh:mm:ss±hh:mm
  559. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  560. For example, ``2015-08-27T09:49:58-05:00``.
  561. If you omit the time zone, the UTC time zone is assumed.
  562. This parameter is only valid when specified by administrators.
  563. If non-admin users specify this parameter, it is ignored.
  564. in: query
  565. required: false
  566. type: string
  567. delete_info:
  568. description: |
  569. Information for snapshot deletion. Include the ID of the associated volume. For
  570. example:
  571. .. code-block:: javascript
  572. DELETE /os-assisted-volume-snapshots/421752a6-acf6-4b2d-bc7a-119f9148cd8c?delete_info='{"volume_id": "521752a6-acf6-4b2d-bc7a-119f9148cd8c"}'
  573. in: query
  574. required: true
  575. type: string
  576. deleted_query:
  577. in: query
  578. required: false
  579. type: boolean
  580. description: |
  581. Show deleted items only. In some circumstances deleted items will still
  582. be accessible via the backend database, however there is no
  583. contract on how long, so this parameter should be used with
  584. caution. ``1``, ``t``, ``true``, ``on``, ``y`` and ``yes`` are treated as
  585. ``True`` (case-insensitive). Other than them are treated as ``False``.
  586. This parameter is only valid when specified by administrators.
  587. If non-admin users specify this parameter, it is ignored.
  588. description_query_server:
  589. description: |
  590. Filter the server list result by description.
  591. This parameter is only valid when specified by administrators.
  592. If non-admin users specify this parameter, it is ignored.
  593. .. note::
  594. ``display_description`` can also be requested which is alias of
  595. ``description`` but that is not recommended to use as that will
  596. be removed in future.
  597. in: query
  598. required: false
  599. type: string
  600. detailed_simple_tenant_usage:
  601. description: |
  602. Specify the ``detailed=1`` query parameter to get detail information
  603. ('server_usages' information).
  604. in: query
  605. required: false
  606. type: integer
  607. disk_config_query_server:
  608. description: |
  609. Filter the server list result by the ``disk_config`` setting of the server,
  610. Valid values are:
  611. - ``AUTO``
  612. - ``MANUAL``
  613. This parameter is only valid when specified by administrators.
  614. If non-admin users specify this parameter, it is ignored.
  615. in: query
  616. required: false
  617. type: string
  618. end_simple_tenant_usage:
  619. description: |
  620. The ending time to calculate usage statistics on compute and
  621. storage resources. The date and time stamp format is any of
  622. the following ones:
  623. ::
  624. CCYY-MM-DDThh:mm:ss
  625. For example, ``2015-08-27T09:49:58``.
  626. ::
  627. CCYY-MM-DDThh:mm:ss.NNNNNN
  628. For example, ``2015-08-27T09:49:58.123456``.
  629. ::
  630. CCYY-MM-DD hh:mm:ss.NNNNNN
  631. For example, ``2015-08-27 09:49:58.123456``.
  632. If you omit this parameter, the current time is used.
  633. in: query
  634. required: false
  635. type: string
  636. exclude:
  637. description: |
  638. Specify ``exclude=uuid[,uuid...]`` to exclude the instances from the results.
  639. in: query
  640. required: false
  641. type: string
  642. flavor_is_public_query:
  643. in: query
  644. required: false
  645. type: string
  646. description: |
  647. This parameter is only applicable to users with the administrative role.
  648. For all other non-admin users, the parameter is ignored and only public
  649. flavors will be returned. Filters the flavor list based on whether the
  650. flavor is public or private. If the value of this parameter is not
  651. specified, it is treated as ``True``. If the value is specified, ``1``,
  652. ``t``, ``true``, ``on``, ``y`` and ``yes`` are treated as ``True``. ``0``,
  653. ``f``, ``false``, ``off``, ``n`` and ``no`` are treated as ``False``
  654. (they are case-insensitive). If the value is ``None`` (case-insensitive)
  655. both public and private flavors will be listed in a single request.
  656. flavor_query:
  657. description: |
  658. Filters the response by a flavor, as a UUID. A flavor is a combination of memory,
  659. disk size, and CPUs.
  660. in: query
  661. required: false
  662. type: string
  663. host_query_server:
  664. description: |
  665. Filter the server list result by the host name of compute node.
  666. This parameter is only valid when specified by administrators.
  667. If non-admin users specify this parameter, it is ignored.
  668. in: query
  669. required: false
  670. type: string
  671. host_query_service:
  672. description: |
  673. Filter the service list result by the host name.
  674. in: query
  675. required: false
  676. type: string
  677. hostname_query_server:
  678. description: |
  679. Filter the server list result by the host name of server.
  680. This parameter is only valid when specified by administrators.
  681. If non-admin users specify this parameter, it is ignored.
  682. in: query
  683. required: false
  684. type: string
  685. hypervisor_hostname_pattern_query:
  686. description: |
  687. The hypervisor host name or a portion of it. The hypervisor hosts are
  688. selected with the host name matching this pattern.
  689. .. note:: ``limit`` and ``marker`` query parameters for paging are
  690. not supported when listing hypervisors using a hostname pattern.
  691. Also, ``links`` will not be returned in the response when using this
  692. query parameter.
  693. in: query
  694. required: false
  695. type: string
  696. min_version: 2.53
  697. hypervisor_limit:
  698. description: |
  699. Requests a page size of items. Returns a number of items up to a limit value.
  700. Use the ``limit`` parameter to make an initial limited request and use the ID
  701. of the last-seen item from the response as the ``marker`` parameter value in a
  702. subsequent limited request.
  703. in: query
  704. required: false
  705. type: integer
  706. min_version: 2.33
  707. hypervisor_marker:
  708. description: |
  709. The ID of the last-seen item. Use the ``limit`` parameter to make an initial limited
  710. request and use the ID of the last-seen item from the response as the ``marker``
  711. parameter value in a subsequent limited request.
  712. in: query
  713. required: false
  714. type: integer
  715. min_version: 2.33
  716. max_version: 2.52
  717. hypervisor_marker_uuid:
  718. description: |
  719. The ID of the last-seen item as a UUID. Use the ``limit`` parameter to make
  720. an initial limited request and use the ID of the last-seen item from the
  721. response as the ``marker`` parameter value in a subsequent limited request.
  722. in: query
  723. required: false
  724. type: string
  725. min_version: 2.53
  726. hypervisor_query:
  727. description: |
  728. Filters the response by a hypervisor type.
  729. in: query
  730. required: false
  731. type: string
  732. hypervisor_with_servers_query:
  733. description: |
  734. Include all servers which belong to each hypervisor in the response output.
  735. in: query
  736. required: false
  737. type: boolean
  738. min_version: 2.53
  739. image_name_query:
  740. description: |
  741. Filters the response by an image name, as a string.
  742. in: query
  743. required: false
  744. type: string
  745. image_query:
  746. description: |
  747. Filters the response by an image, as a UUID.
  748. .. note::
  749. 'image_ref' can also be requested which is alias of 'image'
  750. but that is not recommended to use as that will be removed in future.
  751. in: query
  752. required: false
  753. type: string
  754. image_server_query:
  755. description: |
  756. Filters the response by a server, as a URL.
  757. format: uri
  758. in: query
  759. required: false
  760. type: string
  761. image_status_query:
  762. description: |
  763. Filters the response by an image status, as a string. For example, ``ACTIVE``.
  764. in: query
  765. required: false
  766. type: string
  767. image_type_query:
  768. description: |
  769. Filters the response by an image type. For example, ``snapshot`` or ``backup``.
  770. in: query
  771. required: false
  772. type: string
  773. include:
  774. description: |
  775. Specify ``include=uuid[,uuid...]`` to include the instances in the results.
  776. in: query
  777. required: false
  778. type: string
  779. instance_action_limit:
  780. description: |
  781. Requests a page size of items. Returns a number of items up to a limit value.
  782. Use the ``limit`` parameter to make an initial limited request and use the
  783. last-seen item from the response as the ``marker`` parameter value in a
  784. subsequent limited request.
  785. in: query
  786. required: false
  787. type: integer
  788. min_version: 2.58
  789. instance_action_marker:
  790. description: |
  791. The ``request_id`` of the last-seen instance action. Use the ``limit``
  792. parameter to make an initial limited request and use the last-seen
  793. item from the response as the ``marker`` parameter value in a subsequent
  794. limited request.
  795. in: query
  796. required: false
  797. type: string
  798. min_version: 2.58
  799. ip6_query:
  800. description: |
  801. An IPv6 address to filter results by.
  802. Up to microversion 2.4, this parameter is only valid when specified
  803. by administrators. If non-admin users specify this parameter,
  804. it is ignored.
  805. Starting from microversion 2.5, this parameter is valid for no-admin users
  806. as well as administrators.
  807. in: query
  808. required: false
  809. type: string
  810. ip_query:
  811. description: |
  812. An IPv4 address to filter results by.
  813. in: query
  814. required: false
  815. type: string
  816. kernel_id_query_server:
  817. in: query
  818. required: false
  819. type: string
  820. description: |
  821. Filter the server list result by the UUID of the kernel image
  822. when using an AMI.
  823. This parameter is only valid when specified by administrators.
  824. If non-admin users specify this parameter, it is ignored.
  825. key_name_query_server:
  826. description: |
  827. Filter the server list result by keypair name.
  828. This parameter is only valid when specified by administrators.
  829. If non-admin users specify this parameter, it is ignored.
  830. in: query
  831. required: false
  832. type: string
  833. keypair_limit:
  834. description: |
  835. Requests a page size of items. Returns a number of items up to a limit value.
  836. Use the ``limit`` parameter to make an initial limited request and use the
  837. last-seen item from the response as the ``marker`` parameter value in a
  838. subsequent limited request.
  839. in: query
  840. required: false
  841. type: integer
  842. min_version: 2.35
  843. keypair_marker:
  844. description: |
  845. The last-seen item. Use the ``limit`` parameter to make an initial limited
  846. request and use the last-seen item from the response as the ``marker``
  847. parameter value in a subsequent limited request.
  848. in: query
  849. required: false
  850. type: string
  851. min_version: 2.35
  852. keypair_user:
  853. in: query
  854. required: false
  855. type: string
  856. description: |
  857. This allows administrative users to operate key-pairs of specified
  858. user ID.
  859. min_version: 2.10
  860. launch_index_query_server:
  861. description: |
  862. Filter the server list result by the sequence in which the
  863. servers were launched.
  864. This parameter is only valid when specified by administrators.
  865. If non-admin users specify this parameter, it is ignored.
  866. in: query
  867. required: false
  868. type: integer
  869. launched_at_query_server:
  870. description: |
  871. Filter the server list result by a date and time stamp when the instance was launched.
  872. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  873. ::
  874. CCYY-MM-DDThh:mm:ss±hh:mm
  875. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  876. For example, ``2015-08-27T09:49:58-05:00``.
  877. If you omit the time zone, the UTC time zone is assumed.
  878. This parameter is only valid when specified by administrators.
  879. If non-admin users specify this parameter, it is ignored.
  880. in: query
  881. required: false
  882. type: string
  883. limit:
  884. description: |
  885. Requests a page size of items. Returns a number of items up to a limit value.
  886. Use the ``limit`` parameter to make an initial limited request and use the ID
  887. of the last-seen item from the response as the ``marker`` parameter value in a
  888. subsequent limited request.
  889. in: query
  890. required: false
  891. type: integer
  892. limit_simple:
  893. description: |
  894. Used in conjunction with ``offset`` to return a slice of items. ``limit``
  895. is the maximum number of items to return. If ``limit`` is not specified,
  896. or exceeds the configurable ``max_limit``, then ``max_limit`` will be
  897. used instead.
  898. in: query
  899. required: false
  900. type: integer
  901. locked_by_query_server:
  902. description: |
  903. Filter the server list result by who locked the server, possible value
  904. could be ``admin`` or ``owner``.
  905. This parameter is only valid when specified by administrators.
  906. If non-admin users specify this parameter, it is ignored.
  907. in: query
  908. required: false
  909. type: string
  910. locked_query_server:
  911. description: |
  912. Specify the ``locked`` query parameter to list all locked or unlocked
  913. instances. If the value is specified, ``1``, ``t``, ``true``,
  914. ``on``, ``y`` and ``yes`` are treated as ``True``. ``0``, ``f``,
  915. ``false``, ``off``, ``n`` and ``no`` are treated as ``False``.
  916. (They are case-insensitive.) Any other value provided will be considered
  917. invalid.
  918. in: query
  919. required: false
  920. type: boolean
  921. min_version: 2.73
  922. marker:
  923. description: |
  924. The ID of the last-seen item. Use the ``limit`` parameter to make an initial limited
  925. request and use the ID of the last-seen item from the response as the ``marker``
  926. parameter value in a subsequent limited request.
  927. in: query
  928. required: false
  929. type: string
  930. migration_hidden:
  931. description: |
  932. The 'hidden' setting of migration to filter.
  933. The 'hidden' flag is set if the value is 1.
  934. The 'hidden' flag is not set if the value is 0.
  935. But the 'hidden' setting of migration is always 0,
  936. so this parameter is useless to filter migrations.
  937. in: query
  938. required: false
  939. type: integer
  940. migration_host:
  941. description: |
  942. The source/destination compute node of migration to filter.
  943. in: query
  944. required: false
  945. type: string
  946. migration_instance_uuid:
  947. description: |
  948. The uuid of the instance that migration is operated on to filter.
  949. in: query
  950. required: false
  951. type: string
  952. migration_limit:
  953. description: |
  954. Requests a page size of items. Returns a number of items up to a limit value.
  955. Use the ``limit`` parameter to make an initial limited request and use the
  956. last-seen item from the response as the ``marker`` parameter value in a
  957. subsequent limited request.
  958. in: query
  959. required: false
  960. type: integer
  961. min_version: 2.59
  962. migration_marker:
  963. description: |
  964. The UUID of the last-seen migration. Use the ``limit`` parameter to make an
  965. initial limited request and use the last-seen item from the response as
  966. the ``marker`` parameter value in a subsequent limited request.
  967. in: query
  968. required: false
  969. type: string
  970. min_version: 2.59
  971. migration_source_compute:
  972. description: |
  973. The source compute node of migration to filter.
  974. in: query
  975. required: false
  976. type: string
  977. migration_status:
  978. description: |
  979. The status of migration to filter.
  980. in: query
  981. required: false
  982. type: string
  983. migration_type:
  984. description: |
  985. The type of migration to filter. Valid values are:
  986. * ``evacuation``
  987. * ``live-migration``
  988. * ``migration``
  989. * ``resize``
  990. in: query
  991. required: false
  992. type: string
  993. minDisk:
  994. description: |
  995. Filters the response by a minimum disk space, in GiB. For example, ``100``.
  996. in: query
  997. required: false
  998. type: integer
  999. minRam:
  1000. description: |
  1001. Filters the response by a minimum RAM, in MiB. For example, ``512``.
  1002. in: query
  1003. required: false
  1004. type: integer
  1005. node_query_server:
  1006. description: |
  1007. Filter the server list result by the node.
  1008. This parameter is only valid when specified by administrators.
  1009. If non-admin users specify this parameter, it is ignored.
  1010. in: query
  1011. required: false
  1012. type: string
  1013. not_tags_any_query:
  1014. in: query
  1015. required: false
  1016. type: string
  1017. description: |
  1018. A list of tags to filter the server list by. Servers that don't
  1019. match any tags in this list will be returned. Boolean expression in this
  1020. case is 'NOT (t1 OR t2)'. Tags in query must be separated by comma.
  1021. min_version: 2.26
  1022. not_tags_query:
  1023. in: query
  1024. required: false
  1025. type: string
  1026. description: |
  1027. A list of tags to filter the server list by. Servers that don't
  1028. match all tags in this list will be returned. Boolean expression in this
  1029. case is 'NOT (t1 AND t2)'. Tags in query must be separated by comma.
  1030. min_version: 2.26
  1031. offset_simple:
  1032. description: |
  1033. Used in conjunction with ``limit`` to return a slice of items. ``offset``
  1034. is where to start in the list.
  1035. in: query
  1036. required: false
  1037. type: integer
  1038. power_state_query_server:
  1039. in: query
  1040. required: false
  1041. type: integer
  1042. description: |
  1043. Filter the server list result by server power state.
  1044. Possible values are integer values that is mapped as::
  1045. 0: NOSTATE
  1046. 1: RUNNING
  1047. 3: PAUSED
  1048. 4: SHUTDOWN
  1049. 6: CRASHED
  1050. 7: SUSPENDED
  1051. This parameter is only valid when specified by administrators.
  1052. If non-admin users specify this parameter, it is ignored.
  1053. progress_query_server:
  1054. description: |
  1055. Filter the server list result by the progress of the server.
  1056. The value could be from 0 to 100 as integer.
  1057. This parameter is only valid when specified by administrators.
  1058. If non-admin users specify this parameter, it is ignored.
  1059. in: query
  1060. required: false
  1061. type: integer
  1062. project_id_query_migrations:
  1063. description: |
  1064. Filter the migrations by the given project ID.
  1065. in: query
  1066. required: false
  1067. type: string
  1068. min_version: 2.80
  1069. project_id_query_server:
  1070. description: |
  1071. Filter the list of servers by the given project ID.
  1072. This filter only works when the ``all_tenants`` filter is also specified.
  1073. .. note::
  1074. 'tenant_id' can also be requested which is alias of 'project_id'
  1075. but that is not recommended to use as that will be removed in future.
  1076. in: query
  1077. required: false
  1078. type: string
  1079. ramdisk_id_query_server:
  1080. in: query
  1081. required: false
  1082. type: string
  1083. description: |
  1084. Filter the server list result by the UUID of the ramdisk image when
  1085. using an AMI.
  1086. This parameter is only valid when specified by administrators.
  1087. If non-admin users specify this parameter, it is ignored.
  1088. reservation_id_query:
  1089. in: query
  1090. required: false
  1091. type: string
  1092. description: |
  1093. A reservation id as returned by a servers multiple create call.
  1094. reserved_query:
  1095. description: |
  1096. Specify whether the result of resource total includes reserved resources
  1097. or not.
  1098. - ``0``: Not include reserved resources.
  1099. - Other than 0: Include reserved resources.
  1100. If non integer value is specified, it is the same as ``0``.
  1101. in: query
  1102. required: false
  1103. type: integer
  1104. server_name_query:
  1105. description: |
  1106. Filters the response by a server name, as a string. You can use regular expressions
  1107. in the query. For example, the ``?name=bob`` regular expression returns both bob
  1108. and bobb. If you must match on only bob, you can use a regular expression that
  1109. matches the syntax of the underlying database server that is implemented for Compute,
  1110. such as MySQL or PostgreSQL.
  1111. .. note::
  1112. 'display_name' can also be requested which is alias of 'name'
  1113. but that is not recommended to use as that will be removed in future.
  1114. format: regexp
  1115. in: query
  1116. required: false
  1117. type: string
  1118. server_root_device_name_query:
  1119. in: query
  1120. required: false
  1121. type: string
  1122. description: |
  1123. Filter the server list result by the root device name of the server.
  1124. This parameter is only valid when specified by administrators.
  1125. If non-admin users specify this parameter, it is ignored.
  1126. server_status_query:
  1127. description: |
  1128. Filters the response by a server status, as a string. For example, ``ACTIVE``.
  1129. Up to microversion 2.37, an empty list is returned if an invalid status is
  1130. specified. Starting from microversion 2.38, a 400 error is returned
  1131. in that case.
  1132. in: query
  1133. required: false
  1134. type: string
  1135. server_uuid_query:
  1136. description: |
  1137. Filter the server list result by the UUID of the server.
  1138. This parameter is only valid when specified by administrators.
  1139. If non-admin users specify this parameter, it is ignored.
  1140. in: query
  1141. required: false
  1142. type: string
  1143. soft_deleted_server:
  1144. description: |
  1145. Filter the server list by ``SOFT_DELETED`` status. This parameter is only valid
  1146. when the ``deleted=True`` filter parameter is specified.
  1147. in: query
  1148. required: false
  1149. type: boolean
  1150. sort_dir_flavor:
  1151. description: |
  1152. Sort direction. A valid value is ``asc`` (ascending) or ``desc`` (descending).
  1153. Default is ``asc``. You can specify multiple pairs of sort key and sort direction
  1154. query parameters. If you omit the sort direction in a pair, the API uses the natural
  1155. sorting direction of the direction of the flavor ``sort_key`` attribute.
  1156. in: query
  1157. required: false
  1158. type: string
  1159. sort_dir_server:
  1160. description: |
  1161. Sort direction. A valid value is ``asc`` (ascending) or ``desc`` (descending).
  1162. Default is ``desc``. You can specify multiple pairs of sort key and sort direction
  1163. query parameters. If you omit the sort direction in a pair, the API uses the natural
  1164. sorting direction of the direction of the server ``sort_key`` attribute.
  1165. in: query
  1166. required: false
  1167. type: string
  1168. sort_key_flavor:
  1169. description: |
  1170. Sorts by a flavor attribute. Default attribute is ``flavorid``. You can specify
  1171. multiple pairs of sort key and sort direction query parameters. If you omit the
  1172. sort direction in a pair, the API uses the natural sorting direction of the flavor
  1173. ``sort_key`` attribute. The sort keys are limited to:
  1174. - ``created_at``
  1175. - ``description``
  1176. - ``disabled``
  1177. - ``ephemeral_gb``
  1178. - ``flavorid``
  1179. - ``id``
  1180. - ``is_public``
  1181. - ``memory_mb``
  1182. - ``name``
  1183. - ``root_gb``
  1184. - ``rxtx_factor``
  1185. - ``swap``
  1186. - ``updated_at``
  1187. - ``vcpu_weight``
  1188. - ``vcpus``
  1189. in: query
  1190. required: false
  1191. type: string
  1192. sort_key_server:
  1193. description: |
  1194. Sorts by a server attribute. Default attribute is ``created_at``. You can
  1195. specify multiple pairs of sort key and sort direction query parameters. If
  1196. you omit the sort direction in a pair, the API uses the natural sorting
  1197. direction of the server ``sort_key`` attribute. The sort keys are limited
  1198. to:
  1199. - ``access_ip_v4``
  1200. - ``access_ip_v6``
  1201. - ``auto_disk_config``
  1202. - ``availability_zone``
  1203. - ``config_drive``
  1204. - ``created_at``
  1205. - ``display_description``
  1206. - ``display_name``
  1207. - ``host``
  1208. - ``hostname``
  1209. - ``image_ref``
  1210. - ``instance_type_id``
  1211. - ``kernel_id``
  1212. - ``key_name``
  1213. - ``launch_index``
  1214. - ``launched_at``
  1215. - ``locked`` (New in version 2.73)
  1216. - ``locked_by``
  1217. - ``node``
  1218. - ``power_state``
  1219. - ``progress``
  1220. - ``project_id``
  1221. - ``ramdisk_id``
  1222. - ``root_device_name``
  1223. - ``task_state``
  1224. - ``terminated_at``
  1225. - ``updated_at``
  1226. - ``user_id``
  1227. - ``uuid``
  1228. - ``vm_state``
  1229. ``host`` and ``node`` are only allowed for admin.
  1230. If non-admin users specify them, a 403 error is returned.
  1231. in: query
  1232. required: false
  1233. type: string
  1234. start_simple_tenant_usage:
  1235. description: |
  1236. The beginning time to calculate usage statistics on compute and
  1237. storage resources. The date and time stamp format is any of the
  1238. following ones:
  1239. ::
  1240. CCYY-MM-DDThh:mm:ss
  1241. For example, ``2015-08-27T09:49:58``.
  1242. ::
  1243. CCYY-MM-DDThh:mm:ss.NNNNNN
  1244. For example, ``2015-08-27T09:49:58.123456``.
  1245. ::
  1246. CCYY-MM-DD hh:mm:ss.NNNNNN
  1247. For example, ``2015-08-27 09:49:58.123456``.
  1248. If you omit this parameter, the current time is used.
  1249. in: query
  1250. required: false
  1251. type: string
  1252. tags_any_query:
  1253. in: query
  1254. required: false
  1255. type: string
  1256. description: |
  1257. A list of tags to filter the server list by. Servers that match
  1258. any tag in this list will be returned. Boolean expression in this
  1259. case is 't1 OR t2'. Tags in query must be separated by comma.
  1260. min_version: 2.26
  1261. tags_query:
  1262. in: query
  1263. required: false
  1264. type: string
  1265. description: |
  1266. A list of tags to filter the server list by. Servers that match
  1267. all tags in this list will be returned. Boolean expression in this
  1268. case is 't1 AND t2'. Tags in query must be separated by comma.
  1269. min_version: 2.26
  1270. task_state_query_server:
  1271. in: query
  1272. required: false
  1273. type: string
  1274. description: |
  1275. Filter the server list result by task state.
  1276. This parameter is only valid when specified by administrators.
  1277. If non-admin users specify this parameter, it is ignored.
  1278. tenant_id_query:
  1279. description: |
  1280. Specify the project ID (tenant ID) to show the rate and absolute limits.
  1281. This parameter can be specified by admin only.
  1282. in: query
  1283. required: false
  1284. type: string
  1285. terminated_at_query_server:
  1286. description: |
  1287. Filter the server list result by a date and time stamp when instance was terminated.
  1288. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  1289. ::
  1290. CCYY-MM-DDThh:mm:ss±hh:mm
  1291. The ``±hh:mm`` value, if included, returns the time zone as an offset from UTC.
  1292. For example, ``2015-08-27T09:49:58-05:00``.
  1293. If you omit the time zone, the UTC time zone is assumed.
  1294. This parameter is only valid when specified by administrators.
  1295. If non-admin users specify this parameter, it is ignored.
  1296. in: query
  1297. required: false
  1298. type: string
  1299. usage_limit:
  1300. description: |
  1301. Requests a page size of items. Calculate usage for the limited number of
  1302. instances. Use the ``limit`` parameter to make an initial limited request
  1303. and use the last-seen instance UUID from the response as the ``marker``
  1304. parameter value in a subsequent limited request.
  1305. in: query
  1306. required: false
  1307. type: integer
  1308. min_version: 2.40
  1309. usage_marker:
  1310. description: |
  1311. The last-seen item. Use the ``limit`` parameter to make an initial limited
  1312. request and use the last-seen instance UUID from the response as the
  1313. ``marker`` parameter value in a subsequent limited request.
  1314. in: query
  1315. required: false
  1316. type: string
  1317. min_version: 2.40
  1318. user_id_query_migrations:
  1319. description: |
  1320. Filter the migrations by the given user ID.
  1321. in: query
  1322. required: false
  1323. type: string
  1324. min_version: 2.80
  1325. user_id_query_quota:
  1326. description: |
  1327. ID of user to list the quotas for.
  1328. in: query
  1329. required: false
  1330. type: string
  1331. user_id_query_quota_delete:
  1332. description: |
  1333. ID of user to delete quotas for.
  1334. in: query
  1335. required: false
  1336. type: string
  1337. user_id_query_server:
  1338. description: |
  1339. Filter the list of servers by the given user ID.
  1340. This parameter is only valid when specified by administrators.
  1341. If non-admin users specify this parameter, it is ignored.
  1342. in: query
  1343. required: false
  1344. type: string
  1345. user_id_query_set_quota:
  1346. description: |
  1347. ID of user to set the quotas for.
  1348. in: query
  1349. required: false
  1350. type: string
  1351. vm_state_query_server:
  1352. description: |
  1353. Filter the server list result by vm state.
  1354. The value could be:
  1355. - ``ACTIVE``
  1356. - ``BUILDING``
  1357. - ``DELETED``
  1358. - ``ERROR``
  1359. - ``PAUSED``
  1360. - ``RESCUED``
  1361. - ``RESIZED``
  1362. - ``SHELVED``
  1363. - ``SHELVED_OFFLOADED``
  1364. - ``SOFT_DELETED``
  1365. - ``STOPPED``
  1366. - ``SUSPENDED``
  1367. This parameter is only valid when specified by administrators.
  1368. If non-admin users specify this parameter, it is ignored.
  1369. in: query
  1370. required: false
  1371. type: string
  1372. # variables in body
  1373. accessIPv4:
  1374. in: body
  1375. required: true
  1376. type: string
  1377. description: |
  1378. IPv4 address that should be used to access this server. May be
  1379. automatically set by the provider.
  1380. accessIPv4_in:
  1381. in: body
  1382. required: false
  1383. type: string
  1384. description: |
  1385. IPv4 address that should be used to access this server.
  1386. accessIPv6:
  1387. in: body
  1388. required: true
  1389. type: string
  1390. description: |
  1391. IPv6 address that should be used to access this server. May be
  1392. automatically set by the provider.
  1393. accessIPv6_in:
  1394. in: body
  1395. required: false
  1396. type: string
  1397. description: |
  1398. IPv6 address that should be used to access this server.
  1399. action:
  1400. description: |
  1401. The name of the action.
  1402. in: body
  1403. required: true
  1404. type: string
  1405. action_reserve:
  1406. description: |
  1407. The attribute to reserve an IP with a value of ``null``.
  1408. in: body
  1409. required: false
  1410. type: string
  1411. action_unreserve:
  1412. description: |
  1413. The attribute to release an IP with a value of ``null``.
  1414. in: body
  1415. required: false
  1416. type: string
  1417. addFixedIp:
  1418. description: |
  1419. The action to add a fixed ip address to a server.
  1420. in: body
  1421. required: true
  1422. type: object
  1423. addFloatingIp:
  1424. description: |
  1425. The action. Contains required floating IP ``address`` and optional
  1426. ``fixed_address``.
  1427. in: body
  1428. required: true
  1429. type: object
  1430. address:
  1431. description: |
  1432. The floating IP address.
  1433. in: body
  1434. required: true
  1435. type: string
  1436. addresses:
  1437. description: |
  1438. The addresses for the server. Servers with status ``BUILD`` hide their
  1439. addresses information.
  1440. in: body
  1441. required: true
  1442. type: object
  1443. addresses_obj:
  1444. description: |
  1445. The addresses information for the server.
  1446. in: body
  1447. required: true
  1448. type: object
  1449. addSecurityGroup:
  1450. description: |
  1451. The action to add a security group to a server.
  1452. in: body
  1453. required: true
  1454. type: object
  1455. addTenantAccess:
  1456. description: |
  1457. The action.
  1458. in: body
  1459. required: true
  1460. type: string
  1461. adminPass_change_password:
  1462. description: |
  1463. The administrative password for the server.
  1464. in: body
  1465. required: true
  1466. type: string
  1467. adminPass_evacuate:
  1468. description: |
  1469. An administrative password to access the evacuated instance.
  1470. If you set ``enable_instance_password`` configuration option to ``False``,
  1471. the API wouldn't return the ``adminPass`` field in response.
  1472. in: body
  1473. required: false
  1474. type: string
  1475. max_version: 2.13
  1476. adminPass_evacuate_request:
  1477. description: |
  1478. An administrative password to access the evacuated server.
  1479. If you omit this parameter, the operation generates a new password.
  1480. Up to API version 2.13, if ``onSharedStorage`` is set to ``True`` and
  1481. this parameter is specified, an error is raised.
  1482. in: body
  1483. required: false
  1484. type: string
  1485. adminPass_request:
  1486. description: |
  1487. The administrative password of the server. If you omit this parameter, the operation
  1488. generates a new password.
  1489. in: body
  1490. required: false
  1491. type: string
  1492. adminPass_rescue_request:
  1493. description: |
  1494. The password for the rescued instance. If you omit this parameter, the operation
  1495. generates a new password.
  1496. in: body
  1497. required: false
  1498. type: string
  1499. adminPass_response:
  1500. description: |
  1501. The administrative password for the server. If you set ``enable_instance_password`` configuration
  1502. option to ``False``, the API wouldn't return the ``adminPass`` field in response.
  1503. in: body
  1504. required: false
  1505. type: string
  1506. agent:
  1507. description: |
  1508. The guest agent object.
  1509. in: body
  1510. required: true
  1511. type: object
  1512. agent_id:
  1513. description: |
  1514. The agent ID.
  1515. in: body
  1516. required: true
  1517. type: integer
  1518. agent_id_str:
  1519. description: |
  1520. The agent ID. (This is a bug of API, this should be integer type which is consistent with
  1521. the responses of agent create and list. This will be fixed in later microversion.)
  1522. in: body
  1523. required: true
  1524. type: string
  1525. agents:
  1526. description: |
  1527. A list of guest agent objects.
  1528. in: body
  1529. required: true
  1530. type: array
  1531. aggregate:
  1532. description: |
  1533. The host aggregate object.
  1534. in: body
  1535. required: true
  1536. type: object
  1537. aggregate_add_host:
  1538. description: |
  1539. The add_host object used to add host to aggregate.
  1540. in: body
  1541. required: true
  1542. type: object
  1543. aggregate_az:
  1544. description: |
  1545. The availability zone of the host aggregate.
  1546. in: body
  1547. required: true
  1548. type: string
  1549. aggregate_az_optional_create:
  1550. description: |
  1551. The availability zone of the host aggregate. You should use a custom
  1552. availability zone rather than the default returned by the
  1553. os-availability-zone API. The availability zone must not include ':'
  1554. in its name.
  1555. in: body
  1556. required: false
  1557. type: string
  1558. aggregate_az_optional_update:
  1559. description: |
  1560. The availability zone of the host aggregate. You should use a custom
  1561. availability zone rather than the default returned by the
  1562. os-availability-zone API. The availability zone must not include ':'
  1563. in its name.
  1564. .. warning:: You should not change or unset the availability zone of an
  1565. aggregate when that aggregate has hosts which contain servers in it
  1566. since that may impact the ability for those servers to move to another
  1567. host.
  1568. in: body
  1569. required: false
  1570. type: string
  1571. aggregate_host_list:
  1572. description: |
  1573. A list of host ids in this aggregate.
  1574. in: body
  1575. required: true
  1576. type: array
  1577. aggregate_id_body:
  1578. description: |
  1579. The ID of the host aggregate.
  1580. in: body
  1581. required: true
  1582. type: integer
  1583. aggregate_metadata_request:
  1584. description: |
  1585. Metadata key and value pairs associated with the aggregate.
  1586. The maximum size for each metadata key and value pair is 255 bytes.
  1587. New keys will be added to existing aggregate metadata. For existing
  1588. keys, if the value is ``null`` the entry is removed, otherwise the
  1589. value is updated. Note that the special ``availability_zone`` metadata
  1590. entry cannot be unset to ``null``.
  1591. .. warning:: You should not change the availability zone of an
  1592. aggregate when that aggregate has hosts which contain servers in it
  1593. since that may impact the ability for those servers to move to another
  1594. host.
  1595. in: body
  1596. required: true
  1597. type: object
  1598. aggregate_metadata_response:
  1599. description: |
  1600. Metadata key and value pairs associated with the aggregate.
  1601. in: body
  1602. required: true
  1603. type: object
  1604. aggregate_name:
  1605. description: |
  1606. The name of the host aggregate.
  1607. in: body
  1608. required: true
  1609. type: string
  1610. aggregate_name_optional:
  1611. description: |
  1612. The name of the host aggregate.
  1613. in: body
  1614. required: false
  1615. type: string
  1616. aggregate_remove_host:
  1617. description: |
  1618. The add_host object used to remove host from aggregate.
  1619. in: body
  1620. required: true
  1621. type: object
  1622. aggregate_uuid:
  1623. description: |
  1624. The UUID of the host aggregate.
  1625. in: body
  1626. required: true
  1627. type: string
  1628. min_version: 2.41
  1629. aggregates:
  1630. description: |
  1631. The list of existing aggregates.
  1632. in: body
  1633. required: true
  1634. type: array
  1635. alias:
  1636. description: |
  1637. A short name by which this extension is also known.
  1638. in: body
  1639. required: true
  1640. type: string
  1641. alive:
  1642. description: |
  1643. Returns true if the instance is alive.
  1644. in: body
  1645. required: true
  1646. type: boolean
  1647. architecture:
  1648. description: |
  1649. The name of the cpu architecture.
  1650. in: body
  1651. required: true
  1652. type: string
  1653. associate_host:
  1654. description: |
  1655. The name of the host to associate.
  1656. in: body
  1657. required: true
  1658. type: string
  1659. attachment_device_resp:
  1660. description: |
  1661. Name of the device in the attachment object, such as, ``/dev/vdb``.
  1662. in: body
  1663. required: false
  1664. type: string
  1665. attachment_id_required:
  1666. description: |
  1667. The UUID of the attachment.
  1668. in: body
  1669. required: true
  1670. type: string
  1671. attachment_id_resp:
  1672. description: |
  1673. The UUID of the attachment.
  1674. in: body
  1675. required: false
  1676. type: string
  1677. attachment_server_id_resp:
  1678. description: |
  1679. The UUID of the server.
  1680. in: body
  1681. required: false
  1682. type: string
  1683. attachment_volumeId_resp:
  1684. description: |
  1685. The UUID of the attached volume.
  1686. in: body
  1687. required: false
  1688. type: string
  1689. availability_zone:
  1690. description: |
  1691. The availability zone.
  1692. in: body
  1693. required: false
  1694. type: string
  1695. availability_zone_info:
  1696. description: |
  1697. The list of availability zone information.
  1698. in: body
  1699. required: true
  1700. type: array
  1701. availability_zone_state:
  1702. description: |
  1703. The current state of the availability zone.
  1704. in: body
  1705. required: true
  1706. type: object
  1707. availability_zone_unshelve:
  1708. description: |
  1709. The availability zone name. Specifying an availability zone is only
  1710. allowed when the server status is ``SHELVED_OFFLOADED`` otherwise a
  1711. 409 HTTPConflict response is returned.
  1712. in: body
  1713. required: false
  1714. type: string
  1715. min_version: 2.77
  1716. available:
  1717. description: |
  1718. Returns true if the availability zone is available.
  1719. in: body
  1720. required: true
  1721. type: boolean
  1722. backup_name:
  1723. description: |
  1724. The name of the image to be backed up.
  1725. in: body
  1726. required: true
  1727. type: string
  1728. backup_rotation:
  1729. description: |
  1730. The rotation of the back up image, the oldest image will be removed when image count
  1731. exceed the rotation count.
  1732. in: body
  1733. required: true
  1734. type: integer
  1735. backup_type:
  1736. description: |
  1737. The type of the backup, for example, ``daily``.
  1738. in: body
  1739. required: true
  1740. type: string
  1741. baremetal_cpus:
  1742. description: |
  1743. Number of CPUs the node has.
  1744. .. note:: This is a JSON string, even though it will look like an int value.
  1745. in: body
  1746. required: true
  1747. type: string
  1748. baremetal_disk:
  1749. description: |
  1750. Amount of disk in GiB the node has.
  1751. .. note:: This is a JSON string, even though it will look like an int value.
  1752. in: body
  1753. required: true
  1754. type: string
  1755. baremetal_host:
  1756. description: |
  1757. This will always have the value ``IRONIC MANAGED``.
  1758. in: body
  1759. required: true
  1760. type: string
  1761. baremetal_id:
  1762. description: |
  1763. UUID of the baremetal node.
  1764. in: body
  1765. required: true
  1766. type: string
  1767. baremetal_instance_uuid:
  1768. description: |
  1769. UUID of the server instance on this node.
  1770. in: body
  1771. required: true
  1772. type: string
  1773. baremetal_interfaces:
  1774. description: |
  1775. A list of interface objects for active interfaces on the baremetal
  1776. node. Each will have an ``address`` field with the address.
  1777. in: body
  1778. required: true
  1779. type: array
  1780. baremetal_mem:
  1781. description: |
  1782. Amount of memory in MiB the node has.
  1783. .. note:: This is a JSON string, even though it will look like an int value.
  1784. in: body
  1785. required: true
  1786. type: string
  1787. baremetal_node:
  1788. description: |
  1789. A baremetal node object.
  1790. in: body
  1791. required: true
  1792. type: object
  1793. baremetal_nodes:
  1794. description: |
  1795. An array of baremetal node objects.
  1796. in: body
  1797. required: true
  1798. type: array
  1799. baremetal_taskstate:
  1800. description: |
  1801. The Ironic task state for the node. See Ironic project for more
  1802. details.
  1803. in: body
  1804. required: true
  1805. type: string
  1806. binary:
  1807. description: |
  1808. The binary name of the service.
  1809. in: body
  1810. required: true
  1811. type: string
  1812. block_device_mapping_v2:
  1813. description: |
  1814. Enables fine grained control of the block device mapping for an instance. This
  1815. is typically used for booting servers from volumes. An example format would look
  1816. as follows:
  1817. .. code-block:: javascript
  1818. "block_device_mapping_v2": [{
  1819. "boot_index": "0",
  1820. "uuid": "ac408821-c95a-448f-9292-73986c790911",
  1821. "source_type": "image",
  1822. "volume_size": "25",
  1823. "destination_type": "volume",
  1824. "delete_on_termination": true,
  1825. "tag": "disk1",
  1826. "disk_bus": "scsi"}]
  1827. In microversion 2.32, ``tag`` is an optional string attribute that can
  1828. be used to assign a tag to the block device. This tag is then exposed to
  1829. the guest in the metadata API and the config drive and is associated to
  1830. hardware metadata for that block device, such as bus (ex: SCSI), bus
  1831. address (ex: 1:0:2:0), and serial.
  1832. A bug has caused the ``tag`` attribute to no longer be accepted starting
  1833. with version 2.33. It has been restored in version 2.42.
  1834. in: body
  1835. required: false
  1836. type: array
  1837. block_device_uuid:
  1838. description: |
  1839. This is the uuid of source resource. The uuid points to different resources
  1840. based on the ``source_type``. For example, if ``source_type`` is ``image``,
  1841. the block device is created based on the specified image which is retrieved
  1842. from the image service. Similarly, if ``source_type`` is ``snapshot`` then
  1843. the uuid refers to a volume snapshot in the block storage service. If
  1844. ``source_type`` is ``volume`` then the uuid refers to a volume in the block
  1845. storage service.
  1846. in: body
  1847. required: false
  1848. type: string
  1849. block_migration:
  1850. description: |
  1851. Set to ``True`` to migrate local disks by using block migration. If the source
  1852. or destination host uses shared storage and you set this value to ``True``, the
  1853. live migration fails.
  1854. in: body
  1855. required: true
  1856. type: boolean
  1857. max_version: 2.24
  1858. block_migration_2_25:
  1859. description: |
  1860. Migrates local disks by using block migration. Set to ``auto`` which means
  1861. nova will detect whether source and destination hosts on shared storage. if they are
  1862. on shared storage, the live-migration won't be block migration. Otherwise the block
  1863. migration will be executed. Set to ``True``, means the request will fail when the
  1864. source or destination host uses shared storage. Set to ``False`` means the request
  1865. will fail when the source and destination hosts are not on the shared storage.
  1866. in: body
  1867. required: true
  1868. type: string
  1869. min_version: 2.25
  1870. boot_index:
  1871. description: |
  1872. Defines the order in which a hypervisor tries devices when it attempts to boot
  1873. the guest from storage. Give each device a unique boot index starting from ``0``.
  1874. To disable a device from booting, set the boot index to a negative value or use
  1875. the default boot index value, which is ``None``. The simplest usage is, set the
  1876. boot index of the boot device to ``0`` and use the default boot index value, ``None``,
  1877. for any other devices. Some hypervisors might not support booting from multiple
  1878. devices; these hypervisors consider only the device with a boot index of ``0``. Some
  1879. hypervisors support booting from multiple devices but only if the devices are
  1880. of different types. For example, a disk and CD-ROM.
  1881. in: body
  1882. required: true
  1883. type: integer
  1884. cache:
  1885. description: A list of image objects to cache.
  1886. in: body
  1887. required: true
  1888. type: array
  1889. certificate:
  1890. description: |
  1891. The certificate object.
  1892. in: body
  1893. required: true
  1894. type: object
  1895. changePassword:
  1896. description: |
  1897. The action to change an administrative password of the server.
  1898. in: body
  1899. required: true
  1900. type: object
  1901. cidr:
  1902. description: |
  1903. The CIDR for address range.
  1904. in: body
  1905. required: true
  1906. type: string
  1907. cloudpipe:
  1908. description: |
  1909. The cloudpipe object.
  1910. in: body
  1911. required: true
  1912. type: object
  1913. cloudpipes:
  1914. description: |
  1915. The list of cloudpipe objects.
  1916. in: body
  1917. required: true
  1918. type: array
  1919. code:
  1920. description: |
  1921. The HTTP response code for the event. The following codes are currently used:
  1922. * 200 - successfully submitted event
  1923. * 400 - the request is missing required parameter
  1924. * 404 - the instance specified by ``server_uuid`` was not found
  1925. * 422 - no host was found for the server specified by ``server_uuid``,
  1926. so there is no route to this server.
  1927. in: body
  1928. required: true
  1929. type: string
  1930. config_drive:
  1931. description: |
  1932. Indicates whether a config drive enables metadata injection. The config_drive
  1933. setting provides information about a drive that the instance can mount at boot
  1934. time. The instance reads files from the drive to get information that is normally
  1935. available through the metadata service. This metadata is different from the user
  1936. data. Not all cloud providers enable the ``config_drive``. Read more in the
  1937. `OpenStack End User Guide <https://docs.openstack.org/nova/latest/user/config-drive.html>`_.
  1938. in: body
  1939. required: false
  1940. type: boolean
  1941. config_drive_diagnostics:
  1942. description: |
  1943. Indicates whether or not a config drive was used for this server.
  1944. in: body
  1945. required: true
  1946. type: boolean
  1947. min_version: 2.48
  1948. config_drive_resp:
  1949. description: |
  1950. Indicates whether or not a config drive was used for this server.
  1951. The value is ``True`` or an empty string. An empty string stands for
  1952. ``False``.
  1953. in: body
  1954. required: true
  1955. type: string
  1956. config_drive_resp_update_rebuild:
  1957. description: |
  1958. Indicates whether or not a config drive was used for this server.
  1959. The value is ``True`` or an empty string. An empty string stands for
  1960. ``False``.
  1961. in: body
  1962. required: true
  1963. type: string
  1964. min_version: 2.75
  1965. configure_project_cloudpipe:
  1966. description: |
  1967. VPN IP and Port information to configure the cloudpipe instance..
  1968. in: body
  1969. required: true
  1970. type: object
  1971. confirmResize:
  1972. description: |
  1973. The action to confirm a resize operation.
  1974. in: body
  1975. required: true
  1976. type: none
  1977. console:
  1978. description: |
  1979. The console object.
  1980. in: body
  1981. required: true
  1982. type: object
  1983. console_host:
  1984. description: |
  1985. The name or ID of the host.
  1986. in: body
  1987. required: false
  1988. type: string
  1989. console_id_in_body:
  1990. description: |
  1991. The UUID of the console.
  1992. in: body
  1993. required: true
  1994. type: string
  1995. console_output:
  1996. description: |
  1997. The console output as a string. Control characters will be escaped
  1998. to create a valid JSON string.
  1999. in: body
  2000. required: true
  2001. type: string
  2002. console_password:
  2003. description: |
  2004. The password for the console.
  2005. in: body
  2006. required: true
  2007. type: string
  2008. console_type:
  2009. description: |
  2010. The type of the console.
  2011. in: body
  2012. required: true
  2013. type: string
  2014. consoles:
  2015. description: |
  2016. The list of console objects.
  2017. in: body
  2018. required: true
  2019. type: array
  2020. contents:
  2021. description: |
  2022. The file contents field in the personality object.
  2023. in: body
  2024. required: true
  2025. type: string
  2026. max_version: 2.56
  2027. cores: &cores
  2028. description: |
  2029. The number of allowed server cores for each tenant.
  2030. in: body
  2031. required: true
  2032. type: integer
  2033. cores_quota_class: &cores_quota_class
  2034. <<: *cores
  2035. description: |
  2036. The number of allowed server cores for the quota class.
  2037. cores_quota_class_optional:
  2038. <<: *cores_quota_class
  2039. required: false
  2040. cores_quota_details:
  2041. description: |
  2042. The object of detailed cores quota, including in_use, limit and
  2043. reserved number of cores.
  2044. in: body
  2045. required: true
  2046. type: object
  2047. cores_quota_optional:
  2048. description: |
  2049. The number of allowed server cores for each tenant.
  2050. in: body
  2051. required: false
  2052. type: integer
  2053. cpu_details_diagnostics:
  2054. description: |
  2055. The list of dictionaries with detailed information about VM CPUs.
  2056. Following fields are presented in each dictionary:
  2057. - ``id`` - the ID of CPU (Integer)
  2058. - ``time`` - CPU Time in nano seconds (Integer)
  2059. - ``utilisation`` - CPU utilisation in percents (Integer)
  2060. in: body
  2061. required: true
  2062. type: array
  2063. min_version: 2.48
  2064. cpu_info:
  2065. description: |
  2066. A dictionary that contains cpu information like ``arch``, ``model``,
  2067. ``vendor``, ``features`` and ``topology``. The content of this field is
  2068. hypervisor specific.
  2069. .. note::
  2070. Since version 2.28 ``cpu_info`` field is returned as a dictionary
  2071. instead of string.
  2072. in: body
  2073. required: true
  2074. type: object
  2075. create_info:
  2076. description: |
  2077. Information for snapshot creation.
  2078. in: body
  2079. required: true
  2080. type: object
  2081. create_info_id:
  2082. description: |
  2083. Its an arbitrary string that gets passed back to the user.
  2084. in: body
  2085. required: false
  2086. type: string
  2087. create_info_id_resp:
  2088. description: |
  2089. Its the same arbitrary string which was sent in request body.
  2090. .. note::
  2091. This string is passed back to user as it is and not being
  2092. used in Nova internally. So use ``snapshot_id`` instead for further
  2093. operation on this snapshot.
  2094. in: body
  2095. required: true
  2096. type: string
  2097. createBackup:
  2098. description: |
  2099. The action.
  2100. in: body
  2101. required: true
  2102. type: object
  2103. created:
  2104. description: |
  2105. The date and time when the resource was created. The date and time
  2106. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  2107. ::
  2108. CCYY-MM-DDThh:mm:ss±hh:mm
  2109. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  2110. value, if included, is the time zone as an offset from UTC. In
  2111. the previous example, the offset value is ``-05:00``.
  2112. in: body
  2113. required: true
  2114. type: string
  2115. createImage:
  2116. description: |
  2117. The action to create a snapshot of the image or
  2118. the volume(s) of the server.
  2119. in: body
  2120. required: true
  2121. type: object
  2122. current_workload:
  2123. description: |
  2124. The current_workload is the number of tasks the hypervisor is responsible for. This will be
  2125. equal or greater than the number of active VMs on the system (it can be greater when VMs
  2126. are being deleted and the hypervisor is still cleaning up).
  2127. in: body
  2128. required: true
  2129. type: integer
  2130. data:
  2131. description: |
  2132. The certificate.
  2133. in: body
  2134. required: true
  2135. type: string
  2136. delete_on_termination:
  2137. description: |
  2138. To delete the boot volume when the server is destroyed, specify ``true``.
  2139. Otherwise, specify ``false``. Default: ``false``
  2140. in: body
  2141. required: false
  2142. type: boolean
  2143. delete_on_termination_attachments_req:
  2144. description: |
  2145. To delete the attached volume when the server is destroyed, specify ``true``.
  2146. Otherwise, specify ``false``. Default: ``false``
  2147. in: body
  2148. required: false
  2149. type: boolean
  2150. min_version: 2.79
  2151. delete_on_termination_attachments_resp:
  2152. description: |
  2153. A flag indicating if the attached volume will be deleted when the server is
  2154. deleted.
  2155. in: body
  2156. required: true
  2157. type: boolean
  2158. min_version: 2.79
  2159. deleted:
  2160. description: |
  2161. A boolean indicates whether this aggregate is deleted or not, if it has
  2162. not been deleted, ``false`` will appear.
  2163. in: body
  2164. required: true
  2165. type: boolean
  2166. deleted_at:
  2167. description: |
  2168. The date and time when the resource was deleted. If the resource has
  2169. not been deleted yet, this field will be ``null``, The date and time
  2170. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  2171. ::
  2172. CCYY-MM-DDThh:mm:ss±hh:mm
  2173. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  2174. value, if included, is the time zone as an offset from UTC. In
  2175. the previous example, the offset value is ``-05:00``.
  2176. in: body
  2177. required: true
  2178. type: string
  2179. description:
  2180. description: |
  2181. Security group description.
  2182. in: body
  2183. required: true
  2184. type: string
  2185. destination_type:
  2186. description: |
  2187. Defines where the block device mapping will reside. Valid values are:
  2188. * ``local``: The ephemeral disk resides local to the compute host on
  2189. which the server runs
  2190. * ``volume``: The persistent volume is stored in the block storage service
  2191. in: body
  2192. required: false
  2193. type: string
  2194. device:
  2195. description: |
  2196. Name of the device such as, ``/dev/vdb``. Omit or set this parameter to null for
  2197. auto-assignment, if supported. If you specify this parameter, the device must
  2198. not exist in the guest operating system. Note that as of the 12.0.0 Liberty release,
  2199. the Nova libvirt driver no longer honors a user-supplied device name. This is
  2200. the same behavior as if the device name parameter is not supplied on the request.
  2201. in: body
  2202. required: false
  2203. type: string
  2204. device_name:
  2205. description: |
  2206. A path to the device for the volume that you want to use to boot the server.
  2207. Note that as of the 12.0.0 Liberty release, the Nova libvirt driver no
  2208. longer honors a user-supplied device name. This is the same behavior as if
  2209. the device name parameter is not supplied on the request.
  2210. in: body
  2211. required: false
  2212. type: string
  2213. device_resp:
  2214. description: |
  2215. Name of the device such as, ``/dev/vdb``.
  2216. in: body
  2217. required: true
  2218. type: string
  2219. device_tag_bdm:
  2220. description: |
  2221. A device role tag that can be applied to a block device. The guest OS of a
  2222. server that has devices tagged in this manner can access hardware metadata
  2223. about the tagged devices from the metadata API and on the config drive, if
  2224. enabled.
  2225. .. note:: Due to a bug, block device tags are accepted in version 2.32 and
  2226. subsequently starting with version 2.42.
  2227. in: body
  2228. required: false
  2229. type: string
  2230. min_version: 2.32
  2231. device_tag_bdm_attachment:
  2232. description: |
  2233. A device role tag that can be applied to a volume when attaching it to the
  2234. VM. The guest OS of a server that has devices tagged in this manner can
  2235. access hardware metadata about the tagged devices from the metadata API and
  2236. on the config drive, if enabled.
  2237. .. note:: Tagged volume attachment is not supported for shelved-offloaded
  2238. instances.
  2239. in: body
  2240. required: false
  2241. type: string
  2242. min_version: 2.49
  2243. device_tag_bdm_attachment_resp:
  2244. description: |
  2245. The device tag applied to the volume block device or ``null``.
  2246. in: body
  2247. required: true
  2248. type: string
  2249. min_version: 2.70
  2250. device_tag_nic:
  2251. description: |
  2252. A device role tag that can be applied to a network interface. The guest OS
  2253. of a server that has devices tagged in this manner can access hardware
  2254. metadata about the tagged devices from the metadata API and on the config
  2255. drive, if enabled.
  2256. .. note:: Due to a bug, network interface tags are accepted between 2.32
  2257. and 2.36 inclusively, and subsequently starting with version 2.42.
  2258. in: body
  2259. required: false
  2260. type: string
  2261. min_version: 2.32
  2262. device_tag_nic_attachment:
  2263. description: |
  2264. A device role tag that can be applied to a network interface when attaching
  2265. it to the VM. The guest OS of a server that has devices tagged in this
  2266. manner can access hardware metadata about the tagged devices from the
  2267. metadata API and on the config
  2268. drive, if enabled.
  2269. in: body
  2270. required: false
  2271. type: string
  2272. min_version: 2.49
  2273. device_tag_nic_attachment_resp:
  2274. description: |
  2275. The device tag applied to the virtual network interface or ``null``.
  2276. in: body
  2277. required: true
  2278. type: string
  2279. min_version: 2.70
  2280. device_type:
  2281. description: |
  2282. The device type. For example, ``disk``, ``cdrom``.
  2283. in: body
  2284. required: false
  2285. type: string
  2286. device_volume_type:
  2287. description: |
  2288. The device ``volume_type``. This can be used to specify the type of volume
  2289. which the compute service will create and attach to the server.
  2290. If not specified, the block storage service will provide a default volume
  2291. type. See the `block storage volume types API <https://docs.openstack.org/api-ref/block-storage/v3/#volume-types-types>`_
  2292. for more details.
  2293. There are some restrictions on ``volume_type``:
  2294. - It can be a volume type ID or name.
  2295. - It is only supported with ``source_type`` of ``blank``, ``image`` or
  2296. ``snapshot``.
  2297. - It is only supported with ``destination_type`` of ``volume``.
  2298. in: body
  2299. required: false
  2300. type: string
  2301. min_version: 2.67
  2302. # Optional input parameter in the body for PUT /os-services/{service_id} added
  2303. # in microversion 2.53.
  2304. disabled_reason_2_53_in:
  2305. description: |
  2306. The reason for disabling a service. The minimum length is 1 and the
  2307. maximum length is 255. This may only be requested with ``status=disabled``.
  2308. in: body
  2309. required: false
  2310. type: string
  2311. disabled_reason_body:
  2312. description: |
  2313. The reason for disabling a service.
  2314. in: body
  2315. required: true
  2316. type: string
  2317. disk_available_least:
  2318. description: |
  2319. The actual free disk on this hypervisor(in GiB). If allocation ratios used
  2320. for overcommit are configured, this may be negative. This is intentional as
  2321. it provides insight into the amount by which the disk is overcommitted.
  2322. in: body
  2323. required: true
  2324. type: integer
  2325. disk_available_least_total:
  2326. description: |
  2327. The actual free disk on all hypervisors(in GiB). If allocation ratios used
  2328. for overcommit are configured, this may be negative. This is intentional as
  2329. it provides insight into the amount by which the disk is overcommitted.
  2330. in: body
  2331. required: true
  2332. type: integer
  2333. disk_bus:
  2334. description: |
  2335. Disk bus type, some hypervisors (currently only libvirt) support
  2336. specify this parameter. Some example disk_bus values can be: `ide`,
  2337. `usb`, `virtio`, `scsi`. This is not an exhaustive list as it depends
  2338. on the virtualization driver, and may change as more support is added.
  2339. in: body
  2340. required: false
  2341. type: string
  2342. disk_config:
  2343. description: |
  2344. Disk configuration. The value is either:
  2345. - ``AUTO``. The API builds the server with a single partition the size of
  2346. the target flavor disk. The API automatically adjusts the file system to
  2347. fit the entire partition.
  2348. - ``MANUAL``. The API builds the server by using the partition scheme and
  2349. file system that is in the source image. If the target flavor disk is
  2350. larger, The API does not partition the remaining disk space.
  2351. in: body
  2352. required: true
  2353. type: string
  2354. disk_details_diagnostics:
  2355. description: |
  2356. The list of dictionaries with detailed information about VM disks.
  2357. Following fields are presented in each dictionary:
  2358. - ``read_bytes`` - Disk reads in bytes (Integer)
  2359. - ``read_requests`` - Read requests (Integer)
  2360. - ``write_bytes`` - Disk writes in bytes (Integer)
  2361. - ``write_requests`` - Write requests (Integer)
  2362. - ``errors_count`` - Disk errors (Integer)
  2363. in: body
  2364. required: true
  2365. type: array
  2366. min_version: 2.48
  2367. disk_over_commit:
  2368. description: |
  2369. Set to ``True`` to enable over commit when the destination host is checked for
  2370. available disk space. Set to ``False`` to disable over commit. This setting affects
  2371. only the libvirt virt driver.
  2372. in: body
  2373. required: true
  2374. type: boolean
  2375. max_version: 2.25
  2376. display_description:
  2377. description: |
  2378. The volume description.
  2379. in: body
  2380. required: true
  2381. type: string
  2382. display_description_optional:
  2383. description: |
  2384. The volume description.
  2385. in: body
  2386. required: false
  2387. type: string
  2388. display_name:
  2389. description: |
  2390. The volume name.
  2391. in: body
  2392. required: true
  2393. type: string
  2394. display_name_optional:
  2395. description: |
  2396. The volume name.
  2397. in: body
  2398. required: false
  2399. type: string
  2400. driver_diagnostics:
  2401. description: |
  2402. The driver on which the VM is running. Possible values are:
  2403. - ``libvirt``
  2404. - ``xenapi``
  2405. - ``hyperv``
  2406. - ``vmwareapi``
  2407. - ``ironic``
  2408. in: body
  2409. required: true
  2410. type: string
  2411. min_version: 2.48
  2412. ended_at:
  2413. description: |
  2414. The date and time when the server was deleted.
  2415. The date and time stamp format is as follows:
  2416. ::
  2417. CCYY-MM-DDThh:mm:ss.NNNNNN
  2418. For example, ``2015-08-27T09:49:58.123456``.
  2419. If the server hasn't been deleted yet, its value is ``null``.
  2420. in: body
  2421. required: true
  2422. type: string
  2423. ended_at_optional:
  2424. description: |
  2425. The date and time when the server was deleted.
  2426. The date and time stamp format is as follows:
  2427. ::
  2428. CCYY-MM-DDThh:mm:ss.NNNNNN
  2429. For example, ``2015-08-27T09:49:58.123456``.
  2430. If the server hasn't been deleted yet, its value is ``null``.
  2431. in: body
  2432. required: false
  2433. type: string
  2434. errors:
  2435. description: |
  2436. The number of errors.
  2437. in: body
  2438. required: true
  2439. type: integer
  2440. evacuate:
  2441. description: |
  2442. The action to evacuate a server to another host.
  2443. in: body
  2444. required: true
  2445. type: object
  2446. event:
  2447. description: |
  2448. The name of the event.
  2449. in: body
  2450. required: true
  2451. type: string
  2452. event_finish_time:
  2453. description: |
  2454. The date and time when the event was finished. The date and time
  2455. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  2456. ::
  2457. CCYY-MM-DDThh:mm:ss±hh:mm
  2458. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  2459. value, if included, is the time zone as an offset from UTC. In
  2460. the previous example, the offset value is ``-05:00``.
  2461. in: body
  2462. required: true
  2463. type: string
  2464. event_host:
  2465. min_version: 2.62
  2466. description: |
  2467. The name of the host on which the event occurred.
  2468. Policy defaults enable only users with the administrative role to see
  2469. an instance action event host. Cloud providers can change these
  2470. permissions through the ``policy.json`` file.
  2471. in: body
  2472. required: false
  2473. type: string
  2474. event_hostId:
  2475. min_version: 2.62
  2476. description: |
  2477. An obfuscated hashed host ID string, or the empty string if there is no
  2478. host for the event. This is a hashed value so will not actually look like
  2479. a hostname, and is hashed with data from the project_id, so the same
  2480. physical host as seen by two different project_ids will be different.
  2481. This is useful when within the same project you need to determine if two
  2482. events occurred on the same or different physical hosts.
  2483. in: body
  2484. required: true
  2485. type: string
  2486. event_name:
  2487. description: |
  2488. The event name. A valid value is:
  2489. - ``network-changed``
  2490. - ``network-vif-plugged``
  2491. - ``network-vif-unplugged``
  2492. - ``network-vif-deleted``
  2493. - ``volume-extended`` (since microversion ``2.51``)
  2494. - ``power-update`` (since microversion ``2.76``)
  2495. in: body
  2496. required: true
  2497. type: string
  2498. event_result:
  2499. description: |
  2500. The result of the event.
  2501. in: body
  2502. required: true
  2503. type: string
  2504. event_start_time:
  2505. description: |
  2506. The date and time when the event was started. The date and time
  2507. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  2508. ::
  2509. CCYY-MM-DDThh:mm:ss±hh:mm
  2510. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  2511. value, if included, is the time zone as an offset from UTC. In
  2512. the previous example, the offset value is ``-05:00``.
  2513. in: body
  2514. required: true
  2515. type: string
  2516. event_status:
  2517. description: |
  2518. The event status. A valid value is ``failed``, ``completed``, or ``in-progress``.
  2519. Default is ``completed``.
  2520. in: body
  2521. required: false
  2522. type: string
  2523. event_tag:
  2524. description: |
  2525. A string value that identifies the event. Certain types of events require
  2526. specific tags:
  2527. - For the ``power-update`` event the tag must be either be ``POWER_ON``
  2528. or ``POWER_OFF``.
  2529. - For the ``volume-extended`` event the tag must be the volume id.
  2530. in: body
  2531. required: false
  2532. type: string
  2533. event_traceback:
  2534. description: |
  2535. The traceback stack if an error occurred in this event.
  2536. Policy defaults enable only users with the administrative role to see
  2537. an instance action event traceback. Cloud providers can change these
  2538. permissions through the ``policy.json`` file.
  2539. in: body
  2540. required: true
  2541. type: string
  2542. events:
  2543. description: |
  2544. List of external events to process.
  2545. in: body
  2546. required: true
  2547. type: array
  2548. extension:
  2549. description: |
  2550. An ``extension`` object.
  2551. in: body
  2552. required: true
  2553. type: object
  2554. extension_description:
  2555. description: |
  2556. Text describing this extension's purpose.
  2557. in: body
  2558. required: true
  2559. type: string
  2560. extension_links:
  2561. description: |
  2562. Links pertaining to this extension. This is a list of dictionaries, each including
  2563. keys ``href`` and ``rel``.
  2564. in: body
  2565. required: true
  2566. type: array
  2567. extension_name:
  2568. description: |
  2569. Name of the extension.
  2570. in: body
  2571. required: true
  2572. type: string
  2573. extensions:
  2574. description: |
  2575. List of ``extension`` objects.
  2576. in: body
  2577. required: true
  2578. type: array
  2579. extra_specs:
  2580. description: |
  2581. A dictionary of the flavor's extra-specs key-and-value pairs. It appears
  2582. in the os-extra-specs' "create" REQUEST body, as well as the
  2583. os-extra-specs' "create" and "list" RESPONSE body.
  2584. in: body
  2585. required: true
  2586. type: object
  2587. extra_specs_2_47:
  2588. min_version: 2.47
  2589. description: |
  2590. A dictionary of the flavor's extra-specs key-and-value pairs. This will
  2591. only be included if the user is allowed by policy to index flavor
  2592. extra_specs.
  2593. in: body
  2594. required: false
  2595. type: object
  2596. extra_specs_2_61:
  2597. min_version: 2.61
  2598. description: |
  2599. A dictionary of the flavor's extra-specs key-and-value pairs. This will
  2600. only be included if the user is allowed by policy to index flavor
  2601. extra_specs.
  2602. in: body
  2603. required: false
  2604. type: object
  2605. fault:
  2606. description: |
  2607. A fault object. Only displayed when the server status is ``ERROR`` or
  2608. ``DELETED`` and a fault occurred.
  2609. in: body
  2610. required: false
  2611. type: object
  2612. fault_code:
  2613. description: |
  2614. The error response code.
  2615. in: body
  2616. required: true
  2617. type: integer
  2618. fault_created:
  2619. description: |
  2620. The date and time when the exception was raised. The date and time
  2621. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  2622. ::
  2623. CCYY-MM-DDThh:mm:ss±hh:mm
  2624. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  2625. value, if included, is the time zone as an offset from UTC. In
  2626. the previous example, the offset value is ``-05:00``.
  2627. in: body
  2628. required: true
  2629. type: string
  2630. fault_details:
  2631. description: |
  2632. The stack trace. It is available if the response code is not 500 or
  2633. you have the administrator privilege
  2634. in: body
  2635. required: false
  2636. type: string
  2637. fault_message:
  2638. description: |
  2639. The error message.
  2640. in: body
  2641. required: true
  2642. type: string
  2643. fixed_address:
  2644. description: |
  2645. The fixed IP address with which you want to associate the floating IP address.
  2646. in: body
  2647. required: false
  2648. type: string
  2649. fixed_ip:
  2650. description: |
  2651. A fixed IPv4 address for the NIC. Valid with a ``neutron`` or ``nova-networks``
  2652. network.
  2653. in: body
  2654. required: false
  2655. type: string
  2656. fixed_ip_address:
  2657. description: |
  2658. Fixed IP associated with floating IP network.
  2659. in: body
  2660. required: true
  2661. type: string
  2662. fixed_ip_host:
  2663. description: |
  2664. The hostname of the host that manages the server that is associated with
  2665. this fixed IP address.
  2666. in: body
  2667. required: true
  2668. type: string
  2669. fixed_ip_hostname:
  2670. description: |
  2671. The hostname of the server that is associated with this fixed IP address.
  2672. in: body
  2673. required: true
  2674. type: string
  2675. fixed_ip_obj:
  2676. description: |
  2677. A fixed IP address object.
  2678. in: body
  2679. required: true
  2680. type: object
  2681. fixed_ips:
  2682. description: |
  2683. Fixed IP addresses. If you request a specific fixed IP address without
  2684. a ``net_id``, the request returns a ``Bad Request (400)`` response code.
  2685. in: body
  2686. required: false
  2687. type: array
  2688. fixed_ips_quota:
  2689. description: |
  2690. The number of allowed fixed IP addresses for each tenant. Must be equal to or
  2691. greater than the number of allowed servers.
  2692. in: body
  2693. required: true
  2694. type: integer
  2695. max_version: 2.35
  2696. fixed_ips_quota_class: &fixed_ips_quota_class
  2697. description: |
  2698. The number of allowed fixed IP addresses for the quota class. Must be
  2699. equal to or greater than the number of allowed servers.
  2700. in: body
  2701. required: true
  2702. type: integer
  2703. max_version: 2.49
  2704. fixed_ips_quota_class_optional:
  2705. <<: *fixed_ips_quota_class
  2706. required: false
  2707. fixed_ips_quota_details:
  2708. description: |
  2709. The object of detailed fixed ips quota, including in_use, limit and
  2710. reserved number of fixed ips.
  2711. in: body
  2712. required: true
  2713. type: object
  2714. max_version: 2.35
  2715. fixed_ips_quota_optional:
  2716. description: |
  2717. The number of allowed fixed IP addresses for each tenant. Must be equal to or
  2718. greater than the number of allowed servers.
  2719. in: body
  2720. required: false
  2721. type: integer
  2722. max_version: 2.35
  2723. fixed_ips_resp:
  2724. description: |
  2725. Fixed IP addresses with subnet IDs.
  2726. in: body
  2727. required: true
  2728. type: array
  2729. flavor:
  2730. description: |
  2731. The ID and links for the flavor for your server instance. A flavor is a combination
  2732. of memory, disk size, and CPUs.
  2733. in: body
  2734. required: true
  2735. type: object
  2736. flavor_access:
  2737. description: |
  2738. A list of objects, each with the keys ``flavor_id`` and ``tenant_id``.
  2739. in: body
  2740. required: true
  2741. type: array
  2742. flavor_cpus:
  2743. in: body
  2744. required: true
  2745. type: integer
  2746. description: |
  2747. The number of virtual CPUs that will be allocated to the server.
  2748. flavor_cpus_2_47:
  2749. min_version: 2.47
  2750. in: body
  2751. required: true
  2752. type: integer
  2753. description: |
  2754. The number of virtual CPUs that were allocated to the server.
  2755. flavor_description:
  2756. type: string
  2757. in: body
  2758. required: false
  2759. min_version: 2.55
  2760. description: |
  2761. A free form description of the flavor. Limited to 65535 characters
  2762. in length. Only printable characters are allowed.
  2763. flavor_description_required:
  2764. type: string
  2765. in: body
  2766. required: true
  2767. description: |
  2768. A free form description of the flavor. Limited to 65535 characters
  2769. in length. Only printable characters are allowed.
  2770. flavor_description_resp:
  2771. description: |
  2772. The description of the flavor.
  2773. in: body
  2774. required: true
  2775. type: string
  2776. min_version: 2.55
  2777. flavor_description_resp_no_min:
  2778. description: |
  2779. The description of the flavor.
  2780. in: body
  2781. required: true
  2782. type: string
  2783. flavor_disabled:
  2784. in: body
  2785. required: false
  2786. type: boolean
  2787. description: |
  2788. Whether or not the flavor has been administratively disabled.
  2789. This is typically only visible to administrative users.
  2790. flavor_disk:
  2791. in: body
  2792. required: true
  2793. type: integer
  2794. description: |
  2795. The size of the root disk that will be created in GiB. If 0 the
  2796. root disk will be set to exactly the size of the image used to
  2797. deploy the instance. However, in this case filter scheduler cannot
  2798. select the compute host based on the virtual image size. Therefore,
  2799. 0 should only be used for volume booted instances or for testing
  2800. purposes. Volume-backed instances can be enforced for flavors with
  2801. zero root disk via the ``os_compute_api:servers:create:zero_disk_flavor``
  2802. policy rule.
  2803. flavor_disk_2_47:
  2804. min_version: 2.47
  2805. in: body
  2806. required: true
  2807. type: integer
  2808. description: |
  2809. The size of the root disk that was created in GiB.
  2810. flavor_ephem_disk:
  2811. in: body
  2812. required: true
  2813. type: integer
  2814. description: |
  2815. The size of the ephemeral disk that will be created, in
  2816. GiB. Ephemeral disks may be written over on server state
  2817. changes. So should only be used as a scratch space for
  2818. applications that are aware of its limitations. Defaults to 0.
  2819. flavor_ephem_disk_2_47:
  2820. min_version: 2.47
  2821. in: body
  2822. required: true
  2823. type: integer
  2824. description: |
  2825. The size of the ephemeral disk that was created, in GiB.
  2826. flavor_ephem_disk_in:
  2827. in: body
  2828. required: false
  2829. type: integer
  2830. description: |
  2831. The size of the ephemeral disk that will be created, in
  2832. GiB. Ephemeral disks may be written over on server state
  2833. changes. So should only be used as a scratch space for
  2834. applications that are aware of its limitations. Defaults to 0.
  2835. flavor_extra_spec_key2:
  2836. description: |
  2837. The extra spec key of a flavor. It appears in the os-extra-specs'
  2838. "create" and "update" REQUEST body, as well as the os-extra-specs'
  2839. "create", "list", "show", and "update" RESPONSE body.
  2840. in: body
  2841. required: true
  2842. type: string
  2843. flavor_extra_spec_key_2_47:
  2844. description: |
  2845. The extra spec key of a flavor.
  2846. in: body
  2847. required: true
  2848. type: string
  2849. min_version: 2.47
  2850. flavor_extra_spec_value:
  2851. description: |
  2852. The extra spec value of a flavor. It appears in the os-extra-specs'
  2853. "create" and "update" REQUEST body, as well as the os-extra-specs'
  2854. "create", "list", "show", and "update" RESPONSE body.
  2855. in: body
  2856. required: true
  2857. type: string
  2858. flavor_extra_spec_value_2_47:
  2859. description: |
  2860. The extra spec value of a flavor.
  2861. in: body
  2862. required: true
  2863. type: string
  2864. min_version: 2.47
  2865. flavor_id_body:
  2866. description: |
  2867. The ID of the flavor. While people often make this look like
  2868. an int, this is really a string.
  2869. in: body
  2870. required: true
  2871. type: string
  2872. flavor_id_body_2_46:
  2873. description: |
  2874. The ID of the flavor. While people often make this look like
  2875. an int, this is really a string.
  2876. in: body
  2877. required: true
  2878. type: string
  2879. max_version: 2.46
  2880. flavor_id_body_create:
  2881. description: |
  2882. The ID of the flavor. While people often make this look like an int, this
  2883. is really a string. If not provided, this defaults to a uuid.
  2884. in: body
  2885. required: false
  2886. type: string
  2887. flavor_is_public:
  2888. description: |
  2889. Whether the flavor is public (available to all projects) or scoped
  2890. to a set of projects. Default is True if not specified.
  2891. in: body
  2892. required: true
  2893. type: boolean
  2894. flavor_is_public_in:
  2895. description: |
  2896. Whether the flavor is public (available to all projects) or scoped
  2897. to a set of projects. Default is True if not specified.
  2898. in: body
  2899. required: false
  2900. type: boolean
  2901. flavor_links_2_46:
  2902. description: |
  2903. Links to the flavor resource. See `API Guide / Links and
  2904. References
  2905. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  2906. for more info.
  2907. in: body
  2908. required: true
  2909. type: array
  2910. max_version: 2.46
  2911. flavor_name:
  2912. description: |
  2913. The display name of a flavor.
  2914. in: body
  2915. required: true
  2916. type: string
  2917. flavor_name_optional:
  2918. description: |
  2919. The display name of a flavor.
  2920. in: body
  2921. required: false
  2922. type: string
  2923. flavor_original_name:
  2924. description: |
  2925. The display name of a flavor.
  2926. in: body
  2927. required: true
  2928. type: string
  2929. min_version: 2.47
  2930. flavor_ram:
  2931. description: |
  2932. The amount of RAM a flavor has, in MiB.
  2933. in: body
  2934. required: true
  2935. type: integer
  2936. flavor_ram_2_47:
  2937. description: |
  2938. The amount of RAM a flavor has, in MiB.
  2939. in: body
  2940. required: true
  2941. type: integer
  2942. min_version: 2.47
  2943. flavor_rxtx_factor:
  2944. description: |
  2945. The receive / transmit factor (as a float) that will be set on
  2946. ports if the network backend supports the QOS extension.
  2947. Otherwise it will be ignored. It defaults to 1.0.
  2948. in: body
  2949. required: true
  2950. type: float
  2951. flavor_rxtx_factor_in:
  2952. description: |
  2953. The receive / transmit factor (as a float) that will be set on
  2954. ports if the network backend supports the QOS extension.
  2955. Otherwise it will be ignored. It defaults to 1.0.
  2956. in: body
  2957. required: false
  2958. type: float
  2959. flavor_server:
  2960. description: |
  2961. Before microversion 2.47 this contains the ID and links for the flavor
  2962. used to boot the server instance. This can be an empty object in case
  2963. flavor information is no longer present in the system.
  2964. As of microversion 2.47 this contains a subset of the actual flavor
  2965. information used to create the server instance, represented as a nested
  2966. dictionary.
  2967. in: body
  2968. required: true
  2969. type: object
  2970. flavor_swap:
  2971. description: |
  2972. The size of a dedicated swap disk that will be allocated, in
  2973. MiB. If 0 (the default), no dedicated swap disk will be created.
  2974. Currently, the empty string ('') is used to represent 0.
  2975. As of microversion 2.75 default return value of swap is 0
  2976. instead of empty string.
  2977. in: body
  2978. required: true
  2979. type: integer
  2980. flavor_swap_2_47:
  2981. description: |
  2982. The size of a dedicated swap disk that was allocated, in MiB.
  2983. in: body
  2984. required: true
  2985. type: integer
  2986. min_version: 2.47
  2987. flavor_swap_in:
  2988. description: |
  2989. The size of a dedicated swap disk that will be allocated, in
  2990. MiB. If 0 (the default), no dedicated swap disk will be created.
  2991. in: body
  2992. required: false
  2993. type: integer
  2994. flavorRef:
  2995. description: |
  2996. The flavor reference, as an ID (including a UUID) or full URL,
  2997. for the flavor for your server instance.
  2998. in: body
  2999. required: true
  3000. type: string
  3001. flavorRef_resize:
  3002. description: |
  3003. The flavor ID for resizing the server. The size of the disk in the flavor
  3004. being resized to must be greater than or equal to the size of the disk in
  3005. the current flavor.
  3006. If a specified flavor ID is the same as the current one of the server,
  3007. the request returns a ``Bad Request (400)`` response code.
  3008. in: body
  3009. required: true
  3010. type: string
  3011. flavors:
  3012. description: |
  3013. An array of flavor objects.
  3014. in: body
  3015. required: true
  3016. type: array
  3017. floating_ip:
  3018. description: |
  3019. The floating ip address.
  3020. in: body
  3021. required: true
  3022. type: string
  3023. floating_ip_bulk_object:
  3024. description: |
  3025. The floating ip bulk address object.
  3026. in: body
  3027. required: true
  3028. type: object
  3029. floating_ip_id_value:
  3030. description: |
  3031. The floating IP id value.
  3032. .. note::
  3033. For nova-network, the value will be of type integer, whereas for
  3034. neutron, the value will be of type string.
  3035. in: body
  3036. required: true
  3037. type: string
  3038. floating_ip_obj:
  3039. description: |
  3040. A floating IP address object.
  3041. in: body
  3042. required: true
  3043. type: object
  3044. floating_ip_pool_name:
  3045. description: |
  3046. The name of the floating ip pool.
  3047. in: body
  3048. required: true
  3049. type: string
  3050. floating_ip_pool_name_optional:
  3051. description: |
  3052. The name of the floating ip pool
  3053. in: body
  3054. required: false
  3055. type: string
  3056. floating_ip_pools:
  3057. description: |
  3058. The ``floating_ip_pools`` object.
  3059. in: body
  3060. required: true
  3061. type: array
  3062. floating_ips:
  3063. description: |
  3064. The number of allowed floating IP addresses for each tenant.
  3065. in: body
  3066. required: true
  3067. type: integer
  3068. max_version: 2.35
  3069. floating_ips_list:
  3070. description: |
  3071. An array of floating ip objects.
  3072. in: body
  3073. required: true
  3074. type: array
  3075. floating_ips_quota_class: &floating_ips_quota_class
  3076. description: |
  3077. The number of allowed floating IP addresses for the quota class.
  3078. in: body
  3079. required: true
  3080. type: integer
  3081. max_version: 2.49
  3082. floating_ips_quota_class_optional:
  3083. <<: *floating_ips_quota_class
  3084. required: false
  3085. floating_ips_quota_details:
  3086. description: |
  3087. The object of detailed floating ips quota, including in_use, limit and
  3088. reserved number of floating ips.
  3089. in: body
  3090. required: true
  3091. type: object
  3092. max_version: 2.35
  3093. floating_ips_quota_optional:
  3094. description: |
  3095. The number of allowed floating IP addresses for each tenant.
  3096. in: body
  3097. required: false
  3098. type: integer
  3099. max_version: 2.35
  3100. force:
  3101. description: |
  3102. You can force the update even if the quota has already been used and the reserved
  3103. quota exceeds the new quota. To force the update, specify the ``"force": "True"``.
  3104. Default is ``False``.
  3105. in: body
  3106. required: false
  3107. type: boolean
  3108. force_evacuate:
  3109. description: |
  3110. Force an evacuation by not verifying the provided destination host by the
  3111. scheduler.
  3112. .. warning:: This could result in failures to actually evacuate the
  3113. instance to the specified host. It is recommended to either not specify
  3114. a host so that the scheduler will pick one, or specify a host without
  3115. ``force=True`` set.
  3116. Furthermore, this should not be specified when evacuating instances
  3117. managed by a clustered hypervisor driver like ironic since you
  3118. cannot specify a node, so the compute service will pick a node randomly
  3119. which may not be able to accomodate the instance.
  3120. in: body
  3121. required: false
  3122. type: boolean
  3123. min_version: 2.29
  3124. max_version: 2.67
  3125. force_live_migrate:
  3126. description: |
  3127. Force a live-migration by not verifying the provided destination host by
  3128. the scheduler.
  3129. .. warning:: This could result in failures to actually live migrate the
  3130. instance to the specified host. It is recommended to either not specify
  3131. a host so that the scheduler will pick one, or specify a host without
  3132. ``force=True`` set.
  3133. in: body
  3134. required: false
  3135. type: boolean
  3136. min_version: 2.30
  3137. max_version: 2.67
  3138. force_migration_complete:
  3139. description: |
  3140. The action to force an in-progress live migration to complete.
  3141. in: body
  3142. required: true
  3143. type: none
  3144. force_snapshot:
  3145. description: |
  3146. Indicates whether to create a snapshot, even if the volume is attached.
  3147. in: body
  3148. required: false
  3149. type: boolean
  3150. # This is both the request and response parameter for
  3151. # PUT /os-services/force-down which was added in 2.11.
  3152. forced_down_2_11:
  3153. description: |
  3154. Whether or not this service was forced down manually by an
  3155. administrator after the service was fenced. This value is useful
  3156. to know that some 3rd party has verified the service should be
  3157. marked down.
  3158. in: body
  3159. required: true
  3160. type: boolean
  3161. min_version: 2.11
  3162. # This is the optional request input parameter for
  3163. # PUT /os-services/{service_id} added in 2.53.
  3164. forced_down_2_53_in:
  3165. description: |
  3166. ``forced_down`` is a manual override to tell nova that the service in
  3167. question has been fenced manually by the operations team (either hard
  3168. powered off, or network unplugged). That signals that it is safe to proceed
  3169. with ``evacuate`` or other operations that nova has safety checks to
  3170. prevent for hosts that are up.
  3171. .. warning::
  3172. Setting a service forced down without completely fencing it will likely
  3173. result in the corruption of VMs on that host.
  3174. in: body
  3175. required: false
  3176. type: boolean
  3177. # This is the response output parameter for
  3178. # PUT /os-services/{service_id} added in 2.53.
  3179. forced_down_2_53_out:
  3180. description: |
  3181. Whether or not this service was forced down manually by an
  3182. administrator after the service was fenced. This value is useful
  3183. to know that some 3rd party has verified the service should be
  3184. marked down.
  3185. in: body
  3186. required: true
  3187. type: boolean
  3188. forceDelete:
  3189. description: |
  3190. The action.
  3191. in: body
  3192. required: true
  3193. type: none
  3194. free_ram_mb:
  3195. description: |
  3196. The free RAM in this hypervisor(in MiB). This does not take allocation
  3197. ratios used for overcommit into account so this value may be negative.
  3198. in: body
  3199. required: true
  3200. type: integer
  3201. free_ram_mb_total:
  3202. description: |
  3203. The free RAM on all hypervisors(in MiB). This does not take allocation
  3204. ratios used for overcommit into account so this value may be negative.
  3205. in: body
  3206. required: true
  3207. type: integer
  3208. from_port:
  3209. description: |
  3210. The port at start of range.
  3211. in: body
  3212. required: true
  3213. type: integer
  3214. group:
  3215. description: |
  3216. A ``group`` object. Includes the ``tenant_id`` and the source security
  3217. group ``name``.
  3218. in: body
  3219. required: true
  3220. type: object
  3221. group_id:
  3222. description: |
  3223. The source security group ID.
  3224. in: body
  3225. required: false
  3226. type: string
  3227. guest_format:
  3228. description: |
  3229. Specifies the guest server disk file system format, such as ``ext2``,
  3230. ``ext3``, ``ext4``, ``xfs`` or ``swap``.
  3231. Swap block device mappings have the following restrictions:
  3232. * The ``source_type`` must be ``blank``
  3233. * The ``destination_type`` must be ``local``
  3234. * There can only be one swap disk per server
  3235. * The size of the swap disk must be less than or equal to the ``swap``
  3236. size of the flavor
  3237. in: body
  3238. required: false
  3239. type: string
  3240. host:
  3241. description: |
  3242. The name or ID of the host to which the server is evacuated.
  3243. If you omit this parameter, the scheduler chooses a host.
  3244. .. warning:: Prior to microversion 2.29, specifying a host will bypass
  3245. validation by the scheduler, which could result in failures to actually
  3246. evacuate the instance to the specified host, or over-subscription of the
  3247. host. It is recommended to either not specify a host so that the
  3248. scheduler will pick one, or specify a host with microversion >= 2.29 and
  3249. without ``force=True`` set.
  3250. in: body
  3251. required: false
  3252. type: string
  3253. host_cpu:
  3254. description: |
  3255. The number of virtual CPUs on the host.
  3256. in: body
  3257. required: true
  3258. type: integer
  3259. host_disk_gb:
  3260. description: |
  3261. The disk size on the host (in GiB).
  3262. in: body
  3263. required: true
  3264. type: integer
  3265. host_done_num:
  3266. description: |
  3267. The number of the hosts whose instance audit tasks have been done.
  3268. in: body
  3269. required: true
  3270. type: integer
  3271. host_ip:
  3272. description: |
  3273. The IP address of the hypervisor's host.
  3274. in: body
  3275. required: true
  3276. type: string
  3277. host_maintenance_mode:
  3278. description: |
  3279. Mode of maintenance state, either ``on_maintenance`` or
  3280. ``off_maintenance``.
  3281. in: body
  3282. required: false
  3283. type: string
  3284. host_maintenance_mode_in:
  3285. description: |
  3286. Mode of maintenance state, either ``enable`` or ``disable``.
  3287. in: body
  3288. required: false
  3289. type: string
  3290. host_memory_mb:
  3291. description: |
  3292. The memory size on the host (in MiB).
  3293. in: body
  3294. required: true
  3295. type: integer
  3296. host_migration:
  3297. description: |
  3298. The host to which to migrate the server. If this parameter is ``None``,
  3299. the scheduler chooses a host.
  3300. .. warning:: Prior to microversion 2.30, specifying a host will bypass
  3301. validation by the scheduler, which could result in failures to actually
  3302. migrate the instance to the specified host, or over-subscription of the
  3303. host. It is recommended to either not specify a host so that the
  3304. scheduler will pick one, or specify a host with microversion >= 2.30 and
  3305. without ``force=True`` set.
  3306. in: body
  3307. required: true
  3308. type: string
  3309. host_migration_2_56:
  3310. description: |
  3311. The host to which to migrate the server. If you specify ``null`` or
  3312. don't specify this parameter, the scheduler chooses a host.
  3313. in: body
  3314. required: false
  3315. type: string
  3316. min_version: 2.56
  3317. host_name_body:
  3318. description: |
  3319. The name of the host.
  3320. in: body
  3321. required: true
  3322. type: string
  3323. host_not_run:
  3324. description: |
  3325. A list of the hosts whose instance audit tasks have not run.
  3326. in: body
  3327. required: true
  3328. type: array
  3329. host_not_run_num:
  3330. description: |
  3331. The number of the hosts whose instance audit tasks have not run.
  3332. in: body
  3333. required: true
  3334. type: integer
  3335. host_num:
  3336. description: |
  3337. The number of the hosts.
  3338. in: body
  3339. required: true
  3340. type: integer
  3341. host_power_action:
  3342. description: |
  3343. The power action on the host.
  3344. in: body
  3345. required: true
  3346. type: string
  3347. host_project:
  3348. description: |
  3349. The project id (or special name like total, used_now, used_max).
  3350. in: body
  3351. required: true
  3352. type: string
  3353. host_resource:
  3354. description: |
  3355. The resource info of the host.
  3356. in: body
  3357. required: true
  3358. type: object
  3359. host_resource_array:
  3360. description: |
  3361. The array that includes resource info of the host.
  3362. in: body
  3363. required: true
  3364. type: array
  3365. host_running_num:
  3366. description: |
  3367. The number of the hosts whose instance audit tasks are running.
  3368. in: body
  3369. required: true
  3370. type: integer
  3371. host_service:
  3372. description: |
  3373. The name of the service which is running on the host.
  3374. in: body
  3375. required: true
  3376. type: string
  3377. host_status:
  3378. description: |
  3379. The host status. Values where next value in list can override the previous:
  3380. - ``UP`` if nova-compute up.
  3381. - ``UNKNOWN`` if nova-compute not reported by servicegroup driver.
  3382. - ``DOWN`` if nova-compute forced down.
  3383. - ``MAINTENANCE`` if nova-compute is disabled.
  3384. - Empty string indicates there is no host for server.
  3385. This attribute appears in the response only if the policy permits.
  3386. By default, only administrators can get this parameter.
  3387. in: body
  3388. required: false
  3389. type: string
  3390. min_version: 2.16
  3391. host_status_body:
  3392. description: |
  3393. The status of the current host, either ``enabled`` or ``disabled``.
  3394. in: body
  3395. required: false
  3396. type: string
  3397. host_status_body_in:
  3398. description: |
  3399. The status of the host, either ``enable`` or ``disable``.
  3400. in: body
  3401. required: false
  3402. type: string
  3403. host_status_update_rebuild:
  3404. description: |
  3405. The host status. Values where next value in list can override the previous:
  3406. - ``UP`` if nova-compute up.
  3407. - ``UNKNOWN`` if nova-compute not reported by servicegroup driver.
  3408. - ``DOWN`` if nova-compute forced down.
  3409. - ``MAINTENANCE`` if nova-compute is disabled.
  3410. - Empty string indicates there is no host for server.
  3411. This attribute appears in the response only if the policy permits.
  3412. By default, only administrators can get this parameter.
  3413. in: body
  3414. required: false
  3415. type: string
  3416. min_version: 2.75
  3417. host_zone:
  3418. description: |
  3419. The available zone of the host.
  3420. in: body
  3421. required: true
  3422. type: string
  3423. hostId:
  3424. description: |
  3425. An ID string representing the host. This is a hashed value so will not actually look like
  3426. a hostname, and is hashed with data from the project_id, so the same physical host as seen
  3427. by two different project_ids, will be different. It is useful when within the same project you
  3428. need to determine if two instances are on the same or different physical hosts for the
  3429. purposes of availability or performance.
  3430. in: body
  3431. required: true
  3432. type: string
  3433. hosts:
  3434. description: |
  3435. An array of host information.
  3436. in: body
  3437. required: true
  3438. type: array
  3439. hosts.availability_zone:
  3440. description: |
  3441. An object containing a list of host information. The host information is comprised
  3442. of host and service objects. The service object returns three parameters representing
  3443. the states of the service: ``active``, ``available``, and ``updated_at``.
  3444. in: body
  3445. required: true
  3446. type: object
  3447. hosts.availability_zone_none:
  3448. description: |
  3449. It is always ``null``.
  3450. in: body
  3451. required: true
  3452. type: none
  3453. hours:
  3454. description: |
  3455. The duration that the server exists (in hours).
  3456. in: body
  3457. required: true
  3458. type: float
  3459. hours_optional:
  3460. description: |
  3461. The duration that the server exists (in hours).
  3462. in: body
  3463. required: false
  3464. type: float
  3465. hypervisor:
  3466. description: |
  3467. The hypervisor object.
  3468. in: body
  3469. required: true
  3470. type: object
  3471. hypervisor_count:
  3472. description: |
  3473. The number of hypervisors.
  3474. in: body
  3475. required: true
  3476. type: integer
  3477. hypervisor_diagnostics:
  3478. description: |
  3479. The hypervisor on which the VM is running. Examples for libvirt driver
  3480. may be: ``qemu``, ``kvm`` or ``xen``.
  3481. in: body
  3482. required: true
  3483. type: string
  3484. min_version: 2.48
  3485. hypervisor_free_disk_gb:
  3486. description: |
  3487. The free disk remaining on this hypervisor(in GiB). This does not take
  3488. allocation ratios used for overcommit into account so this value may be
  3489. negative.
  3490. in: body
  3491. required: true
  3492. type: integer
  3493. hypervisor_free_disk_gb_total:
  3494. description: |
  3495. The free disk remaining on all hypervisors(in GiB). This does not take
  3496. allocation ratios used for overcommit into account so this value may be
  3497. negative.
  3498. in: body
  3499. required: true
  3500. type: integer
  3501. hypervisor_hostname:
  3502. description: |
  3503. The hypervisor host name provided by the Nova virt driver. For the Ironic driver,
  3504. it is the Ironic node uuid.
  3505. in: body
  3506. required: true
  3507. type: string
  3508. hypervisor_id_body:
  3509. description: |
  3510. The id of the hypervisor.
  3511. in: body
  3512. required: true
  3513. type: integer
  3514. max_version: 2.52
  3515. hypervisor_id_body_no_version:
  3516. description: |
  3517. The id of the hypervisor.
  3518. in: body
  3519. required: true
  3520. type: integer
  3521. hypervisor_id_body_uuid:
  3522. description: |
  3523. The id of the hypervisor as a UUID.
  3524. in: body
  3525. required: true
  3526. type: string
  3527. min_version: 2.53
  3528. hypervisor_links:
  3529. description: |
  3530. Links to the hypervisors resource. See `API Guide / Links and
  3531. References
  3532. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  3533. for more info.
  3534. in: body
  3535. type: array
  3536. min_version: 2.33
  3537. required: false
  3538. hypervisor_os_diagnostics:
  3539. description: |
  3540. The hypervisor OS.
  3541. in: body
  3542. type: string
  3543. required: true
  3544. min_version: 2.48
  3545. hypervisor_servers:
  3546. description: |
  3547. A list of ``server`` objects.
  3548. This field has become mandatory in microversion 2.75. If no servers is on hypervisor
  3549. then empty list is returned.
  3550. in: body
  3551. required: true
  3552. type: array
  3553. min_version: 2.53
  3554. hypervisor_servers_name:
  3555. description: |
  3556. The server name.
  3557. in: body
  3558. required: false
  3559. type: string
  3560. min_version: 2.53
  3561. hypervisor_servers_uuid:
  3562. description: |
  3563. The server ID.
  3564. in: body
  3565. required: false
  3566. type: string
  3567. min_version: 2.53
  3568. hypervisor_service:
  3569. description: |
  3570. The hypervisor service object.
  3571. in: body
  3572. required: true
  3573. type: object
  3574. hypervisor_state:
  3575. description: |
  3576. The state of the hypervisor. One of ``up`` or ``down``.
  3577. in: body
  3578. required: true
  3579. type: string
  3580. hypervisor_statistics:
  3581. description: |
  3582. The hypervisors statistics summary object.
  3583. in: body
  3584. required: true
  3585. type: object
  3586. hypervisor_status:
  3587. description: |
  3588. The status of the hypervisor. One of ``enabled`` or ``disabled``.
  3589. in: body
  3590. required: true
  3591. type: string
  3592. hypervisor_type:
  3593. in: body
  3594. required: true
  3595. type: string
  3596. description: |
  3597. The hypervisor type for the agent. Currently only ``xen`` is supported.
  3598. hypervisor_type_body:
  3599. description: |
  3600. The hypervisor type.
  3601. in: body
  3602. required: true
  3603. type: string
  3604. hypervisor_vcpus:
  3605. description: |
  3606. The number of vcpu in this hypervisor. This does not take allocation
  3607. ratios used for overcommit into account so there may be disparity between
  3608. this and the used count.
  3609. in: body
  3610. required: true
  3611. type: integer
  3612. hypervisor_vcpus_total:
  3613. description: |
  3614. The number of vcpu on all hypervisors. This does not take allocation
  3615. ratios used for overcommit into account so there may be disparity between
  3616. this and the used count.
  3617. in: body
  3618. required: true
  3619. type: integer
  3620. hypervisor_vcpus_used:
  3621. description: |
  3622. The number of vcpu used in this hypervisor.
  3623. in: body
  3624. required: true
  3625. type: integer
  3626. hypervisor_vcpus_used_total:
  3627. description: |
  3628. The number of vcpu used on all hypervisors.
  3629. in: body
  3630. required: true
  3631. type: integer
  3632. hypervisor_version:
  3633. description: |
  3634. The hypervisor version.
  3635. in: body
  3636. required: true
  3637. type: integer
  3638. hypervisors:
  3639. description: |
  3640. An array of hypervisor information.
  3641. in: body
  3642. required: true
  3643. type: array
  3644. image:
  3645. description: |
  3646. The UUID and links for the image for your server instance. The ``image`` object
  3647. might be an empty string when you boot the server from a volume.
  3648. in: body
  3649. required: true
  3650. type: object
  3651. image_id_body:
  3652. description: |
  3653. The ID of the Image.
  3654. in: body
  3655. required: true
  3656. type: string
  3657. image_metadata:
  3658. description: |
  3659. Metadata key and value pairs for the image.
  3660. The maximum size for each metadata key and value pair is 255 bytes.
  3661. in: body
  3662. required: false
  3663. type: object
  3664. image_metadata_items:
  3665. description: |
  3666. The number of allowed metadata items for each image. Starting from
  3667. version 2.39 this field is dropped from 'os-limits' response, because
  3668. 'image-metadata' proxy API was deprecated.
  3669. in: body
  3670. required: true
  3671. type: integer
  3672. max_version: 2.38
  3673. image_name:
  3674. description: |
  3675. The display name of an Image.
  3676. in: body
  3677. required: true
  3678. type: string
  3679. image_progress:
  3680. description: |
  3681. A percentage value of the image save progress. This can be one of:
  3682. - ``ACTIVE``: 100
  3683. - ``SAVING``: 25 or 50
  3684. in: body
  3685. required: true
  3686. type: integer
  3687. image_server:
  3688. description: |
  3689. The server booted from image.
  3690. in: body
  3691. required: false
  3692. type: object
  3693. image_size:
  3694. description: |
  3695. The size of the image.
  3696. in: body
  3697. required: true
  3698. type: integer
  3699. image_status:
  3700. description: |
  3701. The status of image, as a string. This can be one of:
  3702. - ``ACTIVE``: image is in active state
  3703. - ``SAVING``: image is in queued or in saving process
  3704. - ``DELETED``: image is deleted or in progress of deletion
  3705. - ``ERROR``: image is in error state
  3706. - ``UNKNOWN``: image is in unknown state
  3707. in: body
  3708. required: true
  3709. type: string
  3710. imageRef:
  3711. description: |
  3712. The UUID of the image to use for your server instance.
  3713. This is not required in case of boot from volume.
  3714. In all other cases it is required and must be a valid UUID
  3715. otherwise API will return 400.
  3716. in: body
  3717. required: false
  3718. type: string
  3719. imageRef_rebuild:
  3720. description: |
  3721. The UUID of the image to rebuild for your server instance.
  3722. It must be a valid UUID otherwise API will return 400.
  3723. If rebuilding a volume-backed server with a new image
  3724. (an image different from the image used when creating the volume),
  3725. the API will return 400.
  3726. For non-volume-backed servers, specifying a new image will result
  3727. in validating that the image is acceptable for the current compute host
  3728. on which the server exists. If the new image is not valid,
  3729. the server will go into ``ERROR`` status.
  3730. in: body
  3731. required: true
  3732. type: string
  3733. images:
  3734. description: |
  3735. An array of Image objects.
  3736. in: body
  3737. required: true
  3738. type: array
  3739. injected_file_content_bytes:
  3740. description: |
  3741. The number of allowed bytes of content for each injected file.
  3742. in: body
  3743. required: true
  3744. type: integer
  3745. max_version: 2.56
  3746. injected_file_content_bytes_quota_details:
  3747. description: |
  3748. The object of detailed injected file content bytes quota,
  3749. including in_use, limit and reserved number of injected
  3750. file content bytes.
  3751. in: body
  3752. required: true
  3753. type: object
  3754. max_version: 2.56
  3755. injected_file_content_bytes_quota_optional:
  3756. description: |
  3757. The number of allowed bytes of content for each injected file.
  3758. in: body
  3759. required: false
  3760. type: integer
  3761. max_version: 2.56
  3762. injected_file_path_bytes:
  3763. description: |
  3764. The number of allowed bytes for each injected file path.
  3765. in: body
  3766. required: true
  3767. type: integer
  3768. max_version: 2.56
  3769. injected_file_path_bytes_quota_details:
  3770. description: |
  3771. The object of detailed injected file path bytes quota,
  3772. including in_use, limit and reserved number of injected
  3773. file path bytes.
  3774. in: body
  3775. required: true
  3776. type: object
  3777. max_version: 2.56
  3778. injected_file_path_bytes_quota_optional:
  3779. description: |
  3780. The number of allowed bytes for each injected file path.
  3781. in: body
  3782. required: false
  3783. type: integer
  3784. max_version: 2.56
  3785. injected_files: &injected_files
  3786. description: |
  3787. The number of allowed injected files for each tenant.
  3788. in: body
  3789. required: true
  3790. type: integer
  3791. max_version: 2.56
  3792. injected_files_quota_class: &injected_files_quota_class
  3793. <<: *injected_files
  3794. description: |
  3795. The number of allowed injected files for the quota class.
  3796. injected_files_quota_class_optional:
  3797. <<: *injected_files_quota_class
  3798. required: false
  3799. injected_files_quota_details:
  3800. description: |
  3801. The object of detailed injected files quota, including in_use, limit and
  3802. reserved number of injected files.
  3803. in: body
  3804. required: true
  3805. type: object
  3806. max_version: 2.56
  3807. injected_files_quota_optional:
  3808. description: |
  3809. The number of allowed injected files for each tenant.
  3810. in: body
  3811. required: false
  3812. type: integer
  3813. max_version: 2.56
  3814. injectNetworkInfo:
  3815. description: |
  3816. The action.
  3817. in: body
  3818. required: true
  3819. type: none
  3820. instance_action_events_2_50:
  3821. description: |
  3822. The events which occurred in this action in descending order of creation.
  3823. Policy defaults enable only users with the administrative role to see
  3824. instance action event information. Cloud providers can change these
  3825. permissions through the ``policy.json`` file.
  3826. in: body
  3827. required: false
  3828. type: array
  3829. max_version: 2.50
  3830. instance_action_events_2_51:
  3831. description: |
  3832. The events which occurred in this action in descending order of creation.
  3833. Policy defaults enable only users with the administrative role or the owner
  3834. of the server to see instance action event information. Cloud providers can
  3835. change these permissions through the ``policy.json`` file.
  3836. in: body
  3837. required: true
  3838. type: array
  3839. min_version: 2.51
  3840. instance_actions_next_links:
  3841. description: |
  3842. Links pertaining to the instance action.
  3843. This parameter is returned when paging and more data is available.
  3844. See `API Guide / Links and References
  3845. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  3846. for more info.
  3847. in: body
  3848. required: false
  3849. type: array
  3850. min_version: 2.58
  3851. instance_id_body:
  3852. description: |
  3853. The UUID of the server.
  3854. in: body
  3855. required: true
  3856. type: string
  3857. instance_id_cloudpipe:
  3858. description: |
  3859. The UUID of the cloudpipe instance.
  3860. in: body
  3861. required: true
  3862. type: string
  3863. instance_name:
  3864. description: |
  3865. The name of the instance.
  3866. in: body
  3867. required: true
  3868. type: string
  3869. instance_usage_audit_log:
  3870. description: |
  3871. The object of instance usage audit logs.
  3872. in: body
  3873. required: true
  3874. type: object
  3875. instance_usage_audit_log_message:
  3876. description: |
  3877. The log message of the instance usage audit task.
  3878. in: body
  3879. required: true
  3880. type: string
  3881. instance_usage_audit_logs:
  3882. description: |
  3883. The object of instance usage audit log information.
  3884. in: body
  3885. required: true
  3886. type: object
  3887. instance_usage_audit_task_state:
  3888. description: |
  3889. The state of the instance usage audit task.
  3890. ``DONE`` or ``RUNNING``.
  3891. in: body
  3892. required: true
  3893. type: string
  3894. instanceAction:
  3895. description: |
  3896. The instance action object.
  3897. in: body
  3898. required: true
  3899. type: object
  3900. instanceActions:
  3901. description: |
  3902. List of the actions for the given instance in descending order of creation.
  3903. in: body
  3904. required: true
  3905. type: array
  3906. instances: &instances
  3907. description: |
  3908. The number of allowed servers for each tenant.
  3909. in: body
  3910. required: true
  3911. type: integer
  3912. instances_quota_class: &instances_quota_class
  3913. <<: *instances
  3914. description: |
  3915. The number of allowed servers for the quota class.
  3916. instances_quota_class_optional:
  3917. <<: *instances_quota_class
  3918. required: false
  3919. instances_quota_details:
  3920. description: |
  3921. The object of detailed servers quota, including in_use, limit and
  3922. reserved number of instances.
  3923. in: body
  3924. required: true
  3925. type: object
  3926. instances_quota_optional:
  3927. description: |
  3928. The number of allowed servers for each tenant.
  3929. in: body
  3930. required: false
  3931. type: integer
  3932. instances_usage_audit:
  3933. description: |
  3934. The number of instances.
  3935. in: body
  3936. required: true
  3937. type: integer
  3938. interfaceAttachment:
  3939. description: |
  3940. Specify the ``interfaceAttachment`` action in the request body.
  3941. in: body
  3942. required: true
  3943. type: string
  3944. interfaceAttachment_resp:
  3945. description: |
  3946. The interface attachment.
  3947. in: body
  3948. required: true
  3949. type: object
  3950. interfaceAttachments:
  3951. description: |
  3952. List of the interface attachments.
  3953. in: body
  3954. required: true
  3955. type: array
  3956. internal_access_path:
  3957. description: |
  3958. The id representing the internal access path.
  3959. in: body
  3960. required: false
  3961. type: string
  3962. ip_address:
  3963. description: |
  3964. The IP address.
  3965. in: body
  3966. required: true
  3967. type: string
  3968. ip_address_req:
  3969. description: |
  3970. The IP address. It is required when ``fixed_ips`` is specified.
  3971. in: body
  3972. required: true
  3973. type: string
  3974. ip_host:
  3975. description: |
  3976. The name or ID of the host associated to the IP.
  3977. in: body
  3978. required: true
  3979. type: string
  3980. ip_protocol:
  3981. description: |
  3982. The IP protocol. A valid value is ICMP, TCP, or UDP.
  3983. in: body
  3984. required: true
  3985. type: string
  3986. ip_range:
  3987. description: |
  3988. The range of IP addresses to use for creating floating IPs.
  3989. in: body
  3990. required: true
  3991. type: string
  3992. ip_range_delete:
  3993. description: |
  3994. The range of IP addresses from which to bulk-delete floating IPs.
  3995. in: body
  3996. required: true
  3997. type: string
  3998. key_name:
  3999. description: |
  4000. Key pair name.
  4001. .. note:: The ``null`` value was allowed in the Nova legacy v2 API,
  4002. but due to strict input validation, it is not allowed in
  4003. the Nova v2.1 API.
  4004. in: body
  4005. required: false
  4006. type: string
  4007. key_name_rebuild_req:
  4008. description: |
  4009. Key pair name for rebuild API. If ``null`` is specified,
  4010. the existing keypair is unset.
  4011. .. note:: Users within the same project are able to rebuild other
  4012. user's instances in that project with a new keypair. Keys
  4013. are owned by users (which is the only resource that's true
  4014. of). Servers are owned by projects. Because of this a rebuild
  4015. with a key_name is looking up the keypair by the user calling
  4016. rebuild.
  4017. in: body
  4018. required: false
  4019. type: string
  4020. min_version: 2.54
  4021. key_name_rebuild_resp:
  4022. description: |
  4023. The name of associated key pair, if any.
  4024. in: body
  4025. required: true
  4026. type: string
  4027. min_version: 2.54
  4028. key_name_resp:
  4029. description: |
  4030. The name of associated key pair, if any.
  4031. in: body
  4032. required: true
  4033. type: string
  4034. key_name_resp_update:
  4035. description: |
  4036. The name of associated key pair, if any.
  4037. in: body
  4038. required: true
  4039. type: string
  4040. min_version: 2.75
  4041. key_pairs: &key_pairs
  4042. description: |
  4043. The number of allowed key pairs for each user.
  4044. in: body
  4045. required: true
  4046. type: integer
  4047. key_pairs_quota_class: &key_pairs_quota_class
  4048. <<: *key_pairs
  4049. description: |
  4050. The number of allowed key pairs for the quota class.
  4051. key_pairs_quota_class_optional:
  4052. <<: *key_pairs_quota_class
  4053. required: false
  4054. key_pairs_quota_details:
  4055. description: |
  4056. The object of detailed key pairs quota, including in_use, limit and
  4057. reserved number of key pairs.
  4058. .. note:: ``in_use`` field value for keypair quota details is always
  4059. zero. In Nova, key_pairs are a user-level resource, not a project-
  4060. level resource, so for legacy reasons, the keypair in-use information
  4061. is not counted.
  4062. in: body
  4063. required: true
  4064. type: object
  4065. key_pairs_quota_optional:
  4066. description: |
  4067. The number of allowed key pairs for each user.
  4068. in: body
  4069. required: false
  4070. type: integer
  4071. keypair:
  4072. in: body
  4073. type: object
  4074. required: true
  4075. description: |
  4076. Keypair object
  4077. keypair_deleted:
  4078. description: |
  4079. A boolean indicates whether this keypair is deleted or not.
  4080. The value is always ``false`` (not deleted).
  4081. in: body
  4082. required: true
  4083. type: boolean
  4084. keypair_fingerprint:
  4085. in: body
  4086. required: true
  4087. type: string
  4088. description: |
  4089. The fingerprint for the keypair.
  4090. keypair_id:
  4091. description: |
  4092. The keypair ID.
  4093. in: body
  4094. required: true
  4095. type: integer
  4096. keypair_links:
  4097. description: |
  4098. Links pertaining to keypair. See `API Guide / Links and
  4099. References
  4100. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  4101. for more info.
  4102. in: body
  4103. type: array
  4104. required: false
  4105. min_version: 2.35
  4106. keypair_name:
  4107. in: body
  4108. required: true
  4109. type: string
  4110. description: |
  4111. A name for the keypair which will be used to reference it later.
  4112. keypair_private_key:
  4113. description: |
  4114. If you do not provide a public key on create, a new keypair will
  4115. be built for you, and the private key will be returned during the
  4116. initial create call. Make sure to save this, as there is no way to
  4117. get this private key again in the future.
  4118. in: body
  4119. required: false
  4120. type: string
  4121. keypair_public_key:
  4122. description: |
  4123. The keypair public key.
  4124. in: body
  4125. required: true
  4126. type: string
  4127. keypair_public_key_in:
  4128. description: |
  4129. The public ssh key to import. If you omit this value, a keypair is
  4130. generated for you.
  4131. in: body
  4132. required: false
  4133. type: string
  4134. keypair_type:
  4135. in: body
  4136. required: true
  4137. type: string
  4138. description: |
  4139. The type of the keypair. Allowed values are ``ssh`` or ``x509``.
  4140. min_version: 2.2
  4141. keypair_type_in:
  4142. in: body
  4143. required: false
  4144. type: string
  4145. description: |
  4146. The type of the keypair. Allowed values are ``ssh`` or ``x509``.
  4147. min_version: 2.2
  4148. keypair_updated_deleted_at:
  4149. description: |
  4150. It is always ``null``.
  4151. in: body
  4152. required: true
  4153. type: none
  4154. # NOTE(mriedem): This is the user_id description for the keypair create/show
  4155. # response which has always been returned.
  4156. keypair_userid:
  4157. in: body
  4158. required: true
  4159. type: string
  4160. description: |
  4161. The user_id for a keypair.
  4162. keypair_userid_in:
  4163. in: body
  4164. required: false
  4165. type: string
  4166. description: |
  4167. The user_id for a keypair. This allows administrative users to
  4168. upload keys for other users than themselves.
  4169. min_version: 2.10
  4170. keypairs:
  4171. in: body
  4172. type: array
  4173. required: true
  4174. description: |
  4175. Array of Keypair objects
  4176. length:
  4177. description: |
  4178. The number of lines to fetch from the end of console log. All
  4179. lines will be returned if this is not specified.
  4180. .. note::
  4181. This parameter can be specified as not only 'integer' but also 'string'.
  4182. in: body
  4183. required: false
  4184. type: integer
  4185. limits:
  4186. description: |
  4187. Data structure that contains both absolute limits within a deployment.
  4188. in: body
  4189. required: true
  4190. type: object
  4191. limits_absolutes:
  4192. description: |
  4193. Name/value pairs that set quota limits within a deployment and
  4194. Name/value pairs of resource usage.
  4195. in: body
  4196. required: true
  4197. type: object
  4198. limits_rate_uri:
  4199. description: |
  4200. A human readable URI that is used as a friendly description of where the api rate limit is applied.
  4201. in: body
  4202. required: true
  4203. type: string
  4204. limits_rates:
  4205. description: |
  4206. An empty list for backwards compatibility purposes.
  4207. in: body
  4208. required: true
  4209. type: array
  4210. links:
  4211. description: |
  4212. Links to the resources in question. See `API Guide / Links and
  4213. References
  4214. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  4215. for more info.
  4216. in: body
  4217. required: true
  4218. type: array
  4219. local_gb:
  4220. description: |
  4221. The disk in this hypervisor(in GiB). This does not take allocation
  4222. ratios used for overcommit into account so there may be disparity between
  4223. this and the used count.
  4224. in: body
  4225. required: true
  4226. type: integer
  4227. local_gb_simple_tenant_usage:
  4228. description: |
  4229. The sum of the root disk size of the server and
  4230. the ephemeral disk size of it (in GiB).
  4231. in: body
  4232. required: true
  4233. type: integer
  4234. local_gb_simple_tenant_usage_optional:
  4235. description: |
  4236. The sum of the root disk size of the server and
  4237. the ephemeral disk size of it (in GiB).
  4238. in: body
  4239. required: false
  4240. type: integer
  4241. local_gb_total:
  4242. description: |
  4243. The disk on all hypervisors(in GiB). This does not take allocation
  4244. ratios used for overcommit into account so there may be disparity between
  4245. this and the used count.
  4246. in: body
  4247. required: true
  4248. type: integer
  4249. local_gb_used:
  4250. description: |
  4251. The disk used in this hypervisor(in GiB).
  4252. in: body
  4253. required: true
  4254. type: integer
  4255. local_gb_used_total:
  4256. description: |
  4257. The disk used on all hypervisors(in GiB).
  4258. in: body
  4259. required: true
  4260. type: integer
  4261. lock:
  4262. description: |
  4263. The action to lock a server.
  4264. This parameter can be ``null``.
  4265. Up to microversion 2.73, this parameter should be ``null``.
  4266. in: body
  4267. required: true
  4268. type: object
  4269. locked:
  4270. description: |
  4271. True if the instance is locked otherwise False.
  4272. in: body
  4273. required: true
  4274. type: boolean
  4275. min_version: 2.9
  4276. locked_reason_req:
  4277. description: |
  4278. The reason behind locking a server. Limited to 255 characters in length.
  4279. in: body
  4280. required: false
  4281. type: string
  4282. min_version: 2.73
  4283. locked_reason_resp:
  4284. description: |
  4285. The reason behind locking a server.
  4286. in: body
  4287. required: true
  4288. type: string
  4289. min_version: 2.73
  4290. mac_addr:
  4291. description: |
  4292. The MAC address.
  4293. in: body
  4294. required: true
  4295. type: string
  4296. mac_address:
  4297. description: |
  4298. The MAC address.
  4299. in: body
  4300. required: true
  4301. type: string
  4302. md5hash:
  4303. description: |
  4304. The MD5 hash.
  4305. in: body
  4306. required: true
  4307. type: string
  4308. media_types:
  4309. description: |
  4310. The `media types
  4311. <https://www.iana.org/assignments/media-types/media-types.xhtml>`_.
  4312. It is an array of a fixed dict.
  4313. .. note::
  4314. It is vestigial and provide no useful information.
  4315. It will be deprecated and removed in the future.
  4316. in: body
  4317. required: true
  4318. type: array
  4319. members:
  4320. description: |
  4321. A list of members in the server group.
  4322. in: body
  4323. required: true
  4324. type: array
  4325. memory_details_diagnostics:
  4326. description: |
  4327. The dictionary with information about VM memory usage.
  4328. Following fields are presented in the dictionary:
  4329. - ``maximum`` - Amount of memory provisioned for the VM in MiB (Integer)
  4330. - ``used`` - Amount of memory that is currently used by the guest operating
  4331. system and its applications in MiB (Integer)
  4332. in: body
  4333. required: true
  4334. type: array
  4335. min_version: 2.48
  4336. memory_mb:
  4337. description: |
  4338. The memory of this hypervisor(in MiB). This does not take allocation
  4339. ratios used for overcommit into account so there may be disparity between
  4340. this and the used count.
  4341. in: body
  4342. required: true
  4343. type: integer
  4344. memory_mb_simple_tenant_usage:
  4345. description: |
  4346. The memory size of the server (in MiB).
  4347. in: body
  4348. required: true
  4349. type: integer
  4350. memory_mb_simple_tenant_usage_optional:
  4351. description: |
  4352. The memory size of the server (in MiB).
  4353. in: body
  4354. required: false
  4355. type: integer
  4356. memory_mb_total:
  4357. description: |
  4358. The memory of all hypervisors(in MiB). This does not take allocation
  4359. ratios used for overcommit into account so there may be disparity between
  4360. this and the used count.
  4361. in: body
  4362. required: true
  4363. type: integer
  4364. memory_mb_used:
  4365. description: |
  4366. The memory used in this hypervisor(in MiB).
  4367. in: body
  4368. required: true
  4369. type: integer
  4370. memory_mb_used_total:
  4371. description: |
  4372. The memory used on all hypervisors(in MiB).
  4373. in: body
  4374. required: true
  4375. type: integer
  4376. message:
  4377. description: |
  4378. The related error message for when an action fails.
  4379. in: body
  4380. required: true
  4381. type: string
  4382. meta:
  4383. description: |
  4384. The object of detailed key metadata items.
  4385. in: body
  4386. required: true
  4387. type: object
  4388. metadata:
  4389. description: |
  4390. Metadata key and value pairs. The maximum size of the metadata key and value is
  4391. 255 bytes each.
  4392. in: body
  4393. required: false
  4394. type: object
  4395. metadata_compat:
  4396. description: |
  4397. A dictionary of metadata key-and-value pairs, which is maintained for backward
  4398. compatibility.
  4399. in: body
  4400. required: true
  4401. type: object
  4402. metadata_items:
  4403. description: |
  4404. The number of allowed metadata items for each server.
  4405. in: body
  4406. required: true
  4407. type: integer
  4408. metadata_items_quota_details:
  4409. description: |
  4410. The object of detailed key metadata items quota, including in_use,
  4411. limit and reserved number of metadata items.
  4412. in: body
  4413. required: true
  4414. type: object
  4415. metadata_items_quota_optional:
  4416. description: |
  4417. The number of allowed metadata items for each server.
  4418. in: body
  4419. required: false
  4420. type: integer
  4421. metadata_object:
  4422. description: |
  4423. Metadata key and value pairs. The maximum size for each metadata key and value
  4424. pair is 255 bytes.
  4425. in: body
  4426. required: true
  4427. type: object
  4428. metadata_server_group_max_2_63:
  4429. description: |
  4430. Metadata key and value pairs. The maximum size for each metadata key and value
  4431. pair is 255 bytes. It's always empty and only used for keeping compatibility.
  4432. in: body
  4433. required: true
  4434. type: object
  4435. max_version: 2.63
  4436. migrate:
  4437. description: |
  4438. The action to cold migrate a server.
  4439. This parameter can be ``null``.
  4440. Up to microversion 2.55, this parameter should be ``null``.
  4441. in: body
  4442. required: true
  4443. type: object
  4444. migrate_dest_compute:
  4445. description: |
  4446. The target compute for a migration.
  4447. in: body
  4448. required: true
  4449. type: string
  4450. migrate_dest_host:
  4451. description: |
  4452. The target host for a migration.
  4453. in: body
  4454. required: true
  4455. type: string
  4456. migrate_dest_node:
  4457. description: |
  4458. The target node for a migration.
  4459. in: body
  4460. required: true
  4461. type: string
  4462. migrate_disk_processed_bytes:
  4463. description: |
  4464. The amount of disk, in bytes, that has been processed during the migration.
  4465. in: body
  4466. required: true
  4467. type: integer
  4468. migrate_disk_remaining_bytes:
  4469. description: |
  4470. The amount of disk, in bytes, that still needs to be migrated.
  4471. in: body
  4472. required: true
  4473. type: integer
  4474. migrate_disk_total_bytes:
  4475. description: |
  4476. The total amount of disk, in bytes, that needs to be migrated.
  4477. in: body
  4478. required: true
  4479. type: integer
  4480. migrate_memory_processed_bytes:
  4481. description: |
  4482. The amount of memory, in bytes, that has been processed during the migration.
  4483. in: body
  4484. required: true
  4485. type: integer
  4486. migrate_memory_remaining_bytes:
  4487. description: |
  4488. The amount of memory, in bytes, that still needs to be migrated.
  4489. in: body
  4490. required: true
  4491. type: integer
  4492. migrate_memory_total_bytes:
  4493. description: |
  4494. The total amount of memory, in bytes, that needs to be migrated.
  4495. in: body
  4496. required: true
  4497. type: integer
  4498. migrate_source_compute:
  4499. description: |
  4500. The source compute for a migration.
  4501. in: body
  4502. required: true
  4503. type: string
  4504. migrate_source_node:
  4505. description: |
  4506. The source node for a migration.
  4507. in: body
  4508. required: true
  4509. type: string
  4510. migrate_status:
  4511. description: |
  4512. The current status of the migration.
  4513. in: body
  4514. required: true
  4515. type: string
  4516. migration:
  4517. description: |
  4518. The server migration object.
  4519. in: body
  4520. required: true
  4521. type: object
  4522. migration_id:
  4523. description: |
  4524. The ID of the server migration.
  4525. in: body
  4526. required: true
  4527. type: integer
  4528. migration_links_2_23:
  4529. description: |
  4530. Links to the migration.
  4531. This parameter is returned if the migration type is ``live-migration`` and
  4532. the migration status is one of ``queued``, ``preparing``, ``running``
  4533. and ``post-migrating``. See `API Guide / Links and References
  4534. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  4535. for more info.
  4536. in: body
  4537. required: false
  4538. type: array
  4539. min_version: 2.23
  4540. migration_new_flavor_id:
  4541. description: |
  4542. In ``resize`` case, the flavor ID for resizing the server.
  4543. In the other cases, this parameter is same as the flavor ID
  4544. of the server when the migration was started.
  4545. .. note:: This is an internal ID and is not exposed in any other API.
  4546. In particular, this is not the ID specified or automatically generated
  4547. during flavor creation or returned via the ``GET /flavors`` API.
  4548. in: body
  4549. required: true
  4550. type: integer
  4551. migration_next_links_2_59:
  4552. description: |
  4553. Links pertaining to the migration.
  4554. This parameter is returned when paging and more data is available.
  4555. See `API Guide / Links and References
  4556. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  4557. for more info.
  4558. in: body
  4559. required: false
  4560. type: array
  4561. min_version: 2.59
  4562. migration_old_flavor_id:
  4563. description: |
  4564. The flavor ID of the server when the migration was started.
  4565. .. note:: This is an internal ID and is not exposed in any other API.
  4566. In particular, this is not the ID specified or automatically generated
  4567. during flavor creation or returned via the ``GET /flavors`` API.
  4568. in: body
  4569. required: true
  4570. type: integer
  4571. migration_type_2_23:
  4572. description: |
  4573. The type of the server migration. This is one of ``live-migration``,
  4574. ``migration``, ``resize`` and ``evacuation``.
  4575. in: body
  4576. required: true
  4577. type: string
  4578. min_version: 2.23
  4579. migration_uuid:
  4580. description: |
  4581. The UUID of the migration.
  4582. in: body
  4583. required: true
  4584. type: string
  4585. min_version: 2.59
  4586. migrations:
  4587. description: |
  4588. The list of server migration objects.
  4589. in: body
  4590. required: true
  4591. type: array
  4592. minDisk_body:
  4593. description: |
  4594. The minimum amount of disk space an image requires to boot, in GiB. For example, ``100``.
  4595. in: body
  4596. required: true
  4597. type: integer
  4598. minRam_body:
  4599. description: |
  4600. The minimum amount of RAM an image requires to function, in MiB. For example, ``512``.
  4601. in: body
  4602. required: true
  4603. type: integer
  4604. name:
  4605. description: |
  4606. The security group name.
  4607. in: body
  4608. required: true
  4609. type: string
  4610. name_sec_group_optional:
  4611. description: |
  4612. The security group name.
  4613. in: body
  4614. required: false
  4615. type: string
  4616. name_server_group:
  4617. description: |
  4618. The name of the server group.
  4619. in: body
  4620. required: true
  4621. type: string
  4622. name_update_rebuild:
  4623. description: |
  4624. The security group name.
  4625. in: body
  4626. required: true
  4627. type: string
  4628. min_version: 2.75
  4629. namespace:
  4630. description: |
  4631. A URL pointing to the namespace for this extension.
  4632. in: body
  4633. required: true
  4634. type: string
  4635. net_id:
  4636. description: |
  4637. The ID of the network for which you want to create a port interface. The ``net_id``
  4638. and ``port_id`` parameters are mutually exclusive. If you do not specify the
  4639. ``net_id`` parameter, the OpenStack Networking API v2.0 uses the network information
  4640. cache that is associated with the instance.
  4641. in: body
  4642. required: false
  4643. type: string
  4644. net_id_resp:
  4645. description: |
  4646. The network ID.
  4647. in: body
  4648. required: true
  4649. type: string
  4650. net_id_resp_2_12:
  4651. description: |
  4652. The network ID.
  4653. in: body
  4654. required: true
  4655. type: string
  4656. min_version: 2.12
  4657. network_label_body:
  4658. description: |
  4659. List of IP address and IP version pairs.
  4660. The ``network_label`` stands for the name of a network,
  4661. such as ``public`` or ``private``.
  4662. in: body
  4663. required: true
  4664. type: array
  4665. network_uuid:
  4666. description: |
  4667. To provision the server instance with a NIC for a network, specify the UUID of
  4668. the network in the ``uuid`` attribute in a ``networks`` object. Required if you
  4669. omit the ``port`` attribute.
  4670. Starting with microversion 2.37, this value is strictly enforced to be in
  4671. UUID format.
  4672. in: body
  4673. required: false
  4674. type: string
  4675. networks:
  4676. description: |
  4677. A list of ``network`` object. Required parameter when there are multiple
  4678. networks defined for the tenant. When you do not specify the networks
  4679. parameter, the server attaches to the only network created for the
  4680. current tenant. Optionally, you can create one or more NICs on the server.
  4681. To provision the server instance with a NIC for a network, specify
  4682. the UUID of the network in the ``uuid`` attribute in a ``networks``
  4683. object. To provision the server instance with a NIC for an already
  4684. existing port, specify the port-id in the ``port`` attribute in a
  4685. ``networks`` object.
  4686. If multiple networks are defined, the order in which they appear in the
  4687. guest operating system will not necessarily reflect the order in which they
  4688. are given in the server boot request. Guests should therefore not depend
  4689. on device order to deduce any information about their network devices.
  4690. Instead, device role tags should be used: introduced in 2.32, broken in
  4691. 2.37, and re-introduced and fixed in 2.42, the ``tag`` is an optional,
  4692. string attribute that can be used to assign a tag to a virtual network
  4693. interface. This tag is then exposed to the guest in the metadata API and
  4694. the config drive and is associated to hardware metadata for that network
  4695. interface, such as bus (ex: PCI), bus address (ex: 0000:00:02.0), and MAC
  4696. address.
  4697. A bug has caused the ``tag`` attribute to no longer be accepted starting
  4698. with version 2.37. Therefore, network interfaces could only be tagged in
  4699. versions 2.32 to 2.36 inclusively. Version 2.42 has restored the ``tag``
  4700. attribute.
  4701. Starting with microversion 2.37, this field is required and the special
  4702. string values *auto* and *none* can be specified for networks. *auto*
  4703. tells the Compute service to use a network that is available to the
  4704. project, if one exists. If one does not exist, the Compute service will
  4705. attempt to automatically allocate a network for the project (if possible).
  4706. *none* tells the Compute service to not allocate a network for the
  4707. instance. The *auto* and *none* values cannot be used with any other
  4708. network values, including other network uuids, ports, fixed IPs or device
  4709. tags. These are requested as strings for the networks value, not in a
  4710. list. See the associated example.
  4711. in: body
  4712. required: true
  4713. type: array
  4714. networks_quota_optional: &networks_quota_optional
  4715. description: |
  4716. The number of private networks that can be created per project.
  4717. in: body
  4718. required: false
  4719. type: integer
  4720. max_version: 2.49
  4721. networks_quota_set_optional:
  4722. <<: *networks_quota_optional
  4723. max_version: 2.35
  4724. new_file:
  4725. description: |
  4726. The name of the qcow2 file that Block Storage creates, which becomes the active
  4727. image for the VM.
  4728. in: body
  4729. required: true
  4730. type: string
  4731. nic_details_diagnostics:
  4732. description: |
  4733. The list of dictionaries with detailed information about VM NICs.
  4734. Following fields are presented in each dictionary:
  4735. - ``mac_address`` - Mac address of the interface (String)
  4736. - ``rx_octets`` - Received octets (Integer)
  4737. - ``rx_errors`` - Received errors (Integer)
  4738. - ``rx_drop`` - Received packets dropped (Integer)
  4739. - ``rx_packets`` - Received packets (Integer)
  4740. - ``rx_rate`` - Receive rate in bytes (Integer)
  4741. - ``tx_octets`` - Transmitted Octets (Integer)
  4742. - ``tx_errors`` - Transmit errors (Integer)
  4743. - ``tx_drop`` - Transmit dropped packets (Integer)
  4744. - ``tx_packets`` - Transmit packets (Integer)
  4745. - ``tx_rate`` - Transmit rate in bytes (Integer)
  4746. in: body
  4747. required: true
  4748. type: array
  4749. min_version: 2.48
  4750. no_device:
  4751. description: |
  4752. It is no device if ``True``.
  4753. in: body
  4754. required: false
  4755. type: boolean
  4756. num_cpus_diagnostics:
  4757. description: |
  4758. The number of vCPUs.
  4759. in: body
  4760. required: true
  4761. type: integer
  4762. min_version: 2.48
  4763. num_disks_diagnostics:
  4764. description: |
  4765. The number of disks.
  4766. in: body
  4767. required: true
  4768. type: integer
  4769. min_version: 2.48
  4770. num_nics_diagnostics:
  4771. description: |
  4772. The number of vNICs.
  4773. in: body
  4774. required: true
  4775. type: integer
  4776. min_version: 2.48
  4777. on_shared_storage:
  4778. description: |
  4779. Server on shared storage.
  4780. .. note::
  4781. Starting since version 2.14, Nova automatically detects
  4782. whether the server is on shared storage or not.
  4783. Therefore this parameter was removed.
  4784. in: body
  4785. required: true
  4786. type: boolean
  4787. max_version: 2.13
  4788. os:
  4789. description: |
  4790. The name of the operating system.
  4791. in: body
  4792. required: true
  4793. type: string
  4794. os-availability-zone:availability_zone:
  4795. description: |
  4796. The availability zone from which to launch the server. When you
  4797. provision resources, you specify from which availability zone you
  4798. want your instance to be built. Typically, an admin user will use
  4799. availability zones to arrange OpenStack compute hosts into logical
  4800. groups.
  4801. An availability zone provides a form of physical isolation and redundancy from
  4802. other availability zones. For instance, if some racks in your data center are
  4803. on a separate power source, you can put servers in those racks in their own availability
  4804. zone. Availability zones can also help separate different classes of hardware. By
  4805. segregating resources into availability zones, you can ensure that your application
  4806. resources are spread across disparate machines to achieve high availability in
  4807. the event of hardware or other failure. See
  4808. `Availability Zones (AZs) <https://docs.openstack.org/nova/latest/user/aggregates.html#availability-zones-azs>`_ for more information.
  4809. You can list the available availability zones by calling the
  4810. :ref:`os-availability-zone` API, but you should avoid using the `default
  4811. availability zone <https://docs.openstack.org/nova/latest/configuration/config.html#DEFAULT.default_availability_zone>`_
  4812. when creating the server. The default availability zone is named ``nova``.
  4813. This AZ is only shown when listing the availability zones as an admin.
  4814. in: body
  4815. required: false
  4816. type: string
  4817. OS-DCF:diskConfig:
  4818. description: |
  4819. Controls how the API partitions the disk when you create, rebuild, or resize servers.
  4820. A server inherits the ``OS-DCF:diskConfig`` value from the image from which it
  4821. was created, and an image inherits the ``OS-DCF:diskConfig`` value from the server
  4822. from which it was created. To override the inherited setting, you can include
  4823. this attribute in the request body of a server create, rebuild, or resize request. If
  4824. the ``OS-DCF:diskConfig`` value for an image is ``MANUAL``, you cannot create
  4825. a server from that image and set its ``OS-DCF:diskConfig`` value to ``AUTO``.
  4826. A valid value is:
  4827. - ``AUTO``. The API builds the server with a single partition the size of the
  4828. target flavor disk. The API automatically adjusts the file system to fit the
  4829. entire partition.
  4830. - ``MANUAL``. The API builds the server by using whatever partition scheme and
  4831. file system is in the source image. If the target flavor disk is larger, the API
  4832. does not partition the remaining disk space.
  4833. in: body
  4834. required: false
  4835. type: string
  4836. OS-EXT-AZ:availability_zone:
  4837. description: |
  4838. The availability zone name.
  4839. in: body
  4840. required: true
  4841. type: string
  4842. OS-EXT-AZ:availability_zone_optional:
  4843. description: |
  4844. The availability zone name.
  4845. in: body
  4846. required: false
  4847. type: string
  4848. OS-EXT-AZ:availability_zone_update_rebuild:
  4849. description: |
  4850. The availability zone name.
  4851. in: body
  4852. required: true
  4853. type: string
  4854. min_version: 2.75
  4855. OS-EXT-SRV-ATTR:host:
  4856. description: |
  4857. The name of the compute host on which this instance is running.
  4858. Appears in the response for administrative users only.
  4859. in: body
  4860. required: true
  4861. type: string
  4862. OS-EXT-SRV-ATTR:host_update_rebuild:
  4863. description: |
  4864. The name of the compute host on which this instance is running.
  4865. Appears in the response for administrative users only.
  4866. in: body
  4867. required: true
  4868. type: string
  4869. min_version: 2.75
  4870. OS-EXT-SRV-ATTR:hypervisor_hostname:
  4871. description: |
  4872. The hypervisor host name provided by the Nova virt driver. For the Ironic driver,
  4873. it is the Ironic node uuid. Appears in the response for administrative users only.
  4874. in: body
  4875. required: true
  4876. type: string
  4877. OS-EXT-SRV-ATTR:hypervisor_hostname_update_rebuild:
  4878. description: |
  4879. The hypervisor host name provided by the Nova virt driver. For the Ironic driver,
  4880. it is the Ironic node uuid. Appears in the response for administrative users only.
  4881. in: body
  4882. required: true
  4883. type: string
  4884. min_version: 2.75
  4885. OS-EXT-SRV-ATTR:instance_name:
  4886. description: |
  4887. The instance name. The Compute API generates the instance name from the instance
  4888. name template. Appears in the response for administrative users only.
  4889. in: body
  4890. required: true
  4891. type: string
  4892. OS-EXT-SRV-ATTR:instance_name_update_rebuild:
  4893. description: |
  4894. The instance name. The Compute API generates the instance name from the instance
  4895. name template. Appears in the response for administrative users only.
  4896. in: body
  4897. required: true
  4898. type: string
  4899. min_version: 2.75
  4900. OS-EXT-STS:power_state:
  4901. description: |
  4902. The power state of the instance. This is an enum value that is mapped as::
  4903. 0: NOSTATE
  4904. 1: RUNNING
  4905. 3: PAUSED
  4906. 4: SHUTDOWN
  4907. 6: CRASHED
  4908. 7: SUSPENDED
  4909. in: body
  4910. required: true
  4911. type: integer
  4912. OS-EXT-STS:power_state_update_rebuild:
  4913. description: |
  4914. The power state of the instance. This is an enum value that is mapped as::
  4915. 0: NOSTATE
  4916. 1: RUNNING
  4917. 3: PAUSED
  4918. 4: SHUTDOWN
  4919. 6: CRASHED
  4920. 7: SUSPENDED
  4921. in: body
  4922. required: true
  4923. type: integer
  4924. min_version: 2.75
  4925. OS-EXT-STS:task_state:
  4926. description: |
  4927. The task state of the instance.
  4928. in: body
  4929. required: true
  4930. type: string
  4931. OS-EXT-STS:task_state_update_rebuild:
  4932. description: |
  4933. The task state of the instance.
  4934. in: body
  4935. required: true
  4936. type: string
  4937. min_version: 2.75
  4938. OS-EXT-STS:vm_state:
  4939. description: |
  4940. The VM state.
  4941. in: body
  4942. required: true
  4943. type: string
  4944. OS-EXT-STS:vm_state_update_rebuild:
  4945. description: |
  4946. The VM state.
  4947. in: body
  4948. required: true
  4949. type: string
  4950. min_version: 2.75
  4951. os-extended-volumes:volumes_attached:
  4952. description: |
  4953. The attached volumes, if any.
  4954. in: body
  4955. required: true
  4956. type: array
  4957. os-extended-volumes:volumes_attached.delete_on_termination:
  4958. description: |
  4959. A flag indicating if the attached volume will be deleted
  4960. when the server is deleted. By default this is False.
  4961. in: body
  4962. required: true
  4963. type: boolean
  4964. min_version: 2.3
  4965. os-extended-volumes:volumes_attached.delete_on_termination_update_rebuild:
  4966. description: |
  4967. A flag indicating if the attached volume will be deleted
  4968. when the server is deleted. By default this is False.
  4969. in: body
  4970. required: true
  4971. type: boolean
  4972. min_version: 2.75
  4973. os-extended-volumes:volumes_attached.id:
  4974. description: |
  4975. The attached volume ID.
  4976. in: body
  4977. required: true
  4978. type: string
  4979. os-extended-volumes:volumes_attached.id_update_rebuild:
  4980. description: |
  4981. The attached volume ID.
  4982. in: body
  4983. required: true
  4984. type: string
  4985. min_version: 2.75
  4986. os-extended-volumes:volumes_attached_update_rebuild:
  4987. description: |
  4988. The attached volumes, if any.
  4989. in: body
  4990. required: true
  4991. type: array
  4992. min_version: 2.75
  4993. os-getConsoleOutput:
  4994. description: |
  4995. The action to get console output of the server.
  4996. in: body
  4997. required: true
  4998. type: object
  4999. os-getRDPConsole:
  5000. description: |
  5001. The action.
  5002. in: body
  5003. required: true
  5004. type: object
  5005. os-getRDPConsole-type:
  5006. description: |
  5007. The type of RDP console. The only valid value is ``rdp-html5``.
  5008. in: body
  5009. required: true
  5010. type: string
  5011. os-getRDPConsole-url:
  5012. description: |
  5013. The URL used to connect to the RDP console.
  5014. in: body
  5015. required: true
  5016. type: string
  5017. os-getSerialConsole:
  5018. description: |
  5019. The action.
  5020. in: body
  5021. required: true
  5022. type: object
  5023. os-getSerialConsole-type:
  5024. description: |
  5025. The type of serial console. The only valid value is ``serial``.
  5026. in: body
  5027. required: true
  5028. type: string
  5029. os-getSerialConsole-url:
  5030. description: |
  5031. The URL used to connect to the Serial console.
  5032. in: body
  5033. required: true
  5034. type: string
  5035. os-getSPICEConsole:
  5036. description: |
  5037. The action.
  5038. in: body
  5039. required: true
  5040. type: object
  5041. os-getSPICEConsole-type:
  5042. description: |
  5043. The type of SPICE console. The only valid value is ``spice-html5``.
  5044. in: body
  5045. required: true
  5046. type: string
  5047. os-getSPICEConsole-url:
  5048. description: |
  5049. The URL used to connect to the SPICE console.
  5050. in: body
  5051. required: true
  5052. type: string
  5053. os-getVNCConsole:
  5054. description: |
  5055. The action.
  5056. in: body
  5057. required: true
  5058. type: object
  5059. os-getVNCConsole-type:
  5060. description: |
  5061. The type of VNC console. The valid values are ``novnc`` and ``xvpvnc``.
  5062. in: body
  5063. required: true
  5064. type: string
  5065. os-getVNCConsole-url:
  5066. description: |
  5067. The URL used to connect to the VNC console.
  5068. in: body
  5069. required: true
  5070. type: string
  5071. os-migrateLive:
  5072. description: |
  5073. The action.
  5074. in: body
  5075. required: true
  5076. type: object
  5077. os-resetState:
  5078. description: |
  5079. The action.
  5080. in: body
  5081. required: true
  5082. type: object
  5083. os-resetState_state:
  5084. description: |
  5085. The state of the server to be set, ``active`` or ``error`` are valid.
  5086. in: body
  5087. required: true
  5088. type: string
  5089. OS-SRV-USG:launched_at:
  5090. description: |
  5091. The date and time when the server was launched.
  5092. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  5093. ::
  5094. CCYY-MM-DDThh:mm:ss±hh:mm
  5095. For example, ``2015-08-27T09:49:58-05:00``.
  5096. The ``hh±:mm`` value, if included, is the time zone as an offset from UTC.
  5097. If the ``deleted_at`` date and time stamp is not set, its value is ``null``.
  5098. in: body
  5099. required: true
  5100. type: string
  5101. OS-SRV-USG:launched_at_update_rebuild:
  5102. description: |
  5103. The date and time when the server was launched.
  5104. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  5105. ::
  5106. CCYY-MM-DDThh:mm:ss±hh:mm
  5107. For example, ``2015-08-27T09:49:58-05:00``.
  5108. The ``hh±:mm`` value, if included, is the time zone as an offset from UTC.
  5109. If the ``deleted_at`` date and time stamp is not set, its value is ``null``.
  5110. in: body
  5111. required: true
  5112. type: string
  5113. min_version: 2.75
  5114. OS-SRV-USG:terminated_at:
  5115. description: |
  5116. The date and time when the server was deleted.
  5117. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  5118. ::
  5119. CCYY-MM-DDThh:mm:ss±hh:mm
  5120. For example, ``2015-08-27T09:49:58-05:00``.
  5121. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC.
  5122. If the ``deleted_at`` date and time stamp is not set, its value is ``null``.
  5123. in: body
  5124. required: true
  5125. type: string
  5126. OS-SRV-USG:terminated_at_update_rebuild:
  5127. description: |
  5128. The date and time when the server was deleted.
  5129. The date and time stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_:
  5130. ::
  5131. CCYY-MM-DDThh:mm:ss±hh:mm
  5132. For example, ``2015-08-27T09:49:58-05:00``.
  5133. The ``±hh:mm`` value, if included, is the time zone as an offset from UTC.
  5134. If the ``deleted_at`` date and time stamp is not set, its value is ``null``.
  5135. in: body
  5136. required: true
  5137. type: string
  5138. min_version: 2.75
  5139. os-start:
  5140. description: |
  5141. The action to start a stopped server.
  5142. in: body
  5143. required: true
  5144. type: none
  5145. os-stop:
  5146. description: |
  5147. The action to stop a running server.
  5148. in: body
  5149. required: true
  5150. type: none
  5151. os:scheduler_hints:
  5152. description: |
  5153. The dictionary of data to send to the scheduler. Alternatively, you can specify
  5154. ``OS-SCH-HNT:scheduler_hints`` as the key in the request body.
  5155. .. note:: This is a top-level key in the request body, not part of the
  5156. `server` portion of the request body.
  5157. There are a few caveats with scheduler hints:
  5158. * The request validation schema is per hint. For example, some require a
  5159. single string value, and some accept a list of values.
  5160. * Hints are only used based on the cloud scheduler configuration, which
  5161. varies per deployment.
  5162. * Hints are pluggable per deployment, meaning that a cloud can have custom
  5163. hints which may not be available in another cloud.
  5164. For these reasons, it is important to consult each cloud's user
  5165. documentation to know what is available for scheduler hints.
  5166. in: body
  5167. required: false
  5168. type: object
  5169. os:scheduler_hints_build_near_host_ip:
  5170. description: |
  5171. Schedule the server on a host in the network specified with this parameter
  5172. and a cidr (``os:scheduler_hints.cidr``).
  5173. It is available when ``SimpleCIDRAffinityFilter`` is available
  5174. on cloud side.
  5175. in: body
  5176. required: false
  5177. type: string
  5178. os:scheduler_hints_cidr:
  5179. description: |
  5180. Schedule the server on a host in the network specified with an IP address
  5181. (``os:scheduler_hints:build_near_host_ip``) and this parameter.
  5182. If ``os:scheduler_hints:build_near_host_ip`` is specified and
  5183. this paramete is omitted, ``/24`` is used.
  5184. It is available when ``SimpleCIDRAffinityFilter`` is available
  5185. on cloud side.
  5186. in: body
  5187. required: false
  5188. type: string
  5189. os:scheduler_hints_different_cell:
  5190. description: |
  5191. A list of cell routes or a cell route (string).
  5192. Schedule the server in a cell that is not specified.
  5193. It is available when ``DifferentCellFilter`` is available on cloud side
  5194. that is cell v1 environment.
  5195. in: body
  5196. required: false
  5197. type: array
  5198. os:scheduler_hints_different_host:
  5199. description: |
  5200. A list of server UUIDs or a server UUID.
  5201. Schedule the server on a different host from a set of servers.
  5202. It is available when ``DifferentHostFilter`` is available on cloud side.
  5203. in: body
  5204. required: false
  5205. type: array
  5206. os:scheduler_hints_group:
  5207. description: |
  5208. The server group UUID. Schedule the server according to a policy of
  5209. the server group (``anti-affinity``, ``affinity``, ``soft-anti-affinity``
  5210. or ``soft-affinity``).
  5211. It is available when ``ServerGroupAffinityFilter``,
  5212. ``ServerGroupAntiAffinityFilter``, ``ServerGroupSoftAntiAffinityWeigher``,
  5213. ``ServerGroupSoftAffinityWeigher`` are available on cloud side.
  5214. in: body
  5215. required: false
  5216. type: string
  5217. os:scheduler_hints_query:
  5218. description: |
  5219. Schedule the server by using a custom filter in JSON format.
  5220. For example::
  5221. "query": "[\">=\",\"$free_ram_mb\",1024]"
  5222. It is available when ``JsonFilter`` is available on cloud side.
  5223. in: body
  5224. required: false
  5225. type: string
  5226. os:scheduler_hints_same_host:
  5227. description: |
  5228. A list of server UUIDs or a server UUID.
  5229. Schedule the server on the same host as another server in a set of
  5230. servers.
  5231. It is available when ``SameHostFilter`` is available on cloud side.
  5232. in: body
  5233. required: false
  5234. type: array
  5235. os:scheduler_hints_target_cell:
  5236. description: |
  5237. A target cell name. Schedule the server in a host in the cell specified.
  5238. It is available when ``TargetCellFilter`` is available on cloud side
  5239. that is cell v1 environment.
  5240. in: body
  5241. required: false
  5242. type: string
  5243. overall_status:
  5244. description: |
  5245. The overall status of instance audit tasks.
  5246. ::
  5247. M of N hosts done. K errors.
  5248. The ``M`` value is the number of hosts whose instance audit tasks have
  5249. been done in the period. The ``N`` value is the number of all hosts.
  5250. The ``K`` value is the number of hosts whose instance audit tasks
  5251. cause errors. If instance audit tasks have been done at all hosts
  5252. in the period, the overall status is as follows:
  5253. ::
  5254. ALL hosts done. K errors.
  5255. in: body
  5256. required: true
  5257. type: string
  5258. para:
  5259. description: |
  5260. The parameter object.
  5261. in: body
  5262. required: true
  5263. type: object
  5264. parent_group_id:
  5265. description: |
  5266. Security group ID.
  5267. in: body
  5268. required: true
  5269. type: string
  5270. password:
  5271. description: |
  5272. The password returned from metadata server.
  5273. in: body
  5274. required: false
  5275. type: string
  5276. path:
  5277. description: |
  5278. The path field in the personality object.
  5279. in: body
  5280. required: true
  5281. type: string
  5282. max_version: 2.56
  5283. pause:
  5284. description: |
  5285. The action to pause a server.
  5286. in: body
  5287. required: true
  5288. type: none
  5289. period_beginning:
  5290. description: |
  5291. The beginning time of the instance usage audit period.
  5292. For example, ``2016-05-01 00:00:00``.
  5293. in: body
  5294. required: true
  5295. type: string
  5296. period_ending:
  5297. description: |
  5298. The ending time of the instance usage audit period.
  5299. For example, ``2016-06-01 00:00:00``.
  5300. in: body
  5301. required: true
  5302. type: string
  5303. personality:
  5304. description: |
  5305. The file path and contents, text only, to inject into the server at launch. The
  5306. maximum size of the file path data is 255 bytes. The maximum limit is the number
  5307. of allowed bytes in the decoded, rather than encoded, data.
  5308. in: body
  5309. required: false
  5310. type: array
  5311. max_version: 2.56
  5312. policies:
  5313. description: |
  5314. A list of exactly one policy name to associate with the server group. The
  5315. current valid policy names are:
  5316. - ``anti-affinity`` - servers in this group must be scheduled to
  5317. different hosts.
  5318. - ``affinity`` - servers in this group must be scheduled to the same host.
  5319. - ``soft-anti-affinity`` - servers in this group should be scheduled to
  5320. different hosts if possible, but if not possible then they should still
  5321. be scheduled instead of resulting in a build failure. This policy was
  5322. added in microversion 2.15.
  5323. - ``soft-affinity`` - servers in this group should be scheduled to the same
  5324. host if possible, but if not possible then they should still be scheduled
  5325. instead of resulting in a build failure. This policy was added in
  5326. microversion 2.15.
  5327. in: body
  5328. required: true
  5329. type: array
  5330. max_version: 2.63
  5331. policy_name:
  5332. description: |
  5333. The ``policy`` field represents the name of the policy. The current
  5334. valid policy names are:
  5335. - ``anti-affinity`` - servers in this group must be scheduled to
  5336. different hosts.
  5337. - ``affinity`` - servers in this group must be scheduled to the same host.
  5338. - ``soft-anti-affinity`` - servers in this group should be scheduled to
  5339. different hosts if possible, but if not possible then they should still
  5340. be scheduled instead of resulting in a build failure.
  5341. - ``soft-affinity`` - servers in this group should be scheduled to the same
  5342. host if possible, but if not possible then they should still be scheduled
  5343. instead of resulting in a build failure.
  5344. in: body
  5345. required: true
  5346. type: string
  5347. min_version: 2.64
  5348. policy_rules:
  5349. description: |
  5350. The ``rules`` field, which is a dict, can be applied to the policy.
  5351. Currently, only the ``max_server_per_host`` rule is supported for the
  5352. ``anti-affinity`` policy. The ``max_server_per_host`` rule allows
  5353. specifying how many members of the anti-affinity group can reside on the
  5354. same compute host. If not specified, only one member from the same
  5355. anti-affinity group can reside on a given host.
  5356. in: body
  5357. required: true
  5358. type: object
  5359. min_version: 2.64
  5360. policy_rules_optional:
  5361. description: |
  5362. The ``rules`` field, which is a dict, can be applied to the policy.
  5363. Currently, only the ``max_server_per_host`` rule is supported for the
  5364. ``anti-affinity`` policy. The ``max_server_per_host`` rule allows
  5365. specifying how many members of the anti-affinity group can reside on the
  5366. same compute host. If not specified, only one member from the same
  5367. anti-affinity group can reside on a given host. Requesting policy rules
  5368. with any other policy than ``anti-affinity`` will be 400.
  5369. in: body
  5370. required: false
  5371. type: object
  5372. min_version: 2.64
  5373. pool:
  5374. description: |
  5375. Pool from which to allocate the IP address. If you omit this parameter, the call
  5376. allocates the floating IP address from the public pool. If no floating IP addresses
  5377. are available, the call returns the ``400`` response code with an informational
  5378. message. Policy defaults enable only users with the administrative role or the
  5379. owner of the server to perform this operation. Cloud providers can change these
  5380. permissions through the ``policy.json`` file.
  5381. in: body
  5382. required: false
  5383. type: string
  5384. port:
  5385. description: |
  5386. To provision the server instance with a NIC for an already existing port,
  5387. specify the port-id in the ``port`` attribute in a ``networks`` object.
  5388. The port status must be ``DOWN``. Required if you omit the ``uuid``
  5389. attribute. Requested security groups are not applied to pre-existing ports.
  5390. in: body
  5391. required: false
  5392. type: string
  5393. port_id:
  5394. description: |
  5395. The ID of the port for which you want to create an interface. The ``net_id``
  5396. and ``port_id`` parameters are mutually exclusive. If you do not specify the
  5397. ``port_id`` parameter, the OpenStack Networking API v2.0 allocates a port and
  5398. creates an interface for it on the network.
  5399. in: body
  5400. required: false
  5401. type: string
  5402. port_id_resp:
  5403. description: |
  5404. The port ID.
  5405. in: body
  5406. required: true
  5407. type: string
  5408. port_number:
  5409. description: |
  5410. The port number.
  5411. in: body
  5412. required: true
  5413. type: integer
  5414. port_state:
  5415. description: |
  5416. The port state.
  5417. in: body
  5418. required: true
  5419. type: string
  5420. preserve_ephemeral:
  5421. description: |
  5422. Indicates whether the server is rebuilt with the preservation of the ephemeral
  5423. partition (``true``).
  5424. .. note::
  5425. This only works with baremetal servers provided by
  5426. Ironic. Passing it to any other server instance results in a
  5427. fault and will prevent the rebuild from happening.
  5428. in: body
  5429. required: false
  5430. type: boolean
  5431. previous:
  5432. description: |
  5433. Moves to the previous metadata item.
  5434. format: uri
  5435. in: body
  5436. required: false
  5437. type: string
  5438. private_key:
  5439. description: |
  5440. The secret key.
  5441. in: body
  5442. required: true
  5443. type: string
  5444. progress:
  5445. description: |
  5446. A percentage value of the operation progress.
  5447. This parameter only appears when the server status is ``ACTIVE``,
  5448. ``BUILD``, ``REBUILD``, ``RESIZE``, ``VERIFY_RESIZE`` or ``MIGRATING``.
  5449. in: body
  5450. required: false
  5451. type: integer
  5452. project_id:
  5453. description: |
  5454. The UUID of the project. If omitted, the project ID defaults to the
  5455. calling tenant.
  5456. in: body
  5457. required: false
  5458. type: string
  5459. project_id_migration_2_80:
  5460. description: |
  5461. The ID of the project which initiated the server migration. The value
  5462. may be ``null`` for older migration records.
  5463. in: body
  5464. required: true
  5465. type: string
  5466. min_version: 2.80
  5467. project_id_server:
  5468. description: |
  5469. The ID of the project that this server belongs to.
  5470. in: body
  5471. required: true
  5472. type: string
  5473. project_id_server_action:
  5474. description: |
  5475. The ID of the project which initiated the server action.
  5476. in: body
  5477. required: true
  5478. type: string
  5479. project_id_server_group:
  5480. description: |
  5481. The project ID who owns the server group.
  5482. min_version: 2.13
  5483. in: body
  5484. required: true
  5485. type: string
  5486. project_id_value:
  5487. description: |
  5488. The project id under which the bulk ip addresses are created
  5489. in: body
  5490. required: true
  5491. type: string
  5492. quota_class_id_body:
  5493. <<: *quota_class_id
  5494. in: body
  5495. quota_class_set:
  5496. description: |
  5497. A ``quota_class_set`` object.
  5498. in: body
  5499. required: true
  5500. type: object
  5501. quota_set:
  5502. description: |
  5503. A ``quota_set`` object.
  5504. in: body
  5505. required: true
  5506. type: object
  5507. quota_tenant_or_user_id_body:
  5508. description: |
  5509. The UUID of the tenant/user the quotas listed for.
  5510. in: body
  5511. required: true
  5512. type: string
  5513. ram: &ram
  5514. description: |
  5515. The amount of allowed server RAM, in MiB, for each tenant.
  5516. in: body
  5517. required: true
  5518. type: integer
  5519. ram_quota_class: &ram_quota_class
  5520. <<: *ram
  5521. description: |
  5522. The amount of allowed instance RAM, in MiB, for the quota class.
  5523. ram_quota_class_optional:
  5524. <<: *ram_quota_class
  5525. required: false
  5526. ram_quota_details:
  5527. description: |
  5528. The object of detailed key ram quota, including in_use,
  5529. limit and reserved number of ram.
  5530. in: body
  5531. required: true
  5532. type: object
  5533. ram_quota_optional:
  5534. description: |
  5535. The amount of allowed server RAM, in MiB, for each tenant.
  5536. in: body
  5537. required: false
  5538. type: integer
  5539. reboot:
  5540. description: |
  5541. The action to reboot a server.
  5542. in: body
  5543. required: true
  5544. type: object
  5545. reboot_type:
  5546. description: |
  5547. The type of the reboot action. The valid values are ``HARD`` and ``SOFT``.
  5548. A ``SOFT`` reboot attempts a graceful shutdown and restart of the server.
  5549. A ``HARD`` reboot attempts a forced shutdown and restart of the server.
  5550. The ``HARD`` reboot corresponds to the power cycles of the server.
  5551. in: body
  5552. required: true
  5553. type: string
  5554. rebuild:
  5555. description: |
  5556. The action to rebuild a server.
  5557. in: body
  5558. required: true
  5559. type: object
  5560. remote_console:
  5561. description: |
  5562. The remote console object.
  5563. in: body
  5564. required: true
  5565. type: object
  5566. remote_console_protocol:
  5567. description: |
  5568. The protocol of remote console. The valid values are ``vnc``, ``spice``,
  5569. ``rdp``, ``serial`` and ``mks``. The protocol ``mks`` is added since
  5570. Microversion ``2.8``.
  5571. in: body
  5572. required: true
  5573. type: string
  5574. remote_console_type:
  5575. description: |
  5576. The type of remote console. The valid values are ``novnc``, ``xvpvnc``,
  5577. ``rdp-html5``, ``spice-html5``, ``serial``, and ``webmks``. The type
  5578. ``webmks`` is added since Microversion ``2.8``.
  5579. in: body
  5580. required: true
  5581. type: string
  5582. remote_console_url:
  5583. description: |
  5584. The URL is used to connect the console.
  5585. in: body
  5586. required: true
  5587. type: string
  5588. removeFixedIp:
  5589. description: |
  5590. The action to remove a fixed ip address from a server.
  5591. in: body
  5592. required: true
  5593. type: object
  5594. removeFloatingIp:
  5595. description: |
  5596. The action to remove or disassociate a floating IP address
  5597. from the server.
  5598. in: body
  5599. required: true
  5600. type: object
  5601. removeSecurityGroup:
  5602. description: |
  5603. The action to remove a security group from the server.
  5604. in: body
  5605. required: true
  5606. type: object
  5607. removeTenantAccess:
  5608. description: |
  5609. The action.
  5610. in: body
  5611. required: true
  5612. type: string
  5613. request_id_body:
  5614. description: |
  5615. The request id generated when execute the API of this action.
  5616. in: body
  5617. required: true
  5618. type: string
  5619. rescue:
  5620. description: |
  5621. The action to rescue a server.
  5622. in: body
  5623. required: true
  5624. type: object
  5625. rescue_image_ref:
  5626. description: |
  5627. The image reference to use to rescue your server instance. Specify the image reference
  5628. by ID or full URL. If you omit an image reference, default is the base image
  5629. reference.
  5630. in: body
  5631. required: false
  5632. type: string
  5633. reservation_id:
  5634. description: |
  5635. The reservation id for the server. This is an id that can
  5636. be useful in tracking groups of servers created with multiple
  5637. create, that will all have the same reservation_id.
  5638. in: body
  5639. required: true
  5640. type: string
  5641. reserved:
  5642. description: |
  5643. The reserved quota value.
  5644. in: body
  5645. required: true
  5646. type: integer
  5647. reserved_fixedip:
  5648. description: |
  5649. True if the fixed ip is reserved, otherwise False.
  5650. in: body
  5651. required: true
  5652. type: boolean
  5653. min_version: 2.4
  5654. resetNetwork:
  5655. description: |
  5656. The action.
  5657. in: body
  5658. required: true
  5659. type: none
  5660. resize:
  5661. description: |
  5662. The action to resize a server.
  5663. in: body
  5664. required: true
  5665. type: object
  5666. restore:
  5667. description: |
  5668. The action.
  5669. in: body
  5670. required: true
  5671. type: none
  5672. resume:
  5673. description: |
  5674. The action to resume a suspended server.
  5675. in: body
  5676. required: true
  5677. type: none
  5678. return_reservation_id:
  5679. description: |
  5680. Set to ``True`` to request that the response return a reservation ID instead of
  5681. instance information. Default is ``False``.
  5682. in: body
  5683. required: false
  5684. type: boolean
  5685. revertResize:
  5686. description: |
  5687. The action to revert a resize operation.
  5688. in: body
  5689. required: true
  5690. type: none
  5691. rules:
  5692. description: |
  5693. The list of security group rules.
  5694. in: body
  5695. required: true
  5696. type: array
  5697. running_vms:
  5698. description: |
  5699. The number of running vms on this hypervisor.
  5700. in: body
  5701. required: true
  5702. type: integer
  5703. running_vms_total:
  5704. description: |
  5705. The total number of running vms on all hypervisors.
  5706. in: body
  5707. required: true
  5708. type: integer
  5709. secgroup_default_rule_id:
  5710. description: |
  5711. The security group default rule ID.
  5712. in: body
  5713. required: true
  5714. type: string
  5715. secgroup_rule_cidr:
  5716. description: |
  5717. The CIDR for address range.
  5718. in: body
  5719. required: false
  5720. type: string
  5721. secgroup_rule_id:
  5722. description: |
  5723. The security group rule ID.
  5724. in: body
  5725. required: true
  5726. type: string
  5727. secgroup_rule_ip_range:
  5728. description: |
  5729. An IP range object. Includes the security group rule ``cidr``.
  5730. in: body
  5731. required: true
  5732. type: object
  5733. secgroup_tenant_id_body:
  5734. description: |
  5735. The UUID of the tenant that owns this security group.
  5736. in: body
  5737. required: false
  5738. type: string
  5739. security_group:
  5740. description: |
  5741. Specify the ``security_group`` action in the request body.
  5742. in: body
  5743. required: true
  5744. type: string
  5745. security_group_default_rule:
  5746. description: |
  5747. A ``security_group_default_rule`` object.
  5748. in: body
  5749. required: true
  5750. type: object
  5751. security_group_default_rules:
  5752. description: |
  5753. A list of the ``security_group_default_rule`` object.
  5754. in: body
  5755. required: true
  5756. type: array
  5757. security_group_id_body:
  5758. description: |
  5759. The ID of the security group.
  5760. in: body
  5761. required: true
  5762. type: string
  5763. security_group_rule:
  5764. description: |
  5765. A ``security_group_rule`` object.
  5766. in: body
  5767. required: true
  5768. type: object
  5769. security_group_rules:
  5770. description: |
  5771. The number of allowed rules for each security group.
  5772. in: body
  5773. required: false
  5774. type: integer
  5775. max_version: 2.35
  5776. security_group_rules_quota:
  5777. description: |
  5778. The number of allowed rules for each security group.
  5779. in: body
  5780. required: true
  5781. type: integer
  5782. max_version: 2.35
  5783. security_group_rules_quota_class: &security_group_rules_quota_class
  5784. description: |
  5785. The number of allowed rules for each security group.
  5786. in: body
  5787. required: true
  5788. type: integer
  5789. max_version: 2.49
  5790. security_group_rules_quota_class_optional:
  5791. <<: *security_group_rules_quota_class
  5792. required: false
  5793. security_group_rules_quota_details:
  5794. description: |
  5795. The object of detailed security group rules quota, including in_use,
  5796. limit and reserved number of security group rules.
  5797. in: body
  5798. required: true
  5799. type: object
  5800. max_version: 2.35
  5801. security_groups:
  5802. description: |
  5803. One or more security groups. Specify the name of the security group in the
  5804. ``name`` attribute. If you omit this attribute, the API creates the server
  5805. in the ``default`` security group. Requested security groups are not
  5806. applied to pre-existing ports.
  5807. in: body
  5808. required: false
  5809. type: array
  5810. security_groups_obj:
  5811. description: |
  5812. One or more security groups objects.
  5813. in: body
  5814. required: true
  5815. type: array
  5816. security_groups_obj_optional:
  5817. description: |
  5818. One or more security groups objects.
  5819. in: body
  5820. required: false
  5821. type: array
  5822. security_groups_obj_update_rebuild:
  5823. description: |
  5824. One or more security groups objects.
  5825. in: body
  5826. required: false
  5827. type: array
  5828. min_version: 2.75
  5829. security_groups_quota:
  5830. description: |
  5831. The number of allowed security groups for each tenant.
  5832. in: body
  5833. required: true
  5834. type: integer
  5835. max_version: 2.35
  5836. security_groups_quota_class: &security_groups_quota_class
  5837. description: |
  5838. The number of allowed security groups for the quota class.
  5839. in: body
  5840. required: true
  5841. type: integer
  5842. max_version: 2.49
  5843. security_groups_quota_class_optional:
  5844. <<: *security_groups_quota_class
  5845. required: false
  5846. security_groups_quota_details:
  5847. description: |
  5848. The object of detailed security groups, including in_use,
  5849. limit and reserved number of security groups.
  5850. in: body
  5851. required: true
  5852. type: object
  5853. max_version: 2.35
  5854. security_groups_quota_optional:
  5855. description: |
  5856. The number of allowed security groups for each tenant.
  5857. in: body
  5858. required: false
  5859. type: integer
  5860. max_version: 2.35
  5861. server:
  5862. description: |
  5863. A ``server`` object.
  5864. in: body
  5865. required: true
  5866. type: object
  5867. server_description:
  5868. type: string
  5869. in: body
  5870. required: false
  5871. min_version: 2.19
  5872. description: |
  5873. A free form description of the server. Limited to 255 characters
  5874. in length. Before microversion 2.19 this was set to the server
  5875. name.
  5876. server_description_resp:
  5877. description: |
  5878. The description of the server.
  5879. Before microversion 2.19 this was set to the server name.
  5880. in: body
  5881. required: true
  5882. type: string
  5883. min_version: 2.19
  5884. server_group:
  5885. description: |
  5886. The server group object.
  5887. in: body
  5888. required: true
  5889. type: object
  5890. server_group_id_body:
  5891. description: |
  5892. The UUID of the server group.
  5893. in: body
  5894. required: true
  5895. type: string
  5896. server_group_members: &server_group_members
  5897. description: |
  5898. The number of allowed members for each server group.
  5899. in: body
  5900. required: true
  5901. type: integer
  5902. server_group_members_quota_class:
  5903. <<: *server_group_members
  5904. min_version: 2.50
  5905. server_group_members_quota_details:
  5906. description: |
  5907. The object of detailed server group members, including in_use,
  5908. limit and reserved number of server group members.
  5909. in: body
  5910. required: true
  5911. type: object
  5912. server_group_members_quota_optional:
  5913. description: |
  5914. The number of allowed members for each server group.
  5915. in: body
  5916. required: false
  5917. type: integer
  5918. server_groups: &server_groups
  5919. description: |
  5920. The number of allowed server groups for each tenant.
  5921. in: body
  5922. required: true
  5923. type: integer
  5924. server_groups_2_71:
  5925. description: |
  5926. The UUIDs of the server groups to which the server belongs. Currently
  5927. this can contain at most one entry.
  5928. in: body
  5929. required: true
  5930. type: array
  5931. min_version: 2.71
  5932. server_groups_list:
  5933. description: |
  5934. The list of existing server groups.
  5935. in: body
  5936. required: true
  5937. type: array
  5938. server_groups_quota_class:
  5939. <<: *server_groups
  5940. description: |
  5941. The number of allowed server groups for the quota class.
  5942. min_version: 2.50
  5943. server_groups_quota_class_optional:
  5944. <<: *server_groups
  5945. description: |
  5946. The number of allowed server groups for the quota class.
  5947. required: false
  5948. server_groups_quota_details:
  5949. description: |
  5950. The object of detailed server groups, including in_use,
  5951. limit and reserved number of server groups.
  5952. in: body
  5953. required: true
  5954. type: object
  5955. server_groups_quota_optional:
  5956. description: |
  5957. The number of allowed server groups for each tenant.
  5958. in: body
  5959. required: false
  5960. type: integer
  5961. # This is the host in a POST (create instance) request body.
  5962. server_host_create:
  5963. description: |
  5964. The name of the compute service host on which the server is to be created.
  5965. The API will return 400 if no compute services are found with the given
  5966. host name. By default, it can be specified by administrators only.
  5967. in: body
  5968. required: false
  5969. type: string
  5970. min_version: 2.74
  5971. server_hostname:
  5972. in: body
  5973. required: false
  5974. type: string
  5975. description: |
  5976. The hostname set on the instance when it is booted.
  5977. By default, it appears in the response for administrative users only.
  5978. min_version: 2.3
  5979. server_hostname_update_rebuild:
  5980. in: body
  5981. required: false
  5982. type: string
  5983. description: |
  5984. The hostname set on the instance when it is booted.
  5985. By default, it appears in the response for administrative users only.
  5986. min_version: 2.75
  5987. # This is the hypervisor_hostname in a POST (create instance) request body.
  5988. server_hypervisor_hostname_create:
  5989. description: |
  5990. The hostname of the hypervisor on which the server is to be created.
  5991. The API will return 400 if no hypervisors are found with the given
  5992. hostname. By default, it can be specified by administrators only.
  5993. in: body
  5994. required: false
  5995. type: string
  5996. min_version: 2.74
  5997. server_id:
  5998. description: |
  5999. The UUID of the server.
  6000. in: body
  6001. required: true
  6002. type: string
  6003. server_id_optional:
  6004. description: |
  6005. The UUID of the server.
  6006. in: body
  6007. required: false
  6008. type: string
  6009. server_kernel_id:
  6010. in: body
  6011. required: false
  6012. type: string
  6013. description: |
  6014. The UUID of the kernel image when using an AMI. Will be null if not.
  6015. By default, it appears in the response for administrative users only.
  6016. min_version: 2.3
  6017. server_kernel_id_update_rebuild:
  6018. in: body
  6019. required: false
  6020. type: string
  6021. description: |
  6022. The UUID of the kernel image when using an AMI. Will be null if not.
  6023. By default, it appears in the response for administrative users only.
  6024. min_version: 2.75
  6025. server_launch_index:
  6026. in: body
  6027. required: false
  6028. type: integer
  6029. description: |
  6030. When servers are launched via multiple create, this is the
  6031. sequence in which the servers were launched.
  6032. By default, it appears in the response for administrative users only.
  6033. min_version: 2.3
  6034. server_launch_index_update_rebuild:
  6035. in: body
  6036. required: false
  6037. type: integer
  6038. description: |
  6039. When servers are launched via multiple create, this is the
  6040. sequence in which the servers were launched.
  6041. By default, it appears in the response for administrative users only.
  6042. min_version: 2.75
  6043. server_links:
  6044. description: |
  6045. Links pertaining to the server. See `API Guide / Links and
  6046. References
  6047. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  6048. for more info.
  6049. in: body
  6050. type: array
  6051. required: true
  6052. server_name:
  6053. description: |
  6054. The server name.
  6055. in: body
  6056. required: true
  6057. type: string
  6058. server_name_optional:
  6059. description: |
  6060. The server name.
  6061. in: body
  6062. required: false
  6063. type: string
  6064. server_ramdisk_id:
  6065. in: body
  6066. required: false
  6067. type: string
  6068. description: |
  6069. The UUID of the ramdisk image when using an AMI. Will be null if not.
  6070. By default, it appears in the response for administrative users only.
  6071. min_version: 2.3
  6072. server_ramdisk_id_update_rebuild:
  6073. in: body
  6074. required: false
  6075. type: string
  6076. description: |
  6077. The UUID of the ramdisk image when using an AMI. Will be null if not.
  6078. By default, it appears in the response for administrative users only.
  6079. min_version: 2.75
  6080. server_reservation_id:
  6081. in: body
  6082. required: false
  6083. type: string
  6084. description: |
  6085. The reservation id for the server. This is an id that can
  6086. be useful in tracking groups of servers created with multiple
  6087. create, that will all have the same reservation_id.
  6088. By default, it appears in the response for administrative users only.
  6089. min_version: 2.3
  6090. server_reservation_id_update_rebuild:
  6091. in: body
  6092. required: false
  6093. type: string
  6094. description: |
  6095. The reservation id for the server. This is an id that can
  6096. be useful in tracking groups of servers created with multiple
  6097. create, that will all have the same reservation_id.
  6098. By default, it appears in the response for administrative users only.
  6099. min_version: 2.75
  6100. server_root_device_name:
  6101. in: body
  6102. required: false
  6103. type: string
  6104. description: |
  6105. The root device name for the instance
  6106. By default, it appears in the response for administrative users only.
  6107. min_version: 2.3
  6108. server_root_device_name_update_rebuild:
  6109. in: body
  6110. required: false
  6111. type: string
  6112. description: |
  6113. The root device name for the instance
  6114. By default, it appears in the response for administrative users only.
  6115. min_version: 2.75
  6116. server_status:
  6117. description: |
  6118. The server status.
  6119. in: body
  6120. required: true
  6121. type: string
  6122. server_tags_create:
  6123. description: |
  6124. A list of tags. Tags have the following restrictions:
  6125. - Tag is a Unicode bytestring no longer than 60 characters.
  6126. - Tag is a non-empty string.
  6127. - '/' is not allowed to be in a tag name
  6128. - Comma is not allowed to be in a tag name in order to simplify
  6129. requests that specify lists of tags
  6130. - All other characters are allowed to be in a tag name
  6131. - Each server can have up to 50 tags.
  6132. in: body
  6133. required: false
  6134. type: array
  6135. min_version: 2.52
  6136. server_topology_nodes:
  6137. description: |
  6138. NUMA nodes information of a server.
  6139. in: body
  6140. required: true
  6141. type: array
  6142. server_topology_nodes_cpu_pinning:
  6143. description: |
  6144. The mapping of server cores to host physical CPU. for example::
  6145. cpu_pinning: { 0: 0, 1: 5}
  6146. This means vcpu 0 is mapped to physical CPU 0, and vcpu 1 is mapped
  6147. physical CPU 5.
  6148. By default the ``cpu_pinning`` field is only visible to users with the
  6149. administrative role. You can change the default behavior via the policy
  6150. rule::
  6151. compute:server:topology:host:index
  6152. in: body
  6153. required: false
  6154. type: dict
  6155. server_topology_nodes_cpu_siblings:
  6156. description: |
  6157. A mapping of host cpus thread sibling. For example::
  6158. siblings: [[0,1],[2,3]]
  6159. This means vcpu 0 and vcpu 1 belong to same CPU core, vcpu 2, vcpu 3
  6160. belong to another CPU core.
  6161. By default the ``siblings`` field is only visible to users with the
  6162. administrative role. You can change the default behavior via the policy
  6163. rule::
  6164. compute:server:topology:host:index
  6165. in: body
  6166. required: false
  6167. type: list
  6168. server_topology_nodes_host_node:
  6169. description: |
  6170. The host NUMA node the virtual NUMA node is map to.
  6171. By default the ``host_node`` field is only visible to users with the
  6172. administrator role. You can change the default behavior via the policy
  6173. rule::
  6174. compute:server:topology:host:index
  6175. in: body
  6176. required: false
  6177. type: integer
  6178. server_topology_nodes_memory_mb:
  6179. description: |
  6180. The amount of memory assigned to this NUMA node in MB.
  6181. in: body
  6182. required: false
  6183. type: integer
  6184. server_topology_nodes_vcpu_set:
  6185. description: |
  6186. A list of IDs of the virtual CPU assigned to this NUMA node.
  6187. in: body
  6188. required: false
  6189. type: list
  6190. server_topology_pagesize_kb:
  6191. description: |
  6192. The page size in KB of a server. This field is ``null`` if the
  6193. page size information is not available.
  6194. in: body
  6195. required: true
  6196. type: integer
  6197. server_trusted_image_certificates_create_req:
  6198. description: |
  6199. A list of trusted certificate IDs, which are used during image
  6200. signature verification to verify the signing certificate. The list is
  6201. restricted to a maximum of 50 IDs. This parameter is optional in server
  6202. create requests if allowed by policy, and is not supported for
  6203. volume-backed instances.
  6204. in: body
  6205. required: false
  6206. type: array
  6207. min_version: 2.63
  6208. server_trusted_image_certificates_rebuild_req:
  6209. description: |
  6210. A list of trusted certificate IDs, which are used during image
  6211. signature verification to verify the signing certificate. The list is
  6212. restricted to a maximum of 50 IDs. This parameter is optional in server
  6213. rebuild requests if allowed by policy, and is not supported
  6214. for volume-backed instances.
  6215. If ``null`` is specified, the existing trusted certificate IDs are either
  6216. unset or reset to the configured defaults.
  6217. in: body
  6218. required: false
  6219. type: array
  6220. min_version: 2.63
  6221. server_trusted_image_certificates_resp:
  6222. description: |
  6223. A list of trusted certificate IDs, that were used during image signature
  6224. verification to verify the signing certificate. The list is restricted
  6225. to a maximum of 50 IDs. The value is ``null`` if trusted certificate IDs
  6226. are not set.
  6227. in: body
  6228. required: true
  6229. type: array
  6230. min_version: 2.63
  6231. server_usages:
  6232. description: |
  6233. A list of the server usage objects.
  6234. in: body
  6235. required: true
  6236. type: array
  6237. server_usages_optional:
  6238. description: |
  6239. A list of the server usage objects.
  6240. in: body
  6241. required: false
  6242. type: array
  6243. server_user_data:
  6244. in: body
  6245. required: false
  6246. type: string
  6247. description: |
  6248. The user_data the instance was created with.
  6249. By default, it appears in the response for administrative users only.
  6250. min_version: 2.3
  6251. server_user_data_update:
  6252. in: body
  6253. required: false
  6254. type: string
  6255. description: |
  6256. The user_data the instance was created with.
  6257. By default, it appears in the response for administrative users only.
  6258. min_version: 2.75
  6259. server_uuid:
  6260. description: |
  6261. The UUID of the server instance to which the API dispatches the event. You must
  6262. assign this instance to a host. Otherwise, this call does not dispatch the event
  6263. to the instance.
  6264. in: body
  6265. required: true
  6266. type: string
  6267. servers:
  6268. description: |
  6269. A list of ``server`` objects.
  6270. in: body
  6271. required: true
  6272. type: array
  6273. servers_links:
  6274. description: |
  6275. Links to the next server. It is available when the number of servers exceeds
  6276. ``limit`` parameter or ``[api]/max_limit`` in the configuration file.
  6277. See `API Guide / Links and References
  6278. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  6279. for more info.
  6280. in: body
  6281. type: array
  6282. required: false
  6283. servers_max_count:
  6284. in: body
  6285. required: false
  6286. type: integer
  6287. description: |
  6288. The max number of servers to be created. Defaults to the value of ``min_count``.
  6289. servers_min_count:
  6290. in: body
  6291. required: false
  6292. type: integer
  6293. description: |
  6294. The min number of servers to be created. Defaults to 1.
  6295. servers_multiple_create_name:
  6296. in: body
  6297. required: true
  6298. type: string
  6299. description: |
  6300. A base name for creating unique names during multiple create.
  6301. service:
  6302. description: |
  6303. Object representing a compute service.
  6304. in: body
  6305. required: true
  6306. type: object
  6307. service_disable_reason:
  6308. description: |
  6309. The disable reason of the service, ``null`` if the service is enabled or
  6310. disabled without reason provided.
  6311. in: body
  6312. required: true
  6313. type: string
  6314. service_id_body:
  6315. description: |
  6316. The id of the service.
  6317. in: body
  6318. required: true
  6319. type: integer
  6320. service_id_body_2_52:
  6321. description: |
  6322. The id of the service.
  6323. in: body
  6324. required: true
  6325. type: integer
  6326. max_version: 2.52
  6327. service_id_body_2_53:
  6328. description: |
  6329. The id of the service as a uuid.
  6330. in: body
  6331. required: true
  6332. type: string
  6333. min_version: 2.53
  6334. service_id_body_2_53_no_version:
  6335. description: |
  6336. The id of the service as a uuid.
  6337. in: body
  6338. required: true
  6339. type: string
  6340. service_state:
  6341. description: |
  6342. The state of the service. One of ``up`` or ``down``.
  6343. in: body
  6344. required: true
  6345. type: string
  6346. service_status:
  6347. description: |
  6348. The status of the service. One of ``enabled`` or ``disabled``.
  6349. in: body
  6350. required: true
  6351. type: string
  6352. # This is an optional input parameter to PUT /os-services/{service_id} added
  6353. # in microversion 2.53.
  6354. service_status_2_53_in:
  6355. description: |
  6356. The status of the service. One of ``enabled`` or ``disabled``.
  6357. in: body
  6358. required: false
  6359. type: string
  6360. services:
  6361. description: |
  6362. A list of service objects.
  6363. in: body
  6364. required: true
  6365. type: array
  6366. set_metadata:
  6367. description: |
  6368. The set_metadata object used to set metadata for host aggregate.
  6369. in: body
  6370. required: true
  6371. type: object
  6372. shelve:
  6373. description: |
  6374. The action.
  6375. in: body
  6376. required: true
  6377. type: none
  6378. shelveOffload:
  6379. description: |
  6380. The action.
  6381. in: body
  6382. required: true
  6383. type: none
  6384. size:
  6385. description: |
  6386. The size of the volume, in gibibytes (GiB).
  6387. in: body
  6388. required: true
  6389. type: integer
  6390. snapshot:
  6391. description: |
  6392. A partial representation of a snapshot that is used to create a snapshot.
  6393. in: body
  6394. required: true
  6395. type: object
  6396. snapshot_description:
  6397. description: |
  6398. The snapshot description.
  6399. in: body
  6400. required: true
  6401. type: string
  6402. snapshot_description_optional:
  6403. description: |
  6404. The snapshot description.
  6405. in: body
  6406. required: false
  6407. type: string
  6408. snapshot_id:
  6409. description: |
  6410. The UUID for a snapshot.
  6411. in: body
  6412. required: true
  6413. type: string
  6414. snapshot_id_optional:
  6415. description: |
  6416. The UUID for a snapshot.
  6417. in: body
  6418. required: false
  6419. type: string
  6420. snapshot_id_resp_2_45:
  6421. description: |
  6422. The UUID for the resulting image snapshot.
  6423. in: body
  6424. required: true
  6425. type: string
  6426. min_version: 2.45
  6427. snapshot_name:
  6428. description: |
  6429. The snapshot name.
  6430. in: body
  6431. required: true
  6432. type: string
  6433. snapshot_name_optional:
  6434. description: |
  6435. The snapshot name.
  6436. in: body
  6437. required: false
  6438. type: string
  6439. snapshot_status:
  6440. description: |
  6441. The status of the snapshot. Valid status values are:
  6442. - ``available``
  6443. - ``creating``
  6444. - ``deleting``
  6445. - ``error``
  6446. - ``error_deleting``
  6447. in: body
  6448. required: true
  6449. type: string
  6450. snapshots:
  6451. description: |
  6452. A list of snapshot objects.
  6453. in: body
  6454. required: true
  6455. type: array
  6456. source_type:
  6457. description: |
  6458. The source type of the block device. Valid values are:
  6459. * ``blank``: Depending on the ``destination_type`` and ``guest_format``,
  6460. this will either be a blank persistent volume or an ephemeral (or swap)
  6461. disk local to the compute host on which the server resides
  6462. * ``image``: This is only valid with ``destination_type=volume``; creates
  6463. an image-backed volume in the block storage service and attaches it to
  6464. the server
  6465. * ``snapshot``: This is only valid with ``destination_type=volume``;
  6466. creates a volume backed by the given volume snapshot referenced via the
  6467. ``block_device_mapping_v2.uuid`` parameter and attaches it to the server
  6468. * ``volume``: This is only valid with ``destination_type=volume``; uses
  6469. the existing persistent volume referenced via the
  6470. ``block_device_mapping_v2.uuid`` parameter and attaches it to the server
  6471. This parameter is required unless ``block_device_mapping_v2.no_device`` is
  6472. specified.
  6473. See `Block Device Mapping in Nova <https://docs.openstack.org/nova/latest/user/block-device-mapping.html>`_
  6474. for more details on valid source and destination types.
  6475. in: body
  6476. required: false
  6477. type: string
  6478. start_simple_tenant_usage_body:
  6479. description: |
  6480. The beginning time to calculate usage statistics on compute and
  6481. storage resources. The date and time stamp format is as follows:
  6482. ::
  6483. CCYY-MM-DDThh:mm:ss.NNNNNN
  6484. For example, ``2015-08-27T09:49:58.123456``.
  6485. in: body
  6486. required: true
  6487. type: string
  6488. start_time:
  6489. description: |
  6490. The date and time when the action was started. The date and time
  6491. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  6492. ::
  6493. CCYY-MM-DDThh:mm:ss±hh:mm
  6494. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  6495. value, if included, is the time zone as an offset from UTC. In
  6496. the previous example, the offset value is ``-05:00``.
  6497. in: body
  6498. required: true
  6499. type: string
  6500. started_at:
  6501. description: |
  6502. The date and time when the server was launched.
  6503. The date and time stamp format is as follows:
  6504. ::
  6505. CCYY-MM-DDThh:mm:ss.NNNNNN
  6506. For example, ``2015-08-27T09:49:58.123456``.
  6507. in: body
  6508. required: true
  6509. type: string
  6510. started_at_optional:
  6511. description: |
  6512. The date and time when the server was launched.
  6513. The date and time stamp format is as follows:
  6514. ::
  6515. CCYY-MM-DDThh:mm:ss.NNNNNN
  6516. For example, ``2015-08-27T09:49:58.123456``.
  6517. in: body
  6518. required: false
  6519. type: string
  6520. stop_simple_tenant_usage:
  6521. description: |
  6522. The ending time to calculate usage statistics on compute and
  6523. storage resources. The date and time stamp format is as follows:
  6524. ::
  6525. CCYY-MM-DDThh:mm:ss.NNNNNN
  6526. For example, ``2015-08-27T09:49:58.123456``.
  6527. in: body
  6528. required: true
  6529. type: string
  6530. subnet_id:
  6531. description: |
  6532. The UUID of the subnet.
  6533. in: body
  6534. required: true
  6535. type: string
  6536. suspend:
  6537. description: |
  6538. The action to suspend a server.
  6539. in: body
  6540. required: true
  6541. type: none
  6542. tags:
  6543. description: |
  6544. A list of tags. The maximum count of tags in this list is 50.
  6545. in: body
  6546. required: true
  6547. type: array
  6548. min_version: 2.26
  6549. tags_no_min:
  6550. description: |
  6551. A list of tags. The maximum count of tags in this list is 50.
  6552. in: body
  6553. required: true
  6554. type: array
  6555. tenant_id_body:
  6556. description: |
  6557. The UUID of the tenant in a multi-tenancy cloud.
  6558. in: body
  6559. required: true
  6560. type: string
  6561. tenant_id_optional:
  6562. description: |
  6563. The UUID of the tenant in a multi-tenancy cloud.
  6564. in: body
  6565. required: false
  6566. type: string
  6567. tenant_usage:
  6568. description: |
  6569. The tenant usage object.
  6570. in: body
  6571. required: true
  6572. type: object
  6573. tenant_usages:
  6574. description: |
  6575. A list of the tenant usage objects.
  6576. in: body
  6577. required: true
  6578. type: array
  6579. to_port:
  6580. description: |
  6581. The port at end of range.
  6582. in: body
  6583. required: true
  6584. type: integer
  6585. total_cores_used:
  6586. description: |
  6587. The number of used server cores in each tenant.
  6588. If ``reserved`` query parameter is specified and it is not 0,
  6589. the number of reserved server cores are also included.
  6590. in: body
  6591. required: true
  6592. type: integer
  6593. total_errors:
  6594. description: |
  6595. The total number of instance audit task errors.
  6596. in: body
  6597. required: true
  6598. type: integer
  6599. total_floatingips_used:
  6600. description: |
  6601. The number of used floating IP addresses in each tenant.
  6602. If ``reserved`` query parameter is specified and it is not 0,
  6603. the number of reserved floating IP addresses are also included.
  6604. in: body
  6605. required: true
  6606. type: integer
  6607. max_version: 2.35
  6608. total_hours:
  6609. description: |
  6610. The total duration that servers exist (in hours).
  6611. in: body
  6612. required: true
  6613. type: float
  6614. total_instances:
  6615. description: |
  6616. The total number of VM instances in the period.
  6617. in: body
  6618. required: true
  6619. type: integer
  6620. total_instances_used:
  6621. description: |
  6622. The number of servers in each tenant.
  6623. If ``reserved`` query parameter is specified and it is not 0,
  6624. the number of reserved servers are also included.
  6625. in: body
  6626. required: true
  6627. type: integer
  6628. total_local_gb_usage:
  6629. description: |
  6630. Multiplying the server disk size (in GiB) by hours the server exists,
  6631. and then adding that all together for each server.
  6632. in: body
  6633. required: true
  6634. type: float
  6635. total_memory_mb_usage:
  6636. description: |
  6637. Multiplying the server memory size (in MiB) by hours the server exists,
  6638. and then adding that all together for each server.
  6639. in: body
  6640. required: true
  6641. type: float
  6642. total_ram_used:
  6643. description: |
  6644. The amount of used server RAM in each tenant.
  6645. If ``reserved`` query parameter is specified and it is not 0,
  6646. the amount of reserved server RAM is also included.
  6647. in: body
  6648. required: true
  6649. type: integer
  6650. total_security_groups_used:
  6651. description: |
  6652. The number of used security groups in each tenant.
  6653. If ``reserved`` query parameter is specified and it is not 0,
  6654. the number of reserved security groups are also included.
  6655. in: body
  6656. required: true
  6657. type: integer
  6658. max_version: 2.35
  6659. total_server_groups_used:
  6660. description: |
  6661. The number of used server groups in each tenant.
  6662. If ``reserved`` query parameter is specified and it is not 0,
  6663. the number of reserved server groups are also included.
  6664. in: body
  6665. required: true
  6666. type: integer
  6667. total_vcpus_usage:
  6668. description: |
  6669. Multiplying the number of virtual CPUs of the server by hours the server exists,
  6670. and then adding that all together for each server.
  6671. in: body
  6672. required: true
  6673. type: float
  6674. trigger_crash_dump:
  6675. in: body
  6676. required: true
  6677. type: none
  6678. description: |
  6679. Specifies the trigger crash dump action should be run
  6680. type-os-assisted-volume-snapshot:
  6681. description: |
  6682. The snapshot type. A valid value is ``qcow2``.
  6683. in: body
  6684. required: true
  6685. type: string
  6686. unlock:
  6687. description: |
  6688. The action to unlock a locked server.
  6689. in: body
  6690. required: true
  6691. type: none
  6692. unpause:
  6693. description: |
  6694. The action to unpause a paused server.
  6695. in: body
  6696. required: true
  6697. type: none
  6698. unrescue:
  6699. description: |
  6700. The action to unrescue a server in rescue mode.
  6701. in: body
  6702. required: true
  6703. type: none
  6704. unshelve:
  6705. description: |
  6706. The action.
  6707. in: body
  6708. required: true
  6709. type: none
  6710. updated:
  6711. description: |
  6712. The date and time when the resource was updated. The date and time
  6713. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  6714. ::
  6715. CCYY-MM-DDThh:mm:ss±hh:mm
  6716. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  6717. value, if included, is the time zone as an offset from UTC. In
  6718. the previous example, the offset value is ``-05:00``.
  6719. in: body
  6720. required: true
  6721. type: string
  6722. updated_consider_null:
  6723. description: |
  6724. The date and time when the resource was updated, if the resource has
  6725. not been updated, this field will show as ``null``. The date and time
  6726. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  6727. ::
  6728. CCYY-MM-DDThh:mm:ss±hh:mm
  6729. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  6730. value, if included, is the time zone as an offset from UTC. In
  6731. the previous example, the offset value is ``-05:00``.
  6732. in: body
  6733. required: true
  6734. type: string
  6735. updated_instance_action:
  6736. description: |
  6737. The date and time when the instance action or the action event of
  6738. instance action was updated. The date and time stamp format is
  6739. `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  6740. ::
  6741. CCYY-MM-DDThh:mm:ss±hh:mm
  6742. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  6743. value, if included, is the time zone as an offset from UTC. In
  6744. the previous example, the offset value is ``-05:00``.
  6745. in: body
  6746. required: true
  6747. type: string
  6748. min_version: 2.58
  6749. updated_version:
  6750. description: |
  6751. This is a fixed string. It is ``2011-01-21T11:33:21Z`` in version 2.0,
  6752. ``2013-07-23T11:33:21Z`` in version 2.1.
  6753. .. note::
  6754. It is vestigial and provides no useful information.
  6755. It will be deprecated and removed in the future.
  6756. in: body
  6757. required: true
  6758. type: string
  6759. uptime:
  6760. description: |
  6761. The total uptime of the hypervisor and information about average
  6762. load.
  6763. in: body
  6764. required: true
  6765. type: string
  6766. uptime_diagnostics:
  6767. description: |
  6768. The amount of time in seconds that the VM has been running.
  6769. in: body
  6770. required: true
  6771. type: integer
  6772. min_version: 2.48
  6773. uptime_simple_tenant_usage:
  6774. description: |
  6775. The uptime of the server.
  6776. in: body
  6777. required: true
  6778. type: integer
  6779. uptime_simple_tenant_usage_optional:
  6780. description: |
  6781. The uptime of the server.
  6782. in: body
  6783. required: false
  6784. type: integer
  6785. url:
  6786. description: |
  6787. The URL associated with the agent.
  6788. in: body
  6789. required: true
  6790. type: string
  6791. usage_links:
  6792. description: |
  6793. Links pertaining to usage. See `API Guide / Links and
  6794. References
  6795. <https://docs.openstack.org/api-guide/compute/links_and_references.html>`_
  6796. for more info.
  6797. in: body
  6798. type: array
  6799. required: false
  6800. min_version: 2.40
  6801. user_data:
  6802. description: |
  6803. Configuration information or scripts to use upon launch.
  6804. Must be Base64 encoded. Restricted to 65535 bytes.
  6805. .. note::
  6806. The ``null`` value allowed in Nova legacy v2 API, but due to the strict
  6807. input validation, it isn't allowed in Nova v2.1 API.
  6808. in: body
  6809. required: false
  6810. type: string
  6811. user_data_rebuild_req:
  6812. description: |
  6813. Configuration information or scripts to use upon rebuild.
  6814. Must be Base64 encoded. Restricted to 65535 bytes.
  6815. If ``null`` is specified, the existing user_data is unset.
  6816. in: body
  6817. required: false
  6818. type: string
  6819. min_version: 2.57
  6820. user_data_rebuild_resp:
  6821. in: body
  6822. required: true
  6823. type: string
  6824. description: |
  6825. The current user_data for the instance.
  6826. min_version: 2.57
  6827. user_id:
  6828. description: |
  6829. The user ID of the user who owns the server.
  6830. in: body
  6831. required: true
  6832. type: string
  6833. user_id_migration_2_80:
  6834. description: |
  6835. The ID of the user which initiated the server migration. The value
  6836. may be ``null`` for older migration records.
  6837. in: body
  6838. required: true
  6839. type: string
  6840. min_version: 2.80
  6841. user_id_server_action:
  6842. description: |
  6843. The ID of the user which initiated the server action.
  6844. in: body
  6845. required: true
  6846. type: string
  6847. user_id_server_group:
  6848. description: |
  6849. The user ID who owns the server group.
  6850. min_version: 2.13
  6851. in: body
  6852. required: true
  6853. type: string
  6854. vcpus:
  6855. description: |
  6856. The number of virtual CPUs that the server uses.
  6857. in: body
  6858. required: true
  6859. type: integer
  6860. vcpus_optional:
  6861. description: |
  6862. The number of virtual CPUs that the server uses.
  6863. in: body
  6864. required: false
  6865. type: integer
  6866. version:
  6867. description: |
  6868. The version.
  6869. in: body
  6870. required: true
  6871. type: string
  6872. version_id:
  6873. type: string
  6874. in: body
  6875. required: true
  6876. description: >
  6877. A common name for the version in question. Informative only, it
  6878. has no real semantic meaning.
  6879. version_ip:
  6880. description: |
  6881. The IP version of the address associated with server.
  6882. in: body
  6883. required: true
  6884. type: integer
  6885. version_max:
  6886. type: string
  6887. in: body
  6888. required: true
  6889. description: >
  6890. If this version of the API supports microversions, the maximum
  6891. microversion that is supported. This will be the empty string if
  6892. microversions are not supported.
  6893. version_min:
  6894. type: string
  6895. in: body
  6896. required: true
  6897. description: >
  6898. If this version of the API supports microversions, the minimum
  6899. microversion that is supported. This will be the empty string if
  6900. microversions are not supported.
  6901. version_status:
  6902. type: string
  6903. in: body
  6904. required: true
  6905. description: |
  6906. The status of this API version. This can be one of:
  6907. - ``CURRENT``: this is the preferred version of the API to use
  6908. - ``SUPPORTED``: this is an older, but still supported version of the API
  6909. - ``DEPRECATED``: a deprecated version of the API that is slated for removal
  6910. versions:
  6911. type: array
  6912. in: body
  6913. required: true
  6914. description: >
  6915. A list of version objects that describe the API versions available.
  6916. virtual_interface:
  6917. description: |
  6918. Virtual interface for the floating ip address.
  6919. in: body
  6920. required: true
  6921. type: string
  6922. virtual_interface_id:
  6923. description: |
  6924. The UUID of the virtual interface.
  6925. in: body
  6926. required: true
  6927. type: string
  6928. virtual_interface_id_optional:
  6929. description: |
  6930. Virtual interface for the floating ip address
  6931. in: body
  6932. required: false
  6933. type: string
  6934. virtual_interfaces:
  6935. description: |
  6936. An array of virtual interfaces.
  6937. in: body
  6938. required: true
  6939. type: array
  6940. vm_state_diagnostics:
  6941. description: |
  6942. A string enum denoting the current state of the VM. Possible values are:
  6943. - ``pending``
  6944. - ``running``
  6945. - ``paused``
  6946. - ``shutdown``
  6947. - ``crashed``
  6948. - ``suspended``
  6949. in: body
  6950. required: true
  6951. type: string
  6952. min_version: 2.48
  6953. vm_state_optional:
  6954. description: |
  6955. The VM state.
  6956. in: body
  6957. required: false
  6958. type: string
  6959. volume:
  6960. description: |
  6961. The ``volume`` object.
  6962. in: body
  6963. required: true
  6964. type: object
  6965. volume_id:
  6966. description: |
  6967. The source volume ID.
  6968. in: body
  6969. required: true
  6970. type: string
  6971. volume_id_resp:
  6972. description: |
  6973. The UUID of the volume.
  6974. in: body
  6975. required: true
  6976. type: string
  6977. volume_size:
  6978. description: |
  6979. The size of the volume (in GiB).
  6980. This is integer value from range 1 to 2147483647
  6981. which can be requested as integer and string.
  6982. This parameter must be specified in the following cases:
  6983. - An image to volume case
  6984. * ``block_device_mapping_v2.source_type`` is ``image``
  6985. * ``block_device_mapping_v2.destination_type`` is ``volume``
  6986. - A blank to volume case
  6987. * ``block_device_mapping_v2.source_type`` is ``blank``
  6988. * ``block_device_mapping_v2.destination_type`` is ``volume``
  6989. in: body
  6990. required: false
  6991. type: integer
  6992. volume_status:
  6993. description: |
  6994. The status of the volume.
  6995. in: body
  6996. required: true
  6997. type: string
  6998. volume_type:
  6999. description: |
  7000. The name or unique identifier for a volume type.
  7001. in: body
  7002. required: true
  7003. type: string
  7004. volume_type_optional:
  7005. description: |
  7006. The unique identifier for a volume type.
  7007. in: body
  7008. required: false
  7009. type: string
  7010. # This is the volumeAttachment in a response body.
  7011. volumeAttachment:
  7012. description: |
  7013. A dictionary representation of a volume attachment containing the fields
  7014. ``device``, ``id``, ``serverId`` and ``volumeId``.
  7015. in: body
  7016. required: true
  7017. type: object
  7018. # This is the volumeAttachment in a POST (attach volume) request body.
  7019. volumeAttachment_post:
  7020. description: |
  7021. A dictionary representation of a volume attachment containing the fields
  7022. ``device`` and ``volumeId``.
  7023. in: body
  7024. required: true
  7025. type: object
  7026. # This is the volumeAttachment in a PUT (swap volume) request body.
  7027. volumeAttachment_put:
  7028. description: |
  7029. A dictionary representation of a volume attachment containing the field
  7030. ``volumeId`` which is the UUID of the replacement volume.
  7031. in: body
  7032. required: true
  7033. type: object
  7034. volumeAttachments:
  7035. description: |
  7036. The list of volume attachments.
  7037. in: body
  7038. required: true
  7039. type: array
  7040. volumeId:
  7041. description: |
  7042. The UUID of the volume to attach.
  7043. in: body
  7044. required: true
  7045. type: string
  7046. volumeId_resp:
  7047. description: |
  7048. The UUID of the attached volume.
  7049. in: body
  7050. required: true
  7051. type: string
  7052. volumeId_swap:
  7053. description: |
  7054. The UUID of the volume to attach instead of the attached volume.
  7055. in: body
  7056. required: true
  7057. type: string
  7058. volumes:
  7059. description: |
  7060. The list of ``volume`` objects.
  7061. in: body
  7062. required: true
  7063. type: array
  7064. vpn_public_ip:
  7065. description: |
  7066. The VPN IP address.
  7067. in: body
  7068. required: true
  7069. type: string
  7070. vpn_public_ip_resp:
  7071. description: |
  7072. The VPN public IP address.
  7073. in: body
  7074. required: false
  7075. type: string
  7076. vpn_public_port:
  7077. description: |
  7078. The VPN port.
  7079. in: body
  7080. required: true
  7081. type: string
  7082. vpn_public_port_resp:
  7083. description: |
  7084. The VPN public port.
  7085. in: body
  7086. required: false
  7087. type: string
  7088. vpn_state:
  7089. description: |
  7090. The VPN state.
  7091. in: body
  7092. required: false
  7093. type: string