Set-BgpRoutingPolicy

Set-BgpRoutingPolicy

Modifies a routing policy configuration.

Syntaxe

Parameter Set: Set3
Set-BgpRoutingPolicy [-Name] <String> [-AddCommunity <String[]> ] [-AsJob] [-CimSession <CimSession[]> ] [-ClearMED] [-Force] [-IgnorePrefix <String[]> ] [-MatchASNRange <UInt32[]> ] [-MatchCommunity <String[]> ] [-MatchNextHop <IPAddress[]> ] [-MatchPrefix <String[]> ] [-NewLocalPref <UInt32> ] [-NewMED <UInt32> ] [-NewNextHop <IPAddress> ] [-PassThru] [-PolicyType <PolicyType> ] [-RemoveCommunity <String[]> ] [-RemovePolicyClause <String[]> ] [-RoutingDomain <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Description détaillée

The Set-BgpRoutingPolicy cmdlet modifies the configuration of a BGP routing policy. The cmdlet selects and configures the routes for the routing policy that match the criteria that you specify for this cmdlet. You can set the criteria by specifying the following parameters:

-- MatchASNRange
-- MatchCommunity
-- MatchNextHop
-- MatchPrefix

Paramètres

-AddCommunity<String[]>

Specifies an array of Community attribute values. The cmdlet adds the Community attribute values to the BGP routes that match the criteria that you specify for this cmdlet.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-AsJob

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-CimSession<CimSession[]>

Exécute l’applet de commande dans une session à distance ou sur un ordinateur distant. Entrez un nom d’ordinateur ou un objet de session, comme la sortie d’une applet de commande New-CimSession ou Get-CimSession. La valeur par défaut est la session active sur l’ordinateur local.

Alias	Session
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-ClearMED

Indicates that the cmdlet removes the Multi-Exit Discriminator (MED) value from the route advertisements of the BGP routes that match the criteria that you specify for this cmdlet.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-Force

Force la commande à s’exécuter sans demander confirmation à l’utilisateur.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-IgnorePrefix<String[]>

Specifies an array of network prefixes. The cmdlet does not process routes that have the network prefix that you specify.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-MatchASNRange<UInt32[]>

Specifies a range of autonomous system numbers (ASNs). The cmdlet matches these ASNs with the ASNs in the As-Path attribute in the BGP route advertisements. The cmdlet processes the routes that match these criteria.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-MatchCommunity<String[]>

Specifies an array of Community attribute values. The cmdlet matches these Community attribute values in the BGP route advertisements. The cmdlet processes the routes that match these criteria.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-MatchNextHop<IPAddress[]>

Specifies an array of Next-Hop attribute values. The cmdlet matches these IP addresses in the BGP route advertisements, and it processes the routes that match these criteria.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-MatchPrefix<String[]>

Specifies an array of network prefixes. The cmdlet matches these network addresses in the BGP route advertisements and processes the routes that match this criteria.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-Name<String>

Specifies the name of a routing policy.

Alias	PolicyId,PolicyName
Obligatoire ?	true
Position ?	2
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-NewLocalPref<UInt32>

Specifies a new value of the Local-Pref attribute of the BGP routes that match the criteria that you specify for this cmdlet.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-NewMED<UInt32>

Specifies anew value of the MED attribute of the BGP routes that match the criteria that you specify for this cmdlet.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-NewNextHop<IPAddress>

Specifies a new IP address value of the Next-Hop attribute of the BGP routes that match the criteria that you specify for this cmdlet.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-PassThru

Retourne un objet qui représente l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucun résultat.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-PolicyType<PolicyType>

Specifies the type of BGP routing policy or the filtering action that the cmdlet applies to the BGP routes that match the criteria that you specify for this cmdlet. Les valeurs acceptables pour ce paramètre sont :

-- ModifyAttribute
-- Allow. The routing policy allows all routes that match the criteria for the BGP best path selection process.
-- Deny. The routing policy filters and drops all routes that match the criteria from the BGP best path selection process.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-RemoveCommunity<String[]>

Specifies an array of Community attribute values. The cmdlet removes the Community attribute values from the BGP routes that match the criteria that you specify for this cmdlet.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-RemovePolicyClause<String[]>

Specified an array of policy clauses. The cmdlet removes these policy clauses from the routing policy.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-RoutingDomain<String>

Specifies a name, as a string, for a routing domain. The name of a routing domain is a unique user-defined alphanumeric string.

Alias	RoutingDomainName
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	True (ByPropertyName)
Accepter les caractères génériques ?	false

-ThrottleLimit<Int32>

Spécifie le nombre maximal d’opérations simultanées qui peuvent être établies pour exécuter cette applet de commande. Si ce paramètre est omis ou si la valeur 0 est entrée, Windows PowerShell ® calcule une limitation optimale pour l’applet de commande en fonction du nombre d’applets de commande CIM qui s’exécutent sur l’ordinateur. La limitation s’applique seulement à l’applet de commande actuelle, et non pas à la session ni à l’ordinateur.

Alias	none
Obligatoire ?	false
Position ?	named
Valeur par défaut	none
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Confirm

Votre confirmation sera requise avant l’exécution de l’applet de commande.

Obligatoire ?	false
Position ?	named
Valeur par défaut	false
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-WhatIf

Présente les conséquences éventuelles de l’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Obligatoire ?	false
Position ?	named
Valeur par défaut	false
Accepter l’entrée de pipeline ?	false
Accepter les caractères génériques ?	false

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d’informations, consultez about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Entrées

Le type d’entrée correspond au type des objets que vous pouvez transmettre à l’applet de commande.

Sorties

Le type de sortie est le type des objets émis par l’applet de commande.

• Microsoft.Management.Infrastructure.CimInstance#BgpRoutingPolicyConfig

Exemples

Example 1: Modify a BGP routing policy

This command modifies the routing policy named RTPolicy01. The command sets the ModifyAttribute policy type of the routing policy, and specifies the value 100 for the MED attribute of the BGP routes that match the criteria that you specify for the routing policy.

PS C:\> Set-BgpRoutingPolicy -Name "RTPolicy01" -PolicyType ModifyAttribute -NewMED 100 -PassThru

Example 2: Modify the community attribute of a BGP routing policy

This command modifies the MatchCommunity attribute for the BGP routing policy named RTPolicy06. Because the cmdlet uses the Force parameter, the cmdlet modifies the routing policy without prompting the user for confirmation.

PS C:\> Set-BgpRoutingPolicy -Name "RTPolicy06" -MatchCommunity 100:500 -Force -PassThru

Example 3: Modify a BGP routing policy of a routing domain

This command removes the routing policy named RTPolicy04 from the BGP router for the routing domain named Rd_001. The command prompts the user for confirmation before it removes the routing policy.

PS C:\> Set-BgpRoutingPolicy -Name "RTPolicy04" -RoutingDomain "Rd_001" -NewLocalPref 300 -PassThru

Rubriques connexes

Get-BgpRoutingPolicy

Add-BgpRoutingPolicy

Remove-BgpRoutingPolicy