Try SpotterList Sensu authentication providers
| "added in version" 1.10.0 of sensu.sensu_go"
Authors: Aljaz Kosir (@aljazkosir), Manca Bizjak (@mancabizjak), Miha Dolinar (@mdolin), Tadej Borovsak (@tadeboro)
stableinterface | supported by certified
Install with ansible-galaxy collection install sensu.sensu_go:==1.14.0
collections:
- name: sensu.sensu_go
version: 1.14.0Retrieve information about Sensu Go authentication providers.
For more information, refer to the Sensu documentation at U(https://docs.sensu.io/sensu-go/latest/operations/control-access/).
- 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 }}"
auth:
description:
- Authentication parameters. Can define each of them with ENV as well.
suboptions:
api_key:
description:
- 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 I(auth.user) and I(auth.password) parameters.
- For more information about the API key, refer to the official Sensu documentation
at U(https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/).
type: str
version_added: 1.3.0
version_added_collection: sensu.sensu_go
ca_path:
description:
- 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 I(SENSU_CA_PATH) environment
variable.
type: path
version_added: 1.5.0
version_added_collection: sensu.sensu_go
password:
default: P@ssw0rd!
description:
- 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 I(auth.api_key) parameter is set.
type: str
url:
default: http://localhost:8080
description:
- Location of the Sensu backend API. If this is not set the value of the SENSU_URL
environment variable will be checked.
type: str
user:
default: admin
description:
- 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 I(auth.api_key) parameter is set.
type: str
verify:
default: true
description:
- Flag that controls the certificate validation.
- If you are using self-signed certificates, you can set this parameter to C(false).
- ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates
in production, see the I(auth.ca_path) parameter.
- It is also possible to set this parameter via the I(SENSU_VERIFY) environment
variable.
type: bool
version_added: 1.5.0
version_added_collection: sensu.sensu_go
type: dict
name:
description:
- Retrieve information about this specific object instead of listing all objects.
type: str
objects:
description: List of Sensu authentication providers.
elements: dict
returned: success
sample:
- groups_prefix: ''
metadata:
name: openldap
servers:
binding:
user_dn: cn=binder,dc=acme,dc=org
client_cert_file: ''
client_key_file: ''
default_upn_domain: ''
group_search:
attribute: member
base_dn: dc=acme,dc=org
name_attribute: cn
object_class: groupOfNames
host: 127.0.0.1
insecure: false
port: 636
security: tls
trusted_ca_file: ''
user_search:
attribute: uid
base_dn: dc=acme,dc=org
name_attribute: cn
object_class: person
username_prefix: ''
type: list