diff --git a/api-ref/source/baremetal-api-v1-nodes.inc b/api-ref/source/baremetal-api-v1-nodes.inc index 13b57cad1d..49ac3fe230 100644 --- a/api-ref/source/baremetal-api-v1-nodes.inc +++ b/api-ref/source/baremetal-api-v1-nodes.inc @@ -89,6 +89,9 @@ supplied when the Node is created, or the resource may be updated later. .. versionadded:: 1.44 Introduced the ``deploy_step`` field. +.. versionadded:: 1.46 + Introduced the ``conductor_group`` field. + Normal response codes: 201 Error codes: 400,403,406 @@ -99,6 +102,7 @@ Request .. rest_parameters:: parameters.yaml - boot_interface: req_boot_interface + - conductor_group: req_conductor_group - console_interface: req_console_interface - deploy_interface: req_deploy_interface - driver_info: req_driver_info @@ -135,7 +139,7 @@ and any defaults added for non-specified fields. Most fields default to "null" or "". The list and example below are representative of the response as of API -microversion 1.44. +microversion 1.46. .. rest_parameters:: parameters.yaml @@ -181,6 +185,7 @@ microversion 1.44. - traits: n_traits - vendor_interface: vendor_interface - volume: n_volume + - conductor_group: conductor_group **Example JSON representation of a Node:** @@ -221,7 +226,12 @@ provision state, and maintenance setting for each Node. .. versionadded:: 1.43 Added the ``detail`` boolean request parameter. When specified ``True`` this - causes the response to include complete details about each node. + causes the response to include complete details about each node, as shown + in the "List Nodes Detailed" section below. + +.. versionadded:: 1.46 + Introduced the ``conductor_group`` request parameter, to allow filtering the + list of returned nodes by conductor group. Normal response codes: 200 @@ -238,6 +248,7 @@ Request - provision_state: r_provision_state - driver: r_driver - resource_class: r_resource_class + - conductor_group: r_conductor_group - fault: r_fault - fields: fields - limit: limit @@ -288,6 +299,9 @@ Nova instance, eg. with a request to ``v1/nodes/detail?instance_uuid={NOVA INSTA .. versionadded:: 1.42 Introduced the ``fault`` field. +.. versionadded:: 1.46 + Introduced the ``conductor_group`` field. + Normal response codes: 200 Error codes: 400,403,406 @@ -304,6 +318,7 @@ Request - provision_state: r_provision_state - driver: r_driver - resource_class: r_resource_class + - conductor_group: r_conductor_group - limit: limit - marker: marker - sort_dir: sort_dir @@ -356,6 +371,7 @@ Response - traits: n_traits - vendor_interface: vendor_interface - volume: n_volume + - conductor_group: conductor_group **Example detailed list of Nodes:** @@ -381,6 +397,9 @@ only the specified set. .. versionadded:: 1.42 Introduced the ``fault`` field. +.. versionadded:: 1.46 + Introduced the ``conductor_group`` field. + Normal response codes: 200 Error codes: 400,403,404,406 @@ -440,6 +459,7 @@ Response - traits: n_traits - vendor_interface: vendor_interface - volume: n_volume + - conductor_group: conductor_group **Example JSON representation of a Node:** @@ -525,6 +545,7 @@ Response - traits: n_traits - vendor_interface: vendor_interface - volume: n_volume + - conductor_group: conductor_group **Example JSON representation of a Node:** diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index a25962e8a9..5808cebb6a 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -197,6 +197,14 @@ r_associated: in: query required: false type: boolean +r_conductor_group: + description: | + Filter the list of returned nodes, and only return those with the + specified ``conductor_group``. Case-insensitive string up to 255 + characters, containing ``a-z``, ``0-9``, ``_``, ``-``, and ``.``. + in: query + required: false + type: string r_driver: description: | Filter the list of returned nodes, and only return those with the specified @@ -407,6 +415,13 @@ clean_steps: in: body required: false type: array +conductor_group: + description: | + The conductor group for a node. Case-insensitive string up to 255 + characters, containing ``a-z``, ``0-9``, ``_``, ``-``, and ``.``. + in: body + required: false + type: string configdrive: description: | A gzip'ed and base-64 encoded config drive, to be written to a partition @@ -1029,6 +1044,13 @@ req_chassis: in: body required: true type: array +req_conductor_group: + description: | + The conductor group for a node. Case-insensitive string up to 255 + characters, containing ``a-z``, ``0-9``, ``_``, ``-``, and ``.``. + in: body + required: false + type: string req_console_enabled: description: | Indicates whether console access is enabled or disabled on this node. diff --git a/api-ref/source/samples/node-create-response.json b/api-ref/source/samples/node-create-response.json index d9e66049e0..ca165c2238 100644 --- a/api-ref/source/samples/node-create-response.json +++ b/api-ref/source/samples/node-create-response.json @@ -2,6 +2,7 @@ "boot_interface": null, "chassis_uuid": null, "clean_step": {}, + "conductor_group": "group-1", "console_enabled": false, "console_interface": null, "created_at": "2016-08-18T22:28:48.643434+11:11", diff --git a/api-ref/source/samples/node-show-response.json b/api-ref/source/samples/node-show-response.json index bea794cd10..2ecf7b4c61 100644 --- a/api-ref/source/samples/node-show-response.json +++ b/api-ref/source/samples/node-show-response.json @@ -2,6 +2,7 @@ "boot_interface": null, "chassis_uuid": null, "clean_step": {}, + "conductor_group": "group-1", "console_enabled": false, "console_interface": null, "created_at": "2016-08-18T22:28:48.643434+11:11", diff --git a/api-ref/source/samples/node-update-driver-info-response.json b/api-ref/source/samples/node-update-driver-info-response.json index 6723b2878b..53ec73fd23 100644 --- a/api-ref/source/samples/node-update-driver-info-response.json +++ b/api-ref/source/samples/node-update-driver-info-response.json @@ -2,6 +2,7 @@ "boot_interface": null, "chassis_uuid": null, "clean_step": {}, + "conductor_group": "group-1", "console_enabled": false, "console_interface": null, "created_at": "2016-08-18T22:28:48.643434+11:11", diff --git a/api-ref/source/samples/nodes-list-details-response.json b/api-ref/source/samples/nodes-list-details-response.json index 96e181b02b..f0fc4d8e81 100644 --- a/api-ref/source/samples/nodes-list-details-response.json +++ b/api-ref/source/samples/nodes-list-details-response.json @@ -4,6 +4,7 @@ "boot_interface": null, "chassis_uuid": null, "clean_step": {}, + "conductor_group": "group-1", "console_enabled": false, "console_interface": null, "created_at": "2016-08-18T22:28:48.643434+11:11", @@ -102,6 +103,7 @@ "boot_interface": "pxe", "chassis_uuid": null, "clean_step": {}, + "conductor_group": "", "console_enabled": false, "console_interface": "no-console", "created_at": "2016-08-18T22:28:48.643434+11:11",