Specifications

B-10
Cisco NAC Appliance - Clean Access Manager Configuration Guide
OL-28003-01
Appendix B API Support
User Operations
• Failure: error string
kickuserbymac
The kickuserbymac function terminates the active session by MAC address of one or more logged-in
In-Band users and removes the user(s) from the In-Band Online Users list.
Required In Parameters:
• op: kickuserbymac
• mac: Specifies one MAC address or a comma separated list of MAC addresses.
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
• Failure: error string
kickoobuser
The kickoobuser function terminates the active session of one or more OOB users and removes the
user(s) from the Out-of-Band Online Users list.
Required In Parameters:
• op: kickoobuser
• mac: Specifies a MAC address or a comma separated list of MAC addresses.
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
• Failure: error string
queryuserstime
The queryuserstime function queries the remaining session time for logged-in users. This function
returns a list of logged-in users in roles with configured session timeouts.
Required In Parameters:
• op: queryuserstime
Note If you do not use session-based authentication, the admin and passwd arguments are required. See
Authentication Requirements, page B-2.