Common Management Platform EMC® Common Object Manager (ECOM) Toolkit
2.7.1.0.0

ECOM Deployment and Configuration Guide
300-014-010 REV A01

EMC Corporation Corporate Headquarters: Hopkinton, MA 01748-9103
1-508-435-1000 www.EMC.com

Copyright © 2012 EMC Corporation. All rights reserved. Published March, 2012 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners.

2

ECOM Deployment and Configuration Guide

Contents

Preface.............................................................................................................................. 7 Chapter 1 Overview of CIM and SMI-S
Modeling with CIM and SMI-S....................................................... Structural model overview....................................................... Profiles......................................................................................... MOF ............................................................................................. Interoperability with CIM................................................................ WBEM ......................................................................................... SLP ............................................................................................... CIM intrinsic and extrinsic operations ................................... SMI-S Server (CIMOM) profile ................................................ CQL.............................................................................................. Additional information for modeling ............................................ ECOM supported standards matrix............................................... WS-Management support ........................................................ XML Fragment Support............................................................ 12 12 13 14 15 15 16 18 19 20 21 22 24 32

Chapter 2

Running ECOM
Starting and stopping ECOM.......................................................... Starting ECOM ........................................................................... Accessing the ECOM Administration Web Server ............... Stopping ECOM......................................................................... Checking the installed version of ECOM............................... Running ECOM under a debugger......................................... Reviewing ECOM log files .............................................................. Testing ECOM deployments ........................................................... Checking ECOM response........................................................ 48 48 51 52 53 53 56 60 60

ECOM Deployment and Configuration Guide

3

Contents

Checking SMI-S compliance .................................................... 60

Chapter 3

ECOM Application Security
AAA in ECOM .................................................................................. Authentication ........................................................................... Cookie Support .......................................................................... Authorization ............................................................................. Accounting ................................................................................. General settings................................................................................. FIPS 140 compliance.................................................................. Using the Encrypt command line tool.................................... SSL Setup for Authentication.......................................................... Supplying a client with the ECOM Server Certificate ......... Supplying ECOM with the Client Certificate........................ CST Security Plug-in ........................................................................ Authentication ........................................................................... Authorization for security functions ...................................... 62 62 63 64 66 68 72 74 75 75 75 77 77 78

Chapter 4

ECOM Communication Security
ECOM port security ......................................................................... portRange Parameter ................................................................ I.P. filtering.................................................................................. Securing ECOM communication.................................................... 80 83 84 85

Appendix A

SLP Configuration
Overview .................................................................................... Requirements ............................................................................. Configuration ............................................................................. Testing response......................................................................... 90 90 94 96

Appendix B

ECOM Server Profile Provider
Overview .................................................................................... 98 Requirements ............................................................................. 98 Configuration ............................................................................. 98

Appendix C

ECOM Indication Subscription Provider
Overview .................................................................................. 102 Requirements ........................................................................... 104 Configuration ........................................................................... 104

4

ECOM Deployment and Configuration Guide

Contents

Testing response ....................................................................... 104

Appendix D

ECOM Repository Provider
Overview................................................................................... 106 Requirements............................................................................ 106 Configuration ........................................................................... 106 Testing response ....................................................................... 107

Appendix E

CQL Support
Supported CQL ........................................................................ 110 Known limitations ................................................................... 111

Appendix F

CIM Indication Support
Configuring indications support ........................................... 114 Managing indication subscriptions ....................................... 115 Secure indication delivery ...................................................... 122 Known limitations ................................................................... 122

ECOM Deployment and Configuration Guide

5

Contents

6

ECOM Deployment and Configuration Guide

Preface

The EMC Common Object Manager (ECOM) is a hub of communications and common services for applications based on EMC’s Common Management Platform. This document contains an overview of ECOM, instructions for its deployment and configuration, basic use cases for ECOM, and other related reference material. As part of an effort to improve and enhance the performance and capabilities of its product lines, EMC periodically releases revisions of its hardware and software. Therefore, some functions described in this document may not be supported by all versions of the software or hardware currently in use. For the most up-to-date information on product features, refer to your product release notes. Audience This document is part of the Common Management Platform documentation set, and it is intended for use by EMC developers seeking to create and deploy management applications that rely on ECOM for resource exposure. Readers of this document are expected to be familiar with the following topics:
◆ ◆ ◆ ◆ ◆

Common Information Model (CIM) Web-Based Enterprise Management (WBEM) Storage Management Initiative - Specification (SMI-S) Service Location Protocol (SLP) IP Multicast

.

ECOM Deployment and Configuration Guide

7

Preface

Conventions used in this document

EMC uses the following conventions for special notices.
Note: A note presents information that is important, but not hazard-related.

!

CAUTION A caution contains information essential to avoid data loss or damage to the system or equipment.

!

IMPORTANT An important notice contains information essential to operation of the software. WARNING A warning contains information essential to avoid a hazard that can cause severe personal injury, death, or substantial property damage if you ignore the warning. DANGER A danger notice contains information essential to avoid a hazard that will cause severe personal injury, death, or substantial property damage if you ignore the message. Typographical conventions EMC uses the following type style conventions in this document:
Normal Used in running (nonprocedural) text for: • Names of interface elements (such as names of windows, dialog boxes, buttons, fields, and menus) • Names of resources, attributes, pools, Boolean expressions, buttons, DQL statements, keywords, clauses, environment variables, filenames, functions, utilities • URLs, pathnames, filenames, directory names, computer names, links, groups, service keys, file systems, notifications Used in running (nonprocedural) text for: • Names of commands, daemons, options, programs, processes, services, applications, utilities, kernels, notifications, system call, man pages

Bold:

8

ECOM Deployment and Configuration Guide

Preface

Used in procedures for: • Names of interface elements (such as names of windows, dialog boxes, buttons, fields, and menus) • What user specifically selects, clicks, presses, or types Italic: Used in all text (including procedures) for: • Full titles of publications referenced in text • Emphasis (for example a new term) • Variables Used for: • System output, such as an error message or script • URLs, complete paths, filenames, prompts, and syntax when shown outside of running text Used for: • Specific user input (such as commands) Used in procedures for: • Variables on command line • User input variables Angle brackets enclose parameter or variable values supplied by the user Square brackets enclose optional values Vertical bar indicates alternate selections - the bar means “or” Braces indicate content that you must specify (that is, x or y or z) Ellipses indicate nonessential information omitted from the example

Courier:

Courier bold: Courier italic:

[] | {} ...

Where to get help Support, downloads, and licensing information can be obtained as follows. Product information — For documentation, release notes, software updates, or for information about this and other products and services, go to: http://cmpdistributions.eng.emc.com Technical support — For technical support, go to the forums: http://cmgportal.lss.emc.com/forum/

ECOM Deployment and Configuration Guide

9

Preface

Your comments Your suggestions will help us continue to improve the accuracy, organization, and overall quality of the user publications. Please send your opinion of this document to: scribes-CMG@emc.com

10

ECOM Deployment and Configuration Guide

1
Overview of CIM and SMI-S

Interoperability within an heterogeneous environment can be achieved by ensuring that management applications and service providers hold the same conceptual view of resources within their domain. ECOM supports the EMC Common Information Model (ECIM), which uses an enterprise wide set of models of specific resource and information elements to represent the varied components found within today's diverse IT environments. ECIM is based on the industry-standard Common Information Model (CIM) and also incorporates SMI-S in addition to EMC-specific models and profiles. A knowledge of CIM and SMI-S is therefore necessary to understand the framework within which management applications and service providers interoperate using ECOM. Within this book, a service provider is defined as a managed element that exposes data or functionality to clients on a network for consumption by other service providers or by management applications, which are both grouped in to the category service client or consumer. The following sections provide a basic overview of CIM, SMI-S, and the communication protocols needed to support the model-driven framework of the Common Management Platform, including ECOM.
◆ ◆ ◆ ◆

Modeling with CIM and SMI-S........................................................ Interoperability with CIM................................................................. Additional information for modeling ............................................. ECOM supported standards matrix................................................

12 15 21 22

Overview of CIM and SMI-S

11

Overview of CIM and SMI-S

Modeling with CIM and SMI-S
This section provides a brief overview of the structure, use, and representation of CIM-based models.

Structural model overview

The CIM schema provides a common methodology for representing systems, networks, applications, and services as a set of object-oriented models that can be bound to real-world data and functionality. Management applications based on CIM can interact with heterogeneous resource instances, such as data storage hardware from multiple vendors, without direct knowledge of the underlying system interfaces. CIM defines several basic model structures for IT resources.

Classes

