Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MSFT_DNSClient class

Represents a DNS client.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class MSFT_DNSClient : CIM_DNSProtocolEndpoint
{
  string   InstanceId;
  string   Caption;
  string   ElementName;
  datetime InstallDate;
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus[];
  uint16   PrimaryStatus;
  string   OtherEnabledState;
  uint16   RequestedState;
  uint16   EnabledDefault;
  uint16   TransitioningToState;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   Description;
  string   Name;
  uint16   OperationalStatus[];
  uint16   EnabledState[];
  datetime TimeOfLastStateChange;
  string   NameFormat;
  uint16   ProtocolType[];
  uint16   ProtocolIFType;
  string   OtherTypeDescription;
  string   Hostname;
  uint16   DHCPOptionsToUse[];
  uint32   InterfaceIndex;
  string   InterfaceAlias;
  string   ConnectionSpecificSuffix;
  string   ConnectionSpecificSuffixSearchList[];
  boolean  RegisterThisConnectionsAddress;
  boolean  UseSuffixWhenRegistering;
};

Members

The MSFT_DNSClient class has these types of members:

Methods

The MSFT_DNSClient class has these methods.

MethodDescription
Register

Registers the addresses of the local machine with the DNS server.

RequestStateChange

Initiates a requests to change the state of a DNS client.

This method is inherited from CIM_EnabledLogicalElement.

 

Properties

The MSFT_DNSClient class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64) , Dynamic

Gets the short description of the DNS client.

This property is inherited from CIM_ManagedElement.

CommunicationStatus
Data type: uint16
Access type: Read-only

Gets a value that indicates the ability of the DNS client to communicate with the underlying CIM_ManagedElement object.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

1

Not Available

2

Communication OK

3

Lost Communication

4

No Contact

5–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

ConnectionSpecificSuffix
Data type: string
Access type: Read/write

Gets and sets the DNS suffix for a connection to the interface.

ConnectionSpecificSuffixSearchList
Data type: string array
Access type: Read-only

Gets and sets an array that contains the DNS suffix for each connection to the interface.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: key, MaxLen (256)

Gets the class name of the DNS client instance.

This property is inherited from the CIM_ServiceAccessPoint class.

Description
Data type: string
Access type: Read-only
Qualifiers: Override (Description)

Gets a description of the DNS client.

This property is inherited from the CIM_ProtocolEndpoint class.

DetailedStatus
Data type: uint16
Access type: Read-only

Gets information about the status of the DNS client, in addition to the information provided by the PrimaryStatus property.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
0

Not Available

1

No Additional Information

2

Stressed

3

Predictive Failure

4

Non-Recoverable Error

5

Supporting Entity in Error

5–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

DHCPOptionsToUse
Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_DHCPProtocolEndpoint.OptionsReceived, CIM_DNSSettingData.DHCPOptionsToUse)

Gets an array that contains the Dynamic Host Configuration Protocol (DHCP) options that the DNS client uses after a DHCP bind operation.

This property is inherited from the CIM_DNSProtocolEndpoint class.

This property can contain the following values:

ValueMeaning
8

Domain Name Server

14

Host Name

17

Domain Name

18–32767

DMTF Reserverd

32768–65535

Vendor Reserved

 

ElementName
Data type: string
Access type: Read-only

Gets the user-friendly name of the DNS client.

This property is inherited from CIM_ManagedElement.

EnabledDefault
Data type: uint16
Access type: Write-only

Indicates the default startup configuration for the EnabledState property.

Default value: "2". This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
2

Enabled

3

Disabled

5

Not Applicable

6

Enabled but Offline

7

No Default

8

Quiesce

9–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

EnabledState
Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_EnabledLogicalElement.OtherEnabledState) , Override (EnabledState)

Gets an array that indicates whether the DNS client is enabled or in some other related state.

This property is inherited from the CIM_ProtocolEndpoint class.

This property can contain one of the following values:

ValueMeaning
0

Unknown

1

Other

2

Enabled

3

Disabled

4

Shutting Down

5

Reboot

6

Enabled but Offline

7

In Test

8

Deferred

9

Quiesce

10

Starting

11–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

HealthState
Data type: uint16
Access type: Read-only
Qualifiers: Experimental

Indicates the current health of the DNS client.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

5

OK

10

Degraded/Warning

15

Minor failure

20

Major failure

25

Critical failure

30

Non-recoverable error

31–32767

DMTF Reserved

32768–65535

Vendor Specific

 

Hostname
Data type: string
Access type: Write-only

Gets the host name of the DNS client connection.

This property is inherited from the CIM_DNSProtocolEndpoint class.

InstallDate
Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings (MIF.DMTF|ComponentID|001.5)

Gets the datetime value that indicates when the DNS client was installed.

This property is inherited from CIM_ManagedSystemElement.

