> 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-rasvm.md).

# Get-RASVM

## SYNOPSIS

Retrieves VM list from a Provider in real-time.

## SYNTAX

```powershell
Get-RASVM [-ProviderId] <uint> [[-Id] <string>] [<CommonParameters>]
```

```powershell
Get-RASVM [-SiteId <uint>] [<CommonParameters>]
```

## DESCRIPTION

Retrieves virtual machine information from Provider servers.

It returns an array of objects of type VM, each containing properties of a virtual machine.

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 Virtual Machine; it does not include all of the settings supported in RAS.

## EXAMPLES

### Example 1

```powershell
Get-RASVM 2 | Format-List
```

Retrieves a list of virtual machines from the specified Provider in the Licensing Server site.

To get the info from a specific site, use the -SiteId parameter.

The Format-List cmdlet formats the display output to include the complete list of returned VM properties.

### Example 2

```powershell
Get-RASVM -ProviderId 2 -SiteId 2
```

Retrieves a list of virtual machines from the specified Provider in the specified site.

### Example 3

```powershell
Get-RASVM | Format-List
```

Retrieves a list of all available virtual machines 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 VM returned properties.

### Example 4

```powershell
Get-RASVM -ProviderId 2 -Id 42311235-09c5-ca15-337d-b9723015edf0
```

Retrieves information about a virtual machine specified by ID from the specified Provider server.

## PARAMETERS

### -SiteId

The site ID from which to retrieve VM information.

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

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

### -ProviderId

The name of the Provider server.

The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

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

### -Id

The virtual machine UUID (universally unique identifier). UUID is assigned to a virtual machine by the hypervisor.

```yaml
Type: string
Required: False
Position: 1
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

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

## RELATED LINKS

* [Start-RASVM](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/start-rasvm.md)
* [Stop-RASVM](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/stop-rasvm.md)
* [Suspend-RASVM](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/suspend-rasvm.md)
* [Reset-RASVM](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/reset-rasvm.md)
* [Restart-RASVM](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/restart-rasvm.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-rasvm.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.
