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

Note

This module is part of the opentelekomcloud.cloud collection (version 0.14.6).

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 opentelekomcloud.cloud. You need further requirements to be able to use this module, see Requirements for details.

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

New in opentelekomcloud.cloud 0.0.1

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

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

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.

floating_ip

string

Name or id of the Floating IP resource.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

mode

string

Mode to be used for tags presence ('replace' or 'set'). 'replace' will replace all existing tags, while 'set' only ensures given tags are present.

Choices:

  • "replace" ← (default)

  • "set"

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.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "ERROR"

  • "WARN" ← (default)

  • "INFO"

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

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

Should the resource be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

subnet

string

Name or id of the Neutron Subnet resource.

tags

list / elements=string

List of tags

Default: []

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

trunk

string

Name or id of the Neutron Trunk resource.

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • false

  • true

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (default)

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

Description

tags

list / elements=string

Present tags on the instance.

Returned: success

Sample: ["tag1", "tag2"]

Authors

  • Artem Goncharov (@gtema)

last updated: 2024-11-15 11:10 UTC - commit: 50bda984453bb05944b37f6d85b6380fcf26d10b