.. 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 .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.ise.device_administration_authentication_rules_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.device_administration_authentication_rules module -- Resource module for Device Administration Authentication Rules +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.ise collection `_ (version 2.10.0). To install it, use: :code:`ansible-galaxy collection install cisco.ise`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.ise.device_administration_authentication_rules`. .. version_added .. rst-class:: ansible-version-added New in cisco.ise 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Device Administration Authentication Rules. - Device Admin - Create authentication rule. - Device Admin - Delete rule. - Device Admin - - Update rule. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.device_administration_authentication_rules_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk \>= 2.2.3 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. Rule id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-identitysourceid: .. rst-class:: ansible-option-title **identitySourceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Identity source id from the identity stores. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-identitysourcename: .. rst-class:: ansible-option-title **identitySourceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Identity source name from the identity stores. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ifauthfail: .. rst-class:: ansible-option-title **ifAuthFail** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Action to perform when authentication fails such as Bad credentials, disabled user and so on. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ifprocessfail: .. rst-class:: ansible-option-title **ifProcessFail** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Action to perform when ISE is uanble to access the identity database. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ifusernotfound: .. rst-class:: ansible-option-title **ifUserNotFound** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Action to perform when user is not found in any of identity stores. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_debug: .. rst-class:: ansible-option-title **ise_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_hostname: .. rst-class:: ansible-option-title **ise_hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_password: .. rst-class:: ansible-option-title **ise_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_single_request_timeout: .. rst-class:: ansible-option-title **ise_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
Timeout (in seconds) for RESTful HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_username: .. rst-class:: ansible-option-title **ise_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine username to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_uses_api_gateway: .. rst-class:: ansible-option-title **ise_uses_api_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
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). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_uses_csrf_token: .. rst-class:: ansible-option-title **ise_uses_csrf_token** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
Flag that informs the SDK whether we send the CSRF token to ISE's ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_verify: .. rst-class:: ansible-option-title **ise_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_version: .. rst-class:: ansible-option-title **ise_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Identity Services Engine to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1\_Patch\_1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-ise_wait_on_rate_limit: .. rst-class:: ansible-option-title **ise_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-link: .. rst-class:: ansible-option-title **link** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's link. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-link/href: .. rst-class:: ansible-option-title **href** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's href. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-link/rel: .. rst-class:: ansible-option-title **rel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's rel. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-link/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-policyid: .. rst-class:: ansible-option-title **policyId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
PolicyId path parameter. Policy id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule: .. rst-class:: ansible-option-title **rule** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Common attributes in rule authentication/authorization. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition: .. rst-class:: ansible-option-title **condition** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's condition. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/attributeid: .. rst-class:: ansible-option-title **attributeId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Dictionary attribute id (Optional), used for additional verification. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/attributename: .. rst-class:: ansible-option-title **attributeName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Dictionary attribute name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/attributevalue: .. rst-class:: ansible-option-title **attributeValue** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
\\Attribute value for condition\ \Value type is specified in dictionary object\ \if multiple values allowed is specified in dictionary object\\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/children: .. rst-class:: ansible-option-title **children** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
In case type is andBlock or orBlock addtional conditions will be aggregated under this logical (OR/AND) condition. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/children/conditiontype: .. rst-class:: ansible-option-title **conditionType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
\\Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation\ \Data type enum(reference,single) indicates than "conditonId" OR "ConditionAttrs" fields should contain condition data but not both\ \Logical aggreation(and,or) enum indicates that additional conditions are present under the children field\\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/children/isnegate: .. rst-class:: ansible-option-title **isNegate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whereas this condition is in negate mode. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/children/link: .. rst-class:: ansible-option-title **link** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's link. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/children/link/href: .. rst-class:: ansible-option-title **href** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's href. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/children/link/rel: .. rst-class:: ansible-option-title **rel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's rel. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/children/link/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/conditiontype: .. rst-class:: ansible-option-title **conditionType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
\\Inidicates whether the record is the condition itself(data) or a logical(or,and) aggregation\ \Data type enum(reference,single) indicates than "conditonId" OR "ConditionAttrs" fields should contain condition data but not both\ \Logical aggreation(and,or) enum indicates that additional conditions are present under the children field\\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/datesrange: .. rst-class:: ansible-option-title **datesRange** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
\Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty\ Options are - Date range, for specific date, the same date should be used for start/end date \ Default - no specific dates\ In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year)\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/datesrange/enddate: .. rst-class:: ansible-option-title **endDate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's endDate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/datesrange/startdate: .. rst-class:: ansible-option-title **startDate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's startDate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/datesrangeexception: .. rst-class:: ansible-option-title **datesRangeException** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
\Defines for which date/s TimeAndDate condition will be matched or NOT matched if used in exceptionDates prooperty\ Options are - Date range, for specific date, the same date should be used for start/end date \ Default - no specific dates\ In order to reset the dates to have no specific dates Date format - yyyy-mm-dd (MM = month, dd = day, yyyy = year)\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/datesrangeexception/enddate: .. rst-class:: ansible-option-title **endDate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's endDate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/datesrangeexception/startdate: .. rst-class:: ansible-option-title **startDate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's startDate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Condition description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/dictionaryname: .. rst-class:: ansible-option-title **dictionaryName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Dictionary name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/dictionaryvalue: .. rst-class:: ansible-option-title **dictionaryValue** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Dictionary value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/hoursrange: .. rst-class:: ansible-option-title **hoursRange** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
\Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property\ Time foramt - hh mm ( h = hour , mm = minutes ) \ Default - All Day \. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/hoursrange/endtime: .. rst-class:: ansible-option-title **endTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's endTime. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/hoursrange/starttime: .. rst-class:: ansible-option-title **startTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's startTime. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/hoursrangeexception: .. rst-class:: ansible-option-title **hoursRangeException** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
\Defines for which hours a TimeAndDate condition will be matched or not matched if used in exceptionHours property\ Time foramt - hh mm ( h = hour , mm = minutes ) \ Default - All Day \. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/hoursrangeexception/endtime: .. rst-class:: ansible-option-title **endTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's endTime. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/hoursrangeexception/starttime: .. rst-class:: ansible-option-title **startTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's startTime. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/isnegate: .. rst-class:: ansible-option-title **isNegate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whereas this condition is in negate mode. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/link: .. rst-class:: ansible-option-title **link** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's link. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/link/href: .. rst-class:: ansible-option-title **href** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's href. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/link/rel: .. rst-class:: ansible-option-title **rel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's rel. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/link/type: .. rst-class:: ansible-option-title **type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Authentication Rules's type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Condition name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/operator: .. rst-class:: ansible-option-title **operator** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Equality operator. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/weekdays: .. rst-class:: ansible-option-title **weekDays** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
\Defines for which days this condition will be matched\ Days format - Arrays of WeekDay enums \ Default - List of All week days\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/condition/weekdaysexception: .. rst-class:: ansible-option-title **weekDaysException** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
\Defines for which days this condition will NOT be matched\ Days format - Arrays of WeekDay enums \ Default - Not enabled\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/default: .. rst-class:: ansible-option-title **default** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates if this rule is the default one. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/hitcounts: .. rst-class:: ansible-option-title **hitCounts** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The amount of times the rule was matched. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The identifier of the rule. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Rule name, Valid characters are alphanumerics, underscore, hyphen, space, period, parentheses. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/rank: .. rst-class:: ansible-option-title **rank** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The rank(priority) in relation to other rules. Lower rank is higher priority. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__parameter-rule/state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The state that the rule is in. A disabled rule cannot be matched. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are device\_administration\_authentication\_rules.DeviceAdministrationAuthenticationRules.create\_device\_admin\_authentication\_rule, device\_administration\_authentication\_rules.DeviceAdministrationAuthenticationRules.delete\_device\_admin\_authentication\_rule\_by\_id, device\_administration\_authentication\_rules.DeviceAdministrationAuthenticationRules.update\_device\_admin\_authentication\_rule\_by\_id, - Paths used are post /device-admin/policy-set/{policyId}/authentication, delete /device-admin/policy-set/{policyId}/authentication/{id}, put /device-admin/policy-set/{policyId}/authentication/{id}, - Does not support \ :literal:`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:: `Cisco ISE documentation for Device Administration - Authentication Rules `_ Complete reference of the Device Administration - Authentication Rules API. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 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: 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"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"}}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_authentication_rules_module__return-ise_update_response: .. rst-class:: ansible-option-title **ise_update_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"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"}}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors