1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
#!/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: pxgrid_node_info
short_description: Information module for pxGrid Node
description:
- Get all pxGrid Node.
- Get pxGrid Node by id.
- Get pxGrid Node by name.
- This API allows the client to get a pxGrid node by ID.
- This API allows the client to get a pxGrid node by name.
- This API allows the client to get all the npxGrid nodes.
version_added: '1.0.0'
extends_documentation_fragment:
- cisco.ise.module_info
author: Rafael Campos (@racampos)
options:
name:
description:
- Name path parameter.
type: str
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
requirements:
- ciscoisesdk >= 2.1.1
- python >= 3.5
notes:
- SDK Method used are
px_grid_node.PxGridNode.get_px_grid_node_by_id,
px_grid_node.PxGridNode.get_px_grid_node_by_name,
px_grid_node.PxGridNode.get_px_grid_node_generator,
- Paths used are
get /ers/config/pxgridnode,
get /ers/config/pxgridnode/name/{name},
get /ers/config/pxgridnode/{id},
"""
EXAMPLES = r"""
- name: Get all pxGrid Node
cisco.ise.pxgrid_node_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
page: 1
size: 20
register: result
- name: Get pxGrid Node by id
cisco.ise.pxgrid_node_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
- name: Get pxGrid Node by name
cisco.ise.pxgrid_node_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
name: 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",
"name": "string",
"description": "string",
"status": "string",
"authMethod": "string",
"groups": "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",
"name": "string",
"description": "string",
"status": "string",
"authMethod": "string",
"groups": "string",
"link": {
"rel": "string",
"href": "string",
"type": "string"
}
}
]
"""
|
