Get-RDSessionCollectionConfiguration

適用対象: Windows 10, Windows Server Technical Preview

Get-RDSessionCollectionConfiguration

Gets configuration information for a session collection.

構文

Parameter Set: General
Get-RDSessionCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

Parameter Set: Client
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -Client [-ConnectionBroker <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

Parameter Set: Connection
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -Connection [-ConnectionBroker <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

Parameter Set: LoadBalancing
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -LoadBalancing [-ConnectionBroker <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

Parameter Set: Security
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -Security [-ConnectionBroker <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

Parameter Set: UserGroup
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -UserGroup [-ConnectionBroker <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

Parameter Set: UserProfileDisk
Get-RDSessionCollectionConfiguration [-CollectionName] <String> -UserProfileDisk [-ConnectionBroker <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [ <CommonParameters>]

詳細説明

The Get-RDSessionCollectionConfiguration cmdlet gets configuration information for a specified session collection. A session collection consists of one or more Remote Desktop Session Host (RD Session Host) servers. Users can connect to RD Session Host servers in a session collection to run programs, save files, and use resources on those servers.

You can specify whether to get configuration resources for connection settings, load balancing settings, security settings, or user profile disk settings. You can also see the domain groups and users authorized to connect to the session.

パラメーター

-Client

Indicates that the cmdlet gets client settings for the session collection, such as those specified by the values of the ClientDeviceRedirectionOptions, ClientPrinterAsDefault, and ClientPrinterRedirected parameters in the Set-RDSessionCollectionConfiguration cmdlet.

Aliases

none

必須/オプション

true

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-CollectionName<String>

Specifies the name of a session collection.

Aliases

none

必須/オプション

true

位置

1

既定値

none

パイプライン入力の受け入れ

True (ByPropertyName)

ワイルドカード文字の受け入れ

false

-Connection

Indicates that the cmdlet displays connection settings for the session collection.

Aliases

none

必須/オプション

true

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-ConnectionBroker<String>

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-InformationAction<System.Management.Automation.ActionPreference>

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend

Aliases

infa

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-InformationVariable<System.String>

Specifies a variable in which to store an information event message.

Aliases

iv

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-LoadBalancing

Indicates that the cmdlet gets load balancing settings for the session collection, such as those set by the LoadBalancing parameter in the Set-RDSessionCollectionConfiguration cmdlet.

Aliases

none

必須/オプション

true

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Security

Indicates that the parameter gets the security protocol in use for the session collection.

Aliases

none

必須/オプション

true

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-UserGroup

Indicates that the cmdlet gets the list of domain groups and users authorized to connect to the session.

Aliases

none

必須/オプション

true

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-UserProfileDisk

Indicates that the cmdlet gets settings for the user profile disk for the session collection.

Aliases

none

必須/オプション

true

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

<CommonParameters>

このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

  • System.Object

使用例

Example 1: Get domain groups authorized to connection to a session collection

This command gets settings for the session collection named Session Collection 22 that has the RD Connection Broker server named RDCB.Contoso.com. The command includes the UserGroup parameter, therefore the command gets the domain groups authorized to connect to the session collection.

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -UserGroup -ConnectionBroker "RDCB.Contoso.com"

Example 2: Get connection settings for a session collection

This command gets settings for the session collection named Session Collection 22 that has the RD Connection Broker server named RDCB.Contoso.com. This command includes the Connection parameter, therefore the command gets connection settings.

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -Connection -ConnectionBroker "RDCB.Contoso.com"

Example 3: Get user profile disk settings for a session collection

This command gets settings for the session collection named Session Collection 22 that has the RD Connection Broker server named RDCB.Contoso.com. This command includes the UserProfileDisk parameter, therefore the command gets settings for the user profile disk.

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -UserProfileDisk -ConnectionBroker "RDCB.Contoso.com"

Example 4: Get security settings for a session collection

This command gets settings for the session collection named Session Collection 22 that has the RD Connection Broker server named RDCB.Contoso.com. This command includes the Security parameter, therefore the command gets security settings.

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -Security -ConnectionBroker "RDCB.Contoso.com"

Example 5: Get load balancing settings for a session collection

This command gets settings for the session collection named Session Collection 22 that has the RD Connection Broker server named RDCB.Contoso.com. This command includes the LoadBalancing parameter, therefore the command gets load balancing settings.

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -LoadBalancing -ConnectionBroker "RDCB.Contoso.com"

Example 6: Get client settings for a session collection

This command gets settings for the session collection named Session Collection 22 that has the RD Connection Broker server named RDCB.Contoso.com. This command includes the Client parameter, therefore the command gets client settings.

PS C:\> Get-RDSessionCollectionConfiguration -CollectionName "Session Collection 22" -Client -ConnectionBroker "RDCB.Contoso.com"

関連項目

Set-RDSessionCollectionConfiguration

Get-RDSessionCollection

New-RDSessionCollection

Remove-RDSessionCollection