getSubscriptions2 Command

Syntax

getSubscriptions2 [-d|--domain domainName] 
[-i|--in inputXmlFile] [-o|--out outputXmlFile] 
[-f|--filter filterExpression] [-p|--packageName name] 
[-pn|--pageNumber number] [-ps|--pageSize size] 
[-s|--sort column[:Ascending|Descending]] [-h|--help] [-sl|--silent]

Parameters

• -h|--help – gets help on this command.
• -d|--domain – specifies the domain.
• -i|--in – reads package name from input XML file. You can generate the XML file by using the -o parameter with getPackages.
• -o|--out – saves command output to an XML file.
• -f|--filter – specifies the filter to use on the subscriptions. The filter expression must have one column name, followed by a colon and the filter string; for example:

  -f columnName:filterString

  Valid filter column names are: subscriptionID, packageName, clientID, physicalID, logicalID, userName, language, clientMsgID, clientMsgTimeStamp, serverMsgID, serverMsgTimeStamp, logLevel.

  You can use "?" and "*" wildcard characters in your filter strings; for example:

  -f clientMsgTimeStamp:*Jan*21?41*2009

• -p|--packageName – specifies package name for which subscription information is returned. Package name is followed by a colon and the package version number, with no white space; for example:

  -p myPkg:2.0

• -ps|--pageSize – specifies the page size, which is the number of subscriptions per page returned. Page size must be 1 or higher. If you do not specify a page size:
  • If the number of subscriptions returned is greater than 10, you are prompted to enter a page size.
  • If the number of subscriptions returned is 10 or fewer, all subscriptions are listed on one page.
• -pn|--pageNumber – specifies the page number, which is the number of the page returned, determined by the page size. Page number must be 1 or higher. If you do not specify a page number:
  • If the number of subscriptions returned is greater than the page size, you are prompted to enter a page number.
  • If the number of subscriptions returned is not greater than the page size, all subscriptions are listed on one page.

  Page size and page number together determine the subscriptions actually returned by for the specified package name; for example, you might specify a page size of 3 with a page number of 2:

  getSubscriptions2 -p myPkg:2.0 -ps 3 -pn 2

  This example returns the second page of subscriptions for version 2.0 of the package named myPkg. That page would contain subscriptions 4-6 to the package. With a page size of 3, the fist page would contain subscriptions 1-3, the third page would contain subscriptions 7-9, and so on. If sorting or filtering are specified, these operations produce the list of subscriptions to which page size and page number are applied.

• -s|--sort – specifies the columns on which output is to be sorted. If you specify only a column name, the default sort order is ascending; for example:

  -s UserName

  Add a colon, followed by Descending after the column name to sort in descending order; for example:

  -s ServerMsgTimeStamp:Descending

  Valid sort column names are: ClientID, PhysicalID, SubscriptionID, LogicalID, PushQueue, UserName, Language, LogLevel, ServerMsgID, ServerMsgTimeStamp, ClientMsgID, ClientMsgTimeStamp, ApplicationName, and MMSPID.

• -sl|--silent – disables all user interactive questions; this option is generally used with batch files.