cisco.catalystcenter.activities_activity_id_triggered_jobs_info module -- Information module for Activities Activity Id Triggered Jobs

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

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

New in cisco.catalystcenter 6.18.0

Synopsis

  • Get all Activities Activity Id Triggered Jobs.

  • Returns the triggered jobs by the activity with the given activity id.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

activityId

string

ActivityId path parameter. The id of the activity.

catc_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catc_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catc_host

string / required

The Cisco Catalyst Center hostname.

catc_password

string

The Cisco Catalyst Center password to authenticate.

catc_username

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catc_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

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

limit

float

Limit query parameter. The number of records to show for this page.

offset

float

Offset query parameter. The first record to show for this page; the first record is numbered 1.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.

sortBy

string

SortBy query parameter. A property within the response to sort by.

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 task.Task.get_triggered_jobs_by_activity_id,

  • Paths used are get /dna/intent/api/v1/activities/{activityId}/triggeredJobs,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for Task GetTriggeredJobsByActivityId

Complete reference of the GetTriggeredJobsByActivityId API.

Examples

---
- name: Get all Activities Activity Id Triggered Jobs
  cisco.catalystcenter.activities_activity_id_triggered_jobs_info:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    headers: "{{my_headers | from_json}}"
    offset: 0
    limit: 0
    sortBy: string
    order: string
    activityId: string
  register: result

Return Values

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

Key

Description

dnac_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": [{"description": "string", "id": "string", "status": "string", "taskId": "string", "taskUrl": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)