.. 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_network_condition_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.network_access_network_condition -- Resource module for Network Access Network Condition ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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_network_condition`. .. 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 Network Condition. .. 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
conditions
list / elements=string
Network Access Network Condition's conditions.
cliDnisList
list / elements=string
<p>This field should contain a Caller ID (CLI), comma, and Called ID (DNIS).<br> Line format - Caller ID (CLI), Called ID (DNIS)</p>.
conditionType
string
This field determines the content of the conditions field.
description
string
Network Access Network Condition's description.
deviceGroupList
list / elements=string
<p>This field should contain a tuple with NDG Root, comma, and an NDG (that it under the root).<br> Line format - NDG Root Name, NDG, Port</p>.
deviceList
list / elements=string
<p>This field should contain Device-Name,port-number. The device name must be the same as the name field in a Network Device object.<br> Line format - Device Name,Port</p>.
id
string
Network Access Network Condition's id.
ipAddrList
list / elements=string
<p>This field should contain IP-address-or-subnet,port number<br> IP address can be IPV4 format (n.n.n.n) or IPV6 format (n n n n n n n n).<br> IP subnet can be IPV4 format (n.n.n.n/m) or IPV6 format (n n n n n n n n/m).<br> Line format - IP Address or subnet,Port</p>.
link
dictionary
Network Access Network Condition's link.
href
string
Network Access Network Condition's href.
rel
string
Network Access Network Condition's rel.
type
string
Network Access Network Condition's type.
macAddrList
list / elements=string
<p>This field should contain Endstation MAC address, comma, and Destination MAC addresses.<br> 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.<br> Line format - Endstation MAC,Destination MAC </p>.
name
string
Network Condition name.
conditionType
string
This field determines the content of the conditions field.
description
string
Network Access Network Condition's description.
id
string
Network Access Network Condition'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.
link
dictionary
Network Access Network Condition's link.
href
string
Network Access Network Condition's href.
rel
string
Network Access Network Condition's rel.
type
string
Network Access Network Condition's type.
name
string
Network Condition name.

.. 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 Network Condition reference `_ Complete reference of the Network Access Network Condition object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.ise.network_access_network_condition: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present conditionType: string conditions: - 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 description: string id: string link: href: string rel: string type: string name: string - name: Update by id cisco.ise.network_access_network_condition: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present conditionType: string conditions: - 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 description: string id: string link: href: string rel: string type: string name: string - name: Delete by id cisco.ise.network_access_network_condition: 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", "description": "string", "id": "string", "link": { "href": "string", "rel": "string", "type": "string" }, "name": "string", "conditions": [ { "cliDnisList": [ "string" ], "conditionType": "string", "description": "string", "id": "string", "ipAddrList": [ "string" ], "link": { "href": "string", "rel": "string", "type": "string" }, "macAddrList": [ "string" ], "name": "string", "deviceGroupList": [ "string" ], "deviceList": [ "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", "description": "string", "id": "string", "link": { "href": "string", "rel": "string", "type": "string" }, "name": "string", "conditions": [ { "cliDnisList": [ "string" ], "conditionType": "string", "description": "string", "id": "string", "ipAddrList": [ "string" ], "link": { "href": "string", "rel": "string", "type": "string" }, "macAddrList": [ "string" ], "name": "string", "deviceGroupList": [ "string" ], "deviceList": [ "string" ] } ] }, "version": "string" }


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