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

# Invoke-RASTemplate

## SYNOPSIS

Perform RAS Template commands.

## SYNTAX

```powershell
Invoke-RASTemplate [-Id] <uint>
 -Command {EnterMaintenance | ExitMaintenance | RecreateHosts | RecreateDesktops}
 -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [-CreateTemplateVersion <SwitchParameter>]
 [-ForceStopUpdateHosts <SwitchParameter>] [-RecreateAllHosts <SwitchParameter>]
 [-TemplateVersionId <uint>] [-VDIHostId <string>] [<CommonParameters>]
```

```powershell
Invoke-RASTemplate [-InputObject] <Template>
 -Command {EnterMaintenance | ExitMaintenance | RecreateHosts | RecreateDesktops}
 -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [-CreateTemplateVersion <SwitchParameter>]
 [-ForceStopUpdateHosts <SwitchParameter>] [-RecreateAllHosts <SwitchParameter>]
 [-TemplateVersionId <uint>] [-VDIHostId <string>] [<CommonParameters>]
```

```powershell
Invoke-RASTemplate [-Name] <string> [[-SiteId] <uint>]
 -Command {EnterMaintenance | ExitMaintenance | RecreateHosts | RecreateDesktops}
 -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [-CreateTemplateVersion <SwitchParameter>]
 [-ForceStopUpdateHosts <SwitchParameter>] [-RecreateAllHosts <SwitchParameter>]
 [-TemplateVersionId <uint>] [-VDIHostId <string>] [<CommonParameters>]
```

## DESCRIPTION

Triggers an action on the selected Template such as: EnterMaintenance, ExitMaintenance or RecreateHosts.

EnterMaintenance: Toggle the template into maintenance mode.

ExitMaintenance: Toggle the template out from maintenance mode.

RecreateHosts: Re-creates one or all of the Template hosts.

## EXAMPLES

### Example 1

```powershell
Invoke-RASTemplate "TemplateName" -ObjType RDSTemplate -Command EnterMaintenance
```

Switch the RAS Template specified by name to maintenance mode in the Licensing Server site.

Since -ForceStopUpdateHosts is not included, hosts will not be stopped/updated.

### Example 2

```powershell
Invoke-RASTemplate -ObjType VDITemplate -Id 10 -Command ExitMaintenance -ForceStopUpdateHosts
```

Switch the RAS Template specified by ID from the maintenance mode.

Since -ForceStopUpdateHosts is included, hosts will be stopped/updated, if required.

### Example 3

```powershell
Invoke-RASTemplate "TemplateName" -ObjType RDSTemplate -Command RecreateHosts -VDIHostId 42312685-05c9-ca51-342d-b3943046edf1
```

Re-create the specified host of the RAS Template specified by name in the Licensing Server site.

Since -RecreateAllHosts is not included, only the specified host will be re-created.

### Example 4

```powershell
Invoke-RASTemplate -ObjType RDSTemplate -InputObject $Template -Command RecreateHosts -RecreateAllHosts
```

Re-create all hosts of the RAS Template specified by the $Template object.

### Example 5

```powershell
Get-RASTemplate -ObjType VDITemplate -Id 10 | Invoke-RASTemplateCmd -Command RecreateHosts -RecreateAllHosts
```

Re-create all hosts of the RAS Template specified by an object obtained from the pipeline output.

## PARAMETERS

### -Name

The name of the target RAS Template.

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

### -SiteId

Site ID of the specified RAS Template.

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 the target RAS Template.

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

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

### -InputObject

An object of type Template which represents a RAS Template.

To obtain the object, use the Get-RASTemplate cmdlet.

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: true (ByValue)
Accept wildcard characters: False
```

### -ObjType

Template object type.

Possible values: RDSTemplate, VDITemplate, AVDTemplate

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

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

### -Command

Template command.

Accepted values: EnterMaintenance, ExitMaintenance, RecreateHosts.

Possible values: EnterMaintenance, ExitMaintenance, RecreateHosts, RecreateDesktops

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

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

### -ForceStopUpdateHosts

Specifies whether to force stopping/updating of hosts.

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

### -VDIHostId

The ID of a host VM to be recreated.

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

### -RecreateAllHosts

Specifies whether to re-create all hosts for the specified template.

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

### -TemplateVersionId

The template version ID from which new hosts will be (re-)created from. Default: null.

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

### -CreateTemplateVersion

Switch determining whether or not a new template version is created on ExitMaintenance. Default: false.

```yaml
Type: SwitchParameter
Required: False
Position: Named
Default value: False
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

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

## OUTPUTS

### None

## RELATED LINKS

* [Get-RASTemplate](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rastemplate.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-rastemplate.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.
