- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# os_ironic – Create/Delete Bare Metal Resources from OpenStack

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Create or Remove Ironic nodes from OpenStack.

## Requirements

The below requirements are needed on the host that executes this module.

- jsonpatch
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 2.7

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
api_timeout integer |  | 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.
auth dictionary |  | 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, os_user_domain_name or os_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.
auth_type string |  | 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.
availability_zone - |  | Ignored. Present for backwards compatibility
ca_cert string |  | A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert
chassis_uuid - |  | Associate the node with a pre-defined chassis.
client_cert string |  | A path to a client certificate to use as part of the SSL transaction. aliases: cert
client_key string |  | A path to a client key to use as part of the SSL transaction. aliases: key
cloud raw |  | 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.
driver - / required |  | The name of the Ironic Driver to use with this node.
driver_info - |  | Information for this server's driver. Will vary based on which driver is in use. Any sub-field which is populated will be validated during creation.
| console - |  | Information necessary to connect to this server's serial console. Not all drivers support this.
| deploy - |  | Information necessary to deploy this server directly, without using Nova. THIS IS NOT RECOMMENDED.
| management - / required |  | Information necessary to interact with this server's management interface. May be shared by power_info in some cases.
| power - / required |  | Information necessary to turn this server on / off. This often includes such things as IPMI username, password, and IP address.
interface string | Choices: admin internal public ← | Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
ironic_url - |  | If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API. Use with "auth" and "auth_type" settings set to None.
name - |  | unique name identifier to be given to the resource.
nics - / required |  | A list of network interface cards, eg, " - mac: aa:bb:cc:aa:bb:cc"
properties - |  | Definition of the physical characteristics of this server, used for scheduling purposes
| capabilities - added in 2.8 | Default: "" | special capabilities for the node, such as boot_option, node_role etc (see https://docs.openstack.org/ironic/latest/install/advanced.html for more information)
| cpu_arch - | Default: "x86_64" | CPU architecture (x86_64, i686, ...)
| cpus - | Default: 1 | Number of CPU cores this machine has
| disk_size - | Default: 1 | size of first storage device in this machine (typically /dev/sda), in GB
| ram - | Default: 1 | amount of RAM this machine has, in MB
| root_device - added in 2.8 | Default: "" | Root disk device hints for deployment. (see https://docs.openstack.org/ironic/latest/install/include/root-device-hints.html for allowed hints)
region_name string |  | Name of the region.
skip_update_of_driver_password boolean | Choices: no ← yes | Allows the code that would assert changes to nodes to skip the update if the change is a single line consisting of the password field. As of Kilo, by default, passwords are always masked to API requests, which means the logic as a result always attempts to re-assert the password field.
state - | Choices: present ← absent | Indicates desired state of the resource
timeout integer | Default: 180 | How long should ansible wait for the requested resource.
uuid - |  | globally unique identifier (UUID) to be given to the resource. Will be auto-generated if not specified, and name is specified. Definition of a UUID will always take precedence to a name value.
validate_certs boolean | Choices: no ← yes | Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to `yes`. aliases: verify
wait boolean | Choices: no yes ← | Should ansible wait until the requested resource is complete.

## Notes

Note

- The standard OpenStack environment variables, such as `OS_USERNAME` may 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

    # Enroll a node with some basic properties and driver info
    - os_ironic:
        cloud: "devstack"
        driver: "pxe_ipmitool"
        uuid: "00000000-0000-0000-0000-000000000002"
        properties:
          cpus: 2
          cpu_arch: "x86_64"
          ram: 8192
          disk_size: 64
          capabilities: "boot_option:local"
          root_device:
            wwn: "0x4000cca77fc4dba1"
        nics:
          - mac: "aa:bb:cc:aa:bb:cc"
          - mac: "dd:ee:ff:dd:ee:ff"
        driver_info:
          power:
            ipmi_address: "1.2.3.4"
            ipmi_username: "admin"
            ipmi_password: "adminpass"
        chassis_uuid: "00000000-0000-0000-0000-000000000001"

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Monty Taylor (@emonty)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.