> 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/invoke-rasvdisessioncmd.md).

# Invoke-RASVDISessionCmd

## SYNOPSIS

Sends VDI session commands.

## SYNTAX

```powershell
Invoke-RASVDISessionCmd [-InputObject] <VDIRDPSession> -Command {LogOff | SendMsg | Disconnect}
 [-Message <string>] [-MsgTitle <string>] [<CommonParameters>]
```

```powershell
Invoke-RASVDISessionCmd [-ProviderId] <uint> -Command {LogOff | SendMsg | Disconnect}
 -VDIHostId <string> [-Message <string>] [-MsgTitle <string>] [<CommonParameters>]
```

```powershell
Invoke-RASVDISessionCmd [-VDIServer] <string> [[-SiteId] <uint>]
 -Command {LogOff | SendMsg | Disconnect} -VDIHostId <string> [-Message <string>]
 [-MsgTitle <string>] [<CommonParameters>]
```

## DESCRIPTION

Sends a session commands such as Logoff, Disconnect or send message.

It will not fail unless VDI (server or Provider ID) is invalid or command does not reach the destination.

If VDI Desktop ID is invalid, the command will not fail.

## EXAMPLES

### Example 1

```powershell
Invoke-RASVDISessionCmd "server.company.dom" -Command LogOff -VDIDesktopId 42311235-09c5-ca15-337d-b9723015edf0
```

Invoke the VDI session to send the LogOff command from the Licensing Server site (default).

### Example 2

```powershell
Invoke-RASVDISessionCmd -ProviderId 10 -Command SendMsg -VDIDesktopId 42311235-09c5-ca15-337d-b9723015edf0 -Message "This is a message"
```

Invoke the VDI session to send the SendMsg command specified by ID.

To obtain the ProviderId, use the Get-RASProvider cmdlet.

To obtain the Desktop ID, use the Get-RASVDIDesktop cmdlet.

### Example 3

```powershell
$VDISession | Invoke-RASVDISessionCmd -Command Disconnect
```

Invoke the VDI session to send the Disconnect command, which is identified by an object obtained from the pipeline output.

To obtain the VDI Session, use the Get-RASProviderStatus cmdlet with StatusLevel as Level3.

## PARAMETERS

### -VDIServer

The name of a Provider.

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: string
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SiteId

Site ID from which to retrieve the server.

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

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

### -ProviderId

The ID of the provider.

To obtain the ID, use the Get-RASProvider cmdlet.

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

### -VDIHostId

Host ID.

To obtain the HostId, use the Get-RASVDIHost command.

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

### -InputObject

The VDIRDPSession Object.

To obtain a VDIRDPSession object representing an VDI Session, use the Get-RASProviderStatus command with StatusLevel as Level3."

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

```yaml
Type: VDIRDPSession
Required: True
Position: 0
Default value: None
Accept pipeline input: true (ByValue)
Accept wildcard characters: False
```

### -Command

Session Command.

Accepted values: LogOff, SendMsg, Disconnect.

Possible values: LogOff, SendMsg, Disconnect

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

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

### -MsgTitle

The message title for the session message.

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

### -Message

The session message to be sent.

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

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

## OUTPUTS

### None

## RELATED LINKS

* [Get-RASProvider](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasprovider.md)
* [Get-RASVDIHost](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasvdihost.md)
* [Get-RASProviderStatus](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasproviderstatus.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/invoke-rasvdisessioncmd.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.
