Dell PowerConnect W Clearpass 100 Software XMLRPC Interface TechNote
Dell PowerConnect W Clearpass 100 Software Manual
 |
View all Dell PowerConnect W Clearpass 100 Software manuals
Add to My Manuals
Save this manual to your list of manuals |
Dell PowerConnect W Clearpass 100 Software manual content summary:
- Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 1
amigopod XMLRPC Interface Unified Visitor Management API CONFIDENTIAL Revision 0.9 Date 4 December 2007 Copyright © 2007 amigopod Pty Ltd Web www.amigopod.com - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 2
amigopod XMLRPC Interface Version 0.9 Table of Contents Introduction ...4 Audience ...4 System Requirements ...4 More Information ...4 API Overview ...5 About the API ...5 Architecture Overview ...5 API Symmetry...6 Access Control...6 Parameter Names...6 Parameter Validation ...6 Field - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 3
amigopod XMLRPC Interface Version 0.9 Method amigopod.guest.enable 17 Parameters ...17 Return Values ...17 Access Control...17 Example Usage ...17 Method amigopod.guest.get 18 Parameters ...18 Return Values ...18 Access Control...18 Example Usage ...18 Method amigopod.guest.list 19 Parameters - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 4
to third-party applications that will integrate with the amigopod Visitor Management Appliance. Audience Developers of integrated applications. Some familiarity with HTTP based web services and XMLRPC is assumed. System administrators of the amigopod appliance. System Requirements amigopod Guest - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 5
Developers wishing to provide integrated applications can make use of this API to programmatically perform actions that would otherwise require manual operation of the GUI. Architecture Overview The amigopod VMA software support services. The network layer provides critical networking support, - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 6
Guest Manager or Hotspot Manager. These applications are built using the services provided by the lower layers. API Symmetry Because amigopod VMA customizable. New fields may be defined (for example, stored with a guest account) and used as part of the form in the presentation layer. Policy-based - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 7
. Parameter Types The XMLRPC specification supports a wide range of data types. The following data types are supported by the XMLRPC presentation layer: ', These are the predefined XMLRPC Fault codes: Code 401 Description Authentication problem - invalid username or password CONFIDENTIAL 7 - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 8
method registration failed XMLRPC server creation failed Access denied No XMLRPC implementation for this page Access Control Accessing the API requires an operator account with a profile that has the XMLRPC API privilege, plus any privileges required for the API calls. To create a sample XMLRPC API - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 9
amigopod XMLRPC Interface Version 0.9 Use the XMLRPC profile when creating a user account for API access: Invoking the API An XMLRPC method call consists of: An XML document specifying the method name and parameters Sent as a HTTP POST - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 10
Change the expiration time of a guest account Create a new guest account Disable or remove a guest account Change one or more properties of a guest account Enable a guest account List one or more guest accounts List guest accounts Reset a guest account's password For more details on these methods - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 11
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 - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 12
. Specified in hours expire_time String Optional date and time at which the account will expire role_id Integer RADIUS Role ID to assign to the account creator_accept_terms Flag Set to 1 to indicate acceptance of the service's terms of use * * Other fields as specified by create_user form - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 13
' => 1, 'creator_accept_terms_error' => 'You must accept the terms of use to continue.', 'creator_accept_terms_error_flag' => 1, 'error' => 1, Method amigopod.guest.delete Disable or remove a guest account. Parameters Name uid delete_account Type Integer Flag Description ID of the guest - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 14
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 deleted Message describing the success or failure of the operation User structure containing updated field values ID of the guest - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 15
password (if the password field is password_value) RADIUS Role ID to assign to the guest account Boolean value indicating whether the account is enabled Number of simultaneous sessions allowed by the account Flag indicating if the account should be enabled at schedule_time Date and time at which the - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 16
' => '2007-12-01 00:00:00', 'expire_postlogin' => 0, Sample successful call: 'error' => 0, 'message' => 'Edited properties of guest account [email protected]', 'item' => array ( 'id' => 162, 'username' => '[email protected]', 'role_id' => 2, 'enabled' => true, 'simultaneous_use' => 1, 'do_schedule - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 17
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 - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 18
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 - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 19
=> 'Visitor Name', 'visitor_phone' => '0', ), ), Sample failed call: 'id' => 162, 'users' => array ( 'error' => 1, 'message' => 'Account not found: ID 162', ), Method amigopod.guest.list List guest accounts. Parameters Name details Type Flag Description Optional parameter; if set to 1 then full - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 20
privilege (Reset Password). Example Usage Sample parameters for call: 'uid' => 162, Sample successful call: 'error' => 0, 'message' => 'Guest account password reset for Password changed to 37172833', 'item' => array ( 'id' => 162, 'password' => '37172833', 'username' => '', ), CONFIDENTIAL 20 - Dell PowerConnect W Clearpass 100 Software | XMLRPC Interface TechNote - Page 21
amigopod XMLRPC Interface Sample failed call: 'error' => 1, 'message' => 'Account not found: ID 162', Version 0.9 CONFIDENTIAL 21
-
1 -
2 -
3 -
4 -
5 -
6 -
7 -
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
 |
 |
amigopod XMLRPC
Interface
Unified Visitor Management API
CONFIDENTIAL
Revision
Date
0.9
4 December 2007
Copyright © 2007 amigopod Pty Ltd
Web
www.amigopod.com