illumio.core.label (0.2.6) — module

Install collection

Install with ansible-galaxy collection install illumio.core:==0.2.6

Add to requirements.yml

  collections:
    - name: illumio.core
      version: 0.2.6

Description

This module allows you to create and manipulate label objects on the Illumio PCE.

Supports check mode.

Requirements

• python>=3.8
• illumio>=1.1.3

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Create Test env label"
  illumio.core.label:
    key: env
    value: Test
    state: present

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Remove existing label"
  illumio.core.label:
    key: env
    value: Test
    state: absent

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: "Remove label by HREF"
  illumio.core.label:
    href: /orgs/1/labels/1
    state: absent

Inputs

    
key:
    description:
    - Label dimension key.
    - Required for creating a label or when HREF is not specified.
    type: str

href:
    description: HREF of an existing label.
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Desired label state.
    - If C(present), the label will be created if it does not exist, or updated to match
      the provided parameters if it does.
    - If C(absent), the label will be removed if it exists.
    type: str

value:
    description:
    - Label name in the PCE.
    - Required for creating a label or when HREF is not specified.
    type: str

pce_port:
    default: 443
    description:
    - HTTP(S) port used by the PCE.
    - Can be set with the environment variable C(ILLUMIO_PCE_PORT).
    type: int

pce_org_id:
    default: 1
    description:
    - PCE Organization ID.
    - Can be set with the environment variable C(ILLUMIO_PCE_ORG_ID).
    type: int

pce_tls_ca:
    description:
    - Path to a custom root CA certificate bundle to use for the PCE connection.
    - If set, overrides C(pce_tls_verify).
    type: str

pce_hostname:
    aliases:
    - pce_url
    description:
    - URL or FQDN of Illumio Policy Compute Engine. C(pce_url) is an alias for C(pce_hostname).
    - Can be set with the environment variable C(ILLUMIO_PCE_HOST).
    required: true
    type: str

api_key_secret:
    description:
    - Illumio PCE API key secret.
    - Can be set with the environment variable C(ILLUMIO_API_KEY_SECRET).
    required: true
    type: str

pce_http_proxy:
    description:
    - HTTP proxy server to use when connecting to the PCE.
    - If not set, it will use the default C(http_proxy) environment variable.
    type: str

pce_tls_verify:
    default: true
    description:
    - Flag denoting whether TLS verification should be enabled on the PCE connection.
    type: bool

pce_https_proxy:
    description:
    - HTTPS proxy server to use when connecting to the PCE.
    - If not set, it will use the default C(https_proxy) environment variable.
    type: str

api_key_username:
    description:
    - Illumio PCE API key username.
    - Can be set with the environment variable C(ILLUMIO_API_KEY_USERNAME).
    required: true
    type: str

external_data_set:
    description:
    - External data set identifier.
    - Must be set if using C(external_data_reference).
    type: str

pce_tls_client_certs:
    description:
    - Optional paths to client-side certificate files.
    - May point to separate cert and private key files or a PEM bundle containing both.
    elements: str
    type: list

external_data_reference:
    description:
    - External data reference identifier.
    - Must be set if using C(external_data_set).
    type: str

Outputs

label:
  contains:
    created_at:
      description: A timestamp denoting when this label was created.
      returned: always
      type: str
    created_by:
      description: A reference to the user object that created this label.
      returned: always
      sample:
        created_by:
          href: /users/1
      type: dict
    deleted:
      description: Flag denoting whether or not the label has been deleted on the
        PCE.
      returned: always
      type: bool
    external_data_reference:
      description: External data reference identifier.
      returned: always
      type: str
    external_data_set:
      description: External data set identifier.
      returned: always
      type: str
    href:
      description: The label's HREF.
      returned: always
      type: str
    key:
      description: The label key.
      returned: always
      type: str
    updated_at:
      description: A timestamp denoting when this label was last updated.
      returned: always
      type: str
    updated_by:
      description: A reference to the user object that last updated this label.
      returned: always
      sample:
        updated_by:
          href: /users/1
      type: dict
    value:
      description: The label value.
      returned: always
      type: str
  description: Information about the label that was created or updated.
  returned: success
  sample:
    label:
      created_at: '2022-06-07T00:11:10.923Z'
      created_by:
        href: /users/1
      href: /orgs/1/label/1500
      key: loc
      updated_at: '2022-06-07T17:51:56.606Z'
      updated_by:
        href: /users/1
      value: AWS
  type: complex