cisco.dnac.snmpv2_write_community_credential – Resource module for Snmpv2 Write Community Credential

Note

This plugin is part of the cisco.dnac collection (version 4.0.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.

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Manage operations create and update of the resource Snmpv2 Write Community 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.0

• python >= 3.5

Parameters

Parameter		Choices/Defaults	Comments
comments string			Comments to identify the credential.
credentialType string			Credential type to identify the application that uses the credential.
description string			Name/Description of the credential.
dnac_debug boolean		Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required			The Cisco DNA Center hostname.
dnac_password string			The Cisco DNA Center password to authenticate.
dnac_port string		Default: 443	The Cisco DNA Center port.
dnac_username string		Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean		Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string		Default: "2.2.3.3"	Informs the SDK which version of Cisco DNA Center to use.
instanceUuid string			Snmpv2 Write Community Credential's instanceUuid.
payload list / elements=string			Snmpv2 Write Community Credential's payload.
	comments string		Comments to identify the credential.
	credentialType string		Credential type to identify the application that uses the credential.
	description string		Name/Description of the credential.
	writeCommunity string		SNMP write community.
validate_response_schema boolean		Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
writeCommunity string			SNMP write community. NO!$DATA!$ for no value change.

Notes

Note

• 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

Snmpv2 Write Community Credential reference

Complete reference of the Snmpv2 Write Community Credential object model.

Examples

- name: Create
  cisco.dnac.snmpv2_write_community_credential:
    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

- name: Update all
  cisco.dnac.snmpv2_write_community_credential:
    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
    comments: string
    credentialType: string
    description: string
    instanceUuid: string
    writeCommunity: string

Return Values

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

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "response": { "taskId": "string", "url": "string" }, "version": "string" }

Authors

• Rafael Campos (@racampos)