.. 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.dnac.device_credential_intent_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.device_credential_intent module -- Resource module for Global Device Credentials and Assigning Credentials to sites. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.15.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. 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.dnac.device_credential_intent`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.7.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations on Global Device Credentials and Assigning Credentials to sites. - API to create global device credentials. - API to update global device credentials. - API to delete global device credentials. - API to assign the device credential to the site. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.device_credential_intent_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.1 - python \>= 3.9 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html

- .. raw:: html

List of details of global device credentials and site names. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site: .. rst-class:: ansible-option-title **assign_credentials_to_site** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Assign Device Credentials to Site. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/cli_credential: .. rst-class:: ansible-option-title **cli_credential** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

CLI Credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/cli_credential/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

CLI Credential Description. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/cli_credential/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

CLI Credential Id. Use (Description, Username) or Id. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/cli_credential/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

CLI Credential Username. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/https_read: .. rst-class:: ansible-option-title **https_read** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

HTTP(S) Read Credential .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/https_read/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

HTTP(S) Read Credential Description. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/https_read/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

HTTP(S) Read Credential Id. Use (Description, Username) or Id. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/https_read/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

HTTP(S) Read Credential Username. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/https_write: .. rst-class:: ansible-option-title **https_write** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

HTTP(S) Write Credential .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/https_write/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

HTTP(S) Write Credential Description. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/https_write/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

HTTP(S) Write Credential Id. Use (Description, Username) or Id. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/https_write/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

HTTP(S) Write Credential Username. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/site_name: .. rst-class:: ansible-option-title **site_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html

- .. raw:: html

Site Name to assign credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/snmp_v2c_read: .. rst-class:: ansible-option-title **snmp_v2c_read** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

SNMPv2c Read Credential .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/snmp_v2c_read/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

SNMPv2c Read Credential Description. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/snmp_v2c_read/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

SNMPv2c Read Credential Id. Use Description or Id. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/snmp_v2c_write: .. rst-class:: ansible-option-title **snmp_v2c_write** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

SNMPv2c Write Credential .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/snmp_v2c_write/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

SNMPv2c Write Credential Description. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/snmp_v2c_write/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

SNMPv2c Write Credential Id. Use Description or Id. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/snmp_v3: .. rst-class:: ansible-option-title **snmp_v3** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

snmp\_v3 Credential .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/snmp_v3/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

snmp\_v3 Credential Description. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/assign_credentials_to_site/snmp_v3/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

snmp\_v3 Credential Id. Use Description or Id. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details: .. rst-class:: ansible-option-title **global_credential_details** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

Manages global device credentials .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/cli_credential: .. rst-class:: ansible-option-title **cli_credential** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Global Credential V2's cliCredential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/cli_credential/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Description. Required for creating the credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/cli_credential/enable_password: .. rst-class:: ansible-option-title **enable_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

cli\_credential credential Enable Password. Password cannot contain spaces or angle brackets (\< \>) .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/cli_credential/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Credential Id. Use this for updating the device credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/cli_credential/old_description: .. rst-class:: ansible-option-title **old_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Old Description. Use this for updating the description/Username. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/cli_credential/old_username: .. rst-class:: ansible-option-title **old_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Old Username. Use this for updating the description/Username. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/cli_credential/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

cli\_credential credential Password. Required for creating/updating the credential. Password cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/cli_credential/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

cli\_credential credential Username. Username cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_read: .. rst-class:: ansible-option-title **https_read** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Global Credential V2's httpsRead. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_read/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Credential Id. Use this for updating the device credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_read/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Name. Required for creating the credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_read/old_description: .. rst-class:: ansible-option-title **old_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Old Description. Use this for updating the description/Username. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_read/old_username: .. rst-class:: ansible-option-title **old_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Old Username. Use this for updating the description/Username. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_read/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

https\_read credential Password. Required for creating/updating the credential. Password cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_read/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Port. Default port is 443. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_read/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

https\_read credential Username. Username cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_write: .. rst-class:: ansible-option-title **https_write** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Global Credential V2's httpsWrite. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_write/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Credential Id. Use this for updating the device credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_write/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Name. Required for creating the credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_write/old_description: .. rst-class:: ansible-option-title **old_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Old Description. Use this for updating the description/Username. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_write/old_username: .. rst-class:: ansible-option-title **old_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Old Username. Use this for updating the description/Username. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_write/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

https\_write credential Password. Required for creating/updating the credential. Password cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_write/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Port. Default port is 443. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/https_write/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

https\_write credential Username. Username cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_read: .. rst-class:: ansible-option-title **snmp_v2c_read** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Global Credential V2's snmpV2cRead. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_read/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Description. Required for creating the credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_read/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Credential Id. Use this for updating the device credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_read/old_description: .. rst-class:: ansible-option-title **old_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Old Description. Use this for updating the description. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_read/read_community: .. rst-class:: ansible-option-title **read_community** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

snmp\_v2c\_read Read Community. Password cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_write: .. rst-class:: ansible-option-title **snmp_v2c_write** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Global Credential V2's snmpV2cWrite. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_write/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Description. Required for creating the credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_write/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Credential Id. Use this for updating the device credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_write/old_description: .. rst-class:: ansible-option-title **old_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Old Description. Use this for updating the description. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v2c_write/write_community: .. rst-class:: ansible-option-title **write_community** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

snmp\_v2c\_write Write Community. Password cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3: .. rst-class:: ansible-option-title **snmp_v3** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html

- .. raw:: html

Global Credential V2's snmpV3. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3/auth_password: .. rst-class:: ansible-option-title **auth_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

snmp\_v3 Auth Password. Password must contain minimum 8 characters. Password cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3/auth_type: .. rst-class:: ansible-option-title **auth_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Auth Type. ["SHA", "MD5"]. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

snmp\_v3 Description. Should be unique from other snmp\_v3 credentials. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Credential Id. Use this for updating the device credential. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3/old_description: .. rst-class:: ansible-option-title **old_description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Old Description. Use this for updating the description. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3/privacy_password: .. rst-class:: ansible-option-title **privacy_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

snmp\_v3 Privacy Password. Password must contain minimum 8 characters. Password cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3/privacy_type: .. rst-class:: ansible-option-title **privacy_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Privacy Type. ["AES128", "AES192", "AES256"]. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3/snmp_mode: .. rst-class:: ansible-option-title **snmp_mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Snmp Mode. ["AUTHPRIV", "AUTHNOPRIV", "NOAUTHNOPRIV"]. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config/global_credential_details/snmp_v3/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

snmp\_v3 credential Username. Username cannot contain spaces or angle brackets (\< \>). .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-config_verify: .. rst-class:: ansible-option-title **config_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Set to True to verify the Cisco DNA Center after applying the playbook config. .. 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.dnac.device_credential_intent_module__parameter-dnac_api_task_timeout: .. rst-class:: ansible-option-title **dnac_api_task_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Defines the timeout in seconds for API calls to retrieve task details. If the task details are not received within this period, the process will end, and a timeout notification will be logged. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`1200` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Flag for Cisco DNA Center 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.dnac.device_credential_intent_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html

- .. raw:: html

The Cisco DNA Center hostname. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-dnac_log: .. rst-class:: ansible-option-title **dnac_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Flag to enable/disable playbook execution logging. When true and dnac\_log\_file\_path is provided, - Create the log file at the execution location with the specified name. When true and dnac\_log\_file\_path is not provided, - Create the log file at the execution location with the name 'dnac.log'. When false, - Logging is disabled. If the log file doesn't exist, - It is created in append or write mode based on the "dnac\_log\_append" flag. If the log file exists, - It is overwritten or appended based on the "dnac\_log\_append" flag. .. 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.dnac.device_credential_intent_module__parameter-dnac_log_append: .. rst-class:: ansible-option-title **dnac_log_append** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. .. 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.dnac.device_credential_intent_module__parameter-dnac_log_file_path: .. rst-class:: ansible-option-title **dnac_log_file_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Governs logging. Logs are recorded if dnac\_log is True. If path is not specified, - When 'dnac\_log\_append' is True, 'dnac.log' is generated in the current Ansible directory; logs are appended. - When 'dnac\_log\_append' is False, 'dnac.log' is generated; logs are overwritten. If path is specified, - When 'dnac\_log\_append' is True, the file opens in append mode. - When 'dnac\_log\_append' is False, the file opens in write (w) mode. - In shared file scenarios, without append mode, content is overwritten after each module execution. - For a shared log file, set append to False for the 1st module (to overwrite); for subsequent modules, set append to True. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"dnac.log"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-dnac_log_level: .. rst-class:: ansible-option-title **dnac_log_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Sets the threshold for log level. Messages with a level equal to or higher than this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL indicates serious errors halting the program. Displays only CRITICAL messages. ERROR indicates problems preventing a function. Displays ERROR and CRITICAL messages. WARNING indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages. INFO tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages. DEBUG provides detailed diagnostic info. Displays all log messages. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"WARNING"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The Cisco DNA Center password to authenticate. .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"443"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-dnac_task_poll_interval: .. rst-class:: ansible-option-title **dnac_task_poll_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html

- .. raw:: html

Specifies the interval in seconds between successive calls to the API to retrieve task details. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_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.dnac.device_credential_intent_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html

- .. raw:: html

The state of Cisco DNA Center after module completion. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"deleted"` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html

