> 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/set-raspubitempreferredroute.md).

# Set-RASPubItemPreferredRoute

## SYNOPSIS

Modifies the specified preferred route for the specified published resource.

## SYNTAX

```powershell
Set-RASPubItemPreferredRoute [-Id] <uint> -PreferredRouteId <uint> [-Description <string>]
 [-Enabled <bool>] [-Name <string>] [-Priority {Up | Down}] [-ReferenceId <uint>]
 [-ReferenceType {Gateway | HALB | Custom}] [-SiteId <uint>] [<CommonParameters>]
```

```powershell
Set-RASPubItemPreferredRoute [-InputObject] <PubItem> -PreferredRouteId <uint>
 [-Description <string>] [-Enabled <bool>] [-Name <string>] [-Priority {Up | Down}]
 [-ReferenceId <uint>] [-ReferenceType {Gateway | HALB | Custom}] [-SiteId <uint>]
 [<CommonParameters>]
```

## DESCRIPTION

This cmdlet modifies the specified preferred route for the specified published resource.

To add a preferred route, use the Add-RASPubItemPreferredRoute cmdlet.

## EXAMPLES

### Example 1

```powershell
Set-RASPubItemPreferredRoute -Id 12 -PreferredRouteId 1 -Enabled $False
```

Disable the preferred route with ID 1 for the published resource specified with ID 12.

## PARAMETERS

### -PreferredRouteId

The ID of the Preferred Route to be modified.

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

### -Name

The Name of the Preferred Route

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

### -Description

Description of the Preferred Route

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

### -Enabled

Whether the Preferred Route is enabled or not

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

### -ReferenceType

Reference Type of the Preferred Route

Possible values: Gateway, HALB, Custom

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

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

### -ReferenceId

Reference ID of the Preferred Route

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

### -Priority

The direction to move the Publishing Route object: Up or Down (changes the priority of the Publishing Route accordingly)

Possible values: Up, Down

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

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

### -Id

Published resource ID.

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

### -InputObject

An object specifying the published resource.

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

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

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

### -SiteId

Site ID.

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

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

## OUTPUTS

### None

## RELATED LINKS

* [Get-RASPubItem](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-raspubitem.md)
* [Add-RASPubItemPreferredRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/add-raspubitempreferredroute.md)
* [Get-RASPubItemFilter](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-raspubitemfilter.md)
* [Remove-RASPubItemPreferredRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-raspubitempreferredroute.md)
* [New-RASCustomRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/new-rascustomroute.md)
* [Get-RASCustomRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rascustomroute.md)
* [Set-RASCustomRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/set-rascustomroute.md)
* [Remove-RASCustomRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/remove-rascustomroute.md)
* [Get-RASGateway](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rasgateway.md)
* [Get-RASHALB](https://docs.parallels.com/landing/ras-powershell-api-guide/rasadmin/cmdlets/get-rashalb.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/set-raspubitempreferredroute.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.