InstanceId
Data type: string
Access type: Read-only

Gets the unique identifier of this object. The ID must be unique within the scope of the instantiating namespace.

This property is inherited from CIM_ManagedElement.

InterfaceAlias
Data type: string
Access type: Read-only

Gets the user-friendly name of the interface.

InterfaceIndex
Data type: uint32
Access type: Read-only

Gets the user-friendly index to the interface.

Name
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256) , key, Override (Name)

Gets the ID of the DNS client interface.

This property is inherited from the CIM_ProtocolEndpoint class.

NameFormat
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

Gets the structure of the Name property, which ensures that Name is a unique value.

This property is inherited from the CIM_ProtocolEndpoint class.

OperatingStatus
Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_EnabledLogicalElement.EnabledState)

Gets an array that contains information about the operating status of the DNS client, in addition to the information provided by the EnabledState property.

This property is inherited from CIM_ManagedSystemElement.

This property can contain the following values:

ValueMeaning
0

Unknown

1

Not Available

2

Servicing

3

Starting

4

Stopping

5

Stopped

6

Aborted

7

Dormant

8

Completed

9

Migrating

10

Emigrating

11

Immigrating

12

Snapshotting

13

Shutting Down

14

In Test

15

Transitioning

16

In Service

17–32767

DMTF Reserved

32768–...

Vendor Reserved

 

OperationalStatus
Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType (Indexed) , ModelCorrespondence (CIM_ManagedSystemElement.StatusDescriptions) , Override (OperationalStatus)

Gets the current statuses of the DNS client.

This property is inherited from the CIM_ProtocolEndpoint class.

This property can contain one of the following values:

ValueMeaning
0

Unknown

1

Other

2

OK

3

Degraded

4

Stressed

5

Error

6

Non-Recoverable Error

7

Starting

8

Stopping

9

Stopped

10

In Service

11
12

No Contact

13

Lost Communication

14

Aborted

15

Dormant

16

Supporting Entity Error

17

Completed

18

Power Mode

19–32767

DMTF Reserved

32768–...

Vendor Reserved

 

OtherEnabledState
Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_EnabledLogicalElement.EnabledState)

Gets a description of the value of the EnabledState property when it is set to "1" (other).

This property is inherited from CIM_EnabledLogicalElement.

OtherTypeDescription
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64) , ModelCorrespondence (CIM_ProtocolEndpoint.ProtocolType, CIM_ProtocolEndpoint.ProtocolIFType)

Gets a string that describes the network protocol to use when the ProtocolIFType property is set to 1 (Other); otherwise, this value must be set to null.

This property is inherited from the CIM_ProtocolEndpoint class.

PrimaryStatus
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_ManagedSystemElement.DetailedStatus, CIM_ManagedSystemElement.HealthState)

Gets the high level status of the DNS client.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

1

OK

2

Degraded

3

Error

4–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

ProtocolIFType
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_ProtocolEndpoint.OtherTypeDescription)

Gets the network protocols that are supported by the DNS client.

This property is inherited from the CIM_ProtocolEndpoint class.

This property can contain the following values:

ValueMeaning
0

Unknown

1

Other

2

Regular 1822

3

HDH 1822

4

DDN X.25

5

RFC877 X.25

6

Ethernet CSMA/CD

7

ISO 802.3 CSMA/CD

8

ISO 802.4 Token Bus

9

ISO 802.5 Token Ring

10

ISO 802.6 MAN

11

StarLAN

12

"Proteon 10Mbit

13

Proteon 80Mbit

14

HyperChannel

15

FDDI

16

LAP-B

17

SDLC

18

DS1

19

E1

20

Basic ISDN

21

Primary ISDN

22

Proprietary Point-to-Point Serial

23

PPP

24

Software Loopbac

25

EON

26

Ethernet 3Mbit

27

NSIP

28

SLIP

29

Ultra

30

DS3

31

SIP

32

Frame Relay

33

RS-232

34

Parallel

35

ARCNet

36

ARCNet Plus

37

ATM

38

MIO X.25

39

SONET

40

X.25 PLE

41

ISO 802.211c

42

LocalTalk

43

SMDS DXI

44

Frame Relay Service

45

V.35

46

HSSI

47

HIPPI

48

Modem

49

AAL5

50

SONET Path

51

SONET VT

52

SMDS ICIP

53

Proprietary Virtual/Internal

54

Proprietary Multiplexor

55

IEEE 802.12

56

Fibre Channel

57

HIPPI Interface

58

Frame Relay Interconnect

59

ATM Emulated LAN for 802.3

60

ATM Emulated LAN for 802.5

61

ATM Emulated Circuit

62

Fast Ethernet (100BaseT)

63

ISDN

64

V.11

65

V.36

66

G703 at 64K

67

G703 at 2Mb

68

QLLC

69

Fast Ethernet 100BaseFX

70

Channel

71

IEEE 802.11

72

IBM 260/370 OEMI Channel

73

ESCON

74

Data Link Switching

75

ISDN S/T Interface

76

ISDN U Interface

77

LAP-D

78

IP Switch

79

Remote Source Route Bridging

80

ATM Logical

81

DS0

82

DS0 Bundle

83

BSC

84

Async

85

Combat Net Radio

86

ISO 802.5r DTR

87

Ext Pos Loc Report System

88

AppleTalk Remote Access Protocol

89

Proprietary Connectionless

90

ITU X.29 Host PAD

91

ITU X.3 Terminal PAD

92

Frame Relay MPI

93

ITU X.213

94

ADSL

95

RADSL

96

SDSL

97

VDSL

98

ISO 802.5 CRFP

99

Myrinet

100

Voice Receive and Transmit

101

Voice Foreign Exchange Office

102

Voice Foreign Exchange Service

103

Voice Encapsulation

104

Voice over IP

105

ATM DXI

106

ATM FUNI

107

ATM IMA

108

PPP Multilink Bundle

109

IP over CDLC

110

IP over CLAW

111

Stack to Stack

112

Virtual IP Address

113

MPC

114

IP over ATM

115

ISO 802.5j Fibre Token Ring

116

TDLC

117

Gigabit Ethernet

118

HDLC

119

LAP-F

120

V.37

121

X.25 MLP

122

X.25 Hunt Group

123

Transp HDLC

124

Interleave Channel

125

FAST Channel

126

IP (for APPN HPR in IP Networks)

127

CATV MAC Layer

128

CATV Downstream

129

CATV Upstream

130

Avalon 12MPP Switch

131

Tunnel

132

Coffee

133

Circuit Emulation Service

134

ATM SubInterface

135

Layer 2 VLAN using 802.1Q

136

Layer 3 VLAN using IP

137

Layer 3 VLAN using IPX

138

Digital Power Line

139

Multimedia Mail over IP

140

DTM

141

DCN

142

IP Forwarding

143

MSDSL

144

IEEE 1394

145

IF-GSN/HIPPI-6400

146

DVB-RCC MAC Layer

147

DVB-RCC Downstream

148

DVB-RCC Upstream

149

ATM Virtual

150

MPLS Tunnel

151

SRP

152

Voice over ATM

153

Voice over Frame Relay

154

ISDL

155

Composite Link

156

SS7 Signaling Link

157

Proprietary P2P Wireless

158

Frame Forward

159

RFC1483 Multiprotocol over ATM

160

USB

161

IEEE 802.3ad Link Aggregate

162

BGP Policy Accounting

163

FRF .16 Multilink FR

164

H.323 Gatekeeper

165

H.323 Proxy

166

MPLS

167

Multi-Frequency Signaling Link

168

HDSL-2

169

S-HDSL

170

DS1 Facility Data Link

171

Packet over SONET/SDH

172

DVB-ASI Input

173

DVB-ASI Output

174

Power Line

175

Non Facility Associated Signaling

176

TR008

177

GR303 RDT

178

GR303 RDT

179

ISUP

180

Proprietary Wireless MAC Layer

181

Proprietary Wireless Downstream

182

Proprietary Wireless Upstream

183

HIPERLAN Type 2

184

Proprietary Broadband Wireless Access Point to Mulipoint

185

SONET Overhead Channel

186

Digital Wrapper Overhead Channel

187

ATM Adaptation Layer 2

188

Radio MAC

189

ATM Radio

190

Inter Machine Trunk

191

MVL DSL

192

Long Read DSL

193

Frame Relay DLCI Endpoint

194

ATM VCI Endpoint

195

Optical Channel

196

Optical Transport

197

Proprietary ATM

198

Voice over Cable

199

Infiniband

200

TE Link

201

Q.2931

202

Virtual Trunk Group

203

SIP Trunk Group

204

SIP Signaling

205

CATV Upstream Channel

206

Econet

207

FSAN 155Mb PON

208

FSAN 622Mb PON

209

Transparent Bridge

210

Line Group

211

Voice E&M Feature Group

212

Voice FGD EANA

213

Voice DID

214

MPEG Transport

215

6To4

216

GTP

217

Paradyne EtherLoop 1

218

Paradyne EtherLoop 2

219

Optical Channel Group

220

HomePNA

221

GFP

222

ciscoISLvlan

223

actelisMetaLOOP

224

Fcip

225–4095

IANA Reserved

4096

IPv4

4097

IPv6

4098

IPv4/v6

4099

IPX

4100

DECnet

4101

SNA

4102

CONP

4103

CLNP

4104

VINES

4105

XNS

4106

ISDN B Channel Endpoint

4107

ISDN D Channel Endpoint

4108

BGP

4109

OSPF

4110

UDP

4111

TCP

4112

802.11a

4113

802.11b

4114

802.11g

4115

802.11h

4200

NFS

4201

CIFS

4202

DAFS

4203

WebDAV

4204

HTTP

4205

FTP

4300

NDMP

4400

Telnet

4401

SSH

4402

SM CLP

4403

SMTP

4404

LDAP

4405

RDP

4406

HTTPS

4407–32767

DMTF Reserved

32768–...

Vendor Reserved

 

ProtocolType
Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_ProtocolEndpoint.OtherTypeDescription) , Override (EnabledState) , Deprecated (CIM_ProtocolEndpoint.ProtocolIFType)

Note  This property is deprecated. Instead, we recommend that you use the CIM_ProtocolEndpoint.ProtocolIFType property.

Gets the network protocols that are supported by the DNS client.

This property is inherited from the CIM_ProtocolEndpoint class.

This property can contain the following values:

ValueMeaning
0

Unknown

1

Other

2

IPv4

3

IPv6

4

IPX

5

AppleTalk

6

DECnet

7

SNA

8

CONP

9

CLNP

10

VINES

11

XNS

12

ATM

13

Frame Relay

14

Ethernet

15

TokenRing

16

FDDI

17

Infiniband

18

Fibre Channel

19

ISDN BRI Endpoint

20

ISDN B Channel Endpoint

21

ISDN D Channel Endpoint

22

IPv4/v6

23

BGP

24

OSPF

25

MPLS

26

UDP

27

TCP

 

RegisterThisConnectionsAddress
Data type: boolean
Access type: Read/write

Indicates whether to register the address of the current connection with DNS.

RequestedState
Data type: uint16
Access type: Read-only

Indicates the last requested state of the DNS client. The actual state of the client is represented by the EnabledState property.

Default value: "12".

This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

ValueMeaning
0

Unknown

2

Enabled

3

Disabled

4

Shut Down

5

No Change

6

Offline

7

Test

8

Deferred

9

Quiesce

10

Reboot

11

Reset

12

Not Applicable

13–32767

DMTF Reserved

32768–65535

Vendor Reserved

 

Status
Data type: string
Access type: Read-only
Qualifiers: MaxLen (10) , Deprecated (CIM_ManagedSystemElement.OperationalStatus)

Note  This property is deprecated. Instead, use OperationalStatus.

Gets the status of the DNS client.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

ValueMeaning
OK

The DNS client is functioning without errors.

Error

The DNS client experienced an error.

Degraded

The DNS client is functioning but some features are turned off.

Unknown

The status of the DNS client is unknown.

Pred Fail

The DNS client experienced a predictive failure.

Starting

The DNS client is being started.

Stopping

The DNS client is being shut down.

Service

The DNS client is being serviced.

Stressed

The DNS client is having performance issues.

NonRecover

The DNS client has an error and cannot recover.

No Contact

There is no contact with the DNS client.

Lost Comm

Communication with the DNS client has been lost.

Stopped

The DNS client is not running, however, it might be possible to restart the DNS client.

 

StatusDescriptions
Data type: string array
Access type: Read-only
Qualifiers: ArrayType (Indexed) , ModelCorrespondence (CIM_ManagedSystemElement.OperationalStatus)

Gets an array of strings that describe the details of the corresponding array values in the OperationalStatus property.

This property is inherited from CIM_ManagedSystemElement.

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: key, MaxLen (256) , Propagated (CIM_System.CreationClassName)

Gets the class name of the system object that hosts the DNS client.

This property is inherited from the CIM_ServiceAccessPoint class.

SystemName
Data type: string
Access type: Read-only
Qualifiers: key, MaxLen (256) , Propagated (CIM_System.Name)

Gets the name of the system that hosts the DNS client.

This property is inherited from the CIM_ServiceAccessPoint class.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only
Qualifiers: Override (TimeOfLastStateChange)

Gets the datetime value that indicates when the EnabledState property was last changed.

TransitioningToState
Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence (CIM_EnabledLogicalElement.RequestStateChange, CIM_EnabledLogicalElement.RequestedState, CIM_EnabledLogicalElement.EnabledState)

Gets the state to which the DNS client will transition.

This property is inherited from CIM_EnabledLogicalElement.

ValueMeaning
0

Unknown

2

Enabled

3

Disabled

4

Shut Down

5

No Change

6

Offline

7

Test

8

Defer

9

Quiesce

10

Reboot

11

Reset

12

Not Applicable

13–...

DMTF Reserved

 

UseSuffixWhenRegistering
Data type: boolean
Access type: Read/write

Indicates whether to use the DNS suffix for the connection during DNS registration.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

Root\StandardCimv2

MOF

DnsClientCim.mof

DLL

DnsClientCim.dll

See also

Dnsclientcim Provider Class

 

 

Community Additions

Show:
© 2015 Microsoft