Merge pull request #1 from jaredhendrickson13/master

fork update

README.md

@@ -4445,7 +4445,7 @@ URL: https://{{$hostname}}/api/v1/services/dhcpd/stop
 Update the current DHCPd configuration.<br>
 
 
-_Requires at least one of the following privileges:_ [`page-all`, `page-services-dhcpserverpage-services-dhcpserver`]
+_Requires at least one of the following privileges:_ [`page-all`, `page-services-dhcpserver`]
 
 
 ***Endpoint:***
@@ -4463,14 +4463,15 @@ URL: https://{{$hostname}}/api/v1/services/dhcpd
 | --- | ------|-------------|
 | interface | string | Specify which interface's DHCP configuration to update. You may specify either the interface's descriptive name, the pfSense ID (wan, lan, optx), or the physical interface id (e.g. igb0). This Interface must host a static IPv4 subnet that has more than one available within the subnet. |
 | enable | boolean | Enable or disable the DHCP server for this Interface (optional) |
-| range_from | string | Update the DHCP pool's start IPv4 address. This must be an available address within the Interface's subnet and be less than the `range_to` value. (optional) |
-| range_to | string | Update the DHCP pool's end IPv4 address. This must be an available address within the Interface's subnet and be greater than the `range_from` value. (optional) |
+| range_from | string | Update the DHCP pool's start IPv4 address. This must be an available address within the Interface's subnet and be less than the `range_to` value. This field is required if no DHCP range has been set previously. (conditional) |
+| range_to | string | Update the DHCP pool's end IPv4 address. This must be an available address within the Interface's subnet and be greater than the `range_from` value. This field is required if no DHCP range has been set previously. (conditional) |
 | dnsserver | string or array | Update the DNS servers to include In DHCP leases. Multiple values may be passed in as an array or single values may be passed in as a string. Each value must be a valid IPv4 address. Alternatively, you may pass In an empty array to revert to the system default. (optional) |
 | domain | string | Update the domain name to Include In the DHCP lease. This must be a valid domain name or an empty string to assume the system default (optional) |
 | domainsearchlist | string or array | Update the search domains to include In the DHCP lease. You may pass In an array for multiple entries or a string for single entries. Each entry must be a valid domain name. (optional) |
 | mac_allow | string or array | Update the list of allowed MAC addresses. You may pass In an array for multiple entries or a string for single entries. Each entry must be a full or partial MAC address. Alternatively, you may specify an empty array to revert to default (optional) |
 | mac_deny | string or array | Update the list of denied MAC addresses. You may pass In an array for multiple entries or a string for single entries. Each entry must be a full or partial MAC address. Alternatively, you may specify an empty array to revert to default (optional) |
 | gateway | string | Update the gateway to include In DHCP leases. This value must be a valid IPv4 address within the Interface's subnet. Alternatively, you can pass In an empty string to revert to the system default. (optional) |
+| staticarp | boolean | Update whether the system should use static ARP entries on the associated interface. This option will persist even when DHCP is disabled. *Note: issues have been reported when interacting with this field via API, a separate call to initiate `/etc/rc.reload_interfaces` may be required afterwards which can be done via the /api/v1/diagnostics/command_prompt endpoint.* (optional) |
 | ignorebootp | boolean | Update whether or not to ignore BOOTP requests. True to Ignore, false to allow. (optional) |
 | denyunknown | boolean | Update whether or not to ignore unknown MAC addresses. If true, you must specify MAC addresses in the `mac_allow` field or add a static DHCP entry to receive DHCP requests. (optional) |
 

