New-SqlMonitorLinuxHost
Published 21 March 2023
Creates a new temporary object that holds information about a Linux host.
Syntax
New-SqlMonitorLinuxHost -FullName <string> -BaseMonitor <BaseMonitor> [-Group <Group>] [-UserName <string>] [-Password <string>] [<CommonParameters>] New-SqlMonitorLinuxHost -FullName <string> -BaseMonitor <BaseMonitor> [-Group <Group>] [-UserName <string>] [-SshPrivateKey <SshPrivateKey>] [<CommonParameters>]
Description
The New-SqlMonitorLinuxHost cmdlet creates a new temporary object that holds information about a Linux host. The returned object needs to be passed to Add-SqlMonitorMonitoredObject, as it does not add anything to SQL Monitor on its own.
Parameters
-FullName
<String>
The address of the monitored object e.g. "localhost".
| Aliases | None |
| Required? | true |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-BaseMonitor
<BaseMonitor>
The base monitor to add the monitored object to. For more informatiom, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorbasemonitor.
| Aliases | None |
| Required? | true |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Group
<Group>
Group object - use Get-Group or related methods to find the group.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-UserName
<String>
The SSH username to connect to the Linux host.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Password
<String>
The SSH Password to connect to the Linux host.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-SshPrivateKey
<SshPrivateKey>
The SSH Private Key to connect to the Linux host.
| Aliases | None |
| Required? | false |
| Position? | named |
| 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.
-
None.
You cannot pipe input to this cmdlet.
Examples
-------------------------- EXAMPLE 1 --------------------------
$server = New-SqlMonitorLinuxHost -HostName "localhost" -BaseMonitor $BaseMonitor -SshUserName "ssh_user" -SshPassword "ssh_pass" $instance = New-SqlMonitorSqlServer -FullName "localhost" -BaseMonitor $BaseMonitor -UserName "sql_username" -Password "sql_pass" $server, $instance | Add-SqlMonitorMonitoredObject
