Documentation

os_ironic_inspect - Explicitly triggers baremetal node introspection in ironic.

New in version 2.1.

Synopsis

Requests Ironic to set a node into inspect state in order to collect metadata regarding the node. This command may be out of band or in-band depending on the ironic driver configuration. This is only possible on nodes in ‘manageable’ and ‘available’ state.

Requirements (on host that executes module)

  • 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
          Name of the availability zone.
          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.
                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
                    mac
                    		 no None
                      unique mac address that is used to attempt to identify the host.
                      name
                      		 no None
                        unique name identifier to identify the host in Ironic.
                        region_name
                        		 no
                          Name of the region.
                          timeout
                          		 no 180
                            How long should ansible wait for the requested resource.
                            uuid
                            		 no None
                              globally unique identifier (UUID) to identify the host.
                              validate_certs
                              		 no True
                                Whether or not SSL API requests should be verified.

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

                                Examples

                                # Invoke node inspection
- os_ironic_inspect:
    name: "testnode1"

                                Return Values

                                Common return values are documented here Common Return Values, the following are the fields unique to this module:

                                name description returned type sample
                                ansible_facts Dictionary of new facts representing discovered properties of the node.. changed dictionary
                                contains:
                                name description returned type sample
                                memory_mb Amount of node memory as updated in the node properties string 1024
                                cpu_arch Detected CPU architecture type string x86_64
                                local_gb Total size of local disk storage as updaed in node properties. string 10
                                cpus Count of cpu cores defined in the updated node properties. string 1


                                Notes

                                Note

                                The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

                                Note

                                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

                                This is an Extras Module

                                For more information on what this means please read Extras Modules

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