cisco.ise.device_administration_network_conditions – Resource module for Device Administration Network Conditions

Note

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

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.

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

New in version 1.0.0: of cisco.ise

Synopsis

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

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.1.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
conditions
list / elements=string
Device Administration Network Conditions'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>.
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>.
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>.
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>.
conditionType
string
This field determines the content of the conditions field.
description
string
Device Administration Network Conditions's description.
id
string
Device Administration Network Conditions'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
Device Administration Network Conditions's link.
href
string
Device Administration Network Conditions's href.
rel
string
Device Administration Network Conditions's rel.
type
string
Device Administration Network Conditions's type.
name
string
Network Condition name.

Notes

Note

  • Does not support check_mode

See Also

See also

Device Administration Network Conditions reference

Complete reference of the Device Administration Network Conditions object model.

Examples

- 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
    conditionType: string
    conditions:
    - cliDnisList:
      - string
      deviceGroupList:
      - string
      deviceList:
      - string
      ipAddrList:
      - string
      macAddrList:
      - string
    description: string
    id: string
    link:
      href: string
      rel: string
      type: 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
    conditionType: string
    conditions:
    - cliDnisList:
      - string
      deviceGroupList:
      - string
      deviceList:
      - string
      ipAddrList:
      - string
      macAddrList:
      - string
    description: string
    id: string
    link:
      href: string
      rel: string
      type: 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

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:
{ "conditionType": "string", "description": "string", "id": "string", "link": { "href": "string", "rel": "string", "type": "string" }, "name": "string", "conditions": [ { "cliDnisList": [ "string" ], "ipAddrList": [ "string" ], "macAddrList": [ "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" ], "ipAddrList": [ "string" ], "macAddrList": [ "string" ], "deviceGroupList": [ "string" ], "deviceList": [ "string" ] } ] }, "version": "string" }


Authors

  • Rafael Campos (@racampos)