.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.ise.network_access_authorization_rules_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.network_access_authorization_rules -- Resource module for Network Access Authorization Rules ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 0.0.9). To install it use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.network_access_authorization_rules`. .. version_added .. versionadded:: 1.0.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Network Access Authorization Rules. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
id
string
Id path parameter. Rule id.
policyId
string
PolicyId path parameter. Policy id.
profile
list / elements=string
The authorization profile/s.
rule
dictionary
Common attributes in rule authentication/authorization.
condition
dictionary
Network Access Authorization 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.
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
Network Access Authorization Rules's endDate.
startDate
string
Network Access Authorization 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
Network Access Authorization Rules's endDate.
startDate
string
Network Access Authorization 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
Network Access Authorization Rules's endTime.
startTime
string
Network Access Authorization 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
Network Access Authorization Rules's endTime.
startTime
string
Network Access Authorization Rules's startTime.
id
string
Network Access Authorization Rules's id.
isNegate
boolean
    Choices:
  • no
  • yes
Indicates whereas this condition is in negate mode.
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.
description
string
The description of the rule.
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.
securityGroup
string
Security group used in authorization policies.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.ise.plugins.module_utils.definitions.network_access_authorization_rules ` The official documentation on the **cisco.ise.plugins.module_utils.definitions.network_access_authorization_rules** module. `Network Access Authorization Rules reference `_ Complete reference of the Network Access Authorization Rules object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.ise.network_access_authorization_rules: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present profile: - string rule: condition: attributeId: string attributeName: string attributeValue: string children: - conditionType: string isNegate: true 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 name: string operator: string weekDays: - string weekDaysException: - string default: true description: string hitCounts: 0 id: string name: string rank: 0 state: string securityGroup: string - name: Update by id cisco.ise.network_access_authorization_rules: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present id: string policyId: string profile: - string rule: condition: attributeId: string attributeName: string attributeValue: string children: - conditionType: string isNegate: true 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 name: string operator: string weekDays: - string weekDaysException: - string default: true description: string hitCounts: 0 id: string name: string rank: 0 state: string securityGroup: string - name: Delete by id cisco.ise.network_access_authorization_rules: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: absent id: string policyId: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "rule": { "id": "string", "name": "string", "description": "string", "hitCounts": 0, "rank": 0, "state": "string", "default": true, "condition": { "conditionType": "string", "isNegate": true, "name": "string", "id": "string", "description": "string", "dictionaryName": "string", "attributeName": "string", "attributeId": "string", "operator": "string", "dictionaryValue": "string", "attributeValue": "string", "children": [ { "conditionType": "string", "isNegate": true } ], "hoursRange": { "startTime": "string", "endTime": "string" }, "hoursRangeException": { "startTime": "string", "endTime": "string" }, "weekDays": [ "string" ], "weekDaysException": [ "string" ], "datesRange": { "startDate": "string", "endDate": "string" }, "datesRangeException": { "startDate": "string", "endDate": "string" } } }, "profile": [ "string" ], "securityGroup": "string" }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors