Skip to main content
Use AlwaysOn Policies to View the Health of an Availability Group (SQL Server)

This topic describes how to determine the operational health of an AlwaysOn availability group by using an AlwaysOn policy in SQL Server Management Studio or PowerShell in SQL Server 2014. For information about AlwaysOn Policy Based Management, see AlwaysOn Policies for Operational Issues with AlwaysOn Availability Groups (SQL Server).

Important noteImportant

For AlwaysOn policies, the category names are used as IDs. Changing the name of an AlwaysOn category would break its health-evaluation functionality. Therefore, the names of AlwaysOn category should never be modified.

  • Before you begin: Security

  • Use AlwaysOn policies to view the health of an availability group, using:

    AlwaysOn Dashboard

    PowerShell

Before You Begin

Security

Permissions

Requires CONNECT, VIEW SERVER STATE, and VIEW ANY DEFINITION permissions.

Arrow icon used with Back to Top link[Top]

Using the AlwaysOn Dashboard

To open the AlwaysOn Dashboard

  1. In Object Explorer, connect to the server instance that hosts one of the availability replicas. To view information about all of the availability replicas in an availability group, use to the server instance that hosts the primary replica.

  2. Click the server name to expand the server tree.

  3. Expand the AlwaysOn High Availability node.

    Either right-click the Availability Groups node or expand this node and right-click a specific availability group.

  4. Select the Show Dashboard command.

For information about how to use the AlwaysOn Dashboard, see Use the AlwaysOn Dashboard (SQL Server Management Studio).

Arrow icon used with Back to Top link[Top]

Using PowerShell

Use AlwaysOn policies to view the health of an availability group

  1. Set default (cd) to a server instance that hosts one of the availability replicas. To view information about all of the availability replicas in an availability group, use to the server instance that hosts the primary replica.

  2. Use the following cmdlets:

    Test-SqlAvailabilityGroup

    Assesses the health of an availability group by evaluating SQL Server policy based management (PBM) policies. You must have CONNECT, VIEW SERVER STATE, and VIEW ANY DEFINITION permissions to execute this cmdlet.

    For example, the following command shows all availability groups with a health state of "Error" on the server instance Computer\Instance.

    Get-ChildItem SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups ` 
    | Test-SqlAvailabilityGroup | Where-Object { $_.HealthState -eq "Error" }
    Test-SqlAvailabilityReplica

    Assesses the health of availability replicas by evaluating SQL Server policy based management (PBM) policies. You must have CONNECT, VIEW SERVER STATE, and VIEW ANY DEFINITION permissions to execute this cmdlet.

    For example, the following command evaluates the health of the availability replica named MyReplica in the availability group MyAg and outputs a brief summary.

    Test-SqlAvailabilityReplica ` 
    -Path SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MyAg\AvailabilityReplicas\MyReplica
    Test-SqlDatabaseReplicaState

    Assesses the health of an availability database on all joined availability replicas by evaluating SQL Server policy based management (PBM) policies.

    For example, the following command evaluates the health of all availability databases in the availability group MyAg and outputs a brief summary for each database.

    Get-ChildItem SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\MyAg\DatabaseReplicaStates ` 
     | Test-SqlDatabaseReplicaState

    These cmdlets accept the following options:

    Option

    Description

    AllowUserPolicies

    Runs user policies found in the AlwaysOn policy categories.

    InputObject

    A collection of objects that, represent availability groups, availability replicas, or availability database states (depending on which cmdlet you are using). The cmdlet will compute the health of the specified objects.

    NoRefresh

    When this parameter is set, the cmdlet will not manually refresh the objects specified by the -Path or -InputObject parameter.

    Path

    The path to the availability group, one or more availability replicas, or database replica cluster state of the availability database (depending on which cmdlet you are using). This is an optional parameter. If not specified, the value of this parameter defaults to the current working location.

    ShowPolicyDetails

    Shows the result of each policy evaluation performed by this cmdlet. The cmdlet outputs one object per policy evaluation, and this object has fields describing the results of evaluation (whether the policy passed or not, the policy name and category, and so forth).

    For example, the following Test-SqlAvailabilityGroup command specifies the -ShowPolicyDetails parameter to show the result of each policy evaluation performed by this cmdlet for each policy-based management (PBM) policy that was executed on the availability group named MyAg.

    Test-SqlAvailabilityGroup ` 
    -Path SQLSERVER:\Sql\Computer\Instance\AvailabilityGroups\AgName `
    -ShowPolicyDetails
    NoteNote

    To view the syntax of a cmdlet, use the Get-Help cmdlet in the SQL Server PowerShell environment. For more information, see Get Help SQL Server PowerShell.

To set up and use the SQL Server PowerShell provider

Arrow icon used with Back to Top link[Top]