FNGi DHCPatriot Version 6, Руководство по эксплуатации

Страница: 78 / 104

Error(s): user james not found user john not found user joe not found
Enable Device
This allows a suspended user’s devices to be enabled on the DHCPatriot system. It will
enable all devices belonging to the specified username. The default admin level
required for this feature is five. This would be the same as using the enable user link in
the Suspend User function on the Web Administration Interface. As of 5.3.0, you can
pass a MAC address instead of a username to enable a single device. As of version
5.4.0, you can include the optional parameter AuthTest=true to force the DHCPatriot to
attempt to authenticate the user before enabling them as is done when using the
Suspend User web interface.
The GET string to send is as follows: https://patriot.[domain]/cli/?
function=SuspendEnable&username=[username]&password=[password]&action=unsus
pend&user=[username to enable]&mac=[MAC address to be enabled]&AuthTest=true
Here is an example of what a properly formatted URL might look like for enable user:
https://patriot.network1.net/cli/?
function=SuspendEnable&username=apiuser&password=apipass&action=unsuspend&
user=linux
Success will present the text RETURN=1. Failure will present RETURN=0 with some
text given below as a reason for the failure.
Search Authenticated Devices
This provides an API method to access the list of authenticated devices and search it
based on several parameters such as MAC address, admin note, username, address
type, and current online status. The return data is provided in XML format.
The GET string to send is as follows: https://patriot.[domain]/cli/?
function=SearchAuthDevices&username=[apiusername]&password=[apipassword]&ma
c=[MAC]&AdminNote=[URLencodedNote]&user=[username]&ShowOnlyOnline=[TRUE]
&AddressType=[STATIC/DYNAMIC]
Here is an example of what a properly formatted URL might look like to search for
authenticated devices:
https://patriot.network1.net/cli/?
function=SearchAuthDevices&username=apiuser&password=apipass&mac=&AdminNo
te=&user=bobjim&ShowOnlyOnline=&AddressType=
The result will look something like this:
<?xml version="1.0" encoding="UTF-8"?>
<result>
! <record>
! ! <Username>bobjim</Username>
Chapter 11: Remote Access API 78
DHCPatriot Version 6 Operations Manual This document © 2017 First Network Group Inc. All Rights Reserved