.. 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_network_conditions_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.device_administration_network_conditions module -- Resource module for Device Administration Network Conditions +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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_network_conditions`. .. 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 Network Conditions. - Device Admin- Creates network condition. - Device Admin - Delete network condition. - Device Admin - Update network condition. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.device_administration_network_conditions_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_network_conditions_module__parameter-clidnislist: .. rst-class:: ansible-option-title **cliDnisList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
\This field should contain a Caller ID (CLI), comma, and Called ID (DNIS).\ Line format - Caller ID (CLI), Called ID (DNIS)\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_module__parameter-conditiontype: .. rst-class:: ansible-option-title **conditionType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This field determines the content of the conditions field. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device Administration Network Conditions's description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_module__parameter-devicegrouplist: .. rst-class:: ansible-option-title **deviceGroupList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
\This field should contain a tuple with NDG Root, comma, and an NDG (that it under the root).\ Line format - NDG Root Name, NDG, Port\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_module__parameter-devicelist: .. rst-class:: ansible-option-title **deviceList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
\This field should contain Device Name. The device name must be the same as the name field in a Network Device object. Line format - Device Name\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_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
Device Administration Network Conditions's id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_module__parameter-ipaddrlist: .. rst-class:: ansible-option-title **ipAddrList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
\This field should contain IP address or subnet.\ IP address can be IPV4 format (n.n.n.n) or IPV6 format (n n n n n n n n).\ IP subnet can be IPV4 format (n.n.n.n/m) or IPV6 format (n n n n n n n n/m).\ Line format - IP Address or subnet\. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_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_network_conditions_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_network_conditions_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_network_conditions_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_network_conditions_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_network_conditions_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_network_conditions_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_network_conditions_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_network_conditions_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_network_conditions_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_network_conditions_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 Network Conditions's link. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_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 Network Conditions's href. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_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 Network Conditions's rel. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_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 Network Conditions's type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_module__parameter-macaddrlist: .. rst-class:: ansible-option-title **macAddrList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
\This field should contain Endstation MAC address, comma, and Destination MAC addresses.\ Each Max address must include twelve hexadecimal digits using formats nn nn nn nn nn nn or nn-nn-nn-nn-nn-nn or nnnn.nnnn.nnnn or nnnnnnnnnnnn.\ Line format - Endstation MAC,Destination MAC \. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Condition name. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are device\_administration\_network\_conditions.DeviceAdministrationNetworkConditions.create\_device\_admin\_network\_condition, device\_administration\_network\_conditions.DeviceAdministrationNetworkConditions.delete\_device\_admin\_network\_condition\_by\_id, device\_administration\_network\_conditions.DeviceAdministrationNetworkConditions.update\_device\_admin\_network\_condition\_by\_id, - Paths used are post /device-admin/network-condition, delete /device-admin/network-condition/{id}, put /device-admin/network-condition/{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 - Network Conditions `_ Complete reference of the Device Administration - Network Conditions API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.ise.device_administration_network_conditions: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present cliDnisList: - string conditionType: string description: string deviceGroupList: - string deviceList: - string id: string ipAddrList: - string link: href: string rel: string type: string macAddrList: - string name: string - name: Update by id cisco.ise.device_administration_network_conditions: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present cliDnisList: - string conditionType: string description: string deviceGroupList: - string deviceList: - string id: string ipAddrList: - string link: href: string rel: string type: string macAddrList: - string name: string - name: Delete by id cisco.ise.device_administration_network_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: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_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:`{"cliDnisList": ["string"], "conditionType": "string", "description": "string", "deviceGroupList": ["string"], "deviceList": ["string"], "id": "string", "ipAddrList": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "macAddrList": ["string"], "name": "string"}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.device_administration_network_conditions_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": {"cliDnisList": ["string"], "conditionType": "string", "description": "string", "deviceGroupList": ["string"], "deviceList": ["string"], "id": "string", "ipAddrList": ["string"], "link": {"href": "string", "rel": "string", "type": "string"}, "macAddrList": ["string"], "name": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors