User's Manual

424 | Administration Dell Networking W-ClearPass Guest 6.4 | User Guide
Method amigopod.guest.list
List guest accounts. (To retrieve devices, see "Method amigopod.mac.list" on page 430)
Parameters
Name Type Description
details Flag Optional parameter; if set to 1 then
full details of all guest accounts are
returned, otherwise only the IDs are
returned
sort string Optonal parameter. If set to 1, then
sorts first by the specified column,
and then by username. For the field_
name and +field_name formats,
sort order will be ascending (A to Z);
for the -field_name format the sort
order will be descending (Z to A).
filter string Allows searching for multiple values
when using the equality (=) or
inequality (!=) operators. For more
information, see the Filter description
in "Managing Single Guest Accounts
" on page 55.
Return Values
Name Type Description
ids Array Array of guest account IDs (if details
was 0)
users Array Array of guest account structures (if
details was 1)
Access Control
Requires the guest_users privilege (Guest Manager > List Guest Accounts in the Operator Profile Editor).
Example Usage
Sample parameters:
'details' => 0,
Sample successful call:
'ids' =>
array (
0 => '37',
1 => '141',
2 => '40',
...
),