ansible.builtin.online_user_info (v2.9.27) — module

Gather information about Online user.

| "added in version" 2.9 of ansible.builtin"

Authors: Remy Leone (@sieben)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Gather information about the user.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather Online user info
  online_user_info:
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug:
    msg: "{{ result.online_user_info }}"

Inputs

    
api_url:
    aliases:
    - base_url
    default: https://api.online.net
    description:
    - Online API URL
    type: str

api_token:
    aliases:
    - oauth_token
    description:
    - Online OAuth token.
    required: true
    type: str

api_timeout:
    aliases:
    - timeout
    default: 30
    description:
    - HTTP timeout to Online API in seconds.
    type: int

validate_certs:
    default: true
    description:
    - Validate SSL certs of the Online API.
    type: bool

Outputs

online_user_info:
  description: Response from Online API
  returned: success
  sample:
    online_user_info:
      company: foobar LLC
      email: foobar@example.com
      first_name: foo
      id: 42
      last_name: bar
      login: foobar
  type: complex