cisco.ise.active_directory_user_groups_info – Information module for Active Directory User Groups

Note

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

To install it use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.active_directory_user_groups_info.

New in version 1.0.0: of cisco.ise

Synopsis

  • Get all Active Directory User Groups.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk

Parameters

Parameter Choices/Defaults Comments
additionalData
list / elements=string
Active Directory Get User Groups's additionalData.
name
string
Active Directory Get User Groups's name.
value
string
Active Directory Get User Groups's value.
id
string
Id path parameter.

See Also

See also

cisco.ise.plugins.module_utils.definitions.active_directory_user_groups

The official documentation on the cisco.ise.plugins.module_utils.definitions.active_directory_user_groups module.

Active Directory User Groups reference

Complete reference of the Active Directory User Groups object model.

Examples

- name: Get all Active Directory User Groups
  cisco.ise.active_directory_user_groups_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
    additionalData:
    - name: username
      value: '{{username}}'
  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": [ { "name": "string", "sid": "string", "type": "string" } ] }


Authors

  • Rafael Campos (@racampos)