118 lines
3.3 KiB
Python
118 lines
3.3 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: telemetry_info
|
|
short_description: Information module for Telemetry Info
|
|
description:
|
|
- Get all Telemetry Info.
|
|
- Get Telemetry Info by id.
|
|
version_added: '1.0.0'
|
|
extends_documentation_fragment:
|
|
- cisco.ise.module_info
|
|
author: Rafael Campos (@racampos)
|
|
options:
|
|
id:
|
|
description:
|
|
- Id path parameter.
|
|
type: str
|
|
page:
|
|
description:
|
|
- Page query parameter. Page number.
|
|
type: int
|
|
size:
|
|
description:
|
|
- Size query parameter. Number of objects returned per page.
|
|
type: int
|
|
filter:
|
|
description:
|
|
- >
|
|
Filter query parameter. <br/> **Simple filtering** should be available through the filter query string
|
|
parameter. The structure of a filter is a triplet of field operator and value separated with dots. More than
|
|
one filter can be sent. The logical operator common to ALL filter criteria will be by default AND, and can
|
|
be changed by using the "filterType=or" query string parameter. Each resource Data model description should
|
|
specify if an attribute is a filtered field. <br/> Operator | Description <br/>
|
|
------------|----------------- <br/> EQ | Equals <br/> NEQ | Not Equals <br/> GT | Greater Than <br/> LT |
|
|
Less Then <br/> STARTSW | Starts With <br/> NSTARTSW | Not Starts With <br/> ENDSW | Ends With <br/> NENDSW
|
|
| Not Ends With <br/> CONTAINS | Contains <br/> NCONTAINS | Not Contains <br/>.
|
|
type: list
|
|
filterType:
|
|
description:
|
|
- >
|
|
FilterType query parameter. The logical operator common to ALL filter criteria will be by default AND, and
|
|
can be changed by using the parameter.
|
|
type: str
|
|
requirements:
|
|
- ciscoisesdk >= 1.1.0
|
|
- python >= 3.5
|
|
seealso:
|
|
# Reference by Internet resource
|
|
- name: Telemetry Info reference
|
|
description: Complete reference of the Telemetry Info object model.
|
|
link: https://ciscoisesdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary
|
|
"""
|
|
|
|
EXAMPLES = r"""
|
|
- name: Get all Telemetry Info
|
|
cisco.ise.telemetry_info:
|
|
ise_hostname: "{{ise_hostname}}"
|
|
ise_username: "{{ise_username}}"
|
|
ise_password: "{{ise_password}}"
|
|
ise_verify: "{{ise_verify}}"
|
|
page: 1
|
|
size: 20
|
|
filter: []
|
|
filterType: AND
|
|
register: result
|
|
|
|
- name: Get Telemetry Info by id
|
|
cisco.ise.telemetry_info:
|
|
ise_hostname: "{{ise_hostname}}"
|
|
ise_username: "{{ise_username}}"
|
|
ise_password: "{{ise_password}}"
|
|
ise_verify: "{{ise_verify}}"
|
|
id: 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",
|
|
"status": "string",
|
|
"deploymentId": "string",
|
|
"udiSN": "string",
|
|
"link": {
|
|
"rel": "string",
|
|
"href": "string",
|
|
"type": "string"
|
|
}
|
|
}
|
|
ise_responses:
|
|
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
|
|
returned: always
|
|
version_added: "1.1.0"
|
|
type: list
|
|
elements: dict
|
|
sample: >
|
|
[
|
|
{
|
|
"id": "string",
|
|
"link": {
|
|
"rel": "string",
|
|
"href": "string",
|
|
"type": "string"
|
|
}
|
|
}
|
|
]
|
|
"""
|