cisco.ise.device_administration_network_conditions module – Resource module for Device Administration Network Conditions
Note
This module is part of the cisco.ise collection (version 2.6.2).
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_network_conditions.
New in cisco.ise 1.0.0
Synopsis
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 action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.1.1
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
<p>This field should contain a Caller ID (CLI), comma, and Called ID (DNIS).<br> Line format - Caller ID (CLI), Called ID (DNIS)</p>. |
|
This field determines the content of the conditions field. |
|
Device Administration Network Conditions’s description. |
|
<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>. |
|
<p>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</p>. |
|
Device Administration Network Conditions’s id. |
|
<p>This field should contain IP address or subnet.<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</p>. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: |
|
The Identity Services Engine username to authenticate. |
|
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:
|
|
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:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
Device Administration Network Conditions’s link. |
|
Device Administration Network Conditions’s href. |
|
Device Administration Network Conditions’s rel. |
|
Device Administration Network Conditions’s type. |
|
<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>. |
|
Network Condition name. |
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
check_modeThe 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 - Network Conditions
Complete reference of the Device Administration - Network Conditions API.
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
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |