Set method of the PS_BgpRouter class

Updates the configuration of a BGP router.

Syntax

uint32 Set(
  [in]  string          BgpIdentifier,
  [in]  uint32          LocalASN,
  [in]  boolean         CompareMEDAcrossASN,
  [in]  boolean         DefaultGatewayRouting,
  [in]  uint32          IPv6Routing,
  [in]  string          RoutingDomain,
  [in]  boolean         PassThru,
  [in]  boolean         Force,
  [in]  string          LocalIPv6Address,
  [in]  uint32          TransitRouting,
  [in]  uint32          RouteReflector,
  [in]  uint32          ClusterId,
  [in]  uint32          ClientToClientReflection,
  [out] BgpRouterConfig cmdletOutput
);

Parameters

BgpIdentifier [in]

The IPv4 address of the BGP router to update.

LocalASN [in]

The local Autonomous System Number (ASN) of the BGP router.

CompareMEDAcrossASN [in]

Indicates whether to enable the BGP router to compare multi-exit discriminator (MED) values across autonomous systems. True to enable to router to compare MED values across autonomous systems; otherwise false.

DefaultGatewayRouting [in]

Indicates whether the BGP router routes network traffic to the default internet gateway. True to route network traffic to the default internet gateway; otherwise false.

IPv6Routing [in]

Enables IPv6 routing for the BGP router.

RoutingDomain [in]

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

PassThru [in]

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

Force [in]

Indicates whether to use a confirmation prompt to modify the configuration of the router. True to use a confirmation prompt; otherwise false.

LocalIPv6Address [in]

The IPv6 IP address of the next-hop value for IPv6 route advertisements.

TransitRouting [in]

whether Transit routing is enabled.

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

RouteReflector [in]

Whether the BGP router acts as a route reflector.

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

ClusterId [in]

The cluster id of the route reflector.

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

ClientToClientReflection [in]

Whether client to client reflection is enabled.

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

cmdletOutput [out]

The BgpRouterConfig object that receives the updated BGP router instance.

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_BgpRouter