Set-Routing Protocol Preference

Module:
remoteaccess
Configures preferences for routing protocols.

Syntax 

Set-RoutingProtocolPreference
   [-Name] <String>
   [-Level] <UInt32>
   [-PassThru]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-RoutingProtocolPreference cmdlet configures preferences for routing protocols. When specifying preferences, lower values have higher priority.

Use the Get-RoutingProtocolPreference cmdlet to see the current values.

Examples

Example 1: Modify preferences 

PS C:\> Set-RoutingProtocolPreference -Name "ebgp" -Level 15 -PassThru
Protocol                                          Priority (Lower value = higher priority)
----------------------------                      ------------------------------------------------
local                                             1
static                                            3
nondod                                            5
autostatic                                        7
netmgmt                                           10
ebgp                                              15
rip                                               120
ibgp                                              200

This command modifies the routing protocol preferences. It sets the priority of the protocol named ebgp to a value of 15. The command specifies the PassThru parameter, so it passes a protocol preference object to the console.

Required Parameters

-Level

Specifies a preference level for the protocol. Lower values have higher priority.

Type: UInt32
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-Name

Specifies a name. The cmdlet modifies the preference for the named protocol.

Type: String
Parameter Sets: AutoStatic, Local, NetMgmt, NonDoD, RIP, Static, EBgp, IBgp
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Outputs

Microsoft.Management.Infrastructure.CimInstance#ProtocolPrefernce