MSFT_DNSClientServerAddress class

  • Article

Represents an interface to a DNS server that includes address information about the remote connection to the server.

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

Syntax

class MSFT_DNSClientServerAddress : CIM_RemoteServiceAccessPoint
{
  string   InstanceId;
  string   Caption;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus[];
  uint16   PrimaryStatus;
  uint16   EnabledState;
  string   OtherEnabledState;
  uint16   RequestedState;
  uint16   EnabledDefault;
  datetime TimeOfLastStateChange;
  uint16   TransitioningToState;
  string   Name;
  string   SystemCreationClassName;
  string   SystemName[];
  string   CreationClassName;
  string   AccessInfo;
  uint16   InfoFormat;
  string   OtherInfoFormatDescription;
  uint16   AccessContext;
  string   OtherAccessContext;
  uint32   InterfaceIndex;
  string   InterfaceAlias;
  string   ServerAddresses[];
  uint16   AddressFamily;
};

Members

The MSFT_DNSClientServerAddress class has these types of members:

Methods

The MSFT_DNSClientServerAddress class has these methods.

Method Description
RequestStateChange Initiates a requests to change the state of a DNS server interface.

Properties

The MSFT_DNSClientServerAddress class has these properties.

AccessContext

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence (CIM_RemoteServiceAccessPoint.OtherAccessContext)

Gets a description of the role that the server plays in the local system.

This property is inherited from CIM_RemoteServiceAccessPoint.

This property contains one of the following values. The default value is "0" (unknown).

Value Meaning
0
 Unknown
1
 Other
2
 Default Gateway
3
 DNS Server
4
 SNMP Trap Destination
5
 MPLS Tunnel Destination
6
 DHCP Server
7
 SMTP Server
8
 LDAP Server
9
 Network Time Protocol (NTP) Server
10
 Management Service
207 32767
 DMTF Reserved
32768 ...
 Vendor Reserved

AccessInfo

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence (CIM_RemoteServiceAccessPoint.InfoFormat)

Gets the access and addressing information for the remote connection.

This property is inherited from CIM_RemoteServiceAccessPoint.

AddressFamily

Data type: uint16

Access type: Read-only

Gets the address family of the server address.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), Dynamic

Gets the short description of the server.

This property is inherited from CIM_ManagedElement.

CommunicationStatus

Data type: uint16

Access type: Read-only

Gets a value that indicates the ability of the server interface to communicate with the underlying CIM_ManagedElement object.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

Value Meaning
0
 Unknown
1
 Not Available
2
 Communication OK
3
 Lost Communication
4
 No Contact
5 32767
 DMTF Reserved
32768 65535
Vendor Reserved

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256)

Gets the name of the class that was used to create this MSFT_DNSClientServerAddress object. You can use this to create unique identifiers for class instances.

This property is inherited from CIM_ServiceAccessPoint.

DetailedStatus

Data type: uint16

Access type: Read-only

Gets information about the status of the server, 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:

Value Meaning
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

ElementName

Data type: string

Access type: Read-only

Gets the user-friendly name of the server.

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" (enabled). This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values:

Value Meaning
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

Access type: Read-only

Qualifiers: ModelCorrespondence (CIM_EnabledLogicalElement.OtherEnabledState)

Indicates whether the server is enabled, or in a related state.

This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values. The default value is "5" (not applicable).

Value Meaning
0
 Unknown
1
 Other
2
 Enabled
3
 Disabled
4
 Shutting Down
5
 Not Applicable
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 server.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

Value Meaning
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

InfoFormat

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence (CIM_RemoteServiceAccessPoint.OtherInfoFormatDescription)

Gets an integer that identifies a description of the AccessInfo property value.

This property is inherited from CIM_RemoteServiceAccessPoint.

Value Meaning
1
 Other
2
 Host Name
3
 IPv4 Address
4
 IPv6 Address
5
 IPX Address
6
 DECnet Address
7
 SNA Address
8
 Autonomous System Number
9
 MPLS Label
10
 IPv4 Subnet Address
11
 IPv6 Subnet Address
