OpenStack Baremetal Compute Service
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.

parameters.yaml 20KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784
  1. # variables in header
  2. openstack-request-id:
  3. description: >
  4. A unique ID for tracking the request. The request ID associated with the request
  5. appears in the log lines for that request. By default, the middleware configuration
  6. ensures that the request ID appears in the log files.
  7. in: header
  8. required: true
  9. type: string
  10. # variables in path
  11. address_path:
  12. description: |
  13. The floating IP address.
  14. in: path
  15. required: true
  16. type: string
  17. aggregate_node_path:
  18. description: |
  19. The name of the node.
  20. in: path
  21. required: true
  22. type: string
  23. aggregate_uuid_path:
  24. description: |
  25. The UUID of the aggregate.
  26. in: path
  27. required: true
  28. type: string
  29. api_version:
  30. in: path
  31. required: true
  32. type: string
  33. description: >
  34. The API version as returned in the links from the ``GET /`` call.
  35. flavor_uuid_path:
  36. description: |
  37. The UUID of the flavor.
  38. in: path
  39. required: true
  40. type: string
  41. port_ident:
  42. description: |
  43. The UUID of a network port.
  44. in: path
  45. required: true
  46. type: string
  47. server_group_uuid_path:
  48. description: |
  49. The UUID of the server group.
  50. in: path
  51. required: true
  52. type: string
  53. server_ident:
  54. description: |
  55. The UUID of the server.
  56. in: path
  57. required: true
  58. type: string
  59. spec_key_path:
  60. description: |
  61. The key of the extra spec.
  62. in: path
  63. required: true
  64. type: string
  65. tenant_id_path:
  66. description: |
  67. The UUID of the tenant in a multi-tenancy cloud.
  68. in: path
  69. required: true
  70. type: string
  71. # variables in query
  72. all_tenants:
  73. description: |
  74. Specify the ``all_tenants=1`` query parameter to list all servers
  75. for all projects. By default this is only allowed by admin users.
  76. in: query
  77. required: false
  78. type: integer
  79. fields:
  80. description: |
  81. One or more fields to be returned in the response.
  82. For example, the following request returns only the ``uuid``
  83. and ``name`` fields for each server:
  84. ::
  85. GET /v1/servers?fields=uuid,name
  86. in: query
  87. required: false
  88. type: array
  89. fixed_ip_query:
  90. description: |
  91. Filters the server list result by fixed ip. Users can filter by prefix of ip address.
  92. in: query
  93. required: false
  94. type: string
  95. flavor_name_query:
  96. description: |
  97. Filters the server list by flavor's name.
  98. in: query
  99. required: false
  100. type: string
  101. flavor_query:
  102. description: |
  103. Filters the server list by flavor's UUID.
  104. in: query
  105. required: false
  106. type: string
  107. group_all_tenants:
  108. description: |
  109. Specify the ``all_tenants=1`` query parameter to list server groups
  110. for all projects. By default this is only allowed by admin users.
  111. in: query
  112. required: false
  113. type: integer
  114. image_query:
  115. description: |
  116. Filters the server list by image's UUID.
  117. in: query
  118. required: false
  119. type: string
  120. limit:
  121. description: |
  122. Requests a page size of items. Returns a number of items up to a limit value.
  123. Use the ``limit`` parameter to make an initial limited request and use the ID
  124. of the last-seen item from the response as the ``marker`` parameter value in a
  125. subsequent limited request.
  126. in: query
  127. required: false
  128. type: integer
  129. marker:
  130. description: |
  131. The ID of the last-seen item. Use the ``limit`` parameter to make an initial limited
  132. request and use the ID of the last-seen item from the response as the ``marker``
  133. parameter value in a subsequent limited request.
  134. in: query
  135. required: false
  136. type: string
  137. server_name_query:
  138. description: |
  139. Filters the server list by name. Users can filter by prefix of server's name.
  140. in: query
  141. required: false
  142. type: string
  143. sort_dir:
  144. description: |
  145. Sort direction. A valid value is ``asc`` (ascending) or ``desc`` (descending).
  146. Default is ``asc``. You can specify multiple pairs of sort key and sort direction
  147. query parameters. If you omit the sort direction in a pair, the API uses the natural
  148. sorting direction of the direction of the server ``sort_key`` attribute.
  149. in: query
  150. required: false
  151. type: string
  152. sort_key:
  153. description: |
  154. Sorts the response by the this attribute value.
  155. Default is ``id``. You can specify multiple pairs of sort key and
  156. sort direction query parameters. If you omit the sort direction in
  157. a pair, the API uses the natural sorting direction of the server
  158. attribute that is provided as the ``sort_key``.
  159. in: query
  160. required: false
  161. type: string
  162. status_query:
  163. description: |
  164. Filters the server list by the server's status.
  165. in: query
  166. required: false
  167. type: string
  168. user_id:
  169. description: |
  170. Filters the response by a user, by ID.
  171. in: query
  172. required: false
  173. type: string
  174. # variables in body
  175. address:
  176. description: |
  177. The floating IP address.
  178. in: body
  179. required: true
  180. type: string
  181. addresses:
  182. description: |
  183. The addresses for the server.
  184. in: body
  185. required: true
  186. type: object
  187. adminPass:
  188. description: |
  189. The administrative password of the server. If you omit this parameter, the operation
  190. generates a new password.
  191. in: body
  192. required: false
  193. type: string
  194. affinity_zone:
  195. description: |
  196. The affinity zone which the server belongs to.
  197. in: body
  198. required: false
  199. type: string
  200. aggregate_metadata:
  201. description: |
  202. Metadata key and value pairs associate with the aggregate.
  203. in: body
  204. required: true
  205. type: object
  206. aggregate_name:
  207. description: |
  208. The name of the node aggregate.
  209. in: body
  210. required: true
  211. type: string
  212. aggregate_node:
  213. description: |
  214. The name of the node.
  215. in: body
  216. required: true
  217. type: string
  218. aggregate_nodes:
  219. description: |
  220. An array of node information.
  221. in: body
  222. required: true
  223. type: array
  224. aggregate_uuid:
  225. description: |
  226. The UUID of the node aggregate.
  227. in: body
  228. required: true
  229. type: string
  230. aggregates:
  231. description: |
  232. The list of existing aggregates.
  233. in: body
  234. required: true
  235. type: array
  236. availability_zone:
  237. description: |
  238. The availability zone from which to launch the server. When you provision resources,
  239. you specify from which availability zone you want your server to be built. Typically,
  240. you use availability zones to arrange bare metal nodes into logical groups.
  241. An availability zone provides a form of physical isolation and redundancy from
  242. other availability zones. For server, if some racks in your data center are
  243. on a separate power source, you can put servers in those racks in their own availability
  244. zone. Availability zones can also help separate different classes of hardware. By
  245. segregating resources into availability zones, you can ensure that your application
  246. resources are spread across disparate machines to achieve high availability in
  247. the event of hardware or other failure.
  248. in: body
  249. required: false
  250. type: string
  251. availability_zones:
  252. description: |
  253. An array of availability zone name.
  254. in: body
  255. required: true
  256. type: array
  257. console_info:
  258. description: |
  259. The remote console object.
  260. in: body
  261. required: true
  262. type: object
  263. console_url:
  264. description: |
  265. The URL is used to connect the console.
  266. in: body
  267. required: true
  268. type: string
  269. created_at:
  270. description: |
  271. The date and time when the resource was created. The date and time
  272. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  273. ::
  274. CCYY-MM-DDThh:mm:ss±hh:mm
  275. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  276. value, if included, is the time zone as an offset from UTC. In
  277. the previous example, the offset value is ``-05:00``.
  278. in: body
  279. required: true
  280. type: string
  281. fixed_address:
  282. description: |
  283. The fixed IP address with which you want to associate the floating IP address.
  284. in: body
  285. required: false
  286. type: string
  287. flavor_access:
  288. description: |
  289. A list of tenants.
  290. in: body
  291. required: true
  292. type: array
  293. flavor_aggregates:
  294. description: |
  295. A dict of key and value pairs associate with the flavor including the resources
  296. aggregate metadata.
  297. in: body
  298. required: true
  299. type: object
  300. flavor_description:
  301. description: |
  302. The description of the flavor.
  303. in: body
  304. required: true
  305. type: string
  306. flavor_disabled:
  307. description: |
  308. Whether or not the flavor has been administratively disabled.
  309. in: body
  310. required: false
  311. type: boolean
  312. flavor_is_public:
  313. description: |
  314. Whether the flavor is public (available to all projects) or scoped
  315. to a set of projects. Default is True if not specified.
  316. in: body
  317. required: true
  318. type: boolean
  319. flavor_is_public_not_required:
  320. description: |
  321. Whether the flavor is public (available to all projects) or scoped
  322. to a set of projects. Default is True if not specified.
  323. in: body
  324. required: false
  325. type: boolean
  326. flavor_name:
  327. description: |
  328. The name of the flavor.
  329. in: body
  330. required: true
  331. type: string
  332. flavor_resources:
  333. description: |
  334. A dict of key and value pairs associate with the flavor including the resource
  335. name and the quantity.
  336. in: body
  337. required: true
  338. type: object
  339. flavor_uuid:
  340. description: |
  341. The UUID of the flavor.
  342. in: body
  343. required: true
  344. type: string
  345. flavorRef:
  346. description: |
  347. The flavor reference, as a UUID for the flavor for your server server.
  348. in: body
  349. required: true
  350. type: string
  351. flavors:
  352. description: |
  353. An array of flavor objects.
  354. in: body
  355. required: true
  356. type: array
  357. image_ident:
  358. description: |
  359. The UUID of the image to apply to rebuild your server.
  360. in: body
  361. required: false
  362. type: string
  363. imageRef:
  364. description: |
  365. The UUID of the image to use for your server.
  366. in: body
  367. required: true
  368. type: string
  369. key_name:
  370. description: |
  371. Key pair name.
  372. in: body
  373. required: false
  374. type: string
  375. keypair_fingerprint:
  376. in: body
  377. required: true
  378. type: string
  379. description: |
  380. The fingerprint for the keypair.
  381. keypair_name:
  382. in: body
  383. required: true
  384. type: string
  385. description: |
  386. A name for the keypair which will be used to reference it later.
  387. keypair_private_key:
  388. description: |
  389. If you do not provide a public key on create, a new keypair will
  390. be built for you, and the private key will be returned during the
  391. initial create call. Make sure to save this, as there is no way to
  392. get this private key again in the future.
  393. in: body
  394. required: false
  395. type: string
  396. keypair_public_key:
  397. description: |
  398. The keypair public key.
  399. in: body
  400. required: true
  401. type: string
  402. keypair_public_key_in:
  403. description: |
  404. The public ssh key to import. If you omit this value, a keypair is
  405. generated for you.
  406. in: body
  407. required: false
  408. type: string
  409. keypair_type:
  410. in: body
  411. required: true
  412. type: string
  413. description: |
  414. The type of the keypair. Allowed values are ``ssh`` or ``x509``.
  415. keypair_type_in:
  416. in: body
  417. required: false
  418. type: string
  419. description: |
  420. The type of the keypair. Allowed values are ``ssh`` or ``x509``.
  421. keypair_userid:
  422. in: body
  423. required: true
  424. type: string
  425. description: |
  426. The user_id for a keypair.
  427. keypair_userid_in:
  428. in: body
  429. required: false
  430. type: string
  431. description: |
  432. The user_id for a keypair. This allows administrative users to
  433. upload keys for other users than themselves.
  434. keypairs:
  435. in: body
  436. type: array
  437. required: true
  438. description: |
  439. Array of Keypair objects
  440. launched_at:
  441. description: |
  442. The date and time when the server was launched. The date and time
  443. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  444. ::
  445. CCYY-MM-DDThh:mm:ss±hh:mm
  446. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  447. value, if included, is the time zone as an offset from UTC. In
  448. the previous example, the offset value is ``-05:00``.
  449. in: body
  450. required: true
  451. type: string
  452. links:
  453. description: |
  454. A list of relative links. Includes the self and bookmark links.
  455. in: body
  456. required: true
  457. type: array
  458. lock_state:
  459. description: |
  460. The lock state of a server.
  461. in: body
  462. required: true
  463. type: boolean
  464. manageable_servers:
  465. description: |
  466. An array of manageable servers information.
  467. in: body
  468. required: true
  469. type: array
  470. manageable_servers_image_source:
  471. description: |
  472. Image source uuid of manageable server.
  473. in: body
  474. required: true
  475. type: string
  476. manageable_servers_name:
  477. description: |
  478. Name of manageable server.
  479. in: body
  480. required: true
  481. type: string
  482. manageable_servers_portgroups:
  483. description: |
  484. The portgroups of manageable server.
  485. in: body
  486. required: true
  487. type: array
  488. manageable_servers_ports:
  489. description: |
  490. The ports of manageable server.
  491. in: body
  492. required: true
  493. type: array
  494. manageable_servers_power_state:
  495. description: |
  496. The power state of manageable server.
  497. in: body
  498. required: true
  499. type: string
  500. manageable_servers_provision_state:
  501. description: |
  502. The provision state of manageable server.
  503. in: body
  504. required: true
  505. type: string
  506. manageable_servers_resource_class:
  507. description: |
  508. Resource class of manageable server.
  509. in: body
  510. required: true
  511. type: string
  512. manageable_servers_uuid:
  513. description: |
  514. UUID of manageable server.
  515. in: body
  516. required: true
  517. type: string
  518. max_count_body:
  519. description: |
  520. The max number of servers to be created. Defaults to the value of ``min_count``.
  521. in: body
  522. required: false
  523. type: integer
  524. metadata:
  525. description: |
  526. Metadata key and value pairs. The maximum size of the metadata key and value is
  527. 255 bytes each.
  528. in: body
  529. required: false
  530. type: object
  531. min_count_body:
  532. description: |
  533. The min number of servers to be created. Defaults to 1.
  534. in: body
  535. required: false
  536. type: integer
  537. multi_server_name_body:
  538. description: |
  539. A base name for creating unique names during multiple create. A unique
  540. string will be appended to the end of this base name for every instacne
  541. created.
  542. in: body
  543. required: true
  544. type: string
  545. network_uuid:
  546. description: |
  547. To provision the server with a NIC for a network, specify the UUID of
  548. the network with the ``net_id`` key in a dict in ``networks`` list.
  549. in: body
  550. required: false
  551. type: string
  552. networks:
  553. description: |
  554. A list of networks of the tenant. Optionally, you can create one or more NICs on the server.
  555. To provision the server with a NIC for a network, specify the UUID of the network
  556. with the ``net_id`` key in a dict in ``networks`` list. To provision the server with a
  557. specified type of NIC, specify the port-type key in a dict in a ``networks`` list.
  558. To provision the server with a NIC for an already existing port, specify the port_id in
  559. a ``networks`` list. Now net_id and port_id are exclusive, so you should use only one of
  560. them at one time.
  561. in: body
  562. required: true
  563. type: array
  564. nics:
  565. description: |
  566. The port info in the requested network for the server, with fixed_ip, mac_address, and
  567. network uuid
  568. in: body
  569. required: true
  570. type: object
  571. node:
  572. description: |
  573. The node which our server associated with. Only visible for admin users.
  574. in: body
  575. required: false
  576. type: string
  577. nodes:
  578. description: |
  579. The compute node name list.
  580. in: body
  581. required: true
  582. type: object
  583. partitions:
  584. description: |
  585. The partitions info for root disk, this is only allowed when using partition images
  586. with root_gb(required), ephemeral_gb, and swap_mb.
  587. in: body
  588. required: false
  589. type: object
  590. personality:
  591. description: |
  592. The file path and contents, text only, to inject into the server at launch. The
  593. maximum size of the file path data is 255 bytes. The maximum limit is the number
  594. of allowed bytes in the decoded, rather than encoded, data.
  595. in: body
  596. required: false
  597. type: string
  598. port_uuid:
  599. description: |
  600. To provision the server with a NIC for an already existing port,
  601. specify the port_id in a ``networks`` list.
  602. in: body
  603. required: false
  604. type: string
  605. power_state_target:
  606. description: |
  607. This field represents the requested state either "on", "off", "soft_off",
  608. "reboot", or "soft_reboot".
  609. in: body
  610. required: true
  611. type: string
  612. preserve_ephemeral:
  613. description: |
  614. Indicates whether the server is rebuilt with the preservation of the ephemeral
  615. partition (``true``).
  616. in: body
  617. required: false
  618. type: boolean
  619. project_id_body:
  620. description: |
  621. The UUID of the project in a multi-tenancy cloud.
  622. in: body
  623. required: true
  624. type: string
  625. provision_state:
  626. description: |
  627. One of the provisioning verbs, currently only support rebuild.
  628. in: body
  629. required: true
  630. type: string
  631. remote_console_protocol:
  632. description: |
  633. The protocol of remote console. The valid value is ``serial`` now.
  634. in: body
  635. required: true
  636. type: string
  637. remote_console_type:
  638. description: |
  639. The type of remote console. The valid values are ``socat``, and
  640. ``shellinabox``.
  641. in: body
  642. required: true
  643. type: string
  644. remote_console_url:
  645. description: |
  646. The URL is used to connect the console.
  647. in: body
  648. required: true
  649. type: string
  650. scheduler_hints:
  651. description: |
  652. The dictionary of data send to the scheduler, it represents scheduling
  653. options will be passed to scheduler.
  654. in: body
  655. required: false
  656. type: object
  657. server:
  658. description: |
  659. The dictionary of data represent a server creation request.
  660. in: body
  661. required: true
  662. type: object
  663. server_description:
  664. description: |
  665. A free form description of the server. Limited to 255 characters
  666. in length.
  667. in: body
  668. required: false
  669. type: string
  670. server_fault:
  671. description: |
  672. A fault object. Only displayed in the failed response.
  673. Default keys are ``code``, ``message``, and ``detail``
  674. (response code, message, and detail respectively).
  675. in: body
  676. required: false
  677. type: object
  678. server_group_members:
  679. description: |
  680. A list of uuids of servers which belong to this server group.
  681. in: body
  682. required: false
  683. type: array
  684. server_group_name:
  685. description: |
  686. The server group name.
  687. in: body
  688. required: true
  689. type: string
  690. server_group_policies:
  691. description: |
  692. A list of exactly one policy name to associate with the server group. The
  693. current valid policy names are:
  694. - ``anti-affinity`` - servers in this group must be scheduled to
  695. different affinity-zones.
  696. - ``affinity`` - servers in this group must be scheduled to the same
  697. affinity-zone.
  698. in: body
  699. required: true
  700. type: array
  701. server_group_uuid:
  702. description: |
  703. The UUID of the server group.
  704. in: body
  705. required: true
  706. type: string
  707. server_groups:
  708. description: |
  709. The list of existing server groups.
  710. in: body
  711. required: true
  712. type: array
  713. server_name:
  714. description: |
  715. The server name.
  716. in: body
  717. required: true
  718. type: string
  719. server_power_state:
  720. description: |
  721. The current power state of this server. Usually, "power on" or "power off", but may be "None"
  722. if Mogan is unable to determine the power state (eg, due to hardware failure)
  723. in: body
  724. required: true
  725. type: string
  726. server_status:
  727. description: |
  728. The status of this server. Usually, "building", "active", "error", or "None".
  729. in: body
  730. required: true
  731. type: string
  732. server_uuid:
  733. description: |
  734. The UUID of the server
  735. in: body
  736. required: true
  737. type: string
  738. tenant_id_body:
  739. description: |
  740. The UUID of the tenant in a multi-tenancy cloud.
  741. in: body
  742. required: true
  743. type: string
  744. updated_at:
  745. description: |
  746. The date and time when the resource was updated. The date and time
  747. stamp format is `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`_
  748. ::
  749. CCYY-MM-DDThh:mm:ss±hh:mm
  750. For example, ``2015-08-27T09:49:58-05:00``. The ``±hh:mm``
  751. value, if included, is the time zone as an offset from UTC. In
  752. the previous example, the offset value is ``-05:00``.
  753. in: body
  754. required: true
  755. type: string
  756. user_data:
  757. description: |
  758. Configuration information or scripts to use upon launch. Must be Base64 encoded.
  759. in: body
  760. required: false
  761. type: string
  762. user_id_body:
  763. description: |
  764. The user ID of the user who owns the server.
  765. in: body
  766. required: true
  767. type: string