Public/Entries/New-DSSSHShellEntry.ps1
|
function New-DSSSHShellEntry { <# .SYNOPSIS .DESCRIPTION .EXAMPLE #> [CmdletBinding()] PARAM ( [string]$Group = '', [ValidateNotNullOrEmpty()] [string]$Name = $(throw 'Name is null or empty. Please provide a name for this new entry and try again.'), [string]$Password = '', [ValidateSet( [Devolutions.RemoteDesktopManager.ConnectionDisplayMode]::Embedded, [Devolutions.RemoteDesktopManager.ConnectionDisplayMode]::External )] [string]$DisplayMode = [Devolutions.RemoteDesktopManager.ConnectionDisplayMode]::Embedded, [Devolutions.RemoteDesktopManager.DisplayMonitor]$DisplayMonitor = [Devolutions.RemoteDesktopManager.DisplayMonitor]::Primary, [Devolutions.RemoteDesktopManager.DisplayVirtualDesktop]$DisplayVirtualDesktop = [Devolutions.RemoteDesktopManager.DisplayVirtualDesktop]::Default, [bool]$AlwaysAskForPassword = $false, [string]$Username = '', [ValidateSet( [Devolutions.RemoteDesktopManager.PrivateKeyType]::Data, [Devolutions.RemoteDesktopManager.PrivateKeyType]::NoKey )] [string]$PrivateKeyType = [Devolutions.RemoteDesktopManager.PrivateKeyType]::NoKey, [string]$PrivateKeyPath = '', [string]$PrivateKeyPassphrase = '', [bool]$PromptForPassphrase = '', [string]$HostName = '', [int]$HostPort = 22, [int]$AfterConnectMacroDelay = 500, [string]$AfterConnectMacros = '', [bool]$AfterConnectMacroEnterAfterCommand = $true, [int]$BeforeDisconnectMacroDelay = 500, [string]$BeforeDisconnectMacro = '', [bool]$beforeDisconnectMacroEnterAfterCommand = $true, [string]$OverrideTerminalName = '', [Devolutions.RemoteDesktopManager.TerminalEncoding]$Encoding = [Devolutions.RemoteDesktopManager.TerminalEncoding]::Default, [Devolutions.RemoteDesktopManager.TerminalAutoWrap]$AutoWrap = [Devolutions.RemoteDesktopManager.TerminalAutoWrap]::Default, [Devolutions.RemoteDesktopManager.TerminalLocalEcho]$LocalEcho = [Devolutions.RemoteDesktopManager.TerminalLocalEcho]::Default, [Devolutions.RemoteDesktopManager.TerminalKeypadMode]$InitialKeypadMode = [Devolutions.RemoteDesktopManager.TerminalKeypadMode]::Default, [Devolutions.RemoteDesktopManager.DefaultBoolean]$DisableKeypadMode = [Devolutions.RemoteDesktopManager.DefaultBoolean]::Default, [Devolutions.RemoteDesktopManager.TerminalCursorType]$CursorType = [Devolutions.RemoteDesktopManager.TerminalCursorType]::Default, [Devolutions.RemoteDesktopManager.TerminalCursorBlink]$CursorBlink = [Devolutions.RemoteDesktopManager.TerminalCursorBlink]::Default, [bool]$ForceNonDestructiveBackspace = $false, [bool]$ImplicitCRinLF = $false, [bool]$ImplicitLFinCR = $false, [int]$MaxScrollbackLines = 2000, [string]$DoubleClickDelimiters = '', [Devolutions.RemoteDesktopManager.TerminalFontMode]$FontMode = [Devolutions.RemoteDesktopManager.TerminalFontMode]::Default, [Devolutions.RemoteDesktopManager.TerminalBellMode]$BellMode = [Devolutions.RemoteDesktopManager.TerminalBellMode]::Default, [string]$RemoteCommand = '', [Devolutions.RemoteDesktopManager.TerminalCursorKeyMode]$CursorKeyMode = [Devolutions.RemoteDesktopManager.TerminalCursorKeyMode]::Default, [Devolutions.RemoteDesktopManager.TerminalBackspaceKeyMode]$BackspaceKeyMode = [Devolutions.RemoteDesktopManager.TerminalBackspaceKeyMode]::Default, [Devolutions.RemoteDesktopManager.TerminalHomeEndKeyMode]$HomeEndKeyMode = [Devolutions.RemoteDesktopManager.TerminalHomeEndKeyMode]::Default, [Devolutions.RemoteDesktopManager.TerminalFunctionKeysMode]$FunctionKeyMode = [Devolutions.RemoteDesktopManager.TerminalFunctionKeysMode]::Default, [ValidateSet( [Devolutions.RemoteDesktopManager.ProxyMode]::Custom, [Devolutions.RemoteDesktopManager.ProxyMode]::None )] [string]$ProxyMode = [Devolutions.RemoteDesktopManager.ProxyMode]::None, [ValidateSet( [Devolutions.RemoteDesktopManager.ProxyTunnelType]::Socks5, [Devolutions.RemoteDesktopManager.ProxyTunnelType]::Socks4, [Devolutions.RemoteDesktopManager.ProxyTunnelType]::Http )] [string]$ProxyType = [Devolutions.RemoteDesktopManager.ProxyTunnelType]::Socks5, [string]$ProxyHost = '', [string]$ProxyHostPort = 0, [string]$ProxyUsername = '', [string]$ProxyPassword = '', [string]$ProxyLocalHostConnections = '', [string]$ProxyExcludedHosts = '', [Devolutions.RemoteDesktopManager.TelnetTerminalDnsLookupType]$ProxyDNSLookupType = [Devolutions.RemoteDesktopManager.TelnetTerminalDnsLookupType]::Automatic, [string]$ProxyTelnetCommand = '', [bool]$WarnIfAlreadyOpened = $false, [bool]$OpenCommentPrompt = $false, [bool]$OpenCommentIsRequired = $false, [bool]$TicketNumberIsRequiredOnOpen = $false, [bool]$CloseCommentPrompt = $false, [bool]$CloseCommentIsRequired = $false, [bool]$TicketNumberIsRequiredOnClose = $false, [bool]$CredentialViewedPrompt = $false, [bool]$CredentialViewedCommentIsRequired = $false, [bool]$TicketNumberIsRequiredOnCredentialViewed = $false ) BEGIN { Write-Verbose '[New-DSSSHShellEntry] Beginning...' $URI = "$env:DS_URL/api/connections/partial/save" if ([string]::IsNullOrWhiteSpace($Global:DSSessionToken)) { throw 'Session does not seem authenticated, call New-DSSession.' } } PROCESS { try { $SSHShell = @{ connectionType = [Devolutions.RemoteDesktopManager.ConnectionType]::SSHShell group = $Group name = $Name displayMode = $DisplayMode DisplayMonitor = $DisplayMonitor displayVirtualDesktop = $DisplayVirtualDesktop data = @{ alwaysAskForPassword = $AlwaysAskForPassword username = $Username privateKeyType = $PrivateKeyType host = $Hostname hostPort = $HostPort afterConnectMacroDelay = ( { 500 }, $AfterConnectMacroDelay )[!($AfterConnectMacroDelay -lt 500)] afterConnectMacros = $AfterConnectMacros afterConnectMacroEnterAfterCommand = $afterConnectMacroEnterAfterCommand beforeDisconnectMacroDelay = ( { 500 }, $BeforeDisconnectMacroDelay )[!($BeforeDisconnectMacroDelay -lt 500)] beforeDisconnectMacroEnterAfterCommand = $beforeDisconnectMacroEnterAfterCommand beforeDisconnectMacro = $BeforeDisconnectMacro overrideTerminalName = $OverrideTerminalName encoding = $Encoding autoWrap = $AutoWrap localEcho = $LocalEcho initialKeypadMode = $InitialKeypadMode disableKeypadMode = $DisableKeypadMode cursorType = $CursorType cursorBlink = $CursorBlink forceNonDestructiveBackspace = $ForceNonDestructiveBackspace implicitCRinLF = $ImplicitCRinLF implicitLFinCR = $ImplicitLFinCR maxScrollbackLines = $MaxScrollbackLines doubleClickDelimiters = $DoubleClickDelimiters fontMode = $FontMode bellMode = $BellMode cursorKeyMode = $CursorKeyMode backspaceKeyMode = $BackspaceKeyMode homeEndKeyMode = $HomeEndKeyMode functionKeyMode = $FunctionKeyMode proxyMode = $ProxyMode proxyType = $ProxyType } event = @{ WarnIfAlreadyOpened = $WarnIfAlreadyOpened OpenCommentPrompt = $OpenCommentPrompt OpenCommentIsRequired = $OpenCommentIsRequired TicketNumberIsRequiredOnOpen = $TicketNumberIsRequiredOnOpen CloseCommentPrompt = $CloseCommentPrompt CloseCommentIsRequired = $CloseCommentIsRequired TicketNumberIsRequiredOnClose = $TicketNumberIsRequiredOnClose CredentialViewedPrompt = $CredentialViewedPrompt CredentialViewedCommentIsRequired = $CredentialViewedCommentIsRequired TicketNumberIsRequiredOnCredentialViewed = $TicketNumberIsRequiredOnCredentialViewed } } if ($Password) { $SSHShell.data += @{ passwordItem = @{ hasSensitiveData = $true sensitiveData = $Password } } } #Handling general/private key switch ($PrivateKeyType) { 'Data' { #Validate private key, if path was provided if (![string]::IsNullOrEmpty($PrivateKeyPath)) { $PrivateKeyCtx = Confirm-PrivateKey $PrivateKeyPath if ($PrivateKeyCtx.Body.result -ne [Devolutions.RemoteDesktopManager.SaveResult]::Success) { throw [System.Management.Automation.ItemNotFoundException]::new('Private key could not be parsed. Please make sure you provide a valid .ppk file.') } $SSHShell.data += @{ privateKeyData = $PrivateKeyCtx.Body.privateKeyData } if ($PrivateKeyPassphrase) { $SSHShell += @{ privateKeyPassPhraseItem = @{ hasSensitiveData = $true sensitiveData = $PrivateKeyPassphrase } } } if ($PromptForPassphrase) { $SSHShell += @{ privateKeyPromptForPassPhrase = $PromptForPassphrase } } } } 'NoKey' { } Default { Write-Warning "[New-DSSSHShellEntry] Unsupported private key type. Supported types are : 'NoKey' and 'Data'." } } #Handling general/proxy switch ($ProxyMode) { 'None' { $SSHShell.data += @{ roxyMode = $ProxyMode } } 'Custom' { $SSHShell.data += @{ roxyMode = $ProxyMode proxyHost = $ProxyHost proxyHostPort = $ProxyHostPort proxyUserName = $ProxyUsername proxyLocalHostConnections = $ProxyLocalHostConnections proxyExcludedHosts = $ProxyExcludedHosts proxyDnsLookupType = $ProxyDNSLookupType proxyTelnetCommand = $ProxyTelnetCommand } if ($ProxyPassword) { $SSHShell.data += @{ proxyPasswordItem = @{ hasSensitiveData = $true sensitiveData = $ProxyPassword } } } } } $res = New-DSEntryBase $SSHShell return $res } catch { Write-Error $_.Exception.Message } } END { if ($res.isSuccess) { Write-Verbose '[New-DSSSHShellEntry] Completed successfully!' } else { Write-Verbose '[New-DSSSHShellEntry] Ended with errors...' } } } |