AutoMetric

Provides the AutoMetric of the network in the cluster. The following table summarizes the attributes of the AutoMetric property.

Attribute Value
Data type
DWORD
Access
Read/write
Structure
CLUSPROP_DWORD
Minimum
0
Maximum
1
Default
1

Remarks

The AutoMetric property determines whether the cluster service is allowed to automatically adjust the network Metric property. If the Metric property is set to a value then the AutoMetric property is set to 0. To allow the cluster to adjust the Metric automatically, set the AutoMetric property to 1. The cluster service selects the network path with the lowest sum of metrics.

Examples

The property value portion of a property list entry for AutoMetric can be set with the following example code:

DWORD          AutoMetricData = 0;
CLUSPROP_DWORD AutoMetricValue;

AutoMetricValue.Syntax.dw = CLUSPROP_SYNTAX_LIST_VALUE_DWORD;
AutoMetricValue.cbLength  = sizeof(DWORD);
AutoMetricValue.dw        = AutoMetricData;

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2008 R2 Enterprise, Windows Server 2008 R2 Datacenter

See also

Network Common Properties

CLUSPROP_DWORD

Metric