1
4
Web Services Distributed Management: Management Using Web Services (MUWS 1.1) Part 1
5
OASIS Standard, 01 August 2006
6 7
Document identifier: wsdm-muws1-1.1-spec-os-01
8 9
Location: http://docs.oasis-open.org/wsdm/wsdm-muws1-1.1-spec-os-01.pdf
10 11
Technical Committee: OASIS Web Services Distributed Management TC
12 13
Chair(s): Heather Kreger, IBM, <[email protected]>
14 15 16
Editor:
17 18 19 20
Abstract: There are two specifications produced by the Web Services Distributed Management technical committee: Management Using Web services (MUWS) and Management Of Web Services (MOWS, see [[MOWS]]). This document is part of MUWS.
2 3
Vaughn Bullard, AmberPoint, Inc. <[email protected]> William Vambenepe, Hewlett-Packard <[email protected]>
21 22 23
MUWS defines how an Information Technology resource connected to a network provides manageability interfaces such that the IT resource can be managed locally and from remote locations using Web services technologies.
24 25 26 27 28
MUWS is composed of two parts. This document is MUWS part 1 and provides the fundamental concepts for management using Web services. MUWS part 2 [MUWS Part 2] provides specific messaging formats used to enable the interoperability of MUWS implementations. MUWS part 2 depends on MUWS part 1, while part 1 is independent from part 2.
29 30 31 32 33 34 35 36 37 38
Status:
This document was last revised or approved by the membership of OASIS on the above date. The level of approval is also listed above. Check the current location noted above for possible later revisions of this document. This document is updated periodically on no particular schedule. Technical Committee members should send comments on this specification to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committee’s web page at www.oasis-open.org/committees/wsdm/.
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 1 of 31
39 40 41 42
For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (www.oasis-open.org/committees/wsdm/ipr.php.
43 44
The non-normative errata page for this specification is located at www.oasisopen.org/committees/wsdm.
45
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 2 of 31
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
Table of Contents Introduction ............................................................................................................................. 4 1.1 Terminology.................................................................................................................... 4 1.2 Notational conventions ................................................................................................... 5 2 Architecture ............................................................................................................................. 7 2.1 Focus on WSDM Resources.......................................................................................... 7 2.1.1 Capabilities for Management ..................................................................................... 8 2.1.2 Composition of Resources......................................................................................... 8 2.1.3 Isolation from Implementation.................................................................................... 9 2.2 Composability................................................................................................................. 9 2.2.1 Low-end to High-end Manageability ........................................................................ 10 3 Usage of the Web Services Platform.................................................................................... 12 Properties ..................................................................................................................... 12 3.1 3.2 Operations.................................................................................................................... 12 3.3 Events .......................................................................................................................... 12 3.4 Metadata ...................................................................................................................... 13 3.5 Addressing ................................................................................................................... 13 3.6 Security ........................................................................................................................ 13 4 Common Information Items................................................................................................... 15 4.1 WSDM Event Format ................................................................................................... 15 4.1.1 XML Representation of the event ............................................................................ 15 4.2 Manageability Endpoint Reference .............................................................................. 16 5 Capabilities ........................................................................................................................... 17 5.1 Identity.......................................................................................................................... 17 5.1.1 Definition .................................................................................................................. 17 5.1.2 Properties................................................................................................................. 17 5.2 Manageability Characteristics ...................................................................................... 18 5.2.1 Definition .................................................................................................................. 19 5.2.2 Properties................................................................................................................. 19 5.3 Correlatable Properties ................................................................................................ 19 5.3.1 Definition .................................................................................................................. 19 5.3.2 Information Markup Declarations............................................................................. 20 5.3.3 Properties................................................................................................................. 20 6 Defining a Manageability Capability...................................................................................... 24 7 References............................................................................................................................ 25 Normative ..................................................................................................................... 25 7.1 7.2 Non-normative.............................................................................................................. 25 Appendix A. Acknowledgements ............................................................................................. 27 Appendix B. Notices................................................................................................................. 28 Appendix C. MUWS Part 1 Schema (Normative) .................................................................... 29 Appendix D. Properties Boolean Match Schema (Normative) ................................................. 31 1
87 wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 3 of 31
88
1 Introduction
89 90 91 92 93 94 95
Management Using Web Services (MUWS) enables management of distributed information technology (IT) resources using Web services. Many distributed IT resources use different management interfaces. By leveraging Web service technology, MUWS enables easier and more efficient management of IT resources. This is accomplished by providing a flexible, common framework for manageability interfaces that leverage key features of Web services protocols. Universal management and interoperability across the many and various types of distributed IT resources can be achieved using MUWS.
96 97 98
The types of management capabilities exposed by MUWS are the management capabilities generally expected in systems that manage distributed IT resources. Examples of manageability functions that can be performed via MUWS include:
99
•
monitoring the quality of a service
100
•
enforcing a service level agreement
101
•
controlling a task
102
•
managing a resource lifecycle
103 104 105
MUWS is designed to meet the requirements defined in the MUWS Requirements document [MUWS REQS. Whenever possible, MUWS leverages existing Web services specifications to ensure interoperability, adoptability, and extensibility.
106 107
There is a basic set of manageability capabilities defined in this specification. The only capability required by MUWS is the Identity capability defined in section 5.1.
108 109
To understand the various topics discussed in this specification, the reader should be familiar with IT management concepts. In addition, the following assumptions are made:
110
•
The reader is familiar with the Web Services Architecture [WSA].
111 112
•
The reader is familiar with XML [XML1.0 3 Edition], XML Schema [XML Schema Part 1] [XML Schema Part 2], and XML Namespace [XNS]
113 114
•
The reader is familiar with WSDL [WSDL], SOAP [SOAP] and WS-Addressing [WSAddressing].
115
•
The reader is familiar with WS SOAP Message Security [WSS.
rd
116 117
The text of this specification, along with Appendix C and Appendix D, is normative with the following exception: the abstract, examples and any section explicitly marked as non-normative.
118
1.1 Terminology
119 120 121
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT","SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [RFC2119].
122
Furthermore, this specification defines and uses the following terms:
123 124 125 126
Web service endpoint – an entity providing a destination for Web service messages. A Web service endpoint has an address (URL) and is described by the content of a WSDL 1.1 port element. This definition is consistent with the definition provided in the WS-Addressing specification [WS-Addressing].
127 128
Web service interface – a group of operations described by the content of a WSDL 1.1 portType element. These operations can provide access to resource properties and metadata.
129 130
IT Resource –a logical or physical component of some subject domain, for example, a printer, a magnetic storage disk, an application server or a CRM application. wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 4 of 31
131 132
WS Resource – a resource defined as the actual composition of a resource and a web service from which the resource can be accessed.
133 134 135
WSDM Resource -- a resource for which the management aspect is projected as a WSRF resource. Further usage of the term “resource” shall indicate a reference to a “WSDM resource” unless so noted.
136 137
Manageable resource – a resource capable of supporting one or more standard manageability capabilities.
138 139
Capability –a group of properties, operations, events and metadata associated with identifiable semantics and information and exhibiting specific behaviors.
140
Manageability – the ability to manage a resource, or the ability of a resource to be managed.
141 142
Manageability capability – a capability associated with one or more management domains. This capability is considered to be a resource property.
143 144
Standard manageability capability – a manageability capability that is defined by this specification.
145 146
Manageability interface – A Web service interface that exposes interfaces for one or more manageability capabilities.
147 148
Manageability consumer –a user of manageability capabilities associated with one or more manageable resources.
149 150
Manageability endpoint –a Web service endpoint associated with and providing access to a manageable resource.
151 152
Management domain – an area of knowledge relative to providing control over, and information about, the behavior, health, lifecycle, etc. of manageable resources.
153
1.2 Notational conventions
154 155
This specification uses an informal syntax to describe the XML grammar of the information used in defining the management capabilities. This syntax uses the following rules:
156 157 158
The syntax appears as an XML instance, but data types appear instead of values.
159 160
{any} is a placeholder for elements from some other namespace (like ##other in the XML Schema).
161 162
The Cardinality of an attribute, element, or {any}, is indicated by appending characters to the item as follows:
163
?
none, or one
164
*
none, or more
165
+
one, or more
166
no character
exactly one
167
Items contained within the square brackets, [ and ], are treated as a group.
168 169
Items separated by | and grouped within parentheses, ( and ), indicate syntactic alternatives.
170 171
An ellipsis, or three consecutive periods, ..., are used in XML start elements to indicate that attributes from some other namespace are allowed.
172 173
The XML namespace prefixes, defined in section 5, indicate the namespace of an attribute or an element.
174 wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 5 of 31
175 176
A full XML Schema description of the XML information is available in Appendix C of this specification.
177 178 179
When describing an instance of XML information, and in order to refer to an element or an attribute, this specification uses a simplified XPath-like notation that is formally defined as follows:
180 181
Path = ‘/’? ([‘@’? (NCName | QName | ‘*’)] | [‘(‘ (NCName | QName | ‘*’] ‘)’) [‘/’ Path]?
182 183
where:
184 185 186
NCName is an XML non-qualified name as defined by the XML Schema [XML Schema Part 1]. In this case, the namespace is assumed to default to the namespace of this specification.
187 188
QName is an XML qualified name as defines by the XML Schema [XML Schema Part 1].
189
Symbol * denotes any name match.
190 191
Symbol / denotes a path delimiter. When it appears as the first element of the path, it denotes the root of the XML document.
192 193
Symbol @ denotes a reference to an XML attribute. If absent then an NCName, QName or * refer to an XML element.
194
Symbols ( and ) denote a reference to an XML Schema type.
195 196 197 198
For example: /E1/E2/@A1
refers to an attribute, A1, of an element, E2, contained in element E1, which is a root of the XML document.
E1/ns1:E2/E3
refers to an element, E3, which is contained in element E2 which is contained in element E1, anywhere in the XML document. In this case element E2 belongs to the namespace mapped to the prefix ns1.
(ns2:T1)/E1/ns1:E2/@A1
refers to an attribute, A1, on an element, E2, contained in element E1, as declared in the XML Schema type T1. In this case, the target namespace, T1, is mapped to the prefix ns2.
199 200 201 202 203 204 205 206 207 208
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 6 of 31
209
2 Architecture
210 211 212 213 214
This WSDM specification (MUWS) defines how the ability to manage, or how the manageability of, an arbitrary resource can be made accessible via Web services. In order to achieve this goal, MUWS is based on a number of Web services specifications, mainly for messaging, description, discovery, accessing properties, and notifications (section 3). Some of these Web services specifications are first presented in [MUWS Part 2].
215
The basic concepts of management using Web services can be illustrated by the following figure:
216 217
Figure 1: WSDM Concepts
218 219 220
A Web service endpoint provides access to a manageable resource. An example of a manageable resource is a printer that has the capability to alert when its toner is low, or, a magnetic storage disk that reports its internal temperature in the form of a web service operation.
221 222 223 224
A manageability consumer discovers the Web service endpoint and exchanges messages with the endpoint in order to request information, subscribe to events, or, control the manageable resource associated with the endpoint. An example of a manageability consumer is a management system, or, a business automation process, or simply, any Web service application.
225 226 227 228 229 230
In order to discover the Web service endpoint providing access to a particular manageable resource, a manageability consumer first obtains an Endpoint Reference (EPR), as defined by the WS-Addressing specification [WS-Addressing], and then obtains any other required descriptions, including, but not limited to, a WSDL document [WSDL], an XML Schema, or a policy document. MUWS uses the same mechanisms for obtaining EPRs and their associated descriptions as used by regular Web service implementations.
231 232
A Web service endpoint providing access to some manageable resource is called a manageability endpoint.
233 234 235 236
To exchange messages with a manageability endpoint, a manageability consumer needs to understand all of the required descriptions for the endpoint. The manageability consumer sends messages targeted to the manageable resource by using information contained in the EPR, for example, an address and some reference properties (see [WS-Addressing]).
237
2.1 Focus on WSDM Resources
238 239 240 241
The WSDM specification focuses upon how access is provided to manageable resources. Essentially, there exists a contract between a manageability consumer and a manageable resource with respect to the ability of the consumer to understand what messages can be exchanged between the consumer and the resource. Therefore, the central element and focal wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 7 of 31
242 243 244
point of the WSDM architecture is the manageable resource. The message patterns encapsulate access to resources into manageable resources instead of exposing message patterns to indirectly access the resource through agents, proxies, observers, etc.
245
2.1.1 Capabilities for Management
246 247 248 249 250 251 252
Manageability is one possible aspect of a resource. For example, a printer can, obviously, print. Printing is the functional/operational aspect of the printer. However, the same printer may be able to indicate if it is on-line, or, if the toner has run out. Such indications compose manageability capabilities of the printer. A manageable resource may support some number of capabilities. Each capability has distinct semantics, for example, an ability to describe relationships among resources or an ability to indicate if the resource is on-line or off-line. An implementation of a manageable resource provides a set of manageability capabilities via Web service endpoints.
253
In WSDM terms, a manageability capability
254
is uniquely identified in time and environment,
255 256
has defined semantics (such as those provided by any section in this specification that describes a new capability),
257 258
is associated with a set of properties, operations, events (notifications) and metadata (including policies).
259 260 261 262
Each manageability capability defined in the WSDM specifications is extensible. New capabilities can be similarly defined, based on a particular resource manageability model, for example, DMTF CIM. MUWS provides mechanisms, patterns, and refinements, for defining new manageability capabilities and for discovering, identifying and using capabilities of a manageable resource.
263
2.1.2 Composition of Resources
264 265 266 267 268 269
As a generic and composable specification, WSDM MUWS can be used whether or not a resource model exists for the resource that is made manageable through MUWS. If a resource model (standard or not) exists for the resource, WSDM MUWS provides ways to expose the elements of this model through Web services standards. In this case, the properties of the manageable resource correspond to the appropriate model elements for this resource, plus the MUWS-defined ResourceId property.
270 271 272 273 274 275 276 277
In addition, WSDM MUWS Part 2 defines a set of standard model elements, such as elements to represent relationships among resources, a caption, the version, a human-readable description of the resource, the operational status of the resource, etc. These elements can be used if there is no resource model for the resource, in addition to other resource-specific elements that might need to be defined. Even if there is a model for the resource and if the model contains element that semantically overlap the elements defined in MUWS Part 2, the developer might choose to expose the information through both sets of elements in order to maximize interoperability and make the manageability information consumable by more managers.
278 279 280 281 282 283 284 285 286
In some cases, a resource model only provides a means to represent an individual resource in an XML document. A resource model that is limited in this way does not facilitate the generation of an XML document representing a system comprised of multiple resource instances. For such a case, WS-ServiceGroup provides a means of generating an XML document representing a system of resources. In this case, the system model is exposed by the resource properties document of a WS-ServiceGroup containing the set of resources. Relationships among resources in a WS-ServiceGroup are represented by model elements in a resource model. For example, a relationship can be exposed through a model element defined in a resource model, as a CIM association, or a relationship can be exposed through a MUWS relationship element.
287 288 289 290
Elements of a resource model may be accessed via WSRF operations and received via WSNotification messages with a level of granularity that is different than the level of granularity used to define a WSDM resource. For example, a single request can be used to retrieve an XML document containing a representation of a system comprised of several WSDM resources. wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 8 of 31
291 292
Alternatively, it is possible to use several requests to retrieve a select set of model elements for a WSDM resource.
293 294
2.1.3 Isolation from Implementation
295 296 297 298 299 300
The WSDM architecture focuses upon the manageable resource. This approach does not restrict choices of an implementation strategy. Moreover, WSDM isolates the manageability consumer from implementation specific aspects of a manageable resource or Web service endpoint. For example, a direct-to-resource, agent-less approach, or, an approach using management agents are equally valid implementations. Such implementation details are transparent to manageability consumers. Error! Reference source not found. illustrates this point:
301 302
Figure 2: Isolation from Implementation
303 304
2.2 Composability
305 306 307 308 309 310 311 312 313
Composability allows a manageable resource’s implementation to support a non conflicting mix of some number of capabilities as well as features provided by the Web services platform. Parts of the composition incrementally enrich the implementation without incurring disruptions. For example, a SOAP message sent to a Web service endpoint may result in an order being placed. A similar SOAP message with WS-Security headers, signed and encrypted, may result in an order being placed in a secure manner. The mix of the order placement, plus the security implemented by a Web service endpoint, leveraged message-level composability. In other words, the SOAP message is composed of an order placement request, plus the appropriate security headers, encryption and digital signatures.
314 315 316 317
The implementer of a manageable resource may create an appropriate composition of aspects and capabilities offered to a manageability consumer via one or more Web service endpoints. Within the context of WSDM, there are two kinds of composition that can manifest in an implementation of a manageable resource, as follows:
318 319 320 321
1. Composition of aspects of a Web services implementation – for example, messaging, description, discovery, security, asynchronous notifications, etc. These implementation aspects are provided by the Web services platform and the respective standards specifications (see section 3).
322 323
2. Composition of manageability capabilities, which may be classified into one of two categories, as follows:
324 325 326 327 328 329 330
a. Composition of common manageability capabilities – for example, the ability to identify manageable resources, the ability to report and notify on a change of resource availability, or, the ability to report on how resources are related to each other. Such common manageability capabilities are defined in this specification in section 5 and in [MUWS Part 2]. Essentially these are base-line enablers of a richer set of resource manageability. This is similar to how SOAP and HTTP may be considered baseline enablers of Web services. wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 9 of 31
331 332 333 334 335 336
b. Composition of resource-specific manageability capabilities – for example, an ability to manage printers, or, an ability to manage network-connected devices. Other specifications define these manageability capabilities based on the available resource management model, (e.g. DMTF CIM), based on the needs of the management applications, based on the abilities of the resource (e.g. WSDM MOWS), or based on the needs of the management application.
337 338
The whole composition as implemented by a manageable resource is then accessible via a Web service endpoint. This is illustrated in Figure 3.
339
340 341
Figure 3: Composability
342 343
2.2.1 Low-end to High-end Manageability
344 345 346 347 348 349 350 351 352 353
The WSDM architecture provides appropriate coverage from low-end manageability of small devices like mobile phones, to high-end manageability of very capable components like application servers and business processes. This range of coverage is achieved by the low barrier to entry placed upon a WSDM implementation: there are few normative requirements made by this specification and the specifications it depends on. Also, composability allows for additional manageability capabilities to be gradually introduced, based upon the availability of management functions and processing power within an implementation of a manageable resource. Manageability consumers can discover and make use of composed capabilities as these capabilities become available. This flexibility is built into the foundation of the WSDM architecture (Figure 4).
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 10 of 31
354 355
Figure 4: Low-end to High-end Manageability
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 11 of 31
356
3 Usage of the Web Services Platform
357 358 359 360 361 362
As described in section 2, the foundation for MUWS is provided by the Web services platform. A number of Web services specifications may be composed with the WSDM specifications when implementing a manageability endpoint for a manageable resource. This and dependent specifications are used to represent different aspects of a capability: the properties, the operations, metadata, and events. [MUWS Part 2] introduces additional Web services specifications to define an interoperable way to represent these capability aspects.
363
3.1 Properties
364 365 366
MUWS uses XML Schema ([XML Schema Part 1], [XML Schema Part 2]) to describe properties. A MUWS property is represented by a Global Element Declaration (GED). In order to create a property one MUST provide:
367
•
the schema for the property,
368
•
a description (in some form) of the semantics of the property,
369
•
the cardinality of the property,
370
•
any relevant metadata for the property.
371 372 373
A manageable resource MUST expose an XML document containing, as top-level elements, all the properties of the manageable resource. This document is called the resource properties document for the resource.
374
3.2 Operations
375 376 377
MUWS uses [WSDL] to describe operations. The “operations” component of a capability corresponds to an operation, as defined by WSDL. In order to create an operation one MUST provide:
378
•
a WSDL portType containing a WSDL operation corresponding to the operation,
379
•
a description (in some form) of the semantics of the operation,
380 381
•
a WS-Addressing:Action attribute, during the input, output or fault phases that corresponds to a WSA formatted URI,
382
•
any relevant metadata for the operation.
383
3.3 Events
384 385 386 387 388 389 390 391
Event types (as opposed to instances of event messages) are defined in MUWS by providing the combination of a “topic” QName and a “message content” Global Element Declaration. The “topic” QName need not be the QName of the “message content” element. A “topic” or a “message content” element need not be exclusive to one event. However, the combination of a “topic” and a “message content” element MUST uniquely identify an event. The “message content” element represents information that is transmitted as part of a notification message and corresponds to an event instance. The “topic” provides information about why the event was generated. In order to create a new event, one MUST provide:
392
•
the corresponding “topic” and ”message content” element,
393 394
•
a description (in some form) of the semantics for the “topic” and ”message content” element,
395
•
any relevant metadata for the event.
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 12 of 31
396 397
A manageability endpoint SHOULD offer one or more events that correspond to a change in the properties it supports.
398
3.4 Metadata
399 400 401 402 403 404 405 406
MUWS allows definition of metadata on properties and operations. One such metadata item on properties is whether it is Mutable. Mutability is defined as an indication of whether the value of a property can change over time. Another metadata item on a property is whether it is Modifiable. Modifiability is defined as an indication of whether the value of a property can be set explicitly, as opposed to can not be set at all, or, can be set only as a side-effect of setting some other property. Finally, a Capability is a metadata item that can be attached to a property, an operation or an event. This metadata item contains a unique identifier for the capability. [MUWS Part 2] describes additional metadata items.
407 408 409 410 411
For each property introduced in this specification, the value of these metadata items is described. However, MUWS does not specify if, or how, the value is made available to a consumer. A few properties contain actual metadata about a given manageable resource. For example, the ManageabilityCapability capability property as defined in section 5.2.2 Properties is one such metadata property.
412
3.5 Addressing
413 414 415 416
MUWS makes use of the endpoint reference (EPR) construct, as defined in [WS-Addressing]. In addition, MUWS-compliant messages MUST comply with the rules in [WS-Addressing] regarding the use of SOAP headers, and, regarding how the content of the EPR constrains the messages sent to the endpoint.
417
3.6 Security
418 419
When evaluating the security requirements for resource management, it is important to delineate several aspects of Security technology;
420 421 422 423 424 425 426 427 428
• • • • • • •
Identification: Presentation of a claimed identity Authentication: Verification of proof of asserted identity Authorization: The information and mechanisms to allow appropriate authorized requests to resources and deny unauthorized requests. Message Integrity: The protection of messages in a message exchange from unauthorized modification. Data Integrity: The protection of data from unauthorized modification. Data confidentiality Trust
429 430 431
A complete security model addressing the requirements listed above needs to be provided for any management deployment. Profiles for different sets of requirements will be needed to ensure interoperable deployments.
432 433
An explicit mapping to an authorization model at deployment time should be provided by a conformant management application.
434 435 436 437 438 439 440
To address security of messages, MUWS relies on generic Web services security mechanisms, including transport-level security (e.g. HTTP over SSL), OASIS Web Services Security messagelevel security [WSS, etc. The composition of appropriate security specifications and this specification provides a model for securing the messages exchanged during management using Web services realized by manageability endpoint implementations. The choice of concrete security mechanisms should be carried out by the implementers of the manageability endpoints and may conform to some profile.
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 13 of 31
441 442 443
Within an enterprise MUWS can be deployed like any other specification into the existing enterprise security model. When managing between enterprises, security will need to be developed in an ad hoc, pair-wise fashion at a messaging level.
444 445 446 447 448 449
This specification defines some metadata items for management. Whenever information related to management metadata is being relied on, it is important to understand the environment in which the metadata is being asserted. It may be needed to provide some data integrity mechanisms to protect the information from unauthorized modification. It may also be needed to implement a set of authorization mechanisms to provide a way of identifying under what conditions information should be shared.
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 14 of 31
450
4 Common Information Items
451
4.1 WSDM Event Format
452 453 454 455 456
The WSDM Event Format defines an XML format to carry management event information. The format defines a set of basic, consistent data elements that allow different types of management event information to be carried in a consistent manner. The WSDM Event Format provides a basis for programmatic processing, correlation, and interpretation of events from different products, platforms, and management technologies.
457 458 459 460
The WSDM Event Format organizes management event data into three basic categories, the event reporter, the event source, and extensible, event-specific, situation data. Each category contains a few common properties, as found in most management events, and allows for extensible, event-specific data. The WSDM Event Format has a flexible and extensible syntax..
461
To be effective, the WSDM Event Format MUST provide the following essential information:
462
•
the identification of the resource experiencing an event, called the source,
463 464
•
the identification of the reporter of an event, known as the reporter. In most cases the source reports its own event, thus the identity of the reporter and the source is the same.
465
Typically, further information is also needed to describe the semantics of an event.
466 467 468 469 470
Additionally, an event MUST contain an EventId that is unique across event types within the source. An event may contain additional information related to the situation that has occurred or to the context within which it occurred. For example, message text, severity information or related Application Response Measurement (ARM) instrumentation information. It is RECOMMENDED that a container be used to encapsulate additional information that is significant to an event.
471 472
The base element of the WSDM Event Format is muws1:ManagementEvent, as presented in the next section.
473
4.1.1 XML Representation of the event
474
The following is the XML representation of the WSDM MUWS management event container.
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
<muws1:ManagementEvent ... muws1:ReportTime=”xs:dateTime”?>
493
Where the clauses are described as follows:
494
muws1:ManagementEvent: The wrapper element used for management event messages.
<muws1:EventId>xs:anyURI</muws1:EventId> <muws1:SourceComponent ...> <muws1:ResourceId>xs:anyURI</muws1:ResourceId> ? <muws1:ComponentAddress>{any}</muws1:ComponentAddress> * {any}* </muws1:SourceComponent> <muws1:ReporterComponent ...> <muws1:ResourceID>xs:anyURI</muws1:ResourceId> ? <muws1:ComponentAddress>{any}</muws1:ComponentAddress> * {any}* </muws1:ReporterComponent> ? {any}* </muws1:ManagementEvent>
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 15 of 31
495 496 497 498 499
muws1:ManagementEvent/@muws1:ReportTime: The date and time when the event was reported. If the value does not include a time zone designation, or use ‘Z’ for UTC, then the value MUST be interpreted as having a time zone of UTC. The value of ReportTime MUST provide a granularity as precise as is supported by the generating platform. This attribute is RECOMMENDED.
500 501 502 503 504
muws1:ManagementEvent/muws1:EventId: The primary identifier for an event. This element MUST be unique within the scope provided by the manageability implementation for the source resource. This element MAY be used as the primary key for the event. This element is provided for management functions that require events to have an identifier. It is of type URI and is REQUIRED.
505 506
muws1:ManagementEvent/muws1:SourceComponent: The identification of, or reference to, the source associated with an event. This element is REQUIRED.
507 508 509 510 511 512
muws1:ManagementEvent/muws1:SourceComponent/ResourceId: A specification of an identifier of a manageable resource associated with an event. This is an OPTIONAL property. This property is intended as an identifier to be used, for example, in correlation, so that management consumers can ensure that information contained in the muws1:ManagementEvent pertains to a given manageable resource. If provided, this element MUST correspond to the muws1:ResourceId property (defined in section 5.1.2) for the source associated with an event.
513 514 515 516
muws1:ManagementEvent/muws1:SourceComponent/muws1:ComponentAddress: Contains the specific elements used to identify the address of a component. If this element contains more than one child element, each child element represents an alternate address of the same source. This element is RECOMMENDED to improve interoperability.
517 518 519 520 521 522
muws1:ManagementEvent/muws1:SourceComponent/muws1:ComponentAddress/{any}: XML open content including any XML representation of the component address. One commonly used address type is a Web service address, such as an EPR as defined by [WS-Addressing]. In the case where the source is a manageable resource, it is RECOMMENDED that the muws1:ManageabilityEndpointReference element, as defined in section 4.2, be used as the address type.
523 524 525 526 527 528
muws1:ManagementEvent/muws1:ReporterComponent: Provides the identification of, or reference to, the reporter associated with an event. This is a REQUIRED property only if the reporter is different from the source. Otherwise, this element is OPTIONAL. When this element is absent the reporter is asserted to be the same as the source. The content of this element is the same as the content of the ManagementEvent/SourceComponent element except that the definitions apply to the reporter rather than the source.
529 530 531 532
muws1:ManagementEvent/{any}: Provides a container for additional data associated with an event. This is where the “message content” Global Element Declaration introduced in section 3.3 is inserted. MUWS Part 2 defines some additional element that could be included using this wildcard.
533
4.2 Manageability Endpoint Reference
534
MUWS defines the following element to represent a reference to a manageability endpoint:
535 536 537
<muws1:ManageabilityEndpointReference> wsa:EndpointReferenceType </muws1:ManageabilityEndpointReference>
538 539
The element is an EPR as defined by [WS-Addressing]. The EPR provides a reference to a manageability endpoint.
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 16 of 31
540
5 Capabilities
541 542
There is a minimum set of manageability capabilities that an implementation of a manageability endpoint must support in order to comply with the MUWS specification.
543 544
A manageability capability defines properties, operations and events to support domain-specific tasks. Details of a manageability capability are exposed by a manageable resource.
545
A manageable resource MAY also define a new resource-specific manageability capability.
546 547 548 549
A manageable resource SHOULD extend a MUWS manageability capability with a resourcespecific manageability capability that uses similar semantics. A manageable resource is not required to extend a MUWS manageability capability when a resource-specific manageability capability uses different semantics than the set of MUWS manageability capabilities.
550 551
In this section the following namespaces are used unless otherwise specified. The table below lists each prefix and a corresponding namespace URI. Prefix
Namespace
muws1
http://docs.oasis-open.org/wsdm/muws1-2.xsd
pbm
http://docs.oasis-open.org/wsdm/muws/
xs
http://www.w3.org/TR/xmlschema-1/
wsa
http://www.w3.org/2005/08/addressing
552
5.1 Identity
553 554
The manageability capability URI for the Identity capability is http://docs.oasis-open.org/wsdm/muws/capabilities/Identity
555
5.1.1 Definition
556 557 558 559
The goal of the Identity capability is to establish whether two entities are the same. This is a required capability and it MUST be provided by every manageability endpoint. Observe that this requirement does not preclude the manageability endpoint from applying a security policy preventing some requesters from accessing this, or another, capability.
560 561
In addition, this capability is used as a “marker” interface enabling a manageability consumer to learn if an endpoint is a manageability endpoint.
562
5.1.2 Properties
563
The following is the specification of the property defined by the Identity capability.
564
<muws1:ResourceId>xs:anyURI</muws1:ResourceId>
565
The following is an example property instance for the property defined by the Identity capability.
566 567 568
<muws1:ResourceId> http://example.com/resource/diskDrive/9F34AD35B </muws1:ResourceId>
569 570
Note that ResourceId is an opaque identifier of a resource managed through a manageability endpoint. ResourceId is a read-only, mandatory property with a cardinality of 1.
571
This property has the following metadata: wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 17 of 31
572 573 574
It is not Mutable. It is not Modifiable. Its Capability is “http://docs.oasis-open.org/wsdm/muws/capabilities/Identity”.
575
The following constraints are applicable to ResourceId:
576 577 578 579
•
Globally unique: A manageability endpoint MUST create the ResourceId URI in a way that ensures that the ResourceId is unique to the resource managed through the manageability endpoint and globally unique. This specification does not prescribe the means by which global uniqueness is achieved.
580 581 582
•
Uniqueness in time: A ResourceId MUST NOT be reused by the implementation of a manageability endpoint for another resource, even after the original resource no longer exists.
583 584 585 586 587 588 589
•
Consistency across endpoints: An implementation of a manageability endpoint SHOULD use a ResourceId that is suggested by the characteristics of a resource. This is possible when, for example, a ResourceId is retrievable from a resource by a manageability endpoint, or, an application of MUWS to a given domain specifies a method for building a ResourceId based upon characteristics of resources populating the domain. It is not guaranteed that different manageability endpoints associated with the same resource will, in all cases, return the same ResourceId.
590 591 592
•
Consistency within an endpoint: An implementation that exposes several manageability endpoints for the same resource MUST report the same ResourceId at each manageability endpoint.
593 594 595 596 597
•
Persistence: A manageability endpoint SHOULD return the same ResourceId during the entire lifetime of the manageability endpoint, including across power cycles of the manageability endpoint. Resources that are not able to persist a ResourceId across power cycles of a manageability endpoint SHOULD try to provide a consistent ResourceId via predictable identifier generation or delegation of identity assignment.
598 599 600 601 602 603 604 605
•
Equality: If two reported ResourceIds are equal, then the consumer knows that the two manageability endpoints represent the same resource. The converse proposition is not necessarily true: two different ResourceIds could conceivably correspond to the same resource. It is strongly RECOMMENDED that this condition be avoided in a conscious and deliberate manner, as some managers may not be able to distinguish that two different reported identifiers are, in fact, associated with the same manageable resource. Thus, manageability consumers would be forced to treat every identifier as corresponding to a unique manageable resource.
606 607
Note that a manageability consumer SHOULD NOT assume that two manageability endpoints represent two different resources solely because the two reported ResourceIds are different.
608 609 610 611 612
Since the ResourceId is defined as opaque, this specification does not allow a consumer to infer any characteristic of a resource by examining a ResourceId, other than comparing the ResourceId to another ResourceId as one way of establishing oneness. For example, one possible way to construct a ResourceId and ensure its uniqueness is to use a UUID wrapped in a URI.
613 614 615
Note that this specification does not define equivalence of URIs and the consumer should decide which level of the comparison ladder, as defined in section 6 of [RFC2396bis], is appropriate to use for this comparison.
616 617
MUWS defines an additional mechanism for establishing oneness of two resources. This mechanism, called Correlatable Properties is defined in the section 5.3.
618
5.2 Manageability Characteristics
619 620
The manageability capability URI for the Manageability Characteristics capability is http://docs.oasis-open.org/wsdm/muws/capabilities/ManageabilityCharacteristics wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 18 of 31
621
5.2.1 Definition
622 623
The Manageability Characteristics capability defines properties providing information about the characteristics of a manageability endpoint implementation rather than the resource.
624
5.2.2 Properties
625 626
The following is the specification of the property defined by the Manageability Characteristics capability.
627 628 629
<muws1:ManageabilityCapability> xs:anyURI </muws1:ManageabilityCapability>*
630 631
The following are example of property instances for the property defined by the Manageability Characteristics capability.
632 633 634 635 636 637
<muws1:ManageabilityCapability> http://docs.oasis-open.org/wsdm/muws/capabilities/Identity </muws1:ManageabilityCapability> <muws1:ManageabilityCapability> http://example.com/capabilities/FooCapability </muws1:ManageabilityCapability>
638 639 640 641
Note that ManageabilityCapability contains a URI identifying a manageability capability that is supported by a manageable resource. The ManageabilityCapability property is considered to be a metadata property of the MUWS specification. The cardinality of this property is zero to unbounded.
642
This property has the following metadata:
643 644 645 646
It is not Mutable. It is not Modifiable. Its Capability is “http://docs.oasisopen.org/wsdm/muws/capabilities/ManageabilityCharacteristics”.
647 648 649 650
A manageability interface is said to provide a capability if it supports all of the required properties, events, operations and metadata defined by the capability. This does not preclude the manageability endpoint from applying a security policy preventing some requesters from accessing this, or another, capability.
651 652 653 654 655 656 657
There SHOULD be one ManageabilityCapability property instance for each manageability capability provided by a manageability interface. For capabilities extending a base capability, both the extension and the base capability MUST be listed. Marking a property, operation or event as part of a capability is considered a hint for the consumer of a manageability endpoint. The meaning of such a hint is defined by the capability. As a result, the ManageabilityCapability property facilitates discovery and introspection by providing a hint to the manageability consumer about what requests can be sent to the manageability endpoint.
658
5.3 Correlatable Properties
659 660
The manageability capability URI for the Correlatable Properties capability is http://docs.oasis-open.org/wsdm/muws/capabilities/CorrelatableProperties
661
5.3.1 Definition
662 663 664 665 666
The Correlatable Properties capability allows a manageability endpoint to expose its understanding of which property values could be compared when establishing that the manageability endpoint in question and another manageability endpoint correspond to the same resource. This is especially useful in the case where the two manageability endpoints are unable to return the same ResourceId for a resource. For example, one manageability endpoint may wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 19 of 31
667 668 669 670 671 672 673 674 675 676
enable a temperature control capability for a SCSI hard disk drive, and another manageability endpoint may enable a capacity management capability for the same SCSI hard disk drive. Each manageability endpoint may return its own unique ResourceId due to implementation requirements or constraints (e.g. firmware). However, implementers of a manageability endpoint may be aware of some unique resource-specific property values that can indicate if two manageability endpoints correspond to the same resource. In the SCSI example, correlatable properties could be host IP, bus #, channel #, SCSI ID, LUN ID. If the values of those property instances match, then one could be fairly certain that multiple manageability paths are provided to the same SCSI resource. The CorrelatableProperties capability is a property that is considered to be metadata.
677 678 679 680
Using the CorrelatableProperties capability, both manageability endpoints may expose their understanding of what resource property values need to match in order to establish a correlation between manageable resources. The manageability consumer uses this information to evaluate and establish such a correlation.
681 682 683 684 685
Note that if the ResourceIds returned by both manageability endpoints are the same but the correlatable properties do not match, then the resources should be considered the same, as the Identity capability takes precedence over Correlatable Properties capability. Typically, manageability consumers will not evaluate correlatable properties if the two manageability endpoints return the same ResourceId.
686 687 688 689 690 691
The exposure of the information provided as part of this capability allows clients to understand the information used to uniquely identify the resource. This may allow a nefarious client to spoof the presence of the resource. This is particularly true if it is obvious how to generate or construct the ResourceId from these properties. These properties should be used and exposed with this risk in mind. The CorrelateableProperties property should receive the same level of protection as the ResourceID.
692
5.3.2 Information Markup Declarations
693 694 695 696 697
There are three elements, as defined by this specification, providing a simple property boolean match (PBM) dialect that can be used to express a correlation condition for correlatable properties. This condition is expressed based on values of properties of the two resources that are compared through the correlatable properties mechanism. These elements are defined in a separate namespace, from the rest of the MUWS specification, as follows:
698
<pbm:Match>xs:QName</pbm:Match>
699 700
This element evaluates to true if the values of the properties for the given QName match for the two resources.
701
<pbm:MatchAny>(<pbm:Match/>|<pbm:MatchAll>)*</pbm:MatchAny>
702 703
This element evaluates to true if any of the enclosed Match and/or MatchAll conditions evaluate to true.
704
<pbm:MatchAll>(<pbm:Match/>|</pbm:MatchAny>)*</pbm:MatchAll>
705 706
This element evaluates to true if all of the enclosed Match and/or MatchAny conditions evaluate to true.
707
5.3.3 Properties
708
The following is a definition of the property defined by the Correlatable Properties capability.
709 710 711 712 713
<muws1:CorrelatableProperties Dialect="xs:anyURI" NegativeAssertionPossible=”xs:boolean”?> {any} * </muws1:CorrelatableProperties>* wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 20 of 31
714 715 716
This property indicates, from the perspective of the manageability representation, which property values, conditions and expressions are used to correlate a manageable resource. The cardinality of the property is zero to unbounded.
717
This property has the following metadata:
718 719 720
It is Mutable. It is not Modifiable. Its Capability is “http://docs.oasis-open.org/wsdm/muws/capabilities/CorrelatableProperties”.
721 722 723 724 725 726 727
The value of this property is the correlation expression. The format of the correlation expression is determined by the Dialect attribute. This specification defines three possible dialect values. An additional dialect value can be defined to provide additional functionality. A manageability representation can offer several instances of the muws1:CorrelatableProperties property, using the same, or different, dialects. A manageability consumer may evaluate a muws1: CorrelatableProperties property in any dialect that it understands. Support for a particular dialect is optional.
728
The dialects defined by this specification are:
729 730 731 732 733
•
Simple Property Boolean Match The URI for this dialect is http://docs.oasis-open.org/wsdm/pbm. The content of the property is as described in section 5.3.2. If all top-level match conditions evaluate to true, then a correlation between manageable resources is established.
734 735 736 737 738 739 740
•
XPath 1.0 The URI for this dialect is http://www.w3.org/TR/1999/REC-xpath-19991116. The content of the property is an [XPath 1.0] expression. When retrieved as a property form a manageable resource, the XPath expression is evaluated on properties of another manageability resource. If the XPath expression evaluates to a Boolean value of true, or if it evaluates to a non-empty, non-boolean value, without any errors, then a correlation is established between the manageable resources.
741 742 743 744 745 746 747
•
XPath 2.0 The URI for this dialect is http://www.w3.org/TR/xpath20/. The content of the property is an [XPath 2.0] expression. This XPath expression is evaluated on a resource properties document of another manageability representation. If the XPath expression evaluates to a Boolean value of true, or if it evaluates to a nonempty, non-boolean value, without any errors, then a correlation is established between the manageable resources.
748 749 750
The optional NegativeAssertionPossible attributes express whether a negative result from the evaluation of the correlation expression implies that the resources are necessarily different. The default value is false.
751 752 753 754 755 756
•
If NegativeAssertionPossible is false, only a positive match is meaningful to the consumer. In other words, if the correlation expression evaluates successfully, according to the evaluation rules defined by the dialect, then a consumer can consider the resource representations to represent the same resource. If the correlation expression does not evaluate successfully, then the consumer can not infer whether the resource representations represent different resources.
757 758 759
•
If NegativeAssertionPossible is true, a positive match still means that the resources are the same. But a negative match now means that the resources are guaranteed to NOT be the same.
760
5.3.3.1 Examples of use
761 762
Consider the following two simplified sets of properties, obtained through two different manageability endpoints:
763
Properties obtained through manageability endpoint ME1: wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 21 of 31
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
<print:PrinterResourcePropDoc> ... <print:PrinterModel>PrintCo SuperJet 5000</print:PrinterModel> <print:Location>Building 42 lower pillar D4</print:Location> <print:Owner>Sir Printalot</print:Owner> <print:IPAddress>15.244.62.41</print:IPAddress> <foo:Name>Baby got ink</foo:Name> <muws1:CorrelatableProperties Dialect=”http://docs.oasis-open.org/wsdm/pbm”> <pbm:MatchAny> <pbm:Match>print:IPAddress</pbm:Match> <pbm:MatchAll> <pbm:Match>foo:Name</pbm:Match> <pbm:Match>print:PrinterModel</pbm:Match> <pbm:Match>print:Location</pbm:Match> <pbm:Match>print:Owner</pbm:Match> </pbm:MatchAll> </pbm:MatchAny> </muw-p1-xs:CorreletableProperties> </print:PrinterResourcePropDoc>
784
Properties obtained through manageability endpoint ME2:
785 786 787 788 789 790 791 792
<print:PrinterResourcePropDoc> ... <print:PrinterModel>PrintCo UltraJet 40</print:PrinterModel> <print:Location>Building 42 lower pillar D4</print:Location> <print:Owner>Sir Printalot</print:Owner> <print:IPAddress>15.244.10.89</print:IPAddress> <foo:Name>Baby got ink</foo:Name> </print:PrinterResourcePropDoc>
793 794 795 796 797 798
The CorrelatableProperties property, as provided through manageability endpoint ME1, asserts that if a manageability representation provides a view of a resource which either has the same IPAddress as ME1, or, has the same Name, PrinterModel, Location, and Owner as ME1, then these two manageability endpoints represent are the same printer. In this example, since the IPAddress doesn’t match and the PrinterModel is different, the correlation is not established and the consumer cannot deduce that the two printers are the same.
799 800 801 802
Note that since the NegativeAssertionPossible attribute is not specified on CorrelatableProperties it takes the default value of false. Therefore, the consumer cannot assume that the resources are indeed two different printers. At this point, the consumer still cannot infer whether the two manageability endpoints correspond to the same printer or not.
803
Properties obtained through manageability endpoint ME3:
804 805 806 807 808 809 810 811 812 813 814
<print:PrinterResourcePropDoc> ... <muws1:CorrelatableProperties Dialect=http://www.w3.org/TR/1999/REC-xpath-19991116 NegativeAssertionPossible=”false”> boolean(/print:PrinterResourcePropDoc/print:LastJob/print:JobID="5622654845 1262") and boolean(/print:PrinterResourcePropDoc/print:LastJob/print:JobOriginator="15 .244.30.30") </muw-p1-xs:CorrelatableProperties> </print:PrinterResourcePropDoc>
815
Properties obtained through manageability endpoint ME4:
816 817 818
<print:PrinterResourcePropDoc> ... <print:LastJob> wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 22 of 31
819 820 821 822 823
<print:JobID>56226548451262</print:JobID> <print:JobOriginator>15.244.30.30</print:JobOriginator> <print:JobDate>2004-03-11T11:30:56Z</print:JobDate> </print:LastJob> </print:PrinterResourcePropDoc>
824 825 826 827 828 829 830 831 832 833
The CorrelatableProperties property, as provided through manageability endpoint ME3, asserts that if a manageability endpoint provides a view of a resource for which the JobID of the last job is 56226548451262, and the JobOriginator of the last job is 15.244.30.30, then these manageability endpoints represent the same printer. In this example, the condition is satisfied, so the consumer knows that ME3 and ME4 correspond to the same physical printer. Note that, as the example shows, with this dialect the consumer only needs to retrieve the CorrelatableProperties property and no other property from ME3 to check correlation. From ME4 it needs to retrieve the properties needed to evaluate the XPath expression. In this example, NegativeAssertionPossible is set to false, thus a negative result would not have guaranteed that the printers behind ME3 and ME4 are indeed different.
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 23 of 31
834
6 Defining a Manageability Capability
835 836 837 838 839 840
Implementers of manageability endpoints are free to expose additional manageability capabilities as properties beyond those defined in MUWS. The properties defined in a new capability must be defined as XML Schema Global Element Declarations. The operations defined in a new capability are represented as WSDL 1.1 operations. Furthermore, a manageability endpoint offering a new capability is free to ignore all standard manageability capabilities defined by MUWS except for the Identity capability. The MUWS Identity capability is REQUIRED.
841 842
MUWS-compliant manageability endpoints SHOULD also comply with the WS-I Basic Profile version 1.1 [BP].
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 24 of 31
843
7 References
844
7.1 Normative
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
rd
[XML1.0 3 Edition] Tim Bray, et al., Extensible Markup Language (XML) 1.0 (Third Edition), W3C Recommendation, February 2004, http://www.w3.org/TR/REC-xml [XML Schema Part 1] Henry S. Thompson, et al. XML Schema Part 1: Structures, W3C Recommendation, May 2001, http://www.w3.org/TR/xmlschema-1/ [XML Schema Part 2] Paul V. Biron, et al. XML Schema Part 2: Datatypes, W3C Recommendation, May 2001, http://www.w3.org/TR/xmlschema-2/ [XNS]
Tim Bray, et al., Extensible Namespaces in XML, W3C Recommendation, January 1999, http://www.w3.org/TR/REC-xmlnames/
[WSDL]
Erik Christensen, et al., Web services Description Language (WSDL) 1.1, W3C Note, March 2001, http://www.w3.org/TR/wsdl
[WS-Addressing] Don Box, et al., Web services Addressing (WS-Addressing), W3C Member Submission, August 2004, http://www.w3.org/TR/ws-addr-core [RFC2119]
S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.
[RFC2396bis]
T. Berners-Lee, et al., Uniform Resource Identifier (URI): Generic Syntax, IETF RFC 2396bis-04, February 2004, http://www.ietf.org/internet-drafts/draft-fielding-uri-rfc2396bis-04.txt
7.2 Non-normative [MOWS]
Kirk Wilson, Web Services Distributed Management:Management of Web Services (WSDM-MOWS) 1.1, OASIS Committee Draft, February 2006, http://docs.oasis-open.org/wsdm/wsdm-mows-1.1-spec-os-01.pdf
[MUWS Part 2]
Vaughn Bullard, Web Services Distributed Management: Management using Web Services (MUWS 1.1) Part 2, OASIS Committee Draft, March 2006, http://docs.oasis-open.org/wsdm/wsdm-muws2-1.1-spec-os-01.pdf
[MUWS REQS]
Pankaj Kumar, et al., Requirements – Management Using Web Services, Committee Draft, October 2003, http://www.oasisopen.org/apps/org/workgroup/wsdm/download.php/6185/WSDM-MUWSReq-committee-draft-1.0-20031002.pdf
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 25 of 31
887 888 889 890 891 892 893 894 895 896 897 898 899 900
[SOAP]
Don Box, et al., Simple Object Access Protocol (SOAP) 1.1, W3C Note, May 2000, http://www.w3.org/TR/2000/NOTE-SOAP-20000508/
[WSA]
David Booth, et al. Web Services Architecture, W3C Working Group Note, February 2004, http://www.w3.org/TR/2004/NOTE-ws-arch20040211/
[WSS]
Anthony Nadalin, et al. Web Services Security: SOAP Message Security 1.0, OASIS Standard, March 2004, http://docs.oasisopen.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf
[BP]
Keith Ballinger, et al. Basic Profile Version 1.1, WS-I Final Material, August 2004, http://www.ws-i.org/Profiles/BasicProfile-1.1-2004-0824.html
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 26 of 31
901
Appendix A. Acknowledgements
902
WSDM Management Using Web Services Part 1 Version 1.0 Acknowledgements
903 904
The following individuals were members of the committee when the WSDM MUWS Version 1.0 was approved by the technical committee
905 906 907 908 909 910
Guru Bhat, Jeff Bohren, Winston Bumpus, Nick Butler, Brian Carroll, Fred Carter, Michael Clements, David Cox, John DeCarlo, Andreas Dharmawan, Mark Ellison, John Fuller, Paul Lipton, Heather Kreger, Hal Lockhart, Frederico Maciel, Tom Maguire, Bryan Murray, Richard Nikula, Mark Peel, Richard Pelavin, Homayoun Pourheidari, Warren Roberts, Karl Schopmeyer, Igor Sedukhin, David Snelling, Thomas Studwell, William Vambenepe, Andrea Westerinen, Jim Willits, Zhili Zhang.
911 912
In addition, the following non-member employees of member companies made contribution to the specification: Maryann Hondo, Ian Springer, John Gerken, David Melgar, Mitsunori Satomi.
913 914
WSDM Management Using Web Services Part 1 Version 1.1 Acknowledgements
915 916 917 918
The following people made contributions to the WSDM MUWS Version 1.1 specification: Vaughn Bullard, Fred Carter, David Cox, Zulah Eckert, Mark Ellison, Heather Kreger, Frederico Maciel, Bryan Murray, Richard Nikula, Mitsunori Satomi, Thomas Studwell, Kirk Wilson, Zhili Zhang with special thanks to Vaughn Bullard and Mark Ellison as editors.
919 920 921 922 923 924
The following individuals were members of the committee while the WSDM MUWS Version 1.1 specification was developed and approved by the technical committee: Guru Bhat, Jeff Bohren, Vaughn Bullard, Winston Bumpus, Fred Carter, Michael Clements, David Cox, Zulah Eckert, Mark Ellison, John Fuller, Tony Gullato, Heather Kreger, Richard Landau, Frederico Maciel, Tom Maguire, David Melgar, Bryan Murray, Richard Nikula, Mark Peel, Mitsunori Satomi, Thomas Studwell, William Vambenepe, Kirk Wilson, Zhili Zhang.
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 27 of 31
925
Appendix B. Notices
926 927 928 929 930 931 932 933 934
OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification, can be obtained from the OASIS Executive Director.
935 936 937
OASIS invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to implement this specification. Please address the information to the OASIS Executive Director.
938
Copyright © OASIS Open 2003-2006. All Rights Reserved.
939 940 941 942 943 944 945 946 947
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself does not be modified in any way, such as by removing the copyright notice or references to OASIS, except as needed for the purpose of developing OASIS specifications, in which case the procedures for copyrights defined in the OASIS Intellectual Property Rights document must be followed, or as required to translate it into languages other than English.
948 949
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
950 951 952 953 954
This document and the information contained herein is provided on an “AS IS” basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 28 of 31
955
Appendix C. MUWS Part 1 Schema (Normative)
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
<?xml version="1.0" encoding="utf-8"?> <xs:schema xmlns:muws1="http://docs.oasis-open.org/wsdm/muws1-2.xsd" xmlns:wsa="http://www.w3.org/2005/08/addressing" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://docs.oasisopen.org/wsdm/muws1-2.xsd" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:import namespace="http://www.w3.org/2005/08/addressing" schemaLocation="http://www.w3.org/2005/08/addressing/ws-addr.xsd"/> <xs:element name="ResourceId" type="xs:anyURI"/> <xs:element name="ManageabilityCapability" type="xs:anyURI"/> <xs:complexType name="CorrelatablePropertiesType"> <xs:sequence> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="Dialect" type="xs:anyURI"/> <xs:attribute name="NegativeAssertionPossible" type="xs:boolean"/> <xs:anyAttribute namespace="##other"/> </xs:complexType> <xs:element name="CorrelatableProperties" type="muws1:CorrelatablePropertiesType"/> <xs:complexType name="ComponentAddressType"> <xs:sequence> <xs:any namespace="##any" processContents="lax"/> </xs:sequence> </xs:complexType> <xs:complexType name="ComponentType"> <xs:sequence> <xs:element name="ResourceId" type="xs:anyURI" minOccurs="0"/> <xs:element name="ComponentAddress" type="muws1:ComponentAddressType" minOccurs="0" maxOccurs="unbounded"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:anyAttribute namespace="##other"/> </xs:complexType> <xs:complexType name="ManagementEventType"> <xs:sequence> <xs:element name="EventId" type="xs:anyURI"/> <xs:element name="SourceComponent" type="muws1:ComponentType"/> <xs:element name="ReporterComponent" type="muws1:ComponentType" minOccurs="0"/> <xs:any namespace="##other" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> <xs:attribute name="ReportTime" type="xs:dateTime" use="optional"/> <xs:anyAttribute namespace="##other"/> </xs:complexType> <xs:element name="ManagementEvent" type="muws1:ManagementEventType"/> <xs:element name="ManageabilityEndpointReference" type="wsa:EndpointReferenceType"/> <!-- SCHEMA COPY Material and paste element references below into the schema of a resource properties document references are provide to insure that the correct minOccurs/maxOccurs attributes are specified in a resource property document schema. : You must import the MUWS Part 1 schema namespace (MUWS1). wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 29 of 31
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
**
Identity Properties ** <xs:element ref="muws1:ResourceId"/> ** ManageabilityCharacteristics Properties ** <xs:element ref="muws1:ManageabilityCapability" minOccurs="0" maxOccurs="unbounded"/> ** Correlatable Properties ** <xs:element ref="muws1:CorrelatableProperties" minOccurs="0" maxOccurs="unbounded"/> --> </xs:schema>
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 30 of 31
1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
Appendix D. Properties Boolean Match Schema (Normative) <?xml version="1.0" encoding="utf-8"?> <xs:schema targetNamespace="http://docs.oasis-open.org/wsdm/pbm.xsd" xmlns:pbm="http://docs.oasis-open.org/wsdm/pbm.xsd" xmlns:xs="http://www.w3.org/20XX/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:element name="Match" type="xs:QName"/> <xs:complexType name="MatchAllType"> <xs:choice> <xs:element ref="pbm:Match"/> <xs:element ref="pbm:MatchAny"/> </xs:choice> </xs:complexType> <xs:complexType name="MatchAnyType"> <xs:choice> <xs:element ref="pbm:Match"/> <xs:element ref="pbm:MatchAll"/> </xs:choice> </xs:complexType> <xs:element name="MatchAll" type="pbm:MatchAllType"/> <xs:element name="MatchAny" type="pbm:MatchAnyType"/> </xs:schema>
1058
wsdm-muws1-1.1-spec-os-01 Copyright © OASIS Open 2003-2006. All Rights Reserved.
01 August 2006 Page 31 of 31