cisco.dnac.global_credential_snmpv2_write_community – Manage GlobalCredentialSnmpv2WriteCommunity objects of Discovery

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Adds global SNMP write community.

• Updates global SNMP write community.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk

Parameters

Parameter		Choices/Defaults	Comments
comments string			SNMPv2WriteCommunityDTO's comments.
credentialType string			SNMPv2WriteCommunityDTO's credentialType. Available values are 'GLOBAL' and 'APP'.
description string			SNMPv2WriteCommunityDTO's description.
id string			SNMPv2WriteCommunityDTO's id.
instanceTenantId string			SNMPv2WriteCommunityDTO's instanceTenantId.
instanceUuid string			SNMPv2WriteCommunityDTO's instanceUuid.
payload list / elements=dictionary			An object to send in the Request body. Required for state create.
	comments string		It is the global credential snmpv2 write community's comments.
	credentialType string		It is the global credential snmpv2 write community's credentialType.
	description string		It is the global credential snmpv2 write community's description.
	id string		It is the global credential snmpv2 write community's id.
	instanceTenantId string		It is the global credential snmpv2 write community's instanceTenantId.
	instanceUuid string		It is the global credential snmpv2 write community's instanceUuid.
	writeCommunity string / required		It is the global credential snmpv2 write community's writeCommunity.
writeCommunity string			SNMPv2WriteCommunityDTO's writeCommunity. Required for state update.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.global_credential_snmpv2_write_community

The official documentation on the cisco.dnac.plugins.module_utils.definitions.global_credential_snmpv2_write_community module.

GlobalCredentialSnmpv2WriteCommunity reference

Complete reference of the GlobalCredentialSnmpv2WriteCommunity object model.

GlobalCredentialSnmpv2WriteCommunity reference

SDK reference.

Examples

- name: create_snmp_write_community
  cisco.dnac.global_credential_snmpv2_write_community:
    state: create  # required
    payload:  # required
    - writeCommunity: SomeValue  # string, required
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string

- name: update_snmp_write_community
  cisco.dnac.global_credential_snmpv2_write_community:
    state: update  # required
    writeCommunity: SomeValue  # string, required
    comments: SomeValue  # string
    credentialType: # valid values are 'GLOBAL',
      # 'APP'.
      SomeValue  # string
    description: SomeValue  # string
    id: SomeValue  # string
    instanceTenantId: SomeValue  # string
    instanceUuid: SomeValue  # 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 with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: discovery.create_snmp_write_community

Authors

• Rafael Campos (@racampos)