Connectivity Guide

356 | The XML-RPC Interface and API Dell Networking W-ClearPass Guest 6.2 | User Guide
Name Type Description
error Flag Set to 1 for an XML-RPC Fault
faultCode Integer Status code indicating the cause of the fault
faultString String Description of the fault
Table 32: XML-RPC Faults
This type of return might appear as:
'error' => 1,
'faultCode' => 401,
'faultString' => 'Invalid username or password',
These are the predefined XML-RPC Fault codes:
Code Description
401 Authentication problem -- invalid username or password
404 File implementation of XML-RPC method not found
501 XML-RPC implementation not found
502 XML-RPC method registration failed
503 XML-RPC server creation failed
504 Access denied
505 No XML-RPC implementation for this page
Table 33: XML-RPC Faults
Accessing the API
Accessing the API requires an operator account with a profile that has the XML-RPC API privilege, plus any privileges
required for the API calls. You will first create the operator profile, then create the role, a local user, and a translation
rule to map the role name to the profile. Some steps are performed in ClearPass Guest and some steps are performed in
ClearPass Policy Manager.
Creating the Profile
To create a sample XML-RPC API profile:
1. In ClearPass Guest, go to Administration > Operator Logins > Profiles and click the Create a new operator
profile link. The Operator Profile Editor form opens.
2. Enter a name and description that clearly identify the profile.
3. In the Access area, mark the Allow operator logins check box.
4. In the Administrator drop-down list, choose Custom. The row expands to include additional options.
5. For the XMLRPC API option, mark the Allow Access radio button.
6. In the Guest Manager drop-down list, choose Full Access.