W3cubDocs

/Ansible

cisco.dnac.snmpv3_credential_v1 module – Resource module for Snmpv3 Credential V1

Note

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

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

New in cisco.dnac 3.1.0

Synopsis

  • Manage operations create and update of the resource Snmpv3 Credential V1.
  • Adds global SNMPv3 credentials.
  • Updates global SNMPv3 credential.

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

authPassword

string

Auth password for SNMPv3. Required if snmpMode is ‘AUTHPRIV’ or ‘AUTHNOPRIV’. Use ‘NO!$DATA!$’ if no change required.

authType

string

SNMPv3 auth protocol. ‘SHA’ or ‘MD5’. Required if snmpMode is ‘AUTHPRIV’ or ‘AUTHNOPRIV’.

comments

string

Comments to identify the SNMPv3 credential.

credentialType

string

Credential type to identify the application that uses the SNMPv3 credential.

description

string

Description for SNMPv3 Credential.

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"

id

string

Id of the SNMPv3 Credential.

instanceTenantId

string

Deprecated. This attribute will be removed in a future release, should not be used, and any value supplied will be ignored.

instanceUuid

string

Deprecated. This attribute will be removed in a future release, should not be used, and any value supplied will be ignored.

privacyPassword

string

Privacy password for SNMPv3 privacy. Required if snmpMode is ‘AUTHPRIV’. Use ‘NO!$DATA!$’ if no change required.

privacyType

string

SNMPv3 privacy protocol. Required is snmpMode is ‘AUTHPRIV’.

snmpMode

string

Mode of SNMPv3. ‘AUTHPRIV’ or ‘AUTHNOPRIV’ or ‘NOAUTHNOPRIV’.

username

string

SNMPv3 username.

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 discovery.Discovery.create_snmpv3_credentials_v1, discovery.Discovery.update_snmpv3_credentials_v1,
  • Paths used are post /dna/intent/api/v1/global-credential/snmpv3, put /dna/intent/api/v1/global-credential/snmpv3,
  • 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 Discovery CreateSNMPv3CredentialsV1

Complete reference of the CreateSNMPv3CredentialsV1 API.

Cisco DNA Center documentation for Discovery UpdateSNMPv3CredentialsV1

Complete reference of the UpdateSNMPv3CredentialsV1 API.

Examples

- name: Update all
  cisco.dnac.snmpv3_credential_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
    authPassword: string
    authType: string
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    privacyPassword: string
    privacyType: string
    snmpMode: string
    username: string
- name: Create
  cisco.dnac.snmpv3_credential_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
    authPassword: string
    authType: string
    comments: string
    credentialType: string
    description: string
    id: string
    instanceTenantId: string
    instanceUuid: string
    privacyPassword: string
    privacyType: string
    snmpMode: string
    username: 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)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/snmpv3_credential_v1_module.html