SetGateways method of the Win32_NetworkAdapterConfiguration class

The SetGateways WMI class method specifies a list of gateways for routing packets to a subnet that is different from the subnet that the network adapter is connected to.

This topic uses Managed Object Format (MOF) syntax. For more information about using this method, see Calling a Method.

Syntax


uint32 SetGateways(
  [in]           string DefaultIPGateway[],
  [in, optional] uint16 GatewayCostMetric[]
);

Parameters

DefaultIPGateway [in]

List of IP addresses to gateways where network packets are routed.

GatewayCostMetric [in, optional]

Assigns a value that ranges from 1 to 9999, which is used to calculate the fastest and most reliable routes. The values of this parameter correspond with the values in the DefaultIPGateway parameter. The default value for a gateway is 1.

Return value

Returns a value of 0 (zero) for a successful completion when a reboot is not required, 1 (one) for a successful completion when a reboot is required, and any other value if there is an error. For more information on error codes, see WMI Error Constants or WbemErrorEnum. For general HRESULT values, see System Error Codes.

Successful completion, no reboot required

0

Successful completion, reboot required

1

Method not supported on this platform

64

Method not supported when the NIC is in DHCP mode.

Unknown failure

65

Invalid subnet mask

66

An error occurred while processing an Instance that was returned

67

Invalid input parameter

68

More than 5 gateways specified

69

Invalid IP address

70

Invalid gateway IP address

71

An error occurred while accessing the Registry for the requested information

72

Invalid domain name

73

Invalid host name

74

No primary/secondary WINS server defined

75

Invalid file

76

Invalid system path

77

File copy failed

78

Invalid security parameter

79

Unable to configure TCP/IP service

80

Unable to configure DHCP service

81

Unable to renew DHCP lease

82

Unable to release DHCP lease

83

IP not enabled on adapter

84

IPX not enabled on adapter

85

Frame/network number bounds error

86

Invalid frame type

87

Invalid network number

88

Duplicate network number

89

Parameter out of bounds

90

Access denied

91

Out of memory

92

Already exists

93

Path, file or object not found

94

Unable to notify service

95

Unable to notify DNS service

96

Interface not configurable

97

Not all DHCP leases could be released/renewed

98

DHCP not enabled on adapter

100

Other

101–4294967295

Remarks

This method only works when the Network Interface Card (NIC) is in the static IP mode.

To clear the gateway, set your gateway to the same IP you use on EnableStatic.

Examples

The Modify the Gateways for a Network Adapter VBScript sample configures two gateways for a network adapter.

The Assign a Static IP Address VBScript sample sets the IP address and gateway of a computer.

The Static IP and then join to a domain PowerShell sample assists in rebuilding machines.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Namespace

Root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

See also

Computer System Hardware Classes
Win32_NetworkAdapterConfiguration
WMI Tasks: Networking
WMI Tasks: Accounts and Domains
IPv6 and IPv4 Support in WMI

 

 

Show: