Get-RASVDIHost
NAME
Get-RASVDIHost
SYNOPSIS
Retrieves the host VM list from a Provider in real-time.
SYNTAX
Get-RASVDIHost [ProviderId]** (uint) [[-SiteId] (uint)] -Id (string) [User (string)] [VDITemplateId (uint)] [(CommonParameters)]
Get-RASVDIHost [[-ProviderId]** (uint)] [[-SiteId] (uint)] [User (string)] [VDITemplateId (uint)] [(CommonParameters)]
Get-RASVDIHost [-VDITemplateObj] (Template) [[-SiteId] (uint)] [User (string)] [VDITemplateId (uint)] [(CommonParameters)]
DESCRIPTION
Retrieves the list of host VMs from one or multiple Provider servers.
Returns an array of objects of type VDIHost, each containing properties of a host VM.
To see the complete list of object properties, use the Format-List cmdlet (see examples).
Note: the returned object contains only the major properties of a host VM; it does not include all of the settings supported in RAS.
PARAMETERS
ProviderId (uint)
The ID of a Provider server from which to obtain the VM list.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? falseSiteId (uint)
Site ID from which to retrieve the desktop VM list.
If the parameter is omitted, the site ID of the Licensing Server will be used.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseId (string)
The ID of a desktop VM for which to retrieve the information.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseVDITemplateObj (Template)
The VDI Template for which to retrieve the desktops of.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? falseVDITemplateId (uint)
The ID of the VDI Template for which to retrieve the desktops of.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUser (string)
The username assigned to Desktop.
If empty square brackets ([]) are passed, the desktop list will be filtered with those with an assigned user.
Required? false
Position? named
Default value
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
EXAMPLES
**---------- EXAMPLE 1 ----------
Get-RASVDIHost 2 | Format-List
Retrieves the list of host VMs from the specified Provider server from the Licensing Server site.
To get the info from a specific site, specify the -SiteId parameter.
The Format-List cmdlet formats the display output to include the complete list of the returned properties. **---------- EXAMPLE 2 ----------
Get-RASVDIHost -ProviderId 2 -SiteId 2
Retrieves the list of host VMs from the specified Provider server from the specified site. **---------- EXAMPLE 3 ----------
Get-RASVDIHost | Format-List
Retrieves the complete list of host VMs residing on all available Provider servers in the Licensing Server site.
To get the info from a specific site, specify the -SiteId parameter.
The Format-List cmdlet formats the display output to include the complete list of the returned properties. **---------- EXAMPLE 4 ----------
Get-RASVDIHost -ProviderId 2 -Id 42311235-09c5-ca15-337d-b9723015edf0
Retrieves the information about a specified host VM residing on the specified Provider server. **---------- EXAMPLE 5 ----------
Get-RASVDIHost -VDITemplateObj $TempObj
Retrieves the information about the VDI hosts created from the specified VDI template.
RELATED LINKS
Last updated