Get-SqlMonitorCluster
Published 14 February 2023
Gets the details of all of the clusters monitored by SQL Monitor.
Syntax
Get-SqlMonitorCluster [-BaseMonitor <BaseMonitor>] [-Name <string>] [-SuppressDeprecationWarning] [<CommonParameters>] Get-SqlMonitorCluster [-Group <Group>] [-Name <string>] [-SuppressDeprecationWarning] [<CommonParameters>]
Description
The Get-SqlMonitorCluster cmdlet gets details of Clusters from the SQL Monitor Server.
Without parameters, this cmdlet will get all Clusters from the SQL Monitor Server.
Connect-SqlMonitor must be called before this cmdlet.
Parameters
-BaseMonitor
<BaseMonitor>
The Base Monitor to limit results to. For more information, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorbasemonitor.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Group
<Group>
{{ Fill Group Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Name
<String>
The cluster name to match.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-SuppressDeprecationWarning
<SwitchParameter>
{{ Fill SuppressDeprecationWarning Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | False |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
[BaseMonitor] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-BaseMonitor.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[Cluster] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-Cluster.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorCluster
-------------------------- EXAMPLE 2 --------------------------
Get-SqlMonitorCluster -BaseMonitor $baseMonitor
-------------------------- EXAMPLE 3 --------------------------
Get-SqlMonitorCluster -Name "ExampleClusterName"
-------------------------- EXAMPLE 4 --------------------------
Get-SqlMonitorCluster -BaseMonitor $baseMonitor -Name "ExampleClusterName"
