> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasvdihost.md).

# Get-RASVDIHost

## SYNOPSIS

Retrieves the host VM list from a Provider in real-time.

## SYNTAX

```powershell
Get-RASVDIHost [-ProviderId] <uint> [[-SiteId] <uint>] -Id <string> [-User <string>]
 [-VDITemplateId <uint>] [<CommonParameters>]
```

```powershell
Get-RASVDIHost [[-ProviderId] <uint>] [[-SiteId] <uint>] [-User <string>] [-VDITemplateId <uint>]
 [<CommonParameters>]
```

```powershell
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.

## EXAMPLES

### Example 1

```powershell
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

```powershell
Get-RASVDIHost -ProviderId 2 -SiteId 2
```

Retrieves the list of host VMs from the specified Provider server from the specified site.

### Example 3

```powershell
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

```powershell
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

```powershell
Get-RASVDIHost -VDITemplateObj $TempObj
```

Retrieves the information about the VDI hosts created from the specified VDI template.

## PARAMETERS

### -ProviderId

The ID of a Provider server from which to obtain the VM list.

```yaml
Type: uint
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SiteId

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.

```yaml
Type: uint
Required: False
Position: 1
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```

### -Id

The ID of a desktop VM for which to retrieve the information.

```yaml
Type: string
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VDITemplateObj

The VDI Template for which to retrieve the desktops of.

Type reference: [Template](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/template.md)

```yaml
Type: Template
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -VDITemplateId

The ID of the VDI Template for which to retrieve the desktops of.

```yaml
Type: uint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -User

The username assigned to Desktop.

If empty square brackets (\[]) are passed, the desktop list will be filtered with those with an assigned user.

```yaml
Type: string
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about\_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

## INPUTS

### None

## OUTPUTS

### [VDIHost](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/vdihost.md)

## RELATED LINKS

* [Add-RASVDIHostPoolMember](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/add-rasvdihostpoolmember.md)
* [New-RASTemplate](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/new-rastemplate.md)
* [Remove-RASVDIHost](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rasvdihost.md)
* [Invoke-RASVDIHost](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/invoke-rasvdihost.md)
* [Get-RASVDIHostStatus](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasvdihoststatus.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasvdihost.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
