Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Set-RASPubItemPreferredRoute

SYNOPSIS

Modifies the specified preferred route for the specified published resource.

SYNTAX

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

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.

-Name

The Name of the Preferred Route

-Description

Description of the Preferred Route

-Enabled

Whether the Preferred Route is enabled or not

-ReferenceType

Reference Type of the Preferred Route

Possible values: Gateway, HALB, Custom

Type reference: RoutingType

-ReferenceId

Reference ID of the Preferred Route

-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

-Id

Published resource ID.

-InputObject

An object specifying the published resource.

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

Type reference: PubItem

-SiteId

Site ID.

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.

INPUTS

PubItem

OUTPUTS

None

Last updated