Durable Subscribers Monitoring

View Administration Namespaces

Retrieves a list of the administration namespaces for a Universal Messaging server instance.

Syntax

sagcc get administration component nodeAlias Universal-Messaging-instanceName

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 retrieve the administration namespaces.

Examples

To retrieve the administration namespaces for the server instance with ID "Universal-Messaging-umserver" installed in the installation with alias name "sag01":

sagcc get administration component sag01 Universal-Messaging-umserver

View Monitoring Options

Edit online

Retrieves information about the options available for monitoring durable subscribers on a Universal Messaging server instance.

Syntax

sagcc get administration component nodeAlias Universal-Messaging-instanceName
durablesubscribers

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 retrieve the monitoring options.

Examples

To retrieve the options for monitoring durable subscribers on the server instance with ID "Universal-Messaging-umserver" installed in the installation with alias name "sag01":

sagcc get administration component sag01 Universal-Messaging-umserver durablesubscribers

List Durable Subscribers

Edit online

Lists the durable subscribers on a Universal Messaging server instance in XML, TSV, or CSV format.

Syntax

sagcc get administration component nodeAlias Universal-Messaging-instanceName
durablesubscribers list {--format|-f} {tsv|xml|csv}

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 the durable subscribers.

{--format|-f} {tsv|xml|csv}

Required. The format in which to retrieve the list of durable subscribers. Values are:

tsv
xml
csv

Examples

To list the durable subscribers in XML format on the server instance with ID "Universal-Messaging-umserver" installed in the installation with alias name "sag01":

sagcc get administration component sag01 Universal-Messaging-umserver durablesubscribers
list -f xml

List Durable Subscriber Attributes

Edit online

Retrieves the attributes of a specific durable subscriber or a set of attributes for all durable subscribers on a Universal Messaging server instance.

Syntax

To retrieve the attributes of a specific durable subscriber:

sagcc get administration component nodeAlias Universal-Messaging-instanceName
durablesubscribers details channel=channelName name=durableSubscriberName
{--format|-f} {xml|tsv|csv}

To retrieve a set of attributes for all durable subscribers:

sagcc get administration component nodeAlias Universal-Messaging-instanceName
durablesubscribers list {--format|-f} {tsv|csv} properties=commaSeparatedList

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 retrieve a set of durable-subscriber attributes.

{--format|-f} {xml|tsv|csv}

Required. The format in which to retrieve the attributes of the durable subscribers. Values are:

xml - Can be used only for retrieving the attributes of a specific durable subscriber.
tsv
csv

[properties=commaSeparatedList]

Required for retrieving a set of attributes. A comma-separated list of the attributes you want to retrieve.

Examples

To list in XML format the attributes of durable subscriber "dsubscriber1" on channel "channel2", on the server instance with ID "Universal-Messaging-umserver", installed in the installation with alias name "sag01":
```
sagcc get administration component sag01 Universal-Messaging-umserver 
durablesubscribers details channel=channel2 name=dsubscriber1 -f xml
```
To list in TSV format the attributes "name", "channel", "lastEventID", and "outstandingEvents" of the durable subscribers on the server instance with ID "Universal-Messaging-umserver", installed in the installation with alias name "sag01":
```
sagcc get administration component sag01 Universal-Messaging-umserver 
durablesubscribers list -f tsv properties=name,channel,lastEventID,outstandingEvents
```

List Events

Edit online

Retrieves a list of events for a durable subscriber.

Syntax

sagcc get administration component nodeAlias Universal-Messaging-instanceName
durablesubscribers getDurableEvents durableName=durableSubscriberName chanName=channelName

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 retrieve a list of events.
durableName=durableSubscriberName: Required. The name of the durable subscriber for which you want to retrieve a list of events.
chanName=channelName: Required. The name of the channel to which the durable subscriber is subscribed.

Examples

To retrieve the list of events for durable subscriber "dsubscriber1" on channel "channel2", on the server instance with ID "Universal-Messaging-umserver", installed in the installation with alias name "sag01":

sagcc get administration component sag01 Universal-Messaging-umserver 
durablesubscribers getDurableEvents durableName=dsubscriber1 chanName=channel2

Purge Events

Edit online

Purges a set of events or all events for a durable subscriber.

Syntax

To purge a range fo events:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
durablesubscribers purgeStartEndID startEID=startEventID endEID=endEventID
durableName=durableSubscriberName chanName=channelName

To purge all events:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
durablesubscribers purgeAll durableName=durableSubscriberName chanName=channelName

To purge specific events using filtering criteria:

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
durablesubscribers purgeFilter durableName=durableSubscriberName chanName=channelName
filter=filterExpression

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 purge events.
durableName=durableSubscriberName: Required. The name of the durable subscriber for which you want to purge events.
chanName=channelName: Required. The name of the channel to which the durable subscriber is subscribed.
[startEID=startEventID]: Required for purging a range of events. The ID of the first event in the range.
[endEID=endEventID]: Required for purging a range of events. The ID of the last event in the range
[filter=filterExpression]: Required when using a filter to purge events. The criteria used to purge events.

Examples

To purge the events with IDs from "10" to "20" for durable subscriber "dsubscriber1" on channel "channel2", on the server instance with ID "Universal-Messaging-umserver", installed in the installation with alias name "sag01":
```
sagcc exec administration component sag01 Universal-Messaging-umserver 
durablesubscribers purgeStartEndID startEID=10 endEID=20 durableName=dsubscriber1
chanName=channel2
```
To purge all events for durable subscriber "dsubscriber1" on channel "channel2", on the server instance with ID "Universal-Messaging-umserver", installed in the installation with alias name "sag01":
```
sagcc exec administration component sag01 Universal-Messaging-umserver 
durablesubscribers purgeAll durableName=dsubscriber1 chanName=channel2 
```
To purge the events with a size between "10.0" and "12.0" for durable subscriber "dsubscriber1" on channel "channel2", on the server instance with ID "Universal-Messaging-umserver", installed in the installation with alias name "sag01":
```
sagcc exec administration component sag01 Universal-Messaging-umserver 
durablesubscribers purgeFilter durableName=dsubscriber1 chanName=channel2 
filter=size BETWEEN 10.0 AND 12.0
```

Delete a Durable Subscriber

Edit online

Deletes a durable subscriber on a specific channel.

Syntax

sagcc exec administration component nodeAlias Universal-Messaging-instanceName
durablesubscribers delete channel=channelName name=durableSubscriberName

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 delete a durable subscriber.
channel=channelName: Required. The name of the channel on which you want to delete a durable subscriber.
name=durableSubscriberName: Required. The name of the durable subscriber you want to delete.

Examples

To delete durable subscriber "dsubscriber1" on channel "channel3", on the server instance with ID "Universal-Messaging-umserver", installed in the installation with alias name "sag01":

sagcc exec administration component sag01 Universal-Messaging-umserver 
durablesubscribers delete channel=channel3 name=dsubscriber1