Set-RdsSessionHost

Establece el estado de un host de sesión.

Sintaxis

Default (Es el valor predeterminado).

Set-RdsSessionHost
    [-TenantName] <String>
    [-HostPoolName] <String>
    [-Name] <String>
    [-AllowNewSession]
    [-AssignedUser]
    [<CommonParameters>]

Description

El cmdlet Set-RdsSessionHost establece el estado del host de sesión especificado. Puede deshabilitar o habilitar nuevas conexiones con el host de sesión. El cambio de esta propiedad en el host de sesión no afecta a ninguna sesión de usuario en el host de sesión.

Ejemplos

Ejemplo 1: Deshabilitar nuevas conexiones a un host de sesión (es decir, configurar el host en modo de drenaje)

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

Este comando inhabilita el host de sesión para que no reciba nuevas conexiones y lo elimina como candidato para el equilibrio de carga. Las sesiones existentes en el servidor permanecerán allí hasta que se cierre la sesión del usuario. Un administrador puede forzar un cierre de sesión con el cmdlet Invoke-RdsUserSessionLogoff.

Ejemplo 2: Habilitar nuevas conexiones a un host de sesión (es decir, eliminar el host del modo de drenaje)

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

Este comando permite que el host de sesión reciba nuevas conexiones y ahora es un candidato para el equilibrio de carga.

Ejemplo 3: Asignar un usuario a un host de sesión de escritorio personal

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

Este comando asigna el host de sesión en un grupo de hosts de escritorio personal a user1@contoso.com. Este usuario ahora se conectará a este host de sesión cuando se conecte al grupo.

Parámetros

-AllowNewSession

Un interruptor con dos valores potenciales:

  • True, que especifica que el intermediario puede asignar nuevas sesiones de usuario al host de sesión.
  • False, que especifica que al host de la sesión no se le asignará ninguna sesión de usuario nueva (también conocido como modo de drenaje).

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-AssignedUser

Usuario que se asignará al host de sesión de escritorio personal.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-HostPoolName

Nombre del grupo de hosts.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:1
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Name

El nombre de dominio completo (FQDN) del host de sesión.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:NombreDelHostDeLaSesión

Conjuntos de parámetros

(All)
Posición:2
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-TenantName

El nombre del inquilino.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Mandatory:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

System.String

Salidas

Microsoft.RDInfra.RDManagementData.RdMgmtSessionHost