dellemc.openmanage.ome_active_directory module – Configure Active Directory groups to be used with Directory Services
Note
This module is part of the dellemc.openmanage collection (version 9.9.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 dellemc.openmanage.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.ome_active_directory.
New in dellemc.openmanage 4.0.0
Synopsis
This module allows to add, modify, and delete OpenManage Enterprise connection with Active Directory Service.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
Provide the full path of the SSL certificate. The certificate should be a Root CA Certificate encoded in Base64 format. This is applicable when validate_certificate is |
|
Select the Domain Controller Lookup method. Choices:
|
|
Domain controller port. By default, Global Catalog Address port number 3269 is populated. For the Domain Controller Access, enter 636 as the port number.
Default: |
|
Provide the domain password. This is applicable when test_connection is |
|
Enter the domain name or FQDN or IP address of the domain controller. If domain_controller_lookup is If domain_controller_lookup is |
|
Provide the domain username either in the UPN (username@domain) or NetBIOS (domain\\username) format. This is applicable when test_connection is |
|
Provide the group domain in the format |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
Provide the ID of the existing Active Directory service connection. This is applicable for modification and deletion. This is mutually exclusive with name. |
|
Provide a name for the Active Directory connection. This is applicable for creation and deletion. This is mutually exclusive with name. |
|
Enter the network timeout duration in seconds. The supported timeout duration range is 15 to 300 seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Enter the search timeout duration in seconds. The supported timeout duration range is 15 to 300 seconds. Default: |
|
Choices:
|
|
Enables testing the connection to the domain controller. The connection to the domain controller is tested with the provided Active Directory service details. If test fails, module will error out. If Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
Enables validation of SSL certificate of the domain controller. The module will always report change when this is Choices:
|
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
The module will always report change when validate_certificate is
true.Run this module from a system that has direct access to OpenManage Enterprise.
This module supports
check_mode.
Examples
---
- name: Add Active Directory service using DNS lookup along with the test connection
dellemc.openmanage.ome_active_directory:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name: my_ad1
domain_server:
- domainname.com
group_domain: domainname.com
test_connection: true
domain_username: user@domainname
domain_password: domain_password
- name: Add Active Directory service using IP address of the domain controller with certificate validation
dellemc.openmanage.ome_active_directory:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name: my_ad2
domain_controller_lookup: MANUAL
domain_server:
- 192.68.20.181
group_domain: domainname.com
validate_certificate: true
certificate_file: "/path/to/certificate/file.cer"
- name: Modify domain controller IP address, network_timeout and group_domain
dellemc.openmanage.ome_active_directory:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name: my_ad2
domain_controller_lookup: MANUAL
domain_server:
- 192.68.20.189
group_domain: newdomain.in
network_timeout: 150
- name: Delete Active Directory service
dellemc.openmanage.ome_active_directory:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name: my_ad2
state: absent
- name: Test connection to existing Active Directory service with certificate validation
dellemc.openmanage.ome_active_directory:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
name: my_ad2
test_connection: true
domain_username: user@domainname
domain_password: domain_password
validate_certificate: true
certificate_file: "/path/to/certificate/file.cer"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The Active Directory that was added, modified or deleted by this module. Returned: on change Sample: |
|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Overall status of the Active Directory operation. Returned: always Sample: |