Set-CsUserDatabaseState
Topic Last Modified: 2012-03-27
Enables or disables one or more Microsoft Lync Server 2010 user databases.
Syntax
Set-CsUserDatabaseState -Online <$true | $false> -RegistrarPool <Fqdn> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Set-CsUserDatabaseState -Identity <String> -Online <$true | $false> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]
Detailed Description
Lync Server 2010 employs the user database (also known as the user store) to maintain presence and routing information for Lync Server users. The Set-CsUserDatabaseState cmdlet provides a way for you change the state of one or more user databases: you can use the cmdlet to take a database offline or to bring a disabled database back online.
Note that, by default, the firewall exceptions for SQL Server Express are not enabled when you install the Standard Edition of Lync Server 2010. In turn, that means that you will not be able to run Set-CsUserDatabaseState from a remote instance of Windows PowerShell. That’s because your command will not be able to traverse the firewall and access the SQL Server Express database. You can still run the cmdlet locally (that is, on the Standard Edition server itself). However, to run Set-CsUserDatabaseState remotely you will need to manually enable the firewall exceptions for SQL Server Express.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsUserDatabaseState cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself) run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsUserDatabaseState"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
String |
Unique identifier of the user database whose online status is to be modified. For example: -Identity "UserDatabase:atl-sql-001.litwareinc.com". You cannot use both Identity and RegistrarPool in the same command, nor can you use wildcards with either parameter. |
Online |
Required |
Boolean |
When set to True ($True), makes a database available online. When set to False ($False), takes a database offline. |
RegistrarPool |
Optional |
String |
Fully qualified domain name (FQDN) of the Registrar pool hosting the user databases whose online status is to be modified. For example: -RegistrarPool atl-cs-001.litwareinc.com. You cannot use both –Identity and –RegistrarPool in the same command, nor can you use wildcards with either parameter. |
Force |
Suppresses the display of any non-fatal error message that might arise when running the command. |
||
WhatIf |
Describes what would happen if you executed the command without actually executing the command. |
||
Confirm |
Prompts you for confirmation before executing the command. |
Input Types
String. Set-CsUserDatabaseState accepts a string value representing the Identity of the user database to be updated.
Return Types
None. Instead, Set-CsUserDatabaseState modifies existing instances of the Microsoft.Rtc.Management.Xds.UserStoreState object.
Example
-------------------------- Example 1 ------------------------
Set-CsUserDatabaseState -Identity "UserDatabase:atl-sql-001.litwareinc.com" -Online $False
The command shown in Example 1 takes the user database UserDatabase:atl-sql-001.litwareinc.com offline. This is done by setting the Online property to $False.
-------------------------- Example 2 ------------------------
Set-CsUserDatabaseState -RegistrarPool atl-cs-001.litwareinc.com -Online $False
In Example 2, all the user databases on the Registrar pool atl-cs-001.litwareinc.com are taken offline.
-------------------------- Example 3 ------------------------
Get-CsUserDatabaseState | Where-Object {$_.Online -eq $False} | ForEach-Object {Set-CsUserDatabaseState -Identity $_.Identity -Online $True}
The preceding example locates all the user databases that are currently offline and then brings them back online. To do this, the command first calls Get-CsUserDatabaseState without any parameters in order to return a collection of all the user databases in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those databases where the Online property is equal to False. The filtered collection is then piped to the ForEach-Object cmdlet, which takes each database in the collection and sets the Online property to True. Note that the collection of offline databases must be piped to ForEach-Object rather than Set-CsUserDatabaseState. That is because the latter cmdlet cannot directly accept pipelined information.