cisco.ise.network_access_authentication_rules – Resource module for Network Access Authentication Rules¶

Note

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

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

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

New in version 1.0.0: of cisco.ise

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

Manage operations create, update and delete of the resource Network Access Authentication Rules.

Note

This module has a corresponding action plugin.

Requirements ¶

The below requirements are needed on the host that executes this module.

ciscoisesdk

Parameters ¶

Parameter				Choices/Defaults	Comments
id string					Id path parameter. Rule id.
identitySourceId string					Identity source id 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.
policyId string					PolicyId path parameter. Policy id.
rule dictionary					Common attributes in rule authentication/authorization.
	condition dictionary				Network Access 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.
		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 Authentication Rules's endDate.
			startDate string		Network Access 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		Network Access Authentication Rules's endDate.
			startDate string		Network Access 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		Network Access Authentication Rules's endTime.
			startTime string		Network Access 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		Network Access Authentication Rules's endTime.
			startTime string		Network Access Authentication Rules's startTime.
		id string			Network Access Authentication 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.

Examples ¶

- name: Create
  cisco.ise.network_access_authentication_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    identitySourceId: string
    ifAuthFail: string
    ifProcessFail: string
    ifUserNotFound: 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

- name: Update by id
  cisco.ise.network_access_authentication_rules:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    id: string
    identitySourceId: string
    ifAuthFail: string
    ifProcessFail: string
    ifUserNotFound: string
    policyId: 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

- name: Delete by id
  cisco.ise.network_access_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: { "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" } } }, "identitySourceId": "string", "ifAuthFail": "string", "ifUserNotFound": "string", "ifProcessFail": "string" }

Authors¶

Rafael Campos (@racampos)

cisco.ise.network_access_authentication_rules – Resource module for Network Access Authentication Rules¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