Documentation

os_ironic - Create/Delete Bare Metal Resources from OpenStack

New in version 2.0.

Synopsis

  • Create or Remove Ironic nodes from OpenStack.

Requirements

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

  • jsonpatch
  • openstacksdk
  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments
api_timeout
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 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 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
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
cacert
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert
A path to a client certificate to use as part of the SSL transaction.
chassis_uuid
Associate the node with a pre-defined chassis.
cloud
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.
management
required
Information necessary to interact with this server's management interface. May be shared by power_info in some cases.
console
Information necessary to connect to this server's serial console. Not all drivers support this.
power
required
Information necessary to turn this server on / off. This often includes such things as IPMI username, password, and IP address.
deploy
Information necessary to deploy this server directly, without using Nova. THIS IS NOT RECOMMENDED.
interface
(added in 2.3)
    Choices:
  • public ←
  • internal
  • admin
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.
key
A path to a client key to use as part of the SSL transaction.
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
cpu_arch Default:
x86_64
CPU architecture (x86_64, i686, ...)
ram Default:
1
amount of RAM this machine has, in MB
disk_size Default:
1
size of first storage device in this machine (typically /dev/sda), in GB
cpus Default:
1
Number of CPU cores this machine has
region_name
Name of the region.
skip_update_of_driver_password
bool
    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 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.
verify
bool
    Choices:
  • no
  • yes
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: validate_certs
wait
bool
    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 os-client-config, 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 http://docs.openstack.org/developer/os-client-config

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
    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 flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Monty Taylor (@emonty)

Hint

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