12
 IPv4 Address Range
13
 IPv6 Address Range
100
 Dial String
101
 Ethernet Address
102
 Token Ring Address
103
 ATM Address
104
 Frame Relay Address
200
 URL
201
 FQDN
202
 User FQDN
203
 DER ASN1 DN
204
 DER ASN1 GN
205
 Key ID
206
 Parameterized URL
207 32767
 DMTF Reserved
32768 ...
 Vendor Reserved

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings (MIF.DMTF|ComponentID|001.5)

Gets the datetime value that indicates when this object was created.

This property is inherited from CIM_ManagedSystemElement.

InstanceId

Data type: string

Access type: Read-only

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 server interface.

InterfaceIndex

Data type: uint32

Access type: Read-only

Gets the user-friendly index of the server interface.

Name

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256), Override (Name)

Gets the unique ID of this object.

This property is inherited from CIM_ServiceAccessPoint.

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 server, in addition to the information provided by the EnabledState property.

This property is inherited from CIM_ManagedSystemElement.

This property can contain the following values:

Value Meaning
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)

Gets an array that contains the status of the server.

This property is inherited from CIM_ManagedSystemElement.

This property can contain the following values:

Value Meaning
0
 Unknown
1
 Other
2
 OK
3
 Degraded
4
 Stressed
5
 Predictive Failure
6
 Error
7
 Non-Recoverable Error
8
 Starting
9
 Stopping
10
 Stopped
11
 In Service
12
 No Contact
13
 Lost Communication
14
 Aborted
15
 Dormant
16
 Supporting Entity in Error
17
 Completed
18
 Power Mode
19
 DMTF Reserved
20
 Vendor Reserved

OtherAccessContext

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence (CIM_RemoteServiceAccessPoint.AccessContext)

Gets a description of the role of the server when the AccessContext property is set to "1" (other).

This property is inherited from CIM_RemoteServiceAccessPoint.

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.

OtherInfoFormatDescription

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence (CIM_RemoteServiceAccessPoint.InfoFormat)

Gets a description to use when the InfoFormat property is set to "1" (other).

This property is inherited from CIM_RemoteServiceAccessPoint.

PrimaryStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence (CIM_ManagedSystemElement.DetailedStatus, CIM_ManagedSystemElement.HealthState)

Gets the high level status of the server.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

Value Meaning
0
 Unknown
1
 OK
2
 Degraded
3
 Error
4 32767
 DMTF Reserved
32768 65535
Vendor Reserved

RequestedState

Data type: uint16

Access type: Read-only

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

This property is inherited from CIM_EnabledLogicalElement.

This property contains one of the following values. The default value is "12" (not applicable).

Value Meaning
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

ServerAddresses

Data type: string array

Access type: Read-only

Gets an array that contains the IP addresses of the servers.

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 server.

This property is inherited from CIM_ManagedSystemElement.

This property contains one of the following values:

Value Meaning
OK
 The server is functioning without errors.
Error
 The server experienced an error.
Degraded
 The server is functioning but some features are turned off.
Unknown
 The status of the server is unknown.
Pred Fail
 The server experienced a predictive failure.
Starting
 The server is being started.
Stopping
 The server is being shut down.
Service
 The server is being serviced.
Stressed
 The server is having performance issues.
NonRecover
 The server has an error and cannot recover.
No Contact
 There is no contact with the server.
Lost Comm
 Communication with the server been lost.
Stopped
 The server is not running, however, it might be possible to restart the server.

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: MaxLen (256), Propagated (CIM_System.CreationClassName)

Gets the name of the class that represents the local system.

This property is inherited from CIM_ServiceAccessPoint.

SystemName

Data type: string array

Access type: Read-only

Qualifiers: MaxLen (256), Propagated (CIM_System.Name)

Gets the name of the local system.

This property is inherited from CIM_ServiceAccessPoint.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

Gets the date and time of the last change to the value of the EnabledState property.

This property is inherited from CIM_EnabledLogicalElement.

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 server will transition.

This property is inherited from CIM_EnabledLogicalElement.

Value Meaning
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

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 Classes