cisco.ise.network_access_authentication_rules_info – Information module for Network Access Authentication Rules

Note

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

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

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

New in version 1.0.0: of cisco.ise

Synopsis

  • Get all Network Access Authentication Rules.

  • Get Network Access Authentication Rules by id.

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 Choices/Defaults Comments
id
string
Id path parameter. Rule id.
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.0"
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.
policyId
string
PolicyId path parameter. Policy id.

Notes

Note

  • Supports check_mode

See Also

See also

Network Access Authentication Rules reference

Complete reference of the Network Access Authentication Rules object model.

Examples

- name: Get all Network Access Authentication Rules
  cisco.ise.network_access_authentication_rules_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    policyId: string
  register: result

- name: Get Network Access Authentication Rules by id
  cisco.ise.network_access_authentication_rules_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    policyId: string
    id: string
  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:
{ "response": { "identitySourceId": "string", "identitySourceName": "string", "ifAuthFail": "string", "ifProcessFail": "string", "ifUserNotFound": "string", "link": { "href": "string", "rel": "string", "type": "string" }, "rule": { "condition": { "conditionType": "string", "isNegate": true, "link": { "href": "string", "rel": "string", "type": "string" }, "description": "string", "id": "string", "name": "string", "attributeName": "string", "attributeId": "string", "attributeValue": "string", "dictionaryName": "string", "dictionaryValue": "string", "operator": "string", "children": [ { "conditionType": "string", "isNegate": true, "link": { "href": "string", "rel": "string", "type": "string" } } ], "datesRange": { "endDate": "string", "startDate": "string" }, "datesRangeException": { "endDate": "string", "startDate": "string" }, "hoursRange": { "endTime": "string", "startTime": "string" }, "hoursRangeException": { "endTime": "string", "startTime": "string" }, "weekDays": [ "string" ], "weekDaysException": [ "string" ] }, "default": true, "hitCounts": 0, "id": "string", "name": "string", "rank": 0, "state": "string" } }, "version": "string" }


Authors

  • Rafael Campos (@racampos)