cisco.catalystcenter.event_subscription_syslog_v1 module -- Resource module for Event Subscription Syslog V1

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

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operations create and update of the resource Event Subscription Syslog V1.

  • Create Syslog Subscription Endpoint for list of registered events.

  • Update Syslog Subscription Endpoint for list of registered events.

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:

_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:

_version

string

Informs the SDK which version of Cisco CATALYST Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

payload

list / elements=dictionary

Event Subscription Syslog's payload.

description

string

Description.

filter

dictionary

Event Subscription Syslog's filter.

categories

list / elements=string

Categories.

domainsSubdomains

list / elements=dictionary

Event Subscription Syslog's domainsSubdomains.

domain

string

Domain.

subDomains

list / elements=string

Sub Domains.

eventIds

list / elements=string

Event Ids (Comma separated event ids).

severities

list / elements=string

Severities.

siteIds

list / elements=string

Site Ids.

sources

list / elements=string

Sources.

types

list / elements=string

Types.

name

string

Name.

subscriptionEndpoints

list / elements=dictionary

Event Subscription Syslog's subscriptionEndpoints.

instanceId

string

(From Get Syslog Subscription Details --> pick instanceId).

subscriptionDetails

dictionary

Event Subscription Syslog's subscriptionDetails.

connectorType

string

Connector Type (Must be SYSLOG).

subscriptionId

string

Subscription Id (Unique UUID).

version

string

Version.

validate_response_schema

boolean

Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are event_management.EventManagement.create_syslog_event_subscription_v1, event_management.EventManagement.update_syslog_event_subscription_v1,

  • Paths used are post /dna/intent/api/v1/event/subscription/syslog, put /dna/intent/api/v1/event/subscription/syslog,

  • 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 CreateSyslogEventSubscriptionV1

Complete reference of the CreateSyslogEventSubscriptionV1 API.

Cisco DNA Center documentation for Event Management UpdateSyslogEventSubscriptionV1

Complete reference of the UpdateSyslogEventSubscriptionV1 API.

Examples

- name: Update all
  cisco.catalystcenter.event_subscription_syslog_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - description: string
        filter:
          categories:
            - string
          domainsSubdomains:
            - domain: string
              subDomains:
                - string
          eventIds:
            - string
          severities:
            - string
          siteIds:
            - string
          sources:
            - string
          types:
            - string
        name: string
        subscriptionEndpoints:
          - instanceId: string
            subscriptionDetails:
              connectorType: string
        subscriptionId: string
        version: string
- name: Create
  cisco.catalystcenter.event_subscription_syslog_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - description: string
        filter:
          categories:
            - string
          domainsSubdomains:
            - domain: string
              subDomains:
                - string
          eventIds:
            - string
          severities:
            - string
          siteIds:
            - string
          sources:
            - string
          types:
            - string
        name: string
        subscriptionEndpoints:
          - instanceId: string
            subscriptionDetails:
              connectorType: string
        subscriptionId: string
        version: 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:`{"statusUri": "string"}`

Authors

  • Rafael Campos (@racampos)