Docs4dev
Docs
ansible / latest / collections / sensu / sensu_go / ad_auth_provider_module.html

sensu.sensu_go.ad_auth_provider – Manage Sensu AD authentication provider

Note

This plugin is part of the sensu.sensu_go collection (version 1.12.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.

To use it in a playbook, specify: sensu.sensu_go.ad_auth_provider.

New in version 1.10.0: of sensu.sensu_go

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments
auth
dictionary
Authentication parameters. Can define each of them with ENV as well.
api_key
string
added in 1.3.0 of sensu.sensu_go
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/.
ca_path
path
added in 1.5.0 of sensu.sensu_go
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.
password
string
Default:
"P@ssw0rd!"
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.
url
string
Default:
"http://localhost:8080"
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.
user
string
Default:
"admin"
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.
verify
boolean
added in 1.5.0 of sensu.sensu_go
    Choices:
  • no
  • yes ←
Flag that controls the certificate validation.
If you are using self-signed certificates, you can set this parameter to false.
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.
groups_prefix
string
The prefix added to all AD groups.
name
string / required
The Sensu resource's name. This name (in combination with the namespace where applicable) uniquely identifies the resource that Ansible operates on.
If the resource with selected name already exists, Ansible module will update it to match the specification in the task.
Consult the name metadata attribute specification in the upstream docs on https://docs.sensu.io/sensu-go/latest/reference/ for more details about valid names and other restrictions.
servers
list / elements=dictionary
An array of AD servers for your directory.
binding
dictionary
The AD account that performs user and group lookups.
If your sever supports anonymous binding, you can omit the user_dn or password attributes to query the directory without credentials.
password
string / required
Password for the user_dn account.
If your sever supports anonymous binding, you can omit this attribute.
user_dn
string / required
The AD account that performs user and group lookups.
If your sever supports anonymous binding, you can omit this attribute.
client_cert_file
string
Path to the certificate that should be sent to the server if requested.
client_key_file
string
Path to the key file associated with the client_cert_file.
Required if client_cert_file is present.
default_upn_domain
string
Enables UPN authentication when set. The default UPN suffix that will be appended to the username when a domain is not specified during login (for example, user becomes user@defaultdomain.xyz).
group_search
dictionary
Search configuration for groups.
attribute
string
Default:
"member"
Used for comparing result entries.
base_dn
string / required
Which part of the directory tree to search.
name_attribute
string
Default:
"cn"
Represents the attribute to use as the entry name.
object_class
string
Default:
"group"
Identifies the class of objects returned in the search result.
host
string / required
AD server IP address.
include_nested_groups
boolean
    Choices:
  • no
  • yes
If true, the group search includes any nested groups a user is a member of. If false, the group search includes only the top-level groups a user is a member of.
insecure
boolean
    Choices:
  • no ←
  • yes
Skips SSL certificate verification when set to true.
port
integer
AD server port.
security
string
    Choices:
  • insecure
  • tls ←
  • starttls
Encryption type to be used for the connection to the AD server.
trusted_ca_file
string
Path to an alternative CA bundle file.
user_search
dictionary
Search configuration for users.
attribute
string
Default:
"sAMAccountName"
Used for comparing result entries.
base_dn
string / required
Which part of the directory tree to search.
name_attribute
string
Default:
"displayName"
Represents the attribute to use as the entry name.
object_class
string
Default:
"person"
Identifies the class of objects returned in the search result.
state
string
    Choices:
  • present ←
  • absent
Target state of the Sensu object.
username_prefix
string
The prefix added to all AD usernames.

See Also

See also

sensu.sensu_go.auth_provider_info

The official documentation on the sensu.sensu_go.auth_provider_info module.

sensu.sensu_go.ldap_auth_provider

The official documentation on the sensu.sensu_go.ldap_auth_provider module.

sensu.sensu_go.oidc_auth_provider

The official documentation on the sensu.sensu_go.oidc_auth_provider module.

Examples

- name: Create a AD auth provider
  sensu.sensu_go.ad_auth_provider:
    name: activedirectory
    servers:
      - host: 127.0.0.1
        group_search:
          base_dn: dc=acme,dc=org
        user_search:
          base_dn: dc=acme,dc=org
- name: Delete a AD auth provider
  sensu.sensu_go.ad_auth_provider:
    name: activedirectory
    state: absent

Return Values

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

Key Returned Description
object
dictionary
success
Object representing Sensu AD authentication provider.

Sample:
{'groups_prefix': 'AD', 'metadata': {'name': 'activedirectory'}, 'servers': {'binding': {'user_dn': 'cn=binder,dc=acme,dc=org'}, 'client_cert_file': '/path/to/ssl/cert.pem', 'client_key_file': '/path/to/ssl/key.pem', 'default_upn_domain': 'example.org', 'group_search': {'attribute': 'member', 'base_dn': 'dc=acme,dc=org', "name_attribute'": 'cn', 'object_class': 'group'}, 'host': '127.0.0.1', 'insecure': 'False', 'port': '636', 'security': 'tls', 'trusted_ca_file': '/path/to/trusted-certificate-authorities.pem', 'user_search': {'attribute': 'sAMAccountName', 'base_dn': 'dc=acme,dc=org', 'name_attribute': 'displayName', 'object_class': 'person'}}, 'username_prefix': 'AD'}


Authors

  • Aljaz Kosir (@aljazkosir)
  • Manca Bizjak (@mancabizjak)
  • Miha Dolinar (@mdolin)
  • Tadej Borovsak (@tadeboro)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/ad_auth_provider_module.html