Specifications

B-15
Cisco NAC Appliance - Clean Access Manager Configuration Guide
OL-28003-01
Appendix B API Support
Report Operations
getversion
The getversion function returns the version number of the CAM.
Required In Parameters:
• op: getversion
Out Params:
• Comment of form <!--version=version--> is returned.
getuserinfo
Given an IP address, MAC address, or username, the getuserinfo function retrieves the following user
information:
• IP in IPv4 format
• MAC address
• Name is the username
• Provider can be the LDAP server
• Role is the current role assigned to the user
• Origrole is the original role assigned to the user
• VLAN is the original VLAN tag
• NEWVLAN is the current VLAN tag
• Operating system of the user’s system
If multiple users match the criteria, the system returns a list of users. If you enter “all” as the qtype
Parameter, all information for all users is retrieved.
Required In Parameters:
• op: getuserinfo
• qtype: Specifies one of the following strings: ip, mac, name, or all.
• qval: Specifies an IP address, MAC address, or username depending on the qtype parameter; enter
an empty string (‘’) to indicate “all.”
Note If you do not use session-based authentication, the admin and passwd arguments are required. See
Authentication Requirements, page B-2.
Out Parameters: <!--error=mesg--> comment
• Success: mesg value of 0; <!--count=10--> shows the number of users returned and is followed by
a corresponding number of comments
<!--IP=10.1.10.12,MAC=0A:13:07:9B:82:60,NAME=jdoe,PROVIDER=LDAP
Server,ROLE=Student,ORIGROLE=Student,VLAN=1024,NEWVLAN=1024,OS=Windows XP-->
• Failure: error string