Documentation

os_ironic_node - Activate/Deactivate Bare Metal Resources from OpenStack

New in version 2.0.

Synopsis

  • Deploy to nodes controlled by Ironic.

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.
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.
config_drive
no None
A configdrive file or HTTP(S) URL that will be passed along to the node.
deploy
no True
  • true
  • false
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.
endpoint_type
no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
instance_info
no
Definition of the instance information which is used to deploy the node. This information is only required when an instance is set to present.
Dictionary object instance_info
parameter required default choices comments
image_disk_format
no
The type of image that has been requested to be deployed.
image_source
no
An HTTP(S) URL where the image can be retrieved from.
image_checksum
no
The checksum of image_source.
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.
maintenance
no
A setting to allow the direct control if a node is in maintenance mode.
maintenance_reason
no None
A string expression regarding the reason a node is in a maintenance mode.
power
no present
  • 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
no
Name of the region.
state
no present
  • present
  • absent
Indicates desired state of the resource
timeout
(added in 2.1)
no
An integer value representing the number of seconds to wait for the node activation or deactivation to complete.
uuid
no None
globally unique identifier (UUID) to be given to the resource.
validate_certs
no
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.

aliases: verify
wait
(added in 2.1)
no
A boolean value instructing the module to wait for node activation or deactivation to complete before returning.

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

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, Helping Testing PRs and Developing Modules.