Get-VDIHost

Get-VDIHost

Retrieves information about one or multiple VDI Host servers.

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

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

Retrieves the information about one or multiple VDI Host servers.

It returns an array of objects of type VDIHost, each including properties of a VDI Host server.

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 VDI 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 VDI 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 a VDI 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. 

VDIHost

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

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

Retrieves properties of the specified VDI Host server.

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

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

Get-VDIHost -Id 5

Retrieves properties of a VDI Host server specified by ID.