# Set-RASCustomRoute

## NAME

Set-RASCustomRoute

## SYNOPSIS

Modifies a Custom Route.

## SYNTAX

**Set-RASCustomRoute** \[[Id](#id-string)] *(uint)*\*\* \[[Description](#description-string) *(string)*] \[[Enabled](#enabled-string) *(bool)*] \[[NewName](#newname-string) *(string)*] \[[Port](#port-string) *(uint)*] \[[PublicAddress](#publicaddress-string) *(string)*] \[[SSLPort](#sslport-string) *(uint)*] \[*(*[*CommonParameters*](#CommonParameters)*)*]

**Set-RASCustomRoute** \[-[InputObject](#inputobject)] *(*[*CustomRoute*](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/customroute)*)* \[[Description](#description-string) *(string)*] \[[Enabled](#enabled-string) *(bool)*] \[[NewName](#newname-string) *(string)*] \[[Port](#port-string) *(uint)*] \[[PublicAddress](#publicaddress-string) *(string)*] \[[SSLPort](#sslport-string) *(uint)*] \[*(*[*CommonParameters*](#CommonParameters)*)*]

**Set-RASCustomRoute** \[[Name](#name-string)]\*\* *(string)* \[\[-[SiteId](#siteid-string)] *(uint)*] \[[Description](#description-string) *(string)*] \[[Enabled](#enabled-string) *(bool)*] \[[NewName](#newname-string) *(string)*] \[[Port](#port-string) *(uint)*] \[[PublicAddress](#publicaddress-string) *(string)*] \[[SSLPort](#sslport-string) *(uint)*] \[*(*[*CommonParameters*](#CommonParameters)*)*]

## DESCRIPTION

Modifies properties of a Custom Route.

## PARAMETERS

## Name (string)

The name of the Custom Route.

```
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## SiteId (uint)

Site ID in which to modify the specified Custom Route.

If the parameter is omitted, the site ID of the Licensing Server will be used.

```
        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## Id (uint)

The ID of the Custom Route to modify. To obtain the ID, use the Get-RASCustomRoute cmdlet.

```
        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## InputObject ([CustomRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/customroute))

The Custom Route to modify.

To obtain an object of type CustomRoute representing a Custom Route, use the Get-RASCustomRoute cmdlet.

```
        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false
```

## Enabled (bool)

Whether Custom Route is enabled or not

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## NewName (string)

The new name of the Custom Route.

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## Description (string)

A user-defined Custom Route description.

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## PublicAddress (string)

Public Address of the Custom Route

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## Port (uint)

Port of the Custom Route

```
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
```

## SSLPort (uint)

SSL Port of the Custom Route

```
        Required?                    false

        Position?                    named

        Default value                

        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

[CustomRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/types/customroute)

## OUTPUTS

-none-

## EXAMPLES

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

Set-RASCustomRoute -Name "My Custom Route" -Description "Custom"

Modifies the description of a custom route specified by name.\
\&#xNAN;**---------- EXAMPLE 2 ----------**

Set-RASCustomRoute -Id 1 -PublicAddress server.test.com

Modifies the public address of a custom route specified by Id.

## RELATED LINKS

* [New-RASCustomRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/new-rascustomroute)
* [Get-RASCustomRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/get-rascustomroute)
* [Remove-RASCustomRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/remove-rascustomroute)
* [Add-RASPubItemPreferredRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/add-raspubitempreferredroute)
* [Get-RASPubItemPreferredRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/get-raspubitempreferredroute)
* [Set-RASPubItemPreferredRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/set-raspubitempreferredroute)
* [Remove-RASPubItemPreferredRoute](https://docs.parallels.com/landing/ras-powershell-api-guide/parallels-ras-powershell-admin-module/commands/remove-raspubitempreferredroute)