Get-RDS

Get-RDS

Retrieves information about one or multiple RD Session Host servers.

Get-RDS [[-Server] <string>] [[-SiteId] <uint>] [<CommonParameters>]

Get-RDS [[-Id] <uint>] [<CommonParameters>]

Retrieves the information about one or multiple RD Session Host servers.

It returns an array of objects of type RDS, each including properties of an RD Session Host.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

Note: the result set contains only the major server properties; it does not include all of the settings supported in RAS.

-Server <string>
The name of the RD Session Host server for which to retrieve the information.

This must be the actual server name used in the RAS farm.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint>
Site ID from which to retrieve the RD Session Host server information.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint>
The ID of an RD Session Host server for which to retrieve the information.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

RDS

---------- EXAMPLE 1 ----------

Get-RDS "server.company.dom" | Format-List

Retrieves properties of the specified RD Session Host server.

The Format-List cmdlet formats the display output to include all available server properties.

---------- EXAMPLE 2 ----------

Get-RDS -Id 5

Retrieves properties of an RD Session Host server specified by ID.