Export (0) Print
Expand All

Remove-CsStorageServiceConfiguration

 

Topic Last Modified: 2014-03-19

Removes existing instances of the Lync Server Storage Service. The storage service provides a common infrastructure that enables Lync Server 2013 components to use Microsoft Exchange Server 2013 as a back-end data store.

This cmdlet was introduced in the Cumulative Updates for Lync Server 2013: February 2013.

Remove-CsStorageServiceConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

The command shown in Example 1 deletes the storage service configuration settings applied to the Redmond site.

Remove-CsStorageServiceConfiguration -Identity "site:Redmond"

In Example 2, all the storage service settings applied to the site scope are deleted. To carry out this task, the command first uses the Get-CsStorageServiceConfiguration cmdlet and the Filter parameter to return all the settings configured at the site scope. That collection is then piped to the Remove-CsStorageServiceConfiguration cmdlet, which proceeds to delete each item in the collection.

Get-CsStorageServiceConfiguration -Filter "site:*" | Remove-CsStorageServiceConfiguration

Example 3 shows how you can delete all the storage service configuration settings collections that share a specified property value—in this case, all the collections where the EnableAutoImportFlushedData property is equal to False ($False). To do this, the command first uses the Get-CsStorageServiceConfiguration cmdlet to return a collection of the storage service settings in use in your organization. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EnableAutoImportFlushedData property is set to False. That subcollection of settings is then piped to, and deleted by, the Remove-CsStorageServiceConfiguration cmdlet.

Get-CsStorageServiceConfiguration | Where-Object {$_.EnableAutoImportFlushedData -eq $False} | Remove-CsStorageServiceConfiguration

The Lync Server Storage Service (introduced in Lync Server 2013) enables Lync Server components, such as archiving for instant messaging and conferencing, to use Exchange 2013 as a back-end data store. This helps to reduce operating costs: for example, you no longer need to have separate storage solutions for Exchange and for Lync Server archiving. Among other things, the Storage Service also enables Lync Server to leverage the heavy investment that has been made in Exchange archiving and storage, and prevents administrators from having to use multiple tools when retrieving archived data.

Separate instances of the Lync Server Storage Service can be configured at the global, site, and service scope (for the Registrar service only). By default, Lync Server provides you with a single, global collection of Storage Service configuration settings. However, administrators have the option of creating custom settings by using the New-CsStorageServiceConfiguration cmdlet. Those custom settings can later be deleted by using the Remove-CsStorageServiceConfiguration cmdlet.

noteNote:
The Remove-CsStorageServiceConfiguration cmdlet can also be run against the global settings collection. In that case, however, the global collection will not be deleted. Instead, all the properties within the collection will be reset to their default values.

To return a list of all the role-based access control (RBAC) roles that this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell command-line interface prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Remove-CsStorageServiceConfiguration"}

Lync Server Control Panel: The functions carried out by the Get-CsStorageServiceConfiguration cmdlet are not available in the Lync Server Control Panel.

 

Parameter Required Type Description

Identity

Required

Microsoft.Rtc.Management.Xds.XdsIdentity

Unique identifier for the collection of storage service configuration settings to be removed. To remove a collection applied to the site scope, use syntax similar to this:

-Identity "site:Redmond”

To remove a collection applied to the service scope, use syntax like this:

-Identity "service:Registrar:atl-cs-001.litwareinc.com"

Note that you can also run the Remove-CsStorageServiceConfiguration cmdlet against the global collection of settings. In that case, however, the global settings will not actually be removed. Instead, the properties within that collection will all be reset to their default values.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command.

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses the display of any non-fatal error message that might occur when running the command.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Describes what would happen if you executed the command without actually executing the command.

The Remove-CsStorageServiceConfiguration cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.storageService.StorageServiceSettings object.

None. The Remove-CsStorageServiceConfiguration cmdlet does not return any objects or data.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft