Specifications

B-16
Cisco NAC Appliance - Clean Access Manager Configuration Guide
OL-28003-01
Appendix B API Support
Report Operations
getoobuserinfo
Given an IP address, MAC address or username, the getoobuserinfo function retrieves information about
the logged-in Out-of-Band (OOB) users, or given the qtype “all”, the system generates a list of
information about all logged-in OOB users. If multiple users match the criteria, the system generates a
list of users.
Required In Parameters:
• op: getoobuserinfo
• qtype: Specifies the method of identifying one or more users: ip, mac, name, all.
• qval: Specifies an IP or MAC address or a username; 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 matching number of comments of form
<!--IP=10.1.10.12,MAC=0A:13:07:9B:82:60,NAME=jdoe,PROVIDER=LDAP
Server,ROLE=Student,AUTHVLAN=10,ACCESSVLAN=1024,OS=Windows
XP,SWITCHIP=10.1.10.1,PORTNUM=18-->
• Failure: error string
getcleanuserinfo
Given a MAC address or username, the getcleanuserinfo function returns information about certified
users. If there are multiple users matching the criteria, the system generates a list of certified users.
Required In Parameters:
• op: getcleanuserinfo
• qtype: Specifies the method of identifying the user: mac, name, all.
• qval: Specifies MAC address or username; enter an empty string (‘’) to indicate “all.”
Out Parameters: <!--error=mesg--> comment
• Success: mesg value of 0; <!--count=10--> shows the number of users returned and is followed by
a matching number of comments of form
<!--MAC=0A:13:07:9B:82:60,NAME=jdoe,PROVIDER=LDAP
Server,ROLE=Student,VLAN=10-->
• Failure: error string
getreports
The getreports function returns a report that contains customized content. You can also use this function
to compile a list of users with certain software installed.
Required In Parameters:
op: getreports