cisco.ise.device_administration_authentication_rules – Resource module for Device Administration 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.device_administration_authentication_rules.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operations create, update and delete of the resource Device Administration Authentication Rules.

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.
identitySourceId
string
Identity source id from the identity stores.
identitySourceName
string
Identity source name from the identity stores.
ifAuthFail
string
Action to perform when authentication fails such as Bad credentials, disabled user and so on.
ifProcessFail
string
Action to perform when ISE is uanble to access the identity database.
ifUserNotFound
string
Action to perform when user is not found in any of identity stores.
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.
link
dictionary
Device Administration Authentication Rules's link.
href
string
Device Administration Authentication Rules's href.
rel
string
Device Administration Authentication Rules's rel.
type
string
Device Administration Authentication Rules's type.
policyId
string
PolicyId path parameter. Policy id.
rule
dictionary
Common attributes in rule authentication/authorization.
condition
dictionary
Device Administration Authentication Rules's condition.
attributeId
string
Dictionary attribute id (Optional), used for additional verification.
attributeName
string
Dictionary attribute name.
attributeValue
string
<ul><li>Attribute value for condition</li> <li>Value type is specified in dictionary object</li> <li>if multiple values allowed is specified in dictionary object</li></ul>.
children
list / elements=string
In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition.
conditionType
string
<ul><li>Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation</li> <li>Data type enum(reference,single) indicates than "conditonId" OR "ConditionAttrs" fields should contain condition data but not both</li> <li>Logical aggreation(and,or) enum indicates that additional conditions are present under the children field</li></ul>.
isNegate
boolean
    Choices:
  • no
  • yes
Indicates whereas this condition is in negate mode.
link
dictionary
Device Administration Authentication Rules's link.
href
string
Device Administration Authentication Rules's href.
rel
string
Device Administration Authentication Rules's rel.
type
string
Device Administration Authentication Rules's type.
conditionType
string
<ul><li>Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation</li> <li>Data type enum(reference,single) indicates than "conditonId" OR "ConditionAttrs" fields should contain condition data but not both</li> <li>Logical aggreation(and,or) enum indicates that additional conditions are present under the children field</li></ul>.
datesRange
dictionary
<p>Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty<br> Options are - Date range, for specific date, the same date should be used for start/end date <br> Default - no specific dates<br> In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year)</p>.
endDate
string
Device Administration Authentication Rules's endDate.
startDate
string
Device Administration Authentication Rules's startDate.
datesRangeException
dictionary
<p>Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty<br> Options are - Date range, for specific date, the same date should be used for start/end date <br> Default - no specific dates<br> In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year)</p>.
endDate
string
Device Administration Authentication Rules's endDate.
startDate
string
Device Administration Authentication Rules's startDate.
description
string
Condition description.
dictionaryName
string
Dictionary name.
dictionaryValue
string
Dictionary value.
hoursRange
dictionary
<p>Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property<br> Time foramt - hh mm ( h = hour , mm = minutes ) <br> Default - All Day </p>.
endTime
string
Device Administration Authentication Rules's endTime.
startTime
string
Device Administration Authentication Rules's startTime.
hoursRangeException
dictionary
<p>Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property<br> Time foramt - hh mm ( h = hour , mm = minutes ) <br> Default - All Day </p>.
endTime
string
Device Administration Authentication Rules's endTime.
startTime
string
Device Administration Authentication Rules's startTime.
id
string
Device Administration Authentication Rules's id.
isNegate
boolean
    Choices:
  • no
  • yes
Indicates whereas this condition is in negate mode.
link
dictionary
Device Administration Authentication Rules's link.
href
string
Device Administration Authentication Rules's href.
rel
string
Device Administration Authentication Rules's rel.
type
string
Device Administration Authentication Rules's type.
name
string
Condition name.
operator
string
Equality operator.
weekDays
list / elements=string
<p>Defines for which days this condition will be matched<br> Days format - Arrays of WeekDay enums <br> Default - List of All week days</p>.
weekDaysException
list / elements=string
<p>Defines for which days this condition will NOT be matched<br> Days format - Arrays of WeekDay enums <br> Default - Not enabled</p>.
default
boolean
    Choices:
  • no
  • yes
Indicates if this rule is the default one.
hitCounts
integer
The amount of times the rule was matched.
id
string
The identifier of the rule.
name
string
Rule name, Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses.
rank
integer
The rank(priority) in relation to other rules. Lower rank is higher priority.
state
string
The state that the rule is in. A disabled rule cannot be matched.

Notes

Note

  • Does not support check_mode

See Also

See also

Device Administration Authentication Rules reference

Complete reference of the Device Administration Authentication Rules object model.

Examples

- name: Create
  cisco.ise.device_administration_authentication_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    identitySourceId: string
    identitySourceName: string
    ifAuthFail: string
    ifProcessFail: string
    ifUserNotFound: string
    link:
      href: string
      rel: string
      type: string
    rule:
      condition:
        attributeId: string
        attributeName: string
        attributeValue: string
        children:
        - conditionType: string
          isNegate: true
          link:
            href: string
            rel: string
            type: string
        conditionType: string
        datesRange:
          endDate: string
          startDate: string
        datesRangeException:
          endDate: string
          startDate: string
        description: string
        dictionaryName: string
        dictionaryValue: string
        hoursRange:
          endTime: string
          startTime: string
        hoursRangeException:
          endTime: string
          startTime: string
        id: string
        isNegate: true
        link:
          href: string
          rel: string
          type: string
        name: string
        operator: string
        weekDays:
        - string
        weekDaysException:
        - string
      default: true
      hitCounts: 0
      id: string
      name: string
      rank: 0
      state: string

- name: Update by id
  cisco.ise.device_administration_authentication_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    id: string
    identitySourceId: string
    identitySourceName: string
    ifAuthFail: string
    ifProcessFail: string
    ifUserNotFound: string
    link:
      href: string
      rel: string
      type: string
    policyId: string
    rule:
      condition:
        attributeId: string
        attributeName: string
        attributeValue: string
        children:
        - conditionType: string
          isNegate: true
          link:
            href: string
            rel: string
            type: string
        conditionType: string
        datesRange:
          endDate: string
          startDate: string
        datesRangeException:
          endDate: string
          startDate: string
        description: string
        dictionaryName: string
        dictionaryValue: string
        hoursRange:
          endTime: string
          startTime: string
        hoursRangeException:
          endTime: string
          startTime: string
        id: string
        isNegate: true
        link:
          href: string
          rel: string
          type: string
        name: string
        operator: string
        weekDays:
        - string
        weekDaysException:
        - string
      default: true
      hitCounts: 0
      id: string
      name: string
      rank: 0
      state: string

- name: Delete by id
  cisco.ise.device_administration_authentication_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string
    policyId: string

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:
{ "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" } }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
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)