Channel Snoop
Start Snooping on a Channel
Starts snooping on events on a channel for a specific user.
Syntax
To start snooping on events on a channel for a specific user:
sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels startSnoop name=channelName user=userName
To start snooping on events on a channel for a specific user with filtering criteria:
sagcc exec administration component nodeAlias Universal-Messaging-instanceName
channels startSnoop name=channelName user=userName [fromeid=firstEventId]
[toeid=lastEventId] [filter=filterString]
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 on which you want to start snooping.
name=channelName
Required. The name of the channel on which you want to snoop.
user=userName
Required. The username of the user for whom you want to start snooping.
[fromeid=firstEventId]
Optional. The ID of the first event in the event range on which you want to start snooping.
[toeid=lastEventId]
Optional. The ID of the last event in the event range on which you want to start snooping.
[filter=filterString]
Optional. Additional filtering criteria based on the properties of the event.
Usage Notes
When you want to start snooping on a range of events:
If you do not specify
fromeid, the range of events starts with the first event on the channel and ends with the event specified for
toeid.
If you do not specify
toeid, the range of events starts with the event specified for
fromeid and ends with the last event on the channel.
Examples
To start snooping on events 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 startSnoop name=channel2 user=Administrator
To start snooping on the events with IDs from "2" to "10" 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 startSnoop name=channel2 user=Administrator fromid=2 toid=10