cisco.ise.active_directory_groups_by_domain_info – Information module for Active Directory Groups By Domain

Note

This plugin is part of the cisco.ise collection (version 2.1.2).

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_groups_by_domain_info.

New in version 1.0.0: of cisco.ise

Synopsis

• Get all Active Directory Groups By Domain.

Note

This module has a corresponding action plugin.

Requirements

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

• ciscoisesdk >= 1.3.0

• python >= 3.5

Parameters

Parameter		Choices/Defaults	Comments
additionalData list / elements=string			Active Directory Get Groups By Domain Info's additionalData.
	name string		Active Directory Get Groups By Domain Info's name.
	value string		Active Directory Get Groups By Domain Info's value.
id string			Id path parameter.
ise_debug boolean		Choices: no ← yes	Flag for Identity Services Engine SDK to enable debugging.
ise_hostname string / required			The Identity Services Engine hostname.
ise_password string / required			The Identity Services Engine password to authenticate.
ise_username string / required			The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in 1.1.0 of cisco.ise		Choices: no yes ←	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).
ise_verify boolean		Choices: no yes ←	Flag to enable or disable SSL certificate verification.
ise_version string		Default: "3.1.1"	Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit boolean		Choices: no yes ←	Flag for Identity Services Engine SDK to enable automatic rate-limit handling.

Notes

Note

• 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

See Also

See also

Active Directory Groups By Domain reference

Complete reference of the Active Directory Groups By Domain object model.

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	Returned	Description
ise_response dictionary	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "groups": [ { "groupName": "string", "sid": "string", "type": "string" } ] }

Authors

• Rafael Campos (@racampos)