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

# Invoke-RASRDSHostSessionCmd

## SYNOPSIS

Sends RDS session commands.

## SYNTAX

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

```powershell
Invoke-RASRDSHostSessionCmd [-RDSId] <uint> -Command {LogOff | SendMsg | Disconnect} -Id <uint>
 [-Message <string>] [-MsgTitle <string>] [<CommonParameters>]
```

```powershell
Invoke-RASRDSHostSessionCmd [-RDSServer] <string> [[-SiteId] <uint>]
 -Command {LogOff | SendMsg | Disconnect} -Id <uint> [-Message <string>] [-MsgTitle <string>]
 [<CommonParameters>]
```

## DESCRIPTION

Sends a session command such as LogOff, Disconnect, or Send Message.

It will only fail with an error if the name or ID of the RD Session Host server is invalid or command does not reach the destination.

If the session ID is invalid, the command will not fail.

## EXAMPLES

### Example 1

```powershell
Invoke-RASRDSHostSessionCmd "server.company.dom" -Command LogOff -Id 6
```

Send the LogOff command to the server specified by name in the Licensing Server site (default).

To obtain the session ID, use the Get-RASRDSHostStatus cmdlet with StatusLevel as Level2.

### Example 2

```powershell
Invoke-RASRDSHostSessionCmd -RDSId 10 -Command SendMsg -Id 6 -Message "This is a message"
```

Send the SendMsg command to the server specified by ID to send the specified message.

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

To obtain the session ID, use the Get-RASRDSHostStatus cmdlet with StatusLevel as Level2.

### Example 3

```powershell
$RDPSession | Invoke-RASRDSHostSessionCmd -Command Disconnect
```

Send the Disconnect command for the session, which is identified by an object obtained from the pipeline output.

To obtain the $RDPSession object, use the Get-RASRDSHostStatus cmdlet with StatusLevel as Level2.

## PARAMETERS

### -RDSServer

The name of a RD Session Host 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: string
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -SiteId

Site ID.

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

### -RDSId

The ID of a RD Session Host server.

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

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

### -Id

Session ID.

To obtain the RDS Session ID, use the Get-RASRDSHostStatus command with StatusLevel as Level2.

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

### -InputObject

The RDS Session Object.

To obtain a RDSSession object representing a RD Session, use the Get-RASRDSHostStatus command with StatusLevel as Level2."

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

```yaml
Type: RDPSession
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: [RDSSessionCmd](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/types/rdssessioncmd.md)

```yaml
Type: RDSSessionCmd
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

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

## OUTPUTS

### None

## RELATED LINKS

* [Get-RASRDSHost](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasrdshost.md)
* [Get-RASRDSHostStatus](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasrdshoststatus.md)
* [Invoke-RASRDSHostCmd](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/invoke-rasrdshostcmd.md)
* [Invoke-RASRDSHostProcessCmd](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/invoke-rasrdshostprocesscmd.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-rasrdshostsessioncmd.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.
