.. Document meta :orphan: .. 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 0.0.9). 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 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
authenticationSettings
dictionary
Network Device's authenticationSettings.
dtlsRequired
boolean
    Choices:
  • no
  • yes
DtlsRequired flag.
enableKeyWrap
boolean
    Choices:
  • no
  • yes
EnableKeyWrap flag.
enableMultiSecret
string
Network Device's enableMultiSecret.
keyEncryptionKey
string
Network Device's keyEncryptionKey.
keyInputFormat
string
Network Device's keyInputFormat.
messageAuthenticatorCodeKey
string
Network Device's messageAuthenticatorCodeKey.
networkProtocol
string
Network Device's networkProtocol.
radiusSharedSecret
string
Network Device's radiusSharedSecret.
coaPort
integer
Network Device's coaPort.
description
string
Network Device's description.
dtlsDnsName
string
Network Device's dtlsDnsName.
id
string
Id path parameter.
name
string
Network Device's name.
NetworkDeviceGroupList
list / elements=string
Network Device's NetworkDeviceGroupList.
NetworkDeviceIPList
list / elements=string
Network Device's NetworkDeviceIPList.
ipaddress
string
Network Device's ipaddress.
mask
integer
Network Device's mask.
profileName
string
Network Device's profileName.
snmpsettings
dictionary
Network Device's snmpsettings.
authPassowrd
string
Network Device's authPassowrd.
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.
privacyPassowrd
string
Network Device's privacyPassowrd.
roCommunity
string
Network Device's roCommunity.
version
string
Network Device's version.
tacacsSettings
dictionary
Network Device's tacacsSettings.
connectModeOptions
string
Network Device's connectModeOptions.
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.
includeWhenDeployingSGTUpdates
boolean
    Choices:
  • no
  • yes
IncludeWhenDeployingSGTUpdates flag.
pushIdSupport
string
Network Device's pushIdSupport.
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
Network Device's sendConfigurationToDeviceUsing.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.ise.plugins.module_utils.definitions.network_device ` The official documentation on the **cisco.ise.plugins.module_utils.definitions.network_device** module. `Network Device reference `_ Complete reference of the Network Device object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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: - Location#All Locations - IPSEC#Is IPSEC Device#No - Device Type#All Device Types NetworkDeviceIPList: - ipaddress: 1.2.3.4 mask: 32 authenticationSettings: networkProtocol: RADIUS radiusSharedSecret: C1sco12345 description: '' name: nad tacacsSettings: connectModeOptions: false sharedSecret: C1sco12345 - 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: - Location#All Locations - IPSEC#Is IPSEC Device#No - Device Type#All Device Types NetworkDeviceIPList: - ipaddress: 1.2.3.4 mask: 32 authenticationSettings: networkProtocol: RADIUS radiusSharedSecret: C1sco12345 description: '' id: string name: nad tacacsSettings: connectModeOptions: false sharedSecret: C1sco12345 - 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: 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: - Location#All Locations - IPSEC#Is IPSEC Device#No - Device Type#All Device Types NetworkDeviceIPList: - ipaddress: 1.2.3.4 mask: 32 authenticationSettings: networkProtocol: RADIUS radiusSharedSecret: C1sco12345 description: '' name: nad tacacsSettings: connectModeOptions: false sharedSecret: C1sco12345 - 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 .. 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:
{}


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