ironic_ui.api.ironic
Moduleironic_ui.api.ironic
Module¶ironic_ui.api.ironic.
driver_list
(request)Retrieve a list of drivers.
Parameters: | request – HTTP request. |
---|---|
Returns: | A list of drivers. |
ironic_ui.api.ironic.
driver_properties
(request, driver_name)Retrieve the properties of a specified driver
Parameters: |
|
---|---|
Returns: | Property list |
ironic_ui.api.ironic.
ironicclient
(*args, **kwargs)Returns a client connected to the Ironic backend.
Parameters: | request – HTTP request. |
---|---|
Returns: | Ironic client. |
ironic_ui.api.ironic.
node_create
(request, params)Create a node
Parameters: |
|
---|
ironic_ui.api.ironic.
node_delete
(request, node_id)Delete a node from inventory.
Parameters: |
|
---|---|
Returns: | node. |
ironic_ui.api.ironic.
node_get
(request, node_id)Retrieve a node.
Parameters: |
|
---|---|
Returns: | node. |
ironic_ui.api.ironic.
node_get_boot_device
(request, node_id)Get the boot device for a specified node.
Parameters: |
|
---|---|
Returns: | Dictionary with keys “boot_device” and “persistent” |
ironic_ui.api.ironic.
node_get_console
(request, node_id)Get connection information for a node’s console.
Parameters: |
|
---|---|
Returns: | Console connection information |
ironic_ui.api.ironic.
node_get_supported_boot_devices
(request, node_id)Get the list of supported boot devices for a specified node.
Parameters: |
|
---|---|
Returns: | List of supported boot devices (strings) |
ironic_ui.api.ironic.
node_list
(request)Retrieve a list of nodes.
Parameters: | request – HTTP request. |
---|---|
Returns: | A list of nodes. |
ironic_ui.api.ironic.
node_list_ports
(request, node_id)List all the ports on a given node.
Parameters: |
|
---|---|
Returns: | A full list of ports. (limit=0) |
ironic_ui.api.ironic.
node_set_boot_device
(request, node_id, device, persistent)Set the boot device for a specified node.
Parameters: |
|
---|---|
Returns: | null. |
ironic_ui.api.ironic.
node_set_console_mode
(request, node_id, enabled)Start or stop the serial console for a given node.
Parameters: |
|
---|---|
Returns: | node. |
ironic_ui.api.ironic.
node_set_maintenance
(request, node_id, state, maint_reason=None)Set the maintenance mode on a given node.
Parameters: |
|
---|---|
Returns: | node. |
ironic_ui.api.ironic.
node_set_power_state
(request, node_id, state, soft=False)Set power state for a given node.
Parameters: |
|
---|---|
Returns: | node. |
ironic_ui.api.ironic.
node_set_provision_state
(request, node_id, state, cleansteps=None)Set the target provision state for a given node.
Parameters: |
|
---|---|
Returns: | node. |
ironic_ui.api.ironic.
node_update
(request, node_id, patch)Update a specified node.
Parameters: |
|
---|---|
Returns: | node. |
ironic_ui.api.ironic.
node_validate
(request, node_id)Validate a specified node.
Parameters: |
|
---|---|
Returns: | List of dictionaries, each containing an interface status |
ironic_ui.api.ironic.
port_create
(request, params)Create network port
Parameters: |
|
---|---|
Returns: | Port |
ironic_ui.api.ironic.
port_delete
(request, port_uuid)Delete a network port
Parameters: |
|
---|---|
Returns: | Port |
ironic_ui.api.ironic.
port_update
(request, port_uuid, patch)Update a specified port.
Parameters: |
|
---|---|
Returns: | Port. |
ironic_ui.api.ironic.
portgroup_create
(request, params)Create a portgroup.
Parameters: |
|
---|---|
Returns: | Portgroup. |
ironic_ui.api.ironic.
portgroup_delete
(request, portgroup_id)Delete a portgroup from the DB.
Parameters: |
|
---|---|
Returns: | Portgroup. |
ironic_ui.api.ironic.
portgroup_get_ports
(request, portgroup_id)Get the ports associated with a specified portgroup.
Parameters: |
|
---|---|
Returns: | List of ports. |
ironic_ui.api.ironic.
portgroup_list
(request, node_id)List the portgroups associated with a given node.
Parameters: |
|
---|---|
Returns: | A full list of portgroups. (limit=0) |
ironic_ui.api.ironic.
portgroup_update
(request, portgroup_id, patch)Update a specified portgroup.
Parameters: |
|
---|---|
Returns: | Portgroup. |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.