- .. raw:: html

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. 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

.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are discovery.Discovery.create\_global\_credentials\_v2, discovery.Discovery.delete\_global\_credential\_v2, discovery.Discovery.update\_global\_credentials\_v2, network\_settings.NetworkSettings.assign\_device\_credential\_to\_site\_v2, - Paths used are post /dna/intent/api/v2/global-credential, delete /dna/intent/api/v2/global-credential/{id}, put /dna/intent/api/v2/global-credential, post /dna/intent/api/v2/credential-to-site/{siteId}, - 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 DNAC SDK - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Discovery CreateGlobalCredentialsV2 `_ Complete reference of the CreateGlobalCredentialsV2 API. `Cisco DNA Center documentation for Discovery DeleteGlobalCredentialV2 `_ Complete reference of the DeleteGlobalCredentialV2 API. `Cisco DNA Center documentation for Discovery UpdateGlobalCredentialsV2 `_ Complete reference of the UpdateGlobalCredentialsV2 API. `Cisco DNA Center documentation for Network Settings AssignDeviceCredentialToSiteV2 `_ Complete reference of the AssignDeviceCredentialToSiteV2 API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create Credentials and assign it to a site. cisco.dnac.device_credential_intent: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_debug: "{{ dnac_debug }}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - global_credential_details: cli_credential: - description: string username: string password: string enable_password: string snmp_v2c_read: - description: string read_community: string snmp_v2c_write: - description: string write_community: string snmp_v3: - auth_password: string auth_type: SHA snmp_mode: AUTHPRIV privacy_password: string privacy_type: AES128 username: string description: string https_read: - description: string username: string password: string port: 443 https_write: - description: string username: string password: string port: 443 assign_credentials_to_site: cli_credential: id: string snmp_v2c_read: id: string snmp_v2c_write: id: string snmp_v3: id: string https_read: id: string https_write: id: string site_name: - string - name: Create Multiple Credentials. cisco.dnac.device_credential_intent: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_debug: "{{ dnac_debug }}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - global_credential_details: cli_credential: - description: string username: string password: string enable_password: string - description: string username: string password: string enable_password: string snmp_v2c_read: - description: string read_community: string - description: string read_community: string snmp_v2c_write: - description: string write_community: string - description: string write_community: string snmp_v3: - auth_password: string auth_type: SHA snmp_mode: AUTHPRIV privacy_password: string privacy_type: AES128 username: string description: string - auth_password: string auth_type: SHA snmp_mode: AUTHPRIV privacy_password: string privacy_type: AES128 username: string description: string https_read: - description: string username: string password: string port: 443 - description: string username: string password: string port: 443 https_write: - description: string username: string password: string port: 443 - description: string username: string password: string port: 443 - name: Update global device credentials using id cisco.dnac.device_credential_intent: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_debug: "{{ dnac_debug }}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - global_credential_details: cli_credential: - description: string username: string password: string enable_password: string id: string snmp_v2c_read: - description: string read_community: string id: string snmp_v2c_write: - description: string write_community: string id: string snmp_v3: - auth_password: string auth_type: SHA snmp_mode: AUTHPRIV privacy_password: string privacy_type: AES128 username: string description: string id: string https_read: - description: string username: string password: string port: 443 id: string https_write: - description: string username: string password: string port: 443 id: string - name: Update multiple global device credentials using id cisco.dnac.device_credential_intent: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_debug: "{{ dnac_debug }}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - global_credential_details: cli_credential: - description: string username: string password: string enable_password: string id: string - description: string username: string password: string enable_password: string id: string snmp_v2c_read: - description: string read_community: string id: string - description: string read_community: string id: string snmp_v2c_write: - description: string write_community: string id: string - description: string write_community: string id: string snmp_v3: - auth_password: string auth_type: SHA snmp_mode: AUTHPRIV privacy_password: string privacy_type: AES128 username: string description: string id: string - auth_password: string auth_type: SHA snmp_mode: AUTHPRIV privacy_password: string privacy_type: AES128 username: string description: string id: string https_read: - description: string username: string password: string port: 443 id: string - description: string username: string password: string port: 443 id: string https_write: - description: string username: string password: string port: 443 id: string - description: string username: string password: string port: 443 id: string - name: Update global device credential name/description using old name and description. cisco.dnac.device_credential_intent: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_debug: "{{ dnac_debug }}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - global_credential_details: cli_credential: - description: string username: string password: string enable_password: string old_description: string old_username: string snmp_v2c_read: - description: string read_community: string old_description: string snmp_v2c_write: - description: string write_community: string old_description: string snmp_v3: - auth_password: string auth_type: string snmp_mode: string privacy_password: string privacy_type: string username: string description: string https_read: - description: string username: string password: string port: string old_description: string old_username: string https_write: - description: string username: string password: string port: string old_description: string old_username: string - name: Assign Credentials to sites using old description and username. cisco.dnac.device_credential_intent: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_debug: "{{ dnac_debug }}" dnac_log: True dnac_log_level: "{{ dnac_log_level }}" state: merged config_verify: True config: - assign_credentials_to_site: cli_credential: description: string username: string snmp_v2c_read: description: string snmp_v2c_write: description: string snmp_v3: description: string https_read: description: string username: string https_write: description: string username: string site_name: - string - 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.dnac.device_credential_intent_module__return-dnac_response1: .. rst-class:: ansible-option-title **dnac_response1** .. 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 DNAC 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:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html

* - .. raw:: html

.. _ansible_collections.cisco.dnac.device_credential_intent_module__return-dnac_response2: .. rst-class:: ansible-option-title **dnac_response2** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html

- .. raw:: html

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Muthu Rakesh (@MUTHU-RAKESH-27) Madhan Sankaranarayanan (@madhansansel) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html

Issue Tracker Repository (Sources)

.. Parsing errors