New-DSSession

    2025-01-30

    New-DSSession

    SYNOPSIS

    Establishes a connection with your Devolutions Server instance.

    SYNTAX

    Credentials

    New-DSSession [[-Credential] <pscredential>] [-BaseUri] <string> [-DomainId <string>]
 [-Timeout <int>] [-AsApplication] [-UseOAuth] [-AsLegacyResponse] [<CommonParameters>]

    WindowsAuthentication

    New-DSSession [-BaseUri] <string> -WindowsAuthentication [-DomainId <string>] [-Timeout <int>]
 [-AsApplication] [-UseOAuth] [-AsLegacyResponse] [<CommonParameters>]

    ALIASES

    This cmdlet has the following aliases,

    DESCRIPTION

    Establishes a connection with your Devolutions Server by retrieving server informations and setting global variables that are required for accessing the API.

    EXAMPLES

    EXAMPLE 1

    PS C:> $SecurePassword = ConvertTo-SecureString 'YourPassword' -AsPlainText -Force; $SessionData = @{ BaseURI = "Your/DVLS/Instance/URL" Credential = New-Object System.Management.Automation.PSCredential ($YourUsername, $SecurePassword) };

        New-DSSession @SessionData

    Authenticate with the splatting of the hash table containing the required parameters.

    EXAMPLE 2

    PS C:> $SecurePassword = ConvertTo-SecureString $YourPassword -AsPlainText -Force $Credentials = New-Object System.Management.Automation.PSCredential ($YourUsername, $SecurePassword) $BaseURI = "Your/DVLS/Instance/URL"

        New-DSSession -Credential $Credentials -BaseURI $URI

    Authenticate by using the parameters.

    EXAMPLE 3

    PS C:> $SecurePassword = ConvertTo-SecureString $YourPassword -AsPlainText -Force $Credentials = New-Object System.Management.Automation.PSCredential ($YourUsername, $SecurePassword) $BaseURI = "Your/DVLS/Instance/URL"

        New-DSSession -Credential $Credentials -BaseURI $URI

    Authenticate using an application user.

    EXAMPLE 4

    PS C:> New-DSSession -BaseURI "Your/DVLS/Instance/URL" -WindowsAuthentication

    A Windows user authenticates himself with his logged account.

    EXAMPLE 5

    PS C:> New-DSSession -BaseURI "Your/DVLS/Instance/URL" -UseOAuth

    Authenticate using OAuth in a web browser.

    PARAMETERS

    -AsApplication

    Required when using an application user to authenticate

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

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

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

    -BaseUri

    URL to your Devolutions Server instance

    Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -Credential

    PSCredential with your Devolutions Server username and password

    Type: System.Management.Automation.PSCredential
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Credentials
  Position: 1
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

    -DomainId

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

    -Timeout

    Polling delay in seconds. Default value is 15 seconds. The value must be between 3 and 600 seconds.

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

    -UseOAuth

    Use OAuth in a web browser.

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

    -WindowsAuthentication

    Use Windows Authentication. Must be on Windows.

    Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: WindowsAuthentication
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  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.

    INPUTS

    OUTPUTS

    RemoteDesktopManager.PowerShellModule.Private.ServerResponse

    NOTES

    For more information, type "Get-Help New-DSSession -detailed". For technical information, type "Get-Help New-DSSession -full".