/ home / cisco / cisco.dnac / 6.13.3 / module / event_subscription_rest_info

cisco.dnac.event_subscription_rest_info (6.13.3) — module

Information module for Event Subscription Rest

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Event Subscription Rest.

Gets the list of Rest/Webhook Subscriptions's based on provided query params.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Event Subscription Rest
  cisco.dnac.event_subscription_rest_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    eventIds: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
    domain: string
    subDomain: string
    category: string
    type: string
    name: string
  register: result

Inputs

name:
description:
- Name query parameter. List of subscriptions related to the respective name.
type: str

type:
description:
- Type query parameter. List of subscriptions related to the respective type.
type: str

limit:
description:
- Limit query parameter. The number of Subscriptions's to limit in the resultset whose
default value 10.
type: int

order:
description:
- Order query parameter.
type: str

domain:
description:
- Domain query parameter. List of subscriptions related to the respective domain.
type: str

offset:
description:
- Offset query parameter. The number of Subscriptions's to offset in the resultset
whose default value 0.
type: int

sortBy:
description:
- SortBy query parameter. SortBy field name.
type: str

headers:
description: Additional headers.
type: dict

category:
description:
- Category query parameter. List of subscriptions related to the respective category.
type: str

eventIds:
description:
- EventIds query parameter. List of subscriptions related to the respective eventIds
(Comma separated event ids).
type: str

dnac_host:
description:
- The Cisco DNA Center hostname.
required: true
type: str

dnac_port:
default: 443
description:
- The Cisco DNA Center port.
type: int

subDomain:
description:
- SubDomain query parameter. List of subscriptions related to the respective sub-domain.
type: str

dnac_debug:
default: false
description:
- Flag for Cisco DNA Center SDK to enable debugging.
type: bool

dnac_verify:
default: true
description:
- Flag to enable or disable SSL certificate verification.
type: bool

dnac_version:
default: 2.3.5.3
description:
- Informs the SDK which version of Cisco DNA Center to use.
type: str

dnac_password:
description:
- The Cisco DNA Center password to authenticate.
type: str

dnac_username:
aliases:
- user
default: admin
description:
- The Cisco DNA Center username to authenticate.
type: str

validate_response_schema:
default: true
description:
- Flag for Cisco DNA Center SDK to enable the validation of request bodies against
a JSON schema.
type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  elements: dict
  returned: always
  sample: "[\n  {\n    \"version\": \"string\",\n    \"subscriptionId\": \"string\"\
    ,\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"subscriptionEndpoints\"\
    : [\n      {\n        \"instanceId\": \"string\",\n        \"subscriptionDetails\"\
    : {\n          \"connectorType\": \"string\",\n          \"instanceId\": \"string\"\
    ,\n          \"name\": \"string\",\n          \"description\": \"string\",\n \
    \         \"url\": \"string\",\n          \"basePath\": \"string\",\n        \
    \  \"resource\": \"string\",\n          \"method\": \"string\",\n          \"\
    trustCert\": \"string\",\n          \"headers\": [\n            {\n          \
    \    \"string\": \"string\"\n            }\n          ],\n          \"queryParams\"\
    : [\n            {\n              \"string\": \"string\"\n            }\n    \
    \      ],\n          \"pathParams\": [\n            {\n              \"string\"\
    : \"string\"\n            }\n          ],\n          \"body\": \"string\",\n \
    \         \"connectTimeout\": \"string\",\n          \"readTimeout\": \"string\"\
    \n        },\n        \"connectorType\": \"string\"\n      }\n    ],\n    \"filter\"\
    : {\n      \"eventIds\": [\n        \"string\"\n      ],\n      \"others\": [\n\
    \        \"string\"\n      ],\n      \"domainsSubdomains\": [\n        {\n   \
    \       \"domain\": \"string\",\n          \"subDomains\": [\n            \"string\"\
    \n          ]\n        }\n      ],\n      \"types\": [\n        \"string\"\n \
    \     ],\n      \"categories\": [\n        \"string\"\n      ],\n      \"severities\"\
    : [\n        \"string\"\n      ],\n      \"sources\": [\n        \"string\"\n\
    \      ],\n      \"siteIds\": [\n        \"string\"\n      ]\n    },\n    \"isPrivate\"\
    : \"string\",\n    \"tenantId\": \"string\"\n  }\n]\n"
  type: list