CIM classes identify types of resources. A class can represent a broad category of resources or can be subclassed to represent a specific type. For example, the class CIM_NetworkPort represents a broad category of heterogeneous network communications hardware, while EMC_NetworkPort is a subclass that represents an EMC-specific subset. While classes define types of things found in a managed IT environment, instances represent individual implementations of a class. A specific port at a specific network address is an example of an instance of class EMC_NetworkPort. Classes define the state, behavior, and identity information (called properties) that distinguishes each instance. CIM also defines the operations that can be performed by instances of a class (called methods), linking models to system-specific functionality.

Qualifiers

Many elements in CIM can be further specialized through the use of qualifiers. Qualifiers enhance or apply constraints to associations, classes, indications, methods, method parameters, properties and references by providing additional information that distinguishes them from similar elements and/or their superclasses. For example, qualifiers can be used to make a class property vendor-specific by defining minimum and maximum values for it. as appropriate for the vendor’s modeled resource. An association, which is a class with the association qualifier, defines a relationship between two or more classes. An association contains two or more references that define the classes linked by the

Associations

12

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

association. However, because an association is its own separate class, it does not impact the associated classes themselves. For example, an association could link the classes representing the virtual machines defined on a server to the class of the server itself. Indications An indication, which is a class with the Indication qualifier, defines an event of interest that might occur in a managed environment. Instances of Indications are transient objects and cannot be queried using standard CIM Intrinsics. Rather, to receive indications, an application must create a subscription to an indication class to receive notification of its instances. Indications can be divided into two categories. Lifecycle indications are notifications related to the creation, deletion, and modification of objects modeled in CIM. Process indications are notifications of events that may not be completely modeled by CIM. Direct feedback from instrumented devices or SNMP traps are examples of process indications. Subscribers to indications can define filters that further limit the indications they are notified of. Because CIM contains almost 2000 classes and is meant to have broad applicability to managed IT environments, some industry groups haven chosen to create profiles that address the usage of CIM in specific domains. To promote device and application interoperability, profiles unambiguously define sets of classes, associations, indications, methods, properties that must be used to model the managed resources of the domain. In addition, profiles also specify required property values, required interconnections for associations, and certain method behaviors that are are not typically encoded into MOF files. Profiles also define other requirements that cannot be represented in MOF, such as the use of a specific communication protocol by devices adhering to the profile. Profiles generally include recipes that serve as examples to guide server-side implementers and client-side application writers in proper usage of the profile. Compliance with specific profiles ensures that managed resources and management applications share the same conceptual view of their environment and of each other. SMI-S is a good example of profiles applied to a storage-related domain. SMI-S The Storage Management Initiative - Specification (SMI-S) published by the Storage Networking Industry Association (SNIA) provides several examples of profiles that are used to enable the interoperability of heterogeneous storage and storage-related

Profiles

Modeling with CIM and SMI-S

13

Overview of CIM and SMI-S

resources within a network. SMI-S includes domain profiles and subprofiles for arrays, switches, storage virtualization, volume management, and many other storage-related resources and concepts. Additionally, SMI-S defines:
◆

the communications protocol (CIM-XML) used to exchange CIM models via XML (xmlCIM) over HTTP(S) the protocol used to discover available services, which is called the Service Location Protocol (SLP) version 2

◆

ECOM complies with SMI-S version 1.2, including compliance with the following standards:
◆ ◆ ◆ ◆ ◆

CIM schema version 2.14 CIM/XML version 2.2 CIM/XML over HTTP version 1.2 Service Location Protocol (SLP) version 2 SSL 3.0 / TLS 1.0

MOF

The Managed Object Format (MOF) is a way to represent CIM models in text form. Within a MOF file, the classes, associations, properties, references, methods and associated qualifiers are defined for a domain to be modeled. MOF files are often the starting point for developers seeking to create providers that expose modeled data and functionality through ECOM. MOF files can used by tools such as the OSL# MOF Compiler to generate C++ header and source files that represent the objects modeled in the MOF file. These generated files form the basis for the resource exposure plugin that links ECOM to resource-specific functionality.

[ EMC_Sample2IsLeaf, EMC_CtorArgTypes{ "const char *", "const char *" }, EMC_CtorArgNames{ "arrayId", "volumeId" }, Description ( "Sample storage volume" ) ] class SP_StorageVolume : EMC_StorageVolume { };
Figure 1

MOF file entry for class SP_StorageVolume

14

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Interoperability with CIM
The consistent modeling of domain resources is only the first step in creating a network of interoperable management applications and managed resources. The abilities to exchange model information, to retrieve data from and execute commands through models, and to discover available resources are also required to link the heterogeneous elements in a network. The following sections describe the communication and discovery requirements of SMI-S 1.2. These requirements are fully supported by ECOM.

