.. 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_device_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.network_device -- Resource module for Network Device ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. 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_device`. .. 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 Device. .. 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
authenticationSettings
dictionary
Network Device's authenticationSettings.
dtlsRequired
boolean
    Choices:
  • no
  • yes
This value enforces use of dtls.
enabled
boolean
    Choices:
  • no
  • yes
Enabled flag.
enableKeyWrap
boolean
    Choices:
  • no
  • yes
EnableKeyWrap flag.
enableMultiSecret
string
Network Device's enableMultiSecret.
keyEncryptionKey
string
Network Device's keyEncryptionKey.
keyInputFormat
string
Allowed values - ASCII, - HEXADECIMAL.
messageAuthenticatorCodeKey
string
Network Device's messageAuthenticatorCodeKey.
networkProtocol
string
Allowed values - RADIUS, - TACACS_PLUS.
radiusSharedSecret
string
Network Device's radiusSharedSecret.
secondRadiusSharedSecret
string
Network Device's secondRadiusSharedSecret.
coaPort
integer
Network Device's coaPort.
description
string
Network Device's description.
dtlsDnsName
string
This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate.
id
string
Network Device'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.
modelName
string
Network Device's modelName.
name
string
Network Device's name.
NetworkDeviceGroupList
list / elements=string
List of Network Device Group names for this node.
NetworkDeviceIPList
list / elements=string
List of IP Subnets for this node.
getIpaddressExclude
string
It can be either single IP address or IP range address.
ipaddress
string
Network Device's ipaddress.
mask
integer
Network Device's mask.
profileName
string
Network Device's profileName.
snmpsettings
dictionary
Network Device's snmpsettings.
linkTrapQuery
boolean
    Choices:
  • no
  • yes
LinkTrapQuery flag.
macTrapQuery
boolean
    Choices:
  • no
  • yes
MacTrapQuery flag.
originatingPolicyServicesNode
string
Network Device's originatingPolicyServicesNode.
pollingInterval
integer
Network Device's pollingInterval.
roCommunity
string
Network Device's roCommunity.
version
string
Network Device's version.
softwareVersion
string
Network Device's softwareVersion.
tacacsSettings
dictionary
Network Device's tacacsSettings.
connectModeOptions
string
Allowed values - OFF, - ON_LEGACY, - ON_DRAFT_COMPLIANT.
sharedSecret
string
Network Device's sharedSecret.
trustsecsettings
dictionary
Network Device's trustsecsettings.
deviceAuthenticationSettings
dictionary
Network Device's deviceAuthenticationSettings.
sgaDeviceId
string
Network Device's sgaDeviceId.
sgaDevicePassword
string
Network Device's sgaDevicePassword.
deviceConfigurationDeployment
dictionary
Network Device's deviceConfigurationDeployment.
enableModePassword
string
Network Device's enableModePassword.
execModePassword
string
Network Device's execModePassword.
execModeUsername
string
Network Device's execModeUsername.
includeWhenDeployingSGTUpdates
boolean
    Choices:
  • no
  • yes
IncludeWhenDeployingSGTUpdates flag.
pushIdSupport
boolean
    Choices:
  • no
  • yes
PushIdSupport flag.
sgaNotificationAndUpdates
dictionary
Network Device's sgaNotificationAndUpdates.
coaSourceHost
string
Network Device's coaSourceHost.
downlaodEnvironmentDataEveryXSeconds
integer
Network Device's downlaodEnvironmentDataEveryXSeconds.
downlaodPeerAuthorizationPolicyEveryXSeconds
integer
Network Device's downlaodPeerAuthorizationPolicyEveryXSeconds.
downloadSGACLListsEveryXSeconds
integer
Network Device's downloadSGACLListsEveryXSeconds.
otherSGADevicesToTrustThisDevice
boolean
    Choices:
  • no
  • yes
OtherSGADevicesToTrustThisDevice flag.
reAuthenticationEveryXSeconds
integer
Network Device's reAuthenticationEveryXSeconds.
sendConfigurationToDevice
boolean
    Choices:
  • no
  • yes
SendConfigurationToDevice flag.
sendConfigurationToDeviceUsing
string
Allowed values - ENABLE_USING_COA, - ENABLE_USING_CLI, - DISABLE_ALL.

.. 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 Device reference `_ Complete reference of the Network Device object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update by name cisco.ise.network_device: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present NetworkDeviceGroupList: - string NetworkDeviceIPList: - getIpaddressExclude: string ipaddress: string mask: 0 authenticationSettings: dtlsRequired: true enableKeyWrap: true enableMultiSecret: string enabled: true keyEncryptionKey: string keyInputFormat: string messageAuthenticatorCodeKey: string networkProtocol: string radiusSharedSecret: string secondRadiusSharedSecret: string coaPort: 0 description: string dtlsDnsName: string id: string modelName: string name: string profileName: string snmpsettings: linkTrapQuery: true macTrapQuery: true originatingPolicyServicesNode: string pollingInterval: 0 roCommunity: string version: string softwareVersion: string tacacsSettings: connectModeOptions: string sharedSecret: string trustsecsettings: deviceAuthenticationSettings: sgaDeviceId: string sgaDevicePassword: string deviceConfigurationDeployment: enableModePassword: string execModePassword: string execModeUsername: string includeWhenDeployingSGTUpdates: true pushIdSupport: true sgaNotificationAndUpdates: coaSourceHost: string downlaodEnvironmentDataEveryXSeconds: 0 downlaodPeerAuthorizationPolicyEveryXSeconds: 0 downloadSGACLListsEveryXSeconds: 0 otherSGADevicesToTrustThisDevice: true reAuthenticationEveryXSeconds: 0 sendConfigurationToDevice: true sendConfigurationToDeviceUsing: string - name: Delete by name cisco.ise.network_device: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: absent name: string - name: Update by id cisco.ise.network_device: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present NetworkDeviceGroupList: - string NetworkDeviceIPList: - getIpaddressExclude: string ipaddress: string mask: 0 authenticationSettings: dtlsRequired: true enableKeyWrap: true enableMultiSecret: string enabled: true keyEncryptionKey: string keyInputFormat: string messageAuthenticatorCodeKey: string networkProtocol: string radiusSharedSecret: string secondRadiusSharedSecret: string coaPort: 0 description: string dtlsDnsName: string id: string modelName: string name: string profileName: string snmpsettings: linkTrapQuery: true macTrapQuery: true originatingPolicyServicesNode: string pollingInterval: 0 roCommunity: string version: string softwareVersion: string tacacsSettings: connectModeOptions: string sharedSecret: string trustsecsettings: deviceAuthenticationSettings: sgaDeviceId: string sgaDevicePassword: string deviceConfigurationDeployment: enableModePassword: string execModePassword: string execModeUsername: string includeWhenDeployingSGTUpdates: true pushIdSupport: true sgaNotificationAndUpdates: coaSourceHost: string downlaodEnvironmentDataEveryXSeconds: 0 downlaodPeerAuthorizationPolicyEveryXSeconds: 0 downloadSGACLListsEveryXSeconds: 0 otherSGADevicesToTrustThisDevice: true reAuthenticationEveryXSeconds: 0 sendConfigurationToDevice: true sendConfigurationToDeviceUsing: string - name: Delete by id cisco.ise.network_device: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: absent id: string - name: Create cisco.ise.network_device: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present NetworkDeviceGroupList: - string NetworkDeviceIPList: - getIpaddressExclude: string ipaddress: string mask: 0 authenticationSettings: dtlsRequired: true enableKeyWrap: true enableMultiSecret: string enabled: true keyEncryptionKey: string keyInputFormat: string messageAuthenticatorCodeKey: string networkProtocol: string radiusSharedSecret: string secondRadiusSharedSecret: string coaPort: 0 description: string dtlsDnsName: string modelName: string name: string profileName: string snmpsettings: linkTrapQuery: true macTrapQuery: true originatingPolicyServicesNode: string pollingInterval: 0 roCommunity: string version: string softwareVersion: string tacacsSettings: connectModeOptions: string sharedSecret: string trustsecsettings: deviceAuthenticationSettings: sgaDeviceId: string sgaDevicePassword: string deviceConfigurationDeployment: enableModePassword: string execModePassword: string execModeUsername: string includeWhenDeployingSGTUpdates: true pushIdSupport: true sgaNotificationAndUpdates: coaSourceHost: string downlaodEnvironmentDataEveryXSeconds: 0 downlaodPeerAuthorizationPolicyEveryXSeconds: 0 downloadSGACLListsEveryXSeconds: 0 otherSGADevicesToTrustThisDevice: true reAuthenticationEveryXSeconds: 0 sendConfigurationToDevice: true sendConfigurationToDeviceUsing: 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:
{ "id": "string", "name": "string", "description": "string", "authenticationSettings": { "networkProtocol": "string", "secondRadiusSharedSecret": "string", "radiusSharedSecret": "string", "enableKeyWrap": true, "enabled": true, "dtlsRequired": true, "enableMultiSecret": "string", "keyEncryptionKey": "string", "messageAuthenticatorCodeKey": "string", "keyInputFormat": "string" }, "snmpsettings": { "version": "string", "roCommunity": "string", "pollingInterval": 0, "linkTrapQuery": true, "macTrapQuery": true, "originatingPolicyServicesNode": "string" }, "trustsecsettings": { "deviceAuthenticationSettings": { "sgaDeviceId": "string", "sgaDevicePassword": "string" }, "sgaNotificationAndUpdates": { "downlaodEnvironmentDataEveryXSeconds": 0, "downlaodPeerAuthorizationPolicyEveryXSeconds": 0, "reAuthenticationEveryXSeconds": 0, "downloadSGACLListsEveryXSeconds": 0, "otherSGADevicesToTrustThisDevice": true, "sendConfigurationToDevice": true, "sendConfigurationToDeviceUsing": "string", "coaSourceHost": "string" }, "deviceConfigurationDeployment": { "includeWhenDeployingSGTUpdates": true, "enableModePassword": "string", "execModePassword": "string", "execModeUsername": "string" }, "pushIdSupport": true }, "tacacsSettings": { "sharedSecret": "string", "connectModeOptions": "string" }, "profileName": "string", "coaPort": 0, "dtlsDnsName": "string", "modelName": "string", "softwareVersion": "string", "NetworkDeviceIPList": [ { "ipaddress": "string", "mask": 0, "getIpaddressExclude": "string" } ], "NetworkDeviceGroupList": [ "string" ], "link": { "rel": "string", "href": "string", "type": "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:
{ "UpdatedFieldsList": { "updatedField": [ { "field": "string", "oldValue": "string", "newValue": "string" } ], "field": "string", "oldValue": "string", "newValue": "string" } }


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