/ home / cisco / cisco.dnac / 2.0.7 / module / event_subscription

cisco.dnac.event_subscription (2.0.7) — module

Manage EventSubscription objects of EventManagement

| "added in version" 1.0.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:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

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

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: delete_event_subscriptions
  cisco.dnac.event_subscription:
    state: delete  # required
    subscriptions: SomeValue  # string, required

Scanned by Steampunk Spotter

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

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- 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

Scanned by Steampunk Spotter

- name: count_of_event_subscriptions
  cisco.dnac.event_subscription:
    state: query  # required
    event_ids: SomeValue  # string, required
    count: True  # boolean, required
  register: nm_count_of_event_subscriptions

Inputs

    
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

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: event_management.count_of_event_subscriptions
  type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also