Your IT workflows just got faster. Devolutions 2026.2 is now available.
Explore the release
Ctrlk
Book a demoOn-demand labAcademyDownload center
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Update-DSSSHShellEntry

Synopsis

Update an SSH Shell entry.

Syntax

__AllParameterSets

Update-DSSSHShellEntry -EntryID <guid> [-Group <string>] [-Name <string>] [-Password <string>]
 [-Description <string>] [-Tags <string>] [-DisplayMode <ConnectionDisplayMode>]
 [-DisplayMonitor <DisplayMonitor>] [-DisplayVirtualDesktop <DisplayVirtualDesktop>]
 [-AlwaysAskForPassword] [-Username <string>] [-PrivateKeyType <PrivateKeyType>]
 [-PrivateKeyPath <string>] [-PrivateKeyPassphrase <string>] [-PromptForPassphrase]
 [-HostName <string>] [-HostPort <int>] [-AfterConnectMacroDelay <int>]
 [-AfterConnectMacros <string>] [-AfterConnectMacroEnterAfterCommand <bool>]
 [-BeforeDisconnectMacroDelay <int>] [-BeforeDisconnectMacro <string>]
 [-BeforeDisconnectMacroEnterAfterCommand <bool>] [-OverrideTerminalName <string>]
 [-Encoding <TerminalEncoding>] [-AutoWrap <TerminalAutoWrap>] [-LocalEcho <TerminalLocalEcho>]
 [-InitialKeypadMode <TerminalKeypadMode>] [-DisableKeypadMode <DefaultBoolean>]
 [-CursorType <TerminalCursorType>] [-CursorBlink <TerminalCursorBlink>]
 [-ForceNonDestructiveBackspace] [-ImplicitCRinLF] [-ImplicitLFinCR] [-MaxScrollbackLines <int>]
 [-DoubleClickDelimiters <string>] [-FontMode <TerminalFontMode>] [-BellMode <TerminalBellMode>]
 [-RemoteCommand <string>] [-CursorKeyMode <TerminalCursorKeyMode>]
 [-BackspaceKeyMode <TerminalBackspaceKeyMode>] [-HomeEndKeyMode <TerminalHomeEndKeyMode>]
 [-FunctionKeyMode <TerminalFunctionKeysMode>] [-ProxyMode <ProxyMode>] [-ProxyType <string>]
 [-ProxyHost <string>] [-ProxyHostPort <string>] [-ProxyUsername <string>] [-ProxyPassword <string>]
 [-ProxyLocalHostConnections <string>] [-ProxyExcludedHosts <string>]
 [-ProxyDNSLookupType <TelnetTerminalDnsLookupType>] [-ProxyTelnetCommand <string>]
 [-WarnIfAlreadyOpened] [-CredentialViewedCommentIsRequired]
 [-TicketNumberIsRequiredOnCredentialViewed] [-CredentialViewedPrompt] [-OpenCommentPrompt]
 [-OpenCommentIsRequired] [-TicketNumberIsRequiredOnOpen] [-CloseCommentPrompt]
 [-CloseCommentIsRequired] [-TicketNumberIsRequiredOnClose] [-NewFieldsList <Field[]>]
 [-AsLegacyResponse] [<CommonParameters>]

Description

Update an SSH Shell entry using supplied parameters.

Examples

Change the name and password of the specified entry.

Parameters

-AfterConnectMacroDelay

Delay in ms before starting after-connection macros. The default value is the minimal one, 500 ms.

-AfterConnectMacroEnterAfterCommand

If it should send 'Enter' input after entering an after-connection macro. True by default.

-AfterConnectMacros

Macros to run after connection

-AlwaysAskForPassword

If it should always ask for password when checking out

-AsLegacyResponse

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

-AutoWrap

Toggle terminal autowrapping

-BackspaceKeyMode

Keyboard backspace key mode (Default/Control-H/Control-? (ASCII code 127))

-BeforeDisconnectMacro

