Note
This plugin is part of the openstack.cloud collection (version 1.5.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install openstack.cloud.
To use it in a playbook, specify: openstack.cloud.baremetal_inspect.
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 | |
| 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. | |
| 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. | |
| mac string | unique mac address that is used to attempt to identify the host. | |
| name string | unique name identifier to identify the host in Ironic. | |
| region_name string | Name of the region. | |
| timeout integer | Default: 1200 | A timeout in seconds to tell the role to wait for the node to complete introspection if wait is set to True. |
| uuid string | globally unique identifier (UUID) to identify the host. | |
| 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.# Invoke node inspection
- openstack.cloud.baremetal_inspect:
name: "testnode1"
Facts returned by this module are added/updated in the hostvars host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.
| Fact | Returned | Description |
|---|---|---|
| cpu_arch string / elements=string | success | Detected CPU architecture type Sample: x86_64 |
| cpus string / elements=string | success | Count of cpu cores defined in the updated node properties. Sample: 1 |
| local_gb string / elements=string | success | Total size of local disk storage as updated in node properties. Sample: 10 |
| memory_mb string / elements=string | success | Amount of node memory as updated in the node properties Sample: 1024 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/baremetal_inspect_module.html