opentelekomcloud.cloud.tag (0.14.2) — module

Manage tags on diverse OpenStack/OTC resources

| "added in version" 0.0.1 of opentelekomcloud.cloud"

Authors: Artem Goncharov (@gtema)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

set or delete tags on the OpenStack/OTC resources


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: replace all tags with a single tag on a server
  os_tag:
    server: "{{ server_name }}"
    state: present
    tags:
        - new_tag
    mode: replace
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: replace all tags with a single tag on a network
  os_tag:
    network: "{{ network_name }}"
    state: present
    tags:
        - new_tag
    mode: replace
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: append tags on instance
  os_tag:
    server: "{{ server_name }}"
    state: present
    mode: set
    tags:
        - new_tag1
        - new_tag2
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove all tags
  os_tag:
    server: "{{ server_name }}"
    state: present
    tags:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove only given tags
  os_tag:
    server: "{{ server_name }}"
    state: present
    tags:
      - new_tag1

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(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.
    type: dict

mode:
    choices:
    - replace
    - set
    default: replace
    description:
    - Mode to be used for tags presence ('replace' or 'set'). 'replace' will replace all
      existing tags, while 'set' only ensures given tags are present.
    type: str

port:
    description:
    - Name or id of the Neutron Port resource.
    type: str

tags:
    default: []
    description:
    - List of tags
    elements: str
    type: list

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Should the resource be present or absent.
    type: str

trunk:
    description:
    - Name or id of the Neutron Trunk resource.
    type: str

router:
    description:
    - Name or id of the Neutron Router resource.
    type: str

server:
    description:
    - Name or id of the Nova Server resource.
    type: str

subnet:
    description:
    - Name or id of the Neutron Subnet resource.
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

network:
    description:
    - Name or id of the Neutron Network resource.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

auth_type:
    description:
    - 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 I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

api_timeout:
    description:
    - 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.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

floating_ip:
    description:
    - Name or id of the Floating IP resource.
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

security_group:
    description:
    - Name or id of the Neutron SecurityGroup resource.
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

security_group_rule:
    description:
    - Name or id of the Neutron SecurityGroupRule resource.
    type: str

Outputs

tags:
  description: Present tags on the instance.
  returned: success
  sample:
  - tag1
  - tag2
  type: list