Specifications

B-21
Cisco NAC Appliance - Clean Access Manager Configuration Guide
OL-28003-01
Appendix B API Support
Report Operations
Out Parameters: <!--error=mesg--> comment
• Success: mesg value of 0; <!--count=count--> shows the number of reports returned; the reports
follow the count comment and are of the form:
<!--status=status,user=user,agentType=agentType,ip=ip,mac=mac,os=os,time=time,text=text-->
• Failure: error string
getuallist
The getuallist function fetches the list of XML data files stored in /perfigo/control/data/logs/ual.
Required In Parameter:
• op: getuallist
• admin: Administrator account username
• passwd: Administrator account password
• ip: Specifies IP Address of the Cisco NAC Appliance API
(https://<cam-IP-or-hostname>/admin/cisco_api.jsp)
Out Parameters: <!--error=mesg--> comment
• Success: mesg value of 0; <!--count=count--> shows the number of files returned; the list of
filenames follow the count comment and are of the form:
<!--filename=filename-->
• Failure: error string
getualfile
The getualfile function displays the contents of the specified UAL file.
Required In Parameter:
• op: getUALfile
• filename: Specifies the UAL file name
• admin: Administrator account username
• passwd: Administrator account password
• ip: Specifies IP Address of the Cisco NAC Appliance API
(https://<cam-IP-or-hostname>/admin/cisco_api.jsp)
reqName Name of the AV or AS software requirement; empty
quotes “any” (default)
Restricts to reports containing this software
requirement.
reqStatus One of the following values:
• any (default)
• success
• failure
Restricts to reports where the software
requirement is of this status (only if reqName
is used).
Table B-1 Query Parameters for the getreports function (continued)
Parameter Name Allowed Values Description