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

Note

This module is part of the community.network collection (version 5.0.2).

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.

Aliases: network.itential.iap_token

Parameters

Parameter

Comments

https

boolean

Use HTTPS to connect

By default using http

Choices:

  • false ← (default)

  • true

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

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.

Choices:

  • false ← (default)

  • true

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

Description

token

string

The token acquired from the Itential Automation Platform

Returned: always

Authors

  • Itential (@cma0)