openstack.cloud.server_metadata – Add/Update/Delete Metadata in Compute Instances from OpenStack¶
This plugin is part of the openstack.cloud collection.
To install it use:
ansible-galaxy collection install openstack.cloud.
To use it in a playbook, specify:
The below requirements are needed on the host that executes this module.
openstacksdk >= 0.12.0
python >= 3.6
The standard OpenStack environment variables, such as
OS_USERNAMEmay 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/
# Creates or updates hostname=test1 as metadata of the server instance vm1 - name: add metadata to compute instance hosts: localhost tasks: - name: add metadata to instance openstack.cloud.server_metadata: state: present auth: auth_url: https://openstack-api.example.com:35357/v2.0/ username: admin password: admin project_name: admin name: vm1 meta: hostname: test1 group: group1 # Removes the keys under meta from the instance named vm1 - name: delete metadata from compute instance hosts: localhost tasks: - name: delete metadata from instance openstack.cloud.server_metadata: state: absent auth: auth_url: https://openstack-api.example.com:35357/v2.0/ username: admin password: admin project_name: admin name: vm1 meta: hostname: group:
Common return values are documented here, the following are the fields unique to this module: