cisco.ise.network_device – Resource module for Network Device

Note

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

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	This value enforces use of dtls.
	enabled boolean		Choices: no yes	Enabled flag.
	enableKeyWrap boolean		Choices: no yes	EnableKeyWrap flag.
	enableMultiSecret boolean		Choices: no yes	EnableMultiSecret flag.
	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.
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.

See Also

See also

Network Device reference

Complete reference of the Network Device object model.

Examples

- 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: true
      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: true
      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: true
      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

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: { "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }

Authors

• Rafael Campos (@racampos)