Invoke-CsManagementServerFailover

  • Reference
Module:
SkypeForBusiness
Applies to:
Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Invokes the process by which the Skype for Business Server Central Management Store (CMS) is failed over to another pool. When the Central Management store is failed over the primary database will be replaced by either a preassigned database or a specified backup database. To run this cmdlet, you need to use an account that is a member of the RTCUniversalServerAdmins group. This cmdlet should be run on a server in the pool to which you want to failerover the CMS. This cmdlet was introduced in Lync Server 2013.

Syntax

Invoke-CsManagementServerFailover
      -BackupSqlServerFqdn <Fqdn>
      [-Force]
      [-BackupMirrorSqlInstanceName <String>]
      [-BackupMirrorSqlServerFqdn <Fqdn>]
      [-BackupSqlInstanceName <String>]
      [-Confirm]
      [-Report <String>]
      [-WhatIf]
      [<CommonParameters>]
Invoke-CsManagementServerFailover
      [-Confirm]
      [-Report <String>]
      [-Restore]
      [-WhatIf]
      [<CommonParameters>]

Description

The Invoke-CsManagementServerFailover cmdlet enables administrators to "failover" the Central Management Server (CMS). You can only invoke the failover to the database defined in the Topology Builder. The Invoke-CsManagementServerFailover cmdlet provides two methods for failing over the CMS:

Failover when the CMS is available by running the cmdlet without any target database parameters as in Example 1.

Failover when the CMS is unavailable (in disaster recovery mode) by specifying the BackupSqlServerFqdn parameter and the corresponding BackupSqlInstanceName parameter as in Example 2. If the database defined in the Topology Builder is mirrored, add the BackupMirrorSqlServerFqdn and BackupMirrorSqlInstanceName parameters.

Skype for Business Server Control Panel: The functions carried out by the Invoke-CsManagementServerFailover cmdlet are not available in the Skype for Business Server Control Panel.

Examples

-------------------------- Example 1 --------------------------

Invoke-CsManagementServerFailover

The command shown in Example 1 fails over the Central Management store for Skype for Business Server. In this case, the existing management store will be replaced by the preassigned database specified in the topology.

-------------------------- Example 2 --------------------------

Invoke-CsManagementServerFailover -BackupSqlServerFqdn "redmond-cs-001.litwareinc.com" - BackupSqlInstanceName "RTC" -Force

The command shown in Example 2 fails over the Central Management store for Skype for Business Server. In this case, the existing management store will be replaced by the RTC database instance found on the computer redmond-cs-001.litwareinc.com.

Parameters

-BackupMirrorSqlInstanceName

SQL Server instance for the mirror database.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-BackupMirrorSqlServerFqdn

Fully qualified domain name of the computer hosting the SQL Server mirror database.

Type:Fqdn
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-BackupSqlInstanceName

SQL Server instance for the backup database.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-BackupSqlServerFqdn

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.

Type:Fqdn
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Confirm

Prompts you for confirmation before executing the command.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Force

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.

You should not use the Force parameter if you are running the cmdlet for purposes other than disaster recovery, as it will not account for replication during the failover. When the parameter is not used, the cmdlet will first make sure all replications are done, then set the source DB to read-only mode.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Report

Enables you to specify a file path for the log file created when the cmdlet runs. For example: -Report "C:\Logs\CMSFailover.html"

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Restore

When specified, restores the existing Central Management Server database.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Inputs

None. The Invoke-CsManagementServerFailover cmdlet does not accept pipelined input.

Outputs

None.