cisco.catalystcenter.sites_device_credentials module -- Resource module for Sites Device Credentials

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.sites_device_credentials.

New in cisco.catalystcenter 6.15.0

Synopsis

• Manage operation update of the resource Sites Device Credentials. - > Updates device credential settings for a site; `null` values indicate that the setting will be inherited from the parent site; empty objects `{}` indicate that the credential is unset, and that no credential of that type will be used for the site.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.6.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
cliCredentialsId dictionary	Sites Device Credentials's cliCredentialsId.
credentialsId string	The `id` of the credentials.
httpReadCredentialsId dictionary	Sites Device Credentials's httpReadCredentialsId.
credentialsId string	The `id` of the credentials.
httpWriteCredentialsId dictionary	Sites Device Credentials's httpWriteCredentialsId.
credentialsId string	The `id` of the credentials.
id string	Id path parameter. Site Id, retrievable from the `id` attribute in `/dna/intent/api/v1/sites`.
snmpv2cReadCredentialsId dictionary	Sites Device Credentials's snmpv2cReadCredentialsId.
credentialsId string	The `id` of the credentials.
snmpv2cWriteCredentialsId dictionary	Sites Device Credentials's snmpv2cWriteCredentialsId.
credentialsId string	The `id` of the credentials.
snmpv3CredentialsId dictionary	Sites Device Credentials's snmpv3CredentialsId.
credentialsId string	The `id` of the credentials.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are network_settings.NetworkSettings.update_device_credential_settings_for_a_site,

• Paths used are put /dna/intent/api/v1/sites/{id}/deviceCredentials,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins,

• but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Network Settings UpdateDeviceCredentialSettingsForASite

Complete reference of the UpdateDeviceCredentialSettingsForASite API.

Examples

---
- name: Update all
  cisco.catalystcenter.sites_device_credentials:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    cliCredentialsId:
      credentialsId: string
    httpReadCredentialsId:
      credentialsId: string
    httpWriteCredentialsId:
      credentialsId: string
    id: string
    snmpv2cReadCredentialsId:
      credentialsId: string
    snmpv2cWriteCredentialsId:
      credentialsId: string
    snmpv3CredentialsId:
      credentialsId: string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"count": 0}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)