# Add-RASPubItemPreferredRoute

## NAME

Add-RASPubItemPreferredRoute

## SYNOPSIS

Adds a preferred route to the specified published resource.

## SYNTAX

**Add-RASPubItemPreferredRoute** \[-[Id](#Id)] _\<uint>_ -[Name](#Name) _\<string>_ -[ReferenceId](#ReferenceId) _\<uint>_ -[ReferenceType](#ReferenceType) {Gateway | HALB | Custom} \[-[Description](#Description) _\<string>_] \[-[Enabled](#Enabled) _\<bool>_] \[-[SiteId](#SiteId) _\<uint>_] \[_<_[_CommonParameters_](#CommonParameters)_>_]

**Add-RASPubItemPreferredRoute** \[-[InputObject](#InputObject)] _<_[_PubItem_](../classes-and-enumerations/pubitem)_>_ -[Name](#Name) _\<string>_ -[ReferenceId](#ReferenceId) _\<uint>_ -[ReferenceType](#ReferenceType) {Gateway | HALB | Custom} \[-[Description](#Description) _\<string>_] \[-[Enabled](#Enabled) _\<bool>_] \[-[SiteId](#SiteId) _\<uint>_] \[_<_[_CommonParameters_](#CommonParameters)_>_]

## DESCRIPTION

This cmdlet allows you to add a preferred route to the specified published resource.

To modify preferred route options, use the Set-RASPubItemPreferredRoute cmdlet.

## PARAMETERS

-**Name \<string>**\
The Name of the Preferred Route

```
        Required?                    true

        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                True

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**ReferenceType <**[**RoutingType**](../classes-and-enumerations/routingtype)**>**\
Reference Type of the Preferred Route

Possible values: Gateway, HALB, Custom

```
        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

-**ReferenceId \<uint>**\
Reference ID of the Preferred Route

```
        Required?                    true

        Position?                    named

        Default value                0

        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**](../classes-and-enumerations/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](../classes-and-enumerations/pubitem)

## OUTPUTS

-none-

## EXAMPLES

**---------- EXAMPLE 1 ----------**

Add-RASPubItemPreferredRoute -Id 12 -Name Route1 -ReferenceType Gateway -ReferenceId 1

Adds a preferred route with Name Route1 that routes connections through the Gateway with ID 1.

The target published resource is specified by ID 12.\
&#xNAN;**---------- EXAMPLE 2 ----------**

Add-RASPubItemPreferredRoute -Id 12 -Name Route2 -ReferenceType HALB -ReferenceId 1

Adds a preferred route with Name Route2 that routes connections through the HALB with ID 1.

The target published resource is specified by ID 12.

## RELATED LINKS

* [Get-RASPubItem](get-raspubitem)
* [Get-RASPubItemPreferredRoute](get-raspubitempreferredroute)
* [Set-RASPubItemPreferredRoute](set-raspubitempreferredroute)
* [Remove-RASPubItemPreferredRoute](remove-raspubitempreferredroute)
* [New-RASCustomRoute](new-rascustomroute)
* [Get-RASCustomRoute](get-rascustomroute)
* [Set-RASCustomRoute](set-rascustomroute)
* [Remove-RASCustomRoute](remove-rascustomroute)
* [Get-RASGateway](get-rasgateway)
* [Get-RASHALB](get-rashalb)
