Get-SqlMonitorMachine
Published 14 February 2023
Gets the details of all of the machines in SQL Monitor.
Syntax
Get-SqlMonitorMachine [[-BaseMonitor] <BaseMonitor[]>] [[-Cluster] <Cluster[]>] [[-Name] <string>] [-SuppressDeprecationWarning] [<CommonParameters>]
Description
The Get-SqlMonitorMachine cmdlet gets details of SQL Monitor Machines from the SQL Monitor Server.
Connect-SqlMonitor must be called before this cmdlet.
Parameters
-BaseMonitor
<BaseMonitor[]>
The Base Monitor to get Machines from. For more information, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorbasemonitor.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Cluster
<Cluster[]>
The Cluster to limit results to. For more information, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorcluster.
| Aliases | None |
| Required? | false |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Name
<String>
The Machine name to match
| Aliases | None |
| Required? | false |
| Position? | 3 |
| 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.
-
[Cluster] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-Cluster.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[Machine] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-Machine.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorMachine
-------------------------- EXAMPLE 2 --------------------------
Get-SqlMonitorMachine -Cluster $cluster
-------------------------- EXAMPLE 3 --------------------------
Get-SqlMonitorMachine -BaseMonitor $baseMonitor
-------------------------- EXAMPLE 4 --------------------------
Get-SqlMonitorMachine -Name "ExampleMachineName"
-------------------------- EXAMPLE 5 --------------------------
Get-SqlMonitorMachine -Cluster $cluster -Name "ExampleMachineName"
