Note
This plugin is part of the openstack.cloud collection.
To install it use: ansible-galaxy collection install openstack.cloud.
To use it in a playbook, specify: openstack.cloud.baremetal_node.
The below requirements are needed on the host that executes this module.
| 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, user_domain_name or 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 string | 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 string | 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 string | The name of the Ironic Driver to use with this node. Required when state=present
| ||
| driver_info dictionary / required | 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 string | Information necessary to connect to this server's serial console. Not all drivers support this. | ||
| deploy string | Information necessary to deploy this server directly, without using Nova. THIS IS NOT RECOMMENDED. | ||
| management string / required | Information necessary to interact with this server's management interface. May be shared by power_info in some cases. | ||
| power string / required | Information necessary to turn this server on / off. This often includes such things as IPMI username, password, and IP address. | ||
| interface string |
| Endpoint URL type to fetch from the service catalog. aliases: endpoint_type | |
| ironic_url string | 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 string | unique name identifier to be given to the resource. | ||
| nics list / elements=dictionary / required | A list of network interface cards, eg, " - mac: aa:bb:cc:aa:bb:cc" | ||
| mac string / required | The MAC address of the network interface card. | ||
| properties dictionary | Definition of the physical characteristics of this server, used for scheduling purposes | ||
| capabilities string | 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 string | Default: "x86_64" | CPU architecture (x86_64, i686, ...) | |
| cpus string | Default: 1 | Number of CPU cores this machine has | |
| disk_size string | Default: 1 | size of first storage device in this machine (typically /dev/sda), in GB | |
| ram string | Default: 1 | amount of RAM this machine has, in MB | |
| root_device string | Default: "" | Root disk device hints for deployment. | |
| region_name string | Name of the region. | ||
| skip_update_of_masked_password boolean |
| 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. skip_update_of_driver_password is deprecated alias and will be removed in openstack.cloud 2.0.0.aliases: skip_update_of_driver_password | |
| state string |
| Indicates desired state of the resource | |
| timeout integer | Default: 180 | How long should ansible wait for the requested resource. | |
| uuid string | 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 |
| Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes.aliases: verify | |
| wait boolean |
| Should ansible wait until the requested resource is complete. | |
Note
OS_USERNAME may be used instead of providing explicit values.# Enroll a node with some basic properties and driver info
- openstack.cloud.baremetal_node:
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"
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/baremetal_node_module.html