Set method of the PS_BgpRoutingPolicy class

Updates a BGP routing policy.

Syntax

uint32 Set(
  [in]  string                 Name,
  [in]  boolean                PassThru,
  [in]  uint32                 PolicyType,
  [in]  string                 RoutingDomain,
  [in]  boolean                Force,
  [in]  string                 AddCommunity[],
  [in]  string                 RemoveCommunity[],
  [in]  string                 RemovePolicyClause[],
  [in]  uint32                 MatchASNRange[],
  [in]  string                 IgnorePrefix[],
  [in]  string                 MatchCommunity[],
  [in]  string                 MatchPrefix[],
  [in]  string                 MatchNextHop[],
  [in]  boolean                ClearMED,
  [in]  uint32                 NewLocalPref,
  [in]  uint32                 NewMED,
  [in]  string                 NewNextHop,
  [in]  boolean                RemoveAllCommunities,
  [out] BgpRoutingPolicyConfig cmdletOutput
);

Parameters

Name [in]

The unique alphanumeric ID of the routing policy to update.

PassThru [in]

Indicates whether cmdletOutput parameter returns an output object. True to return an output object; otherwise false.

PolicyType [in]

The type of filtering procedure that this routing policy performs. You can set this parameter to one of the following values.

ModifyAttribute (1)

Allow (2)

Deny (3)

RoutingDomain [in]

The user-defined unique alphanumeric ID of the routing domain.

Force [in]

Indicates whether the policy displays a confirmation prompt before adding the specified routing policy to policy store. True to display the confirmation prompt; otherwise false.

AddCommunity [in]

An array that contains the community attribute values to add to BGP routes.

RemoveCommunity [in]

An array that contains the community attribute values to remove from BGP routes.

RemovePolicyClause [in]

An array that contains the policy clauses to remove from BGP routes.

MatchASNRange [in]

An array that contains a range of Autonomous System Numbers (ASN) to match with the AS-PATH values of BGP route advertisements.

IgnorePrefix [in]

An array that contains the IP network prefixes to ignore during this procedure.

MatchCommunity [in]

An array that contains the community attribute values to match with route advertisements.

MatchPrefix [in]

An array that contains the network prefixes to match with BGP route advertisements.

MatchNextHop [in]

An array that contains next-hop values to match with BGP route advertisements.

ClearMED [in]

Indicates whether this routing policy removes the MED value from route advertisements. True to remove MED values from BGP route advertisements; otherwise false.

NewLocalPref [in]

The LOCAL-PREF attribute for the routing policy.

NewMED [in]

The multi-exit discriminator (MED) to add to BGP routes.

NewNextHop [in]

The next-hop value to add to BGP routes.

RemoveAllCommunities [in]

Set True to remove all communities from the BGP route.

Windows Server 2012 R2: This parameter is not supported before Windows Server 2016.

cmdletOutput [out]

The BgpRoutingPolicyConfig object that receives the updated routing policy.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2012 R2
Namespace	Root\Microsoft\Windows\RemoteAccess
MOF	RAMgmtPSProvider.Mof
DLL	RAMgmtPSProvider.dll

See also

PS_BgpRoutingPolicy