Set-RDMSession

Synopsis

Save/set the session.

Syntax

__AllParameterSets

Set-RDMSession [-Session] <PSConnection[]> [-Refresh] [-ForcePromptAnswer <DialogResult[]>]
 [<CommonParameters>]

Description

Save/set the session. Session must be first fetch via Session property of the Get-RDM-Session cmdlet or via the New-RDMSession result.

Examples

Example 1

PS C:\> $list = Get-RDMSession; $list[1].Name = "New Name";Set-RDMSession $list[1]

Retrieves the list of available sessions, modify the name of the second session, update the session.

Example 2

PS C:\> $session = New-RDMSession -Name "New Session" -Host "myServer" -Kind "RDPConfigured";Set-RDMSession $session

Create & save new session.

Example 3

PS C:\> [Devolutions.Generated.Models.Connection].DeclaredFields | Where-Object -Property Name -like "*ConnectionID" | Select-Object -Property Name; $session = Get-RDMSession -Name ARDP"; $session.CredentialConnectionID = [Devolutions.Generated.Models.Connection]::MyDefaultCredentialConnectionID; Set-RDMSession $session

The user looks at the options for the type of credentials for entries. After finding the desired one, they get the session ARDP. He sets the credentials to 'My Personal Credentials' and save the modification.

Parameters

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

• Yes: Accept the prompt. Cover the OK and Automatic value.
• No: Refuse the yes/no/cancel prompt. "Cancel" is the fallback option if there is no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Refresh

Send refresh notification to Remote Desktop Manager application.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Session

PSSession object, must be retrieved from Get-RDMSession or created via New-RDMSession.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

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 Set-RDMSession -detailed". For technical information, type "Get-Help Set-RDMSession -full".