Macros to run before disconnect

-BeforeDisconnectMacroDelay

Delay in ms before starting before-disconnect macro. The default value is the minimal one, 500 ms.

-BeforeDisconnectMacroEnterAfterCommand

If it should send 'Enter' input after entering a before-disconnect macro. True by default.

-BellMode

Select bell mode behavior (Default/None/Sound/Visual)

-CloseCommentIsRequired

A comment is required on close

-CloseCommentPrompt

Prompt the user for comment/ticket number on close

-CredentialViewedCommentIsRequired

A comment is required to view entry's credentials

-CredentialViewedPrompt

Prompt the user for comment/ticket number

-CursorBlink

Toggle terminal cursor blink

-CursorKeyMode

Keyboard cursor key mode (Default/Normal/Application)

-CursorType

Select terminal cursor type (Block/Underline/Vertical line)

-Description

Entry's description

-DisableKeypadMode

Disable terminal application keypad mode

-DisplayMode

Display mode used by SSH Shell. Embedded by default.

-DisplayMonitor

Display monitor used by SSH Shell. Primary by default.

-DisplayVirtualDesktop

Virtual desktop used by SSH Shell.

-DoubleClickDelimiters

Delemiters for double-clicking in terminal

-Encoding

Select terminal encoding

-EntryID

ID of the entry to modify.

-FontMode

Select font mode (Default/Override)

-ForceNonDestructiveBackspace

Force non-destructive backspaces (Disable character 127)

-FunctionKeyMode

Keyboard fn key mode

-Group

Entry's location in the vault (folder name, not ID)

-HomeEndKeyMode

Keyboard home/end key mode (Default/Standard/RXVT)

-HostName

Entry's hostname

-HostPort

Entry's host port. 22 by default.

-ImplicitCRinLF

Convert CR to LF

-ImplicitLFinCR

Convert LF to CR

-InitialKeypadMode

Terminal's initial keypad mode (Default/Enable (Application in Putty)/Disable (Normal in Putty))

-LocalEcho

Toggle terminal local echo

-MaxScrollbackLines

Terminal max scrollback lines. 2000 lines by default.

-Name

Entry's name

-NewFieldsList

Fields to add

-OpenCommentIsRequired

A comment is required on open

-OpenCommentPrompt

Prompt the user for comment/ticket number on open

-OverrideTerminalName

Override terminal type

-Password

Entry's password

-PrivateKeyPassphrase

Private key passphrase

-PrivateKeyPath

Full private key path (*.ppk)

-PrivateKeyType

Private key type. The default type is NoKey.

-PromptForPassphrase

Prompt for passphrase before checkout.

-ProxyDNSLookupType

Proxy DNS lookup mode. Automatic by default.

-ProxyExcludedHosts

Proxy excluded hosts

-ProxyHost

Proxy Hostname

-ProxyHostPort

Proxy host port

-ProxyLocalHostConnections

Proxy localhost connections

-ProxyMode

Proxy mode (Only None/custom supported)

-ProxyPassword

Proxy password

-ProxyTelnetCommand

Telnet/local proxy command (blank for default)

-ProxyType

Proxy type. Socks5 by default.

-ProxyUsername

Proxy username

-RemoteCommand

Ignored. Absolute path of the application on the remote computer

-Tags

Entry's tags (keywords). Each word separated by a space is considered a keyword.

-TicketNumberIsRequiredOnClose

A ticket number is required on close

-TicketNumberIsRequiredOnCredentialViewed

A ticket number is required to view entry's credentials

-TicketNumberIsRequiredOnOpen

A ticket number is required on open

-Username

Entry's username

-WarnIfAlreadyOpened

Warns the user if session is already opened

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

For more information, type "Get-Help Update-DSSSHShellEntry -detailed". For technical information, type "Get-Help Update-DSSSHShellEntry -full".

PreviousUpdate-DSRoleNextUpdate-DSUser

Last updated

Was this helpful?