.. 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 .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.ise.network_device_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.network_device module -- Resource module for Network Device +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.ise collection `_ (version 2.10.0). To install it, use: :code:`ansible-galaxy collection install cisco.ise`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.ise.network_device`. .. version_added .. rst-class:: ansible-version-added New in cisco.ise 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Network Device. - This API creates a network device. - This API deletes a network device by ID. - This API deletes a network device by name. - This API allows the client to update a network device by ID. - This API allows the client to update a network device by name. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.network_device_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk \>= 2.2.3 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings: .. rst-class:: ansible-option-title **authenticationSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Device's authenticationSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/dtlsrequired: .. rst-class:: ansible-option-title **dtlsRequired** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
This value enforces use of dtls. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/enabled: .. rst-class:: ansible-option-title **enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enabled flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/enablekeywrap: .. rst-class:: ansible-option-title **enableKeyWrap** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableKeyWrap flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/enablemultisecret: .. rst-class:: ansible-option-title **enableMultiSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's enableMultiSecret. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/keyencryptionkey: .. rst-class:: ansible-option-title **keyEncryptionKey** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's keyEncryptionKey. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/keyinputformat: .. rst-class:: ansible-option-title **keyInputFormat** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Allowed values - ASCII, - HEXADECIMAL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/messageauthenticatorcodekey: .. rst-class:: ansible-option-title **messageAuthenticatorCodeKey** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's messageAuthenticatorCodeKey. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/networkprotocol: .. rst-class:: ansible-option-title **networkProtocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Allowed values - RADIUS, - TACACS\_PLUS. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/radiussharedsecret: .. rst-class:: ansible-option-title **radiusSharedSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's radiusSharedSecret. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-authenticationsettings/secondradiussharedsecret: .. rst-class:: ansible-option-title **secondRADIUSSharedSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's secondRADIUSSharedSecret. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-coaport: .. rst-class:: ansible-option-title **coaPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Network Device's coaPort. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-dtlsdnsname: .. rst-class:: ansible-option-title **dtlsDnsName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This value is used to verify the client identity contained in the X.509 RADIUS/DTLS client certificate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_debug: .. rst-class:: ansible-option-title **ise_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_hostname: .. rst-class:: ansible-option-title **ise_hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_password: .. rst-class:: ansible-option-title **ise_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_single_request_timeout: .. rst-class:: ansible-option-title **ise_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
Timeout (in seconds) for RESTful HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_username: .. rst-class:: ansible-option-title **ise_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine username to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_uses_api_gateway: .. rst-class:: ansible-option-title **ise_uses_api_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
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). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_uses_csrf_token: .. rst-class:: ansible-option-title **ise_uses_csrf_token** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_verify: .. rst-class:: ansible-option-title **ise_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_version: .. rst-class:: ansible-option-title **ise_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Identity Services Engine to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1\_Patch\_1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-ise_wait_on_rate_limit: .. rst-class:: ansible-option-title **ise_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-modelname: .. rst-class:: ansible-option-title **modelName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's modelName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-networkdevicegrouplist: .. rst-class:: ansible-option-title **NetworkDeviceGroupList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of Network Device Group names for this node. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-networkdeviceiplist: .. rst-class:: ansible-option-title **NetworkDeviceIPList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of IP Subnets for this node. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-networkdeviceiplist/getipaddressexclude: .. rst-class:: ansible-option-title **getIpaddressExclude** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
It can be either single IP address or IP range address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-networkdeviceiplist/ipaddress: .. rst-class:: ansible-option-title **ipaddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's ipaddress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-networkdeviceiplist/mask: .. rst-class:: ansible-option-title **mask** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Network Device's mask. Can be a string, but will be cast to an integer. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-profilename: .. rst-class:: ansible-option-title **profileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's profileName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-snmpsettings: .. rst-class:: ansible-option-title **snmpsettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Device's snmpsettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-snmpsettings/linktrapquery: .. rst-class:: ansible-option-title **linkTrapQuery** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
LinkTrapQuery flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-snmpsettings/mactrapquery: .. rst-class:: ansible-option-title **macTrapQuery** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
MacTrapQuery flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-snmpsettings/originatingpolicyservicesnode: .. rst-class:: ansible-option-title **originatingPolicyServicesNode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's originatingPolicyServicesNode. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-snmpsettings/pollinginterval: .. rst-class:: ansible-option-title **pollingInterval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Network Device's pollingInterval. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-snmpsettings/rocommunity: .. rst-class:: ansible-option-title **roCommunity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's roCommunity. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-snmpsettings/version: .. rst-class:: ansible-option-title **version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's version. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-softwareversion: .. rst-class:: ansible-option-title **softwareVersion** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's softwareVersion. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-tacacssettings: .. rst-class:: ansible-option-title **tacacsSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Device's tacacsSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-tacacssettings/connectmodeoptions: .. rst-class:: ansible-option-title **connectModeOptions** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Allowed values - OFF, - ON\_LEGACY, - ON\_DRAFT\_COMPLIANT. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-tacacssettings/sharedsecret: .. rst-class:: ansible-option-title **sharedSecret** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's sharedSecret. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings: .. rst-class:: ansible-option-title **trustsecsettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Device's trustsecsettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/deviceauthenticationsettings: .. rst-class:: ansible-option-title **deviceAuthenticationSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Device's deviceAuthenticationSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/deviceauthenticationsettings/sgadeviceid: .. rst-class:: ansible-option-title **sgaDeviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's sgaDeviceId. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/deviceauthenticationsettings/sgadevicepassword: .. rst-class:: ansible-option-title **sgaDevicePassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's sgaDevicePassword. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/deviceconfigurationdeployment: .. rst-class:: ansible-option-title **deviceConfigurationDeployment** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Device's deviceConfigurationDeployment. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/deviceconfigurationdeployment/enablemodepassword: .. rst-class:: ansible-option-title **enableModePassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's enableModePassword. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/deviceconfigurationdeployment/execmodepassword: .. rst-class:: ansible-option-title **execModePassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's execModePassword. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/deviceconfigurationdeployment/execmodeusername: .. rst-class:: ansible-option-title **execModeUsername** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's execModeUsername. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/deviceconfigurationdeployment/includewhendeployingsgtupdates: .. rst-class:: ansible-option-title **includeWhenDeployingSGTUpdates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeWhenDeployingSGTUpdates flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/pushidsupport: .. rst-class:: ansible-option-title **pushIdSupport** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
PushIdSupport flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/sganotificationandupdates: .. rst-class:: ansible-option-title **sgaNotificationAndUpdates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Network Device's sgaNotificationAndUpdates. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/sganotificationandupdates/coasourcehost: .. rst-class:: ansible-option-title **coaSourceHost** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network Device's coaSourceHost. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/sganotificationandupdates/downlaodenvironmentdataeveryxseconds: .. rst-class:: ansible-option-title **downlaodEnvironmentDataEveryXSeconds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Network Device's downlaodEnvironmentDataEveryXSeconds. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/sganotificationandupdates/downlaodpeerauthorizationpolicyeveryxseconds: .. rst-class:: ansible-option-title **downlaodPeerAuthorizationPolicyEveryXSeconds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Network Device's downlaodPeerAuthorizationPolicyEveryXSeconds. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/sganotificationandupdates/downloadsgacllistseveryxseconds: .. rst-class:: ansible-option-title **downloadSGACLListsEveryXSeconds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Network Device's downloadSGACLListsEveryXSeconds. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/sganotificationandupdates/othersgadevicestotrustthisdevice: .. rst-class:: ansible-option-title **otherSGADevicesToTrustThisDevice** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
OtherSGADevicesToTrustThisDevice flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/sganotificationandupdates/reauthenticationeveryxseconds: .. rst-class:: ansible-option-title **reAuthenticationEveryXSeconds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Network Device's reAuthenticationEveryXSeconds. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/sganotificationandupdates/sendconfigurationtodevice: .. rst-class:: ansible-option-title **sendConfigurationToDevice** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
SendConfigurationToDevice flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__parameter-trustsecsettings/sganotificationandupdates/sendconfigurationtodeviceusing: .. rst-class:: ansible-option-title **sendConfigurationToDeviceUsing** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Allowed values - ENABLE\_USING\_COA, - ENABLE\_USING\_CLI, - DISABLE\_ALL. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are network\_device.NetworkDevice.create\_network\_device, network\_device.NetworkDevice.delete\_network\_device\_by\_id, network\_device.NetworkDevice.delete\_network\_device\_by\_name, network\_device.NetworkDevice.update\_network\_device\_by\_id, network\_device.NetworkDevice.update\_network\_device\_by\_name, - Paths used are post /ers/config/networkdevice, delete /ers/config/networkdevice/name/{name}, delete /ers/config/networkdevice/{id}, put /ers/config/networkdevice/name/{name}, put /ers/config/networkdevice/{id}, - Does not support \ :literal:`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 .. 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: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"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", "link": {"href": "string", "rel": "string", "type": "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"}}}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.network_device_module__return-ise_update_response: .. rst-class:: ansible-option-title **ise_update_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors