sensu.sensu_go.auth_provider_info module – List Sensu authentication providers
Note
This module is part of the sensu.sensu_go collection (version 1.14.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install sensu.sensu_go.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: sensu.sensu_go.auth_provider_info.
Note
The sensu.sensu_go collection will be removed from Ansible 12 due to violations of the Ansible inclusion requirements. The collection has unresolved sanity test failures. See the discussion thread for more information.
New in sensu.sensu_go 1.10.0
Synopsis
Retrieve information about Sensu Go authentication providers.
For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/operations/control-access/.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
Parameters
Parameter |
Comments |
|---|---|
Authentication parameters. Can define each of them with ENV as well. |
|
The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked. This replaces auth.user and auth.password parameters. For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/. |
|
Path to the CA bundle that should be used to validate the backend certificate. If this parameter is not set, module will use the CA bundle that python is using. It is also possible to set this parameter via the SENSU_CA_PATH environment variable. |
|
The Sensu user’s password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked. This parameter is ignored if the auth.api_key parameter is set. Default: |
|
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked. Default: |
|
The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked. This parameter is ignored if the auth.api_key parameter is set. Default: |
|
Flag that controls the certificate validation. If you are using self-signed certificates, you can set this parameter to ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter. It is also possible to set this parameter via the SENSU_VERIFY environment variable. Choices:
|
|
Retrieve information about this specific object instead of listing all objects. |
See Also
See also
- sensu.sensu_go.ad_auth_provider
Manage Sensu AD authentication provider.
- sensu.sensu_go.ldap_auth_provider
Manage Sensu LDAP authentication provider.
- sensu.sensu_go.oidc_auth_provider
Manage Sensu OIDC authentication provider.
Examples
- name: List all Sensu authentication providers
sensu.sensu_go.auth_provider_info:
register: result
- name: List the selected Sensu authentication provider
sensu.sensu_go.auth_provider_info:
name: my_auth_provider
register: result
- name: Do something with result
ansible.builtin.debug:
msg: "{{ result.objects.0.metadata.name }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
List of Sensu authentication providers. Returned: success Sample: |