Dell PowerConnect W Clearpass 100 Software XMLRPC Interface TechNote - Page 18

Method amigopod.guest.get

Page 18 highlights

amigopod XMLRPC Interface Version 0.9 'error' => 1, 'message' => 'Account not found: ID 162', Method amigopod.guest.get List one or more guest accounts. Parameters Name id Type Integer Array Description Retrieve a single guest account by ID (integer parameter), or multiple guest accounts by ID (array parameter) Return Values Name id users Type Mixed Array Description ID or IDs of the guest accounts being returned If a single ID was requested, users contains the guest account requested (or an error field if an error occurred) If multiple IDs were requested, users contains an array of results Access Control Requires the guest_users privilege (Guest Manager List Guest Accounts). Example Usage Sample parameters: 'id' => array(150, 162) Sample successful call: 'id' => array ( 0 => 150, 1 => 162, ), 'users' => array ( 0 => array ( 'id' => '150', 'username' => '44454318', 'enabled' => '1', 'role_id' => '2', 'email' => '', 'notes' => 'GuestManager account 22 of 30 created by root from 192.168.2.3', 'do_expire' => '0', 'expire_time' => '', 'simultaneous_use' => '1', 'expire_postlogin' => '0', 'do_schedule' => '0', 'schedule_time' => '', CONFIDENTIAL 18

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21

amigopod XMLRPC Interface
Version 0.9
CONFIDENTIAL
18
'error' => 1,
'message' => 'Account not found: ID 162',
Method amigopod.guest.get
List one or more guest accounts.
Parameters
Name
Type
Description
id
Integer
Array
Retrieve a single guest account by ID
(integer parameter), or multiple guest
accounts by ID (array parameter)
Return Values
Name
Type
Description
id
Mixed
ID or IDs of the guest accounts being
returned
users
Array
°
If a single ID was requested,
users
contains the guest account requested
(or an
error
field if an error occurred)
°
If multiple IDs were requested,
users
contains an array of results
Access Control
Requires the
guest_users
privilege (Guest Manager
±
List Guest Accounts).
Example Usage
Sample parameters:
'id' => array(150, 162)
Sample successful call:
'id' =>
array (
0 => 150,
1 => 162,
),
'users' =>
array (
0 =>
array (
'id' => '150',
'username' => '44454318',
'enabled' => '1',
'role_id' => '2',
'email' => '',
'notes' => 'GuestManager account 22 of 30 created by root from
192.168.2.3',
'do_expire' => '0',
'expire_time' => '',
'simultaneous_use' => '1',
'expire_postlogin' => '0',
'do_schedule' => '0',
'schedule_time' => '',