Repository URL to install this package:
|
Version:
6.0.0 ▾
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: event_subscription_details_rest_info
short_description: Information module for Event Subscription Details Rest
description:
- Get all Event Subscription Details Rest.
- Gets the list of subscription details for specified connectorType.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
connectorType:
description:
- ConnectorType query parameter. Connector Type REST.
type: str
name:
description:
- Name query parameter. Name of the specific configuration.
type: str
instanceId:
description:
- InstanceId query parameter. Instance Id of the specific configuration.
type: str
requirements:
- dnacentersdk >= 2.4.9
- python >= 3.5
notes:
- SDK Method used are
event_management.EventManagement.get_rest_webhook_subscription_details,
- Paths used are
get /dna/intent/api/v1/event/subscription-details/rest,
"""
EXAMPLES = r"""
- name: Get all Event Subscription Details Rest
cisco.dnac.event_subscription_details_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:
custom: value
connectorType: string
name: string
instanceId: string
register: result
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: list
elements: dict
sample: >
[
{
"instanceId": "string",
"name": "string",
"description": "string",
"connectorType": "string",
"url": "string",
"method": "string",
"trustCert": "string",
"headers": [
{
"name": "string",
"value": "string"
}
],
"queryParams": [
"string"
],
"pathParams": [
"string"
]
}
]
"""