Create method of the MSFT_NetRoute class

Create an IP route.

Syntax


uint32 Create(
  [in]  uint32        InterfaceIndex,
  [in]  string        InterfaceAlias,
  [in]  string        DestinationPrefix,
  [in]  string        NextHop,
  [in]  uint8         Publish,
  [in]  uint16        RouteMetric,
  [in]  uint16        Protocol,
  [in]  datetime      ValidLifetime,
  [in]  datetime      PreferredLifetime,
  [in]  string        PolicyStore,
  [in]  uint16        AddressFamily,
  [in]  boolean       PassThru,
  [out] MSFT_NetRoute CmdletOutput[]
);

Parameters

InterfaceIndex [in]

The interface index of the route.

InterfaceAlias [in]

The interface alias of the route.

DestinationPrefix [in]

The destination prefix of the route.

NextHop [in]

TBD

Publish [in]

The value that indicates how to advertise the route. This parameter can contain one of the following values.

ValueMeaning
0

Do not advertise the route.

1

Advertise the route for a specific interval.

2

Advertise the route indefinitely.

 

RouteMetric [in]

The route metric.

Protocol [in]

TBD

Windows 8 and Windows Server 2012:  This parameter is not supported before Windows 8.1 and Windows Server 2012 R2.

ValidLifetime [in]

The valid end time of the lifetime of the route. The default value for this parameter is infinite.

PreferredLifetime [in]

The preferred end time of the lifetime of the route. The default value for this parameter is infinite

PolicyStore [in]

TBD

AddressFamily [in]

A value that indicates whether the route uses the IPv4 or IPv6 address family. This parameter can contain one of the following values.

ValueMeaning
2

IPv4

23

IPv6

 

PassThru [in]

A value that indicates whether the MSFT_NetRoute parameter returns an object.

CmdletOutput [out]

The MSFT_NetRoute object that receives the new route.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

Root\StandardCimv2

MOF

NetTCPIP.mof

DLL

NetTCPIP.dll

See also

MSFT_NetRoute

 

 

Community Additions

ADD
Show: