Skip to content

Service

system_service_things

ServiceMixin

Bases: BasePFSenseAPIClient

mixin to add all the various service calls

Source code in pfsense_api_client/service/__init__.py
 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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
class ServiceMixin(BasePFSenseAPIClient):
    """ mixin to add all the various service calls """
    def get_service(
        self, **filterargs: Dict[str, Any]
    ) -> APIResponse:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-services"""
        url = "/api/v1/services"
        return self.call_api(url, payload=filterargs)


    def restart_all_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-all-services"""
        url = "/api/v1/services/restart"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def start_all_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-all-services"""
        url = "/api/v1/services/start"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def stop_all_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-all-services"""
        url = "/api/v1/services/stop"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def get_dhcpd_service_configuration(
        self, **filterargs: Dict[str, Any]
    ) -> APIResponse:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-dhcpd-service-configuration"""
        url = "/api/v1/services/dhcpd"
        return self.call_api(url, payload=filterargs)


    def restart_dhcpd_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-dhcpd-service_"""
        url = "/api/v1/services/dhcpd/restart"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def start_dhcpd_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-dhcpd-service_"""
        url = "/api/v1/services/dhcpd/start"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def stop_dhcpd_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-dhcpd-service_"""
        url = "/api/v1/services/dhcpd/stop"
        method = "POST"
        response: Response = self.call(url=url, method=method, payload=args)
        return response


    def update_dhcpd_service_configuration(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-update-dhcpd-service-configuration"""
        url = "/api/v1/services/dhcpd"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def get_dhcpd_leases(
        self, **filterargs: Dict[str, Any]
    ) -> APIResponse:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-dhcpd-leases"""
        url = "/api/v1/services/dhcpd/lease"
        return self.call_api_dict(url, payload=filterargs)


    def create_dhcpd_static_mappings(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-dhcpd-static-mappings"""
        url = "/api/v1/services/dhcpd/static_mapping"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def delete_dhcpd_static_mappings(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-dhcpd-static-mappings"""
        url = "/api/v1/services/dhcpd/static_mapping"
        method = "DELETE"
        return self.call(url=url, method=method, payload=args)


    def get_dhcpd_static_mappings(
        self, *filterargs: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-dhcpd-static-mappings"""
        url = "/api/v1/services/dhcpd/static_mapping"
        return self.call(url, payload=filterargs)


    def update_dhcpd_static_mappings(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-update-dhcpd-static-mappings"""
        url = "/api/v1/services/dhcpd/static_mapping"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def restart_dnsmasq_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-restart-dnsmasq-service_"""
        url = "/api/v1/services/dnsmasq/restart"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def start_dnsmasq_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-start-dnsmasq-service_"""
        url = "/api/v1/services/dnsmasq/start"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def stop_dnsmasq_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-stop-dnsmasq-service_"""
        url = "/api/v1/services/dnsmasq/stop"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def restart_dpinger_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-restart-dpinger-service_"""
        url = "/api/v1/services/dpinger/restart"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def start_dpinger_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-start-dpinger-service_"""
        url = "/api/v1/services/dpinger/start"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def stop_dpinger_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-stop-dpinger-service_"""
        url = "/api/v1/services/dpinger/stop"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def get_ntpd_service(
        self, *filterargs: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-ntpd-service_"""
        url = "/api/v1/services/ntpd"
        return self.call(url, payload=filterargs)


    def restart_ntpd_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-ntpd-service_"""
        url = "/api/v1/services/ntpd/restart"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def start_ntpd_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-ntpd-service_"""
        url = "/api/v1/services/ntpd/start"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def stop_ntpd_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-ntpd-service_"""
        url = "/api/v1/services/ntpd/stop"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def update_ntpd_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-update-ntpd-service_"""
        url = "/api/v1/services/ntpd"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def create_ntpd_time_server(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-ntpd-time-server"""
        url = "/api/v1/services/ntpd/time_server"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def delete_ntpd_time_server(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-ntpd-time-server"""
        url = "/api/v1/services/ntpd/time_server"
        method = "DELETE"
        return self.call(url=url, method=method, payload=args)


    def create_openvpn_client_specific_overrides(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-openvpn-client-specific-overrides"""
        url = "/api/v1/services/openvpn/csc"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def delete_openvpn_client_specific_override(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-openvpn-client-specific-override"""
        url = "/api/v1/services/openvpn/csc"
        method = "DELETE"
        return self.call(url=url, method=method, payload=args)


    def get_openvpn_client_specific_overrides(
        self, *filterargs: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-openvpn-client-specific-overrides"""
        url = "/api/v1/services/openvpn/csc"
        return self.call(url, payload=filterargs)


    def update_openvpn_client_specific_overrides(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-update-openvpn-client-specific-overrides"""
        url = "/api/v1/services/openvpn/csc"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def get_sshd_configuration(
        self, *filterargs: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-sshd-configuration"""
        url = "/api/v1/services/sshd"
        return self.call(url, payload=filterargs)


    def restart_sshd_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-sshd-service_"""
        url = "/api/v1/services/sshd/restart"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def start_sshd_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-sshd-service_"""
        url = "/api/v1/services/sshd/start"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def stop_sshd_service(self, **args: Dict[str, Any]) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-sshd-service_"""
        url = "/api/v1/services/sshd/stop"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def update_sshd_configuration(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-update-sshd-configuration"""
        url = "/api/v1/services/sshd"
        method = "PUT"
        return self.call(url=url, method=method, payload=args)


    def restart_syslogd_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-restart-syslogd-service_"""
        url = "/api/v1/services/syslogd/restart"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def start_syslogd_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-start-syslogd-service_"""
        url = "/api/v1/services/syslogd/start"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def stop_syslogd_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-stop-syslogd-service_"""
        url = "/api/v1/services/syslogd/stop"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def restart_unbound_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-restart-unbound-service_"""
        url = "/api/v1/services/unbound/restart"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def start_unbound_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-start-unbound-service_"""
        url = "/api/v1/services/unbound/start"
        method = "POST"
        return self.call(url=url, method=method, payload=args)


    def stop_unbound_service(
        self, **args: Dict[str, Any]
    ) -> Response:
        """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-stop-unbound-service_"""
        url = "/api/v1/services/unbound/stop"
        method = "POST"
        return self.call(url=url, method=method, payload=args)

create_dhcpd_static_mappings(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-dhcpd-static-mappings

Source code in pfsense_api_client/service/__init__.py
91
92
93
94
95
96
97
def create_dhcpd_static_mappings(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-dhcpd-static-mappings"""
    url = "/api/v1/services/dhcpd/static_mapping"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

create_ntpd_time_server(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-ntpd-time-server

Source code in pfsense_api_client/service/__init__.py
218
219
220
221
222
223
224
def create_ntpd_time_server(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-ntpd-time-server"""
    url = "/api/v1/services/ntpd/time_server"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

create_openvpn_client_specific_overrides(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-openvpn-client-specific-overrides

Source code in pfsense_api_client/service/__init__.py
236
237
238
239
240
241
242
def create_openvpn_client_specific_overrides(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-create-openvpn-client-specific-overrides"""
    url = "/api/v1/services/openvpn/csc"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

delete_dhcpd_static_mappings(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-dhcpd-static-mappings

Source code in pfsense_api_client/service/__init__.py
100
101
102
103
104
105
106
def delete_dhcpd_static_mappings(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-dhcpd-static-mappings"""
    url = "/api/v1/services/dhcpd/static_mapping"
    method = "DELETE"
    return self.call(url=url, method=method, payload=args)

delete_ntpd_time_server(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-ntpd-time-server

Source code in pfsense_api_client/service/__init__.py
227
228
229
230
231
232
233
def delete_ntpd_time_server(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-ntpd-time-server"""
    url = "/api/v1/services/ntpd/time_server"
    method = "DELETE"
    return self.call(url=url, method=method, payload=args)

delete_openvpn_client_specific_override(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-openvpn-client-specific-override

Source code in pfsense_api_client/service/__init__.py
245
246
247
248
249
250
251
def delete_openvpn_client_specific_override(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-delete-openvpn-client-specific-override"""
    url = "/api/v1/services/openvpn/csc"
    method = "DELETE"
    return self.call(url=url, method=method, payload=args)

get_dhcpd_leases(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-dhcpd-leases

Source code in pfsense_api_client/service/__init__.py
83
84
85
86
87
88
def get_dhcpd_leases(
    self, **filterargs: Dict[str, Any]
) -> APIResponse:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-dhcpd-leases"""
    url = "/api/v1/services/dhcpd/lease"
    return self.call_api_dict(url, payload=filterargs)

get_dhcpd_service_configuration(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-dhcpd-service-configuration

Source code in pfsense_api_client/service/__init__.py
42
43
44
45
46
47
def get_dhcpd_service_configuration(
    self, **filterargs: Dict[str, Any]
) -> APIResponse:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-dhcpd-service-configuration"""
    url = "/api/v1/services/dhcpd"
    return self.call_api(url, payload=filterargs)

get_dhcpd_static_mappings(*filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-dhcpd-static-mappings

Source code in pfsense_api_client/service/__init__.py
109
110
111
112
113
114
def get_dhcpd_static_mappings(
    self, *filterargs: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-dhcpd-static-mappings"""
    url = "/api/v1/services/dhcpd/static_mapping"
    return self.call(url, payload=filterargs)

get_ntpd_service(*filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-ntpd-service_

Source code in pfsense_api_client/service/__init__.py
180
181
182
183
184
185
def get_ntpd_service(
    self, *filterargs: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-ntpd-service_"""
    url = "/api/v1/services/ntpd"
    return self.call(url, payload=filterargs)

get_openvpn_client_specific_overrides(*filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-openvpn-client-specific-overrides

Source code in pfsense_api_client/service/__init__.py
254
255
256
257
258
259
def get_openvpn_client_specific_overrides(
    self, *filterargs: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-read-openvpn-client-specific-overrides"""
    url = "/api/v1/services/openvpn/csc"
    return self.call(url, payload=filterargs)

get_service(**filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-services

Source code in pfsense_api_client/service/__init__.py
13
14
15
16
17
18
def get_service(
    self, **filterargs: Dict[str, Any]
) -> APIResponse:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-services"""
    url = "/api/v1/services"
    return self.call_api(url, payload=filterargs)

get_sshd_configuration(*filterargs)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-sshd-configuration

Source code in pfsense_api_client/service/__init__.py
271
272
273
274
275
276
def get_sshd_configuration(
    self, *filterargs: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-read-sshd-configuration"""
    url = "/api/v1/services/sshd"
    return self.call(url, payload=filterargs)

restart_all_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-all-services

Source code in pfsense_api_client/service/__init__.py
21
22
23
24
25
def restart_all_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-all-services"""
    url = "/api/v1/services/restart"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

restart_dhcpd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-dhcpd-service_

Source code in pfsense_api_client/service/__init__.py
50
51
52
53
54
55
56
def restart_dhcpd_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-dhcpd-service_"""
    url = "/api/v1/services/dhcpd/restart"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

restart_dnsmasq_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-restart-dnsmasq-service_

Source code in pfsense_api_client/service/__init__.py
126
127
128
129
130
131
132
def restart_dnsmasq_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-restart-dnsmasq-service_"""
    url = "/api/v1/services/dnsmasq/restart"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

restart_dpinger_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-restart-dpinger-service_

Source code in pfsense_api_client/service/__init__.py
153
154
155
156
157
158
159
def restart_dpinger_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-restart-dpinger-service_"""
    url = "/api/v1/services/dpinger/restart"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

restart_ntpd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-ntpd-service_

Source code in pfsense_api_client/service/__init__.py
188
189
190
191
192
193
194
def restart_ntpd_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-ntpd-service_"""
    url = "/api/v1/services/ntpd/restart"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

restart_sshd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-sshd-service_

Source code in pfsense_api_client/service/__init__.py
279
280
281
282
283
284
285
def restart_sshd_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-restart-sshd-service_"""
    url = "/api/v1/services/sshd/restart"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

restart_syslogd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-restart-syslogd-service_

Source code in pfsense_api_client/service/__init__.py
311
312
313
314
315
316
317
def restart_syslogd_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#1-restart-syslogd-service_"""
    url = "/api/v1/services/syslogd/restart"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

restart_unbound_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-restart-unbound-service_

Source code in pfsense_api_client/service/__init__.py
338
339
340
341
342
343
344
def restart_unbound_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-restart-unbound-service_"""
    url = "/api/v1/services/unbound/restart"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

start_all_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-all-services

Source code in pfsense_api_client/service/__init__.py
28
29
30
31
32
def start_all_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-all-services"""
    url = "/api/v1/services/start"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

start_dhcpd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-dhcpd-service_

Source code in pfsense_api_client/service/__init__.py
59
60
61
62
63
def start_dhcpd_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-dhcpd-service_"""
    url = "/api/v1/services/dhcpd/start"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

start_dnsmasq_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-start-dnsmasq-service_

Source code in pfsense_api_client/service/__init__.py
135
136
137
138
139
140
141
def start_dnsmasq_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-start-dnsmasq-service_"""
    url = "/api/v1/services/dnsmasq/start"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

start_dpinger_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-start-dpinger-service_

Source code in pfsense_api_client/service/__init__.py
162
163
164
165
166
167
168
def start_dpinger_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-start-dpinger-service_"""
    url = "/api/v1/services/dpinger/start"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

start_ntpd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-ntpd-service_

Source code in pfsense_api_client/service/__init__.py
197
198
199
200
201
def start_ntpd_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-ntpd-service_"""
    url = "/api/v1/services/ntpd/start"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

start_sshd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-sshd-service_

Source code in pfsense_api_client/service/__init__.py
288
289
290
291
292
def start_sshd_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-start-sshd-service_"""
    url = "/api/v1/services/sshd/start"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

start_syslogd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-start-syslogd-service_

Source code in pfsense_api_client/service/__init__.py
320
321
322
323
324
325
326
def start_syslogd_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#2-start-syslogd-service_"""
    url = "/api/v1/services/syslogd/start"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

start_unbound_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-start-unbound-service_

Source code in pfsense_api_client/service/__init__.py
347
348
349
350
351
352
353
def start_unbound_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-start-unbound-service_"""
    url = "/api/v1/services/unbound/start"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

stop_all_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-all-services

Source code in pfsense_api_client/service/__init__.py
35
36
37
38
39
def stop_all_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-all-services"""
    url = "/api/v1/services/stop"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

stop_dhcpd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-dhcpd-service_

Source code in pfsense_api_client/service/__init__.py
66
67
68
69
70
71
def stop_dhcpd_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-dhcpd-service_"""
    url = "/api/v1/services/dhcpd/stop"
    method = "POST"
    response: Response = self.call(url=url, method=method, payload=args)
    return response

stop_dnsmasq_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-stop-dnsmasq-service_

Source code in pfsense_api_client/service/__init__.py
144
145
146
147
148
149
150
def stop_dnsmasq_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-stop-dnsmasq-service_"""
    url = "/api/v1/services/dnsmasq/stop"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

stop_dpinger_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-stop-dpinger-service_

Source code in pfsense_api_client/service/__init__.py
171
172
173
174
175
176
177
def stop_dpinger_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-stop-dpinger-service_"""
    url = "/api/v1/services/dpinger/stop"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

stop_ntpd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-ntpd-service_

Source code in pfsense_api_client/service/__init__.py
204
205
206
207
208
def stop_ntpd_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-ntpd-service_"""
    url = "/api/v1/services/ntpd/stop"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

stop_sshd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-sshd-service_

Source code in pfsense_api_client/service/__init__.py
295
296
297
298
299
def stop_sshd_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-stop-sshd-service_"""
    url = "/api/v1/services/sshd/stop"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

stop_syslogd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-stop-syslogd-service_

Source code in pfsense_api_client/service/__init__.py
329
330
331
332
333
334
335
def stop_syslogd_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#3-stop-syslogd-service_"""
    url = "/api/v1/services/syslogd/stop"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

stop_unbound_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-stop-unbound-service_

Source code in pfsense_api_client/service/__init__.py
356
357
358
359
360
361
362
def stop_unbound_service(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-stop-unbound-service_"""
    url = "/api/v1/services/unbound/stop"
    method = "POST"
    return self.call(url=url, method=method, payload=args)

update_dhcpd_service_configuration(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-update-dhcpd-service-configuration

Source code in pfsense_api_client/service/__init__.py
74
75
76
77
78
79
80
def update_dhcpd_service_configuration(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-update-dhcpd-service-configuration"""
    url = "/api/v1/services/dhcpd"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)

update_dhcpd_static_mappings(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-update-dhcpd-static-mappings

Source code in pfsense_api_client/service/__init__.py
117
118
119
120
121
122
123
def update_dhcpd_static_mappings(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-update-dhcpd-static-mappings"""
    url = "/api/v1/services/dhcpd/static_mapping"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)

update_ntpd_service(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-update-ntpd-service_

Source code in pfsense_api_client/service/__init__.py
211
212
213
214
215
def update_ntpd_service(self, **args: Dict[str, Any]) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-update-ntpd-service_"""
    url = "/api/v1/services/ntpd"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)

update_openvpn_client_specific_overrides(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-update-openvpn-client-specific-overrides

Source code in pfsense_api_client/service/__init__.py
262
263
264
265
266
267
268
def update_openvpn_client_specific_overrides(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#4-update-openvpn-client-specific-overrides"""
    url = "/api/v1/services/openvpn/csc"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)

update_sshd_configuration(**args)

https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-update-sshd-configuration

Source code in pfsense_api_client/service/__init__.py
302
303
304
305
306
307
308
def update_sshd_configuration(
    self, **args: Dict[str, Any]
) -> Response:
    """https://github.com/jaredhendrickson13/pfsense-api/blob/master/README.md#5-update-sshd-configuration"""
    url = "/api/v1/services/sshd"
    method = "PUT"
    return self.call(url=url, method=method, payload=args)