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

Method amigopod.guest.enable

Page 17 highlights

amigopod XMLRPC Interface Version 0.9 'do_expire_error_flag' => 1, 'expire_time_error' => 'Parameter must be a string', 'expire_time_error_flag' => 1, 'expire_postlogin_error' => 'Please choose from one of the available options', 'expire_postlogin_error_flag' => 1, 'error' => 1, Method amigopod.guest.enable Enable a guest account. Parameters Name uid Type Description Integer ID of the guest account to enable Return Values NOTE This function may return a Boolean false value if some input parameters are invalid. Name error message item uid *_error *_error_flag Type Flag String Struct Integer String Flag Description Set to 1 if the account was not enabled Message describing the success or failure of the operation User structure containing updated field values ID of the guest account Field-specific error message Field-specific error flag, set to 1 if present Access Control Requires the remove_account privilege (Guest Manager Accounts). Remove Example Usage Sample parameters for call: 'uid' => '162', Sample successful call: 'error' => 0, 'message' => 'Guest account 'item' => array ( 'id' => 162, 'enabled' => 1, 'username' => '', ), has been re-enabled', Sample failed call: CONFIDENTIAL 17

  • 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
17
'do_expire_error_flag' => 1,
'expire_time_error' => 'Parameter must be a string',
'expire_time_error_flag' => 1,
'expire_postlogin_error' => 'Please choose from one of the available
options',
'expire_postlogin_error_flag' => 1,
'error' => 1,
Method amigopod.guest.enable
Enable a guest account.
Parameters
Name
Type
Description
uid
Integer
ID of the guest account to enable
Return Values
NOTE
This function may return a Boolean
false
value if some input parameters are
invalid.
Name
Type
Description
error
Flag
Set to 1 if the account was not enabled
message
String
Message describing the success or
failure of the operation
item
Struct
User structure containing updated field
values
uid
Integer
ID of the guest account
*_error
String
Field-specific error message
*_error_flag
Flag
Field-specific error flag, set to 1 if present
Access Control
Requires the
remove_account
privilege (Guest Manager
±
Remove
Accounts).
Example Usage
Sample parameters for call:
'uid' => '162',
Sample successful call:
'error' => 0,
'message' => 'Guest account
has been re-enabled',
'item' =>
array (
'id' => 162,
'enabled' => 1,
'username' => '',
),
Sample failed call: