blob: 4fbf7af0fbcad3d9305e37ff1b9c90398e78393d (
plain)
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
|
#!/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: node_group_info
short_description: Information module for Node Group
description:
- Get all Node Group.
- Get Node Group by name.
- This API retrieves the details of a node group in the cluster using a node group name.
- This API retrieves the details of all the node groups in the cluster.
version_added: '1.0.0'
extends_documentation_fragment:
- cisco.ise.module_info
author: Rafael Campos (@racampos)
options:
nodeGroupName:
description:
- NodeGroupName path parameter. Name of the existing node group.
type: str
requirements:
- ciscoisesdk >= 2.1.1
- python >= 3.5
seealso:
- name: Cisco ISE documentation for Node Group
description: Complete reference of the Node Group API.
link: https://developer.cisco.com/docs/identity-services-engine/v1/#!deployment-openapi
notes:
- SDK Method used are
node_group.NodeGroup.get_node_group,
node_group.NodeGroup.get_node_groups,
- Paths used are
get /api/v1/deployment/node-group,
get /api/v1/deployment/node-group/{nodeGroupName},
"""
EXAMPLES = r"""
- name: Get all Node Group
cisco.ise.node_group_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
register: result
- name: Get Node Group by name
cisco.ise.node_group_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
nodeGroupName: 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: >
{
"description": "string",
"marCache": {
"query-attempts": 0,
"query-timeout": 0,
"replication-attempts": 0,
"replication-timeout": 0
},
"name": "string"
}
"""
|