openstack.cloud.baremetal_node module – Create/Delete Bare Metal Resources from OpenStack
Note
This module is part of the openstack.cloud collection (version 2.2.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install openstack.cloud.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: openstack.cloud.baremetal_node.
Synopsis
Create or Remove Ironic nodes from OpenStack.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
openstacksdk >= 1.0.0
Parameters
Parameter |
Comments |
|---|---|
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library. |
|
Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present. |
|
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly. |
|
The bios interface for this node, e.g. |
|
The boot interface for this node, e.g. |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
Associate the node with a pre-defined chassis. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml. |
|
The console interface for this node, e.g. |
|
The deploy interface for this node, e.g. |
|
The name of the Ironic Driver to use with this node. Required when state is |
|
Information for this node’s driver. Will vary based on which driver is in use. Any sub-field which is populated will be validated during creation. For compatibility reasons sub-fields `power`, `deploy`, `management` and `console` are flattened. |
|
ID to be given to the baremetal node. Will be auto-generated on creation if not specified, and name is specified. Definition of id will always take precedence over name. |
|
The interface used for node inspection, e.g. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
The interface for out-of-band management of this node, e.g. “ipmitool”. |
|
unique name identifier to be given to the resource. |
|
The network interface provider to use when describing connections for this node. |
|
A list of network interface cards, eg, This node attribute cannot be updated. |
|
The MAC address of the network interface card. |
|
The interface used to manage power actions on this node, e.g. |
|
Definition of the physical characteristics of this node Used for scheduling purposes |
|
Special capabilities for this node such as boot_option etc. For more information refer to https://docs.openstack.org/ironic/latest/install/advanced.html. |
|
CPU architecture (x86_64, i686, …) |
|
Number of CPU cores this machine has |
|
Size in GB of first storage device in this machine (typically /dev/sda) |
|
Amount of RAM in MB this machine has |
|
Root disk device hints for deployment. For allowed hints refer to https://docs.openstack.org/ironic/latest/install/advanced.html. |
|
Interface used for configuring raid on this node. |
|
Name of the region. |
|
Interface used for node rescue, e.g. |
|
The specific resource type to which this node belongs. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
Deprecated, no longer used. Updating or specifing a password has not been supported for a while. Choices:
|
|
Indicates desired state of the resource Choices:
|
|
Interface used for attaching and detaching volumes on this node, e.g. |
|
Number of seconds to wait for the newly created node to reach the available state. Default: |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Interface for all vendor-specific actions on this node, e.g. |
|
Should ansible wait until the requested resource is complete. Choices:
|
Notes
Note
The standard OpenStack environment variables, such as
OS_USERNAMEmay be used instead of providing explicit values.Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/
Examples
- name: Enroll a node with some basic properties and driver info
openstack.cloud.baremetal_node:
chassis_id: "00000000-0000-0000-0000-000000000001"
cloud: "devstack"
driver: "pxe_ipmitool"
driver_info:
ipmi_address: "1.2.3.4"
ipmi_username: "admin"
ipmi_password: "adminpass"
id: "00000000-0000-0000-0000-000000000002"
nics:
- mac: "aa:bb:cc:aa:bb:cc"
- mac: "dd:ee:ff:dd:ee:ff"
properties:
capabilities: "boot_option:local"
cpu_arch: "x86_64"
cpus: 2
local_gb: 64
memory_mb: 8192
root_device:
wwn: "0x4000cca77fc4dba1"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Dictionary describing the Bare Metal node. Returned: On success when state is ‘present’. |
|
The UUID of the allocation associated with the node. If not null, will be the same as instance_id (the opposite is not always true). Unlike instance_id, this field is read-only. Please use the Allocation API to remove allocations. Returned: success |
|
The bios interface to be used for this node. Returned: success |
|
The boot interface for a node, e.g. “pxe”. Returned: success |
|
The boot mode for a node, either “uefi” or “bios” Returned: success |
|
UUID of the chassis associated with this node. May be empty or None. Returned: success |
|
The current clean step. Returned: success |
|
The conductor currently servicing a node. Returned: success |
|
The conductor group for a node. Returned: success |
|
The console interface for a node, e.g. “no-console”. Returned: success |
|
Bare Metal node created at timestamp. Returned: success |
|
The deploy interface for a node, e.g. “direct”. Returned: success |
|
The current deploy step. Returned: success |
|
The name of the driver. Returned: success |
|
All the metadata required by the driver to manage this node. List of fields varies between drivers, and can be retrieved from the /v1/drivers/<DRIVER_NAME>/properties resource. Returned: success |
|
Internal metadata set and stored by the node’s driver. Returned: success |
|
A set of one or more arbitrary metadata key and value pairs. Returned: success |
|
The fault indicates the active fault detected by ironic, typically the node is in “maintenance mode”. None means no fault has been detected by ironic. “power failure” indicates ironic failed to retrieve power state from this node. There are other possible types, e.g., “clean failure” and “rescue abort failure”. Returned: success |
|
The UUID for the resource. Returned: success |
|
The interface used for node inspection. Returned: success |
|
UUID of the Nova instance associated with this node. Returned: success |
|
Information used to customize the deployed image. May include root partition size, a base 64 encoded config drive, and other metadata. Note that this field is erased automatically when the instance is deleted (this is done by requesting the node provision state be changed to DELETED). Returned: success |
|
Indicates whether the node will perform automated clean or not. Returned: success |
|
Indicates whether console access is enabled or disabled on this node. Returned: success |
|
Whether or not this node is currently in “maintenance mode”. Setting a node into maintenance mode removes it from the available resource pool and halts some internal automation. This can happen manually (eg, via an API request) or automatically when Ironic detects a hardware fault that prevents communication with the machine. Returned: success |
|
Whether the node is protected from undeploying, rebuilding and deletion. Returned: success |
|
Whether the node is retired and can hence no longer be provided, i.e. move from manageable to available, and will end up in manageable after cleaning (rather than available). Returned: success |
|
Indicates whether node is currently booted with secure_boot turned on. Returned: success |
|
Any error from the most recent (last) transaction that started but failed to finish. Returned: success |
|
A list of relative links, including self and bookmark links. Returned: success |
|
User-settable description of the reason why this node was placed into maintenance mode Returned: success |
|
Interface for out-of-band node management. Returned: success |
|
Human-readable identifier for the node resource. May be undefined. Certain words are reserved. Returned: success |
|
Which Network Interface provider to use when plumbing the network connections for this node. Returned: success |
|
A string or UUID of the tenant who owns the object. Returned: success |
|
List of ironic port groups on this node. Returned: success |
|
List of ironic ports on this node. Returned: success |
|
Interface used for performing power actions on the node, e.g. “ipmitool”. Returned: success |
|
The current power state of this node. Usually, “power on” or “power off”, but may be “None” if Ironic is unable to determine the power state (eg, due to hardware failure). Returned: success |
|
Physical characteristics of this node. Populated by ironic-inspector during inspection. May be edited via the REST API at any time. Returned: success |
|
The reason the node is marked as protected. Returned: success |
|
The current provisioning state of this node. Returned: success |
|
Represents the current RAID configuration of the node. Introduced with the cleaning feature. Returned: success |
|
Interface used for configuring RAID on this node. Returned: success |
|
The interface used for node rescue, e.g. “no-rescue”. Returned: success |
|
The name of an Ironic Conductor host which is holding a lock on this node, if a lock is held. Usually “null”, but this field can be useful for debugging. Returned: success |
|
A string which can be used by external schedulers to identify this node as a unit of a specific type of resource. For more details, see https://docs.openstack.org/ironic/latest/install/configure-nova-flavors.html Returned: success |
|
The reason the node is marked as retired. Returned: success |
|
Links to the collection of states. Returned: success |
|
Interface used for attaching and detaching volumes on this node, e.g. “cinder”. Returned: success |
|
If a power state transition has been requested, this field represents the requested (ie, “target”) state, either “power on” or “power off”. Returned: success |
|
If a provisioning action has been requested, this field represents the requested (ie, “target”) state. Note that a node may go through several states during its transition to this target state. For instance, when requesting an instance be deployed to an AVAILABLE node, the node may go through the following state change progression, AVAILABLE -> DEPLOYING -> DEPLOYWAIT -> DEPLOYING -> ACTIVE Returned: success |
|
Represents the requested RAID configuration of the node, which will be applied when the node next transitions through the CLEANING state. Introduced with the cleaning feature. Returned: success |
|
List of traits for this node. Returned: success |
|
Bare Metal node updated at timestamp. Returned: success |
|
Interface for vendor-specific functionality on this node, e.g. “no-vendor”. Returned: success |