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
|
"""Adds enough AJAX methods to RuckusApi to support Home Assistant"""
from typing import List
from .ruckusajaxapi import RuckusAjaxApi
from .typing_policy import *
from .const import (
SystemStat,
)
from .ajaxsession import AjaxSession
class R1AjaxApi(RuckusAjaxApi):
"""Ruckus One Configuration, Statistics and Commands API"""
def __init__(self, session: AjaxSession):
super().__init__(session)
async def get_aps(self) -> List[dict]:
"""Return a list of APs"""
aps = await self.session.r1_get("venues/aps")
compat_aps = [
{
**ap,
"devname": ap["name"],
"version": ap["firmware"],
"serial": ap["serialNumber"],
}
for ap in aps
]
return compat_aps
async def get_ap_groups(self) -> List:
"""Return a list of AP groups"""
raise NotImplementedError
async def get_wlans(self) -> List[dict]:
"""Return a list of WLANs"""
raise NotImplementedError
async def get_wlan_groups(self) -> List[dict]:
"""Return a list of WLAN groups"""
raise NotImplementedError
async def get_urlfiltering_policies(self) -> list[UrlFilter | dict]:
"""Return a list of URL Filtering Policies"""
raise NotImplementedError
async def get_urlfiltering_blockingcategories(
self,
) -> list[UrlBlockCategory | dict]:
"""Return a list of URL Filtering Blocking Categories"""
raise NotImplementedError
async def get_ip4_policies(self) -> list[Ip4Policy | dict]:
"""Return a list of IP4 Policies"""
raise NotImplementedError
async def get_ip6_policies(self) -> list[Ip6Policy | dict]:
"""Return a list of IP6 Policies"""
raise NotImplementedError
async def get_device_policies(self) -> list[DevicePolicy | dict]:
"""Return a list of Device Policies"""
raise NotImplementedError
async def get_precedence_policies(self) -> list[PrecedencePolicy | dict]:
"""Return a list of Precedence Policies"""
raise NotImplementedError
async def get_arc_policies(self) -> list[ArcPolicy | dict]:
"""Return a list of Application Recognition & Control Policies"""
raise NotImplementedError
async def get_arc_applications(self) -> list[ArcApplication | dict]:
"""Return a list of Application Recognition & Control User Defined Applications"""
raise NotImplementedError
async def get_arc_ports(self) -> list[ArcPort | dict]:
"""Return a list of Application Recognition & Control User Defined Ports"""
raise NotImplementedError
async def get_roles(self) -> list[Role | dict]:
"""Return a list of Roles"""
raise NotImplementedError
async def get_dpsks(self) -> list[Dpsk | dict]:
"""Return a list of DPSKs"""
raise NotImplementedError
async def get_system_info(self, *sections: SystemStat) -> dict:
"""Return system information"""
tenant = await self.session.r1_get("tenants/self")
return {
"tenant": tenant,
"sysinfo": {"version": "R1", "serial": tenant["entitlementId"]},
"identity": {"name": tenant["name"]}
}
async def get_mesh_info(self) -> dict:
"""Return dummy mesh information"""
# We need to implement this because Home Assistant uses the mesh
# name as the display name for any Ruskus network.
# We will use the Tenant Name instead.
tenant = await self.session.r1_get("tenants/self")
return tenant
async def __get_cluster_state(self) -> dict:
"""Return Cluster State"""
return await self.session.sz_get("cluster/state")
async def get_zerotouch_mesh_ap_serials(self) -> dict:
"""Return a list of Pre-approved AP serial numbers"""
raise NotImplementedError
async def get_acls(self) -> list[L2Policy | dict]:
"""Return a list of ACLs"""
raise NotImplementedError
async def get_blocked_client_macs(self) -> list[L2Rule | dict]:
"""Return a list of blocked client MACs"""
raise NotImplementedError
async def get_active_clients(self, interval_stats: bool = False) -> List:
"""Return a list of active clients"""
clients = await self.session.r1_get("clients")
compat_clients = [
{
**client,
"ap": client["apMac"],
"hostname": client["hostname"] or client["mac"]
}
for client in clients
]
return compat_clients
async def get_inactive_clients(self) -> List:
"""Return a list of inactive clients"""
raise NotImplementedError
async def get_ap_stats(self) -> List:
"""Return a list of AP statistics"""
aps = await self.session.r1_get("venues/aps")
compat_aps = [
{
**ap,
"devname": ap["name"],
"firmware-version": ap["firmware"],
"serial-number": ap["serialNumber"],
}
for ap in aps
]
return compat_aps
async def get_ap_group_stats(self) -> List:
"""Return a list of AP group statistics"""
raise NotImplementedError
async def get_vap_stats(self) -> List:
"""Return a list of Virtual AP (per-radio WLAN) statistics"""
return await self.session.sz_query("wlan")
async def get_wlan_group_stats(self) -> List:
"""Return a list of WLAN group statistics"""
raise NotImplementedError
async def get_dpsk_stats(self) -> List:
"""Return a list of AP group statistics"""
raise NotImplementedError
async def get_active_rogues(self) -> list[dict]:
"""Return a list of currently active rogue devices"""
raise NotImplementedError
async def get_known_rogues(self, limit: int = 300) -> list[dict]:
"""Return a list of known/recognized rogues devices"""
raise NotImplementedError
async def get_blocked_rogues(self, limit: int = 300) -> list[dict]:
"""Return a list of user blocked rogues devices"""
raise NotImplementedError
async def get_all_alarms(self, limit: int = 300) -> list[dict]:
"""Return a list of all alerts"""
raise NotImplementedError
async def get_all_events(self, limit: int = 300) -> list[dict]:
"""Return a list of all events"""
raise NotImplementedError
async def get_wlan_events(self, *wlan_ids, limit: int = 300) -> list[dict]:
"""Return a list of WLAN events"""
raise NotImplementedError
async def get_ap_events(self, *ap_macs, limit: int = 300) -> list[dict]:
"""Return a list of AP events"""
raise NotImplementedError
async def get_client_events(self, limit: int = 300) -> list[dict]:
"""Return a list of client events"""
raise NotImplementedError
async def get_wired_client_events(self, limit: int = 300) -> list[dict]:
"""Return a list of wired client events"""
raise NotImplementedError
async def get_syslog(self) -> str:
"""Return a list of syslog entries"""
raise NotImplementedError
async def get_backup(self) -> bytes:
"""Return a backup"""
raise NotImplementedError
async def do_block_client(self, mac: str) -> None:
"""Block a client"""
raise NotImplementedError
async def do_unblock_client(self, mac: str) -> None:
"""Unblock a client"""
raise NotImplementedError
async def do_delete_ap_group(self, name: str) -> bool:
"""Delete an AP group"""
raise NotImplementedError
async def do_disable_wlan(self, name: str, disable_wlan: bool = True) -> None:
"""Disable a WLAN"""
raise NotImplementedError
async def do_enable_wlan(self, name: str) -> None:
"""Enable a WLAN"""
raise NotImplementedError
async def do_set_wlan_password(
self, name: str, passphrase: str, sae_passphrase: str = None
) -> None:
raise NotImplementedError
async def do_hide_ap_leds(self, mac: str, leds_off: bool = True) -> None:
"""Hide AP LEDs"""
raise NotImplementedError
async def do_show_ap_leds(self, mac: str) -> None:
"""Show AP LEDs"""
raise NotImplementedError
async def do_restart_ap(self, mac: str) -> None:
"""Restart AP"""
raise NotImplementedError
|
