Redgate Monitor 14

New-RedgateMonitorLinuxHost

Creates a new temporary object that holds information about a Linux host.

Syntax

New-RedgateMonitorLinuxHost -FullName <string> -BaseMonitor <BaseMonitor> [-Group <Group>] [-UserName <string>] [-Password <string>] [-SshPort <int>] [-SshHostKey <string>] [<CommonParameters>]

New-RedgateMonitorLinuxHost -FullName <string> -BaseMonitor <BaseMonitor> [-Group <Group>] [-UserName <string>] [-SshPrivateKey <SshPrivateKey>] [-SshPort <int>] [-SshHostKey <string>] [<CommonParameters>]

Description

The New-RedgateMonitorLinuxHost cmdlet creates a new temporary object that holds information about a Linux host. The returned object needs to be passed to Add-RedgateMonitorMonitoredObject, as it does not add anything to Redgate 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 information, see https://documentation.red-gate.com/monitor14/api/powershell-api/powershell-cmdlet-reference/get-redgatemonitorbasemonitor.

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

-SshPort <Int32>

The SSH Port to connect to the Linux Host

Aliases None
Required? false
Position? named
Default Value 22
Accept Pipeline Input False
Accept Wildcard Characters false

-SshHostKey <String>

The SSH host key to trust, as one line of ssh-keygen -lf output, e.g. "256 SHA256:uNiVztksCsDhcc0u9e8BujQXVUpKZIDTMczCvj3tD2s root@linux-host (ED25519)". To get the lines, run "cat /etc/ssh/ssh_host_*_key.pub | ssh-keygen -lf -" on the Linux host, then give one line as printed. If the Linux host is already monitored, the key must match the key that Redgate Monitor trusts for it.

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, -OutVariable, and -ProgressAction. 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-RedgateMonitorLinuxHost -HostName "localhost" -BaseMonitor $BaseMonitor -SshUserName "ssh_user" -SshPassword "ssh_pass"
$instance = New-RedgateMonitorSqlServer -FullName "localhost" -BaseMonitor $BaseMonitor -UserName "sql_username" -Password "sql_pass"
$server, $instance | Add-RedgateMonitorMonitoredObject

This documentation contains proprietary information and is protected by copyright law.
Copyright © 2026 Red Gate Software Limited. All rights reserved


Didn't find what you were looking for?