cisco.ise.network_device – Resource module for Network Device

Note

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

To install it use: ansible-galaxy collection install cisco.ise.

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

New in version 1.0.0: of cisco.ise

Synopsis

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

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk

Parameters

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.

See Also

See also

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

- 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

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:
{}


Authors

  • Rafael Campos (@racampos)