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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
#!/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: endpoint
short_description: Resource module for Endpoint
description:
- Manage operations create, update and delete of the resource Endpoint.
- This API creates an endpoint.
- This API deletes an endpoint.
- This API allows the client to update an endpoint.
version_added: '1.0.0'
extends_documentation_fragment:
- cisco.ise.module
author: Rafael Campos (@racampos)
options:
customAttributes:
description: Endpoint's customAttributes.
suboptions:
customAttributes:
description: Key value map.
type: dict
type: dict
description:
description: Endpoint's description.
type: str
groupId:
description: Endpoint's groupId.
type: str
id:
description: Endpoint's id.
type: str
identityStore:
description: Endpoint's identityStore.
type: str
identityStoreId:
description: Endpoint's identityStoreId.
type: str
mac:
description: Endpoint's mac.
type: str
mdmAttributes:
description: Endpoint's mdmAttributes.
suboptions:
mdmComplianceStatus:
description: MdmComplianceStatus flag.
type: bool
mdmEncrypted:
description: MdmEncrypted flag.
type: bool
mdmEnrolled:
description: MdmEnrolled flag.
type: bool
mdmIMEI:
description: Endpoint's mdmIMEI.
type: str
mdmJailBroken:
description: MdmJailBroken flag.
type: bool
mdmManufacturer:
description: Endpoint's mdmManufacturer.
type: str
mdmModel:
description: Endpoint's mdmModel.
type: str
mdmOS:
description: Endpoint's mdmOS.
type: str
mdmPhoneNumber:
description: Endpoint's mdmPhoneNumber.
type: str
mdmPinlock:
description: MdmPinlock flag.
type: bool
mdmReachable:
description: MdmReachable flag.
type: bool
mdmSerial:
description: Endpoint's mdmSerial.
type: str
mdmServerName:
description: Endpoint's mdmServerName.
type: str
type: dict
name:
description: Endpoint's name.
type: str
portalUser:
description: Endpoint's portalUser.
type: str
profileId:
description: Endpoint's profileId.
type: str
staticGroupAssignment:
description: StaticGroupAssignment flag.
type: bool
staticProfileAssignment:
description: StaticProfileAssignment flag.
type: bool
requirements:
- ciscoisesdk >= 2.1.1
- python >= 3.5
notes:
- SDK Method used are
endpoint.Endpoint.create_endpoint,
endpoint.Endpoint.delete_endpoint_by_id,
endpoint.Endpoint.update_endpoint_by_id,
- Paths used are
post /ers/config/endpoint,
delete /ers/config/endpoint/{id},
put /ers/config/endpoint/{id},
"""
EXAMPLES = r"""
- name: Update by id
cisco.ise.endpoint:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customAttributes:
customAttributes: {}
description: string
groupId: string
id: string
identityStore: string
identityStoreId: string
mac: string
mdmAttributes:
mdmComplianceStatus: true
mdmEncrypted: true
mdmEnrolled: true
mdmIMEI: string
mdmJailBroken: true
mdmManufacturer: string
mdmModel: string
mdmOS: string
mdmPhoneNumber: string
mdmPinlock: true
mdmReachable: true
mdmSerial: string
mdmServerName: string
name: string
portalUser: string
profileId: string
staticGroupAssignment: true
staticProfileAssignment: true
- name: Delete by id
cisco.ise.endpoint:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.endpoint:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customAttributes:
customAttributes: {}
description: string
groupId: string
identityStore: string
identityStoreId: string
mac: string
mdmAttributes:
mdmComplianceStatus: true
mdmEncrypted: true
mdmEnrolled: true
mdmIMEI: string
mdmJailBroken: true
mdmManufacturer: string
mdmModel: string
mdmOS: string
mdmPhoneNumber: string
mdmPinlock: true
mdmReachable: true
mdmSerial: string
mdmServerName: string
name: string
portalUser: string
profileId: string
staticGroupAssignment: true
staticProfileAssignment: true
"""
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",
"mac": "string",
"profileId": "string",
"staticProfileAssignment": true,
"groupId": "string",
"staticGroupAssignment": true,
"portalUser": "string",
"identityStore": "string",
"identityStoreId": "string",
"mdmAttributes": {
"mdmServerName": "string",
"mdmReachable": true,
"mdmEnrolled": true,
"mdmComplianceStatus": true,
"mdmOS": "string",
"mdmManufacturer": "string",
"mdmModel": "string",
"mdmSerial": "string",
"mdmEncrypted": true,
"mdmPinlock": true,
"mdmJailBroken": true,
"mdmIMEI": "string",
"mdmPhoneNumber": "string"
},
"customAttributes": {
"customAttributes": {}
},
"link": {
"rel": "string",
"href": "string",
"type": "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: >
{
"UpdatedFieldsList": {
"updatedField": [
{
"field": "string",
"oldValue": "string",
"newValue": "string"
}
],
"field": "string",
"oldValue": "string",
"newValue": "string"
}
}
"""
|
