online_user_facts – Gather facts about Online user — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# online_user_facts – Gather facts about Online user

New in version 2.7.

- DEPRECATED
- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## DEPRECATED

Removed in Ansible:
| version: 2.13
Why: | Deprecated in favour of `_info` module.
Alternative: | Use online_user_info instead.

## Synopsis

- Gather facts about the user.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
api_timeout integer | Default: 30 | HTTP timeout to Online API in seconds. aliases: timeout
api_token string |  | Online OAuth token. aliases: oauth_token
api_url string | Default: "https://api.online.net" | Online API URL aliases: base_url
validate_certs boolean | Choices: no yes ← | Validate SSL certs of the Online API.

## Notes

Note

- Also see the API documentation on https://console.online.net/en/api/
- If `api_token` is not set within the module, the following environment variables can be used in decreasing order of precedence `ONLINE_TOKEN`, `ONLINE_API_KEY`, `ONLINE_OAUTH_TOKEN`, `ONLINE_API_TOKEN`
- If one wants to use a different `api_url` one can also set the `ONLINE_API_URL` environment variable.

## Examples

    - name: Gather Online user facts
      online_user_facts:

## Return Values

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

Key | Returned | Description
--- | --- | ---
online_user_facts complex | success | Response from Online API Sample: {'online_user_facts': {'company': 'foobar LLC', 'email': 'foobar@example.com', 'first_name': 'foo', 'id': 42, 'last_name': 'bar', 'login': 'foobar'}}

## Status

- This module will be removed in version 2.13. [deprecated]
- For more information see DEPRECATED.

### Authors

- Remy Leone (@sieben)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.