commands

^

Get-DbaWsfcRole

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows only

 

Synopsis

Gets information about one or more clustered roles (resource groups) in a failover cluster.

Description

Gets information about one or more clustered roles (resource groups) in a failover cluster.

All Windows Server Failover Clustering (Wsfc) commands require local admin on each member node.

Syntax

Get-DbaWsfcRole
    [[-ComputerName] <DbaInstanceParameter[]>]
    [[-Credential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaWsfcRole -ComputerName cluster01

Gets role information from the failover cluster cluster01

Example: 2
PS C:\> Get-DbaWsfcRole -ComputerName cluster01 | Select-Object *

Shows all role values, including the ones not shown in the default view

Optional Parameters

-ComputerName

The target cluster name. Can be a Role or the cluster name itself.

Alias
Required False
Pipeline true (ByValue)
Default Value $env:COMPUTERNAME
-Credential

Allows you to login to the cluster using alternative credentials.

Alias
Required False
Pipeline false
Default Value
-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.

Alias
Required False
Pipeline false
Default Value False

 

Want to see the source code for this command? Check out Get-DbaWsfcRole on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaWsfcRole.