You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

openstack.cloud.baremetal_port_info module – Retrieve information about Bare Metal ports from OpenStack

Note

This module is part of the openstack.cloud collection (version 1.8.0).

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

Synopsis

• Retrieve information about Bare Metal ports from OpenStack.

Requirements

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

• openstacksdk

• openstacksdk >= 0.12.0

• python >= 3.6

Parameters

Parameter	Comments
address string	Physical hardware address of this network Port, typically the hardware MAC address.
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 aliases: cacert string	A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
client_cert aliases: cert string	A path to a client certificate to use as part of the SSL transaction.
client_key aliases: key string	A path to a client key to use as part of the SSL transaction.
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 aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: admin internal public ← (default)
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.
node string	Name or globally unique identifier (UUID) to identify a Baremetal Node.
region_name string	Name of the region.
timeout integer	How long should ansible wait for the requested resource. Default: 180
uuid string	Name or globally unique identifier (UUID) to identify the port.
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. Choices: no yes
wait boolean	Should ansible wait until the requested resource is complete. Choices: no yes ← (default)

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

# Gather information about all baremetal ports
- openstack.cloud.baremetal_port_info:
    cloud: devstack
  register: result
# Gather information about a baremetal port by address
- openstack.cloud.baremetal_port_info:
    cloud: devstack
    address: fa:16:3e:aa:aa:aa
  register: result
# Gather information about a baremetal port by address
- openstack.cloud.baremetal_port_info:
    cloud: devstack
    uuid: a2b6bd99-77b9-43f0-9ddc-826568e68dec
  register: result
# Gather information about a baremetal ports associated with a baremetal node
- openstack.cloud.baremetal_port_info:
    cloud: devstack
    node: bm-0
  register: result

Return Values

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

Key	Description
baremetal_ports list / elements=dictionary	Bare Metal port list. A subset of the dictionary keys listed below may be returned, depending on your cloud provider. Returned: always, but can be null
address string	Physical hardware address of this network Port, typically the hardware MAC address. Returned: success
created_at string	Bare Metal port created at timestamp. Returned: success
extra dictionary	A set of one or more arbitrary metadata key and value pairs. Returned: success
id string	The UUID for the Baremetal Port resource. Returned: success
internal_info dictionary	Internal metadata set and stored by the Port. This field is read-only. Returned: success
is_pxe_enabled boolean	Whether PXE is enabled or disabled on the Port. Returned: success
local_link_connection dictionary	The Port binding profile. Returned: success
port_id string	Identifier of the physical port on the switch to which node’s port is connected to. Returned: success
switch_id string	A MAC address or an OpenFlow based datapath_id of the switch. Returned: success
switch_info string	An optional string field to be used to store any vendor-specific information. Returned: success
location dictionary	Cloud location of this resource (cloud, project, region, zone) Returned: success
name string	Bare Metal port name. Returned: success
node_id string	UUID of the Bare Metal Node this resource belongs to. Returned: success
physical_network string	The name of the physical network to which a port is connected. Returned: success
port_group_id string	UUID of the Portgroup this resource belongs to. Returned: success
updated_at string	Bare Metal port updated at timestamp. Returned: success

Authors

• OpenStack Ansible SIG

Collection links

Issue Tracker Repository (Sources)