Professional Documents
Culture Documents
DSP1038 1.0.1
DSP1038 1.0.1
3 Date: 2008-10-01
4 Version: 1.0.1
8 Document Language: E
9
DNS Client Profile DSP1038
10 Copyright Notice
11 Copyright © 2008 Distributed Management Task Force, Inc. (DMTF). All rights reserved.
12 DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems
13 management and interoperability. Members and non-members may reproduce DMTF specifications and
14 documents for uses consistent with this purpose, provided that correct attribution is given. As DMTF
15 specifications may be revised from time to time, the particular version and release date should always be
16 noted.
17 Implementation of certain elements of this standard or proposed standard may be subject to third party
18 patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations
19 to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose,
20 or identify any or all such third party patent right, owners or claimants, nor for any incomplete or
21 inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to
22 any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize,
23 disclose, or identify any such third party patent rights, or for such party’s reliance on the standard or
24 incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any
25 party implementing such standard, whether such implementation is foreseeable or not, nor to any patent
26 owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is
27 withdrawn or modified after publication, and shall be indemnified and held harmless by any party
28 implementing the standard from any and all claims of infringement by a patent owner for such
29 implementations.
30 CONTENTS
31 Foreword ....................................................................................................................................................... 5
32 Introduction ................................................................................................................................................... 6
33 1 Scope .................................................................................................................................................... 7
34 2 Normative References........................................................................................................................... 7
35 2.1 Approved References ................................................................................................................. 7
36 2.2 Other References........................................................................................................................ 7
37 3 Terms and Definitions ........................................................................................................................... 7
38 4 Symbols and Abbreviated Terms .......................................................................................................... 9
39 5 Synopsis ................................................................................................................................................ 9
40 6 Description .......................................................................................................................................... 10
41 7 Implementation.................................................................................................................................... 11
42 7.1 DNS Client Representation....................................................................................................... 11
43 7.2 DNS Server Representation ..................................................................................................... 14
44 7.3 DNS Client-Server Relationship ............................................................................................... 14
45 7.4 Alternate Configuration Management (Optional) ...................................................................... 15
46 8 Methods............................................................................................................................................... 16
47 8.1 CIM_DNSProtocolEndpoint.RequestStateChange( ) ............................................................... 16
48 8.2 Profile Conventions for Operations........................................................................................... 17
49 8.3 CIM_DNSGeneralSettingData .................................................................................................. 18
50 8.4 CIM_DNSProtocolEndpoint ...................................................................................................... 18
51 8.5 CIM_DNSSettingData ............................................................................................................... 18
52 8.6 CIM_ElementCapabilities ......................................................................................................... 19
53 8.7 CIM_ElementSettingData ......................................................................................................... 19
54 8.8 CIM_EnabledLogicalElementCapabilities................................................................................. 19
55 8.9 CIM_SAPSAPDependency....................................................................................................... 19
56 8.10 CIM_HostedAccessPoint .......................................................................................................... 20
57 8.11 CIM_RemoteServiceAccessPoint............................................................................................. 20
58 8.12 CIM_RemoteAccessAvailableToElement ................................................................................. 20
59 9 Use Cases........................................................................................................................................... 20
60 9.1 Object Diagrams ....................................................................................................................... 20
61 9.2 Determine the Current DNS Configuration ............................................................................... 24
62 9.3 Determine Support for an Alternate DNS Configuration........................................................... 25
63 9.4 Modify the DNS Configuration .................................................................................................. 25
64 9.5 Determine Whether ElementName Can Be Modified ............................................................... 25
65 9.6 Determine Whether State Management Is Supported.............................................................. 25
66 10 CIM Elements...................................................................................................................................... 26
67 10.1 CIM_DNSGeneralSettingData .................................................................................................. 26
68 10.2 CIM_DNSProtocolEndpoint ...................................................................................................... 27
69 10.3 CIM_DNSSettingData ............................................................................................................... 28
70 10.4 CIM_ElementCapabilities ......................................................................................................... 28
71 10.5 CIM_ElementSettingData—DNSGeneralSettingData .............................................................. 29
72 10.6 CIM_ElementSettingData—DNSSettingData ........................................................................... 29
73 10.7 CIM_EnabledLogicalElementCapabilities................................................................................. 29
74 10.8 CIM_SAPSAPDependency....................................................................................................... 30
75 10.9 CIM_HostedAccessPoint—DNSProtocolEndpoint ................................................................... 30
76 10.10 CIM_HostedAccessPoint—RemoteServiceAccessPoint.......................................................... 30
77 10.11 CIM_RemoteAccessAvailableToElement ................................................................................. 31
78 10.12 CIM_RemoteServiceAccessPoint............................................................................................. 31
79 10.13 CIM_RegisteredProfile.............................................................................................................. 32
80 ANNEX A (Informative) Change Log ......................................................................................................... 33
81 ANNEX B (informative) Acknowledgments ................................................................................................ 34
82
83 Figures
91 Tables
117
118 Foreword
119 The DNS Client Profile (DSP1038) was prepared by the Server Management Working Group of the
120 DMTF.
121 DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems
122 management and interoperability.
123 Introduction
124 The information in this specification should be sufficient for a provider or consumer of this data to identify
125 unambiguously the classes, properties, methods, and values that shall be instantiated and manipulated to
126 represent and manage a DNS client and its associated configuration information. The target audience for
127 this specification is implementers who are writing CIM-based providers or consumers of management
128 interfaces that represent the component described in this document.
130 1 Scope
131 The DNS Client Profile extends the management capability of referencing profiles by adding the capability
132 to represent the DNS client configuration of a computer system and its IP interfaces.
157 3.1
158 can
159 used for statements of possibility and capability, whether material, physical, or causal
160 3.2
161 cannot
162 used for statements of possibility and capability, whether material, physical, or causal
163 3.3
164 conditional
165 indicates requirements to be followed strictly to conform to the document when the specified conditions
166 are met
167 3.4
168 mandatory
169 indicates requirements to be followed strictly to conform to the document and from which no deviation is
170 permitted
171 3.5
172 may
173 indicates a course of action permissible within the limits of the document
174 3.6
175 need not
176 indicates a course of action permissible within the limits of the document
177 3.7
178 optional
179 indicates a course of action permissible within the limits of the document
180 3.8
181 referencing profile
182 indicates a profile that owns the definition of this class and can include a reference to this profile in its
183 “Referenced Profiles” table
184 3.9
185 shall
186 indicates requirements to be followed strictly to conform to the document and from which no deviation is
187 permitted
188 3.10
189 shall not
190 indicates requirements to be followed strictly to conform to the document and from which no deviation is
191 permitted
192 3.11
193 should
194 indicates that among several possibilities, one is recommended as particularly suitable, without
195 mentioning or excluding others, or that a certain course of action is preferred but not necessarily required
196 3.12
197 should not
198 indicates that a certain possibility or course of action is deprecated but not prohibited
199 3.13
200 unspecified
201 indicates that this profile does not define any constraints for the referenced CIM element or operation
202
213
214 EXPERIMENTAL
216 EXPERIMENTAL
218 4.1
219 DNS
220 Domain Name System
221 4.2
222 DHCP
223 Dynamic Host Configuration Protocol
224 4.3
225 IP
226 Internet Protocol
227 5 Synopsis
228 Profile Name: DNS Client
229 Version: 1.0.1
230 Organization: DMTF
231 CIM Schema Version: 2.19.1
232 Central Class: CIM_DNSProtocolEndpoint
233 Scoping Class: CIM_ComputerSystem
234 The DNS Client Profile extends the management capability of referencing profiles by adding the capability
235 to represent a DNS client in a managed system. This profile includes a specification of the DNS client, its
236 configuration, its associated capabilities, and the profile registration information for this profile.
237 The Central Instance of the DNS Client Profile shall be an instance of CIM_DNSProtocolEndpoint. The
238 Scoping Instance shall be the instance of CIM_ComputerSystem with which the Central Instance is
239 associated through an instance of CIM_HostedAccessPoint.
242 6 Description
243 The DNS Client Profile describes a DNS client in a managed system. The DNS client is represented by
244 an instance of CIM_DNSProtocolEndpoint. The DNS client has a relationship with exactly one IP
245 interface. This relationship is indicated through an instance of the CIM_SAPSAPDependency association.
246 Configuration information for each interface is modeled in the CIM_DNSProtocolEndpoint instance as well
247 as in the CIM_DNSSettingData instance.
251 The DNS servers that the DNS client has been configured to use are modeled using an instance of
252 CIM_RemoteServiceAccessPoint. The actual DNS servers are not modeled in this profile.
253 Figure 1 represents the class schema for the DNS Client Profile. For simplicity, the prefix CIM_ has been
254 removed from the names of the classes.
1..*
ComputerSystem 1
(See Referencing Profile) StaticAssignmentIPSettingData
(See IP Interface Profile)
1
HostedAccessPoint * *
(See IP Interface Profile) ElementSettingData
(See IP Interface Profile)
HostedAccessPoint
1..*
* 1..*
IPProtocolEndpoint OrderedComponent
RemoteServiceAccessPoint (See IP Interface Profile) (See IP Interface Profile)
ElementSettingData
1 1..*
*
SAPSAPDependency
ElementSettingData
RemoteAccessAvailableToElement 1..* (See IP Interface Profile)
1
DNSProtocolEndpoint 1
IPAssignmentSettingData
1..*
(See IP Interface Profile)
257 7 Implementation
258 This section details the requirements related to the arrangement of instances and properties of instances
259 for implementations of this profile.
264 The current configuration of the DNS client is modeled using properties of the CIM_DNSProtocolEndpoint
265 instance. One or more alternate configurations for the client may be instrumented. Requirements when
266 modeling one or more alternate configurations are described in section 7.4.
267
268 EXPERIMENTAL
269
274 EXPERIMENTAL
275
290 The RequestedStatesSupported property may contain zero or more of the following values: 2 (Enabled),
291 3 (Disabled), or 11 (Reset).
296 The CIM_DNSProtocolEndpoint.RequestedState property shall have one of the values specified in the
297 CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported property or a value of 5 (No
298 Change).
300 When the RequestedState parameter has a value of 2 (Enabled) or 3 (Disabled) and the
301 CIM_DNSProtocolEndpoint.RequestStateChange( ) method completes successfully, the value of the
302 EnabledState property shall equal the value of the CIM_DNSProtocolEndpoint.RequestedState property.
303 If the method does not complete successfully, the value of the EnabledState property is indeterminate.
304 The EnabledState property shall have the value 2 (Enabled), 3 (Disabled), or 5 (Not Applicable).
316 The RequestedState property shall have the value 12 (Not Applicable).
318 The EnabledState property shall have one of the following values: 2 (Enabled), 3 (Disabled), 5 (Not
319 Applicable), or 6 (Enabled but Offline).
353
354 EXPERIMENTAL
355 If the value of CIM_RemoteServiceAccessPoint.InfoFormat is 4 (IPv6 Address), then the value of the
356 property shall be expressed in the notation as defined in IETF RFC 4291, section 2.2.
357 EXPERIMENTAL
360
361 EXPERIMENTAL
363 EXPERIMENTAL
364
379 For this set of instances, the values of the OrderOfAccess property of each instance shall form a positive,
380 monotonically increasing sequence starting with a value of 1. The relative order of the value of the
381 OrderOfAccess properties shall correspond to the relative order in which the DNS client will communicate
382 with the represented DNS servers when performing name resolution.
388 When alternate configuration management of the DNS client is not supported, the current configuration of
389 the DNS client shall not be affected when an alternate configuration for an IP interface is applied to the
390 associated IP interface.
391 Some aspects of the configuration are specific to a particular IP interface. These aspects are modeled
392 using CIM_DNSSettingData. Other aspects of the complete configuration are applicable system wide.
393 These aspects are modeled using CIM_DNSGeneralSettingData. When alternate configuration
394 management of the DNS client is supported, the current configuration of the DNS client shall not be
395 affected when an alternate configuration for an IP interface is applied to the associated IP interface where
396 no instance of CIM_DNSSettingData or CIM_DNSGeneralSettingData is associated with the
397 CIM_IPAssignmentSettingData instance.
398 The following subclauses specify the requirements when this optional behavior is implemented.
431 8 Methods
432 This section details the requirements for supporting intrinsic operations and extrinsic methods for the CIM
433 elements defined by this profile.
441 Detailed requirements for the RequestStateChange( ) method are specified in Table 2 and Table 3.
443 Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten
444 or lost.
Value Description
0 Request was successfully executed.
1 Method unsupported
2 Error occurred
0x1000 Job started: REF returned to started CIM_ConcreteJob
468 A compliant implementation shall support all the operations in the default list for each class, unless the
469 “Requirement” column states something other than Mandatory.
534 The CIM_DNSProtocolEndpoint instance is associated with profile1, indicating that the instance of
535 CIM_DNSProtocolEndpoint is conformant with the DMTF DNS Client Profile version 1.0.0. The instance
536 of CIM_ComputerSystem is conformant with the DMTF Base System Profile version 1.0.0, as indicated by
537 the CIM_ElementConformsToProfile association to profile2. Likewise, the CIM_IPProtocolEndpoint
538 instance is conformant with the DMTF IP Interface Profile version 1.0.0, as indicated by the association to
539 profile3.
ComputerSystem
ElementConformsToProfile
profile2 : RegisteredProfile
RegisteredOrganization : DMTF
HostedAccessPoint
RegisteredName : Base Server
RegisteredVersion : 1.0.0
DNSProtocolEndpoint
ReferencedProfile
profile1 : RegisteredProfile
RegisteredOrganization : DMTF ElementConformsToProfile
RegisteredName : DNS Client SAPSAPDependency
RegisteredVersion : 1.0.0
IPProtocolEndpoint
profile3 : RegisteredProfile
RegisteredOrganization : DMTF ElementConformsToProfile
RegisteredName : IP Interface
RegisteredVersion : 1.0.0
540
542 Figure 3 is an object diagram for an IP interface with DNS client support. Management of the DNS client
543 is limited to indicating the host name bound to the IP interface. The DNS client for the IP interface is
544 represented by the instance of CIM_DNSProtocolEndpoint. In this implementation, the current host name
545 being used can be queried and the DNS client can be enabled and disabled.
ComputerSystem
HostedAccessPoint HostedAccessPoint
IPProtocolEndpoint DNSProtocolEndpoint
SAPSAPDependency
IPv4Address : 9.44.125.168 ProtocolIFType : 1 (Other)
SubnetMask : 255.255.240.0 OtherTypeDescription : DNS
AddressOrigin : 3 (static) Hostname : w3
EnabledState : 2 (Enabled)
546
548 Figure 4 is an object diagram for an IP interface that has DNS client support. This implementation
549 provides a complete model of the DNS client configuration. Each instance of
550 CIM_RemoteServiceAccessPoint represents a DNS server that the client has been configured to use.
551 The CIM_DNSProtocolEndpoint instance contains the entire configuration of the DNS client.
ComputerSystem
HostedAccessPoint
HostedAccessPoint
IPProtocolEndpoint
IPv4Address : 9.44.125.168
DNSProtocolEndpoint
SubnetMask : 255.255.240.0 SAPSAPDependency
AddressOrigin : 3 (static) ProtocolIFType : 1 (Other)
HostedAccessPoint
OtherTypeDescription : DNS
Hostname : w3
DomainName: abc.com
RegisterThisConnectionsAddress :true
UseSuffixWhenRegistering : TRUE
AppendPrimarySuffixes : TRUE
DNS1 : RemoteServiceAccessPoint AppendParentSuffixes : TRUE
RemoteAccessAvailableToElement
OrderOfAccess : 1 DNSSuffixToAppend : xyz.abc.com
Name : DNS Server 9.44.125.1
AccessInfo : 9.44.125.1
InfoFormat : 3 (IPv4 Address)
AccessContext : 3 (DNS Server) RemoteAccessAvailableToElement
OrderOfAccess : 2
DNS3 : RemoteServiceAccessPoint
Name : DNS Server 9.44.6.5
AccessInfo : 9.44.6.5
InfoFormat : 3 (IPv4 Address)
AccessContext : 3 (DNS Server)
552
554 The object diagram in Figure 5 is for an implementation in which the optional behavior of managing
555 alternate configurations is supported. This diagram illustrates a more complete implementation than
556 Figure 4. The current configuration of the DNS client is reflected by the properties of the
557 CIM_DNSProtocolEndpoint instance.
558 dns2 and dnsgen2 contain the alternate configuration for the DNS client that will be used if the instance of
559 CIM_IPAssignmentSettingData that represents an alternate configuration that could be applied to the IP
560 interface is applied to the IP interface.
561 Note that to reduce clutter, the CIM_HostedAccessPoint associations are not shown. Neither are the
562 CIM_IPConfigurationService instance and its related associations.
ComputerSystem
ElementSettingData
IsCurrent : 2 (Is Not Current)
ElementSettingData
IsCurrent : 2 (Is Not Current)
StaticIPAssignmentSettingData
dnsgen2 : DNSGeneralSettingData
IPAddress : 9.44.124.126
IPProtocolEndpoint SubnetMask : 255.255.255.0 AppendPrimarySuffixes : TRUE
IsCurrent : 2 (Is Not Current)
SAPSAPDependency
ElementSettingData
IsCurrent : 2 (Is Not Current) OrderedComponent
IsNext : 1 (Is Next) AssignedSequence : 1
DNSProtocolEndpoint
ProtocolIFType : 1 (Other)
OtherTypeDescription : DNS
Hostname : w3
AppendPrimarySuffixes : TRUE IPAssignmentSettingData
AppendParentSuffixes : FALSE
DNSSuffixToAppend : abc.xyz.com
DomainName: xyz.com
RegisterThisConnectionsAddress :TRUE
UseSuffixWhenRegistering : TRUE ElementSettingData OrderedComponent
IsCurrent : 2 (Is Not Current) AssignedSequence : 2
RemoteAccessAvailableToElement
OrderOfAccess : 1 dns2 : DNSSettingData
DomainName: xyz.com
svr1 : RemoteServiceAccessPoint RequestedHostName: thatsystem
RegisterThisConnectionsAddress :TRUE
AccessInfo : 9.44.125.1 UseSuffixWhenRegistering : TRUE
InfoFormat : 3 (IPv4 Address) DNSServerAddresses : 9.44.120.1, 9.44.120.2
AccessContext : 3 (DNS Server)
563
565 The object diagram in Figure 6 is for the same implementation as that of Figure 5 after the alternate
566 configuration has been applied. The property values of the CIM_DNSProtocolEndpoint instance have
567 been updated to reflect the settings applied when the alternate configuration was applied. The IsCurrent
568 property of the instances of CIM_ElementSettingData that associate dns2 and dnsgen2 with the
569 CIM_DNSProtocolEndpoint instance have the value 1 (Is Current), which indicates that these settings
570 were the last applied.
ComputerSystem
ElementSettingData
IsCurrent : 1 (Is Current)
dnsgen2 : DNSGeneralSettingData
AppendPrimarySuffixes : TRUE
AppendParentSuffixes : TRUE
DNSSuffixToAppend : hgw.xyz.com
IPProtocolEndpoint
IsCurrent : 1 (Is Current)
ElementSettingData
IPAssignmentSettingData
SAPSAPDependency
ElementSettingData
IsCurrent : 1 (Is Current)
OrderedComponent
DNSProtocolEndpoint AssignedSequence : 3
ProtocolIFType : Other
OtherTypeDescription : DNS
Hostname : thatsystem
StaticIPAssignmentSettingData
AppendPrimarySuffixes : TRUE IPAddress : 9.44.124.126
AppendParentSuffixes : TRUE SubnetMask : 255.255.255.0
DNSSuffixToAppend : hgw.xyz.com DefaultGatewayAddress : 9.44.124.1
DomainName: xyz.com OrderedComponent
RegisterThisConnectionsAddress :TRUE AssignedSequence : 2
UseSuffixWhenRegistering : TRUE ElementSettingData
IsCurrent : 1 (Is Current)
dns2 : DNSSettingData
RemoteAccessAvailableToElement DomainName: xyz.com
OrderOfAccess : 1 RemoteAccessAvailableToElement RequestedHostName: thatsystem
OrderOfAccess : 2 RegisterThisConnectionsAddress :TRUE
UseSuffixWhenRegistering : TRUE
svr2 : RemoteServiceAccessPoint srv3 : RemoteServiceAccessPoint DNSServerAddresses : 9.44.120.1, 9.44.120.2
694 NOTE: Previous versions of this document included the suffix “Profile” for the RegisteredName value. If
695 implementations querying for the RegisteredName value find the suffix “Profile”, they should ignore the suffix, with
696 any surrounding white spaces, before any comparison is done with the value as specified in this document.
697
698 ANNEX A
699 (Informative)
700
701 Change Log
702
703 ANNEX B
704 (informative)
705
706 Acknowledgments
708 Editor:
709 • Aaron Merkin – IBM
710 • Jeff Hilland – HP
711 • Jim Davis – WBEM Solutions
712 Contributors:
713 • Jon Hass – Dell
714 • Khachatur Papanyan – Dell
715 • Enoch Suen – Dell
716 • Jeff Hilland – HP
717 • Christina Shaw – HP
718 • Aaron Merkin – IBM
719 • Perry Vincent – Intel
720 • John Leung – Intel
721