Topic Last Modified: 2013-02-22
Invokes the process by which the Lync Server 2013 Central Management store is failed over. When the Central Management store is failed over the primary database will be replaced by either a pre-assigned mirror database or a specified backup database. This cmdlet was introduced in Lync Server 2013.
Syntax
Invoke-CsManagementServerFailover -BackupSqlServerFqdn
<Fqdn> -Force <SwitchParameter>
[-BackupMirrorSqlInstanceName <String>]
[-BackupMirrorSqlServerFqdn <Fqdn>] [-BackupSqlInstanceName
<String>] <COMMON PARAMETERS>
|
Invoke-CsManagementServerFailover [-Restore
<SwitchParameter>] <COMMON PARAMETERS>
|
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]]
[-Report <String>] [-WhatIf [<SwitchParameter>]]
|
Examples
Example 1
The command shown in Example 1 fails over the Central Management store for Lync Server 2013. In this case, the existing management store will be replaced by the RTC database instance found on the computer redmond-cs-001.litwareinc.com.
Copy Code | |
---|---|
Invoke-CsManagementServerFailover -BackupSqlServerFqdn "redmond-cs-001.litwareinc.com" - BackupSqlInstanceName "RTC" -Force |
Detailed Description
The Invoke-CsManagementServerFailover cmdlet enables administrators to "failover" the Central Managament Server (CMS). The Invoke-CsManagementServerFailover cmdlet provides two different methods for failing over the CMS: 1) you can failover to a specified backup instance of SQL Server, or, 2) you can failover to a preassigned mirror database. To failover to a specified backup instance, use the BackupSqlServerFqdn and BackupSqlInstanceName parameters. To failover to the mirror database, use the BackupMirrorSqlServerFqdn and BackupMirrorSqlInstanceName parameters.
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 command-line interface prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Invoke-CsManagementServerFailover"}
Lync Server Control Panel: The functions carried out by the Invoke-CsManagementServerFailover cmdlet are not available in the Lync Server Control Panel.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
BackupSqlServerFqdn |
Optional |
Microsoft.Rtc.Management.Deploy.Fqdn |
Fully qualified domain name of the computer hosting the SQL Server backup database. This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. |
Force |
Optional |
System.Management.Automation.SwitchParameter |
Suppresses the display of any non-fatal error message that might occur when running the command. This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. |
BackupMirrorSqlInstanceName |
Optional |
System.String |
SQL Server instance for the mirror database. |
BackupMirrorSqlServerFqdn |
Optional |
Microsoft.Rtc.Management.Deploy.Fqdn |
Fully qualified domain name of the computer hosting the SQL Server mirror database. |
BackupSqlInstanceName |
Optional |
System.String |
SQL Server instance for the backup database. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
Prompts you for confirmation before executing the command. |
Report |
Optional |
System.String |
Enables you to specify a file path for the log file created when the cmdlet runs. For example: -Report "C:\Logs\CMSFailover.html" |
Restore |
Optional |
System.Management.Automation.SwitchParameter |
When specified, restores the existing Central Management Server database. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Input Types
None. The Invoke-CsManagementServerFailover cmdlet does not accept pipelined input.
Return Types
None.