Add method of the PS_BgpRoutingPolicy class

Adds a new BGP routing policy to the policy store.

Syntax

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

Parameters

PassThru [in]

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

RoutingDomain [in]

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

IgnorePrefix [in]

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

Name [in]

The unique alphanumeric ID of the routing policy.

MatchCommunity [in]

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

NewLocalPref [in]

The LOCAL-PREF attribute for the routing policy.

AddCommunity [in]

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

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.

NewMED [in]

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

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)

NewNextHop [in]

The next-hop value to add to BGP routes.

RemoveCommunity [in]

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

MatchPrefix [in]

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

MatchASNRange [in]

An array that contains a range of Autonomous System Numbers (ASN) to match with the AS-PATH values of 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.

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