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-DSRDPEntry

Synopsis

Update a RDP entry.

Syntax

__AllParameterSets

Update-DSRDPEntry -EntryID <guid> [-ForceAlternateShellProgram] [-Name <string>] [-Domain <string>]
 [-Username <string>] [-Password <string>] [-MnemonicPassword <string>] [-Group <string>]
 [-PromptCredentials] [-LinkedCredentialValue <string>] [-CredentialMode <CredentialSourceMode>]
 [-Description <string>] [-Tags <string>] [-Expiration <string>] [-WarnIfAlreadyOpened]
 [-CredentialViewedCommentIsRequired] [-TicketNumberIsRequiredOnCredentialViewed]
 [-CredentialViewedPrompt] [-OpenCommentPrompt] [-OpenCommentIsRequired]
 [-TicketNumberIsRequiredOnOpen] [-CloseCommentPrompt] [-CloseCommentIsRequired]
 [-TicketNumberIsRequiredOnClose] [-CheckoutMode <CheckOutMode>] [-AllowOffline <AllowOffline>]
 [-HostName <string>] [-AdminMode] [-Port <string>] [-RDPType <RDPType>] [-RoleName <string>]
 [-AzureInstanceID <int>] [-HyperVInstance <string>] [-UseEnhancedSessionMode]
 [-UsesClipboard <bool>] [-UsesDevices] [-UsesHardDrives <bool>] [-UsesPrinters]
 [-UsesSerialPorts <bool>] [-UsesSmartDevices] [-SoundHook <SoundHook>]
 [-AudioQualityMode <RDPAudioQualityMode>] [-AudioCaptureRedirectionMode <bool>]
 [-KeyboardHook <string>] [-AlternateShell <string>] [-ShellWorkingDirectory <string>]
 [-AfterLoginProgram <string>] [-AfterLoginDelay <int>] [-RemoteApplicationProgram <string>]
 [-RemoteApplicationCmdLine <string>] [-NetworkConnectionType <string>] [-DesktopBackground <bool>]
 [-FontSmoothing] [-DesktopComposition] [-Animations] [-VisualStyles <bool>] [-NetworkAutoDetect]
 [-AutoReconnection <bool>] [-RedirectDirectX] [-RedirectVideoPlayback]
 [-ShowContentWhileDragging <bool>] [-DataCompression <bool>] [-PersistentBitmapCaching <bool>]
 [-BandwidthAutoDetect <bool>] [-LoadAddonsMode <DefaultBoolean>] [-ClientSpec <RDPClientSpec>]
 [-KeepAliveInternal <int>] [-DisplayMode <ConnectionDisplayMode>]
 [-DisplayMonitor <DisplayMonitor>] [-DisplayVirtualDesktop <DisplayVirtualDesktop>]
 [-NewFieldsList <Field[]>] [-AsLegacyResponse] [<CommonParameters>]

Description

Update a RDP entry with the parameters supplied.

Examples

Update a specified RDP entry by activating the warn if already opened and requesting a prompt with a ticket number on opening it.

Parameters

-AdminMode

Open the administration console

-AfterLoginDelay

Delay (in miliseconds) to launch application after login. 500 ms by default. Must be betwen 0 and 6000.

-AfterLoginProgram

Path (including filename) of application to launch in alternate shell

-AllowOffline

Entry's offline mode.

-AlternateShell

Path (including filename) of application to launch in alternate shell

-Animations

Enable animations

-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.

-AudioCaptureRedirectionMode

ecord audio from RDP session. True by default.

-AudioQualityMode

RDP Audio Quality. Dynamic by default.

-AutoReconnection

Enable automatic reconnection if RDP drop. True by default.

-AzureInstanceID

Azure Cloud Service's instance ID

-BandwidthAutoDetect

Enable bandwith autodetection. True by default.

-CheckoutMode

Entry's checkout mode.

-ClientSpec

Cache specifications

-CloseCommentIsRequired

A comment is required on close

-CloseCommentPrompt

Prompt the user for comment/ticket number on close

-CredentialMode

Credential mode: CredentialEntry => Credential entry in the same vault. Must use the 'LinkedCredentialValue' parameter to specify the credential ID. PrivilegedAccount => PAM Account to link. Must use the 'LinkedCredentialValue' parameter to specify the PAM account ID. PrivateVaultSearch => Credential in the user vault. Must use the 'LinkedCredentialValue' parameter to specify the credential name.

-CredentialViewedCommentIsRequired

A comment is required to view entry's credentials

-CredentialViewedPrompt

Prompt the user for comment/ticket number

-DataCompression

Enable data compression. True by default.

-Description

Entry's description

-DesktopBackground

Enable desktop background. True by default.

-DesktopComposition

Enable desktop composition

-DisplayMode

Display mode used by RDP. Embedded by default.

-DisplayMonitor

Display monitor used by RDP. Primary by default.

-DisplayVirtualDesktop

Virtual desktop used by RPD. Current by default

-Domain

Domain's name

-EntryID

ID of the entry to modify.

-Expiration

Entry's expiration date (ISO-8601 format (yyyy-mm-ddThh:mm:ss.000Z)

-FontSmoothing

Enable font smoothing

-ForceAlternateShellProgram

Force alternate shell use instead of the preferred method RemoteApp.

-Group

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

-HostName

RDP's host name (Address)

-HyperVInstance

Hyper-V Instance

-KeepAliveInternal

Keep alive. 1000 by default.

-KeyboardHook

Sets the destination for Windows key combinations (ALT+TAB, for example)

-LinkedCredentialValue

Linked credential ID or the user vault credential's name

-LoadAddonsMode

Sets if addons load in embedded or not.

-MnemonicPassword

Ignored. Entry's mnemonic password to help remembering the password

-Name

Entry's name

-NetworkAutoDetect

Enable network autodetection

-NetworkConnectionType

Connection speed to use for RDP

-NewFieldsList

Fields to add

-OpenCommentIsRequired

A comment is required on open

-OpenCommentPrompt

Prompt the user for comment/ticket number on open

-Password

Entry's password

-PersistentBitmapCaching

Enable persistent bitmap caching. True by default.

-Port

Port used by RDP. 3389 by default.

-PromptCredentials

Prompt for password when checkout

-RDPType

RDP Type. Normal by default.

-RedirectDirectX

Enable DirectX redirection

-RedirectVideoPlayback

Enable video playback redirection

-RemoteApplicationCmdLine

Parameters for the remote application

-RemoteApplicationProgram

Path (including filename and extension) of application to launch

-RoleName

Azure Cloud Services role name

-ShellWorkingDirectory

Path for alternate shell directory

-ShowContentWhileDragging

Enable content showing while dragging across screen. True by default.

-SoundHook

Choose destination for sounds. BringToThisComputer by default.

-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

-UseEnhancedSessionMode

Hyper-V enhanced session (Uses machine's local resources, such as USB drive or printer)

-Username

Entry's username

-UsesClipboard

RDP access to clipboard. True by default.

-UsesDevices

RDP access to "devices" (Such as cameras...)

-UsesHardDrives

RDP access to hard drives. True by default.

-UsesPrinters

RDP access to printers

-UsesSerialPorts

RDP access to serial ports. True by default.

-UsesSmartDevices

RDP access to smart devices

-VisualStyles

Enable visual styles. True by default.

-WarnIfAlreadyOpened

Warns the user if RDP 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-DSRDPEntry -detailed". For technical information, type "Get-Help Update-DSRDPEntry -full".

PreviousUpdate-DSPamVaultNextUpdate-DSRole

Last updated

Was this helpful?