# os_ironic_node – Activate/Deactivate Bare Metal Resources from OpenStack

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

## Synopsis

- Deploy to nodes controlled by Ironic.

## Requirements

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

- python >= 2.7
- openstacksdk >= 0.12.0

## 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
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.

config_drive - |  | A configdrive file or HTTP(S) URL that will be passed along to the node.

deploy
boolean

Choices:
- no
- yes ←

Indicates if the resource should be deployed. Allows for deployment logic to be disengaged and control of the node power or maintenance state to be changed.

instance_info - |  | Definition of the instance information which is used to deploy the node. This information is only required when an instance is set to present.
| image_checksum - |  | The checksum of image_source.
| image_disk_format - |  | The type of image that has been requested to be deployed.
| image_source - |  | An HTTP(S) URL where the image can be retrieved from.

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.

maintenance
boolean

Choices:
- no ←
- yes

A setting to allow the direct control if a node is in maintenance mode.

maintenance_reason - |  | A string expression regarding the reason a node is in a maintenance mode.

power
-

Choices:
- present ←
- absent

A setting to allow power state to be asserted allowing nodes that are not yet deployed to be powered on, and nodes that are deployed to be powered off.

region_name string |  | Name of the region.

state
-

Choices:
- present ←
- absent

Indicates desired state of the resource

timeout integer | Default: 180 | An integer value representing the number of seconds to wait for the node activation or deactivation to complete.
uuid - |  | globally unique identifier (UUID) to be given to the resource.

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

A boolean value instructing the module to wait for node activation or deactivation to complete before returning.

## 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

    # Activate a node by booting an image with a configdrive attached
    os_ironic_node:
      cloud: "openstack"
      uuid: "d44666e1-35b3-4f6b-acb0-88ab7052da69"
      state: present
      power: present
      deploy: True
      maintenance: False
      config_drive: "http://192.168.1.1/host-configdrive.iso"
      instance_info:
        image_source: "http://192.168.1.1/deploy_image.img"
        image_checksum: "356a6b55ecc511a20c33c946c4e678af"
        image_disk_format: "qcow"
      delegate_to: localhost

## 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.