cisco.catalystcenter.event_subscription_details_email_v1_info module -- Information module for Event Subscription Details Email 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_details_email_v1_info.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Get all Event Subscription Details Email V1.

  • Gets the list of subscription details for specified connectorType.

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"`

headers

dictionary

Additional headers.

instanceId

string

InstanceId query parameter. Instance Id of the specific configuration.

limit

float

Limit query parameter. The number of Email Subscription detail's to limit in the resultset whose default value 10.

name

string

Name query parameter. Name of the specific configuration.

offset

float

Offset query parameter. The number of Email Subscription detail's to offset in the resultset whose default value 0.

order

string

Order query parameter.

sortBy

string

SortBy query parameter. SortBy field name.

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.get_email_subscription_details_v1,

  • Paths used are get /dna/intent/api/v1/event/subscription-details/email,

  • Supports 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 GetEmailSubscriptionDetailsV1

Complete reference of the GetEmailSubscriptionDetailsV1 API.

Examples

- name: Get all Event Subscription Details Email V1
  cisco.catalystcenter.event_subscription_details_email_v1_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    headers: "{{my_headers | from_json}}"
    name: string
    instanceId: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

Return Values

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

Key

Description

catalystcenter_response

list / elements=dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"instanceId\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"connectorType\\": \\"string\\",\\n \\"fromEmailAddress\\": \\"string\\",\\n \\"toEmailAddresses\\": [\\n \\"string\\"\\n ],\\n \\"subject\\": \\"string\\"\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)