community.general.iap_token (0.1.1) — module

Get token for the Itential Automation Platform

Authors: Itential (@cma0) <opensource@itential.com>

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Checks the connection to IAP and retrieves a login token.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get token for the Itential Automation Platform
  iap_token:
    iap_port: 3000
    iap_fqdn: localhost
    username: myusername
    password: mypass
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug: var=result.token

Inputs

    
https:
    default: false
    description:
    - Use HTTPS to connect
    - By default using http
    type: bool

iap_fqdn:
    default: null
    description:
    - Provide the fqdn or ip-address for the Itential Automation Platform
    required: true

iap_port:
    default: null
    description:
    - Provide the port number for the Itential Automation Platform
    required: true

password:
    default: null
    description:
    - Provide the password for the Itential Automation Platform
    required: true

username:
    default: null
    description:
    - Provide the username for the Itential Automation Platform
    required: true

validate_certs:
    default: false
    description:
    - If C(no), SSL certificates for the target url will not be validated. This should
      only be used on personally controlled sites using self-signed certificates.
    type: bool

Outputs

token:
  description: The token acquired from the Itential Automation Platform
  returned: always
  type: str