Set-RASCustomRoute

Set-RASCustomRoute

Modifies a Custom Route.

Set-RASCustomRoute [-Name] <string> [[-SiteId] <uint>] [-Description <string>] [-NewName <string>] [-Port <uint>] [-PublicAddress <string>] [-SSLPort <uint>] [<CommonParameters>]

Set-RASCustomRoute [-Id] <uint> [-Description <string>] [-NewName <string>] [-Port <uint>] [-PublicAddress <string>] [-SSLPort <uint>] [<CommonParameters>]

Set-RASCustomRoute [-InputObject] <CustomRoute> [-Description <string>] [-NewName <string>] [-Port <uint>] [-PublicAddress <string>] [-SSLPort <uint>] [<CommonParameters>]

Modifies properties of a Custom Route.

-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>
The VDI Pool 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

-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. 

CustomRoute

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

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

Modifies the description of a custom route specified by name.

---------- EXAMPLE 2 ----------

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

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