These pages cover SQL Monitor 13, which is not the latest version. Help for other versions is also available.
Add-SqlMonitorSshPrivateKey
Published 07 June 2023
Adds a SSH private key to the specific base monitor.
Syntax
- Add-SqlMonitorSshPrivateKey [-BaseMonitor] <BaseMonitor> [-Name] <string> [-Key] <string> [[-Passphrase] <string>] [<CommonParameters>]
Description
Adds a SSH private key to base monitor which can be retrieved using Get-SqlMonitorSshPrivateKey.
Parameters
-BaseMonitor
<BaseMonitor>
{{ Fill BaseMonitor Description }}
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Name
<String>
{{ Fill Name Description }}
| Aliases | None |
| Required? | true |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Key
<String>
{{ Fill Key Description }}
| Aliases | None |
| Required? | true |
| Position? | 3 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Passphrase
<String>
{{ Fill Passphrase Description }}
| Aliases | None |
| Required? | false |
| Position? | 4 |
| 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.
-
[BaseMonitor] See Get-SqlMonitorBaseMonitor.
-
[string] Name for SSH private key
-
[string] SSH private key
-
[string] Passphrase for SSH private key (optional)
Examples
-------------------------- EXAMPLE 1 --------------------------
- Add-SqlMonitorSshPrivateKey -BaseMonitor $BaseMonitor -Name "machine-key" -Key "secret-key" -Passphrase "secret-passphrase"
-------------------------- EXAMPLE 2 --------------------------
- Add-SqlMonitorSshPrivateKey -BaseMonitor $BaseMonitor -Name "machine-key" -Key "secret-key"
