syntropynet.syntropy.syntropy_login (0.1.4) — module

Install collection

Install with ansible-galaxy collection install syntropynet.syntropy:==0.1.4

Add to requirements.yml

  collections:
    - name: syntropynet.syntropy
      version: 0.1.4

Description

Logins to Syntropy Platform and returns API authorization token that can be used with other modules.

Requirements

• syntropy-sdk

Usage examples

Scanned by Steampunk Spotter

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

-   name: Login
    syntropylogin:
        username: AUserName
        password: APassword
    register: api_token

Scanned by Steampunk Spotter

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

-   name: Gather facts
    syntropyfacts:
        api_token: '{{ api_token.token }}'
    register: facts

Inputs

    
api_url:
    default: null
    description:
    - URL Of the Platform API.
    - This parameter is required if SYNTROPY_API_SERVER environment variable is not set.
    required: false
    type: str

password:
    description: Password for the user.
    required: true
    type: str

username:
    description: Username registered on Syntropy Platform.
    required: true
    type: str

Outputs

error:
  description: Error message upon unsuccessful login.
  returned: always
  sample: Authorization failure
  type: str
token:
  description: Retrieved API token upon successful login.
  returned: always
  sample: '{API token string}'
  type: str