FNGi DHCPatriot Version 6, Operation Manual

Page: 89 / 104

List Static IP Assignments
This API call returns an XML list of the Standard DHCP Actions -> Static IP Assignment
in the Web Administration Interface. A sample of the result is shown below:
<result>
! <record>
! ! <SharedNetwork>test</SharedNetwork>
! ! <StaticSubnet>1.1.1.0/24</StaticSubnet>
! ! <Identifier>John Doe</Identifier>
! ! <IPAddress>1.1.1.10</IPAddress>
! ! <TypeofMatch>Circuit ID</TypeofMatch>
! ! <MatchString>1/4/ethernet42/vlan4</MatchString>
! ! <TFTPFile/>
! ! <id>34288</id>
! </record>
</result>
The GET URL is as follows: https://patriot.network1.net/cli/?
function=StaticIPassign&username=[user]&password=[pass]&ACTION=LIST
A properly formatted URL would look something like this: https://patriot.network1.net/
cli/?function=StaticIPassign&username=apiuser&password=apipass&ACTION=LIST
Add Static IP Assignment
This allows a Standard Static Assignment to be added via the API. Standard Static
Assignment can be found in the Web Administration Interface under Standard DHCP
Actions. Please note that an id of the appropriate subnet must be obtained from the Get
Network Config API call to be used during the add.
The GET URL is as follows: https://patriot.network1.net/cli/?
function=StaticIPassign&username=apiuser&password=apipass&ACTION=ADD&Static
SubnetID=[some id]&Ident=[some text]&IP=[some ip]&MatchType=[REMOTE_MAC/
agent_circuit_id/agent_remote_id]&MatchString=[some match string]&TFTPfile=[some
tftp file]
StaticSubnetID, IP, MatchType and MatchString are all required fields. Ident
and TFTPfile are optional.
A properly formatted URL looks like: https://patriot.network1.net/cli/?
function=StaticIPassign&username=apiuser&password=apipass&ACTION=ADD&Static
SubnetID=3&Ident=Jose
%20Aldo&IP=10.22.22.3&MatchType=REMOTE_MAC&MatchString=99:98:97:00:01:02
&TFTPfile=PlusSign.png
Chapter 11: Remote Access API 89
DHCPatriot Version 6 Operations Manual This document © 2017 First Network Group Inc. All Rights Reserved