illumio.core.pairing_key (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 generate pairing keys on the Illumio PCE that can be used to pair Illumio VEN agents

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: "Generate pairing key by profile name"
  illumio.core.pairing_key:
    pairing_profile_name: Default
  register: pairing_key_result

Scanned by Steampunk Spotter

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

- name: "Generate pairing key by profile HREF"
  illumio.core.pairing_key:
    pairing_profile_href: /orgs/1/pairing_profiles/1
  register: pairing_key_result

Inputs

    
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

pairing_profile_href:
    description: HREF of an existing pairing profile.
    type: str

pairing_profile_name:
    description: Name of an existing pairing profile.
    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

Outputs

pairing_key:
  description: The generated pairing key.
  returned: success
  type: str