72 lines
1.6 KiB
Python
72 lines
1.6 KiB
Python
#!/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: tasks_info
|
|
short_description: Information module for Tasks
|
|
description:
|
|
- Get all Tasks.
|
|
- Get Tasks by id.
|
|
version_added: '1.0.0'
|
|
extends_documentation_fragment:
|
|
- cisco.ise.module_info
|
|
author: Rafael Campos (@racampos)
|
|
options:
|
|
taskId:
|
|
description:
|
|
- TaskId path parameter. The id of the task executed before.
|
|
type: str
|
|
requirements:
|
|
- ciscoisesdk >= 1.1.0
|
|
- python >= 3.5
|
|
seealso:
|
|
# Reference by Internet resource
|
|
- name: Tasks reference
|
|
description: Complete reference of the Tasks object model.
|
|
link: https://ciscoisesdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: Get all Tasks
|
|
cisco.ise.tasks_info:
|
|
ise_hostname: "{{ise_hostname}}"
|
|
ise_username: "{{ise_username}}"
|
|
ise_password: "{{ise_password}}"
|
|
ise_verify: "{{ise_verify}}"
|
|
register: result
|
|
|
|
- name: Get Tasks by id
|
|
cisco.ise.tasks_info:
|
|
ise_hostname: "{{ise_hostname}}"
|
|
ise_username: "{{ise_username}}"
|
|
ise_password: "{{ise_password}}"
|
|
ise_verify: "{{ise_verify}}"
|
|
taskId: string
|
|
register: result
|
|
|
|
"""
|
|
|
|
RETURN = r"""
|
|
ise_response:
|
|
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
|
|
returned: always
|
|
type: dict
|
|
sample: >
|
|
{
|
|
"id": "string",
|
|
"executionStatus": "string",
|
|
"moduleType": "string",
|
|
"startTime": "string",
|
|
"resourcesCount": 0,
|
|
"successCount": 0,
|
|
"failCount": 0,
|
|
"detailStatus": [
|
|
{}
|
|
]
|
|
}
|
|
"""
|