.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.ise.network_access_conditions_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.network_access_conditions -- Resource module for Network Access Conditions ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 2.0.0). 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 :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.network_access_conditions`. .. 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 Conditions. .. 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 >= 1.2.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
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
Network Access Conditions's link.
href
string
Network Access Conditions's href.
rel
string
Network Access Conditions's rel.
type
string
Network Access Conditions'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<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 Conditions's endDate.
startDate
string
Network Access Conditions's startDate.
datesRangeException
dictionary
<p>Defines for which date/s TimeAndDate condition will be matched<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 Conditions's endDate.
startDate
string
Network Access Conditions'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<br> Time format - hh mm ( h = hour , mm = minutes ) <br> Default - All Day </p>.
endTime
string
Network Access Conditions's endTime.
startTime
string
Network Access Conditions's startTime.
hoursRangeException
dictionary
<p>Defines for which hours a TimeAndDate condition will be matched<br> Time format - hh mm ( h = hour , mm = minutes ) <br> Default - All Day </p>.
endTime
string
Network Access Conditions's endTime.
startTime
string
Network Access Conditions's startTime.
id
string
Network Access Conditions's 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.
isNegate
boolean
    Choices:
  • no
  • yes
Indicates whereas this condition is in negate mode.
link
dictionary
Network Access Conditions's link.
href
string
Network Access Conditions's href.
rel
string
Network Access Conditions's rel.
type
string
Network Access Conditions'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>.

.. Attributes .. Notes Notes ----- .. note:: - Does not support ``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 .. Seealso See Also -------- .. seealso:: `Network Access Conditions reference `_ Complete reference of the Network Access Conditions object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.ise.network_access_conditions: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present 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 - name: Update by name cisco.ise.network_access_conditions: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present 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 - name: Delete by name cisco.ise.network_access_conditions: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: absent name: string - name: Update by id cisco.ise.network_access_conditions: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present 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 - name: Delete by id cisco.ise.network_access_conditions: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: absent id: 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:
{ "conditionType": "string", "isNegate": true, "link": { "href": "string", "rel": "string", "type": "string" }, "description": "string", "id": "string", "name": "string", "attributeName": "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" ] }
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": { "conditionType": "string", "isNegate": true, "link": { "href": "string", "rel": "string", "type": "string" }, "description": "string", "id": "string", "name": "string", "attributeName": "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" ] }, "version": "string" }


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