Adding bios_interface reference to api docs
As per title, this patch adds default_boot_interface and enabled_boot_interfaces references, definitions and examples to the api-ref documentation. Change-Id: I35d4829c32cc48d5734c269c0a83ad9b4fbdd660
This commit is contained in:
parent
6a96bfa57e
commit
e0639875f4
@ -80,6 +80,7 @@ drivers supported by this Ironic service.
|
||||
|
||||
.. rest_parameters:: parameters.yaml
|
||||
|
||||
- default_bios_interface: default_bios_interface
|
||||
- default_boot_interface: default_boot_interface
|
||||
- default_console_interface: default_console_interface
|
||||
- default_deploy_interface: default_deploy_interface
|
||||
@ -91,6 +92,7 @@ drivers supported by this Ironic service.
|
||||
- default_rescue_interface: default_rescue_interface
|
||||
- default_storage_interface: default_storage_interface
|
||||
- default_vendor_interface: default_vendor_interface
|
||||
- enabled_bios_interfaces: enabled_bios_interfaces
|
||||
- enabled_boot_interfaces: enabled_boot_interfaces
|
||||
- enabled_console_interfaces: enabled_console_interfaces
|
||||
- enabled_deploy_interfaces: enabled_deploy_interfaces
|
||||
@ -140,6 +142,7 @@ Response Parameters
|
||||
- name: driver_name
|
||||
- hosts: hosts
|
||||
- type: response_driver_type
|
||||
- default_bios_interface: default_bios_interface
|
||||
- default_boot_interface: default_boot_interface
|
||||
- default_console_interface: default_console_interface
|
||||
- default_deploy_interface: default_deploy_interface
|
||||
@ -151,6 +154,7 @@ Response Parameters
|
||||
- default_rescue_interface: default_rescue_interface
|
||||
- default_storage_interface: default_storage_interface
|
||||
- default_vendor_interface: default_vendor_interface
|
||||
- enabled_bios_interfaces: enabled_bios_interfaces
|
||||
- enabled_boot_interfaces: enabled_boot_interfaces
|
||||
- enabled_console_interfaces: enabled_console_interfaces
|
||||
- enabled_deploy_interfaces: enabled_deploy_interfaces
|
||||
|
@ -502,6 +502,13 @@ d_bios_setting:
|
||||
in: body
|
||||
required: true
|
||||
type: dictionary
|
||||
default_bios_interface:
|
||||
description: |
|
||||
The default bios interface used for a node with a dynamic driver, if no
|
||||
bios interface is specified for the node.
|
||||
in: body
|
||||
required: true
|
||||
type: string
|
||||
default_boot_interface:
|
||||
description: |
|
||||
The default boot interface used for a node with a dynamic driver, if no
|
||||
@ -628,6 +635,12 @@ drivers:
|
||||
in: body
|
||||
required: true
|
||||
type: array
|
||||
enabled_bios_interfaces:
|
||||
description: |
|
||||
The enabled bios interfaces for this driver.
|
||||
in: body
|
||||
required: true
|
||||
type: list
|
||||
enabled_boot_interfaces:
|
||||
description: |
|
||||
The enabled boot interfaces for this driver.
|
||||
|
@ -1,4 +1,5 @@
|
||||
{
|
||||
"default_bios_interface": "no-bios",
|
||||
"default_boot_interface": "pxe",
|
||||
"default_console_interface": "no-console",
|
||||
"default_deploy_interface": "iscsi",
|
||||
@ -10,6 +11,9 @@
|
||||
"default_rescue_interface": "no-rescue",
|
||||
"default_storage_interface": "noop",
|
||||
"default_vendor_interface": "no-vendor",
|
||||
"enabled_bios_interfaces": [
|
||||
"no-bios"
|
||||
],
|
||||
"enabled_boot_interfaces": [
|
||||
"pxe"
|
||||
],
|
||||
|
@ -1,6 +1,7 @@
|
||||
{
|
||||
"drivers": [
|
||||
{
|
||||
"default_bios_interface": null,
|
||||
"default_boot_interface": null,
|
||||
"default_console_interface": null,
|
||||
"default_deploy_interface": null,
|
||||
@ -12,6 +13,7 @@
|
||||
"default_rescue_interface": null,
|
||||
"default_storage_interface": null,
|
||||
"default_vendor_interface": null,
|
||||
"enabled_bios_interfaces": null,
|
||||
"enabled_boot_interfaces": null,
|
||||
"enabled_console_interfaces": null,
|
||||
"enabled_deploy_interfaces": null,
|
||||
@ -50,6 +52,7 @@
|
||||
"type": "classic"
|
||||
},
|
||||
{
|
||||
"default_bios_interface": null,
|
||||
"default_boot_interface": null,
|
||||
"default_console_interface": null,
|
||||
"default_deploy_interface": null,
|
||||
@ -61,6 +64,7 @@
|
||||
"default_rescue_interface": null,
|
||||
"default_storage_interface": null,
|
||||
"default_vendor_interface": null,
|
||||
"enabled_bios_interfaces": null,
|
||||
"enabled_boot_interfaces": null,
|
||||
"enabled_console_interfaces": null,
|
||||
"enabled_deploy_interfaces": null,
|
||||
@ -99,6 +103,7 @@
|
||||
"type": "classic"
|
||||
},
|
||||
{
|
||||
"default_bios_interface": "no-bios",
|
||||
"default_boot_interface": "pxe",
|
||||
"default_console_interface": "no-console",
|
||||
"default_deploy_interface": "iscsi",
|
||||
@ -110,6 +115,9 @@
|
||||
"default_rescue_interface": "no-rescue",
|
||||
"default_storage_interface": "noop",
|
||||
"default_vendor_interface": "no-vendor",
|
||||
"enabled_bios_interfaces": [
|
||||
"no-bios"
|
||||
],
|
||||
"enabled_boot_interfaces": [
|
||||
"pxe"
|
||||
],
|
||||
|
Loading…
Reference in New Issue
Block a user