community.network.iap_token – Get token for the Itential Automation Platform

Note

This plugin is part of the community.network collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.iap_token.

Synopsis

  • Checks the connection to IAP and retrieves a login token.

Parameters

Parameter Choices/Defaults Comments
https
boolean
    Choices:
  • no ←
  • yes
Use HTTPS to connect
By default using http
iap_fqdn
string / required
Provide the fqdn or ip-address for the Itential Automation Platform
iap_port
string / required
Provide the port number for the Itential Automation Platform
password
string / required
Provide the password for the Itential Automation Platform
username
string / required
Provide the username for the Itential Automation Platform
validate_certs
boolean
    Choices:
  • no ←
  • yes
If no, SSL certificates for the target url will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: Get token for the Itential Automation Platform
  community.network.iap_token:
    iap_port: 3000
    iap_fqdn: localhost
    username: myusername
    password: mypass
  register: result

- ansible.builtin.debug: var=result.token

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
token
string
always
The token acquired from the Itential Automation Platform



Authors