WBEM

Web-Based Enterprise Management (WBEM) is a group of Web-based technology standards advocated by the Distributed Management Task Force (DMTF) to facilitate unified management of enterprise IT environments. WBEM incorporates:
◆ ◆

a model (CIM) to represent resources an XML-based communication protocol (CIM-XML over HTTP) to facilitate interaction between network components1 an XML representation of CIM models and messages (xmlCIM) to travel via CIM-XML a discovery protocol (SLP) to allow management applications to discover available services

◆

◆

The combination of WBEM technologies allows ECOM to serve as the interoperability hub of the Common Management Platform (CMP).

1. WS-Management is also advocated by the DMTF as an

alternative to CIM-XML.
Interoperability with CIM
15

Overview of CIM and SMI-S

Figure 2

In this very simple example, a WBEM-enabled client and service provider use the CIM-XML protocol to transmit messages and models between themselves.

SLP

Before resources can be managed, they must first be discovered by management applications. The Service Location Protocol (SLP) defines a mechanism for using UDP or TCP multicasts to announce the need for and the responding location of services in a network. Applications looking for a service are called user agents (UA), and applications providing a service are called service agents (SA). optionally, directory agents may be used to provide a central listing of available services. In terms of SLP, ECOM acts as a service agent that advertises its address and capabilities when it receives a multicast requesting its type of available functionality from an user agent (often a management application) on the network. When a UA has found the ECOM-exposed services that it needs, it begins communicating directly with each ECOM instance via CIM-XML messages.

16

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Figure 3

SLP multicast is used to find needed ECOM instances in a network. Only ECOMs that have the appropriate profile respond, returning information to facilitate direct CIM-XML access.

Interoperability with CIM

17

Overview of CIM and SMI-S

CIM intrinsic and extrinsic operations

Once a service consumer and a service provider have established contact, CIM-XML messages are passed between them to transport information about modeled resources and to execute commands (also known as methods or operations). The types of operations that clients can perform are divided into two categories:
◆

Intrinsic operations are those defined in The DMTF Specification for CIM Operations Over HTTP. These operations are performed against a namespace and modify or obtain information about related CIM elements (classes, instances, qualifiers, properties, etc.). Extrinsic operations are methods defined within CIM classes themselves. Extrinsic methods define class-specific operations exposed by the model.

◆

As an example, the combination of intrinsic and extrinsic methods allows service consumers to filter through the object types available on an ECOM instance (EnumerateClasses), obtain instances of a specific class type (EnumerateInstances), identify a particular instance to modify (GetInstance), and execute a method defined for it. See Table 2 on page 23 for a list of supported CIM intrinsic operations. ECOM also supports CIM extrinsic methods.

18

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

M-POST /cimom HTTP/1.1 HOST: http://172.23.144.237:5988 Content-Type: application/xml; charset="utf-8" Content-Length: 563 Man: http://www.dmtf.org/cim/mapping/http/v1.0 ; ns=73 73-CIMOperation: MethodCall 73-CIMMethod: EnumerateInstances 73-CIMObject: root/ecom FALSE FALSE
Figure 4

An example of the EnumerateInstances CIM intrinsic method in a CIM-XML message

SMI-S Server (CIMOM) profile

In addition to querying information about the resources exposed through a CIMOM such as ECOM, SMI-S requires a server profile that allows clients to query information about ECOM itself, including the profiles it supports.

Interoperability with CIM

19

Overview of CIM and SMI-S

CQL

The CIM Query Language (CQL) is used to filter through CIM elements and identify those that meet the requirements of the query. CQL queries help clients filter through the potentially large number of classes and instances that could be exposed through ECOM without having to issue several CIM operations, such as EnumerateInstances, and iterate through the data sets returned.

20

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Additional information for modeling
For additional information about the technologies discussed here, consult the following resources:
◆

DMTF web-based tutorial, covering CIM, WBEM, and profiles http://www.wbemsolutions.com/tutorials/DMTF/initiatives.ht ml DMTF Common Information Model (CIM) web site http://www.dmtf.org/standards/cim/ SNIA Storage Management Initiative (SMI) web site http://www.snia.org/smi/home/ Overview of the EMC Common Information Model (ECIM) https://corpusweb172.corp.emc.com/eRoom/spoadvtech/EMC SMI/0_135a

◆

◆

◆

Additional information for modeling

21

Overview of CIM and SMI-S

ECOM supported standards matrix
ECOM supports the following standards:
Table 1

Standards supported by ECOM Compliance Full Full Full Full Full Full Standard Location http://www.snia.org/publicreview http://www.dmtf.org/standards/cim/cim_s chema_v214/ http://www.dmtf.org/standards/wbem/DS P201.html http://www.dmtf.org/standards/published _documents/DSP200.pdf http://tools.ietf.org/html/rfc2608 SSL 3.0 http://wp.netscape.com/eng/ssl3/ TLS 1.0 http://www.ietf.org/rfc/rfc2246.txt

Standard SMI-S 1.2 CIM schema version 2.14 CIM-XML version 2.2 CIM- Operations over HTTP version 1.2 Service Location Protocol (SLP) version 2 SSL 3.0 / TLS 1.0

CIM Query Language (CQL) HTTP 1.0/1.1

Partial. Only Basic Query and Embedded Properties are supported. Full

http://www.dmtf.org/standards/document s/WBEM/DSP0202.pdf HTTP 1.0 http://www.w3.org/Protocols/rfc1945/rfc1 945 HTTP 1.1 http://www.ietf.org/rfc/rfc2616.txt

22

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

ECOM supports the following CIM profiles and intrinsic operations:
Table 2

Supported CIM profiles for intrinsic operations Profile Basic Read Supported intrinsic operation GetClass EnumerateClasses EnumerateClassNames GetInstance EnumerateInstances EnumerateInstanceNames GetProperty CreateInstance DeleteInstance ModifyInstance Associators AssociatorNames References ReferenceNames Set Property

Instance Modification

AssociationTraversal

Basic Write

Note: ECOM also supports CIM extrinsic methods (InvokeMethod).

The following CIM intrinsics are NOT currently supported but may be included in future releases of ECOM:
◆ ◆ ◆ ◆ ◆ ◆ ◆ ◆

DeleteClass CreateClass ModifyClass ExecQuery GetQualifier SetQualifier DeleteQualifier EnumerateQualifiers

ECOM supported standards matrix

23

Overview of CIM and SMI-S

WS-Management support
Table 3

Table 3 on page 24 defines ECOM’s mappings for WS-Management operations to corresponding CIM equivalents.
ECOM’s mappings of WS-Management operations to CIM operations CIM equivalent GetInstance() DeleteInstance() OpenAssociatorInstancePaths()

WS-Management wsa:Action URI is http://schemas.xmlsoap.org/ws/2004/09/transfer/Get wsa:Action URI is http://schemas.xmlsoap.org/ws/2004/09/transfer/Delete wsa:Action URI is http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerat e ,its EnumerationMode is EnumerateEPR and its FilterDialect is AssociatedInstances wsa:Action URI is http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerat e ,its EnumerationMode is EnumerateEPR and its FilterDialect is AssociationInstances wsa:Action URI is http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerat e ,its EnumerationMode is NULL (or EnumerateObjectAndEPR) and its FilterDialect is AssociatedInstances wsa:Action URI is http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerat e ,its EnumerationMode is NULL (or EnumerateObjectAndEPR)and its FilterDialect is AssociationInstances wsa:Action URI is: http://schemas.xmlsoap.org/ws/2004/09/enumeration/Pull and Enumeration Context is OBJECT wsa:Action URI is: http://schemas.xmlsoap.org/ws/2004/09/enumeration/Pull and Enumeration Context is INSTANCENAME wsa:Action URI is: http://schemas.xmlsoap.org/ws/2004/09/enumeration/Release wsa:Action URI is: http://schemas.xmlsoap.org/ws/2004/09/transfer/Put wsa:Action URI is: http://schemas.xmlsoap.org/ws/2004/09/transfer/Create

OpenReferenceInstancePaths()

OpenAssociatorInstances()

OpenReferenceInstances()

PullInstancesWithPath()

PullInstancePaths()

CloseEnumerationContext() ModifyInstance() CreateInstance()

24

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Table 4 on page 25 lists known limitations of ECOM’s CIM operations and their correspondence to its WS-Management support.
Table 4

CIM operation support and WS-Management limitations WS-Management support? Yes Supported Parameters ObjectName=InstanceNames, AssociationClass, ResultClass, Role, ResultRole ObjectName=InstanceNames, AssociationClass, ResultClass, Role, ResultRole Unsupported parameters ObjectName=ClassName, IncludeClassOrigin & PropertyList ObjectName=ClassName

CIM Intrinsic Operation Associators()

AssociatorNames()

Yes

CreateInstance() DeleteInstance() EnumerateInstanceNames() EnumerateInstances() GetClass () GetInstance() ModifyInstance() ReferenceNames() References()

No Yes Yes Yes No (no mapping in DSP0207) Yes No Yes Yes ObjectName=InstanceName, ResultClass, Role ObjectName=InstanceName, ResultClass, Role ClassName ObjectName=ClassName ObjectName=ClassName, IncludeClassOrigin & PropertyList FilterQueryLanguage, FilterQuery, OperationTimeout, ContinueOnError DeepInheritance, IncludeClassOrigina, PropertyList, FilterQueryLanguage, FilterQuery, OperationTimeout, ContinueOnError InstanceName IncludeClassOrigin, PropertyList InstanceName ClassName ClassName

OpenEnumerateInstancePath s

Yes

OpenEnumerateInstances

Yes

ClassName

ECOM supported standards matrix

25

Overview of CIM and SMI-S

Table 4

CIM operation support and WS-Management limitations WS-Management support? Yes Supported Parameters EnumerationContext, InstanceName, EndOfSequence, AssociationClass, ResultRole, Role, ResultRole, MaxObjectCount EnumerationContext, InstanceName, EndOfSequence, AssociationClass, ResultRole, Role, ResultRole, MaxObjectCount EnumerationContext, InstanceName, EndOfSequence, ResultClass, Role, MaxObjectCount Unsupported parameters IncludeClassOrigina, PropertyList, FilterQueryLanguage, FilterQuery, OperationTimeout, ContinueOnError FilterQueryLanguage, FilterQuery, OperationTimeout, ContinueOnError

CIM Intrinsic Operation OpenAssociatorInstances

OpenAssociatorPaths

Yes

OpenReferenceInstances

Yes

IncludeClassOrigina, PropertyList, FilterQueryLanguage, FilterQuery, OperationTimeout, ContinueOnError FilterQueryLanguage, FilterQuery, OperationTimeout, ContinueOnError

OpenReferenceInstancePaths

Yes

EnumerationContext, InstanceName, EndOfSequence, ResultClass, Role, MaxObjectCount EnumerationContext, EndOfSequence, MaxObjectCount EnumerationContext, EndOfSequence, MaxObjectCount EnumerationContext

PullInstancePaths

Yes

PullInstancesWithPath

Yes

CloseEnumeration

Yes

Optional features in WS-Management, such as OptimizeEnumeration, are not supported unless specifically stated.

The following intrinsic methods in WS-Management can only take instance names as input parameters:
◆ ◆ ◆

Associators AssociatorNames References

26

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

◆

ReferenceNames

element support

ECOM now supports the element, allowing ECOM clients to increase system security and specify the allowed duration for enumeration requests. maps directly to the CIM operation timeout as an enumeration context timeout. Figure Figure 5 on page 27 provides an example.

http://localhost:5985/wsman http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumera t http://schemas.xmlsoap.org/ws/2004/08/addressing/role/an onymous uuid:7150fae3-0c6e-407e-a4a1-7369748abbc0 http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/ CIM_ManagedElement 150000 interop EnumerateEPR 2012-03-01T10:01:01
Figure 5

example

ECOM supported standards matrix

27

Overview of CIM and SMI-S

Note: The enumeration operation timeout value can also be set globally for ECOM through the DefaultPulledEnumOperationTimeout parameter in ECOM_settings.xml.

The element can hold a time value of type xs:dateTime or xs:duration. … [xs:dateTime | xs:duration] ? …

dateTime is specified in the form "YYYY-MM-DDThh:mm:ss" where:
◆ ◆ ◆ ◆ ◆ ◆ ◆

YYYY indicates the year MM indicates the month DD indicates the day T indicates the start of the required time section hh indicates the hour mm indicates the minute ss indicates the second

All components of this format are required for use with ECOM. If a value of type xs:dateTime is passed, ECOM calculates how many seconds are left between the moment it received the message and the specified dateTime. All calculations are based on ECOM's current timezone. An example of an xs:duration value of 30 seconds is:

… PT30S …

Another example, which will expire in 1 year, 2 months and 3 days, is:

…
28

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

P1Y2M3D …

The duration for xs:duration is specified in the form "PnYnMnDTnHnMnS" where:
◆ ◆ ◆ ◆ ◆

