Set-RdsSessionHost

Ustawia stan hosta sesji.

Składnia

Default (Domyślna)

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

Opis

Polecenie cmdlet Set-RdsSessionHost ustawia stan określonego hosta sesji. Możesz wyłączyć lub włączyć nowe połączenia z hostem sesji. Zmiana tej właściwości na hoście sesji nie ma wpływu na żadne sesje użytkowników na hoście sesji.

Przykłady

Przykład 1: Wyłączanie nowych połączeń z hostem sesji (czyli ustawianie hosta w trybie opróżniania)

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

To polecenie wyłącza odbieranie nowych połączeń przez hosta sesji i usuwa go jako kandydata do równoważenia obciążenia. Wszystkie istniejące sesje na serwerze pozostaną na nim do momentu wylogowania użytkownika. Administrator może wymusić wylogowanie za pomocą polecenia cmdlet Invoke-RdsUserSessionLogoff.

Przykład 2: Włączanie nowych połączeń z hostem sesji (czyli usuwanie hosta z trybu opróżniania)

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

To polecenie umożliwia hostowi sesji odbieranie nowych połączeń i jest teraz kandydatem do równoważenia obciążenia.

Przykład 3: Przypisywanie użytkownika do hosta sesji pulpitu osobistego

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

To polecenie przypisuje hosta sesji w puli hostów komputerów stacjonarnych do user1@contoso.com. Ten użytkownik będzie teraz łączył się z tym hostem sesji podczas nawiązywania połączenia z pulą.

Parametry

-AllowNewSession

Przełącznik o dwóch wartościach potencjału:

  • True, określając, że host sesji może być przypisywany do nowych sesji użytkowników przez brokera.
  • False, określając, że host sesji nie zostanie przypisany do żadnych nowych sesji użytkownika (tzw. tryb opróżniania).

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-AssignedUser

Użytkownik, który ma zostać przypisany do hosta sesji pulpitu osobistego.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowy:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-HostPoolName

Nazwa puli hostów.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:1
Obowiązkowy:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Name

W pełni kwalifikowana nazwa domeny (FQDN) hosta sesji.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:NazwaHostaSesji

Zestawy parametrów

(All)
Position:2
Obowiązkowy:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-TenantName

Nazwa dzierżawy.

Właściwości parametru

Typ:String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:0
Obowiązkowy:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

System.String

Dane wyjściowe

Microsoft.RDInfra.RDManagementData.RdMgmtSessionHost