Add-RASPubItemPreferredRoute
NAME
Add-RASPubItemPreferredRoute
SYNOPSIS
Adds a preferred route to the specified published resource.
SYNTAX
Add-RASPubItemPreferredRoute [-Id] <uint> -Name <string> -ReferenceId <uint> -ReferenceType {Gateway | HALB | Custom} [-Description <string>] [-Enabled <bool>] [-SiteId <uint>] [<CommonParameters>]
Add-RASPubItemPreferredRoute [-InputObject] <PubItem> -Name <string> -ReferenceId <uint> -ReferenceType {Gateway | HALB | Custom} [-Description <string>] [-Enabled <bool>] [-SiteId <uint>] [<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> 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> 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
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. ---------- 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
Last updated