W3cubDocs

online_user_facts - Gather facts about Online user.

New in version 2.7.

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

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.

- name: Gather Online user facts
  online_user_facts:

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
	online_user_facts

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Hint

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

© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/online_user_facts_module.html