cisco.catalystcenter.event_snmp_config module -- Resource module for Event Snmp Config

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

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

To use it in a playbook, specify: cisco.catalystcenter.event_snmp_config.

New in cisco.catalystcenter 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.

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
authPassword string	Auth Password.
community string	Required only if snmpVersion is V2C.
configId string	Config Id.
description string	Description.
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 CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`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 CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST 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.catalystcenter.event_snmp_config:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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.catalystcenter.event_snmp_config:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"apiStatus": "string", "errorMessage": {"errors": [{}]}, "statusMessage": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)