pfSense-pkg-API/files/etc/inc/api/endpoints/APIAccessToken.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -23,4 +23,4 @@ class APIAccessToken extends APIEndpoint {
     protected function post() {
         return (new APIAccessTokenCreate())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIDiagnosticsCommandPrompt.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallAlias.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -36,4 +36,4 @@ class APIFirewallAlias extends APIEndpoint {
         return (new APIFirewallAliasDelete())->call();
     }
 
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallAliasEntry.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -28,4 +28,4 @@ class APIFirewallAliasEntry extends APIEndpoint {
         return (new APIFirewallAliasEntryDelete())->call();
     }
 
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallApply.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -23,4 +23,4 @@ class APIFirewallApply extends APIEndpoint {
     protected function post() {
         return (new APIFirewallApplyCreate())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallNATOneToOne.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -36,4 +36,4 @@ class APIFirewallNATOneToOne extends APIEndpoint {
         return (new APIFirewallNATOneToOneDelete())->call();
     }
 
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallNATOutbound.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -27,4 +27,4 @@ class APIFirewallNATOutbound extends APIEndpoint {
     protected function put() {
         return (new APIFirewallNATOutboundUpdate())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallNATOutboundMapping.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -35,4 +35,4 @@ class APIFirewallNATOutboundMapping extends APIEndpoint {
     protected function delete() {
         return (new APIFirewallNATOutboundMappingDelete())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallNATPortForward.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -36,4 +36,4 @@ class APIFirewallNATPortForward extends APIEndpoint {
         return (new APIFirewallNATPortForwardDelete())->call();
     }
 
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallRule.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -36,4 +36,4 @@ class APIFirewallRule extends APIEndpoint {
         return (new APIFirewallRuleDelete())->call();
     }
 
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallRuleFlush.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallSchedule.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -35,4 +35,4 @@ class APIFirewallSchedule extends APIEndpoint {
     protected function delete() {
         return (new APIFirewallScheduleDelete())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallScheduleTimeRange.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -27,4 +27,4 @@ class APIFirewallScheduleTimeRange extends APIEndpoint {
     protected function delete() {
         return (new APIFirewallScheduleTimeRangeDelete())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallStates.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -23,4 +23,4 @@ class APIFirewallStates extends APIEndpoint {
     protected function get() {
         return (new APIFirewallStatesRead())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallStatesSize.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -27,4 +27,4 @@ class APIFirewallStatesSize extends APIEndpoint {
     protected function put() {
         return (new APIFirewallStatesSizeUpdate())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaper.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -35,4 +35,4 @@ class APIFirewallTrafficShaper extends APIEndpoint {
     protected function delete() {
         return (new APIFirewallTrafficShaperDelete())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaperLimiter.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -31,4 +31,4 @@ class APIFirewallTrafficShaperLimiter extends APIEndpoint {
     protected function delete() {
         return (new APIFirewallTrafficShaperLimiterDelete())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaperLimiterBandwidth.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -27,4 +27,4 @@ class APIFirewallTrafficShaperLimiterBandwidth extends APIEndpoint {
     protected function delete() {
         return (new APIFirewallTrafficShaperLimiterBandwidthDelete())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaperLimiterQueue.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -27,4 +27,4 @@ class APIFirewallTrafficShaperLimiterQueue extends APIEndpoint {
     protected function delete() {
         return (new APIFirewallTrafficShaperLimiterQueueDelete())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallTrafficShaperQueue.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -27,4 +27,4 @@ class APIFirewallTrafficShaperQueue extends APIEndpoint {
     protected function delete() {
         return (new APIFirewallTrafficShaperQueueDelete())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallVirtualIP.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -36,4 +36,4 @@ class APIFirewallVirtualIP extends APIEndpoint {
         return (new APIFirewallVirtualIPDelete())->call();
     }
 
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIInterface.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -36,4 +36,4 @@ class APIInterface extends APIEndpoint {
         return (new APIInterfaceDelete())->call();
     }
 
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIInterfaceApply.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -23,4 +23,4 @@ class APIInterfaceApply extends APIEndpoint {
     protected function post() {
         return (new APIInterfaceApplyCreate())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIInterfaceBridge.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.

pfSense-pkg-API/files/etc/inc/api/endpoints/APIInterfaceVLAN.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -36,4 +36,4 @@ class APIInterfaceVLAN extends APIEndpoint {
         return (new APIInterfaceVLANDelete())->call();
     }
 
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIRoutingApply.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -23,4 +23,4 @@ class APIRoutingApply extends APIEndpoint {
     protected function post() {
         return (new APIRoutingApplyCreate())->call();
     }
-}
+}

pfSense-pkg-API/files/etc/inc/api/endpoints/APIRoutingGateway.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.

pfSense-pkg-API/files/etc/inc/api/endpoints/APIRoutingGatewayDetail.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.

pfSense-pkg-API/files/etc/inc/api/endpoints/APIRoutingStaticRoute.inc

@@ -1,5 +1,5 @@
 <?php
-//   Copyright 2021 Jared Hendrickson
+//   Copyright 2022 Jared Hendrickson
 //
 //   Licensed under the Apache License, Version 2.0 (the "License");
 //   you may not use this file except in compliance with the License.
@@ -35,4 +35,4 @@ class APIRoutingStaticRoute extends APIEndpoint {
     protected function delete() {
         return (new APIRoutingStaticRouteDelete())->call();
     }
-}
+}