.. 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.global_credential_v2_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.global_credential_v2 module -- Resource module for Global Credential V2 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.7.6). 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.global_credential_v2`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.7.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Global Credential V2. - API to create new global credentials. Multiple credentials of various types can be passed at once. Please refer sample Request Body for more information. - Delete a global credential. Only 'id' of the credential has to be passed. - API to update device credentials. Multiple credentials can be passed at once, but only a single credential of a given type can be passed at once. Please refer sample Request Body for more information. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.global_credential_v2_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.5.5 - 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.dnac.global_credential_v2_module__parameter-clicredential: .. rst-class:: ansible-option-title **cliCredential** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Global Credential V2's cliCredential. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-clicredential/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-clicredential/enablepassword: .. rst-class:: ansible-option-title **enablePassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Enable Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-clicredential/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-clicredential/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-clicredential/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Username. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_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.global_credential_v2_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.global_credential_v2_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.global_credential_v2_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. 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.global_credential_v2_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.global_credential_v2_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.global_credential_v2_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.global_credential_v2_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.3.5.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpsread: .. rst-class:: ansible-option-title **httpsRead** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Global Credential V2's httpsRead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpsread/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpsread/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpsread/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpsread/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpsread/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Username. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpswrite: .. rst-class:: ansible-option-title **httpsWrite** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Global Credential V2's httpsWrite. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpswrite/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpswrite/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpswrite/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpswrite/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-httpswrite/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Username. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_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
Id path parameter. Global Credential id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv2cread: .. rst-class:: ansible-option-title **snmpV2cRead** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Global Credential V2's snmpV2cRead. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv2cread/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv2cread/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv2cread/readcommunity: .. rst-class:: ansible-option-title **readCommunity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Read Community. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv2cwrite: .. rst-class:: ansible-option-title **snmpV2cWrite** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Global Credential V2's snmpV2cWrite. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv2cwrite/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv2cwrite/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv2cwrite/writecommunity: .. rst-class:: ansible-option-title **writeCommunity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Write Community. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv3: .. rst-class:: ansible-option-title **snmpV3** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Global Credential V2's snmpV3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv3/authpassword: .. rst-class:: ansible-option-title **authPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Auth Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv3/authtype: .. rst-class:: ansible-option-title **authType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Auth Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv3/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv3/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv3/privacypassword: .. rst-class:: ansible-option-title **privacyPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Privacy Password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv3/privacytype: .. rst-class:: ansible-option-title **privacyType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Privacy Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv3/snmpmode: .. rst-class:: ansible-option-title **snmpMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Snmp Mode. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_module__parameter-snmpv3/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Username. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.global_credential_v2_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, - 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, - 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. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update all cisco.dnac.global_credential_v2: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" state: present cliCredential: description: string enablePassword: string id: string password: string username: string httpsRead: id: string name: string password: string port: 0 username: string httpsWrite: id: string name: string password: string port: 0 username: string snmpV2cRead: description: string id: string readCommunity: string snmpV2cWrite: description: string id: string writeCommunity: string snmpV3: authPassword: string authType: string description: string id: string privacyPassword: string privacyType: string snmpMode: string username: string - name: Create cisco.dnac.global_credential_v2: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" state: present cliCredential: - description: string enablePassword: string password: string username: string httpsRead: - name: string password: string port: 0 username: string httpsWrite: - name: string password: string port: 0 username: string snmpV2cRead: - description: string readCommunity: string snmpV2cWrite: - description: string writeCommunity: string snmpV3: - authPassword: string authType: string description: string privacyPassword: string privacyType: string snmpMode: string username: string - name: Delete by id cisco.dnac.global_credential_v2: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" state: absent id: 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.global_credential_v2_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_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 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
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors