> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell/powershell-commands/new-dssession.md).

# 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>]
```

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

```powershell
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

```powershell
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

```powershell
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

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

A Windows user authenticates themselves with their logged account.

#### Example 5

```powershell
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

```yaml
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: ''
```

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

```yaml
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: ''
```

#### -BaseUri

URL to your Devolutions Server instance

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

#### -Credential

PSCredential with your Devolutions Server username and password

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

#### -DomainId

```yaml
Type: System.String
DefaultValue: ''
SupportsWildcards: false
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.

```yaml
Type: System.Int32
DefaultValue: ''
SupportsWildcards: false
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.

```yaml
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: ''
```

#### -WindowsAuthentication

Use Windows Authentication. Must be on Windows.

```yaml
Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
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](https://go.microsoft.com/fwlink/?LinkID=113216).

### Notes

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.devolutions.net/powershell/powershell-commands/new-dssession.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.