New-DSSession

Synopsis

Établit une connexion avec votre instance de Devolutions Server.

Syntaxe

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

Établit une connexion avec votre Devolutions Server en récupérant les informations du serveur et en définissant les variables globales requises pour accéder à l'API.

Exemples

Exemple 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

S'authentifier avec l'éclatement de la table de hachage contenant les paramètres requis.

Exemple 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

S'authentifier en utilisant les paramètres.

Exemple 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

S'authentifier en utilisant un utilisateur d'application.

Exemple 4

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

Un utilisateur Windows s'authentifie avec son compte de session.

Exemple 5

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

S'authentifier via OAuth dans un navigateur web.

Paramètres

-AsApplication

Obligatoire lors de l'utilisation d'un utilisateur d'application pour s'authentifier.

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

Dans les versions antérieures à 2024.2, de nombreuses applets de commande DS retournaient un objet ServerResponse. L'activation de ce commutateur de compatibilité descendante permet aux scripts développés pour des versions antérieures de fonctionner correctement.

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 vers votre instance de Devolutions Server.

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 contenant votre nom d'utilisateur et mot de passe Devolutions Server.

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

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

Délai d'interrogation en secondes. La valeur par défaut est 15 secondes. La valeur doit être comprise entre 3 et 600 secondes.

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

Utiliser OAuth dans un navigateur web.

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

Utiliser l'authentification Windows. Doit être exécuté sur Windows.

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

Cette applet de commande prend en charge les paramètres communs : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d'informations, consultez about_CommonParameters.

Notes

Pour plus d'informations, tapez "Get-Help New-DSSession -detailed". Pour des informations techniques, tapez "Get-Help New-DSSession -full".