cisco.ise.active_directory_groups_by_domain_info module – Information module for Active Directory Groups By Domain
Note
This module is part of the cisco.ise collection (version 2.9.5).
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 cisco.ise
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.active_directory_groups_by_domain_info
.
New in cisco.ise 1.0.0
Synopsis
Get all Active Directory Groups By Domain.
This API lists the groups of the given domain.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.2.3
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Active Directory Get Groups By Domain Info’s additionalData. |
|
Active Directory Get Groups By Domain Info’s name. |
|
Active Directory Get Groups By Domain Info’s value. |
|
Id path parameter. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: |
|
The Identity Services Engine username to authenticate. |
|
Flag that informs the SDK whether to use the Identity Services Engine’s API Gateway to send requests. If it is true, it uses the ISE’s API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). Choices:
|
|
Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
Notes
Note
SDK Method used are active_directory.ActiveDirectory.get_groups_by_domain,
Paths used are put /ers/config/activedirectory/{id}/getGroupsByDomain,
Supports
check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK
The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection
Examples
- name: Get all Active Directory Groups By Domain
cisco.ise.active_directory_groups_by_domain_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
additionalData:
- name: domain
value: Required. The domain whose groups we want to fetch
- name: filter
value: Optional. Exact match filter on group's CN
- name: sidFilter
value: Optional. Exact match filter on group's SID, optionally specifying the domain
as prefix. e.g. S-1-5-33-544 and R1.dom/S-1-5-33-544 are legal
- name: typeFilter
value: Optional. Can be exactly one of:BUILTIN, DOMAIN LOCAL, GLOBAL, UNIVERSAL
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |