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

Set-RASCustomRoute

SYNOPSIS

Modifies a Custom Route.

SYNTAX

Set-RASCustomRoute [-Id] <uint> [-Description <string>] [-Enabled <bool>] [-NewName <string>]
 [-Port <uint>] [-PublicAddress <string>] [-SSLPort <uint>] [<CommonParameters>]
Set-RASCustomRoute [-InputObject] <CustomRoute> [-Description <string>] [-Enabled <bool>]
 [-NewName <string>] [-Port <uint>] [-PublicAddress <string>] [-SSLPort <uint>] [<CommonParameters>]
Set-RASCustomRoute [-Name] <string> [[-SiteId] <uint>] [-Description <string>] [-Enabled <bool>]
 [-NewName <string>] [-Port <uint>] [-PublicAddress <string>] [-SSLPort <uint>] [<CommonParameters>]

DESCRIPTION

Modifies properties of a Custom Route.

EXAMPLES

Example 1

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

Modifies the description of a custom route specified by name.

Example 2

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

PARAMETERS

-Name

The name of the Custom Route.

-SiteId

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.

-Id

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

-InputObject

The Custom Route to modify.

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

Type reference: CustomRoute

-Enabled

Whether Custom Route is enabled or not

-NewName

The new name of the Custom Route.

-Description

A user-defined Custom Route description.

-PublicAddress

Public Address of the Custom Route

-Port

Port of the Custom Route

-SSLPort

SSL Port of the Custom Route

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

CustomRoute

OUTPUTS

None

Last updated