cisco.ise.active_directory_is_user_member_of_group_info module – Information module for Active Directory Is User Member Of Group
Note
This module is part of the cisco.ise collection (version 1.2.1).
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
.
To use it in a playbook, specify: cisco.ise.active_directory_is_user_member_of_group_info
.
New in version 1.0.0: of cisco.ise
Synopsis
Get all Active Directory Is User Member Of Group.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 1.1.0
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Active Directory Is User Member Of Group’s additionalData. |
|
Active Directory Is User Member Of Group’s name. |
|
Active Directory Is User Member Of Group’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. |
|
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 to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: “3.1.0” |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
See Also
See also
- Active Directory Is User Member Of Group reference
Complete reference of the Active Directory Is User Member Of Group object model.
Examples
- name: Get all Active Directory Is User Member Of Group
cisco.ise.active_directory_is_user_member_of_group_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
additionalData:
- name: username
value: Required. Perform the check on this user
- name: groupsids
value: Required. Membership is looked for. The result will be a subset of this list
of the groups the user is a member of
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: “{\n \”groups\”: [\n {\n \”groupName\”: \”string\”,\n \”sid\”: \”string\”,\n \”type\”: \”string\”\n }\n ]\n}\n” |
Authors
Rafael Campos (@racampos)