Metric
Applies To: Windows 7, Windows 8, Windows 8.1, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, Windows Vista
Metric specifies the interface metric for the IPv4 protocol. When routes are chosen, the overall metric used to determine the preference is the sum of the route metric and the interface metric.
Typically, the interface metric gives preference to a particular interface, assuming two adapters and interfaces are available with connectivity to the same destination. If a preference is not specified, the stack will apply the automatic metric, generated by the stack for each interface.
This scenario will typically apply in a server scenario where the server has multiple Ethernet NICs and will not apply in a client scenario due to the new WCM feature.
If a preference is not specified, the stack will choose an automatic metric, such as automatically preferring wired over wireless.
Values
metric |
Specifies the interface metric for the IPv4 protocol. The range is from five (more than 2 gigabytes (GB) per second) to fifty (less than 500 kilobytes (KB) per second). |
Valid Configuration Passes
specialize
windowsPE
Parent Hierarchy
Microsoft-Windows-TCPIP | Interfaces | Interface | Ipv4Settings | Metric
Applies To
For a list of the Windows® editions and architectures that this component supports, see Microsoft-Windows-TCPIP.
XML Example
The following XML output shows how to configure TCPIP.
<component name="Microsoft-Windows-TCPIP" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS" xmlns:wcm="https://schemas.microsoft.com/WMIConfig/2002/State" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Interfaces>
<!-- Add static IP address (192.168.0.1/24, ffff:1::3/48) & route (12.34.0.0/16) to interface with identifier "Ethernet 1" --> <Interface wcm:action="add">
<Ipv4Settings>
<DhcpEnabled>true</DhcpEnabled>
<Metric>20</Metric>
<RouterDiscoveryEnabled>false</RouterDiscoveryEnabled>
</Ipv4Settings>
<Ipv6Settings>
<DhcpEnabled>false</DhcpEnabled>
<Metric>30</Metric>
<RouterDiscoveryEnabled>true</RouterDiscoveryEnabled>
</Ipv6Settings>
<Identifier>Ethernet 1</Identifier>
<UnicastIpAddresses>
<IpAddress wcm:action="add" wcm:keyValue="1">192.168.0.1/24</IpAddress>
<IpAddress wcm:action="add" wcm:keyValue="2">ffff:1::3/48</IpAddress>
</UnicastIpAddresses>
<Routes>
<Route wcm:action="add">
<Identifier>1</Identifier>
<Metric>10</Metric>
<NextHopAddress>12.34.0.0</NextHopAddress>
<Prefix>16</Prefix>
</Route>
<Route wcm:action="add">
<Identifier>10</Identifier>
<Metric>29</Metric>
<NextHopAddress>12.34.56.0</NextHopAddress>
<Prefix>24</Prefix>
</Route>
</Routes>
</Interface>
<Interface wcm:action="add">
<Ipv4Settings>
<DhcpEnabled>true</DhcpEnabled>
<Metric>20</Metric>
<RouterDiscoveryEnabled>false</RouterDiscoveryEnabled>
</Ipv4Settings>
<Ipv6Settings>
<DhcpEnabled>false</DhcpEnabled>
<Metric>10</Metric>
<RouterDiscoveryEnabled>true</RouterDiscoveryEnabled>
</Ipv6Settings>
<Identifier>Local Area Connection</Identifier>
<UnicastIpAddresses>
<IpAddress wcm:action="add" wcm:keyValue="1">123.45.67.8</IpAddress>
</UnicastIpAddresses>
<Routes>
<Route wcm:action="add">
<Identifier>1</Identifier>
<Metric>10</Metric>
<NextHopAddress>12.34.0.0</NextHopAddress>
<Prefix>16</Prefix>
</Route>
</Routes>
</Interface>
</Interfaces>
</component>