SetDNSSuffixSearchOrder method of the Win32_NetworkAdapterConfiguration class

The SetDNSSuffixSearchOrder WMI class static method uses an array of string elements to set the suffix search order.

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

Syntax


uint32 SetDNSSuffixSearchOrder(
  [in] string DNSDomainSuffixSearchOrder[]
);

Parameters

DNSDomainSuffixSearchOrder [in]

List of server suffixes to query for DNS servers. The registry location of the DNS suffix is HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\Tcpip|NameServer

Example: "suffix1.company.com", "suffix2.company.com"

Return value

Returns a value of 0 (zero) for a successful completion when no reboot is required, 1 (one) for a successful completion when a reboot is required, and a different number 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, no reboot required.

Successful completion, reboot required

1

Successful completion, reboot required.

Method not supported on this platform

64

Method not supported on this platform.

Unknown failure

65

Unknown failure.

Invalid subnet mask

66

Invalid subnet mask.

An error occurred while processing an Instance that was returned

67

An error occurred while processing an instance that was returned.

Invalid input parameter

68

Invalid input parameter.

More than 5 gateways specified

69

More than five gateways specified.

Invalid IP address

70

Invalid IP address.

Invalid gateway IP address

71

Invalid gateway IP address.

An error occurred while accessing the Registry for the requested information

72

An error occurred while accessing the registry for the requested information.

Invalid domain name

73

Invalid domain name.

Invalid host name

74

Invalid host name.

No primary/secondary WINS server defined

75

No primary or secondary WINS server defined.

Invalid file

76

Invalid file.

Invalid system path

77

Invalid system path.

File copy failed

78

File copy failed.

Invalid security parameter

79

Invalid security parameter.

Unable to configure TCP/IP service

80

Unable to configure TCP/IP service.

Unable to configure DHCP service

81

Unable to configure DHCP service.

Unable to renew DHCP lease

82

Unable to renew DHCP lease.

Unable to release DHCP lease

83

Unable to release DHCP lease.

IP not enabled on adapter

84

IP not enabled on adapter.

IPX not enabled on adapter

85

IPX not enabled on adapter.

Frame/network number bounds error

86

Frame or network number bounds error.

Invalid frame type

87

Invalid frame type.

Invalid network number

88

Invalid network number.

Duplicate network number

89

Duplicate network number.

Parameter out of bounds

90

Parameter out of bounds.

Access denied

91

Access denied.

Out of memory

92

Out of memory.

Already exists

93

Already exists.

Path, file or object not found

94

Path, file, or object not found.

Unable to notify service

95

Unable to notify service.

Unable to notify DNS service

96

Unable to notify DNS service.

Interface not configurable

97

Interface not configurable.

Not all DHCP leases could be released/renewed

98

Not all DHCP leases are released or renewed.

DHCP not enabled on adapter

100

DHCP not enabled on adapter.

Other

101–4294967295

Remarks

This is an instance-independent call that applies to all adapters but only for Windows.

Examples

The Modify the DNS Suffix Search Order for All Network Adapters VBScript code sample configures a computer to use two DNS suffixes when performing DNS searches.

The Enable DHCP Settings on a Computer VBScript sample configures all the settings typically required to enable DHCP on a computer.

The following PowerShell code sets the DNS suffix search order.


#First store the suffixes to set in a variable
$suffixes = 'microsoft.com', 'google.com', 'yahoo.com'

#Since this is a static method, get a class object and then call the method. 
$class = [wmiclass]'Win32_NetworkAdapterConfiguration'
$class.SetDNSSuffixSearchOrder($suffixes)


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: