Try SpotterManage EventSubscription objects of EventManagement
| "added in version" 1.0 of racampos.dnac"
Authors: first last (@GitHubID)
preview | supported by community
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install racampos.dnac:==0.0.1
collections:
- name: racampos.dnac
version: 0.0.1Delete EventSubscriptions.
Gets the list of Subscriptions's based on provided offset and limit.
Subscribe SubscriptionEndpoint to list of registered events.
Update SubscriptionEndpoint to list of registered events.
Returns the Count of EventSubscriptions.
- name: delete_event_subscriptions
cisco.dnac.event_subscription:
state: delete # required
subscriptions: SomeValue # string, required
- name: get_event_subscriptions
cisco.dnac.event_subscription:
state: query # required
event_ids: SomeValue # string
limit: 1 # number
offset: 1 # number
order: SomeValue # string
sort_by: SomeValue # string
register: query_result
- name: create_event_subscriptions
cisco.dnac.event_subscription:
state: create # required
payload: # required
- filter: # required
eventIds:
- SomeValue # string
subscriptionId: SomeValue # string
version: SomeValue # string
name: SomeValue # string
description: SomeValue # string
subscriptionEndpoints:
- instanceId: SomeValue # string
subscriptionDetails:
name: SomeValue # string
url: SomeValue # string
method: SomeValue # string
connectorType: SomeValue # string
- name: update_event_subscriptions
cisco.dnac.event_subscription:
state: update # required
payload: # required
- filter: # required
eventIds:
- SomeValue # string
subscriptionId: SomeValue # string
version: SomeValue # string
name: SomeValue # string
description: SomeValue # string
subscriptionEndpoints:
- instanceId: SomeValue # string
subscriptionDetails:
name: SomeValue # string
url: SomeValue # string
method: SomeValue # string
connectorType: SomeValue # string
- name: count_of_event_subscriptions
cisco.dnac.event_subscription:
state: query # required
event_ids: SomeValue # string, required
count: True # boolean, required
register: query_result
count:
description:
- If true gets the number of objects.
- Required for state query.
type: bool
limit:
description:
- The number of Subscriptions's to limit in the resultset whose default value 10.
type: int
order:
description:
- Order query parameter.
type: str
offset:
description:
- The number of Subscriptions's to offset in the resultset whose default value 0.
type: int
payload:
description:
- An object to send in the Request body.
elements: dict
required: true
suboptions:
description:
description:
- It is the event subscription's description.
type: str
filter:
description:
- It is the event subscription's filter.
required: true
suboptions:
eventIds:
description:
- It is the event subscription's eventIds.
type: list
type: dict
name:
description:
- It is the event subscription's name.
type: str
subscriptionEndpoints:
description:
- It is the event subscription's subscriptionEndpoints.
elements: dict
suboptions:
instanceId:
description:
- It is the event subscription's instanceId.
type: str
subscriptionDetails:
description:
- It is the event subscription's subscriptionDetails.
suboptions:
connectorType:
description:
- It is the event subscription's connectorType.
type: str
method:
description:
- It is the event subscription's method.
type: str
name:
description:
- It is the event subscription's name.
type: str
url:
description:
- It is the event subscription's url.
type: str
type: dict
type: list
subscriptionId:
description:
- It is the event subscription's subscriptionId.
type: str
version:
description:
- It is the event subscription's version.
type: str
type: list
sort_by:
description:
- SortBy field name.
type: str
event_ids:
description:
- List of subscriptions related to the respective eventIds.
- Required for state query.
type: str
subscriptions:
description:
- List of EventSubscriptionId's for removal.
- Required for state delete.
type: str
count_of_event_subscriptions:
contains: null
description: Returns the Count of EventSubscriptions.
response:
description: Response, property of the response body.
returned: always
sample: 0
type: int
returned: always
type: dict
create_event_subscriptions:
contains: null
description: Subscribe SubscriptionEndpoint to list of registered events.
returned: success
statusUri:
description: Status Uri, property of the response body.
returned: success
sample: <statusuri>
type: str
type: dict
delete_event_subscriptions:
contains: null
description: Delete EventSubscriptions.
returned: success
statusUri:
description: Status Uri, property of the response body.
returned: success
sample: <statusuri>
type: str
type: dict
get_event_subscriptions:
contains: null
description: Gets the list of Subscriptions's based on provided offset and limit.
payload:
contains:
description:
description: It is the event subscription's description.
returned: always
sample: <description>
type: str
filter:
contains:
eventIds:
description: It is the event subscription's eventIds.
returned: always
type: list
description: It is the event subscription's filter.
returned: always
type: dict
name:
description: It is the event subscription's name.
returned: always
sample: <name>
type: str
subscriptionEndpoints:
contains:
id:
description: It is the event subscription's id.
returned: always
sample: '478012'
type: str
instanceId:
description: It is the event subscription's instanceId.
returned: always
sample: <instanceid>
type: str
subscriptionDetails:
contains:
connectorType:
description: It is the event subscription's connectorType.
returned: always
sample: <connectortype>
type: str
method:
description: It is the event subscription's method.
returned: always
sample: <method>
type: str
name:
description: It is the event subscription's name.
returned: always
sample: <name>
type: str
url:
description: It is the event subscription's url.
returned: always
sample: <url>
type: str
description: It is the event subscription's subscriptionDetails.
returned: always
type: dict
description: It is the event subscription's subscriptionEndpoints.
returned: always
type: list
version:
description: It is the event subscription's version.
returned: always
sample: '1.0'
type: str
description: It is the event subscription's payload.
returned: always
type: list
returned: always
type: dict
update_event_subscriptions:
contains: null
description: Update SubscriptionEndpoint to list of registered events.
returned: changed
statusUri:
description: Status Uri, property of the response body.
returned: changed
sample: <statusuri>
type: str
type: dict