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
|
"""Traffic rules as part of a UniFi network."""
from dataclasses import dataclass
from typing import NotRequired, Self, TypedDict
from .api import ApiItem, ApiRequestV2
class BandwidthLimit(TypedDict):
"""Bandwidth limit type definition."""
download_limit_kbps: int
enabled: bool
upload_limit_kbps: int
class PortRange(TypedDict):
"""Port range type definition."""
port_start: int
port_stop: int
class IPAddress(TypedDict):
"""IP Address for which traffic rule is applicable type definition."""
ip_or_subnet: str
ip_version: str
port_ranges: list[PortRange]
ports: list[int]
class IPRange(TypedDict):
"""IP Range type definition."""
ip_start: str
ip_stop: str
ip_version: str
class Schedule(TypedDict):
"""Schedule to enable/disable traffic rule type definition."""
date_end: str
date_start: str
mode: str
repeat_on_days: list[str]
time_all_day: bool
time_range_end: str
time_range_start: str
class TargetDevice(TypedDict):
"""Target device to which the traffic rule applies."""
client_mac: NotRequired[str]
network_id: NotRequired[str]
type: str
class TypedTrafficRule(TypedDict):
"""Traffic rule type definition."""
_id: str
action: str
app_category_ids: list[str]
app_ids: list[str]
bandwidth_limit: BandwidthLimit
description: str
domains: list[str]
enabled: bool
ip_addresses: list[IPAddress]
ip_ranges: list[IPRange]
matching_target: str
network_ids: list[str]
regions: list[str]
schedule: Schedule
target_devices: list[TargetDevice]
@dataclass
class TrafficRuleListRequest(ApiRequestV2):
"""Request object for traffic rule list."""
@classmethod
def create(cls) -> Self:
"""Create traffic rule request."""
return cls(method="get", path="/trafficrules", data=None)
@dataclass
class TrafficRuleEnableRequest(ApiRequestV2):
"""Request object for traffic rule enable."""
@classmethod
def create(cls, traffic_rule: TypedTrafficRule, enable: bool) -> Self:
"""Create traffic rule enable request."""
traffic_rule["enabled"] = enable
return cls(
method="put",
path=f"/trafficrules/{traffic_rule['_id']}",
data=traffic_rule,
)
class TrafficRule(ApiItem):
"""Represent a traffic rule configuration."""
raw: TypedTrafficRule
@property
def id(self) -> str:
"""ID of traffic rule."""
return self.raw["_id"]
@property
def description(self) -> str:
"""Description given by user to traffic rule."""
return self.raw["description"]
@property
def enabled(self) -> bool:
"""Is traffic rule enabled."""
return self.raw["enabled"]
@property
def action(self) -> str:
"""What action is defined by this traffic rule."""
return self.raw["action"]
@property
def matching_target(self) -> str:
"""What target is matched by this traffic rule."""
return self.raw["matching_target"]
@property
def target_devices(self) -> list[TargetDevice]:
"""What target devices are affected by this traffic rule."""
return self.raw["target_devices"]
|
