Please note that as of 5.3.0 you can pass &mac=[optional mac address] instead of
&user=[username to suspend] An example would look like:
This allows a device to be suspended by mac address instead of username (which
suspends ALL of their mac addresses).
Success will present the text RETURN=1. Failure will present RETURN=0 with some
text given below as a reason for the failure.
Mass Suspend Device by Username
This allows the suspension of multiple devices belonging to multiple users at the same
time. It would be analogous to accessing Auth DHCP Actions -> Suspend User and
clicking on “Suspend Multiple Users”.
The feature is accessed using a POST action string as follows:
.[domain]/cli/?
function=AuthMassSuspend&username=[username]&password=[password]¬e=[note
]
including POST data name value pair consisting of `UserList` for the name and a list of
usernames separated by line breaks for the value.
For example:
UserList=‘jim
james
john
joe’
Success will present the text RETURN=1. Failure will present RETURN=0. Please
note, that RETURN=0 will be sent even if only one of the suspends fails. There will be
further information given like so:
RETURN=0
Suspened (devices): 1
Failed (devices or users): 3
Failed List:
james
john
joe
Chapter 11: Remote Access API
77
DHCPatriot Version 6 Operations Manual This document © 2017 First Network Group Inc. All Rights Reserved
Summary of Contents for DHCPatriot Version 6
Page 1: ...Operations Manual Version 6...
Page 2: ......
