Get-RASVDIHostPool

NAME

Get-RASVDIHostPool

SYNOPSIS

Retrieves information about one or multiple VDI Host Pools.

SYNTAX

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

Get-RASVDIHostPool [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves information about one or multiple VDIHostPools.

The cmdlet returns an object of type VDIHostPool.

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

The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.

PARAMETERS

-Name <string> The name of the VDI Host Pool for which to retrieve the information.

This must be the actual VDI Host Pool 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 Pool 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 Pool 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. 

INPUTS

-none-

OUTPUTS

VDIHostPool

EXAMPLES

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

Get-RASVDIHostPool "My VDI Host Pool" | Format-List

Retrieves information about the VDI host pool specified by name from the Licensing Server site.

To retrieve the info from a specific site, specify the -SiteId parameter.

The Format-List cmdlet formats the display output to include all available group properties. ---------- EXAMPLE 2 ----------

Get-RASVDIHostPool -Id 10

Retrieves information about the VDI host pool specified by ID from the Licensing Server site.

RELATED LINKS

• New-RASVDIHostPool

• Set-RASVDIHostPool

• Remove-RASVDIHostPool

• Add-RASVDIHostPoolMember

• Remove-RASVDIHostPoolMember