cisco.ise.device_administration_time_date_conditions module – Resource module for Device Administration Time Date Conditions

Note

This module is part of the cisco.ise collection (version 2.9.6).

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 ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.ise. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.ise 1.0.0

Synopsis

• Manage operations create, update and delete of the resource Device Administration Time Date Conditions.

• Device Admin - Creates time/date condition.

• Device Admin - Delete Time/Date condition.

• Device Admin - Update network condition.

Note

This module has a corresponding action plugin.

Requirements

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

• ciscoisesdk >= 2.2.3

• python >= 3.5

Parameters

Parameter	Comments
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=dictionary	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	Indicates whereas this condition is in negate mode. Choices: false true
link dictionary	Device Administration Time Date Conditions’s link.
href string	Device Administration Time Date Conditions’s href.
rel string	Device Administration Time Date Conditions’s rel.
type string	Device Administration Time Date 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 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 Time Date Conditions’s endDate.
startDate string	Device Administration Time Date Conditions’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 Time Date Conditions’s endDate.
startDate string	Device Administration Time Date 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 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 Time Date Conditions’s endTime.
startTime string	Device Administration Time Date Conditions’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 Time Date Conditions’s endTime.
startTime string	Device Administration Time Date Conditions’s startTime.
id string	Device Administration Time Date Conditions’s id.
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: false ← (default) true
ise_hostname string / required	The Identity Services Engine hostname.
ise_password string / required	The Identity Services Engine password to authenticate.
ise_single_request_timeout integer added in cisco.ise 3.0.0	Timeout (in seconds) for RESTful HTTP requests. Default: 60
ise_username string / required	The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in cisco.ise 1.1.0	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). Choices: false true ← (default)
ise_uses_csrf_token boolean added in cisco.ise 3.0.0	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. Choices: false ← (default) true
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: false true ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: "3.1_Patch_1"
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: false true ← (default)
isNegate boolean	Indicates whereas this condition is in negate mode. Choices: false true
link dictionary	Device Administration Time Date Conditions’s link.
href string	Device Administration Time Date Conditions’s href.
rel string	Device Administration Time Date Conditions’s rel.
type string	Device Administration Time Date 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>.

Notes

Note

• SDK Method used are device_administration_time_date_conditions.DeviceAdministrationTimeDateConditions.create_device_admin_time_condition, device_administration_time_date_conditions.DeviceAdministrationTimeDateConditions.delete_device_admin_time_condition_by_id, device_administration_time_date_conditions.DeviceAdministrationTimeDateConditions.update_device_admin_time_condition_by_id,

• Paths used are post /device-admin/time-condition, delete /device-admin/time-condition/{id}, put /device-admin/time-condition/{id},

• 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

See Also

See also

Cisco ISE documentation for Device Administration - Time/Date Conditions

Complete reference of the Device Administration - Time/Date Conditions API.

Examples

- name: Create
  cisco.ise.device_administration_time_date_conditions:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    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

- name: Update by id
  cisco.ise.device_administration_time_date_conditions:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
ise_response dictionary	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: {}
ise_update_response dictionary added in cisco.ise 1.1.0	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: {"response": {}, "version": "string"}

Authors

• Rafael Campos (@racampos)

Collection links

• Issue Tracker
• Repository (Sources)