/ home / inwx / inwx.collection / 1.3.0 / module / session

inwx.collection.session (1.3.0) — module

Retrieves an INWX API session with two factor authentication

| "added in version" 2.10 of inwx.collection"

Authors: Nick Ufer (@NickUfer)

preview | supported by community

Install collection

Install with ansible-galaxy collection install inwx.collection:==1.3.0

Add to requirements.yml

  collections:
    - name: inwx.collection
      version: 1.3.0

Description

Retrieves an INWX API session with two factor authentication.

Requirements

python >= 3.6

Usage examples

Scanned by Steampunk Spotter

- name: Get a session without two factor authentication
  inwx.collection.session:
    username: test_user
    password: test_password

Scanned by Steampunk Spotter

- name: Get a session with two factor authentication
  inwx.collection.session:
    username: test_user
    password: test_password
    shared_secret: test_shared_secret

Scanned by Steampunk Spotter

- name: Get a session for the OTE API
  inwx.collection.session:
    api_env: 'ote'
    username: test_user
    password: test_password

Inputs

    
api_env:
    choices:
    - live
    - ote
    default: live
    description:
    - Defines which api should be used.
    required: false
    type: str

password:
    aliases:
    - pass
    description:
    - INWX Account Password
    - Required for API authentication.
    required: true
    type: str

username:
    aliases:
    - user
    description:
    - INWX Account Username
    - Required for API authentication.
    required: true
    type: str

shared_secret:
    description:
    - INWX Account Shared Secret
    - Required for the generation of a TOTP.
    required: false
    type: str

Outputs

session:
  description: The session for this log in.
  returned: success
  type: str