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

API Documentation

Page 11 highlights

amigopod XMLRPC Interface Version 0.9 API Documentation Method amigopod.guest.change.expiration Change the expiration time of a guest account. Parameters Name uid guestaccountexpiry Type Scalar Scalar Description ID of the guest account to update Amount of time in hours before the guest account will expire Return Values Name error message item *_error *_error_flag Type Flag String Struct String Flag Description 0 if successful, 1 if an error occurred Status message describing the operation Updated user information record Field-specific error message Field-specific error flag, set to 1 if present Access Control Requires the change_expiration privilege (Guest Manager Expiration). Change Example Usage Sample parameters for call: 'uid' => 162, 'guestaccountexpiry' => 24, Result returned by a successful operation: 'error' => 0, 'message' => 'Changed expiration time of guest account Account will expire at 2007-11-28 23:27:00', 'item' => array ( 'id' => 162, 'do_expire' => 4, 'expire_time' => 1196256420, 'username' => '', ) Result returned by a failed operation: 'uid' => 162, 'username' => '', 'expiration_time' => '', 'user_enabled' => '', 'guestaccountexpiry_error' => 'Please choose from one of these options.', 'guestaccountexpiry_error_flag' => 1, 'error' => 1, CONFIDENTIAL 11

  • 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
11
API Documentation
Method amigopod.guest.change.expiration
Change the expiration time of a guest account.
Parameters
Name
Type
Description
uid
Scalar
ID of the guest account to update
guestaccountexpiry
Scalar
Amount of time in hours before the guest
account will expire
Return Values
Name
Type
Description
error
Flag
0 if successful, 1 if an error occurred
message
String
Status message describing the operation
item
Struct
Updated user information record
*_error
String
Field-specific error message
*_error_flag
Flag
Field-specific error flag, set to 1 if present
Access Control
Requires the
change_expiration
privilege (Guest Manager
±
Change
Expiration).
Example Usage
Sample parameters for call:
'uid' => 162,
'guestaccountexpiry' => 24,
Result returned by a successful operation:
'error' => 0,
'message' => 'Changed expiration time of guest account
Account will expire at 2007-11-28 23:27:00',
'item' => array (
'id' => 162,
'do_expire' => 4,
'expire_time' => 1196256420,
'username' => '',
)
Result returned by a failed operation:
'uid' => 162,
'username' => '',
'expiration_time' => '',
'user_enabled' => '',
'guestaccountexpiry_error' => 'Please choose from one of these
options.',
'guestaccountexpiry_error_flag' => 1,
'error' => 1,