Get-SqlMonitorSshPrivateKeys
Published 07 June 2023
Gets all SSH private keys on selected Base Monitor.
Syntax
Get-SqlMonitorSshPrivateKeys [[-BaseMonitor] <BaseMonitor>] [<CommonParameters>]
Description
The Get-SqlMonitorSshPrivateKeys cmdlet gets details of the SSH Private key from the SQL Monitor Server (Does not return the private key value, only the information displayed on Manage SSH Keys page).
Connect-SqlMonitor must be called before this cmdlet.
Parameters
-BaseMonitor
<BaseMonitor>
The Base Monitor name to get SSH key from if not provided all SSH keys are returned.
| Aliases | None |
| Required? | false |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| 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.
Return values
The output type is the type of the objects that the cmdlet emits.
-
[SshPrivate] For more information, see https://www.red-gate.com/SM13/powershell-custom-types#CustomTypes-SshPrivateKey.
Examples
-------------------------- EXAMPLE 1 --------------------------
Get-SqlMonitorSshPrivateKeys -BaseMonitor $BaseMonitor
This command will get all SSH private keys on the specified base monitor.