P indicates the period (required) Y indicates the number of years M indicates the number of months D indicates the number of days T indicates the start of a time section (required if you are going to specify hours, minutes, or seconds) H indicates the number of hours M indicates the number of minutes S indicates the number of seconds

◆ ◆ ◆

ECOM supported standards matrix

29

Overview of CIM and SMI-S

Extrinsic Methods

ECOM supports extrinsic method invocation through WS-Management. Figure 6 on page 31 demonstrates an example request.

30

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

http://schemas.dmtf.org/wbem/wscim/1/cim-schem a/2/QE_QETestMethods/CompareStaticData http://9.123.251.94:5985/wsman http://schemas.dmtf.org/wbem/wscim/1/cim-schem a/2/QE_QETestMethods uuid:a9d78e51-5943-1943-8002-7ec0ed251100 http://schemas.xmlsoap.org/ws/2004/08/addressing/role/ano nymous root/emc TestMethodsInstanceName TestDataInstanceName 42 17 18 12 33 What is six times nine ? Hello cruel world?
Figure 6

WS-Management Extrinsic method invocation example with an embedded instance
ECOM supported standards matrix
31

Overview of CIM and SMI-S

XML Fragment Support

The WS-Management specification defines the concept of fragment-level (property) access of resources. This fragment-level access applies to the operations get, put, delete, create and enumeration but we are only going to describe here the fragment level operations get and enumeration, because that are the ones currently implemented. For the operations get, put, delete and create, the fragment level selection is done through the SOAP Header tag xpath expression

The expression used is a subset of the XPath 1.0 specification. For a Get, the XPath expression is able to select a node (and its child or children), and a specific property value of node. For an enumerate, the XPath expression filters out instances from the result set and, from the filtered instances, selects only a subset of the oroperties of those instances. Fragment Level Get Operations The fragment level Get operation is very similar to the regular Get operation, but ECOM adds a wsman:FragmentTransfer tag at the SOAP header. For example, the following request selects a specific SP_StorageVolume instance as the regular Get does, but also limits the output from ECOM to only 3 properties of this instance: SystemName, BlockSize and DeviceID.
XML Fragment Example

Table 5

http://10.5.222.240:5988 http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/root/emc/SP_StorageVolume http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous

32

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Table 5

XML Fragment Example

http://schemas.xmlsoap.org/ws/2004/09/transfer/Get 153600 uuid:109CE460-C546-4045-99A6-DF9A4F2B5F4A root/emc SP_StorageVolume Volume 1 SP_StorageSystem Big Array //*[self::i:SystemName or self::i:BlockSize or self::i:DeviceID]

The ECOM response to the above request is shown in Table 5.

ECOM supported standards matrix

33

Overview of CIM and SMI-S

Table 6

ECOM Response to Example in Table 5

http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous http://schemas.xmlsoap.org/ws/2004/09/transfer/GetResponse uuid:109CE460-C546-4045-99A6-DF9A4F2B5F4A uuid:dd482640-54c6-4783-874f-75586961 Volume 1 Big Array 512

XPath examples for Get operation

Consider the following instance of the SP_StorageVolume class:

34

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Table 7

SP_StorageVolume Class Example

... SP_StorageVolume Volume 1 SP_StorageSystem Big Array 512 128 15 6 42 2 17 ...

The following examples show ECOM's response to a variety of XPath expressions:
Table 8

ECOM Response / XPath Expression matrix

XPath Expression

//*[name()='i:SystemName' or name()='i:BlockSize' or name()='i:DeviceID'] Volume 1 Big Array 512 This xpath has the same effect as // *[self::i:SystemName or self::i:BlockSize or self::i:DeviceID]

ECOM Response

Comment

ECOM supported standards matrix

35

Overview of CIM and SMI-S

Table 8

ECOM Response / XPath Expression matrix

XPath Expression

/i:SP_StorageVolume/i:ConsumableBlocks 128

ECOM Response

