.. Document meta

:orphan:

.. Anchors

.. _ansible_collections.cisco.dnac.device_credential_module:

.. Anchors: short name for ansible.builtin

.. Anchors: aliases



.. Title

cisco.dnac.device_credential -- Manage DeviceCredential objects of NetworkSettings
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 2.0.7).

    To install it use: :code:`ansible-galaxy collection install cisco.dnac`.

    To use it in a playbook, specify: :code:`cisco.dnac.device_credential`.

.. version_added

.. versionadded:: 1.0.0 of cisco.dnac

.. contents::
   :local:
   :depth: 1

.. Deprecated


Synopsis
--------

.. Description

- API to get device credential details.
- API to create device credentials.
- API to update device credentials.
- Delete device credential.

.. note::
    This module has a corresponding :ref:`action plugin <action_plugins>`.

.. Aliases


.. Requirements

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

- dnacentersdk


.. Options

Parameters
----------

.. raw:: html

    <table  border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="2">Parameter</th>
            <th>Choices/<font color="blue">Defaults</font></th>
                        <th width="100%">Comments</th>
        </tr>
                    <tr>
                                                                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-id"></div>
                    <b>id</b>
                    <a class="ansibleOptionLink" href="#parameter-id" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Global credential id.</div>
                                            <div>Required for state delete.</div>
                                                        </td>
            </tr>
                                <tr>
                                                                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-settings"></div>
                    <b>settings</b>
                    <a class="ansibleOptionLink" href="#parameter-settings" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">dictionary</span>
                                                 / <span style="color: red">required</span>                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Settings, property of the request body.</div>
                                                        </td>
            </tr>
                                        <tr>
                                                    <td class="elbow-placeholder"></td>
                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-settings/cliCredential"></div>
                    <b>cliCredential</b>
                    <a class="ansibleOptionLink" href="#parameter-settings/cliCredential" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">raw</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>It is the device credential&#x27;s cliCredential.</div>
                                            <div>Type list for state create.</div>
                                            <div>Type dict for state update.</div>
                                                        </td>
            </tr>
                                <tr>
                                                    <td class="elbow-placeholder"></td>
                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-settings/httpsRead"></div>
                    <b>httpsRead</b>
                    <a class="ansibleOptionLink" href="#parameter-settings/httpsRead" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">raw</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>It is the device credential&#x27;s httpsRead.</div>
                                            <div>Type list for state create.</div>
                                            <div>Type dict for state update.</div>
                                                        </td>
            </tr>
                                <tr>
                                                    <td class="elbow-placeholder"></td>
                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-settings/httpsWrite"></div>
                    <b>httpsWrite</b>
                    <a class="ansibleOptionLink" href="#parameter-settings/httpsWrite" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">raw</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>It is the device credential&#x27;s httpsWrite.</div>
                                            <div>Type list for state create.</div>
                                            <div>Type dict for state update.</div>
                                                        </td>
            </tr>
                                <tr>
                                                    <td class="elbow-placeholder"></td>
                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-settings/snmpV2cRead"></div>
                    <b>snmpV2cRead</b>
                    <a class="ansibleOptionLink" href="#parameter-settings/snmpV2cRead" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">raw</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>It is the device credential&#x27;s snmpV2cRead.</div>
                                            <div>Type list for state create.</div>
                                            <div>Type dict for state update.</div>
                                                        </td>
            </tr>
                                <tr>
                                                    <td class="elbow-placeholder"></td>
                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-settings/snmpV2cWrite"></div>
                    <b>snmpV2cWrite</b>
                    <a class="ansibleOptionLink" href="#parameter-settings/snmpV2cWrite" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">raw</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>It is the device credential&#x27;s snmpV2cWrite.</div>
                                            <div>Type list for state create.</div>
                                            <div>Type dict for state update.</div>
                                                        </td>
            </tr>
                                <tr>
                                                    <td class="elbow-placeholder"></td>
                                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="parameter-settings/snmpV3"></div>
                    <b>snmpV3</b>
                    <a class="ansibleOptionLink" href="#parameter-settings/snmpV3" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">raw</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>It is the device credential&#x27;s snmpV3.</div>
                                            <div>Type list for state create.</div>
                                            <div>Type dict for state update.</div>
                                                        </td>
            </tr>
                    
                                <tr>
                                                                <td colspan="2">
                    <div class="ansibleOptionAnchor" id="parameter-site_id"></div>
                    <b>site_id</b>
                    <a class="ansibleOptionLink" href="#parameter-site_id" title="Permalink to this option"></a>
                    <div style="font-size: small">
                        <span style="color: purple">string</span>
                                                                    </div>
                                                        </td>
                                <td>
                                                                                                                                                            </td>
                                                                <td>
                                            <div>Site id to retrieve the credential details associated with the site.</div>
                                                        </td>
            </tr>
                        </table>
    <br/>

.. Notes


.. Seealso

See Also
--------

