Product Documentation

Manage subscription data

Dec 09, 2014

Manage subscription data for a store using PowerShell cmdlets.

Note: The StoreFront and PowerShell consoles cannot be open at the same time. Always close the StoreFront admin console before using the PowerShell console to administer your StoreFront configuration. Likewise, close all instances of PowerShell before opening the StoreFront console.

Export subscription data

You can create a snapshot of a store’s subscription data using the following PowerShell cmdlets to create a subscription data file:

Add-PSSnapin Citrix.DeliveryServices.SubscriptionsManagement.Commands

Export-DSStoreSubscriptions –StoreName StoreName –FilePath DataFile

When managing a multiple-server deployment, you can run these PowerShell cmdlets on any server within the StoreFront server group.

Restore subscription data

You can restore a store’s subscription data to a previously saved snapshot using the following PowerShell cmdlets:

Add-PSSnapin Citrix.DeliveryServices.SubscriptionsManagement.Commands

Restore-DSStoreSubscriptions –StoreName StoreName –FilePath DataFile

This command restores the subscription data to the state when the export data file was produced, and it removes any existing subscriptions before adding the subscription data found in the data file.

When managing a multiple-server deployment, you can run these PowerShell cmdlets on any server within the StoreFront server group.

Import subscription data

You can update a store’s subscription data from a previously exported data file using the following PowerShell cmdlets:

Add-PSSnapin Citrix.DeliveryServices.SubscriptionsManagement.Commands

Import-DSStoreSubscriptions –StoreName StoreName –FilePath FilePath

This command allows subscription data to be transferred from one store to another, and it retains existing subscriptions before adding/updating subscription data from the imported data file.

When managing a multiple-server deployment, you can run these PowerShell cmdlets on any server within the StoreFront server group.

Purge subscription data for a store

A folder and datastore containing subscription data exists for each store.

  1. Stop the Citrix Subscriptions Store service on the StoreFront server.
  2. Locate subscription store database folder on each StoreFront server in the new location.

    C:\Windows\ServiceProfiles\NetworkService\AppData\Roaming\Citrix\SubscriptionsStore\1__Citrix_<StoreName>

  3. Delete the contents of this folder, but do not delete the folder.
  4. Restart the Citrix Subscriptions Store service on all StoreFront servers in the deployment.

Subscription data file details

The subscription data file is a text file containing one line per user subscription. Each line is a tab-separated sequence of values:

<user-identifier> <resource-id> <subscription-id> <subscription-status> <property-name> <property-value> <property-name> <property-value> …

where:

  • <user-identifier> — Required. A sequence of characters identifying the user. This is the user’s Windows Security Identifier.
  • <resource-id> — Required. A sequence of characters identifying the subscribed resource.
  • <subscription-id> — Required. A sequence of characters uniquely identifying the subscription. This value is not used (although, a value must be present in the data file).
  • <subscription-status> — Required. The status of the subscription: subscribed or unsubscribed.
  • <property-name> and <property-value> — Optional. A sequence of zero or more pairs of <property-name> and <property-value> values. These represent properties associated with the subscription by a StoreFront client (typically a Citrix Receiver). A property with multiple values that is represented by multiple name/value pairs with the same name (for example, “… MyProp A MyProp B ….” represents the property MyProp with values A, B).

Example:

S-0-0-00-0000000000-0000000000-0000000000-0000 XenApp.Excel 21EC2020-3AEA-4069-A2DD-08002B30309D Subscribed dazzle:position 1

Size of subscription data on the Storefront server's disk

Size of import and export .txt files