Set-RASPubItemPreferredRoute

NAME

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.

PARAMETERS

PreferredRouteId (uint)

The ID of the Preferred Route to be modified.

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Name (string)

The Name of the Preferred Route

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Description (string)

Description of the Preferred Route

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Enabled (bool)

Whether the Preferred Route is enabled or not

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ReferenceType (RoutingType)

Reference Type of the Preferred Route

Possible values: Gateway, HALB, Custom

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ReferenceId (uint)

Reference ID of the Preferred Route

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Priority (MoveDirection)

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

Possible values: Up, Down

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Id (uint)

Published resource ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (PubItem)

An object specifying the published resource.

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

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

SiteId (uint)

Site ID.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

(CommonParameters)

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

PubItem

OUTPUTS

-none-

---------- EXAMPLE 1 ----------

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

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

RELATED LINKS

• Get-RASPubItem

• Add-RASPubItemPreferredRoute

• Get-RASPubItemFilter

• Remove-RASPubItemPreferredRoute

• New-RASCustomRoute

• Get-RASCustomRoute

• Set-RASCustomRoute

• Remove-RASCustomRoute

• Get-RASGateway

• Get-RASHALB