@serve.zone/dcrouter-apiclient 32.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist_ts_apiclient/classes.apitoken.d.ts +41 -0
- package/dist_ts_apiclient/classes.apitoken.js +115 -0
- package/dist_ts_apiclient/classes.certificate.d.ts +57 -0
- package/dist_ts_apiclient/classes.certificate.js +69 -0
- package/dist_ts_apiclient/classes.config.d.ts +7 -0
- package/dist_ts_apiclient/classes.config.js +11 -0
- package/dist_ts_apiclient/classes.dcrouterapiclient.d.ts +54 -0
- package/dist_ts_apiclient/classes.dcrouterapiclient.js +97 -0
- package/dist_ts_apiclient/classes.email.d.ts +30 -0
- package/dist_ts_apiclient/classes.email.js +52 -0
- package/dist_ts_apiclient/classes.gatewayclient.d.ts +28 -0
- package/dist_ts_apiclient/classes.gatewayclient.js +52 -0
- package/dist_ts_apiclient/classes.logs.d.ts +28 -0
- package/dist_ts_apiclient/classes.logs.js +69 -0
- package/dist_ts_apiclient/classes.radius.d.ts +59 -0
- package/dist_ts_apiclient/classes.radius.js +95 -0
- package/dist_ts_apiclient/classes.remoteingress.d.ts +66 -0
- package/dist_ts_apiclient/classes.remoteingress.js +164 -0
- package/dist_ts_apiclient/classes.route.d.ts +39 -0
- package/dist_ts_apiclient/classes.route.js +125 -0
- package/dist_ts_apiclient/classes.stats.d.ts +47 -0
- package/dist_ts_apiclient/classes.stats.js +38 -0
- package/dist_ts_apiclient/classes.testing.d.ts +65 -0
- package/dist_ts_apiclient/classes.testing.js +120 -0
- package/dist_ts_apiclient/index.d.ts +12 -0
- package/dist_ts_apiclient/index.js +16 -0
- package/dist_ts_apiclient/plugins.d.ts +4 -0
- package/dist_ts_apiclient/plugins.js +6 -0
- package/dist_ts_interfaces/data/acme-config.d.ts +23 -0
- package/dist_ts_interfaces/data/acme-config.js +2 -0
- package/dist_ts_interfaces/data/auth.d.ts +8 -0
- package/dist_ts_interfaces/data/auth.js +2 -0
- package/dist_ts_interfaces/data/config-events.d.ts +34 -0
- package/dist_ts_interfaces/data/config-events.js +8 -0
- package/dist_ts_interfaces/data/dns-authority.d.ts +98 -0
- package/dist_ts_interfaces/data/dns-authority.js +26 -0
- package/dist_ts_interfaces/data/dns-provider.d.ts +136 -0
- package/dist_ts_interfaces/data/dns-provider.js +41 -0
- package/dist_ts_interfaces/data/dns-record.d.ts +48 -0
- package/dist_ts_interfaces/data/dns-record.js +2 -0
- package/dist_ts_interfaces/data/domain.d.ts +35 -0
- package/dist_ts_interfaces/data/domain.js +2 -0
- package/dist_ts_interfaces/data/email-domain.d.ts +177 -0
- package/dist_ts_interfaces/data/email-domain.js +2 -0
- package/dist_ts_interfaces/data/email-settings.d.ts +68 -0
- package/dist_ts_interfaces/data/email-settings.js +2 -0
- package/dist_ts_interfaces/data/index.d.ts +18 -0
- package/dist_ts_interfaces/data/index.js +19 -0
- package/dist_ts_interfaces/data/remoteingress.d.ts +181 -0
- package/dist_ts_interfaces/data/remoteingress.js +15 -0
- package/dist_ts_interfaces/data/route-management.d.ts +270 -0
- package/dist_ts_interfaces/data/route-management.js +130 -0
- package/dist_ts_interfaces/data/security-policy.d.ts +32 -0
- package/dist_ts_interfaces/data/security-policy.js +2 -0
- package/dist_ts_interfaces/data/smtp-account.d.ts +50 -0
- package/dist_ts_interfaces/data/smtp-account.js +9 -0
- package/dist_ts_interfaces/data/stats.d.ts +283 -0
- package/dist_ts_interfaces/data/stats.js +2 -0
- package/dist_ts_interfaces/data/target-profile.d.ts +30 -0
- package/dist_ts_interfaces/data/target-profile.js +2 -0
- package/dist_ts_interfaces/data/testing.d.ts +191 -0
- package/dist_ts_interfaces/data/testing.js +20 -0
- package/dist_ts_interfaces/data/vpn.d.ts +65 -0
- package/dist_ts_interfaces/data/vpn.js +2 -0
- package/dist_ts_interfaces/data/workhoster.d.ts +63 -0
- package/dist_ts_interfaces/data/workhoster.js +2 -0
- package/dist_ts_interfaces/index.d.ts +5 -0
- package/dist_ts_interfaces/index.js +8 -0
- package/dist_ts_interfaces/plugins.d.ts +2 -0
- package/dist_ts_interfaces/plugins.js +4 -0
- package/dist_ts_interfaces/requests/acme-config.d.ts +42 -0
- package/dist_ts_interfaces/requests/acme-config.js +2 -0
- package/dist_ts_interfaces/requests/admin.d.ts +69 -0
- package/dist_ts_interfaces/requests/admin.js +3 -0
- package/dist_ts_interfaces/requests/api-tokens.d.ts +85 -0
- package/dist_ts_interfaces/requests/api-tokens.js +2 -0
- package/dist_ts_interfaces/requests/certificate.d.ts +87 -0
- package/dist_ts_interfaces/requests/certificate.js +5 -0
- package/dist_ts_interfaces/requests/combined.stats.d.ts +29 -0
- package/dist_ts_interfaces/requests/combined.stats.js +2 -0
- package/dist_ts_interfaces/requests/config-events.d.ts +35 -0
- package/dist_ts_interfaces/requests/config-events.js +4 -0
- package/dist_ts_interfaces/requests/config.d.ts +93 -0
- package/dist_ts_interfaces/requests/config.js +3 -0
- package/dist_ts_interfaces/requests/dns-authority.d.ts +80 -0
- package/dist_ts_interfaces/requests/dns-authority.js +3 -0
- package/dist_ts_interfaces/requests/dns-providers.d.ts +117 -0
- package/dist_ts_interfaces/requests/dns-providers.js +2 -0
- package/dist_ts_interfaces/requests/dns-records.d.ts +89 -0
- package/dist_ts_interfaces/requests/dns-records.js +2 -0
- package/dist_ts_interfaces/requests/domains.d.ts +142 -0
- package/dist_ts_interfaces/requests/domains.js +2 -0
- package/dist_ts_interfaces/requests/email-domains.d.ts +154 -0
- package/dist_ts_interfaces/requests/email-domains.js +2 -0
- package/dist_ts_interfaces/requests/email-ops.d.ts +211 -0
- package/dist_ts_interfaces/requests/email-ops.js +3 -0
- package/dist_ts_interfaces/requests/email-settings.d.ts +26 -0
- package/dist_ts_interfaces/requests/email-settings.js +2 -0
- package/dist_ts_interfaces/requests/index.d.ts +29 -0
- package/dist_ts_interfaces/requests/index.js +30 -0
- package/dist_ts_interfaces/requests/logs.d.ts +43 -0
- package/dist_ts_interfaces/requests/logs.js +4 -0
- package/dist_ts_interfaces/requests/network-targets.d.ts +102 -0
- package/dist_ts_interfaces/requests/network-targets.js +2 -0
- package/dist_ts_interfaces/requests/radius.d.ts +280 -0
- package/dist_ts_interfaces/requests/radius.js +3 -0
- package/dist_ts_interfaces/requests/realtime.d.ts +38 -0
- package/dist_ts_interfaces/requests/realtime.js +12 -0
- package/dist_ts_interfaces/requests/remoteingress.d.ts +162 -0
- package/dist_ts_interfaces/requests/remoteingress.js +3 -0
- package/dist_ts_interfaces/requests/route-management.d.ts +147 -0
- package/dist_ts_interfaces/requests/route-management.js +2 -0
- package/dist_ts_interfaces/requests/security-policy.d.ts +105 -0
- package/dist_ts_interfaces/requests/security-policy.js +2 -0
- package/dist_ts_interfaces/requests/smtp-accounts.d.ts +125 -0
- package/dist_ts_interfaces/requests/smtp-accounts.js +2 -0
- package/dist_ts_interfaces/requests/source-profiles.d.ts +102 -0
- package/dist_ts_interfaces/requests/source-profiles.js +2 -0
- package/dist_ts_interfaces/requests/stats.d.ts +196 -0
- package/dist_ts_interfaces/requests/stats.js +4 -0
- package/dist_ts_interfaces/requests/target-profiles.d.ts +105 -0
- package/dist_ts_interfaces/requests/target-profiles.js +2 -0
- package/dist_ts_interfaces/requests/testing.d.ts +169 -0
- package/dist_ts_interfaces/requests/testing.js +2 -0
- package/dist_ts_interfaces/requests/users.d.ts +53 -0
- package/dist_ts_interfaces/requests/users.js +3 -0
- package/dist_ts_interfaces/requests/vpn.d.ts +188 -0
- package/dist_ts_interfaces/requests/vpn.js +3 -0
- package/dist_ts_interfaces/requests/workhoster.d.ts +79 -0
- package/dist_ts_interfaces/requests/workhoster.js +2 -0
- package/license +21 -0
- package/package.json +67 -0
- package/readme.md +218 -0
- package/ts_apiclient/classes.apitoken.ts +157 -0
- package/ts_apiclient/classes.certificate.ts +124 -0
- package/ts_apiclient/classes.config.ts +17 -0
- package/ts_apiclient/classes.dcrouterapiclient.ts +138 -0
- package/ts_apiclient/classes.email.ts +77 -0
- package/ts_apiclient/classes.gatewayclient.ts +110 -0
- package/ts_apiclient/classes.logs.ts +91 -0
- package/ts_apiclient/classes.radius.ts +180 -0
- package/ts_apiclient/classes.remoteingress.ts +217 -0
- package/ts_apiclient/classes.route.ts +166 -0
- package/ts_apiclient/classes.stats.ts +111 -0
- package/ts_apiclient/classes.testing.ts +152 -0
- package/ts_apiclient/index.ts +17 -0
- package/ts_apiclient/plugins.ts +10 -0
- package/ts_apiclient/readme.md +218 -0
- package/ts_interfaces/data/acme-config.ts +23 -0
- package/ts_interfaces/data/auth.ts +8 -0
- package/ts_interfaces/data/config-events.ts +38 -0
- package/ts_interfaces/data/dns-authority.ts +106 -0
- package/ts_interfaces/data/dns-provider.ts +174 -0
- package/ts_interfaces/data/dns-record.ts +50 -0
- package/ts_interfaces/data/domain.ts +36 -0
- package/ts_interfaces/data/email-domain.ts +206 -0
- package/ts_interfaces/data/email-settings.ts +75 -0
- package/ts_interfaces/data/index.ts +18 -0
- package/ts_interfaces/data/remoteingress.ts +204 -0
- package/ts_interfaces/data/route-management.ts +436 -0
- package/ts_interfaces/data/security-policy.ts +37 -0
- package/ts_interfaces/data/smtp-account.ts +63 -0
- package/ts_interfaces/data/stats.ts +305 -0
- package/ts_interfaces/data/target-profile.ts +31 -0
- package/ts_interfaces/data/testing.ts +184 -0
- package/ts_interfaces/data/vpn.ts +68 -0
- package/ts_interfaces/data/workhoster.ts +72 -0
- package/ts_interfaces/index.ts +9 -0
- package/ts_interfaces/plugins.ts +6 -0
- package/ts_interfaces/readme.md +194 -0
- package/ts_interfaces/requests/acme-config.ts +54 -0
- package/ts_interfaces/requests/admin.ts +96 -0
- package/ts_interfaces/requests/api-tokens.ts +109 -0
- package/ts_interfaces/requests/certificate.ts +106 -0
- package/ts_interfaces/requests/combined.stats.ts +30 -0
- package/ts_interfaces/requests/config-events.ts +45 -0
- package/ts_interfaces/requests/config.ts +94 -0
- package/ts_interfaces/requests/dns-authority.ts +104 -0
- package/ts_interfaces/requests/dns-providers.ts +154 -0
- package/ts_interfaces/requests/dns-records.ts +113 -0
- package/ts_interfaces/requests/domains.ts +178 -0
- package/ts_interfaces/requests/email-domains.ts +193 -0
- package/ts_interfaces/requests/email-ops.ts +266 -0
- package/ts_interfaces/requests/email-settings.ts +34 -0
- package/ts_interfaces/requests/index.ts +29 -0
- package/ts_interfaces/requests/logs.ts +58 -0
- package/ts_interfaces/requests/network-targets.ts +127 -0
- package/ts_interfaces/requests/radius.ts +341 -0
- package/ts_interfaces/requests/realtime.ts +59 -0
- package/ts_interfaces/requests/remoteingress.ts +202 -0
- package/ts_interfaces/requests/route-management.ts +194 -0
- package/ts_interfaces/requests/security-policy.ts +144 -0
- package/ts_interfaces/requests/smtp-accounts.ts +163 -0
- package/ts_interfaces/requests/source-profiles.ts +127 -0
- package/ts_interfaces/requests/stats.ts +207 -0
- package/ts_interfaces/requests/target-profiles.ts +130 -0
- package/ts_interfaces/requests/testing.ts +186 -0
- package/ts_interfaces/requests/users.ts +66 -0
- package/ts_interfaces/requests/vpn.ts +238 -0
- package/ts_interfaces/requests/workhoster.ts +100 -0
|
@@ -0,0 +1,341 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import * as authInterfaces from '../data/auth.js';
|
|
3
|
+
|
|
4
|
+
// ============================================================================
|
|
5
|
+
// RADIUS Client Management
|
|
6
|
+
// ============================================================================
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Get all RADIUS clients (NAS devices)
|
|
10
|
+
*/
|
|
11
|
+
export interface IReq_GetRadiusClients extends plugins.typedrequestInterfaces.implementsTR<
|
|
12
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
13
|
+
IReq_GetRadiusClients
|
|
14
|
+
> {
|
|
15
|
+
method: 'getRadiusClients';
|
|
16
|
+
request: {
|
|
17
|
+
identity?: authInterfaces.IIdentity;
|
|
18
|
+
apiToken?: string;
|
|
19
|
+
};
|
|
20
|
+
response: {
|
|
21
|
+
clients: Array<{
|
|
22
|
+
name: string;
|
|
23
|
+
ipRange: string;
|
|
24
|
+
description?: string;
|
|
25
|
+
enabled: boolean;
|
|
26
|
+
}>;
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Add or update a RADIUS client
|
|
32
|
+
*/
|
|
33
|
+
export interface IReq_SetRadiusClient extends plugins.typedrequestInterfaces.implementsTR<
|
|
34
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
35
|
+
IReq_SetRadiusClient
|
|
36
|
+
> {
|
|
37
|
+
method: 'setRadiusClient';
|
|
38
|
+
request: {
|
|
39
|
+
identity?: authInterfaces.IIdentity;
|
|
40
|
+
apiToken?: string;
|
|
41
|
+
client: {
|
|
42
|
+
name: string;
|
|
43
|
+
ipRange: string;
|
|
44
|
+
secret: string;
|
|
45
|
+
description?: string;
|
|
46
|
+
enabled: boolean;
|
|
47
|
+
};
|
|
48
|
+
};
|
|
49
|
+
response: {
|
|
50
|
+
success: boolean;
|
|
51
|
+
message?: string;
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
/**
|
|
56
|
+
* Remove a RADIUS client
|
|
57
|
+
*/
|
|
58
|
+
export interface IReq_RemoveRadiusClient extends plugins.typedrequestInterfaces.implementsTR<
|
|
59
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
60
|
+
IReq_RemoveRadiusClient
|
|
61
|
+
> {
|
|
62
|
+
method: 'removeRadiusClient';
|
|
63
|
+
request: {
|
|
64
|
+
identity?: authInterfaces.IIdentity;
|
|
65
|
+
apiToken?: string;
|
|
66
|
+
name: string;
|
|
67
|
+
};
|
|
68
|
+
response: {
|
|
69
|
+
success: boolean;
|
|
70
|
+
message?: string;
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// ============================================================================
|
|
75
|
+
// VLAN Mapping Management
|
|
76
|
+
// ============================================================================
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Get all MAC-to-VLAN mappings
|
|
80
|
+
*/
|
|
81
|
+
export interface IReq_GetVlanMappings extends plugins.typedrequestInterfaces.implementsTR<
|
|
82
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
83
|
+
IReq_GetVlanMappings
|
|
84
|
+
> {
|
|
85
|
+
method: 'getVlanMappings';
|
|
86
|
+
request: {
|
|
87
|
+
identity?: authInterfaces.IIdentity;
|
|
88
|
+
apiToken?: string;
|
|
89
|
+
};
|
|
90
|
+
response: {
|
|
91
|
+
mappings: Array<{
|
|
92
|
+
mac: string;
|
|
93
|
+
vlan: number;
|
|
94
|
+
description?: string;
|
|
95
|
+
enabled: boolean;
|
|
96
|
+
createdAt: number;
|
|
97
|
+
updatedAt: number;
|
|
98
|
+
}>;
|
|
99
|
+
config: {
|
|
100
|
+
defaultVlan: number;
|
|
101
|
+
allowUnknownMacs: boolean;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* Add or update a VLAN mapping
|
|
108
|
+
*/
|
|
109
|
+
export interface IReq_SetVlanMapping extends plugins.typedrequestInterfaces.implementsTR<
|
|
110
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
111
|
+
IReq_SetVlanMapping
|
|
112
|
+
> {
|
|
113
|
+
method: 'setVlanMapping';
|
|
114
|
+
request: {
|
|
115
|
+
identity?: authInterfaces.IIdentity;
|
|
116
|
+
apiToken?: string;
|
|
117
|
+
mapping: {
|
|
118
|
+
mac: string;
|
|
119
|
+
vlan: number;
|
|
120
|
+
description?: string;
|
|
121
|
+
enabled: boolean;
|
|
122
|
+
};
|
|
123
|
+
};
|
|
124
|
+
response: {
|
|
125
|
+
success: boolean;
|
|
126
|
+
mapping?: {
|
|
127
|
+
mac: string;
|
|
128
|
+
vlan: number;
|
|
129
|
+
description?: string;
|
|
130
|
+
enabled: boolean;
|
|
131
|
+
createdAt: number;
|
|
132
|
+
updatedAt: number;
|
|
133
|
+
};
|
|
134
|
+
message?: string;
|
|
135
|
+
};
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* Remove a VLAN mapping
|
|
140
|
+
*/
|
|
141
|
+
export interface IReq_RemoveVlanMapping extends plugins.typedrequestInterfaces.implementsTR<
|
|
142
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
143
|
+
IReq_RemoveVlanMapping
|
|
144
|
+
> {
|
|
145
|
+
method: 'removeVlanMapping';
|
|
146
|
+
request: {
|
|
147
|
+
identity?: authInterfaces.IIdentity;
|
|
148
|
+
apiToken?: string;
|
|
149
|
+
mac: string;
|
|
150
|
+
};
|
|
151
|
+
response: {
|
|
152
|
+
success: boolean;
|
|
153
|
+
message?: string;
|
|
154
|
+
};
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* Update VLAN configuration
|
|
159
|
+
*/
|
|
160
|
+
export interface IReq_UpdateVlanConfig extends plugins.typedrequestInterfaces.implementsTR<
|
|
161
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
162
|
+
IReq_UpdateVlanConfig
|
|
163
|
+
> {
|
|
164
|
+
method: 'updateVlanConfig';
|
|
165
|
+
request: {
|
|
166
|
+
identity?: authInterfaces.IIdentity;
|
|
167
|
+
apiToken?: string;
|
|
168
|
+
defaultVlan?: number;
|
|
169
|
+
allowUnknownMacs?: boolean;
|
|
170
|
+
};
|
|
171
|
+
response: {
|
|
172
|
+
success: boolean;
|
|
173
|
+
config: {
|
|
174
|
+
defaultVlan: number;
|
|
175
|
+
allowUnknownMacs: boolean;
|
|
176
|
+
};
|
|
177
|
+
};
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* Test VLAN assignment for a MAC address
|
|
182
|
+
*/
|
|
183
|
+
export interface IReq_TestVlanAssignment extends plugins.typedrequestInterfaces.implementsTR<
|
|
184
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
185
|
+
IReq_TestVlanAssignment
|
|
186
|
+
> {
|
|
187
|
+
method: 'testVlanAssignment';
|
|
188
|
+
request: {
|
|
189
|
+
identity?: authInterfaces.IIdentity;
|
|
190
|
+
apiToken?: string;
|
|
191
|
+
mac: string;
|
|
192
|
+
};
|
|
193
|
+
response: {
|
|
194
|
+
assigned: boolean;
|
|
195
|
+
vlan: number;
|
|
196
|
+
isDefault: boolean;
|
|
197
|
+
matchedRule?: {
|
|
198
|
+
mac: string;
|
|
199
|
+
vlan: number;
|
|
200
|
+
description?: string;
|
|
201
|
+
};
|
|
202
|
+
};
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
// ============================================================================
|
|
206
|
+
// Accounting / Session Management
|
|
207
|
+
// ============================================================================
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* Get active RADIUS sessions
|
|
211
|
+
*/
|
|
212
|
+
export interface IReq_GetRadiusSessions extends plugins.typedrequestInterfaces.implementsTR<
|
|
213
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
214
|
+
IReq_GetRadiusSessions
|
|
215
|
+
> {
|
|
216
|
+
method: 'getRadiusSessions';
|
|
217
|
+
request: {
|
|
218
|
+
identity?: authInterfaces.IIdentity;
|
|
219
|
+
apiToken?: string;
|
|
220
|
+
filter?: {
|
|
221
|
+
username?: string;
|
|
222
|
+
nasIpAddress?: string;
|
|
223
|
+
vlanId?: number;
|
|
224
|
+
};
|
|
225
|
+
};
|
|
226
|
+
response: {
|
|
227
|
+
sessions: Array<{
|
|
228
|
+
sessionId: string;
|
|
229
|
+
username: string;
|
|
230
|
+
macAddress?: string;
|
|
231
|
+
nasIpAddress: string;
|
|
232
|
+
nasIdentifier?: string;
|
|
233
|
+
vlanId?: number;
|
|
234
|
+
framedIpAddress?: string;
|
|
235
|
+
startTime: number;
|
|
236
|
+
lastUpdateTime: number;
|
|
237
|
+
status: 'active' | 'stopped' | 'terminated';
|
|
238
|
+
inputOctets: number;
|
|
239
|
+
outputOctets: number;
|
|
240
|
+
sessionTime: number;
|
|
241
|
+
}>;
|
|
242
|
+
totalCount: number;
|
|
243
|
+
};
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Disconnect a RADIUS session
|
|
248
|
+
*/
|
|
249
|
+
export interface IReq_DisconnectRadiusSession extends plugins.typedrequestInterfaces.implementsTR<
|
|
250
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
251
|
+
IReq_DisconnectRadiusSession
|
|
252
|
+
> {
|
|
253
|
+
method: 'disconnectRadiusSession';
|
|
254
|
+
request: {
|
|
255
|
+
identity?: authInterfaces.IIdentity;
|
|
256
|
+
apiToken?: string;
|
|
257
|
+
sessionId: string;
|
|
258
|
+
reason?: string;
|
|
259
|
+
};
|
|
260
|
+
response: {
|
|
261
|
+
success: boolean;
|
|
262
|
+
message?: string;
|
|
263
|
+
};
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
/**
|
|
267
|
+
* Get accounting summary/report
|
|
268
|
+
*/
|
|
269
|
+
export interface IReq_GetRadiusAccountingSummary extends plugins.typedrequestInterfaces.implementsTR<
|
|
270
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
271
|
+
IReq_GetRadiusAccountingSummary
|
|
272
|
+
> {
|
|
273
|
+
method: 'getRadiusAccountingSummary';
|
|
274
|
+
request: {
|
|
275
|
+
identity?: authInterfaces.IIdentity;
|
|
276
|
+
apiToken?: string;
|
|
277
|
+
startTime: number;
|
|
278
|
+
endTime: number;
|
|
279
|
+
};
|
|
280
|
+
response: {
|
|
281
|
+
summary: {
|
|
282
|
+
periodStart: number;
|
|
283
|
+
periodEnd: number;
|
|
284
|
+
totalSessions: number;
|
|
285
|
+
activeSessions: number;
|
|
286
|
+
totalInputBytes: number;
|
|
287
|
+
totalOutputBytes: number;
|
|
288
|
+
totalSessionTime: number;
|
|
289
|
+
averageSessionDuration: number;
|
|
290
|
+
uniqueUsers: number;
|
|
291
|
+
sessionsByVlan: Record<number, number>;
|
|
292
|
+
topUsersByTraffic: Array<{ username: string; totalBytes: number }>;
|
|
293
|
+
};
|
|
294
|
+
};
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
// ============================================================================
|
|
298
|
+
// Statistics
|
|
299
|
+
// ============================================================================
|
|
300
|
+
|
|
301
|
+
/**
|
|
302
|
+
* Get RADIUS server statistics
|
|
303
|
+
*/
|
|
304
|
+
export interface IReq_GetRadiusStatistics extends plugins.typedrequestInterfaces.implementsTR<
|
|
305
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
306
|
+
IReq_GetRadiusStatistics
|
|
307
|
+
> {
|
|
308
|
+
method: 'getRadiusStatistics';
|
|
309
|
+
request: {
|
|
310
|
+
identity?: authInterfaces.IIdentity;
|
|
311
|
+
apiToken?: string;
|
|
312
|
+
};
|
|
313
|
+
response: {
|
|
314
|
+
stats: {
|
|
315
|
+
running: boolean;
|
|
316
|
+
uptime: number;
|
|
317
|
+
authRequests: number;
|
|
318
|
+
authAccepts: number;
|
|
319
|
+
authRejects: number;
|
|
320
|
+
accountingRequests: number;
|
|
321
|
+
activeSessions: number;
|
|
322
|
+
vlanMappings: number;
|
|
323
|
+
clients: number;
|
|
324
|
+
};
|
|
325
|
+
vlanStats: {
|
|
326
|
+
totalMappings: number;
|
|
327
|
+
enabledMappings: number;
|
|
328
|
+
exactMatches: number;
|
|
329
|
+
ouiPatterns: number;
|
|
330
|
+
wildcardPatterns: number;
|
|
331
|
+
};
|
|
332
|
+
accountingStats: {
|
|
333
|
+
activeSessions: number;
|
|
334
|
+
totalSessionsStarted: number;
|
|
335
|
+
totalSessionsStopped: number;
|
|
336
|
+
totalInputBytes: number;
|
|
337
|
+
totalOutputBytes: number;
|
|
338
|
+
interimUpdatesReceived: number;
|
|
339
|
+
};
|
|
340
|
+
};
|
|
341
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import type { IIdentity } from '../data/auth.js';
|
|
3
|
+
|
|
4
|
+
export const opsRealtimeResources = [
|
|
5
|
+
'emailDomains',
|
|
6
|
+
'emailQueue',
|
|
7
|
+
'smtpAttempts',
|
|
8
|
+
'dns',
|
|
9
|
+
'routes',
|
|
10
|
+
'edges',
|
|
11
|
+
'certificates',
|
|
12
|
+
'configEvents',
|
|
13
|
+
] as const;
|
|
14
|
+
|
|
15
|
+
export type TOpsRealtimeResource = (typeof opsRealtimeResources)[number];
|
|
16
|
+
|
|
17
|
+
export type IOpsRealtimeRevisionMap = Record<TOpsRealtimeResource, number>;
|
|
18
|
+
|
|
19
|
+
export interface IOpsRealtimeInvalidation {
|
|
20
|
+
resource: TOpsRealtimeResource;
|
|
21
|
+
revision: number;
|
|
22
|
+
changedIds?: string[];
|
|
23
|
+
reason?: string;
|
|
24
|
+
timestamp: number;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Authenticates the current WebSocket peer and returns anything newer than the
|
|
29
|
+
* client's last accepted revision. The tag is assigned by the server only.
|
|
30
|
+
*/
|
|
31
|
+
export interface IReq_SubscribeOpsRealtime extends plugins.typedrequestInterfaces.implementsTR<
|
|
32
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
33
|
+
IReq_SubscribeOpsRealtime
|
|
34
|
+
> {
|
|
35
|
+
method: 'subscribeOpsRealtime';
|
|
36
|
+
request: {
|
|
37
|
+
identity: IIdentity;
|
|
38
|
+
knownServerEpoch?: string;
|
|
39
|
+
knownRevisions?: Partial<IOpsRealtimeRevisionMap>;
|
|
40
|
+
};
|
|
41
|
+
response: {
|
|
42
|
+
serverEpoch: string;
|
|
43
|
+
revisions: IOpsRealtimeRevisionMap;
|
|
44
|
+
invalidations: IOpsRealtimeInvalidation[];
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/** Server-to-browser notification. Resource data remains behind authenticated reads. */
|
|
49
|
+
export interface IReq_PushOpsRealtimeInvalidation extends plugins.typedrequestInterfaces.implementsTR<
|
|
50
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
51
|
+
IReq_PushOpsRealtimeInvalidation
|
|
52
|
+
> {
|
|
53
|
+
method: 'pushOpsRealtimeInvalidation';
|
|
54
|
+
request: {
|
|
55
|
+
serverEpoch: string;
|
|
56
|
+
invalidations: IOpsRealtimeInvalidation[];
|
|
57
|
+
};
|
|
58
|
+
response: Record<string, never>;
|
|
59
|
+
}
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
import * as plugins from '../plugins.js';
|
|
2
|
+
import * as authInterfaces from '../data/auth.js';
|
|
3
|
+
import type { IRemoteIngress, IRemoteIngressEgressPolicyConfig, IRemoteIngressHubSettings, IRemoteIngressPerformanceConfig, IRemoteIngressStatus } from '../data/remoteingress.js';
|
|
4
|
+
|
|
5
|
+
// ============================================================================
|
|
6
|
+
// Remote Ingress Edge Management
|
|
7
|
+
// ============================================================================
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Create a new remote ingress edge registration.
|
|
11
|
+
*/
|
|
12
|
+
export interface IReq_CreateRemoteIngress extends plugins.typedrequestInterfaces.implementsTR<
|
|
13
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
14
|
+
IReq_CreateRemoteIngress
|
|
15
|
+
> {
|
|
16
|
+
method: 'createRemoteIngress';
|
|
17
|
+
request: {
|
|
18
|
+
identity?: authInterfaces.IIdentity;
|
|
19
|
+
apiToken?: string;
|
|
20
|
+
name: string;
|
|
21
|
+
listenPorts?: number[];
|
|
22
|
+
autoDerivePorts?: boolean;
|
|
23
|
+
performance?: IRemoteIngressPerformanceConfig;
|
|
24
|
+
egress?: IRemoteIngressEgressPolicyConfig;
|
|
25
|
+
tags?: string[];
|
|
26
|
+
publicIp?: string;
|
|
27
|
+
publicIpV6?: string;
|
|
28
|
+
mailHostname?: string;
|
|
29
|
+
};
|
|
30
|
+
response: {
|
|
31
|
+
success: boolean;
|
|
32
|
+
edge: IRemoteIngress;
|
|
33
|
+
/** Failure reason (e.g. rejected publicIp) when success is false. */
|
|
34
|
+
message?: string;
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Delete a remote ingress edge registration.
|
|
40
|
+
*/
|
|
41
|
+
export interface IReq_DeleteRemoteIngress extends plugins.typedrequestInterfaces.implementsTR<
|
|
42
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
43
|
+
IReq_DeleteRemoteIngress
|
|
44
|
+
> {
|
|
45
|
+
method: 'deleteRemoteIngress';
|
|
46
|
+
request: {
|
|
47
|
+
identity?: authInterfaces.IIdentity;
|
|
48
|
+
apiToken?: string;
|
|
49
|
+
id: string;
|
|
50
|
+
};
|
|
51
|
+
response: {
|
|
52
|
+
success: boolean;
|
|
53
|
+
message?: string;
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* Update a remote ingress edge registration.
|
|
59
|
+
*/
|
|
60
|
+
export interface IReq_UpdateRemoteIngress extends plugins.typedrequestInterfaces.implementsTR<
|
|
61
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
62
|
+
IReq_UpdateRemoteIngress
|
|
63
|
+
> {
|
|
64
|
+
method: 'updateRemoteIngress';
|
|
65
|
+
request: {
|
|
66
|
+
identity?: authInterfaces.IIdentity;
|
|
67
|
+
apiToken?: string;
|
|
68
|
+
id: string;
|
|
69
|
+
name?: string;
|
|
70
|
+
listenPorts?: number[];
|
|
71
|
+
autoDerivePorts?: boolean;
|
|
72
|
+
enabled?: boolean;
|
|
73
|
+
performance?: IRemoteIngressPerformanceConfig;
|
|
74
|
+
egress?: IRemoteIngressEgressPolicyConfig;
|
|
75
|
+
tags?: string[];
|
|
76
|
+
/** null clears the stored value. */
|
|
77
|
+
publicIp?: string | null;
|
|
78
|
+
publicIpV6?: string | null;
|
|
79
|
+
mailHostname?: string | null;
|
|
80
|
+
};
|
|
81
|
+
response: {
|
|
82
|
+
success: boolean;
|
|
83
|
+
edge: IRemoteIngress;
|
|
84
|
+
/** Failure reason (e.g. rejected publicIp) when success is false. */
|
|
85
|
+
message?: string;
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* Regenerate the secret for a remote ingress edge.
|
|
91
|
+
*/
|
|
92
|
+
export interface IReq_RegenerateRemoteIngressSecret extends plugins.typedrequestInterfaces.implementsTR<
|
|
93
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
94
|
+
IReq_RegenerateRemoteIngressSecret
|
|
95
|
+
> {
|
|
96
|
+
method: 'regenerateRemoteIngressSecret';
|
|
97
|
+
request: {
|
|
98
|
+
identity?: authInterfaces.IIdentity;
|
|
99
|
+
apiToken?: string;
|
|
100
|
+
id: string;
|
|
101
|
+
};
|
|
102
|
+
response: {
|
|
103
|
+
success: boolean;
|
|
104
|
+
secret: string;
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
/**
|
|
109
|
+
* Get all remote ingress edge registrations.
|
|
110
|
+
*/
|
|
111
|
+
export interface IReq_GetRemoteIngresses extends plugins.typedrequestInterfaces.implementsTR<
|
|
112
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
113
|
+
IReq_GetRemoteIngresses
|
|
114
|
+
> {
|
|
115
|
+
method: 'getRemoteIngresses';
|
|
116
|
+
request: {
|
|
117
|
+
identity?: authInterfaces.IIdentity;
|
|
118
|
+
apiToken?: string;
|
|
119
|
+
};
|
|
120
|
+
response: {
|
|
121
|
+
edges: IRemoteIngress[];
|
|
122
|
+
};
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Get runtime status of all remote ingress edges.
|
|
127
|
+
*/
|
|
128
|
+
export interface IReq_GetRemoteIngressStatus extends plugins.typedrequestInterfaces.implementsTR<
|
|
129
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
130
|
+
IReq_GetRemoteIngressStatus
|
|
131
|
+
> {
|
|
132
|
+
method: 'getRemoteIngressStatus';
|
|
133
|
+
request: {
|
|
134
|
+
identity?: authInterfaces.IIdentity;
|
|
135
|
+
apiToken?: string;
|
|
136
|
+
};
|
|
137
|
+
response: {
|
|
138
|
+
statuses: IRemoteIngressStatus[];
|
|
139
|
+
};
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* Get a connection token for a remote ingress edge.
|
|
144
|
+
* The token is a single opaque base64url string that encodes hubHost, hubPort, edgeId, and secret.
|
|
145
|
+
*/
|
|
146
|
+
export interface IReq_GetRemoteIngressConnectionToken extends plugins.typedrequestInterfaces.implementsTR<
|
|
147
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
148
|
+
IReq_GetRemoteIngressConnectionToken
|
|
149
|
+
> {
|
|
150
|
+
method: 'getRemoteIngressConnectionToken';
|
|
151
|
+
request: {
|
|
152
|
+
identity?: authInterfaces.IIdentity;
|
|
153
|
+
apiToken?: string;
|
|
154
|
+
edgeId: string;
|
|
155
|
+
hubHost?: string;
|
|
156
|
+
};
|
|
157
|
+
response: {
|
|
158
|
+
success: boolean;
|
|
159
|
+
token?: string;
|
|
160
|
+
message?: string;
|
|
161
|
+
};
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* Get hub-level RemoteIngress settings.
|
|
166
|
+
*/
|
|
167
|
+
export interface IReq_GetRemoteIngressHubSettings extends plugins.typedrequestInterfaces.implementsTR<
|
|
168
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
169
|
+
IReq_GetRemoteIngressHubSettings
|
|
170
|
+
> {
|
|
171
|
+
method: 'getRemoteIngressHubSettings';
|
|
172
|
+
request: {
|
|
173
|
+
identity?: authInterfaces.IIdentity;
|
|
174
|
+
apiToken?: string;
|
|
175
|
+
};
|
|
176
|
+
response: {
|
|
177
|
+
settings: IRemoteIngressHubSettings;
|
|
178
|
+
};
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* Update hub-level RemoteIngress settings.
|
|
183
|
+
*/
|
|
184
|
+
export interface IReq_UpdateRemoteIngressHubSettings extends plugins.typedrequestInterfaces.implementsTR<
|
|
185
|
+
plugins.typedrequestInterfaces.ITypedRequest,
|
|
186
|
+
IReq_UpdateRemoteIngressHubSettings
|
|
187
|
+
> {
|
|
188
|
+
method: 'updateRemoteIngressHubSettings';
|
|
189
|
+
request: {
|
|
190
|
+
identity?: authInterfaces.IIdentity;
|
|
191
|
+
apiToken?: string;
|
|
192
|
+
enabled?: boolean;
|
|
193
|
+
tunnelPort?: number;
|
|
194
|
+
hubDomain?: string | null;
|
|
195
|
+
performance?: IRemoteIngressPerformanceConfig | null;
|
|
196
|
+
};
|
|
197
|
+
response: {
|
|
198
|
+
success: boolean;
|
|
199
|
+
settings?: IRemoteIngressHubSettings;
|
|
200
|
+
message?: string;
|
|
201
|
+
};
|
|
202
|
+
}
|