Get-SqlMonitorInstance
Published 14 February 2023
Gets the details of all of the SQL Server Instances for the given Cluster or Machine.
Syntax
Get-SqlMonitorInstance [[-Machine] <Machine>] [[-Name] <string>] [-BaseMonitor <BaseMonitor>] [<CommonParameters>] Get-SqlMonitorInstance [[-Name] <string>] [-BaseMonitor <BaseMonitor>] [-Group <Group>] [<CommonParameters>] Get-SqlMonitorInstance [[-Cluster] <Cluster>] [[-Name] <string>] [-BaseMonitor <BaseMonitor>] [<CommonParameters>] Get-SqlMonitorInstance [[-LinuxMachine] <LinuxMachine>] [[-Name] <string>] [-BaseMonitor <BaseMonitor>] [<CommonParameters>]
Description
The Get-SqlMonitorInstance cmdlet gets details of Instances from the SQL Monitor Server.
Connect-SqlMonitor must be called before this cmdlet.
Parameters
-BaseMonitor
<BaseMonitor>
The Base Monitor to limit results to.
| 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 |
-Cluster
<Cluster>
The Cluster to get Instances from. For more information, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorcluster.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Machine
<Machine>
The Machine to limit results to. For more information, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitormachine.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-LinuxMachine
<LinuxMachine>
The Linux Machine to limit results to. For more information, see https://documentation.red-gate.com/sm/api/powershell-api/powershell-cmdlet-reference/get-sqlmonitorlinuxmachine.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-Name
<String>
The name of the specific instance to retrieve.
| Aliases | None |
| Required? | false |
| Position? | 2 |
| Default Value | None |
| 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.
-
[Cluster] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-Cluster.
-
[Machine] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-Machine.
-
[LinuxMachine] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-LinuxMachine.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[Instance] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-Instance.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorInstance -Cluster $cluster
-------------------------- EXAMPLE 2 --------------------------
Get-SqlMonitorInstance -Machine $machine
-------------------------- EXAMPLE 3 --------------------------
Get-SqlMonitorInstance -LinuxMachine $linuxMachine
