cisco.dnac.event_snmp_config module – Resource module for Event Snmp Config

Note

This module is part of the cisco.dnac collection (version 6.27.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.event_snmp_config.

New in cisco.dnac 3.1.0

Synopsis

  • This module represents an alias of the module event_snmp_config_v1

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.

community

string

Required only if snmpVersion is V2C.

configId

string

Config Id.

description

string

Description.

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"

ipAddress

string

Ip Address.

name

string

Name.

port

string

Port.

privacyPassword

string

Privacy Password.

snmpAuthType

string

Snmp Auth Type.

snmpMode

string

If snmpVersion is V3 it is required and cannot be NONE.

snmpPrivacyType

string

Snmp Privacy Type.

snmpVersion

string

Snmp Version.

userName

string

Required only if snmpVersion is V3.

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 event_management.EventManagement.create_snmp_destination_v1, event_management.EventManagement.update_snmp_destination_v1,

  • Paths used are post /dna/intent/api/v1/event/snmp-config, put /dna/intent/api/v1/event/snmp-config,

  • It should be noted that this module is an alias of event_snmp_config_v1

  • 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 Event Management CreateSNMPDestinationV1

Complete reference of the CreateSNMPDestinationV1 API.

Cisco DNA Center documentation for Event Management UpdateSNMPDestinationV1

Complete reference of the UpdateSNMPDestinationV1 API.

Examples

- name: Create
  cisco.dnac.event_snmp_config:
    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
    community: string
    description: string
    ipAddress: string
    name: string
    port: string
    privacyPassword: string
    snmpAuthType: string
    snmpMode: string
    snmpPrivacyType: string
    snmpVersion: string
    userName: string

- name: Update all
  cisco.dnac.event_snmp_config:
    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
    community: string
    configId: string
    description: string
    ipAddress: string
    name: string
    port: string
    privacyPassword: string
    snmpAuthType: string
    snmpMode: string
    snmpPrivacyType: string
    snmpVersion: 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: {"apiStatus": "string", "errorMessage": {"errors": [{}]}, "statusMessage": "string"}

Authors

  • Rafael Campos (@racampos)