Universal Messaging 10.11 | Administration Guide | Using Command Central to Manage Universal Messaging | Using the Command Line to Manage Universal Messaging | Channel Snoop | List Snooped Events on a Channel
 
List Snooped Events on a Channel
Lists the snooped events on a channel for a specific user in TSV, XML, or JSON format.
Syntax
*To list the snooped events on a channel for a specific user in TSV format:
sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels snoop name=channelName user=userName
*To list the snooped events on a channel for a specific user in XML or JSON format:
sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels snoop name=channelName user=userName {--format|-f} {xml|json}
Arguments and Options
nodeAlias
Required. The alias name of the installation in which the Universal Messaging server instance is installed.
Universal-Messaging-instanceName
Required. The ID of the Universal Messaging server instance for which you want to list snooped events.
name=channelName
Required. The name of the channel for which you want to list snooped events.
user=userName
Required. The username of the user for whom you want to list snooped events.
[{--format|-f} {xml|json}]
Optional. Whether to list the snooped events in XML or JSON format.
Usage Notes
If the Universal Messaging server becomes unavailable after the snoop on the channel started, Command Central stops snooping all channels on that Universal Messaging server for all Command Central users. If you run the command that lists snooped events while the Universal Messaging server is unavailable, the system returns "snoopStarted=false" and an empty list of events.
Examples
*To list the snooped events in TSV format on channel "channel2", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":
sagcc exec administration component sag01 Universal-Messaging-umserver
channels snoop name=channel2 user=Administrator
*To list the snooped events in JSON format on channel "channel2", created on the server instance with ID "Universal-Messaging-umserver" that is installed in the installation with alias name "sag01", for user "Administrator":
sagcc exec administration component sag01 Universal-Messaging-umserver
channels snoop name=channel2 user=Administrator --format json