openstack.cloud.baremetal_port_group module – Create/Delete Bare Metal port group resources from OpenStack

Note

This module is part of the openstack.cloud collection (version 2.6.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_group.

New in openstack.cloud 2.6.0

Synopsis

• Create, update and remove Bare Metal port groups from OpenStack.

Requirements

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

• python >= 3.6

• openstacksdk >= 1.0.0

Parameters

Parameter	Comments
address string	Physical hardware address of this port group, 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.
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 any	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.
extra dictionary	A set of one or more arbitrary metadata key and value pairs.
id aliases: uuid string	ID of the port group. Will be auto-generated if not specified.
interface aliases: endpoint_type string	Endpoint URL type to fetch from the service catalog. Choices: "admin" "internal" "public" ← (default)
mode string	The port group mode.
name string	Name of the port group.
node string	ID or Name of the node this resource belongs to. Required when creating a new port group.
properties dictionary	Key/value properties for the port group.
region_name string	Name of the region.
sdk_log_level string	Log level of the OpenStackSDK Choices: "INFO" ← (default) "DEBUG"
sdk_log_path string	Path to the logfile of the OpenStackSDK. If empty no log is written
standalone_ports_supported boolean	Whether the port group supports ports that are not members of this port group. Choices: false true
state string	Indicates desired state of the resource. Choices: "present" ← (default) "absent"
timeout integer	How long should ansible wait for the requested resource. Default: 180
validate_certs aliases: verify boolean	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to true. Choices: false true
wait boolean	Should ansible wait until the requested resource is complete. Choices: false true ← (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

- name: Create Bare Metal port group
  openstack.cloud.baremetal_port_group:
    cloud: devstack
    state: present
    name: bond0
    node: bm-0
    address: fa:16:3e:aa:aa:aa
    mode: '802.3ad'
    standalone_ports_supported: true
  register: result

- name: Update Bare Metal port group
  openstack.cloud.baremetal_port_group:
    cloud: devstack
    state: present
    id: 1a85ebca-22bf-42eb-ad9e-f640789b8098
    mode: 'active-backup'
    properties:
      miimon: '100'
  register: result

- name: Delete Bare Metal port group
  openstack.cloud.baremetal_port_group:
    cloud: devstack
    state: absent
    id: 1a85ebca-22bf-42eb-ad9e-f640789b8098
  register: result

Return Values

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

Key	Description
port_group dictionary	A port group dictionary, subset of the dictionary keys listed below may be returned, depending on your cloud provider. Returned: success
address string	Physical hardware address of the port group. Returned: success
created_at string	Bare Metal port group 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 Bare Metal port group resource. Returned: success
links list / elements=string	A list of relative links, including the self and bookmark links. Returned: success
mode string	The port group mode. Returned: success
name string	Bare Metal port group name. Returned: success
node_id string	UUID of the Bare Metal node this resource belongs to. Returned: success
properties dictionary	Key/value properties for this port group. Returned: success
standalone_ports_supported boolean	Whether standalone ports are supported. Returned: success
updated_at string	Bare Metal port group updated at timestamp. Returned: success

Authors

• OpenStack Ansible SIG

Collection links

• Issue Tracker
• Repository (Sources)