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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
#!/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: endpoints
short_description: Resource module for Endpoints
description:
- Manage operations create, update and delete of the resource Endpoints.
version_added: '1.0.0'
extends_documentation_fragment:
- cisco.ise.module
author: Rafael Campos (@racampos)
options:
connectedLinks:
description: Endpoints's connectedLinks.
type: dict
customAttributes:
description: Endpoints's customAttributes.
type: dict
description:
description: Endpoints's description.
type: str
deviceType:
description: Endpoints's deviceType.
type: str
groupId:
description: Endpoints's groupId.
type: str
hardwareRevision:
description: Endpoints's hardwareRevision.
type: str
id:
description: Endpoints's id.
type: str
identityStore:
description: Endpoints's identityStore.
type: str
identityStoreId:
description: Endpoints's identityStoreId.
type: str
ipAddress:
description: Endpoints's ipAddress.
type: str
mac:
description: Endpoints's mac.
type: str
mdmAttributes:
description: Endpoints's mdmAttributes.
type: dict
name:
description: Endpoints's name.
type: str
portalUser:
description: Endpoints's portalUser.
type: str
productId:
description: Endpoints's productId.
type: str
profileId:
description: Endpoints's profileId.
type: str
protocol:
description: Endpoints's protocol.
type: str
serialNumber:
description: Endpoints's serialNumber.
type: str
softwareRevision:
description: Endpoints's softwareRevision.
type: str
staticGroupAssignment:
description: StaticGroupAssignment flag.
type: bool
staticProfileAssignment:
description: StaticProfileAssignment flag.
type: bool
value:
description: Value path parameter. The id or MAC of the endpoint.
type: str
vendor:
description: Endpoints's vendor.
type: str
requirements:
- ciscoisesdk >= 2.2.1
- python >= 3.5
notes:
- SDK Method used are
endpoints.Endpoints.create_end_point,
endpoints.Endpoints.delete_endpoint,
endpoints.Endpoints.update_endpoint,
- Paths used are
post /api/v1/endpoint,
delete /api/v1/endpoint/{value},
put /api/v1/endpoint/{value},
"""
EXAMPLES = r"""
- name: Create
cisco.ise.endpoints:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
connectedLinks: {}
customAttributes: {}
description: string
deviceType: string
groupId: string
hardwareRevision: string
id: string
identityStore: string
identityStoreId: string
ipAddress: string
mac: string
mdmAttributes: {}
name: string
portalUser: string
productId: string
profileId: string
protocol: string
serialNumber: string
softwareRevision: string
staticGroupAssignment: true
staticProfileAssignment: true
vendor: string
- name: Update by id
cisco.ise.endpoints:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
connectedLinks: {}
customAttributes: {}
description: string
deviceType: string
groupId: string
hardwareRevision: string
id: string
identityStore: string
identityStoreId: string
ipAddress: string
mac: string
mdmAttributes: {}
name: string
portalUser: string
productId: string
profileId: string
protocol: string
serialNumber: string
softwareRevision: string
staticGroupAssignment: true
staticProfileAssignment: true
value: string
vendor: string
- name: Delete by id
cisco.ise.endpoints:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
value: string
"""
RETURN = r"""
ise_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
type: dict
sample: >
{
"connectedLinks": {},
"customAttributes": {},
"description": "string",
"deviceType": "string",
"groupId": "string",
"hardwareRevision": "string",
"id": "string",
"identityStore": "string",
"identityStoreId": "string",
"ipAddress": "string",
"mac": "string",
"mdmAttributes": {},
"name": "string",
"portalUser": "string",
"productId": "string",
"profileId": "string",
"protocol": "string",
"serialNumber": "string",
"softwareRevision": "string",
"staticGroupAssignment": true,
"staticProfileAssignment": true,
"vendor": "string"
}
ise_update_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
version_added: '1.1.0'
type: dict
sample: >
{
"connectedLinks": {},
"customAttributes": {},
"description": "string",
"deviceType": "string",
"groupId": "string",
"hardwareRevision": "string",
"id": "string",
"identityStore": "string",
"identityStoreId": "string",
"ipAddress": "string",
"mac": "string",
"mdmAttributes": {},
"name": "string",
"portalUser": "string",
"productId": "string",
"profileId": "string",
"protocol": "string",
"serialNumber": "string",
"softwareRevision": "string",
"staticGroupAssignment": true,
"staticProfileAssignment": true,
"vendor": "string"
}
"""
|