Comment XPath Expression /i:SP_StorageVolume/i:ConsumableBlocks/text() 128 Note how when we append the 'text()' xpath function to the expression the returned value is not enclosed with the property name tag. count(/i:SP_StorageVolume/*) 11 This counts the number of child tags under i:SP_StorageVolume. Note, this is not a properties count, because we can have properties that are arrays and so the array name appers more than once. Like for example the 'ExtentStatus' tag. count(//*[substring(name(),3,6)='Extent']) 2 This counts how many elements we have that has the string 'Extent' starting at position 3 from the return of function name() (which returns the name of the element being evaluated).

ECOM Response

Comment XPath Expression

ECOM Response

Comment

XPath Expression

ECOM Response

Comment

36

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Table 8

ECOM Response / XPath Expression matrix

XPath Expression

count(/i:SP_StorageVolume/descendant::i:OperationalStatus) 2 Another form to count the number of properties with a specific name. Here we are counting the number of times i:OperationalStatus appears. //i:ExtentStatus[2]/text() 6 Select the second element with the name i:ExtentStatus. This XPath expression requests the second element of the ExtentStatus array. //*[text() = 'SP_StorageSystem'] SP_StorageSystem Select the node element containing the string SP_StorageSystem.

ECOM Response

Comment XPath Expression

ECOM Response

Comment XPath Expression

ECOM Response

Comment

ECOM supported standards matrix

37

Overview of CIM and SMI-S

Table 8

ECOM Response / XPath Expression matrix

XPath Expression

concat('The System Name is ', "'",//i:SystemName/text(), "'",' and it has block size of ', //i:BlockSize/text(), " and '", //i:NumberOfBlocks/text(), "' number of blocks, totalling ", //i:BlockSize/text() * //i:NumberOfBlocks/text()) The System Name is 'Big Array' and it has block size of 512 and '42' number of blocks, totalling 21504 This expression concatenates some property values and also a calculation.

ECOM Response

Comment

Fragment level Enumeration operation

You can use XMLFragments with enumerations to do the following:
◆

Select specific properties from all elements. This is effectively a Get operation applied to each element of the enumeration. Filter out elements in the enumeration based on the instance properties.

◆

For example, to request all elements of an enumeration that have a populated ExtentStatus property, send the following enumeration request to ECOM:

38

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Table 9

Request for Enumeration Elements with Specific Property Data

http://localhost:5985/wsman http://schemas.xmlsoap.org/ws/2004/09/enumeration/Enumerate http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous uuid:7150fae3-0c6e-407e-a4a1-7369748abbc0 http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/SP_StorageVolume 150000 root/emc //i:ExtentStatus

ECOM supported standards matrix

39

Overview of CIM and SMI-S

The XPath expression //i:ExtentStatus' makes ECOM return all elements in the enumeration whose property name is i:ExtentStatus. ECOM's response is (omitting the intermediate step of the enumeration context sent by ECOM):

Table 10

ECOM Response to Enumeration Elements with Specific Property Data

http://schemas.xmlsoap.org/ws/2004/08/addressing/role/anonymous http://schemas.xmlsoap.org/ws/2004/09/enumeration/PullResponse uuid:a9d78e51-5943-1943-8002-7ec0ed251100 uuid:09e2b64b-1f25-4a4a-989f-11c77371 15 6 4 6

40

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Table 10

ECOM Response to Enumeration Elements with Specific Property Data

15 6 4 6 0 6 15 6

ECOM supported standards matrix

41

Overview of CIM and SMI-S

Examples: Varying ExtentStatus

The following examples show the ECOM response to a varying number of 'i:ExtentStatus'. ExtentStatus is an array of integers.

42

ECOM Deployment and Configuration Guide

Overview of CIM and SMI-S

Table 11

ECOM Response / XPath Expression matrix

Request

concat('The System Name is ', "'", //i:SystemName/text(), "'", ' and it has block size of ', //i:BlockSize/text(), " and '", //i:NumberOfBlocks/text(), "' number of blocks, totalizing ", //i:BlockSize/text() * //i:NumberOfBlocks/text()) The System Name is 'Big Array' and it has block size of 512 and '42' number of blocks, totalizing 21504 The System Name is 'Big Array' and it has block size of 512 and '42000' number of blocks, totalizing 21504000 The System Name is 'Big Array' and it has block size of 512 and '12345678' number of blocks, totalling 2026019840 The System Name is 'Big Array' and it has block size of 512 and '3' number of blocks, totalizing 1536 The System Name is 'Big Array' and it has block size of 512 and '15' number of blocks, totalizing 7680 The System Name is 'Small Array' and it has block size of 512 and '117' number of blocks, totalizing 59904

Response

Comments

As in the Get operation, the XPath expression is applied to each element of the enumeration.

ECOM supported standards matrix

43

Overview of CIM and SMI-S

Table 11

ECOM Response / XPath Expression matrix

Request

//*[substring(name(),3,6)='Extent']/ancestor::*/i:NumberOfBloc ks[text()