Set-RdsSessionHost
Définit l’état d’un hôte de session.
Syntaxe
Default (Par défaut)
Set-RdsSessionHost
[-TenantName] <String>
[-HostPoolName] <String>
[-Name] <String>
[-AllowNewSession]
[-AssignedUser]
[<CommonParameters>]
Description
L’applet de commande Set-RdsSessionHost définit l’état de l’hôte de session spécifié. Vous pouvez désactiver ou activer de nouvelles connexions à l’hôte de session. La modification de cette propriété sur l’hôte de session n’affecte pas les sessions utilisateur sur l’hôte de session.
Exemples
Exemple 1 : Désactiver les nouvelles connexions à un hôte de session (c’est-à-dire régler l’hôte en mode drain)
PS C:\> Set-RdsSessionHost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com" -AllowNewSession $false
SessionHostName : sh1.contoso.com
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
AllowNewSession : False
Sessions : 1
LastHeartBeat : 1/1/2018 12:00:00 PM
AgentVersion : 1.0.0.1
AssignedUser :
Status : Available
StatusTimestamp : 1/1/2018 12:00:00 PM
Cette commande empêche l’hôte de session de recevoir de nouvelles connexions et le supprime en tant que candidat à l’équilibrage de charge. Toutes les sessions existantes sur le serveur y resteront jusqu’à ce que l’utilisateur soit déconnecté. Un administrateur peut forcer une fermeture de session à l’aide de l’applet de commande Invoke-RdsUserSessionLogoff.
Exemple 2 : Activer de nouvelles connexions à un hôte de session (c’est-à-dire retirer l’hôte du mode drain)
PS C:\> Set-RdsSessionHost -TenantName "contoso" -HostPoolName "contosoHostPool" -Name "sh1.contoso.com" -AllowNewSession $true
SessionHostName : sh1.contoso.com
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoHostPool
AllowNewSession : True
Sessions : 1
LastHeartBeat : 1/1/2018 12:00:00 PM
AgentVersion : 1.0.0.1
AssignedUser :
Status : Available
StatusTimestamp : 1/1/2018 12:00:00 PM
Cette commande permet à l’hôte de session de recevoir de nouvelles connexions et est désormais candidate à l’équilibrage de charge.
Exemple 3 : Affecter un utilisateur à un hôte de session de bureau personnel
PS C:\> Set-RdsSessionHost -TenantName "contoso" -HostPoolName "contosoPersonalDesktops" -Name "sh1.contoso.com" -AssignedUser user1@contoso.com
SessionHostName : sh1.contoso.com
TenantName : contoso
TenantGroupName : Default Tenant Group
HostPoolName : contosoPersonalDesktops
AllowNewSession : True
Sessions : 1
LastHeartBeat : 1/1/2018 12:00:00 PM
AgentVersion : 1.0.0.1
AssignedUser : user1@contoso.com
Status : Available
StatusTimestamp : 1/1/2018 12:00:00 PM
Cette commande attribue l’hôte de session dans un pool d’hôtes de bureau personnel à user1@contoso.com. Cet utilisateur se connectera désormais à cet hôte de session lors de la connexion au pool.
Paramètres
-AllowNewSession
Un interrupteur avec deux valeurs potentielles :
- True, spécifiant que l’hôte de session peut se voir attribuer de nouvelles sessions utilisateur par le répartiteur.
- False, spécifiant que l’hôte de session ne se verra attribuer aucune nouvelle session utilisateur (c’est-à-dire le mode drain).
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-AssignedUser
Utilisateur à affecter à l’hôte de session de bureau personnel.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-HostPoolName
Nom du pool d’hôtes.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 1 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-Name
Nom de domaine complet (FQDN) de l’hôte de session.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Nom de l'hôte de session |
Jeux de paramètres
(All)
| Position: | 2 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-TenantName
Nom du client.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.