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.10.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
.
You need further requirements to be able to use this module,
see Requirements for details.
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.36, < 0.99.0
python >= 3.6
Parameters
Parameter |
Comments |
---|---|
Physical hardware address of this network Port, typically the hardware MAC address. |
|
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. |
|
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. |
|
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. |
|
Ignored. Present for backwards compatibility |
|
A path to a CA Cert bundle that can be used as part of verifying SSL API requests. |
|
A path to a client certificate to use as part of the SSL transaction. |
|
A path to a client key to use as part of the SSL transaction. |
|
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. |
|
Endpoint URL type to fetch from the service catalog. Choices:
|
|
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 or globally unique identifier (UUID) to identify a Baremetal Node. |
|
Name of the region. |
|
Log level of the OpenStackSDK Choices:
|
|
Path to the logfile of the OpenStackSDK. If empty no log is written |
|
How long should ansible wait for the requested resource. Default: |
|
Name or globally unique identifier (UUID) to identify the port. |
|
Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to Choices:
|
|
Should ansible wait until the requested resource is complete. Choices:
|
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 |
---|---|
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 |
|
Physical hardware address of this network Port, typically the hardware MAC address. Returned: success |
|
Bare Metal port created at timestamp. Returned: success |
|
A set of one or more arbitrary metadata key and value pairs. Returned: success |
|
The UUID for the Baremetal Port resource. Returned: success |
|
Internal metadata set and stored by the Port. This field is read-only. Returned: success |
|
Whether PXE is enabled or disabled on the Port. Returned: success |
|
The Port binding profile. Returned: success |
|
Identifier of the physical port on the switch to which node’s port is connected to. Returned: success |
|
A MAC address or an OpenFlow based datapath_id of the switch. Returned: success |
|
An optional string field to be used to store any vendor-specific information. Returned: success |
|
Cloud location of this resource (cloud, project, region, zone) Returned: success |
|
Bare Metal port name. Returned: success |
|
UUID of the Bare Metal Node this resource belongs to. Returned: success |
|
The name of the physical network to which a port is connected. Returned: success |
|
UUID of the Portgroup this resource belongs to. Returned: success |
|
Bare Metal port updated at timestamp. Returned: success |