None
Bases: pecan.rest.RestController
BootDeviceController.
get
(node_ident)¶Get the current boot device for a node.
Parameters: | node_ident – the UUID or logical name of a node. | ||||
---|---|---|---|---|---|
Returns: | a json object containing:
|
BootDeviceController.
put
(node_ident, boot_device, persistent=False)¶Set the boot device for a node.
Set the boot device to use on next reboot of the node.
Parameters: |
|
---|
BootDeviceController.
supported
(node_ident)¶Get a list of the supported boot devices.
Parameters: | node_ident – the UUID or logical name of a node. |
---|---|
Returns: | A json object with the list of supported boot devices. |
None
Bases: ironic.api.controllers.base.APIBase
API representation of the console information for a node.
ConsoleInfo.
sample
()¶None
Bases: pecan.rest.RestController
InjectNmiController.
put
(node_ident)¶Inject NMI for a node.
Inject NMI (Non Maskable Interrupt) for a node immediately.
Parameters: | node_ident – the UUID or logical name of a node. |
---|---|
Raises: | NotFound if requested version of the API doesn’t support inject nmi. |
Raises: | HTTPForbidden if the policy is not authorized. |
Raises: | NodeNotFound if the node is not found. |
Raises: | NodeLocked if the node is locked by another conductor. |
Raises: | UnsupportedDriverExtension if the node’s driver doesn’t support management or management.inject_nmi. |
Raises: | InvalidParameterValue when the wrong driver info is specified or an invalid boot device is specified. |
Raises: | MissingParameterValue if missing supplied info. |
None
Bases: ironic.api.controllers.base.APIBase
API representation of a bare metal node.
This class enforces type checking and value constraints, and converts between the internal object model and the API representation of a node.
Node.
convert_with_links
(rpc_node, fields=None)¶Node.
sample
(expand=True)¶None
Bases: ironic.api.controllers.v1.collection.Collection
API representation of a collection of nodes.
NodeCollection.
convert_with_links
(nodes, limit, url=None, fields=None, **kwargs)¶NodeCollection.
sample
()¶None
Bases: pecan.rest.RestController
NodeConsoleController.
get
(node_ident)¶Get connection information about the console.
Parameters: | node_ident – UUID or logical name of a node. |
---|
NodeConsoleController.
put
(node_ident, enabled)¶Start and stop the node console.
Parameters: |
|
---|
None
Bases: pecan.rest.RestController
NodeMaintenanceController.
delete
(node_ident)¶Remove the node from maintenance mode.
Parameters: | node_ident – the UUID or logical name of a node. |
---|
NodeMaintenanceController.
put
(node_ident, reason=None)¶Put the node in maintenance mode.
Parameters: |
|
---|
None
Bases: pecan.rest.RestController
None
Bases: ironic.api.controllers.v1.types.JsonPatchType
NodePatchType.
internal_attrs
()¶Returns a list of internal attributes.
Internal attributes can’t be added, replaced or removed. This method may be overwritten by derived class.
None
Bases: ironic.api.controllers.base.APIBase
API representation of the states of a node.
NodeStates.
convert
(rpc_node)¶NodeStates.
sample
()¶None
Bases: pecan.rest.RestController
NodeStatesController.
get
(node_ident)¶List the states of the node.
Parameters: | node_ident – the UUID or logical_name of a node. |
---|
NodeStatesController.
power
(node_ident, target, timeout=None)¶Set the power state of the node.
Parameters: |
|
---|---|
Raises: | ClientSideError (HTTP 409) if a power operation is already in progress. |
Raises: | InvalidStateRequested (HTTP 400) if the requested target state is not valid or if the node is in CLEANING state. |
Raises: | NotAcceptable (HTTP 406) for soft reboot, soft power off or timeout parameter, if requested version of the API is less than 1.27. |
Raises: | Invalid (HTTP 400) if timeout value is less than 1. |
NodeStatesController.
provision
(node_ident, target, configdrive=None, clean_steps=None, rescue_password=None)¶Asynchronous trigger the provisioning of the node.
This will set the target provision state of the node, and a background task will begin which actually applies the state change. This call will return a 202 (Accepted) indicating the request was accepted and is in progress; the client should continue to GET the status of this node to observe the status of the requested action.
Parameters: |
|
---|---|
Raises: | NodeLocked (HTTP 409) if the node is currently locked. |
Raises: | ClientSideError (HTTP 409) if the node is already being provisioned. |
Raises: | InvalidParameterValue (HTTP 400), if validation of clean_steps or power driver interface fails. |
Raises: | InvalidStateRequested (HTTP 400) if the requested transition is not possible from the current state. |
Raises: | NodeInMaintenance (HTTP 400), if operation cannot be performed because the node is in maintenance mode. |
Raises: | NoFreeConductorWorker (HTTP 503) if no workers are available. |
Raises: | NotAcceptable (HTTP 406) if the API version specified does not allow the requested state transition. |
NodeStatesController.
raid
(node_ident, target_raid_config)¶Set the target raid config of the node.
Parameters: |
|
---|---|
Raises: | UnsupportedDriverExtension, if the node’s driver doesn’t support RAID configuration. |
Raises: | InvalidParameterValue, if validation of target raid config fails. |
Raises: | NotAcceptable, if requested version of the API is less than 1.12. |
None
Bases: pecan.rest.RestController
NodeTraitsController.
delete
(trait=None)¶Remove one or all traits from a node.
Parameters: | trait – String value; trait to remove from a node, or None. If None, all traits are removed. |
---|
NodeTraitsController.
get_all
()¶List node traits.
NodeTraitsController.
put
(trait=None, traits=None)¶Add a trait to a node.
Parameters: |
|
---|
None
Bases: pecan.rest.RestController
NodeVIFController.
delete
(vif_id)¶Detach a VIF from this node
Parameters: | vif_id – The ID of a VIF to detach |
---|
NodeVIFController.
get_all
()¶Get a list of attached VIFs
NodeVIFController.
post
(vif)¶Attach a VIF to this node
Parameters: | vif – a dictionary of information about a VIF. It must have an ‘id’ key, whose value is a unique identifier for that VIF. |
---|
None
Bases: pecan.rest.RestController
REST controller for VendorPassthru.
This controller allow vendors to expose a custom functionality in the Ironic API. Ironic will merely relay the message from here to the appropriate driver, no introspection will be made in the message body.
NodeVendorPassthruController.
methods
(node_ident)¶Retrieve information about vendor methods of the given node.
Parameters: | node_ident – UUID or logical name of a node. |
---|---|
Returns: | dictionary with <vendor method name>:<method metadata> entries. |
Raises: | NodeNotFound if the node is not found. |
None
Bases: pecan.rest.RestController
REST controller for Nodes.
NodesController.
delete
(node_ident)¶Delete a node.
Parameters: | node_ident – UUID or logical name of a node. |
---|
NodesController.
detail
(chassis_uuid=None, instance_uuid=None, associated=None, maintenance=None, provision_state=None, marker=None, limit=None, sort_key='id', sort_dir='asc', driver=None, resource_class=None, fault=None, conductor_group=None)¶Retrieve a list of nodes with detail.
Parameters: |
|
---|
NodesController.
get_all
(chassis_uuid=None, instance_uuid=None, associated=None, maintenance=None, provision_state=None, marker=None, limit=None, sort_key='id', sort_dir='asc', driver=None, fields=None, resource_class=None, fault=None, conductor_group=None, detail=None)¶Retrieve a list of nodes.
Parameters: |
|
---|
NodesController.
get_one
(node_ident, fields=None)¶Retrieve information about the given node.
Parameters: |
|
---|
NodesController.
patch
(node_ident, reset_interfaces=None, patch=None)¶Update an existing node.
Parameters: |
|
---|
NodesController.
post
(node)¶Create a new node.
Parameters: | node – a node within the request body. |
---|
NodesController.
validate
(node=None, node_uuid=None)¶Validate the driver interfaces, using the node’s UUID or name.
Note that the ‘node_uuid’ interface is deprecated in favour of the ‘node’ interface
Parameters: |
|
---|
None
Bases: ironic.api.controllers.base.APIBase
API representation of the traits for a node.
Traits.
sample
()¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.