cisco.dnac.sites_device_credentials_v1 module – Resource module for Sites Device Credentials V1

Note

This module is part of the cisco.dnac collection (version 6.25.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

To use it in a playbook, specify: cisco.dnac.sites_device_credentials_v1.

New in cisco.dnac 6.15.0

Synopsis

  • Manage operation update of the resource Sites Device Credentials V1.

  • 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.

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

cliCredentialsId

dictionary

Sites Device Credentials’s cliCredentialsId.

credentialsId

string

The `id` of the credentials.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

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

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are network_settings.NetworkSettings.update_device_credential_settings_for_a_site_v1,

  • 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 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

See Also

See also

Cisco DNA Center documentation for Network Settings UpdateDeviceCredentialSettingsForASiteV1

Complete reference of the UpdateDeviceCredentialSettingsForASiteV1 API.

Examples

- name: Update all
  cisco.dnac.sites_device_credentials_v1:
    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
    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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)