opentelekomcloud.cloud.tag – Manage tags on diverse OpenStack/OTC resources

Note

This plugin is part of the opentelekomcloud.cloud collection (version 0.9.0).

To install it use: ansible-galaxy collection install opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.tag.

New in version 0.0.1: of opentelekomcloud.cloud

Synopsis

• set or delete tags on the OpenStack/OTC resources

Requirements

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

• openstacksdk

• openstacksdk >= 0.36.0

• otcextensions

• python >= 2.7

• python >= 3.6

Parameters

Parameter	Choices/Defaults	Comments
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, os_user_domain_name or os_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 string		A path to a CA Cert bundle that can be used as part of verifying SSL API requests. aliases: cacert
client_cert string		A path to a client certificate to use as part of the SSL transaction. aliases: cert
client_key string		A path to a client key to use as part of the SSL transaction. aliases: key
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.
floating_ip string		Name or id of the Floating IP resource.
interface string	Choices: admin internal public ←	Endpoint URL type to fetch from the service catalog. aliases: endpoint_type
mode string	Choices: replace ← set	Mode to be used for tags presence ('replace' or 'set'). 'replace' will replace all existing tags, while 'set' only ensures given tags are present.
network string		Name or id of the Neutron Network resource.
port string		Name or id of the Neutron Port resource.
region_name string		Name of the region.
router string		Name or id of the Neutron Router resource.
security_group string		Name or id of the Neutron SecurityGroup resource.
security_group_rule string		Name or id of the Neutron SecurityGroupRule resource.
server string		Name or id of the Nova Server resource.
state string	Choices: present ← absent	Should the resource be present or absent.
subnet string		Name or id of the Neutron Subnet resource.
tags list / elements=string	Default: []	List of tags
timeout integer	Default: 180	How long should ansible wait for the requested resource.
trunk string		Name or id of the Neutron Trunk resource.
validate_certs boolean	Choices: no ← yes	Whether or not SSL API requests should be verified. Before Ansible 2.3 this defaulted to yes. aliases: verify
wait boolean	Choices: no yes ←	Should ansible wait until the requested resource is complete.

Notes

Note

• One and only one of server, floating_ip, network, port, router, security_group, security_group_rule, subnet, trunk should be set.

• 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: replace all tags with a single tag on a server
  os_tag:
    server: "{{ server_name }}"
    state: present
    tags:
        - new_tag
    mode: replace

- name: replace all tags with a single tag on a network
  os_tag:
    network: "{{ network_name }}"
    state: present
    tags:
        - new_tag
    mode: replace

- name: append tags on instance
  os_tag:
    server: "{{ server_name }}"
    state: present
    mode: set
    tags:
        - new_tag1
        - new_tag2

- name: remove all tags
  os_tag:
    server: "{{ server_name }}"
    state: present
    tags:

- name: remove only given tags
  os_tag:
    server: "{{ server_name }}"
    state: present
    tags:
      - new_tag1

Return Values

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

Key	Returned	Description
tags list / elements=string	success	Present tags on the instance. Sample: ['tag1', 'tag2']

Authors

• Artem Goncharov (@gtema)