Documentation

os_ironic - Create/Delete Bare Metal Resources from OpenStack

New in version 2.0.

Synopsis

  • Create or Remove Ironic nodes from OpenStack.

Requirements (on host that executes module)

  • jsonpatch
  • python >= 2.7
  • shade

Options

parameter required default choices comments
api_timeout
no None
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
no
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
no password
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
no
Ignored. Present for backwards compatability
cacert
no None
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert
no None
A path to a client certificate to use as part of the SSL transaction.
chassis_uuid
no None
Associate the node with a pre-defined chassis.
cloud
no
Named cloud to operate against. 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.
driver
yes None
The name of the Ironic Driver to use with this node.
driver_info
no
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.
Dictionary object driver_info
parameter required default choices comments
management
yes
Information necessary to interact with this server's management interface. May be shared by power_info in some cases.
console
no
Information necessary to connect to this server's serial console. Not all drivers support this.
power
yes
Information necessary to turn this server on / off. This often includes such things as IPMI username, password, and IP address.
deploy
no
Information necessary to deploy this server directly, without using Nova. THIS IS NOT RECOMMENDED.
endpoint_type
no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
ironic_url
no None
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
no None
A path to a client key to use as part of the SSL transaction.
name
no None
unique name identifier to be given to the resource.
nics
yes
A list of network interface cards, eg, " - mac: aa:bb:cc:aa:bb:cc"
properties
no
Definition of the physical characteristics of this server, used for scheduling purposes
Dictionary object properties
parameter required default choices comments
cpu_arch
no x86_64
CPU architecture (x86_64, i686, ...)
ram
no 1
amount of RAM this machine has, in MB
disk_size
no 1
size of first storage device in this machine (typically /dev/sda), in GB
cpus
no 1
Number of CPU cores this machine has
region_name
no
Name of the region.
skip_update_of_driver_password
no
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
no present
  • present
  • absent
Indicates desired state of the resource
timeout
no 180
How long should ansible wait for the requested resource.
uuid
no None
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
no
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: verify
wait
no yes
  • yes
  • no
Should ansible wait until the requested resource is complete.

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"

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.