ansible.builtin.manageiq_tags (v2.9.27) — module

Management of resource tags in ManageIQ.

| "added in version" 2.5 of ansible.builtin"

Authors: Daniel Korn (@dkorn)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

The manageiq_tags module supports adding, updating and deleting tags in ManageIQ.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create new tags for a provider in ManageIQ
  manageiq_tags:
    resource_name: 'EngLab'
    resource_type: 'provider'
    tags:
    - category: environment
      name: prod
    - category: owner
      name: prod_ops
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: False
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove tags for a provider in ManageIQ
  manageiq_tags:
    state: absent
    resource_name: 'EngLab'
    resource_type: 'provider'
    tags:
    - category: environment
      name: prod
    - category: owner
      name: prod_ops
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: False
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List current tags for a provider in ManageIQ
  manageiq_tags:
    state: list
    resource_name: 'EngLab'
    resource_type: 'provider'
    manageiq_connection:
      url: 'http://127.0.0.1:3000'
      username: 'admin'
      password: 'smartvm'
      validate_certs: False

Inputs

    
tags:
    description:
    - tags - list of dictionaries, each includes 'name' and 'category' keys.
    - required if state is present or absent.

state:
    choices:
    - absent
    - present
    - list
    default: present
    description:
    - absent - tags should not exist,
    - present - tags should exist,
    - list - list current tags.

resource_name:
    description:
    - the relevant resource name in manageiq
    required: true

resource_type:
    choices:
    - provider
    - host
    - vm
    - blueprint
    - category
    - cluster
    - data store
    - group
    - resource pool
    - service
    - service template
    - template
    - tenant
    - user
    description:
    - the relevant resource type in manageiq
    required: true

manageiq_connection:
    description:
    - ManageIQ connection configuration information.
    required: false
    suboptions:
      ca_cert:
        aliases:
        - ca_bundle_path
        description:
        - The path to a CA bundle file or directory with certificates. defaults to None.
        type: str
      password:
        description:
        - ManageIQ password. C(MIQ_PASSWORD) env var if set. otherwise, required if no
          token is passed in.
        type: str
      token:
        description:
        - ManageIQ token. C(MIQ_TOKEN) env var if set. otherwise, required if no username
          or password is passed in.
        type: str
      url:
        description:
        - ManageIQ environment url. C(MIQ_URL) env var if set. otherwise, it is required
          to pass it.
        required: false
        type: str
      username:
        description:
        - ManageIQ username. C(MIQ_USERNAME) env var if set. otherwise, required if no
          token is passed in.
        type: str
      validate_certs:
        aliases:
        - verify_ssl
        default: true
        description:
        - Whether SSL certificates should be verified for HTTPS requests. defaults to
          True.
        type: bool
    type: dict