.. seealso::

   :ref:`cisco.dnac.plugins.module_utils.definitions.device_credential <ansible_collections.cisco.dnac.plugins.module_utils.definitions.device_credential_module>`
      The official documentation on the **cisco.dnac.plugins.module_utils.definitions.device_credential** module.
   `DeviceCredential reference <https://developer.cisco.com/docs/dna-center/api/1-3-3-x>`_
       Complete reference of the DeviceCredential object model.
   `DeviceCredential reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v2-1-1-summary>`_
       SDK reference.

.. Examples

Examples
--------

.. code-block:: yaml+jinja

    
    - name: get_device_credential_details
      cisco.dnac.device_credential:
        state: query  # required
        site_id: SomeValue  # string
      register: nm_get_device_credential_details

    - name: create_device_credentials
      cisco.dnac.device_credential:
        state: create  # required
        settings:  # required
          cliCredential:
          - description: SomeValue  # string, required
            username: SomeValue  # string, required
            password: SomeValue  # string, required
            enablePassword: SomeValue  # string
          snmpV2cRead:
          - readCommunity: SomeValue  # string, required
            description: SomeValue  # string
          snmpV2cWrite:
          - writeCommunity: SomeValue  # string, required
            description: SomeValue  # string
          snmpV3:
          - description: SomeValue  # string, required
            username: SomeValue  # string, required
            privacyType: SomeValue  # string, required
            privacyPassword: SomeValue  # string, required
            authType: SomeValue  # string, required
            snmpMode: SomeValue  # string, required
            authPassword: SomeValue  # string
          httpsRead:
          - username: SomeValue  # string, required
            password: SomeValue  # string, required
            name: SomeValue  # string
            port: 1  #  number
          httpsWrite:
          - username: SomeValue  # string, required
            password: SomeValue  # string, required
            name: SomeValue  # string
            port: 1  #  number

    - name: update_device_credentials
      cisco.dnac.device_credential:
        state: update  # required
        settings:  # required
          cliCredential:
            description: SomeValue  # string
            username: SomeValue  # string
            password: SomeValue  # string
            enablePassword: SomeValue  # string
            id: SomeValue  # string
          snmpV2cRead:
            description: SomeValue  # string
            readCommunity: SomeValue  # string
            id: SomeValue  # string
          snmpV2cWrite:
            description: SomeValue  # string
            writeCommunity: SomeValue  # string
            id: SomeValue  # string
          snmpV3:
            authPassword: SomeValue  # string
            authType: SomeValue  # string
            snmpMode: SomeValue  # string
            privacyPassword: SomeValue  # string
            privacyType: SomeValue  # string
            username: SomeValue  # string
            description: SomeValue  # string
            id: SomeValue  # string
          httpsRead:
            name: SomeValue  # string
            username: SomeValue  # string
            password: SomeValue  # string
            port: SomeValue  # string
            id: SomeValue  # string
          httpsWrite:
            name: SomeValue  # string
            username: SomeValue  # string
            password: SomeValue  # string
            port: SomeValue  # string
            id: SomeValue  # string

    - name: delete_device_credential
      cisco.dnac.device_credential:
        state: delete  # required
        id: SomeValue  # string, required





.. Facts


.. Return values

Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. raw:: html

    <table border=0 cellpadding=0 class="documentation-table">
        <tr>
            <th colspan="1">Key</th>
            <th>Returned</th>
            <th width="100%">Description</th>
        </tr>
                    <tr>
                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-dnac_response"></div>
                    <b>dnac_response</b>
                    <a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">dictionary</span>
                                          </div>
                                    </td>
                <td>always</td>
                <td>
                                            <div>A dictionary with the response returned by the DNA Center Python SDK</div>
                                        <br/>
                                            <div style="font-size: smaller"><b>Sample:</b></div>
                                                <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{&#x27;response&#x27;: 29, &#x27;version&#x27;: &#x27;1.0&#x27;}</div>
                                    </td>
            </tr>
                                <tr>
                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-missing_params"></div>
                    <b>missing_params</b>
                    <a class="ansibleOptionLink" href="#return-missing_params" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">list</span>
                       / <span style="color: purple">elements=string</span>                    </div>
                                    </td>
                <td>when the function request schema is not satisfied</td>
                <td>
                                            <div>Provided arguments do not comply with the schema of the DNA Center Python SDK function</div>
                                        <br/>
                                    </td>
            </tr>
                                <tr>
                                <td colspan="1">
                    <div class="ansibleOptionAnchor" id="return-sdk_function"></div>
                    <b>sdk_function</b>
                    <a class="ansibleOptionLink" href="#return-sdk_function" title="Permalink to this return value"></a>
                    <div style="font-size: small">
                      <span style="color: purple">string</span>
                                          </div>
                                    </td>
                <td>always</td>
                <td>
                                            <div>The DNA Center SDK function used to execute the task</div>
                                        <br/>
                                            <div style="font-size: smaller"><b>Sample:</b></div>
                                                <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">network_settings.create_device_credentials</div>
                                    </td>
            </tr>
                        </table>
    <br/><br/>

..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Rafael Campos (@racampos)



.. Parsing errors