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
|
#!/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: subscriber
short_description: Resource module for Subscriber
description:
- Manage operations create, update and delete of the resource Subscriber.
version_added: '2.8.0'
extends_documentation_fragment:
- cisco.ise.module
author: Rafael Campos (@racampos)
options:
enabled:
description: Subscriber is enabled or not.
type: bool
friendlyName:
description: Friendly name for the subscriber.
type: str
identityGroups:
description: Identity Group(s). With more than one idGroups it needs to be comma
seperated.
type: str
imeis:
description: IMEI to be attached to the subscriber.
type: str
imsi:
description: IMSI for Subscriber.
type: str
ki:
description: KI.
type: str
opc:
description: OPC.
type: str
subscriberId:
description: SubscriberId path parameter. Unique id for a subscriber object.
type: str
requirements:
- ciscoisesdk >= 2.2.1
- python >= 3.5
notes:
- SDK Method used are
subscriber.Subscriber.create_subscriber,
subscriber.Subscriber.delete_subscriber,
subscriber.Subscriber.update_subscriber,
- Paths used are
post /api/v1/fiveg/subscriber,
delete /api/v1/fiveg/subscriber/{subscriberId},
put /api/v1/fiveg/subscriber/{subscriberId},
"""
EXAMPLES = r"""
- name: Create
cisco.ise.subscriber:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
enabled: true
friendlyName: string
identityGroups: string
imeis: string
imsi: string
ki: string
opc: string
- name: Update by id
cisco.ise.subscriber:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
enabled: true
friendlyName: string
identityGroups: string
imeis: string
ki: string
opc: string
subscriberId: string
- name: Delete by id
cisco.ise.subscriber:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
subscriberId: 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: >
{
"createTime": "string",
"enabled": true,
"friendlyName": "string",
"id": "string",
"identityGroups": "string",
"imeis": "string",
"imsi": "string",
"ki": "string",
"link": {
"href": "string",
"rel": "string",
"type": "string"
},
"opc": "string",
"updateTime": "string"
}
ise_update_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
type: dict
sample: >
{
"response": {
"createTime": "string",
"enabled": true,
"friendlyName": "string",
"id": "string",
"identityGroups": "string",
"imeis": "string",
"imsi": "string",
"ki": "string",
"link": {
"href": "string",
"rel": "string",
"type": "string"
},
"opc": "string",
"updateTime": "string"
},
"version": "string"
}
"""
|
