< Back

SqlServerAvailabilityGroupFailover

Sat Jan 11, 2020 4:10 am

NAME SqlServerAvailabilityGroupFailover



SYNOPSIS

Autonance DSL task to failover an SQL Server Availability Group.





SYNTAX

SqlServerAvailabilityGroupFailover [-ComputerName] <String> [-SqlInstance] <String> [-AvailabilityGroup] <String>

[-Credential <PSCredential>] [-Count <Int32>] [-Delay <Int32>] [<CommonParameters>]





DESCRIPTION

Use this task to failover the specified SQL Server Availability Group to the

specified computer and instance. It will use the SQLPS module on the remote

system.





PARAMETERS

-ComputerName <String>

This is the target Windows computer for the planned failover.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-SqlInstance <String>

Target SQL instance for the planned planned.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AvailabilityGroup <String>

The availability group name to perform a planned manual failover.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Credential <PSCredential>

Specifies a user account that has permission to perform the task.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Count <Int32>

Specifies the number of retries between availability group state tests.



Required? false

Position? named

Default value 60

Accept pipeline input? false

Accept wildcard characters? false



-Delay <Int32>

Specifies the interval between availability group state tests.



Required? false

Position? named

Default value 2

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Author : Claudio Spizzi

License : MIT License





RELATED LINKS

https://github.com/claudiospizzi/Autonance