3PAR CIM API

Programming Reference
for InForm OS 2.3.1

3PAR Inc.
4209 Technology Drive
Fremont, CA 94538 U.S.A.
Part No. 320-200164 Rev B
February 2010
Revision Notice
This is the second release of this manual. A complete revision history is provided at the end of this document.

Changes
The material in this document is for information only and is subject to change without notice. While reasonable efforts have been
made in the preparation of this document to assure its accuracy, 3PAR Inc. assumes no liability resulting from errors or omissions in
this document or from the use of the information contained herein.
3PAR reserves the right to make changes in the product design without reservation and without notification to its users.

Updates to the Documentation at 3PAR Central

Any updates to this document, or to other 3PAR technical documents, can be found by logging on to 3PAR Central’s Document
Control System from 3PAR’s Support page at http://www.3PAR.com/support/index.html

3PAR Technical Support and Services

Contact your local service provider for technical support and services.

Sales and Ordering Information

For sales and ordering information, contact:
3PAR Inc.
4209 Technology Drive
Fremont, CA 94538 U.S.A.
Telephone: 510-413-5999
Fax: 510-413-5699
E-mail: [email protected]

Reader Comments and Suggestions

Please E-mail your comments and suggestions about this document to [email protected].

Copyrights
© 2010 3PAR Inc. All rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any
form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior written consent of 3PAR Inc.,
4245 Technology Drive, Fremont, CA 94538. By way of exception to the foregoing, the user may print one copy of electronic material
for personal use only.

Trademarks
3PAR, InServ, InForm, InSpire and Serving Information are registered trademarks of 3PAR Inc.
Microsoft, Windows, and Windows NT are either registered trademarks or trademarks of Microsoft Corporation.
UNIX is a registered trademark of The Open Group.
All other trademarks and registered trademarks are owned by their respective owners.

Federal Communications Commission Radio Frequency Interference Statement

WARNING: Changes or modifications to this unit not expressly approved by the party responsible for compliance could void the user’s
authority to operate the equipment.

This device complies with Part 15 of FFC Rules. Operation is subjected to the following two conditions (1) this device may not cause
harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired
operation.

This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to Part 15 of the FCC rules.
These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a
commercial environment. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in
accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a
residential area is likely to cause harmful interference in which case the user required to correct the interference at his own expense.
InForm OS Version 2.3.1 CIM API Programming Reference

Table of Contents
1 Introduction
1.1 Audience 1.1

1.2 Related Documentation 1.2

1.3 Organization 1.2

1.4 Typographical Conventions 1.3

1.5 Advisories 1.4

2 Concepts
2.1 About SMI-S 2.1

2.2 About the WBEM Initiative 2.2

3 Security
3.1 TCP Ports 3.1

3.2 Authentication 3.2

3.3 Authorization 3.3

4 Configuring and Using the CIM Server

4.1 CLI Command Overview 4.2

4.2 Enabling and Disabling the CIM Server 4.2

4.2.1 Enabling the CIM Server 4.2
4.2.2 Disabling the CIM Server 4.3

4.3 Displaying the CIM Server Status 4.3

Table of Contents iii

 CIM API Programming Reference InForm OS Version 2.3.1

4.4 Displaying the CIM Server Version 4.4

4.5 Communicating with the CIM Server 4.4

4.5.1 Client Software 4.4
4.5.2 Sending Client Requests 4.6

4.6 CIM Namespaces 4.7

5 3PAR CIM API SMI-S Support

5.1 Standard Compliance 5.2

5.2 SMI-S Functionality 5.2

5.3 Discovery Service 5.3

5.4 Supported Profiles 5.3

5.5 Supported Array Packages 5.3

5.6 Supported Array Subprofiles 5.4

5.6.1 SMI-S Support by Release 5.5
5.6.2 Discovery Service 5.6

5.7 Server Profile 5.6

5.7.1 Server Profile CIM Classes 5.7
5.7.2 Supported Methods 5.7

5.8 Array Profile 5.8

5.8.1 Array Profile CIM Classes 5.8
5.8.2 Supported Methods 5.8

5.9 Block Services Package 5.9

5.9.1 Block Services Package CIM Classes 5.9
5.9.2 Supported Methods 5.10
5.9.3 StorageSetting 5.12
5.9.4 Creating a DynamicStoragePool (DSP) via SMI-S 5.18
5.9.4.1 Relevant Properties of DynamicStoragePool 5.21
5.9.4.2 Modifiable StorageSetting Properties for DSP 5.23
5.9.4.3 StorageCapabilities of DynamicStoragePool 5.25
5.9.4.4 StoragePoolConfigurationCapabilities of DynamicStoragePool 5.25

iv Table of Contents
InForm OS Version 2.3.1 CIM API Programming Reference

5.9.5 Creating a Volume Through SMI-S 5.26

5.9.5.1 Supported Method For Creating a Storage Volume 5.28
5.9.5.2 Creating Data and Snapshot Space from Two Storage Pools 5.31
5.9.5.3 CreateSetting 5.34
5.9.5.4 Creating a Volume with a Default Setting 5.35
5.9.5.5 Creating a Volume with a Non-Default Setting 5.35
5.9.5.6 Creating a Volume with Disk Pattern Filtering 5.37
5.9.5.7 Summary of Different Types of Volumes That Can Be Created 5.39
5.9.5.8 Modifiable StorageSetting Properties for StorageVolume 5.44
5.9.6 Calculating Capacity for StoragePool and StorageVolume 5.46
5.9.6.1 Primordial Storage Pool 5.46
5.9.6.2 Concrete Storage Pool 5.46
5.9.6.3 Dynamic Storage Pool (CPG) 5.46
5.9.6.4 Legacy Storage Volume 5.47
5.9.6.5 Fully Provisioned Storage Volume 5.50
5.9.6.6 Thinly Provisioned Storage Volume 5.52
5.9.7 Indications 5.55

5.10 Copy Services Subprofile 5.56

5.10.1 Description 5.56
5.10.2 CIM Classes 5.56
5.10.2.1 TPD_AffectedJobElement 5.59
5.10.2.2 TPD_AllocatedFromStoragePool 5.59
5.10.2.3 TPD_AssociatedJobMethodResult 5.59
5.10.2.4 TPD_CapabilitiesOfStorageConfigurationService 5.59
5.10.2.5 TPD_CapabilitiesOfStoragePool 5.59
5.10.2.6 TPD_ConcreteJob 5.59
5.10.2.7 TPD_ConcreteJobInstModification 5.59
5.10.2.8 TPD_DeltaReplicaStoragePool 5.60
5.10.2.9 TPD_ElementSettingData 5.60
5.10.2.10 TPD_HostedStoragePool 5.60
5.10.2.11 TPD_MethodResult 5.60
5.10.2.12 TPD_OwningJobElement 5.60

Table of Contents v
 CIM API Programming Reference InForm OS Version 2.3.1

5.10.2.13 TPD_ReplicaPoolForStorage 5.60

5.10.2.14 TPD_StorageCapabilities 5.60
5.10.2.15 TPD_StorageConfigurationCapabilities 5.61
5.10.2.16 TPD_StorageConfigurationService 5.61
5.10.2.17 TPD_StorageReplicationCapabilities 5.62
5.10.2.18 TPD_StorageSetting 5.66
5.10.2.19 TPD_StorageSynchronized 5.66
5.10.2.20 TPD_SystemVolume 5.67
5.10.2.21 TPD_DynamicStoragePool 5.67
5.10.3 SA/SD Space As StoragePool 5.67
5.10.3.1 StoragePool Instantiation 5.67
5.10.3.2 Associations 5.68
5.10.3.3 Capacity Calculations 5.68
5.10.3.4 Indications 5.71
5.10.4 Physical Copy 5.72
5.10.4.1 StorageSynchronized 5.72
5.10.4.2 StorageReplicationCapabilities 5.73
5.10.4.3 Job Control Subprofile Indications 5.84
5.10.5 Virtual Copy 5.84
5.10.5.1 StorageSynchronized 5.84
5.10.5.2 StorageReplicationCapabilities 5.85
5.10.6 Job Control 5.91
5.10.6.1 Overview 5.91
5.10.6.2 TPD_ConcreteJob 5.91
5.10.6.3 TPD_OwningJobElement 5.95
5.10.6.4 TPD_AffectedJobElement 5.95
5.10.6.5 TPD_AssociatedJobMethodResult 5.95
5.10.6.6 Indications 5.95

5.11 Location Subprofile 5.95

5.11.1 Location Subprofile CIM Classes 5.95
5.11.2 Supported Methods 5.96

vi Table of Contents
InForm OS Version 2.3.1 CIM API Programming Reference

5.12 Multiple Computer System Subprofile 5.96

5.12.1 Multiple Computer System Subprofile CIM Classes 5.96
5.12.2 Supported Methods 5.97

5.13 Software Subprofile 5.97

5.13.1 Software Subprofile CIM Classes 5.97
5.13.2 Supported Methods 5.98

5.14 Masking and Mapping Subprofile 5.98

5.14.1 Masking and Mapping Subprofile CIM Classes 5.98
5.14.2 Supported Methods 5.100
5.14.3 SMI-S View and Paths 5.101
5.14.4 ProtocolControllerMaskingCapabilities 5.105
5.14.5 ControllerConfigurationService 5.107
5.14.5.1 ExposePaths (Creating Matched-Set VLUNs) 5.108
5.14.5.2 HidePaths (Removing Matched-Set VLUNs) 5.112
5.14.5.3 ExposeDefaultLUs (Creating Port-Present VLUNs) 5.114
5.14.5.4 HideDefaultLUs (Removing Port-Present VLUNs) 5.116
5.14.5.5 ExposeLUsToStorageHardwareIDCollection
(Creating Host-Sees VLUNs) (3PAR proprietary method) 5.118

5.15 HideLUsFromStorageHardwareIDCollection
(Removing Host-Sees VLUNs) 5.121
5.15.0.1 StorageHardwareIDManagementService 5.122
5.15.0.2 CreateStorageHardwareID (Creating Host and Path) 5.123
5.15.0.3 DeleteStorageHardwareID (Removing a Path from a Host) 5.124
5.15.0.4 CreateStorageHardwareIDCollection (Creating a Host) 5.125
5.15.0.5 AddStorageHardwareIDsToCollection (Adding a Path to a Host) 5.126
5.15.0.6 StorageHardwareIDCollection.DeleteInstance (Deleting a Host) 5.126
5.15.1 ConcreteDependency 5.126
5.15.2 SAPAvailableForElement 5.126
5.15.3 iSCSISAPAvailableForElement 5.127
5.15.4 SCSIPrococolController 5.127
5.15.5 iSCSIPrococolController 5.127
5.15.6 SCSIPrococolEndpoint 5.127

Table of Contents vii

 CIM API Programming Reference InForm OS Version 2.3.1

5.15.7 iSCSIPrococolEndpoint 5.128

5.15.8 ControllerForUnit 5.128
5.15.9 iSCSIControllerForUnit 5.129
5.15.10 StorageClientSettingData 5.130
5.15.11 StorageHardwareID 5.130
5.15.12 TPD_StorageHardwareIDCollection 5.130
5.15.13 Supporting classes 5.130
5.15.13.1 AuthorizedPrivilege 5.130
5.15.13.2 AuthorizedSubject 5.131
5.15.13.3 AuthorizedTarget 5.131
5.15.13.4 ConcreteDependency 5.131
5.15.13.5 SystemEndpoint (HostedAccessPoint) 5.131
5.15.13.6 ElementCapabilities 5.131
5.15.13.7 ElementSettingData 5.131
5.15.13.8 MemberOfCollection 5.131
5.15.13.9 ProtocolControllerMaskingCapabilities 5.131

5.16 FC Target Ports Subprofile 5.132

5.16.1 FC Target Ports Subprofile CIM Classes 5.132
5.16.2 Supported Methods 5.132

5.17 FC Initiator Ports Subprofile 5.132

5.17.1 FC Initiator Ports Subprofile CIM Classes 5.133
5.17.2 Supported Methods 5.133

5.18 iSCSI Target Ports Subprofile 5.133

5.18.1 iSCSI Target Ports Subprofile CIM Classes 5.134
5.18.2 Supported Methods 5.135

5.19 Disk Drive Lite Subprofile 5.135

5.19.1 Disk Drive Lite Subprofile CIM Classes 5.135
5.19.2 Supported Methods 5.136

5.20 Block Server Performance Subprofile 5.137

5.20.1 Block Server Performance Subprofile CIM Classes 5.137

viii Table of Contents

InForm OS Version 2.3.1 CIM API Programming Reference

6 CIM Indications
6.1 Overview 6.1

6.2 Fibre Channel Ports 6.1

6.3 Job Control for Copy Services 6.2

6.4 Thin Provisioning 6.2

7 3PAR CIM-API Extensions

7.1 Health Management 7.2
7.1.1 Controller Node Subsystem 7.2
7.1.1.1 Controller Node Subsystem CIM Classes 7.2
7.1.1.2 Properties for TPD_StorageSystem 7.3
7.1.1.3 Properties for TPD_NodeSystem 7.3
7.1.1.4 Properties for TPD_PCICard 7.4
7.1.1.5 Properties for TPD_NodeCPU 7.4
7.1.1.6 Properties for TPD_PhysicalMemory 7.5
7.1.1.7 Properties for TPD_IDEDrive 7.5
7.1.2 Supported Methods 7.5
7.1.2.1 UML Diagram 7.6
7.1.3 Disk Enclosure Subsystem 7.6
7.1.3.1 Disk Enclosure Subsystem CIM Classes 7.6
7.1.3.2 Properties for TPD_StorageSystem 7.7
7.1.3.3 Properties for TPD_DriveCage 7.7
7.1.3.4 Properties for TPD_CageInterfaceCard 7.8
7.1.3.5 Properties for TPD_Magazine 7.8
7.1.3.6 Properties for TPD_DiskDrive 7.9
7.1.4 Supported Methods 7.9
7.1.4.1 UML Diagram 7.10
7.1.5 Power and Cooling 7.10
7.1.5.1 Power and Cooling CIM Classes 7.10
7.1.5.2 Properties for TPD_StorageSystem 7.11
7.1.5.3 Properties for TPD_NodeSystem 7.11
7.1.5.4 Properties for TPD_DriveCage 7.12

Table of Contents ix
 CIM API Programming Reference InForm OS Version 2.3.1

7.1.5.5 Properties for TPD_PowerSupply 7.12

7.1.5.6 Properties for TPD_Battery 7.13
7.1.5.7 Properties for TPD_Fan 7.13
7.1.6 Supported Methods 7.14
7.1.6.1 UML Diagram 7.14

7.2 Inventory Management 7.15

7.2.1 Controller Node Subsystem 7.15
7.2.1.1 Controller Node Subsystem CIM Classes 7.15
7.2.1.2 Properties for TPD_StorageSystem 7.16
7.2.1.3 Properties for TPD_SystemPackage 7.16
7.2.1.4 Properties for TPD_NodeSystem 7.17
7.2.1.5 Properties for TPD_NodePackage 7.17
7.2.1.6 Properties for TPD_PCICard 7.17
7.2.1.7 Properties for TPD_NodeCPU 7.18
7.2.1.8 Properties for TPD_PhysicalMemory 7.18
7.2.1.9 Properties for TPD_IDEDrive 7.18
7.2.2 Supported Methods 7.19
7.2.2.1 UML Diagram 7.19
7.2.3 Disk Enclosure Subsystem 7.20
7.2.3.1 Disk Enclosure Subsystem CIM Classes 7.20
7.2.3.2 Properties for TPD_StorageSystem 7.20
7.2.3.3 Properties for TPD_DriveCage 7.21
7.2.3.4 Properties for TPD_CageInterfaceCard 7.21
7.2.3.5 Properties for TPD_Magazine 7.22
7.2.3.6 Properties for TPD_DiskDrive 7.22
7.2.3.7 Properties for TPD_DiskDrivePackage 7.22
7.2.3.8 Properties for TPD_DiskSoftwareIdentity 7.23
7.2.4 Supported Methods 7.24
7.2.4.1 UML Diagram 7.24
7.2.5 Power and Cooling 7.25
7.2.5.1 Power and Cooling CIM Classes 7.25
7.2.5.2 Properties for TPD_StorageSystem 7.25

x Table of Contents
InForm OS Version 2.3.1 CIM API Programming Reference

7.2.5.3 Properties for TPD_NodeSystem 7.26

7.2.5.4 Properties for TPD_DriveCage 7.26
7.2.5.5 Properties for TPD_PowerSupply 7.26
7.2.5.6 Properties for TPD_Battery 7.27
7.2.5.7 Properties for TPD_Fan 7.27
7.2.6 Supported Methods 7.28
7.2.6.1 UML Diagram 7.28

7.3 Thin Provisioning and TPVV Manipulations 7.28

A Managed Object Format Files

A.1 3PAR_InterOp.mof A.2

A.2 3PAR_TPD.mof A.7

A.3 3PAR_TPDCage.mof A.65

A.4 PAR_TPDDisk.mof A.81

A.5 3PAR_TPDNode.mof A.90

A.6 3PAR_TPDEnv.mof A.101

A.7 3PAR_TPDLocation.mof A.109

A.8 3PAR_TPDEthPort.mof A.110

A.9 3PAR_TPDiSCSI.mof A.113

A.10 3PAR_TPDStats.mof A.124

IX Index

RH Revision History

Table of Contents xi
 CIM API Programming Reference InForm OS Version 2.3.1

xii Table of Contents

InForm OS Version 2.3.1 CIM API Programming Reference

1
Introduction

In this chapter
1.1 Audience 1.1

1.2 Related Documentation 1.2

1.3 Organization 1.2

1.4 Typographical Conventions 1.3

1.5 Advisories 1.4

1.1 Audience
To use this document, you must be familiar with basic object oriented development techniques
and be familiar with the following:

„ Storage Management Initiative Specification (SMI-S)

„ Common Information Model (CIM)

„ Hypertext Transfer Protocol (HTTP)

„ Secure Socket Layer (SSL)

„ CIM Operations over HTTP

„ Unified Modeling Language (UML)

Introduction 1.1
 CIM API Programming Reference InForm OS Version 2.3.1

1.2 Related Documentation

The following documents also provide information related to InServ® Storage Servers and the
InForm® Operating System:

Table 1-1. Related Documentation

For Information About… Read the…

Determining InServ Storage Server hardware 3PAR InServ E-Class/F-Class Storage Server
specifications, installation considerations, Physical Planning Manual
power requirements, networking options, and
cabling 3PAR InServ S-Class/T-Class Storage Server
Physical Planning Manual

Identifying storage server components and 3PAR InForm OS Messages and Operator’s
detailed alert information Guide

CLI commands and their usage InForm OS Command Line Interface Reference

Using the InForm Management Console 3PAR InForm Management Console Online
Graphical User Interface to configure and Help
administer InServ Storage Servers

Using the InForm Command Line Interface (CLI) 3PAR InForm OS CLI Administrator’s Manual
to configure and administer InServ Storage
Servers

1.3 Organization
This guide is organized as follows:

„ Chapter 1, Introduction (this chapter), provides an overview of this guide, including

information on audience, related documentation, and typographical conventions.

„ Chapter 2, Concepts, provides an overview of SMI-S and WBEM Initiatives.

„ Chapter 3, Security, discusses 3PAR CIM authentication and authorization.

1.2 Related Documentation

InForm OS Version 2.3.1 CIM API Programming Reference

„ Chapter 4, Configuring and Using the CIM Server, explains the steps required to configure
the 3PAR CIM Server using the InForm CLI.

„ Chapter 5, 3PAR CIM API SMI-S Support, provides information on all 3PAR CIM supported
profile and subprofiles.

„ Chapter 6, CIM Indications, describes the indication subscriptions supported by the 3PAR
CIM Server.

„ Chapter 7, 3PAR CIM-API Extensions, discusses additional classes that provide management
for InServ Storage Server specific features not covered by SMI-S.

„ Appendix A, Managed Object Format Files, provides the contents of the Managed Object
Format (MOF) files for the InServ Storage Server.

This guide also contains a revision history for your reference.

1.4 Typographical Conventions

This guide employs the following typographical conventions:

Table 1-2. Typographical Conventions

Typeface Meaning Example

ABCDabcd Used for dialog elements When prompted, click Finish to

such as titles, button labels, complete the installation.
and other screen elements.

ABCDabcd Used for paths, filenames, Open the file

and screen output. \os\windows\setup.exe

ABCDabcd Used to differentiate user # cd /opt/3par/console

input from screen output.

<ABCDabcd> Used for variables in Modify the content string by adding the -
filenames, paths, and P<x> option after -jar inform.jar
screen output.

<ABCDabcd> Used for variables in user #./java -jar inform.jar

input. -P<x>

Typographical Conventions 1.3

 CIM API Programming Reference InForm OS Version 2.3.1

1.5 Advisories
To avoid injury to people or damage to data and equipment, be sure to observe the cautions
and warnings in this guide.

NOTE: Notes are reminders, tips, or suggestions that supplement the procedures
included in this guide.

CAUTION: Cautions alert you to actions that can cause damage to equipment,
software, or data.

WARNING: Warnings alert you to actions that can cause injury to people or
irreversible damage to data or the operating system.

1.4 Advisories
InForm OS Version 2.3.1 CIM API Programming Reference

2
Concepts

In this chapter
2.1 About SMI-S 2.1

2.2 About the WBEM Initiative 2.2

2.1 About SMI-S

SMI-S enables management of Storage Area Networks (SANs) in a heterogeneous, multi-
vendor environment. SMI-S uses an object-oriented model based on the Common Information
Model (CIM) to define objects and services which comprise a SAN. By leveraging vendor and
technology independent standards, SMI-S allows management application vendors to create
applications that work across products from multiple vendors.

The SMI-S model is divided into several profiles, each of which describes a particular class of
SAN entities (such as disk arrays or Fibre Channel switches). These profiles allow for differences
in implementations but provide a consistent approach for clients to discover and manage SAN
resources and facilitate interoperability across vendor products within the SAN.

SMI-S also defines an automated resource discovery process using Service Location Protocol
version 2 (SLPv2). This allows management applications to automatically find SAN resources
and then probe them to determine which of the SMI-S profiles and features they support.

For more information about SMI-S, refer to the Storage Management Initiative Web site at
http://www.snia.org/smi/home.

Concepts 2.1
 CIM API Programming Reference InForm OS Version 2.3.1

2.2 About the WBEM Initiative

SMI-S is based on the Web-Based Enterprise Management (WBEM) Initiative, which is defined
by the Distributed Management Task Force (DMTF). WBEM is a set of management and
Internet standard technologies developed to unify the management of distributed computing
environments.

The DMTF has developed the following core set of standards that make up WBEM:

Table 2-1. Core Standards for WBEM Initiative

Standard Description

The Common Information Model The CIM standard is the data model for WBEM. CIM provides
(CIM) standard a conceptual framework for describing management data
for systems, networks, applications and services, and allows
for vendor extensions. SMI-S uses CIM to model those objects
and relationships that comprise a SAN.

CIM-XML CIM-XML is a method of exchanging CIM management data.

CIM-XML uses an xmlCIM payload and HTTP(s) as the
transport mechanism.
This protocol is defined by the following specifications:
„ Specification for the Representation of CIM in XML -
Defines a standard for the representation of Common
Information Model (CIM) elements and messages in XML,
written in Document Type Definition (DTD).
„ CIM Operations over HTTP - Defines a mapping of CIM
Messages onto HTTP that allows implementations of CIM to
interoperate in an open, standardized manner. It utilizes
the CIM XML DTD that defines the XML Schema for CIM
objects and messages.

WBEM Discovery using Service WBEM Discovery using SLP is a method for applications to
Location Protocol (SLP) identify WBEM-based management systems. For more
information regarding WBEM and CIM, refer to the DMTF
web site at http://www.dmtf.org.

2.2 About the WBEM Initiative

InForm OS Version 2.3.1 CIM API Programming Reference

3
Security

In this chapter
3.1 TCP Ports 3.1

3.2 Authentication 3.2

3.3 Authorization 3.3

3.1 TCP Ports

The 3PAR CIM-API uses dedicated TCP ports for CIM-XML communications and server location
information. Two ports are specified by the DMTF and registered with IANA for CIM-XML
communications between management clients and any CIM Server. The following table lists
the TCP Ports for the CIM-XML communication and service location protocols:

Table 3-1. TCP Ports for CIM-XML Communication

Protocol TCP Port

HTTP 5988 (default value)

HTTPS 5989 (default value)

Service Location (SLP) 427

Security 3.1
 CIM API Programming Reference InForm OS Version 2.3.1

3.2 Authentication
Authentication verifies the identity of an entity.

Management clients accessing the 3PAR CIM Server are authenticated using a request/
challenge mechanism using HTTP Basic authentication. When a request is received from a
management client, the CIM Server challenges the client to send a user name and password
encoded in the HTTP Authorization header. The user names and passwords used are the same
as those used by other management interfaces and are case sensitive.

NOTE: 3PAR CIM does not currently support LDAP user name and password
authentication; only local user names and passwords are valid. Please see the
3PAR Concepts Guide, Chapter 3 for more information on local versus LDAP user
credentials.

The 3PAR CIM Server uses OpenSSL to support HTTPS connections. The server supports SSLv3
and TLSv1 by default and uses the default OpenSSL cipher list only. For more about OpenSSL,
refer to http://www.openssl.org/docs.

NOTE: Because Basic Authentication means that client user names and passwords
are sent over the wire in unencrypted form, it is recommended that the
authentication is carried out either over a physically secure private network, or in
conjunction with HTTPS.

3.2 Authentication
InForm OS Version 2.3.1 CIM API Programming Reference

3.3 Authorization
Authorization determines whether an entity that has already been authenticated is allowed to
perform a given operation.

The 3PAR CIM Server allows any authenticated user to retrieve CIM class and instance
information. However, to invoke methods on CIM classes or instances, you must either have an
Edit or Super permission level. Refer to the 3PAR Concepts Guide or the 3PAR InForm OS CLI
Administrators Manual for a full discussion on authorization levels.

NOTE: Access to certain information concerning volumes, CPGs, etc., is controlled

by the InForm OS. Therefore, if a user authenticates with the CIM API and only has
access to certain domains, only those objects in those domains returned by the
InForm OS. In addition, operations on those objects also be constrained at the
domain level.

Authorization 3.3
 CIM API Programming Reference InForm OS Version 2.3.1

3.4 Authorization
InForm OS Version 2.3.1 CIM API Programming Reference

4
Configuring and Using the
CIM Server

In this chapter
4.1 CLI Command Overview 4.2

4.2 Enabling and Disabling the CIM Server 4.2

4.2.1 Enabling the CIM Server 4.2

4.2.2 Disabling the CIM Server 4.3

4.4 Displaying the CIM Server Version 4.4

4.5 Communicating with the CIM Server 4.4

4.5.1 Client Software 4.4

4.5.2 Sending Client Requests 4.6

4.6 CIM Namespaces 4.7

This chapter provides information required to configure the 3PAR CIM Server using the InForm
CLI.

Configuring and Using the CIM Server 4.1

 CIM API Programming Reference InForm OS Version 2.3.1

4.1 CLI Command Overview

The following CLI commands are available to manage the 3PAR CIM Server:

Table 4-1. CLI Commands Used to Manage the 3PAR CIM Server

Command Purpose Required

Permission Level

setcim Sets properties of the CIM Server. Super

This command can be used to
enable or disable certain services.

showcim Displays status information for Any

the CIM Server.

startcim Enables the CIM Server. Super

stopcim Disables the CIM Server. Super

NOTE: Refer to the 3PAR InForm OS Command Line Interface Reference for
additional information.

4.2 Enabling and Disabling the CIM Server

By default, the CIM Server is disabled and must be manually enabled by an administrator
before it can be used.

4.2.1 Enabling the CIM Server

To enable the 3PAR CIM Server, issue the startcim command:

# startcim
CIM server will start in about 90 seconds.

4.2 CLI Command Overview

InForm OS Version 2.3.1 CIM API Programming Reference

4.2.2 Disabling the CIM Server

To disable the 3PAR CIM Server, issue the stopcim command:

#stopcim -f
CIM server stopped successfully.

If you issue this command without the -f option, you are prompted to confirm your intent to
disable the 3PAR CIM Server.

4.3 Displaying the CIM Server Status

To display the CIM Server status information, issue the showcim command. If the CIM Server
process is running, the following output is displayed:

# showcim

-Service- -State- --SLP-- SLPPort -HTTP-- HTTPPort -HTTPS- HTTPSPort PGVer CIMVer
Enabled Active Enabled 427 Enabled 5988 Enabled 5989 2.5.1 2.3.1

If the CIM Server process is not running, the following output is displayed:

# showcim

-Service- -State-- --SLP-- SLPPort -HTTP-- HTTPPort -HTTPS- HTTPSPort PGVer CIMVer
Enabled Inactive Enabled 427 Enabled 5988 Enabled 5989 2.5.1 2.3.1

The showcim command enables you to view the overall status of the CIM Server; the status
and ports used for the HTTP, HTTPS, and SLP; the version of the internal Pegasus CIM Object
Manager; and the version of the CIM Server.

Displaying the CIM Server Status 4.3

 CIM API Programming Reference InForm OS Version 2.3.1

4.4 Displaying the CIM Server Version

The CIM Server version can be displayed using the showcim command as shown previously, or
by using the showversion -a command.

# showversion -a
Release version 2.3.1
Patches: None

Component Name Version

CLI Server 2.3.1
CLI Client 2.3.1
GUI Server 2.3.1
System Manager 2.3.1
Kernel 2.3.1
TPD Kernel Code 2.3.1
Utilities 2.3.1
Software Updater 2.3.1
CIM Server 2.3.1

4.5 Communicating with the CIM Server

Several methods of communicating with the CIM Server are listed as follows:

4.5.1 Client Software

3PAR does not provide client software, but commercial and open source CIM client software
packages are readily available. Table 4-2 lists some of the available tools and packages.

4.4 Displaying the CIM Server Version

InForm OS Version 2.3.1 CIM API Programming Reference

Table 4-2. Available Client Software Tools and Packages

Tool or Package Description URL

CIMNavigator CimNavigator is a graphical http://www.cimnavigator.com/

browser tool written in Java
that can be used to manipulate
CIM objects hosted on CIMOMs
on remote or local computers.
3PAR uses this tool for internal
development and testing.

WBEM Services The WBEM Services project is http://

an open-source Java wbemservices.sourceforge.net
implementation of Web Based
Enterprise Management. This
project consists of APIs, server
and client applications and
tools.

Ultimate CIM Ultimate CIM is the Eclipse http://sourceforge.net/projects/

plug-in that enables ultimatecim/
developers to explore CIMOM,
walk associations, execute
WQL queries, graphically view
class hierarchy and more.

Communicating with the CIM Server 4.5

 CIM API Programming Reference InForm OS Version 2.3.1

4.5.2 Sending Client Requests

Management clients send requests to the 3PAR CIM Server. A valid client request must include:

„ A properly formed HTTP header.

„ A request must be addressed to the CIM Server on an InServ Storage Server.

„ This address consists of an IP Address and the appropriate TCP port for either HTTP or
HTTPS as shown in the table that follows:

Protocol TCP Port

HTTP 5988 (default value)

HTTPS 5989 (default value)

„ The desired operation and its required parameters.

For information about CIM operations, please refer to CIM Operations over HTTP.

„ The object or objects on which the operation is to be performed.

The payload of the client request is XML. For information about XML coding for CIM, refer
to Representation of CIM in XML.

4.6 Communicating with the CIM Server

InForm OS Version 2.3.1 CIM API Programming Reference

4.6 CIM Namespaces

CIM namespaces are logical groupings of CIM classes and CIM instances that represent
managed objects in a particular environment. When making requests of a CIM server, a client
application must include the namespace that contains those classes. The namespace is case
insensitive.

Table 4-3 provides information about the namespaces supported by the 3PAR CIM Server:

Table 4-3. 3PAR CIM Server Supported Namespaces

Namespace Purpose

root/PG_Interop This is the Interop Namespace as defined in SMI-S. The Interop

Namespace is used to find Registered Profiles and other CIM classes
related to the SMI-S Server Profile.

root/tpd The root/tpd namespace (ThreeParData) is used to uniquely identify

CIM Servers supplied by 3PAR Inc. and provides management of all
classes related to managing the InServ Storage Server.

CIM Namespaces 4.7

 CIM API Programming Reference InForm OS Version 2.3.1

4.8 CIM Namespaces

InForm OS Version 2.3.1 CIM API Programming Reference

5
3PAR CIM API SMI-S
Support

In this chapter
5.1 Standard Compliance 5.2

5.2 SMI-S Functionality 5.2

5.3 Discovery Service 5.3

5.4 Supported Profiles 5.3

5.5 Supported Array Packages 5.3

5.6 Supported Array Subprofiles 5.4

5.7 Server Profile 5.6

5.8 Array Profile 5.8

5.9 Block Services Package 5.9

5.10 Copy Services Subprofile 5.56

5.11 Location Subprofile 5.95

5.12 Multiple Computer System Subprofile 5.96

5.13 Software Subprofile 5.97

5.14 Masking and Mapping Subprofile 5.98

5.15 HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs) 5.121

3PAR CIM API SMI-S Support 5.1

 CIM API Programming Reference InForm OS Version 2.3.1

5.16 FC Target Ports Subprofile 5.132

5.17 FC Initiator Ports Subprofile 5.132

5.18 iSCSI Target Ports Subprofile 5.133

5.19 Disk Drive Lite Subprofile 5.135

5.20 Block Server Performance Subprofile 5.137

The 3PAR CIM API supports the Storage Management Initiative Specification. The CIM API also
supports extensions to these profiles to provide features that are not available from the
standard profiles.

5.1 Standard Compliance

The 3PAR CIM Server has successfully completed testing and conforms to elements of the
Storage Networking Industry Association’s Conformance Testing Program (SNIA-CTP) for the
SMI specification.

For detailed information, please refer to:

http://www.snia.org/forums/smi/tech_programs/ctp/conformingproviders/
3PAR.html

5.2 SMI-S Functionality

SMI-S defines a number of services, profiles, and subprofiles that are used to manage elements
of a SAN. Each InServ Storage Server running InForm OS version 2.2.3 and beyond comes with
an embedded CIM Server that includes support for the profiles, subprofiles, and services as
described in the following sections.

5.2 Standard Compliance

 CIM API Programming Reference

5.3 Discovery Service

Table 5-1 lists the Discovery Service that is supported:

Table 5-1. Discovery Service

Service Version Purpose

Service Location SLPV2 Allows management applications to discover the location

Protocol (SLP) of CIM Servers and the supported capabilities of those
servers.

5.4 Supported Profiles

Table 5-2 lists supported profiles.

Table 5-2. Supported Profiles

Profile Version Purpose

Server Profile 1.1.0 Defines the capabilities of the CIM Server, including the
supported SMI-S Profiles and Subprofiles supported.

Array Profile 1.1.0 Describes RAID arrays and disk storage systems.

5.5 Supported Array Packages

Table 5-3 lists the supported packages that are mandatory for the Profiles in which they
appear:

Table 5-3. Supported Array Packages

Package Version Purpose

Block Services 1.1.0 Provides management of StorageVolumes and

StoragePools.

Discovery Service 5.3

 CIM API Programming Reference InForm OS Version 2.3.1

5.6 Supported Array Subprofiles

Table 5-4 lists the Supported Array Subprofiles:

Table 5-4. Supported Array Subprofiles

Subprofile Version Purpose

Location 1.1.0 Provides information about the physical location of a disk

storage system.

Multiple 1.1.0 Provides information about the multiple computer systems

Computer (controller nodes) that cooperate to present a virtual computer
System system (cluster).

Software 1.1.0 Provides information on installed controller software.

Masking and 1.1.0 Provides management of LUNs.

Mapping

FC Target Ports 1.1.0 Provides management of front end (host facing) Fibre Channel
ports.

FC Initiator 1.1.0 Provides management of back end (disk enclosure) FC ports.

Ports

iSCSI Target 1.1.0 Provides management of front end (host facing) iSCSI ports.
Ports

Disk Drive Lite 1.1.0 Provides management of disk drive devices.

Block Server 1.1.0 Provides performance statistics information for block servers.
Performance

Copy Services 1.1.0 Provides management of physical and virtual copies (remote
copy is not supported).

Job Control 1.1.0 Provides management of tasks related to Copy Services.

5.4 Supported Array Subprofiles

 CIM API Programming Reference

5.6.1 SMI-S Support by Release

Table 5-5 provides information on the level of SMI-S support for each of the releases of the
CIM Server.

Table 5-5. Supported SMI-S Levels by Release

SMI-S Version Profile Subprofile or Release Version

Package
2.2.2 2.2.3 2.2.4 2.3.1

1.0.2 Server Profile X X X X

Array Profile X X X X

Software X X X X

1.1.0 Server Profile X X X X

Array Profile X X X X

Software X X X X

Block Services X X X X

Masking and X X X X
Mapping

FC Target Ports X X X X

FC Initiator Ports X X X X

Location X X X X

Multiple X X X X
Computer System

Disk Drive Lite X X X X

iSCSI Target Ports X X X X

Block Server X X X
Performance

Supported Array Subprofiles 5.5

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-5. Supported SMI-S Levels by Release (continued)

SMI-S Version Profile Subprofile or Release Version

Package
2.2.2 2.2.3 2.2.4 2.3.1

Copy Services X

Job Control X

5.6.2 Discovery Service

The first step in managing an SMI-S enabled SAN is to discover its available resources (such as
the CIM servers). SMI-S defines Service Location Protocol v2 (SLPv2) as the discovery
mechanism. CIM clients use SLP to query for available CIM servers. CIM servers answer with
generic information about what services they provide and the URL at which these services
reside.

5.7 Server Profile

A CIM Server is anything that supports the CIM-XML protocol and supports the basic read
functional profile as defined by the CIM Operations over HTTP specification. After a CIM client
has discovered a CIM server within a SAN, it then needs to determine the services provided by
that server. The Server Profile defines the capabilities of the CIM Server. This includes the
communication mechanisms the CIM Server supports, the CIM namespaces that it manages,
and the SMI-S profiles and subprofiles that are supported. For a complete discussion on the
Server Profile model, please refer to SMI-S at http://www.snia.org.

5.6 Server Profile

 CIM API Programming Reference

5.7.1 Server Profile CIM Classes

Table 5-6 Lists the key Server Profile CIM classes:

Table 5-6. Server Profile CIM Classes

CIM Class Description

TPD_CIMXMLCommunicationMechanism Defines the communication protocols supported by

the CIM server.

TPD_Namespace Defines the CIM namespaces supported by the CIM

Server.

TPD_ObjectManager The CIM Object Manager service of the CIM Server.

TPD_RegisteredProfile One instance of this class exists for each SMI-S Profile
that is registered with the CIM Server.

TPD_RegisteredSubprofile One instance of this class exists for each SMI-S

Subprofile that is registered with the CIM Server.

TPD_StorageSystem The storage server that is hosting the CIM Server.

5.7.2 Supported Methods

Table 5-7 describes the currently supported method for TPD_StorageSystem:

Table 5-7. Method for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for the
StorageSystem.

Server Profile 5.7

 CIM API Programming Reference InForm OS Version 2.3.1

5.8 Array Profile

The Array profile models the physical and logical aspects of disk storage systems. The basic
Array profile provides a high level, read-only 'view' of a storage system. The mandatory Block
Services package and the various optional subprofiles extend this description and provide
additional management capabilities. For detailed information regarding the Array profile,
refer to SMI-S at http://www.snia.org.

5.8.1 Array Profile CIM Classes

Table 5-8 shows the CIM class for the Array profile:

Table 5-8. Array Profile CIM Class

Class Description

TPD_StorageSystem Represents the storage array as a whole. The Dedicated property

indicates this system operates as a storage array.

5.8.2 Supported Methods

Table 5-9 shows the supported method for TPD_StorageSystem:

Table 5-9. Method for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact

information for the StorageSystem.

5.8 Array Profile

 CIM API Programming Reference

5.9 Block Services Package

The Block Services package defines standards for viewing/managing storage capacity. This
includes managing StoragePools and allocating capacity from StoragePools to be used
by external consumers. With regards to 3PAR, implementation of this package provides the
ability to manage Storage Volumes on the InServ Storage Server.

For detailed information regarding the Block Services package, refer to

SMI-S at http://www.snia.org.

5.9.1 Block Services Package CIM Classes

Table 5-10 shows the key Block Services Package CIM classes:

Table 5-10. Block Services Package CIM Classes

Class Description

TPD_StorageSystem Represents the storage array as a whole.

TPD_StorageVolume Storage volumes that are equivalent to SCSI Logical

Units visible to consumers.

TPD_StoragePool Allocatable space on the array.

TPD_StorageSetting Used by clients as input to the

StorageConfigurationService,
StorageSetting describes the desired configuration
of Storage Volumes.

TPD_StorageCapabilities Provides information about the possible configuration

parameters for elements created from a given
StoragePool.

TPD_StorageConfigurationCapabilities Provides information about what storage configuration

functionality is provided by
StorageConfigurationService.

Block Services Package 5.9

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-10. Block Services Package CIM Classes (continued)

Class Description

TPD_StorageConfigurationService Allows clients to configure Storage Volumes.

TPD_DynamicStoragePool Storage Pool representing a Common Provisioning

Group (CPG).

5.9.2 Supported Methods

Table 5-11 - Table 5-14 shows the supported methods for the Block Services Package:

Table 5-11. Methods for TPD_StorageCapabilities

Method Description

CreateSetting() Provides the ability to create StorageSetting objects

for use in creating StorageVolumes.

GetSupportedStripeLengthRange() Returns the possible stripe lengths for this capability.

GetSupportedStripeDepths() Returns the possible stripe depths for this capability.

Table 5-12. Methods for TPD_StorageSetting

Method Description

modifyInstance() Provides the ability to modify a StorageSetting for

use in creating StorageVolumes.

deleteInstance() Provides the ability to delete a StorageSetting.

5.10 Block Services Package

 CIM API Programming Reference

Table 5-13. Methods for TPD_StorageConfigurationService

Method Description

CreateOrModifyElementFromStoragePool() Provides the ability to create or modify

StorageVolumes using a specific
StorageSetting from a source StoragePool.

ReturnToStoragePool() Provides the ability to remove StorageVolumes,

returning the capacity to the original
StoragePool.

CreateOrModifyStoragePool() Provides the ability to create or modify

DynamicStoragePool using a specific
StorageSetting from a source StoragePool.

DeleteStoragePool() Provides the ability to remove

DynamicStoragePool,
returning the capacity to the parent StoragePool.

Table 5-14. Method for TPD_StoragePool

Method Description

GetSupportedSizeRanges() Returns the supported size ranges for elements

allocated from this Pool.

Block Services Package 5.11

 CIM API Programming Reference InForm OS Version 2.3.1

5.9.3 StorageSetting
There are eight types of StorageSetting:

1 Pre-created StorageSetting for creating legacy or fully provisioned virtual volumes.

There are three of these, one for each RAID type, and each is associated to
3PAR:Capabilities:RAIDx StorageCapabilities. Their InstanceIDs are
3PAR:StorageSetting:RAIDx. A client can use StorageSetting to create a legacy or fully
provisioned virtual volume. Most Logical Disk (LD) and virtual volume-specific properties
are populated. For InForm OS release 2.3.1, a fourth instance is added for RAID-60.

2 Pre-created StorageSetting for creating DynamicStoragePool.

There are three of these, one for each RAID type, and each is associated to
3PAR:Capabilities:RAIDx StorageCapabilities. Their InstanceIDs are
3PAR:DynamicStoragePoolSetting:RAIDx. A client can use this StorageSetting to create
a DynamicStoragePool. Most LD properties are populated, but not those for virtual
volumes. For InForm OS release 2.3.1, a fourth instance is added for RAID-60.

3 Pre-created StorageSetting for creating Thinly Provisioned Virtual Volumes (TPVVs).

There are three of these, one for each RAID type, and each is associated to
3PAR:Capabilities:RAIDx StorageCapabilities. Its InstanceID is
3PAR:ThinProvisionedVolumeSetting:RAIDx. A client can use this StorageSetting for
creating a Thinly Provisioned (TP) virtual volume. Only virtual volume-related properties are
populated. For InForm OS release 2.3.1, a fourth instance is added for RAID-60.

4 Current StorageSetting of a virtual volume.

This StorageSetting contains the current configuration of a virtual volume. If the virtual
volume is a legacy volume, this Setting has a
StorageSettingAssociatedToCapabilities association to the
3PAR:Capabilities:RAIDx capabilities. If the virtual volume user space draws from a
DynamicStoragePool (DSP), then this Setting has a
StorageSettingAssociatedToCapabilities association to the “3PAR:Current Capabilities
for DynamicStoragePool <name> StorageCapabilities” of the DSP.

5 StorageSetting generated from “CreateSetting of 3PAR:Capabilities:RAIDx”

capabilities.

StorageSetting created this way is generic enough that it encompasses LD, virtual volume
and snap space specific properties. A client has to tailor the properties carefully to create
the element (DSP, legacy volume or new-style volume) it desires. This Setting has a

5.12 Block Services Package

 CIM API Programming Reference

StorageSettingGeneratedFromCapabilities association to the

“3PAR:Capabilities:RAIDx”capabilities.

6 StorageSetting generated from CreateSetting of “3PAR:Current Capabilities for

DynamicStoragePool” Capabilities.

StorageSetting created this way can be used by a client for user space or snap space of a
virtual volume. By default the ThinlyProvisioned property is set to FALSE. A client has to
modify this to TRUE if a TPVV is desired. This setting has a
StorageSettingGeneratedFromCapabilities association to the “3PAR:Current
Capabilities for DynamicStoragePool:RAIDx” Capabilities.

7 StorageSetting created by CreateInstance.

These StorageSetting contain values that are totally determined by the client who
created it. The most likely usage for this is if a client clones an existing fixed
StorageSetting and then modified some of the property values before creating it. This
Setting has a StorageSettingGeneratedFromCapabilities association to the appropriate
“3PAR:Capabilities:RAIDx” Capabilities according to the RAID type of the
StorageSetting.The default is RAID10.

8 Persistent StorageSetting/template.

StorageSetting (templates) that are stored in PR. The TemplateType and

TemplateForVolumeType properties of the StorageSetting restrict what kind of element
creation this setting can be applied to. This Setting has a
StorageSettingGeneratedFromCapabilities association to the appropriate
“3PAR:Capabilities:RAIDx” Capabilities according to the RAID type of the
StorageSetting.The Default is RAID10.

Relevant Properties of StorageSetting

Properties Description

Uint64 AllocationUnit Grow increment in bytes. When a TP StorageVolume or a

DynamicStoragePool grows on demand, the system
allocates this number of bytes on each allocation.

Uint64 AllocationUnitMax Maximum allocation unit in bytes.

Uint64 Minimum allocation unit in bytes.

AllocationUnitMin

Block Services Package 5.13

 CIM API Programming Reference InForm OS Version 2.3.1

Relevant Properties of StorageSetting (continued)

Properties Description

Uint64 Snap space limit in bytes. If SpaceLimit (in bytes) is greater

SpaceLimit than zero, the space consumed by the storage element shall
not exceed the value of SpaceLimit. For TP StorageVolume,
if SpaceLimit is zero, allocation limit is not enforced (e.g.
the volume can grow until the system runs out of space).

Uint16 Snap space limit warning in percentage of SpaceLimit.

SpaceLimitWarning When actual space allocated to the TP StorageVolume or
Threshold DynamicStoragePool hits this threshold, alerts are
generated. For example, if SpaceLimitWarningThreshold is
90% and SpaceLimit is 100GB, alerts are generated when
allocated space is 90GB or more.

Uint64 User space limit in bytes. If UserSpaceLimit (in bytes) is

UserSpaceLimit greater than zero, the space consumed by the storage
element shall not exceed the value of UserSpaceLimit. For
TP StorageVolume, if UserSpaceLimit is zero, allocation
limit is not enforced (e.g. the volume can grow until the
system runs out of space).

Uint16 User space limit warning in percentage of UserSpaceLimit.

UserSpaceLimitWarning When the actual space allocated to the TP StorageVolume or
Threshold DynamicStoragePool hits this threshold, alerts are
generated. For example, if
UserSpaceLimitWarningThreshold is 90% and
UserSpaceLimit is 100GB, alerts are generated when
allocated space is 90GB or more.

5.14 Block Services Package

 CIM API Programming Reference

Relevant Properties of StorageSetting (continued)

Properties Description

Uint32 TP volume user space allocation warning in percentage of

UserSpaceAllocationWarning volume size. If this is set,
UserSpaceLimitWarningThreshold is ignored.
UserSpaceLimitWarningThreshold calculation requires
UserSpaceLimit, which may not be specified.
UserSpaceAllocationWarning thus allows a percentage to
be specified without requiring UserSpaceLimit to be
specified (in CLI, one can specify –usr_aw option without
specifying –usr_al option). Applies only to TPVVs.

Uint32 Volume snap space allocation warning in percentage of

SnapSpaceAllocationWarning volume size. If this is set, SpaceLimitWarningThreshold is
ignored. SpaceLimitWarningThreshold calculation requires
SpaceLimit, which may not be specified.
SnapSpaceAllocationWarning thus allows a percentage to
be specified without requiring SpaceLimit to be specified
(in CLI, one can specify –snp_aw option without specifying
–snp_al option).

Uint64 Warning alert is issued if snap space of a CPG exceeds

DSPSnapSpaceGrowWarning DSPSnapSpaceGrowWarning. 0 means no warning limit is
enforced. This value is in bytes. Applies to
DynamicStoragePool only.

Uint16 Describes how the elements are used. For example, if a new
IntendedUsage TP StorageVolume is used for snap shot, this value is 7.
The default value is 0 (“not specialized”).

Block Services Package 5.15

 CIM API Programming Reference InForm OS Version 2.3.1

Relevant Properties of StorageSetting (continued)

Properties Description

Uint16 Generates a low space indication and applies only when

LowSpaceWarningThreshold creating a DynamicStoragePool. If non-zero, a low space
indication is generated when RemainingManagedSpace
of DynamicStoragePool <= (TotalManagedSpace of
DynamicStoragePool*LowSpaceWarningThreshold)/
100. If it is zero, no indication is generated. Unit is in
percentage. This corresponds to the -aw option of the CLI
createcpg command.

Boolean True if the corresponding volume is thinly provisioned.

ThinlyProvisioned

Uint16 Type of template to be created (VV or CPG).

TemplateType

Uint16 Type of VV template to be created (TPVV, CPVV or all).

TemplateForVolumeType

Uint16 The type of thin provisioned pool used when

ThinProvisionedPoolType StorageSetting is used a goal for creating a thin
provisioned pool. In other contexts, this property is
undefined. The possible values match the appropriate values
in
StorageConfigrationCapabilities.SupportedStorageEl
ementTypes.

5.16 Block Services Package

 CIM API Programming Reference

Table 5-15. Matrix of Populated Properties for Different Types of StorageSetting

Properties Default Vaules for Each StorageSetting Type

Legacy DynamicStorage Thin Generated from Generated from

Volume Pool Setting Provisioned “3PAR:Capabilities: “3PAR:Current
Setting Volume RAIDx” CreateSetting Capabilities for
Setting DynamicStoragePool”
CreateSetting

ThinlyProvisioned F NULL T F F

AllocationUnit NULL Default NULL Default NULL

AllocationUnitMax NULL Max NULL Max if goal NULL

setting
Default if
default
setting.

AllocationUnitMin NULL Min NULL Min if goal NULL

setting
Default if
default
setting.

SpaceLimit NULL 0 NULL 0 0

SpaceLimitWarning NULL 0 NULL 0 0

Threshold

UserSpaceLimit NULL NULL NULL NULL NULL

UserSpaceLimit NULL NULL NULL NULL NULL

WarningThreshold

UserSpace NULL NULL NULL NULL NULL

AllocationWarning

SnapSpace NULL NULL NULL NULL NULL

AllocationWarning

Block Services Package 5.17

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-15. Matrix of Populated Properties for Different Types of StorageSetting (continued)

Properties Default Vaules for Each StorageSetting Type

Legacy DynamicStorage Thin Generated from Generated from

Volume Pool Setting Provisioned “3PAR:Capabilities: “3PAR:Current
Setting Volume RAIDx” CreateSetting Capabilities for
Setting DynamicStoragePool”
CreateSetting

LowSpace NULL 0 NULL NULL NULL

WarningThreshold

DSPSnapSpace NULL 0 NULL NULL NULL

GrowWarning

LD Parameters Default Default NULL Default NULL

(e.g., rs, ss, ha,
pattern etc.)

Volume Parameters Default NULL Default Default Default

(e.g., spt, hpc,
policy etc.)

TemplateType Volume CPG Volume Volume Volume

TemplateFor Any NULL TPVV NULL Any

VolumeType

ThinlyProvisioned NULL ThinlyProvi NULL NULL NULL

PoolType sionedLimi
tlessStorag
ePool (9)

5.9.4 Creating a DynamicStoragePool (DSP) via SMI-S

Creating a DynamicStoragePool is a two-step process:

1 Choose or create a StorageSetting instance using CreateSetting().

‹ If choosing a pre-created one, a client should use a StorageSetting with

InstanceID=”3PAR:DynamicStoragePoolSetting:RAIDx”.

5.18 Block Services Package

 CIM API Programming Reference

‹ If generating a StorageSetting, a client should invoke the CreateSetting method on

one of the StorageCapabilties with InstanceID=”3PAR:Capabilities:RAIDx”.

‹ By default, StorageSetting.ThinProvisionedPoolType is set to

ThinlyProvisionedLimitlessStoragePool(9), which creates a DSP with limitless
capacity.

‹ The size parameter to CreateOrModifyStoragePool is ignored.

‹ A client can also set ThinProvisionedPoolType to

ThinlyProvisionedQuotaStoragePool (8), which means there is an upper limit to
how big the DSP can grow. For this, the Size parameter has to be specified and non-
zero.

‹ ThinProvisionedPoolType cannot be set to

ThinlyProvisionedAllocatedStoragePool (7) since this is not supported.

2 Invoking the StorageConfigurationService’s CreateOrModifyStoragePool method: a

client passes in the StorageSetting obtained in step 1 and other relevant input
parameters to create a DynamicStoragePool.

‹ The input StorageSetting can be deleted by StorageSetting.DeleteInstance, or it

can be made persistent via ModifyInstance of the StorageSetting.ChangeableType
property to “Persistent” and StorageSetting.TemplateType property to
“DynamicStoragePool”.

‹ The method CreateOrModifyStoragePool (existing method) of

StorageConfigurationService is used to create a DynamicStoragePool (DSP). Only
DynamicStoragePool can be created; concrete pool cannot be created.

The method signature is described below:

uint32 CreateOrModifyStoragePool (
[In] String ElementName,
[Out] CIM_ConcreteJob ref Job,
[In] StorageSetting ref Goal,
[In, Out] Uint64 Size,
[In] String InPools[],
[In] String InExtents[],
[In, Out] DynamicStoragePool ref Pool);

„ ElementName - The end user’s input name of the DynamicStoragePool (CPG) to be

created.

Block Services Package 5.19

 CIM API Programming Reference InForm OS Version 2.3.1

„ Job - Is always NULL.

„ Goal - This is an instance of StorageSetting describing characteristics of the desired

DynamicStoragePool. If it’s NULL, the provider picks the default setting. The
ThinProvisionedPoolType property specifies what type of DSP to create:
(ThinlyProvisionedQuotaStoragePool(8) for a DSP with an upper limit, or
ThinlyProvisionedLimitlessStoragePool(9) for a DSP with no upper bound).

„ Size - The virtual size of the DynamicStoragePool. On initial creation, the system does
not allocate any space to the pool. The minimum unit (the grow increment) is allocated for
this pool only after a volume is created off this pool. If the DSP has a size limit, then
ThinProvisionedPoolType property in Goal has to be set to
ThinlyProvisionedQuotaStoragePool(8). To create a “limitless” DynamicStoragePool
(e.g., creating a CPG without specifying the size), the ThinProvisionedPoolType property
in Goal has to be set to ThinlyProvisionedLimitlessStoragePool(9), and this
parameter is ignored.

„ InPools - This shall contain an array of StoragePool where the new pool is to be created
from. However, only support creation from “3PAR:all-FC” or “3PAR:all-NL” pools is
supported. Therefore, this array should contain only one element. If any other values are
passed in, an “Invalid Parameter” error is returned.

„ InExtents - This should be a null array because creating DynamicStoragePool from

StorageExtents is not supported. Non-null values are ignored.

„ Pool - It should be null as an input to create a new DynamicStoragePool. Upon method

completion, it contains the object path of the newly created DynamicStoragePool. If it’s
not null, it refers to an existing DynamicStoragePool whose properties are being modified
based on the input Goal (StorageSetting).

Table 5-16. DynamicStoragePool Possible Return Values

ValueMap Values Explanation/Notes

0 Job Completed with No Error

1 Not supported

2 Unknown

3 Timeout

5.20 Block Services Package

 CIM API Programming Reference

Table 5-16. DynamicStoragePool Possible Return Values (continued)

ValueMap Values Explanation/Notes

4 Failed

5 Invalid parameter

6 In Use

4097 Size Not Supported

5.9.4.1 Relevant Properties of DynamicStoragePool

Table 5-17. Relevant Properties of DynamicStoragePool

Properties Description

string A unique ID within the storage array. The user’s defined

PoolID name is used as an identifier.
Note: DSP does not have a WWN because it’s not
considered a physical entity.

Uint64 This is the actual allocated size to the DSP (not the
TotalManagedSpace logical size).
Logical size is denoted by SpaceLimit.

Uint16 The unit is a percentage. If it’s zero, no alert is

LowSpaceWarningThreshold generated. If it’s non-zero, an indication is generated
(percentage) when RemainingManagedSpace <=
(TotalManagedSpacet*LowSpaceWarningThreshold)/
100.

Unit64 This is the grow increment. When a TP StorageVolume

AllocationUnit or a DynamicStoragePool grows on demand, the
(bytes) system allocates this number of bytes on each
allocation.

Block Services Package 5.21

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-17. Relevant Properties of DynamicStoragePool (continued)

Properties Description

Uint16 Defines the approach associated with the pool for

SpaceLimitDetermination determining capacity information for the pool.
Allocated (2) means that the advertised capacity is the
same as the actual capacity. Quota (3) means that there
is an administratively defined limit (SpaceLimit) on the
capacity that may be used to create or expand child
elements. Limitless (4) means that there is no defined
limit on the capacity for creating or expanding children.

Uint64 The capacity of the storage allocated to the pool when

SpaceLimit SpaceLimitDetermination has the value 3 (Quota) or 4
(Limitless) or is set to the value of TotalManagedSpace if
SpaceLimitDetermination has the value 2 (Allocated).
In the case of Limitless, SpaceLimit is set to 1PB, the
maximum allowed by the InServ Storage Server.

Uint64 The size of metadata consumed by this storage pool.

ThinProvisionMetaDataSpace This is only defined if the pool is thin provisioned.
(bytes)

Uint64 This is the current number of bytes being used by all TP

CurrentSpaceConsumed StorageVolumes (RAID overhead already taken into
(bytes) account) allocated from this pool. For example, a RAID-
1 CPG with 50 GB being allocated to TPVVs. The
CurrentSpaceConsumed is 50 GB.

Uint64 This is the nominal number of bytes allocated on disk

ConsumedSnapDataSpace for Snapshot data (SD) of this pool, not including RAID
(bytes) overhead.

Uint64 This is the actual number of bytes allocated on disk for

ConsumedSnapDataSpacePlusMet Snapshot data (SD) space of this pool, including RAID
aData (bytes) overhead.

5.22 Block Services Package

 CIM API Programming Reference

Table 5-17. Relevant Properties of DynamicStoragePool (continued)

Properties Description

Uint64 This is the nominal number of bytes allocated on disk

ConsumedSnapAdminSpace for Snapshot admin (SA) of this pool, not including RAID
(bytes) overhead.

Uint64 This is the actual number of bytes allocated on disk for

ConsumedSnapAdminSpace SA space of this pool, including RAID overhead.
PlusMetaData (bytes)

Uint64 The remaining usable capacity after the allocation of TP

RemainingManagedSpace StorageVolumes. It is calculated as follows:
(bytes) RemainingManagedSpace=SpaceLimit(virtual
size)–CurrentSpaceConsumed.

Uint32 This method returns the maximum and minimum size,

GetSupportedSizeRange() in bytes, of a StorageVolume that can be created off
this DSP. Only the "StorageVolume" value is accepted
for the ElementType parameter.

Uint32 This method is not supported.

GetSupportedSizes()

Uint64 Issue warning alert when space allocation exceeds this

SnapDataSpaceWarningLimit amount. A size of 0 means no warning limit is enforced.
(bytes) Default is 0.

5.9.4.2 Modifiable StorageSetting Properties for DSP

When creating or modifying a DSP, a client can change the following StorageSetting
properties to a non-default value. The provider ignores all other properties.

Block Services Package 5.23

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-18. Summary of Modifiable StorageSetting Properties for DSP

CLI
StorageSetting Property Equivalence Comment

SpaceLimit -sdgl

SpaceLimitWarningThreshold/ -sdgw If both the DSPSnapSpaceGrowWarning and

DSPSnapSpaceGrowWarning SpaceLimitWarningThreshold properties
are specified, DSPSnapSpaceGrowWarning
takes precedence. This is because
SpaceLimitWarningThreshold is in
percentage of SpaceLimit (whereas
DSPSnapSpaceGrowWarning is in bytes), and
for the InServ Storage Server, we set the
absolute limit, not in percentage, hence the
need for proprietary property
DSPSnapSpaceGrowWarning.
If DSPSnapSpaceGrowWarning is NULL and
BOTH SpaceLimitWarningThreshold and
SpaceLimit are specified, the numbers are
converted to bytes for internal usage.

LowSpaceWarningThreshold -aw

AllocationUnit -sdgs

Domain -domain Can only be specified during creation; is

ignored for modification operation.

DataRedundancyGoal -ssz Modifiable only for RAID-10.

ParitySetSize -ssz Modifiable only for RAID-50 and RAID-60.

ExtentStripeLength -rs Row size.

UserDataStripeDepth -sz Step size.

HighAvailability -ha

5.24 Block Services Package

 CIM API Programming Reference

Table 5-18. Summary of Modifiable StorageSetting Properties for DSP (continued)

CLI
StorageSetting Property Equivalence Comment

ChunkletLocationPreference -ch

Disk pattern properties -p e.g. DiskPrimPathNodes, DiskPrimRPM, etc.

Corresponding Template -templ Only if using persistent StorageSetting,

properties i.e., template.

ThinProvisionedPoolType Only Quota (if sdgl is specified) and Limitless

(if no sdgl is specified) are supported.

5.9.4.3 StorageCapabilities of DynamicStoragePool

After a DSP is created, an instance of StorageCapabilities is created, and the
StorageSetting properties that are used to create the DSP are copied into this
StorageCapabilities, which is then bound to the DSP via a CapabilitiesOfStoragePool
association.

5.9.4.4 StoragePoolConfigurationCapabilities of DynamicStoragePool

After a DSP is created, an instance of StoragePoolConfigurationCapabilities is created
and is associated to the DSP via a CapabilitiesOfStoragePoolConfiguration association.

As a matter of fact, each StoragePool in the system (TPD_StoragePool, either primordial or

concrete, TPD_DynamicStoragePool and TPD_DeltaReplicaStoragePool) has an associated
StoragePoolConfigurationCapabilities instance.

There are four instances per system, one for each kind of StoragePool: PrimordialPool,
ConcretePool, DynamicStoragePool and DeltaReplicaStoragePool.

Block Services Package 5.25

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-19. Instances for StoragePoolConfigurationCapabilities

Storage PoolConfigurationCapabilities

Primordial ConcretePool DynamicStoragePool DeltaReplica

Pool StoragePool

SupportedSynchronous NULL Storage Pool Storage Element NULL

Actions Creation (2), Creation (5), Storage
Storage Pool Element Return (6),
Deletion (3), Storage Element
Storage Pool Modification (7).
Modification (4).

SupportedStoragePool NULL Single InPool (3) NULL NULL

Features

SupportedStorage NULL StorageVolume StorageVolume NULL

ElementFeatures Creation (3), Creation (3),
StorageVolume StorageVolume
Modification (5), Modification (5),
Single InPool (6). Single InPool (6).

SupportedStorage NULL StorageVolume (2), StorageVolume (2), NULL

ElementTypes ThinlyProvisionedQ ThinlyProvisioned
uotaStoragePool StorageVolume (5).
(8),
ThinlyProvisioned
LimitlessStorage
Pool (9).

5.9.5 Creating a Volume Through SMI-S

There are two extrinsic methods required to create a volume. The CreateSetting method in
TPD_StorageCapabilities class generates the settings that are used to create the Volume,
and the CreateOrModifyElementFromStoragePool method in
TPD_StorageConfigurationService class creates, modifies or grows the volume with the
StorageSetting instance created by the CreateSetting method. The
ReturnToStoragePool method is used to delete a volume.

5.26 Block Services Package

 CIM API Programming Reference

Additionally, you can use the intrinsic method with the TPD_StorageSetting class. The
ModifyInstance method is used to modify the StorageSetting properties that are
returned by the CreateSetting method.

Beginning with InForm OS 2.3.1, a new method

TPD_CreateOrModifyElementFromStoragePools can also be used to create, modify, and grow
virtual volumes. This method is similar to CreateOrModifyElementFromStoragePool, but
instead of the InPool parameter, there is an InPools parameter which accepts an array of
references to StoragePool, with the first element containing reference to the parent pool from
which the volume allocate its user space, and the second element containing reference to the
parent pool from which the volume allocate its snap space.

Block Services Package 5.27

 CIM API Programming Reference InForm OS Version 2.3.1

5.9.5.1 Supported Method For Creating a Storage Volume

Table 5-20 describes the supported method for creating a volume:

Table 5-20. Method for TPD_StorageConfigurationService

Method Description

CreateOrModifyElementFromStorage Allows clients to create a StorageVolume.

Pool()

5.9.5.1.1 Method Signature

The method signature for InForm OS 2.2.4 and prior versions is described as follows:

uint32 CreateOrModifyElementFromStoragePool (
[In] String ElementName,
[In,
Values {“StorageVolume”, “StorageExtent”, “LogicalDisk” },
ValueMap{”2”,”3”, “4”}]
Uint16 ElementType,
[Out] CIM_ConcreteJob ref Job,
[In] CIM_StorageSetting ref Goal,
[In, Out] Uint64 Size,
[In] CIM_StoragePool ref InPool,
[In, Out] CIM_LogicalElement ref TheElement);

5.28 Block Services Package

 CIM API Programming Reference

The method signature for InForm OS 2.3.1 is described as follows:

uint32 CreateOrModifyElementFromStoragePool (
[In] String ElementName,
[In,
Values {“StorageVolume”, “StorageExtent”, “LogicalDisk”,
"ThinlyProvisionedStorageVolume",
“ThinlyProvisionedLogicalDisk",
"ThinlyProvisionedAllocatedStoragePool",
"ThinlyProvisionedQuotaStoragePool",
"ThinlyProvisionedLimitlessStoragePool"},
ValueMap{”2”,”3”,“4”,”5”,”6”,”7”,”8”,”9”}]
Uint16 ElementType,
[Out] CIM_ConcreteJob ref Job,
[In] CIM_StorageSetting ref Goal,
[In, Out] Uint64 Size,
[In] CIM_StoragePool ref InPool,
[In, Out] CIM_LogicalElement ref TheElement);

„ ElementName: The name of the volume to be created or expanded.

„ ElementType: This enumeration specifies what type of object to create.

‹ For InForm OS 2.2.4 and prior: only StorageVolume(2) is supported.

‹ For InForm OS 2.3.1 and later, StorageVolume(2) and

ThinlyProvisionedStorageVolume(5) are supported. If the InPool parameter
contains a reference to a concrete pool, this can only be StorageVolume(2).

„ Job: If a Job was created as a side-effect of the execution of the method, then a reference
to that Job is returned through this parameter. Job control is not supported. This output
parameter is always NULL.

„ Goal: This is the Service Level that the StorageVolume option is expected to provide. The
Setting is a subset of the Capabilities available from the parent StoragePool. The Goal can
be a null value, in which case the default Setting for the Pool is used. The Goal can refer to
one of the preexisting StorageSetting instances representing RAID types, or the
StorageSetting generated by a CreateSetting method, or from a StorageSetting
option that is associated with another existing StorageVolume option.

Block Services Package 5.29

 CIM API Programming Reference InForm OS Version 2.3.1

„ Size: As an input, this is the desired logical size in bytes of the StorageVolume. If it is not
possible to create a volume of the desired size, a return code of Size not supported is
returned with the size set to the nearest supported size. If it’s a growing volume request,
the size is the new size of the volume. As an output, size is the actual size allocated for the
volume. It might be a little larger than the input size because the allocation unit is based on
chunklet size (256 MB).

„ InPool: This option contains the reference to the source StoragePool.

‹ For InForm OS release 2.2.4 and prior, the only correct input is the reference to
Concrete pool. If something else is passed in, this method throws an invalid parameter
exception. There are two kinds of concrete pools: Fibre Channel (FC) pool and Nearline
(NL) pool. If this parameter is NULL, then by default StorageVolume is created from FC
pool.

‹ For release 2.3.1 and later, this can either be a reference to Concrete pool or
DynamicStoragePool. If this contains a reference to Concrete pool, then only a fully
provisioned volume can be created and the ElementType has to be set to
StorageVolume(2). If this contains a reference to DynamicStoragePool, then the
volume that is created is a fully provisioned volume, if the ElementType is set to
StorageVolume(2), or TPVV, if ElementType is set to
ThinlyProvisionedStorageVolume(5). It is not valid to have a combination of
ThinlyProvisionedStorageVolume(5) for the ElementType and a reference to the
Concrete pool for InPool parameter. If this parameter is NULL and ElementType is set
to StorageVolume(2), then by default StorageVolume is created from FC pool.

„ TheElement: As an input, if it’s not null, the method is called to modify (either set or grow)
the existing StorageVolume. If it’s null (on input), the method is called to create a new
StorageVolume. As an output, it contains the newly created StorageVolume options.

Table 5-21 shows the return values for CreateOrModifyElementFromStoragePool():

Table 5-21. Return Values for CreateOrModifyElementFromStoragePool()

ValueMap Values Explanation/Notes

0 Job Completed with No Error

4 Failed

5.30 Block Services Package

 CIM API Programming Reference

Table 5-21. Return Values for CreateOrModifyElementFromStoragePool()

ValueMap Values Explanation/Notes

5 Invalid Parameter

4097 Size Not Supported A volume with the specified size

cannot be created or grown.

5.9.5.2 Creating Data and Snapshot Space from Two Storage Pools
Table 5-22 shows the supported method for creating data and snapshot space from two
storage pools:

Table 5-22. Method for TPD_StorageConfigurationService

Method Description

TPD_CreateOrModifyElementFrom Supports data and snapshot spaces, allocating

StoragePools space from two different
DynamicStoragePools. This method can also
be used to modify existing TP
StorageVolume, for example, increasing its
size or changing other properties.

This method is useful for creating a default volume that has snap space without the need for
specifying a Goal parameter.

This method can also be used to create fully-provisioned volumes that draw user space from a
DSP.

NOTE: This method does not support creating a legacy volume where user space
is allocated from a concrete “all” pool, although
CreateOrModifyElementFromStoragePool still supports this.

5.9.5.2.1 Method Signature for CreateOrModifyElementFromStoragePools

The method signature for CreateOrModifyElementFromStoragePools is described as
follows:

Block Services Package 5.31

 CIM API Programming Reference InForm OS Version 2.3.1

uint32 TPD_CreateOrModifyElementFromStoragePools (

[In] String ElementName,

[In,
Values
{“StorageVolume”,“ThinlyProvisionedStorageVolume”},
ValueMap{”2”, “5”}]
Uint16 ElementType,
[Out] CIM_ConcreteJob ref Job,
[In] CIM_StorageSetting ref Goal,
[In] CIM_StoragePool ref InPools[],
[In, Out] Uint64 Size,
[In, Out] CIM_LogicalElement ref TheElement);

„ ElementName: The name of the TP StorageVolume (TPVV) or StorageVolume (CPVV)

to be created.

„ ElementType: This enumeration specifies what type of object to create. StorageVolume

(2) and ThinlyProvisionedStorageVolume (5) are supported. If other values are passed
in, the provider should throw an “operation not supported” exception.

„ Job: If a Job was created as a side-effect of the execution of the method, a reference to
that Job is returned through this parameter. Job control is not supported. This output
parameter is always NULL.

„ InPool: This array contains string references (object path) of DynamicStoragePool where
the volume draws space. The first element contains DynamicStoragePool for user data. The
second element contains a DynamicStoragePool for snapshot space. The snapshot space
properties (allocation warning and space limit threshold, etc …) from each pool are
described in the corresponding Goals array. For TPVV or CPVV, the array size may be two,
even if both its user and snap space are drawn from the same DSP. For a fully-provisioned
volume or a TPVV that is not a CPVV, the array size must be one, corresponding to only the
user space. InPools cannot contain anything other than DynamicStoragePool.

„ Goal: This contains object path of StorageSetting, describing quality of service the new
StorageVolume must provide.

5.32 Block Services Package

 CIM API Programming Reference

„ Size: As an input, this is the desired logical size in bytes of the TP StorageVolume or the
requested size of the StorageVolume. If it is a modification request, “Size” is the new size
which must be greater than the existing size (e.g. volume can grow, but can not shrink). For
TP StorageVolume, the system actually allocates only minimum disk space to back up the
volume. More space is allocated on demand as more write data occur. The allocation unit
for each space allocation is the “growth increment” size. The system continues to allocate
more space until either the system runs out of disk space or maximum allocation of the
volume (SpaceLimit) is reached.

„ TheElement: Should be null as an input to create a new TP StorageVolume or

StorageVolume. Upon method completion, it contains the object path of the newly created
TP StorageVolume. If it’s not null, it refers to the TP StorageVolume to be modified (e.g.,
changing size, allocation warning, etc.).

Table 5-23 shows the return values for TPD_CreateOrModifyElementFromStoragePools():

Table 5-23. Return Values for TPD_CreateOrModifyElementFromStoragePools ()

ValueMap Values Explanation/Notes

0 Job Completed with No

Error

1 Not supported

2 Unknown

3 Timeout

4 Failed

5 Invalid Parameter

6 In Use

4097 Size Not Supported

Block Services Package 5.33

 CIM API Programming Reference InForm OS Version 2.3.1

5.9.5.3 CreateSetting
Table 5-24 shows the method forTPD_StorageCapabilities.CreateSetting:

.
Table 5-24. Method for TPD_StorageCapabilities.CreateSetting

Method Description

CreateSetting() Allows clients to create a new StorageSetting

instance based on existing instances.

This method returns a new instance to the client with default property values. There are four
instances of StorageCapabilities (one for each RAID type). The type of StorageSetting
the client wants to create is determined by the referenced StorageCapabilities. For
example, if the client invokes CreateSetting() method on a RAID-0
StorageCapabilities instance, then a RAID-0 StorageSetting instance is returned. The
client can use intrinsic method ModifyInstance() to customize the properties as needed.

Uint32 CreateSetting (
[in] uint16 SettingType,
[Out] CIM_StorageSetting REF NewSetting);

„ SettingType (in): If 'Default' (2) is passed, the Max, Goal, and Min setting attributes are
set to the Default values of the parent StorageCapabilities option when the instance is
created. If they are set to 'Goal' (3), the new StorageSetting attributes are set to the
related attributes of the parent StorageCapabilities options, such as Min to Min, Goal
to Default, and Max to Max.

„ NewSetting (out): Reference to a new StorageSetting instance based on the parent

StorageCapabilities. For example, if the parent StorageCapabilities option is the
RAID-0 instance, then this instance is a copy of the pre-created RAID-0 StorageSetting
instance.

5.34 Block Services Package

 CIM API Programming Reference

Table 5-25 shows the possible return values for CreateSetting():

Table 5-25. Return Values for CreateSetting ()

ValueMap Values Explanation/Notes

0 Method Completed OK

4 Failed

5 Invalid Parameters

5.9.5.4 Creating a Volume with a Default Setting

A volume can be created using one of the fixed StorageSetting from the four available
RAID types. The volume is then created with the default values associated with each RAID type.
If no StorageSetting reference is passed into CreateOrModifyElementFromStoragePool,
then a volume with default RAID-10 properties are created. To create a volume with FC drives,
use reference to FC StoragePool as the InPool parameter. To create a volume with NL drives,
use reference to NL StoragePool as the InPool parameter. To create a legacy volume with
SSD’s, use reference to SSD StoragePool as the InPool parameter [3.1.1]. To create a thinly
provisioned volume or a fully provisioned volume that allocates from a DynamicStoragepool,
use reference to DynamicStoragePool as the InPool parameter; for TPVV, the ElementType
parameter should be set to ThinlyProvisionedStorageVolume(5). For fully provisioned
volume, the ElementType parameter should be set to StorageVolume(2). If the InPool
parameter is NULL, by default FC drives are used to create the volume.

The fixed TPD_StorageSetting instances can be found by walking the

StorageSettingAssociatedToCapabilities association from
TPD_StorageCapabilities.

5.9.5.5 Creating a Volume with a Non-Default Setting

The following are the steps necessary for an SMI-S client to create a volume with non-default
settings:

1 Invoke the CreateSetting method to get at a reference to the TPD_StorageSetting.

The InServ SMI-S provider creates, if one does not exist, an instance of the default or goal
TPD_StorageSetting, depending on the value in the SettingType option. If one
already exists, the provider simply returns a reference to that instance. This instance is
transient only and does not persist across reboots. The client then performs a GetInstance

Block Services Package 5.35

 CIM API Programming Reference InForm OS Version 2.3.1

to obtain the instance of the TPD_StorageSetting in order to examine the properties. If

the values are OK, then it should be used as the ‘Goal’ parameter for the
CreateOrModifyElementFromStoragePool method. If not, continue with the next step.

2 If you would like to change the value of some or all of the properties in the
TPD_StorageSetting instance from step 1, then you should call the ModifyInstance
method to modify them.

3 Call the CreateOrModifyElementFromStoragePool method with the reference to the

TPD_StorageSetting from step 1 or 2 as the Goal parameter.

‹ To create a volume with FC drives, use a reference to the FC StoragePool as the

InPool parameter.

‹ To create a volume with NL drives, use a reference to the NL StoragePool as the

InPool parameter.

‹ To create a thinly provisioned volume or a fully provisioned volume that allocates from
a DynamicStoragepool, use reference to DynamicStoragePool as the InPool
parameter. For a TPVV, the ElementType parameter should also be set to
ThinlyProvisionedStorageVolume (5).

‹ For a fully provisioned volume, the ElementType parameter should be set to

StorageVolume(2).

‹ If the InPool parameter is NULL, by default, the FC drives are used to create the
volume.

‹ The parameter TheElement has to be NULL.

4 You can optionally call DeleteInstance on the TPD_StorageSetting instance from step
1 or 2 to delete it.

5.36 Block Services Package

 CIM API Programming Reference

Table 5-26. Parameters for the CreateOrModifyElementFromStoragePool Method

Operations/Parameters Create Volume Grow/Set Volume

ElementName Name of Volume New name of volume; NULL

means no change in volume
name.

ElementType 2 (Storage Volume) 2

5 (Thinly Provisioned Storage 5 (Thinly Provisioned Storage
Volume) Volume).

Goal Reference to either fixed Reference to a

TPD_StorageSetting or one TPD_StorageSetting instance
created through the containing new parameter
CreateSetting option; values; NULL means no change
defaults to fixed RAID-10 if NULL in StorageSetting parameters.

Size (bytes) Minimum 268435456 (256 MB) Must be larger than the current
volume size; NULL means the
volume is not grown.

InPool Reference to all-FC or all-NL pool NULL.

of DynamicStoragePool;
defaults to all-FC pool if NULL

TheElement NULL Reference to an existing

TPD_StorageVolume.

5.9.5.6 Creating a Volume with Disk Pattern Filtering

Disk pattern filtering can be achieved using the 3PAR extension properties to the
TPD_StorageSetting class (refer to the following table). Each of these properties are
defined as an array, with each array set representing a set of patterns, so for example if a client
wants to provide for 2 sets of patterns, the array size of these properties must all be 2.
Properties that are not applicable must be set to either empty string for string type or –1 for
integer type.

The format for the string is the same as that for the CLI as described in the Table 5-27:

Block Services Package 5.37

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-27. Disk Pattern CIM Properties

Disk Pattern CIM Property Name

(from TPD_StorageSetting class) CIM Property Type CLI Equivalent Format

DiskPrimPathNodes String array -nd <item>

DiskPrimPathPCISlots String array -st <item>

DiskPrimPathPorts String array -pt <item>

DiskCages String array -cg <item>

DiskMagazines String array -mg <item>

DiskMagPositions String array -pn <item>

DiskIDs String array -dk <item>

DiskTotalChunkletGT Signed Integer -tc_gt an integer

array

DiskTotalChunkletLT Signed Integer -tc_lt an integer

array

DiskFreeChunkletGT Signed Integer -fc_gt an integer

array

DiskFreeChunkletLT Signed Integer -fc_lt an integer

array

DiskPackageModels String array -devid <id>,<id>,..

DiskRPM Signed Integer -rpm an integer

array

Where an item is:

<nb> – nb is an integer.

<item>,<item> – an item is a list of items.

5.38 Block Services Package

 CIM API Programming Reference

<nb>-<nb> – an item is a range of integers

5.9.5.7 Summary of Different Types of Volumes That Can Be Created

Table 5-28 outlines the types of volumes that are created based on the input InPool and Goal
parameter to CreateOrModifyElementFromStoragePool()or InPools and Goal parameter to
TPD_CreateOrModifyElementFromStoragePools().

Block Services Package 5.39

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-28. Volumes Created Based on Parameters to CreateOrModifyElementFromStoragePool()

Type of Volume Created CreateOrModifyElementFrom TPD_CreateOrModify

StoragePool ElementFromStorage
Pools

Legacy volume, where 1 ElementType == NULL or Not supported.

user space draws from StorageVolume (2).
“3PAR:all-FC” (default), 2 InPool == NULL or concrete
“3PAR:all-NL”, or pool.
“3PAR:all-SSD” [3.1.1] 3 Goal == NULL or DSPName
concrete pool. property not set. Neither
Goal.SnapVolumeSize nor
Goal.SnapVolume
Percentage can be set. Goal, if
present, contains also all the LD
parameters (e.g., set size, row
size, etc.).

Legacy volume with 1 ElementType == NULL or Not supported.

static snap space, StorageVolume (2).
where user and snap 2 InPool == NULL or concrete
space both draw from pool.
the same “3PAR:all-FC” 3 Either Goal.SnapVolumeSize or
(default), “3PAR:all- Goal.SnapVolumePercentage is
NL”, or “3PAR:all-SSD” set (both cannot be set).
[3.1.1] concrete pool.
Goal.DSPName cannot be set.

Goal, if present, contains all the

LD parameters (e.g., set size, row
size, etc.).

5.40 Block Services Package

 CIM API Programming Reference

Table 5-28. Volumes Created Based on Parameters to CreateOrModifyElementFromStoragePool()

Type of Volume Created CreateOrModifyElementFrom TPD_CreateOrModify

StoragePool ElementFromStorage
Pools

Legacy CPVV, where 1 ElementType == NULL or Not supported.

user space draws from StorageVolume (2).
“3PAR:all-FC” (default), 2 InPool == NULL or concrete
“3PAR:all-NL”, or pool.
“3PAR:all-SSD” [3.1.1] 3 Goal.DSPName property set.
pool. Snap space draws
from the DSP. Goal.SnapVolumeSize and
Goal.SnapVolumePercentage
can be set.

Goal also contains all the LD

parameters (e.g., set size, row
size, etc.).
Goal.SpaceLimit and
Goal.SpaceLimitWarning
Threshold correspond to
allocation limit and warning
respectively of the snap space.

Legacy TPVV, where Not supported. Not supported.

user and snap space
both draw from the
same DSP.

Fully provisioned 1 ElementType = NULL or 1 ElementType = NULL or

volume, where user StorageVolume (2) StorageVolume (2)
space draws from DSP. 2 InPool = DSP 2 InPools[0] = DSP,
3 Goal = NULL or DSPName InPools[1] = NULL
property not set. If the Goal 3 Goal can be NULL. If
parameter is present, all LD the Goal parameter is
related parameters in Goal present, all LD related
would be ignored. parameters in Goal
would be ignored.

Block Services Package 5.41

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-28. Volumes Created Based on Parameters to CreateOrModifyElementFromStoragePool()

Type of Volume Created CreateOrModifyElementFrom TPD_CreateOrModify

StoragePool ElementFromStorage
Pools

Fully-provisioned CPVV, 1 ElementType = NULL or 1 ElementType = NULL or

where user space and StorageVolume (2). StorageVolume (2).
snap space draw from 2 InPool = DSP. 2 InPools[0] = DSP1,
the same DSP or two 3 Goal.DSPName property set. If InPools[1] = DSP2.
different DSPs. the Goal parameter is present, 3 Goal can be NULL. If it
all LD related parameters in is present, all LD
Goal are ignored. related parameters in
Goal are ignored.
Goal.SpaceLimit and
Goal.SpaceLimitWarningThres Goal.SpaceLimit and
hold corresponds to allocation Goal.SpaceLimitWarni
limit and warning respectively of ngThreshold
the snap space. corresponds to
allocation limit and
warning respectively of
the snap space.

5.42 Block Services Package

 CIM API Programming Reference

Table 5-28. Volumes Created Based on Parameters to CreateOrModifyElementFromStoragePool()

Type of Volume Created CreateOrModifyElementFrom TPD_CreateOrModify

StoragePool ElementFromStorage
Pools

Thinly provisioned 1 ElementType = 1 ElementType =

volume, where user ThinlyProvisionedStorageVo ThinlyProvisionedSt
space draws from DSP. lume(5). orageVolume (5).
2 InPool = DSP. 2 InPool = DSP.
3 Goal == NULL or DSPName 3 Goal can be NULL. If it
property not set. If it is present, is present, all LD
all LD related parameters in related parameters in
Goal are ignored. Goal are ignored.

Thinly provisioned 1 ElementType = 1 ElementType =

CPVV, where user space ThinlyProvisionedStorageVo ThinlyProvisionedSt
and snap space draw lume (5). orageVolume (5).
from the same DSP or 2 InPool = DSP. 2 InPools[0] = DSP1,
two different DSPs. 3 Goal.DSPName property set. If InPools[1] = DSP2.
the Goal parameter is present, 3 Goal can be NULL. If it
all LD related parameters in is present, all LD
Goal are ignored. related parameters in
Goal would be
Goal.SpaceLimit and ignored.
Goal.SpaceLimitWarningThres
hold corresponds to allocation Goal.SpaceLimit and
limit and warning respectively of Goal.SpaceLimitWarni
the snap space. ngThreshold
corresponds to
allocation limit and
warning respectively of
the snap space.

NOTE: Consult Modifiable StorageSetting Properties for StorageVolume on

page 5.44 for the list of modifiable properties of StorageSetting.

Block Services Package 5.43

 CIM API Programming Reference InForm OS Version 2.3.1

5.9.5.8 Modifiable StorageSetting Properties for StorageVolume

When creating or modifying a thin-provisioned or full-provisioned StorageVolume, a client can
change the following properties of a StorageSetting meant for the user space of the volume
to a non-default value. The provider ignores all other properties. Table 5-29 provides a
summary of modifiable StorageSetting properties for StorageVolume:

Table 5-29. Summary of Modifiable StorageSetting Properties for StorageVolume

CLI
StorageSetting Property Equivalence Comment

Policy -pol

GeometrySectorsPerTrack -spt

GeometryHeadsPerCylinder -hpc

ThinlyProvisioned -tpvv

SpaceLimit -snp_al “-snp_al” uses percentage, but

SpaceLimit is in number of bytes.

SpaceLimitWarning -snp_aw snap space limit warning in

Threshold percentage of SpaceLimit.

UserSpaceLimit -usr_al -usr_al uses percentage, but

UserSpaceLimit is in number of bytes;
applicable only for TPVV; the provider
ignores this for a full-provisioned
volume, i.e., if ThinlyProvisioned
== FALSE.

UserSpaceLimitWarning -usr_aw user space limit warning in

Threshold percentage of UserSpaceLimit,
applicable only for TPVV; the provider
ignores this for a full-provisioned
volume, i.e., if ThinlyProvisioned
== FALSE.

5.44 Block Services Package

 CIM API Programming Reference

Table 5-29. Summary of Modifiable StorageSetting Properties for StorageVolume

ExpirationTime [2.3.1] -exp Time when the volume expires. (In

CLI, the value is the delta, whereas
here it is the actual date and time.)

RetentionTime [2.3.1] -retain Time when the volume retention

ends. (In CLI, the value is the delta,
whereas here it is the actual date and
time.)

Block Services Package 5.45

 CIM API Programming Reference InForm OS Version 2.3.1

5.9.6 Calculating Capacity for StoragePool and StorageVolume

Calculate capacity for StoragePool and StorageVolume through one of the following
methods.

5.9.6.1 Primordial Storage Pool

The primordial pool represents the raw capacity of the array. Its TotalManagedSpace
therefore represents the capacity of all the disk drives in the array, whether admitted or not,
minus capacity lost due to chunklet formatting. The RemainingManagedSpace option
represents the capacity of the disks that are in a New state, namely those that have not been
admitted. StoragePool.SpaceLimit has the same value as TotalManagedSpace.

5.9.6.2 Concrete Storage Pool

TPD_AllocatedFromStoragePool.SpaceConsumed between a primordial and a concrete
pool (all-FC or all-Nearline) represents the raw capacity taken by the concrete pool. The
capacity used for metadata in the creation of the concrete pool can be calculated by
(TPD_AllocatedFromStoragePool.SpaceConsumed –
ConcreteStoragePool.TotalManagedSpace).

TotalManagedSpace for a concrete storage pool represents the raw capacity that can be used
to create storage volumes, dynamic storage pool, or delta replica storage pool.
RemainingManagedSpace for a concrete storage pool represents how much raw capacity is
available for creating a new volume, dynamic storage pool, or delta replica storage pool. After
a volume, dynamic storage pool or delta replica storage pool is created, the raw size of the
new volume or the actual raw size allocated to the dynamic storage pool or delta replica
storage pool is subtracted from the RemainingManagedSpace of the parent concrete pool.
This volume raw size is also represented in
TPD_AllocatedFromStoragePool.SpaceConsumed between the parent concrete pool and
the storage volume, dynamic storage pool, or delta replica storage pool.

TotalManagedSpace for a concrete storage pool is equal to RemainingManagedSpace for

the concrete storage pool value plus TPD_AllocatedFromStoragePool.SpaceConsumed
option from all the storage volumes, dynamic storage pool, or delta replica storage pool
allocated from the pool.

StoragePool.SpaceLimit has the same value as TotalManagedSpace.

5.9.6.3 Dynamic Storage Pool (CPG)

TPD_AllocatedFromStoragePool.SpaceConsumed between a concrete pool and a dynamic
storage pool (DSP) represents the raw capacity taken by the DSP. Capacity used for metadata in

5.46 Block Services Package

 CIM API Programming Reference

the creation of the pool can be calculated by

(TPD_AllocatedFromStoragePool.SpaceConsumed
–DynamicStoragePool.TotalManagedSpace).

TotalManagedSpace for a DSP represents the logical capacity that can be used to create
storage volumes or delta replica storage pool. RemainingManagedSpace for a DSP
represents what logical capacity is available for creating a new volume or delta replica storage
pool. After a volume or delta replica storage pool is created, the logical size of the new volume
or the actual logical size allocated to delta replica storage pool is subtracted from the
RemainingManagedSpace of the parent DSP. This size is also represented in
TPD_AllocatedFromStoragePool.SpaceConsumed between the DSP and the storage
volume or delta replica storage pool.

For a DynamicStoragePool, the formula used in capacity calculation is different from that of a
concrete pool (all-FC or all-NL). TotalManagedSpace is the actual allocated size to the pool and
is not involved in the calculation anymore. Instead, SpaceLimit is used:

„ SpaceLimit - RemainingManagedSpace plus total SpaceConsumed.

„ TotalManagedSpace - Actual space allocated.

„ SpaceLimit - Virtual size. If the pool is limitless, i.e., -sdgl is not specified, SpaceLimit is
1PB which represents the maximum size the system allows.

„ RemainingManagedSpace - SpaceLimit minus the sum of SpaceConsumed.

5.9.6.4 Legacy Storage Volume

For InForm OS release 2.2.4 and prior, only legacy volume creation is supported, i.e., those
volumes that allocate space directly from concrete pool and not DynamicStoragePool (CPG).

Since a concrete pool (3PAR:all-FC, 3PAR:all-NL, and 3PAR:all-SSD [3.1.1]) is not RAID-specific,
raw capacity is used in calculating its ManagedSpace as well as SpaceConsumed with its
direct parent primordial pool and child pools/volumes. All DeltaReplicaStoragePools
that are directly allocated from concrete pools also use raw capacity in calculating
TotalManagedSpace and RemaniningManagedSpace.

TPD_AllocatedFromStoragePool.SpaceConsumed between the parent concrete pool

and the storage volume represents the raw size of the volume.

For InForm OS release 2.2.4 and prior, TPD_AllocatedFromStoragePool.SpaceConsumed

is equal to TPD_StorageVolume.NumberOfBlocks multiplied by
TPD_StorageVolume.BlockSize. In other words,
TPD_StorageVolume.NumberOfBlocks represents the raw size of the volume in blocks.

Block Services Package 5.47

 CIM API Programming Reference InForm OS Version 2.3.1

The usable size of the volume, in bytes, is represented by

TPD_StorageVolume.ConsumableBlocks multiplied by
TPD_StorageVolume.BlockSize.

Capacity used for metadata in the creation of the storage volume can be calculated by
[(TPD_StorageVolume.NumberOfBlocks minus the
TPD_StorageVolume.ConsumableBlocks) multiplied by the
TPD_StorageVolume.BlockSize].

For InForm OS release 2.3.1, meaning of StorageVolume.NumberOfBlocks has been

changed from representing the raw volume size to the logical usable volume block size. A new
property, NumberOfRawBlocks, is introduced to the StorageVolume class to represent the
raw volume block size. Hence, TPD_AllocatedFromStoragePool.SpaceConsumed is
equal to TPD_StorageVolume.NumberOfRawBlocks multiplied by
TPD_StorageVolume.BlockSize. TPD_StorageVolume.ConsumableBlocks remains
the same and is now equal to TPD_StorageVolume.NumberOfBlocks.

Capacity used for metadata in the creation of the storage volume can be calculated by
[(TPD_StorageVolume.NumberOfRawBlocks minus
TPD_StorageVolume.NumberOfBlocks) multiplied by the
TPD_StorageVolume.BlockSize].

5.9.6.4.1 Initial State Example

Suppose an array consisting of all Fibre Channel disks has a total disk capacity of
1090060445184 bytes (~1039563 MB) of which 923699114496 bytes (~880908 MB) worth of
disks have been admitted. The rest of the disks, totaling 166361330688 bytes, have not been
admitted and are therefore in a new state. The admitted disks are used to create a concrete
pool (all-FC) consisting of all FC disks.

Pimordial TPD_StoragePool.TotalManagedSpace = 1090060445184 (raw capacity of the array,

not including capacity lost due to chunklet formatting).

Primordial TPD_StoragePool.RemainingManagedSpace = 166361330688 (raw capacity of new

disks; if there are no new disks this value is 0)

TPD_AllocatedFromStoragePool.SpaceConsumed between primordial and concrete “all-FC”

pool = 1090060445184 – 166361330688 = 923699114496 (raw space consumed in the creation
of “all-FC” concrete pool)

These values for the primordial pool do change no matter how many volumes are created.
RemainingManagedSpace and SpaceConsumed only change if the new disks are admitted.

5.48 Block Services Package

 CIM API Programming Reference

5.9.6.4.2 Before Volume Creation

Now the total raw capacity of the all-FC concrete pool is 813896302592 bytes (776192 MB). The
Overhead/Metadata used in the creation of the concrete pool (for example, TOC) can be
inferred by the difference between this value and
TPD_AllocatedFromStoragePool.SpaceConsumed between the primordial and concrete
pools. Because at this point there are no volumes in the array, the capacity that is free for
creating volume is the same as the total raw capacity of the concrete pool.

Concrete TPD_StoragePool.TotalManagedSpace = 813896302592 (raw capacity of the concrete

pool)

Metadata used in creating “all-FC” concrete pool =

TPD_AllocatedFromStoragePool.SpaceConsumed – Concrete
TPD_StoragePool.TotalManagedSpace = 923699114496 - 813896302592 = 109802811904
(~104716 MB)

Concrete TPD_StoragePool.RemainingManagedSpace = 813896302592 (raw capacity that can

be used to create volume)

5.9.6.4.3 After Volume Creation

Suppose a RAID-10 volume of logical size 10240 MB is created from all-FC pool. This value is
represented in the TPD_StorageVolume class as ConsumableBlocks. In InForm OS release
2.3.1, the NumOfBlocks also represents the logical size of the volume. Because this is a RAID-10
volume, its raw size is actually double that of the logical size, for example, 20480 MB. This
value is represented in the TPD_StorageVolume class as NumberOfBlocks (InForm OS 2.2.4
and prior) and NumberOfRawBlocks (InForm OS 2.3.1) the raw capacity consumed from the
concrete pool in creating this volume is the same as the raw size of the volume, and this
capacity is deducted from the RemainingManagedSpace of the concrete pool.

BlockSize = 512

InForm OS 2.2.4 and prior:

„ TPD_StorageVolume.NumberOfBlocks = (20480 * 1024 * 1024) / BlockSize = 41943040 (raw

size of the volume)

„ TPD_StorageVolume.ConsumableBlocks = (10240 * 1024 * 1024) / BlockSize = 20971520

(logical size of the volume).

„ TPD_AllocatedFromStoragePool.SpaceConsumed between concrete “all-FC” pool and

volume = TPD_StorageVolume.NumberOfBlocks * BlockSize = 21474836480 (raw space
consumed from concrete pool in the creation of the volume).

Block Services Package 5.49

 CIM API Programming Reference InForm OS Version 2.3.1

„ Concrete TPD_StoragePool.RemainingManagedSpace = previous RemaningManagedSpace

value – volume raw size = 813896302592 – 21474836480 = 792421466112.

InForm OS 2.3.1:

„ TPD_StorageVolume.NumberOfBlocks = TPD_StorageVolume.ConsumableBlocks = (10240

* 1024 * 1024) / BlockSize = 20971520 (logical size of the volume).

„ TPD_StorageVolume.NumberOfRawBlocks = (20480 * 1024 * 1024) / BlockSize = 41943040

(raw size of the volume).

„ TPD_AllocatedFromStoragePool.SpaceConsumed between concrete “all-FC” pool and

volume = TPD_StorageVolume.NumberOfRawBlocks * BlockSize = 21474836480 (raw space
consumed from concrete pool in the creation of the volume).

„ Concrete TPD_StoragePool.RemainingManagedSpace = previous RemaningManagedSpace

value – volume raw size = 813896302592 – 21474836480 = 792421466112.

The TotalManagedSpace for the concrete pool remains unchanged.

5.9.6.5 Fully Provisioned Storage Volume

Starting with release 2.3.1, creation of a volume that allocates from DynamicStoragePool
(CPG) is also supported.

For a DynamicStoragePool, since it is a RAID-specific storage pool, logical user capacity is

used in calculating its ManagedSpace as well as SpaceConsumed with its child pools/volumes.
All DeltaReplicaStoragePools that are allocated from a DSP, use logical user capacity in
calculating TotalManagedSpace and RemaniningManagedSpace. RAID and other types of
overhead are hidden in the SpaceConsumed between concrete pool and the DSP.

TPD_AllocatedFromStoragePool.SpaceConsumed between the parent dynamic storage

pool and the storage volume represents the actual size allocated to the volume, and is equal to
TPD_StorageVolume.NumberOfBlocks multiplied by TPD_StorageVolume.BlockSize.
This is also the usable size of the volume in blocks. Raw size of the volume is represented by
TPD_StorageVolume.NumberOfRawBlocks. Unlike the case for legacy storage volume,
SpaceConsumed between DynamicStoragePool and StorageVolume is not the raw size
allocated to the volume, since RAID overhead is now accounted for in DynamicStoragePool.
The capacity used for the metadata in the creation of the storage volume can be calculated by:

[(TPD_StorageVolume.NumberOfRawBlocks -
TPD_StorageVolume.NumberOfBlocks)* TPD_StorageVolume.BlockSize].

5.50 Block Services Package

 CIM API Programming Reference

TPD_StorageVolume.ConsumableBlocks is set to be the same as

TPD_StorageVolume.NumberOfBlocks.

Example:

„ Initial State

A dynamic storage pool has a virtual capacity of 100GB (as set in the –sdgl option). This value is
reflected in the TPD_DynamicStoragePool.SpaceLimit property and is what’s available
for volume allocation. Let’s assume that there are no volumes or
DeltaReplicaStoragePool allocated from this pool initially. The TotalManagedSpace
property reflects the actual capacity allocated to the pool.

„ Before Volume Creation

‹ TPD_DynamicStoragePool.TotalManagedSpace = actual capacity allocated to the

pool.

‹ TPD_DynamicStoragePool.SpaceLimit = 100GB

‹ TPD_DynamicStoragePool.RemainingManagedSpace = 100 GB (capacity that can

be used to create volume)

„ After Volume Creation

Suppose a RAID-10 volume of logical size 10G is created from the dynamic storage pool. This
value is represented in the TPD_StorageVolume class as NumberOfBlocks
(ConsumableBlocks also has the same value). Since this is a RAID-10 volume, its raw size is
actually double that of the logical size, i.e., 20 GB. This value is represented in the
TPD_StorageVolume class as NumberOfRawBlocks.
AllocatedFromStoragePool.SpaceConsumed between StorageVolume and the parent
DynamicStoragePool is the same as the logical size of the volume; RAID overhead is
accounted for in the DynamicStoragePool itself and does not carry over to the child volume.

„ BlockSize = 512

„ TPD_StorageVolume.NumberOfBlocks = TPD_StorageVolume.ConsumableBlocks
= (10240 * 1024 * 1024) / BlockSize = 20971520 (logical block size of the volume)

„ TPD_StorageVolume.NumberOfRawBlocks = (20480 * 1024 * 1024) / BlockSize =

41943040 (raw block size of the volume)

„ TPD_AllocatedFromStoragePool.SpaceConsumed between dynamic storage pool

and volume = TPD_StorageVolume.NumberOfBlocks * BlockSize = 10737418240

Block Services Package 5.51

 CIM API Programming Reference InForm OS Version 2.3.1

„ TPD_DynamicStoragePool.RemainingManagedSpace =
TPD_DynamicStoragePool.SpaceLimit – volume logical size = 100G – 10G = 90G

„ TotalManagedSpace for the dynamic storage pool remains unchanged.

5.9.6.6 Thinly Provisioned Storage Volume

TPD_AllocatedFromStoragePool.SpaceConsumed between the parent dynamic storage
pool and the thinly provisioned storage volume represents the actual size allocated to the
volume. This value is also represented in
StorageVolume.ProvisionedConsumableBlocks, i.e., SpaceConsumed equals
ProvisionedConsumableBlocks. As is the case with Fully Provisioned volume Fully
Provisioned Storage Volume on page 5.50, logical capacity is used in calculating
SpaceConsumed with child volumes/delta replica pool.

StorageVolume.NumberOfBlocks is the virtual size of the TPVV.

TPD_StorageVolume.ConsumableBlocks is set to be the same as

TPD_StorageVolume.NumberOfBlocks.

Example:

„ Initial State

A dynamic storage pool has a virtual capacity of 100GB (as set in the –sdgl option). This value is
reflected in TPD_DynamicStoragePool.SpaceLimit property and is what’s available for
volume allocation. Let’s assume that there are no volumes or DeltaReplicaStoragePool
allocated from this pool initially. The TotalManagedSpace property reflects the actual
capacity allocated to the pool.

„ Before Volume Creation

‹ TPD_DynamicStoragePool.TotalManagedSpace = actual capacity allocated to the

pool

‹ TPD_DynamicStoragePool.SpaceLimit = 100GB

‹ TPD_DynamicStoragePool.RemainingManagedSpace = 100 GB (capacity that can

be used to create volume)

„ After Volume Creation

Suppose a RAID-10 volume of logical size 10G is created from the dynamic storage pool. This
value is represented in the TPD_StorageVolume class as NumberOfBlocks
(ConsumableBlocks also has the same value). Since this is a thinly provisioned volume, what

5.52 Block Services Package

 CIM API Programming Reference

are actually allocated to the volume may not be the full 10G (let us assume it is 4G). The actual
allocated value is represented in the TPD_StorageVolume class as
ProvisionedConsumableBlocks. AllocatedFromStoragePool.SpaceConsumed
between StorageVolume and the parent DynamicStoragePool is the capacity that is
actually allocated to the volume, i.e., AllocatedFromStoragePool.SpaceConsumed is
equal to StorageVolume.ProvisionedConsumableBlocks.

„ BlockSize = 512

„ TPD_StorageVolume.NumberOfBlocks = TPD_StorageVolume.ConsumableBlocks
= (10240 * 1024 * 1024) / BlockSize = 20971520 (logical block size of the volume)

„ TPD_StorageVolume.ProvisionedConsumableBlocks = actual allocated usable

capacity to the volume in blocks = 4G / BlockSize = 8388608

„ TPD_StorageVolume.NumberOfRawBlocks = actual allocated raw capacity to the

volume in blocks = 4 * 2 = 8G / BlockSize = 16777216

„ TPD_AllocatedFromStoragePool.SpaceConsumed between dynamic storage pool

and volume = TPD_StorageVolume.ProvisionedConsumableBlocks * BlockSize =
4294967296 bytes

„ TPD_DynamicStoragePool.RemainingManagedSpace =
TPD_DynamicStoragePool.SpaceLimit – capacity actually allocated to the volume =
100G – 4G = 96G

„ TotalManagedSpace for the dynamic storage pool remains unchanged.

Block Services Package 5.53

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-30. Properties Relevant to TPVV

Properties Description

Uint64 The logical size of the TPVV, in blocks.

NumberOfBlocks

Uint64 Total number of logically contiguous blocks

NumberOfRawBlocks including overhead and metadata, of size Block
Size, which form this Extent. The total size of the
Extent can be calculated by multiplying BlockSize
by NumberOfRawBlocks. If the BlockSize is 1,
this property is the total size of the Extent.

Uint64 The logical size of the TPVV, in blocks, same as

ConsumableBlocks NumberOfBlocks.

Uint64 The number blocks that are currently allocated and

ProvisionedConsumableBlocks visible to host. For example, a RAID-10 volume with
ConsumableBlocks = 100 GB, but only 10 GB is
actually used, then
ProvisionedConsumableBlocks is 10 GB.
Applicable only to a thin-provisioned volume.

Uint32 The SD space of the volume is prevented from

SnapAllocationLimit growing beyond the specified percentage of the
(percentage) volume size.

Uint32 Generate a warning alert when SD space of the

SnapAllocationWarning volume exceeds the specified percentage of the
(percentage) volume size.

Uint32 The user space of the volume is prevented from

UserAllocationLimit growing beyond the specified percentage of the
(percentage) volume size. Applicable only to a thin-provisioned
volume.

5.54 Block Services Package

 CIM API Programming Reference

Table 5-30. Properties Relevant to TPVV (continued)

Properties Description

Uint32 Generate a warning alert when user space of the

UserAllocationWarning volume exceeds the specified percentage of the
(percentage) volume size. Applicable only to a thin-provisioned
volume.

Boolean If TRUE, the volume is thinly provisioned.

ThinlyProvisioned

String The DynamicStoragePool (DSP) the snapshot

SnapDSPName data (SD) are provisioned from.

String The DynamicStoragePool (DSP) the user space is

UserDSPName provisioned from.

5.9.7 Indications
The following alert indications, related to thin provisioning, are supported starting with
release 2.3.1:

1 TPD_StoragePoolGrowWarningAlert – specifies that a storage pool has reached its

allocation warning threshold.

2 TPD_StoragePoolGrowLimitAlert – specifies that a storage pool has reached its allocation

limit.

3 TPD_StoragePoolGrowFailureAlert – specifies that a storage pool has failed to grow.

4 TPD_StoragePoolOverUsedWarningAlert – specifies that a storage pool has been over-used.

5 TPD_StorageVolumeAllocationFailureAlert – specifies that a TPVV has failed to allocate

more space.

6 TPD_StorageVolumeAllocationWarningAlert – specifies that a TPVV has reached its

allocation warning threshold.

7 TPD_StorageVolumeAllocationLimtAlert – specifies that a TPVV has reached its allocation

limit threshold.

Block Services Package 5.55

 CIM API Programming Reference InForm OS Version 2.3.1

8 TPD_SnapshotAdminSpaceAlert – specifies that a storage volume has failed to allocate

snapshot space for administration data.

9 TPD_SnapshotUserSpaceAlert – specifies that a storage volume has failed to allocate

snapshot space for user data.

5.10 Copy Services Subprofile

5.10.1 Description
The subprofile defines a management interface for local snapshot management and
clone management. Remote copy is not supported in our implementation of this
subprofile.

For detailed information regarding the Copy Services subprofile, please refer to

SMI-S at http://www.snia.org.

5.10.2 CIM Classes

Here are the model diagrams and the CIM classes involved in implementing Copy Services. The
classes are listed in alphabetical order.

Figure 5-1. Service and Capabilities Class Diagram

5.56 Copy Services Subprofile

 CIM API Programming Reference

Figure 5-2. Virtual Copy Class Diagram for a Legacy Volume

Copy Services Subprofile 5.57

 CIM API Programming Reference InForm OS Version 2.3.1

Figure 5-3. Physical Copy Class Diagram for a Legacy Volume

Figure 5-4. Job Control Class Diagram

5.58 Copy Services Subprofile

 CIM API Programming Reference

5.10.2.1 TPD_AffectedJobElement
Association between TPD_ConcreteJob and the replica TPD_StorageVolume. Please refer
to TPD_ConcreteJob on page 5.59 for a more detailed discussion.

5.10.2.2 TPD_AllocatedFromStoragePool
Virtual copy snapshot volume is associated to the TPD_DeltaReplicaStoragePool via
TPD_AllocatedFromStoragePool. SpaceConsumed property in this case is the space
consumed by the snapshots. For a fully-provisioned volume with static snapspace, the
TPD_AllocatedFromStoragePool association also links the
TPD_DeltaReplicaStoragePool with the concrete StoragePool; whether this is all-FC,
all-NL, or all-SSD [3.1.1] depends on the device type of the source volume.

For CPVV and TPVV, TPD_DeltaReplicaStoragePool is associated to the

DynamicStoragePool (DSP) from which the SA and SD spaces are allocated via
TPD_AllocatedFromStoragePool.

5.10.2.3 TPD_AssociatedJobMethodResult
Association between TPD_ConcreteJob and TPD_MethodResult. Please refer to
TPD_ConcreteJob on page 5.59 for a more detailed discussion.

5.10.2.4 TPD_CapabilitiesOfStorageConfigurationService
Association is added between TPD_StorageConfigurationService and each instance of
TPD_StorageReplicationCapabilities.

5.10.2.5 TPD_CapabilitiesOfStoragePool
Association between TPD_DeltaReplicaStoragePool if it exists and the corresponding
TPD_StorageCapabilities.

5.10.2.6 TPD_ConcreteJob
This is the class that describes the job itself. Please refer to TPD_ConcreteJob on page 5.59 for a
more detailed discussion.

5.10.2.7 TPD_ConcreteJobInstModification
This is a indication class, sub-classed from CIM_InstModification, which indicates
completion of a job.

Copy Services Subprofile 5.59

 CIM API Programming Reference InForm OS Version 2.3.1

5.10.2.8 TPD_DeltaReplicaStoragePool
This StoragePool class is instantiated upon allocation of SA and SD space of a volume. The
SA and SD spaces are modeled as TPD_DeltaReplicaStoragePool from which virtual copy
snapshots (delta replica) can be allocated and created. This class is a subclass of
CIM_StoragePool.

CIM_StoragePool.GetSupportedSizeRange() method, which is supported in

TPD_StoragePool, is not supported for TPD_DeltaReplicaStoragePool.

5.10.2.9 TPD_ElementSettingData
Association between TPD_StorageSetting and the replica volume.

5.10.2.10 TPD_HostedStoragePool
Association is added between TPD_StorageSystem and each
TPD_DeltaReplicaStoragePool.

5.10.2.11 TPD_MethodResult
This is the class that describes the result of a job. Please refer to TPD_ConcreteJob on page 5.59
for a more detailed discussion.

5.10.2.12 TPD_OwningJobElement
Association between TPD_StorageConfigurationService and TPD_ConcreteJob.
Please refer to section TPD_ConcreteJob on page 5.59 for a more detailed discussion.

5.10.2.13 TPD_ReplicaPoolForStorage
Association between the TPD_DeltaReplicaStoragePool and the source StorageVolume
from which the SA and SD spaces are created.

5.10.2.14 TPD_StorageCapabilities
If TPD_DeltaReplicaStoragePool exists, then a TPD_CapabilitiesOfStoragePool
association is created between it and the TPD_StorageCapabilities. For example, if the
source volume is of RAID-10, then the RAID-10 TPD_StorageCapabilities are associated
to the TPD_DeltaReplicaStoragePool.

5.60 Copy Services Subprofile

 CIM API Programming Reference

5.10.2.15 TPD_StorageConfigurationCapabilities
Relevant properties are:

„ SupportedAsynchronousActions[] – This property has been deprecated and replaced

by StorageReplicationCapabilities.SupportedAsynchronousActions[], but
SMI-S decrees that a provider must still specify the values here for backward compatibility
with 1.0 clients. 1.1 clients ignore these values and consult those from
TPD_StorageReplicationCapabilities instead. The following are added to the
array:

‹ Replica Attachment – create a physical copy; corresponds to “Local Replica Attachment”

in StorageReplicationCapabilities.SupportedAsynchronousActions.

‹ Replica Modification – resync a physical copy; corresponds to “Local Replica

Modification” in
StorageReplicationCapabilities.SupportedAsynchronousActions.

„ SupportedSynchronousActions[] – This property has been deprecated and replaced

by StorageReplicationCapabilities.SupportedSynchronousActions [], but
new values are added to the array for backward compatibility with 1.0 clients:

‹ Replica Creation – create a virtual copy; corresponds to “Local Replica Creation” in

StorageReplicationCapabilities.SupportedSynchronousActions.

„ SupportedCopyTypes[] - describes the replication capabilities supported by the

associated StorageConfigurationServices. This array contains the following 2 values:

‹ UnSyncAssoc – corresponds to virtual copy or physical copy with resync capability

‹ UnSyncUnAssoc – corresponds to creating an independent physical copy

5.10.2.16 TPD_StorageConfigurationService
The following new SMI-S methods are implemented:

1 CreateReplica() – used for creating virtual copy

2 AttachOrModifyReplica() – used for creating physical copy to an existing volume

3 ModifySynchronization() – used for promotion of physical and virtual copies,

resynchronization of physical copy and halting physical copy or snapshot promotion. The
input parameter Operation specifies the kind of operation to perform. Valid values for
Operation are:

Copy Services Subprofile 5.61

 CIM API Programming Reference InForm OS Version 2.3.1

a Resync – Causes a snapshot to be restarted as a new PIT (Point-in-Time) image (resync

physical copy)

b Restore – Copies a snapshot to the source element (promote virtual copy)

c Detach – Removes the association between the source and replica elements (promote
physical copy)

d Start Copy – Starts a background copy operation for a replica (start copy on an existing
physical copy)

e Stop Copy – Stops a background copy operation (halting physical copy)

In addition, a new 3PAR-specific method is defined that mirrors the CLI updatesnapspace
command:

4 UpdateDeltaSnapshotSpace() – used to start calculation of SA/SD space used by a

virtual copy snapshot volume.

5.10.2.17 TPD_StorageReplicationCapabilities
This describes the replication capability of the 3PAR CIM provider. There are 3 fixed instances
of this class, one for each type of SupportedSynchronizationType that we support. Some
of the major properties in this class are:

1 SupportedSynchronizationType – supported values are:

a UnSyncAssoc-Full - create a full size snapshot (physical copy with ‘Save snapshot for
later resync’ option turned on).

b UnSyncAssoc-Delta - create a delta snapshot (virtual copy).

c UnSyncUnAssoc - create a full size, independent replica (physical copy with ‘Save
snapshot for later resync’ option turned off).

2 SupportedAsynchronousActions[] - Enumeration indicating what operations are

executed as asynchronous jobs, supported values are:

a Local Replica Attachment – physical copy creation is asynchronous (Attachment

means attaching a replica to an existing volume).

b Local Replica Modification – resync physical copy is also asynchronous.

3 SupportedSynchronousActions[] - Enumeration indicating what operations are

executed the without creation of a job, supported values are:

a Local Replica Creation – virtual copy creation is synchronous.

5.62 Copy Services Subprofile

 CIM API Programming Reference

4 SupportedSpecializedElements[] - Enumeration indicating which specialized

storage element types are supported by this instance of StorageReplicationCapabilities.
Example values are “Delta Pool”, “Delta Snapshot”, “Full Snapshots”. This affects the value
of IntendedUsage property of StorageSetting, e.g., if “Delta Snapshot” is defined
here, then this indicates to a CIM client that a StorageSetting can be created with
IntendedUsage set to “Delta Snapshot”, which limits the StorageSetting to only
delta snapshot creation. However, for the 3PAR Inform OS, StorageSetting cannot be
specified for the replica volume during a physical or virtual copy creation, which means
only a value of “Not Specialized” (0) is supported for StorageSetting. IntendedUsage.
In other words, we cannot specialize a StorageSetting to only be used as a goal for
creating replica volumes since that is not supported (StorageSetting can only be used as
a goal in a base volume creation). Thus, we cannot specify “Full Snapshot” nor “Delta
Snapshot” here. Value can only contain the following:

a Delta Pool – StoragePool corresponding to the SA/SD spaces of a volume, valid

only for virtual copy. This indicates to the CIM client that a specialized pool exists from
which to allocate a delta snapshot replica. Since our provider does not support
StoragePool creation, a client cannot set StorageSetting.IntendedUsage to
“Delta Pool” either.

5 InitialReplicationState – initial state of the replica after it is first created, supported

values are:

a Initialized – Resynchronization or copy task is queued but the copy engine has not
started. This is the initial state for a physical copy.

b Idle - an UnSyncAssoc replica is ready to be managed. This is the initial state for a
virtual copy.

6 SupportedModifyOperations[] - Enumeration indicating which

TPD_StorageConfigurationService.ModifySynchronization() Operation are
supported by this instance of StorageReplicationCapabilities. Valid values are
outlined in section, ModifySynchronization().

7 ReplicaHostAccessibility - Indicates host access restrictions for replicas with these

capabilities. Valid values are:

a Not accessible – this applies to physical copy volumes, which cannot be exported. If
a physical copy is promoted to a base volume, then this restriction is lifted.

b No restrictions – any host may access; this applies to virtual copy volumes.

Copy Services Subprofile 5.63

 CIM API Programming Reference InForm OS Version 2.3.1

8 HostAccessibleState[] - lists the replica synchronization states in which the provider

allows host access to replicas. For physical copy, this is an empty array, as hosts are never
allowed to access it. For virtual copy volumes, there are no restrictions whatsoever, so this
array contains all the valid states that a virtual copy can have:

a Restore In Progress – a virtual copy promotion is ongoing.

b Idle – normal state.

9 PersistentReplicasSupported - True indicates replicas can persist during power off or

system reset.

10 MaximumReplicasPerSource – Maximum number of replicas that can be associated with

one source element. If the replica is physical copy or RO virtual copy, then the max number
of replica per source volume is the max number of volume allowed for an InServ minus 1
(8191). If the replica is RW virtual copy, then the max number of replica per source volume
is actually 128, since maximum read-write snapshot per source volume is 128. For the case
where SyncType is UnSyncAssoc-Delta (virtual copy), the larger number of the two is
selected, which is 8191. For independent clone (SyncType == UnSyncUnAssoc), this
number is 0 since the replica is not associated with the source volume.

11 MaximumReplicasPerReadWriteSource - Maximum number of replicas that can be

associated with one read-write source element. This only applies to base volume and read-
write snapshots. The resulting replica can only be read-only. The max number of replica per
source volume is the max number of volume allowed for an InServ minus 1 (8191). For
independent clone (SyncType == UnSyncUnAssoc), this number is 0 since the replica is
not associated with the source volume.

12 MaximumReplicasPerReadOnlySource - Maximum number of replicas that can be

associated with one read-only source element. This only applies to read-only snapshots. The
resulting replica can only be read-write. The max number of replica per source volume is
the maximum read-write snapshot per source volume, which is 128.

13 MaximumLocalReplicationDepth - Maximum local mirror replication depth allowed by

this instance of StorageReplicationCapabilities, including the parent volume. For
physical copy, this is the maximum number of volumes that can be created on InServ. For
virtual copy, this is 257 (since the maximum number of writable virtual copies per volume is
128, max depth therefore is achieved if a RW volume has one RO child snapshot which in
turn has one RW child snapshot which in turn has one RO child snapshot and so on, up to a
total of 128 RW snapshots in the chain, hence total = # of RW snapshots + # of RO
snapshots + 1 for the parent volume = 128 + 128 + 1).

5.64 Copy Services Subprofile

 CIM API Programming Reference

14 DeltaReplicaPoolAccess - Indicates that a specialized pool is required as a container

for delta replica elements. In our case, delta replica (virtual copy snapshots) always requires
a specialized pool, the TPD_DeltaReplicaStoragePool, which corresponds to the SA/
SD space of the base volume. Possible values are:

a Any – specialized pool not required for delta replicas. This is not the case for our
snapshots.

b Shared – a single shared pool is required for all delta replicas. This is not the case for
our snapshots.

c Exclusive - one specialized, exclusive pool must be created for each source element
that has associated delta replicas. This is the only supported value for a virtual copy.

Table 5-31. Matrix of StorageReplicationCapabilities Properties

Property/Synch Type UnSyncAssoc-Full UnSyncAssoc-Delta UnSyncUnAssoc

(capability to create (capability to create (capability to create
a physical copy) a virtual copy) an independent
clone)

SupportedSynchronizationType UnSyncAssoc-Full UnSyncAssoc-Delta UnSyncUnAssoc

SupportedAsynchronousActions[] Local Replica NULL Local Replica

Attachment, Attachment
Local Replica
Modification

SupportedSynchronousActions[] NULL Local Replica NULL

Creation

SupportedSpecializedElements[] NULL Delta Pool NULL

InitialReplicationState Initialized Idle Initialized

SupportedModifyOperations[] Resync, Detach, Restore NULL

Start Copy, Stop
Copy

ReplicaHostAccessibility Not accessible No restrictions No restrictions

HostAccessibleState[] NULL Restore In Progress, NULL

Idle

PersistentReplicasSupported TRUE

Copy Services Subprofile 5.65

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-31. Matrix of StorageReplicationCapabilities Properties (continued)

Property/Synch Type UnSyncAssoc-Full UnSyncAssoc-Delta UnSyncUnAssoc

(capability to create (capability to create (capability to create
a physical copy) a virtual copy) an independent
clone)

MaximumReplicasPerSource Max # of volumes - Max # of volumes - 0

1 1

MaximumReplicasPerReadWriteSource Max # of volumes - Max # of volumes - 0

1 1

MaximumReplicasPerReadOnlySource NULL Max # of RW NULL

snapshots

MaximumLocalReplicationDepth Max # of volumes (Max # of RW 1

snapshots *2) +1

DeltaReplicaPoolAccess NULL Exclusive NULL

5.10.2.18 TPD_StorageSetting
The provider screens the following properties when a CIM client is creating or modifying a
TPD_StorageSetting object, since only one value is allowed for each. Any other values
passed in by the client results in an Invalid Parameter exception. These properties are
initialized with the allowed value upon creation.

1 PersistentReplica – True indicates the associated replicas persist during power off or
system reset. Only TRUE is accepted since we do not support transient replicas. Applicable
only for those settings that are associated to replica volumes.

2 IntendedUsage – Describes the use of the storage elements associated with this
StorageSetting. This can only be set to “Not Specialized” (0) since we do not support
specifying a StorageSetting as a goal when creating physical or virtual copy.

5.10.2.19 TPD_StorageSynchronized
Association class that associates the replica with the source volume. It contains several
important properties that describe the relationship between the source volume and the
replica.

1 SyncMaintained – whether synchronization is maintained; false for both physical and

virtual copy.

5.66 Copy Services Subprofile

 CIM API Programming Reference

2 CopyType – the kind of association between source volume and replica; values are:

a Sync – create and maintain a synchronous mirror copy of the source, e.g. synchronized
remote copy.

b Async – create and maintain an async mirror copy of the source e.g., async remote copy.

c UnSyncAssoc – create and maintain an un-synchronized copy associated to the source,

e.g. virtual copy or physical copy with ‘Save snapshot for later resync’ option turned on.

d UnSyncUnAssoc – create an un-synchronized clone of the source element and does not
maintain the source association after completing the copy operation, e.g., physical copy
with ‘Save snapshot for later resync’ option turned off.

3 SyncState – state of the association between source volume and replica, e.g.,
ResyncInProgress, RestoreInProgress, Idle, CopyInProgress.

5.10.2.20 TPD_SystemVolume
Associations between TPD_StorageSystem and StorageVolumes, including physical
copies and snapshots.

5.10.2.21 TPD_DynamicStoragePool
TPD_DeltaReplicaStoragePool associated to a CPVV is allocated from
DynamicStoragePool.

5.10.3 SA/SD Space As StoragePool

A prerequisite for creating snapshots is the allocation of SA and SD spaces to the source
volume. This is done during volume creation time or during modify volume operation.
TPD_DeltaReplicaStoragePool, sub classed from CIM_StoragePool, represents this
space. Snapshot volumes are associated via TPD_AllocatedFromStoragePool to the
TPD_DeltaReplicaStoragePool instead of a concrete TPD_StoragePool.

5.10.3.1 StoragePool Instantiation

If the SnapVolumeSize (-szs) or DeltaReservationGoal (-pct) or TSPName (-cpg)
option is specified within the input parameter Goal (a TPD_StorageSetting object) during
a create or modify volume operation, a TPD_DeltaReplicaStoragePool are instantiated
automatically. Creation or modification of this pool via the CreateOrModifyStoragePool
method are not supported.

Copy Services Subprofile 5.67

 CIM API Programming Reference InForm OS Version 2.3.1

5.10.3.2 Associations

5.10.3.2.1 TPD_ReplicaPoolForStorage
The TPD_DeltaReplicaStoragePool is associated to the source StorageVolume via
TPD_ReplicaPoolForStorage.

5.10.3.2.2 TPD_AllocatedFromStoragePool
New instances of TPD_AllocatedFromStoragePool are created that associate the
TPD_DeltaReplicaStoragePool to:

„ the parent StoragePool. For non-CPVV, the parent pool is a concrete pool, and whether
this is “all-FC”, “all-NL”, or “all-SSD” [3.1.1] depends on the device type of the source
volume. For CPVV, the parent pool is a DSP. SpaceConsumed property in either case is
the sum of raw snap volume size and raw admin size. SpaceLimit and
SpaceLimitThresholdWarning are valid only for CPVV.

„ all virtual copy snapshot volumes that are created from the source volume.
SpaceConsumed property for each association in this case is the space consumed by the
snapshot.

For CPVV, the TPD_AllocatedFromStoragePool association links the

TPD_DeltaReplicaStoragePool with the source DSP. For ThinStorageVolume (TPVV),
the TPD_AllocatedFromStoragePool association links the
TPD_DeltaReplicaStoragePool with the source SD DynamicStoragePool (as opposed
to the user DynamicStoragePool).

5.10.3.3 Capacity Calculations

5.10.3.3.1 Non-CPVV
TotalManagedSpace of the TPD_DeltaReplicaStoragePool equals to the raw SD space.
Space used by SA is not included in TotalManagedSpace, but is included in the
TPD_AllocatedFromStoragePool.SpaceConsumed value, so to deduce the raw SA space,
one can deduct Pool.TotalManagedSpace from SpaceConsumed. The
UpdateDeltaSnapshotSpace() method should be called to prevent the value of
RemainingManagedSpace from getting too stale.

Pool.TotalManagedSpace = raw SD size

Pool.RemainingManagedSpace = raw SD size – SUM(space used by snapshots)

5.68 Copy Services Subprofile

 CIM API Programming Reference

SpaceConsumed of the TPD_AllocatedFromStoragePool between the concrete pool and

TPD_DeltaReplicaStoragePool equals to the sum of the raw admin and raw snap user
size. SpaceLimit and SpaceLimitWarningThreshold are both NULL since these
properties apply only to CPVV.

SpaceConsumed by Replica Pool from Concrete Pool = raw SD size + raw SA size

SpaceConsumed of the TPD_AllocatedFromStoragePool between

TPD_DeltaReplicaStoragePool and a snapshot volume equals the space consumed by the
snapshot. This value should be updated via the UpdateDeltaSnapshotSpace() method to
prevent it from getting too stale.

SpaceConsumed by Snapshot Vol from Replica Pool = space used by a snapshot

5.10.3.3.2 CPVV
When a base volume is created with a StorageSetting in which TSPName is specified, the
resulting TPD_DeltaReplicaStoragePool is allocated from the DSP. A
TPD_AllocatedFromStoragePool association is created between the
TPD_DeltaReplicaStoragePool and the parent DSP.
TPD_AllocatedFromStoragePool.SpaceLimit and
TPD_AllocatedFromStoragePool.SpaceLimitThresholdWarning of this association
corresponds to the allocation limit (-al) and allocation warning (-aw) respectively.

SpaceLimit = (Source Volume Size * al)/100

SpaceLimitWarningThreshold = aw

FYI, SpaceLimit is the consumption limit for the allocated

TPD_DeltaReplicaStoragePool from the associated DSP in bytes.
SpaceLimitThresholdWarning indicates when a warning indication should be generated
based on the total amount of space consumed being greater than or equal to
(SpaceLimit*SpaceLimitWarningThreshold)/100. A SpaceLimit value of 0 (default)
means that no limit is specified. SpaceLimitThresholdWarning is meaningless if
SpaceLimit is 0.

SpaceLimit and SpaceLimitThresholdWarning for the

TPD_AllocatedFromStoragePool association between the snapshot volume and the
parent TPD_DeltaReplicaStoragePool are not used, and hence is not populated, since the
InformOS does not support specification of allocation limit on a per snapshot volume basis.

Calculation for TotalManagedSpace of the TPD_DeltaReplicaStoragePool of a CPVV is

the similar to that for a non-CPVV, except that the parent pool is now a DSP and not a concrete

Copy Services Subprofile 5.69

 CIM API Programming Reference InForm OS Version 2.3.1

pool. Space used by SA is not included in TotalManagedSpace, but is included in the

TPD_AllocatedFromStoragePool.SpaceConsumed value, so to deduce the raw SA space,
one can deduct Pool.TotalManagedSpace from SpaceConsumed. The
UpdateDeltaSnapshotSpace() method should be called to prevent the value of
RemainingManagedSpace from getting too stale

Pool.TotalManagedSpace = raw SD size

Pool.RemainingManagedSpace = raw SD size – SUM(space used by snapshots)

SpaceConsumed of the TPD_AllocatedFromStoragePool between the parent DSP and

TPD_DeltaReplicaStoragePool equals to the sum of the raw admin and raw snap user
size.
SpaceConsumed by Replica Pool from DSP = raw SD size + raw SA size

SpaceConsumed of the TPD_AllocatedFromStoragePool between

TPD_DeltaReplicaStoragePool and a snapshot volume equals the space consumed by the
snapshot. This value should be updated via the UpdateDeltaSnapshotSpace() method to
prevent it from getting too stale.

SpaceConsumed by Snapshot Vol from Replica Pool = space used by a snapshot

5.10.3.3.3 UpdateDeltaSnapshotSpace() Method

It is important to note that calculation of space consumed by a snapshot volume can
potentially be a long process, and it is not updated real-time by sysmgr. One has to issue the
command “updatesnapspace <snapshot vol name>” from CLI (from which a task is
generated) to start the calculation of SA/SD space used by a snapshot. Hence, when a CIM
client retrieves the RemainingManagedSpace value for a SA/SD pool or the SpaceConsumed
value for a snapshot volume, it can potentially be stale if updatesnapspace has not been
done for a while. As a result, a new 3PAR-specific extrinsic method is defined in
TPD_StorageConfigurationService class called UpdateDeltaSnapshotSpace() which
mirrors the CLI updatesnapspace command.

A client wishing to obtain a more accurate picture of the aforementioned capacity values must
first call this method, monitor the returned job for its completion, then finally get at the
properties.

uint32 UpdateDeltaSnapshotSpace(
[In] TPD_StorageVolume ref SnapshotVolume[],
[Out] TPD_ConcreteJob ref Job);

5.70 Copy Services Subprofile

 CIM API Programming Reference

„ SnapshotVolume: Array of references to the snapshot volume to update. If NULL, then all
snapshots are updated.

„ Job: A Job is created as a side-effect of the execution of the method, and a reference to
that Job is returned through this parameter.

Table 5-32. Return Values for UpdateDeltaSnapshotSpace()

ValueMap Values Explanation/Notes

4 Failed

0x1000 Method parameters checked – job

started

32768 Volume does not exist No such snapshot volume, or the

specified volume is not a virtual
copy snapshot.

5.10.3.4 Indications
Job control indications are supported for the job started with the
UpdateDeltaSnapshotSpace() method. These indications are converted from events
generated by the task framework.

1 Modification of Operational Status for a Concrete Job to Complete and OK – update

successful.

2 Modification of Operational Status for a Concrete Job to Complete and Error – update
failed.

3 Modification of Job Status for Concrete Job – is generated if the job is started. For this, the
task framework must be enhanced to support component state change events.

The type of indication generated is TPD_ConcreteJobInstModification, sub-classed from

CIM_InstModification.

Copy Services Subprofile 5.71

 CIM API Programming Reference InForm OS Version 2.3.1

5.10.4 Physical Copy

5.10.4.1 StorageSynchronized
A TPD_StorageSynchronized association is instantiated the moment a vv copy process is
started. This associates the target volume with the source volume. The values of this instance
are listed in the following table. For a CopyType of UnSyncUnAssoc, an instance of
TPD_StorageSynchronized is maintained while the copy is taking place, but is relinquished
once the copy is finished.

Table 5-33. StorageSynchronized Property Values for a Physical Copy

Property Value

CopyType UnsyncAssoc (4)

Creates an unsynchronized copy and maintain an association to
the source

UnsyncUnAssoc (5)
Creates an unsynchronized copy but do not maintain an
association to the source

ReplicaType Full Copy (2)

This indicates that a full copy of the source object is to be
generated.

SyncState Varies; refer to the various “SyncState Transitions” sections below

for each type of operation.

SyncMaintained False
Synchronization is not maintained between replica and source
volume.

WhenSynced NULL to start with; non-NULL upon successful completion of a

copy; the point in time that the Elements were synchronized.

5.72 Copy Services Subprofile

 CIM API Programming Reference

5.10.4.2 StorageReplicationCapabilities
The ability to create a physical copy is described by the following 2 instances of
TPD_StorageReplicationCapabilities (seeTPD_StorageReplicationCapabilities on
page 5.62):

1 UnSyncAssoc-Full – describes the capability of our provider to create an unsynchronized

full-snapshot replica that maintains an association with the source volume.

2 UnSyncUnAssoc - describes the capability of our provider to create an independent clone of

a volume.

Copy Services Subprofile 5.73

 CIM API Programming Reference InForm OS Version 2.3.1

CREATION

CLI EQUIVALENCE

createvvcopy –p <parvol> <destvol>

createvvcopy –p <parvol> -s <destvol>

SMI-S METHOD
A physical copy can be created by a CIM client using the
TPD_StorageConfigurationService.AttachOrModifyReplica() method
uint32 AttachOrModifyReplica().

[Out] CIM_ConcreteJob ref Job,

[In, REQ] CIM_ManagedElement ref SourceElement,
[In, REQ] CIM_ManagedElement ref TargetElement,
[In, REQ,
Values {“Async”, “Sync”, “UnSyncAssoc”, “UnSyncUnAssoc”},
ValueMap {“2”, “3”, “4”, “5”}]
Uint16 CopyType,
[In, EmbeddedInstance ( "CIM_SettingData" )]
String Goal,
[In] CIM_NetworkPipe ref ReplicationPipe);

„ Job: A Job is created as a side-effect of the execution of the method, and a reference to
that Job is returned through this parameter.

„ SourceElement: Reference to the base StorageVolume to copy from.

„ TargetElement: Reference to the base StorageVolume to copy to.

„ CopyType: Can only be “UnsyncAssoc” (4) or “UnsyncUnAssoc” (5)

„ UnsyncAssoc: Creates an unsynchronized physical copy that is associated to the source

StorageVolume. This creates a snapshot volume as a side-effect. This is equivalent to the
CLI command “createvvcopy –p <parvol> -s <destvol>”.

„ UnsyncUnAssoc: Creates an unsynchronized physical copy of the source StorageVolume

and does not maintain the source association after completing the copy operation. This is
equivalent to the CLI command “createvvcopy –p <parvol> <destvol>”, i.e.,
without the –s option.

5.74 Copy Services Subprofile

 CIM API Programming Reference

„ Goal: The StorageSetting properties to be created or modified for the target

StorageVolume. 3PAR does not support changing the volume characteristics during
createvvcopy, so this can only be NULL. A Non-NULL value is ignored.

„ ReplicationPipe: The NetworkPipe element that scopes the remote mirror pair. This is
only for remote copy, which is not supported in Phase I, so this can only be NULL.

SMI-S also specifies that providers have to accept the AttachReplica() method, which is
defined in an earlier version of the copy services subprofile, for backward compatibility.
AttachReplica is similar to AttachOrModifyReplica with the omission of the Goal and
ReplicationPipe parameters.
uint32 AttachReplica(
[Out] CIM_ConcreteJob ref Job,
[In, REQ] CIM_ManagedElement ref SourceElement,
[In, REQ] CIM_ManagedElement ref TargetElement,
[In, REQ,
Values {“Async”, “Sync”, “UnSyncAssoc”, “UnSyncUnAssoc”},
ValueMap {“2”, “3”, “4”, “5”}]
Uint16 CopyType);

Table 5-34. Return values for AttachOrModifyReplica()/AttachReplica()

ValueMap Values Explanation/Notes

0 Success

4 Failed For example: the source volume does

not have snapspace, target volume is
incompatible.

5 Invalid Parameter For example: the wrong CopyType is

specified.

6 In Use Target volume is already a physical

copy of another volume.

0x1000 Method parameters checked –

job started

Copy Services Subprofile 5.75

 CIM API Programming Reference InForm OS Version 2.3.1

The method execution, if successful, always returns 0x1000, which means that job has started.
A client can either monitor Job.OperationalStatus for job completion or wait for the
arrival of modification of OperationalStatus for a ConcreteJob to indicate ‘Complete’
and ‘OK’ or ‘Complete’ and ‘Error’.

If the operation is of CopyType UnSyncAssoc, a resync snapshot of the physical copy is

created. This snapshot has the same characteristics as a regular snapshot.

STATE TRANSITIONS
Table 5-35 shows the values for SyncState and WhenSynced during various stages of
physical copy creation. Internal vvol_t volume state flags (v_overall_state) are mapped to each
SyncState.

Table 5-35. State Transitions for Physical Copy Creation

Operation SyncState WhenSynced

Copy task queued but Initialized (2) NULL

copy engine not yet
started

Copy in progress ResyncInProgress (5) NULL

Initial copy in progress

Copy complete Frozen (14) Time of when copy is

All blocks copied from source to completed
an UnSyncAssoc replica and the
copy engine is stopped

Copy Failed Broken (12) NULL

The relationship is non-
functional due to errors in the
source or the target

5.76 Copy Services Subprofile

 CIM API Programming Reference

RESYNCHRONIZATION

CLI EQUIVALENCE

createvvcopy –r <destvol>

SMI-S METHOD
A physical copy can be resynchronized with the source volume by a CIM client using the
TPD_StorageConfigurationService.ModifySynchronization() method with the
Operation parameter set to Resync(4). A target volume that is in a Broken state (copy failed)
cannot be resync-ed.
uint32 ModifySynchronization(
[In, REQ,
Values {“Detach”, “Fracture”, “Resync”, “Restore”,
“Prepare”, “Unprepare”, “Quiesce”, “Unquiesce”,
“Reset to Sync”, “Reset to Async”, “Start Copy”,
“Stop Copy”},
ValueMap {“2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”,
“10”, “11”, “12”, “13”}]
Uint16 Operation,
[Out]CIM_ConcreteJob ref Job,
[In, REQ] CIM_StorageSynchronized ref Synchronization);
„ Operation: describes the type of modification to be made to the replica:

‹ Detach: 'Forget' the synchronization between two storage objects. Start to treat the
objects independently. This performs the same function as promoting a physical copy.

‹ Fracture: Suspend the synchronization between two storage objects using Sync or
Async replication. Not supported for local copy.

‹ Resync: Causes a snapshot to be restarted as a new PIT (Point-In-Time) image with a

new value assigned to WhenSynced. This performs the same function as
resynchronizing a physical copy.

‹ Restore: Copies a snapshot to the source element. This performs the same function as
promoting virtual copy.

‹ Prepare: Get the link ready for a Resync operation to take place. Not supported.

‹ Unprepare: Clear a prepared state if a Prepare is not to be followed by a Resync

operation. Not supported.

Copy Services Subprofile 5.77

 CIM API Programming Reference InForm OS Version 2.3.1

‹ Quiesce: Stops the copy engine for snapshots and the snapshot no longer consume
space. Not supported.

‹ Unquiesce: Take the link out of the quiesce state. Not supported.

‹ Reset to Sync: Changes the CopyType value of a mirror replica from “Async” to
“Sync”. Not supported.

‹ Reset to Async: Changes the CopyType value of a mirror replica from “Sync” to
“Async”. Not supported.

‹ Start Copy: Initiate a full background copy of the source to the UnSyncAssoc replica.
Replica enters a Frozen state when the copy operation is completed. This performs the
same function as issuing a createvvcopy again on an existing physical copy.

‹ Stop Copy: Stop the background copy previously started. This performs the same
function as halting a physical copy.

„ Job: A Job is created as a side-effect of the execution of the method, and a reference to
that Job is returned through this parameter.

„ Synchronization: The reference to the StorageSynchronized association describing

the storage source/replica relationship.

Table 5-36. Return Values for the Various ModifySynchronization() Operations

ValueMap Values Explanation/Notes

0 Job Completed with No Error Applicable only for Detach

(promote).

4 Failed For example: the

TPD_StorageSynchronized object
does not exist.

5 Invalid Parameter For example: the wrong CopyType

is specified.

0x1000 Method parameters checked – job Does not apply to Detach.

started

5.78 Copy Services Subprofile

 CIM API Programming Reference

The method execution, if successful, always returns 0x1000, which means that job has started.
A client can either monitor Job.OperationalStatus for job completion or wait for the
modification of OperationalStatus for a ConcreteJob to indicate ‘Complete’ and ‘OK’ or
‘Complete’ and ‘Error’.

STATE TRANSITIONS
Table 5-37 shows the values for SyncState and WhenSynced during various stages of
physical copy resynchronization.

Table 5-37. State Transitions for Physical Copy Resynchronization

Operation SyncState WhenSynced

Resync in progress ResyncInProgress (5) Previous sync time

Resync complete Frozen (14) Time of when resync is

completed

Resync Failed Broken (12) Previous sync time

Copy Services Subprofile 5.79

 CIM API Programming Reference InForm OS Version 2.3.1

PROMOTION

CLI EQUIVALENCE

promotevvcopy

SMI-S METHOD
A physical copy can be promoted with the source volume by a CIM client using the
TPD_StorageConfigurationService.ModifySynchronization() method with the
Operation parameter set to Detach (2). After the a successful Detach operation, the
StorageSynchronized association between the source and target volume is relinquished
and the target volume becomes an independent base volume. The Detach operation is
synchronous and does not require a job.

STATE TRANSITIONS
Table 5-38 shows the values for SyncState and WhenSynced during various stages of
physical copy promotion.

Table 5-38. State Transitions for Physical Copy Promotion

Operation SyncState

Promote in progress Frozen (14)

There are no corresponding SyncState in SMI-S for
detaching, so SyncState remains in Frozen until
operation is complete

Promote complete N/A – StorageSynchronized gone

Promote Failed Broken (12)

5.80 Copy Services Subprofile

 CIM API Programming Reference

START PHYSICAL COPY

CLI EQUIVALENCE

createvvcopy –p <parvol> -s <destvol>

SMI-S METHOD
Copy can be done on an existing physical copy using the
TPD_StorageConfigurationService.ModifySynchronization() method with the
Operation parameter set to Start Copy (12).

The method execution, if successful, always returns 0x1000, which means that job has started.
Please see Resynchronization on page 5.77 for possible return values.

STATE TRANSITIONS
Table 5-39 shows the values for SyncState and WhenSynced during various stages of start
physical copy.

Table 5-39. State Transitions for Physical Copy to an Existing Copy

Operation SyncState WhenSynced

Copy in progress CopyInProgress (15) Previous sync time

Copy complete Frozen (14) Time of when copy is

completed

Copy Failed Broken (12) Previous sync time

Copy Services Subprofile 5.81

 CIM API Programming Reference InForm OS Version 2.3.1

HALT PHYSICAL COPY

CLI EQUIVALENCE

createvvcopy –halt

SMI-S METHOD
Copy can be halted using the
TPD_StorageConfigurationService.ModifySynchronization() method with the
Operation parameter set to Stop Copy(13).

This operation is synchronous and does not require a job. The job that is produced as a side-
effect of the physical copy can also be terminated by
TPD_ConcreteJob.RequestStateChange.

STATE TRANSITIONS
Table 5-40 shows the values for SyncState and WhenSynced during various stages of halting
a physical copy.

Table 5-40. State Transitions for Halting a Physical Copy

Operation SyncState WhenSynced

Copy in progress ResyncInProgress (5) or Previous sync time

CopyInProgress (15)

Halt Copy Complete N/A – StorageSynchronized gone

Halt Copy Failed Frozen (14) New sync time

(This indicates that the
halt has failed and the
copy was allowed to
finish.)

5.82 Copy Services Subprofile

 CIM API Programming Reference

Figure 5-5. State Transition Diagram of Physical Copy

Copy Services Subprofile 5.83

 CIM API Programming Reference InForm OS Version 2.3.1

5.10.4.3 Job Control Subprofile Indications

The following job control subprofile indications are supported for the job that is started as a
result of the copy operation:

„ Modification of Job Status for a Concrete Job - copy/resync started.

„ Modification of Operational Status for a Concrete Job to Complete and OK – copy/resync

successful.

„ Modification of Operational Status for a Concrete Job to Complete and Error – copy/resync
failed.

The type of indication generated is TPD_ConcreteJobInstModification, sub-classed from

CIM_InstModification.

5.10.5 Virtual Copy

5.10.5.1 StorageSynchronized
A TPD_StorageSynchronized association is instantiated after the virtual copy volume is
created. This associates the target volume with the source volume. A virtual copy volume is also
created as a side-product of creating a physical copy that can be resynchronized at a later time.
Table 5-41 shows the property values of this instance.

Table 5-41. StorageSynchronized Property Values for a Virtual Copy

Property Value

CopyType UnsyncAssoc (4)

Creates an unsynchronized copy and
maintains an association to the source.

ReplicaType “After Delta” (4)

Indicates that the replica is maintained as
delta data from the source object.

SyncState Varies; refer to the various “SyncState

Transitions” sections below for each type
of operation.

5.84 Copy Services Subprofile

 CIM API Programming Reference

Table 5-41. StorageSynchronized Property Values for a Virtual Copy

Property Value

SyncMaintained False
Synchronization is not maintained
between replica and source volume.

WhenSynced NULL to start with; non-NULL upon

successful completion of a copy.
The point in time that the Elements were
synchronized.

5.10.5.2 StorageReplicationCapabilities
The ability to create a virtual copy is described by the following instance of
TPD_StorageReplicationCapabilities:

„ UnSyncAssoc-Delta – describes the capability of our provider to create an unsynchronized

delta snapshot replica that maintains an association with the source volume

Copy Services Subprofile 5.85

 CIM API Programming Reference InForm OS Version 2.3.1

CREATION

CLI EQUIVALENCE

createsv

SMI-S METHOD
A client can create a physical copy from the source volume by using the
TPD_StorageConfigurationService.CreateReplica() method.
uint32 CreateReplica(
[In] string ElementName,
[Out] CIM_ConcreteJob ref Job,
[In, REQ] CIM_LogicalElement ref SourceElement,
[Out] CIM_LogicalElement ref TargetElement,
[In] CIM_StorageSetting ref TargetSettingGoal,
[In] CIM_StoragePool ref TargetPool,
[In, REQ,
Values {“Async”, “Sync”, “UnSyncAssoc”, “UnSyncUnAssoc”},
ValueMap {“2”, “3”, “4”, “5”}]
Uint16 CopyType);
„ ElementName: Name of the target snapshot volume.

„ Job: No job is created. This is NULL on output.

„ SourceElement: Reference to the base StorageVolume to copy from.

„ TargetElement: Reference to the target snapshot StorageVolume that is created.

„ TargetSettingGoal: The definition for the StorageSetting to be maintained by the

target storage object. Only the BaseID property is applicable.

„ TargetPool: Reference to the StoragePool from which the virtual copy volume is
allocated. This can either be NULL or the TPD_DeltaReplicaStoragePool associated
with the SourceElement volume. Any other values results in a Invalid Parameter error.

„ CopyType: Can only be “UnsyncAssoc” (4)

‹ UnsyncAssoc: Creates an unsynchronized virtual copy that is associated to the source

StorageVolume.

5.86 Copy Services Subprofile

 CIM API Programming Reference

Table 5-42. Return values for CreateReplica() Operation

ValueMap Values Explanation/Notes

0 Job Completed with No Error

4 Failed

5 Invalid Parameter For example: the wrong CopyType is

specified

STATE TRANSITIONS
Table 5-43 shows the values for SyncState and WhenSynced during various stages of the
virtual copy creation.

Table 5-43. State Transitions for Virtual Copy Creation

Operation SyncState WhenSynced

Copy in progress ResyncInProgress (5) NULL

Copy complete Idle (11) Time when copy is

completed.

Copy Failed Broken (12) Previous sync time.

Copy Services Subprofile 5.87

 CIM API Programming Reference InForm OS Version 2.3.1

PROMOTION

CLI EQUIVALENCE

promotesv

SMI-S METHOD
Virtual copy promote can be done using the
TPD_StorageConfigurationService.ModifySynchronization() method with the
Operation parameter set to Restore (5).

The method execution, if successful, always returns 0x1000, which means that job has started.

STATE TRANSITIONS
Here are the values for SyncState and WhenSynced during various stages of promoting
virtual copy.

Table 5-44. State Transitions for Virtual Copy Promote

Operation SyncState WhenSynced

Promote in progress RestoreInProgress (10) Previous sync time

Promote complete Idle (11) Time of when copy is

completed

Promote Failed Broken (12) Previous sync time

5.88 Copy Services Subprofile

 CIM API Programming Reference

HALT SNAPSHOT PROMOTION

CLI EQUIVALENCE

promotesv -halt

SMI-S METHOD
Virtual copy promote can be halted via the Job Control method
TPD_ConcreteJob.RequestStateChange() method with the RequestedState
parameter set to Terminate(4).

STATE TRANSITIONS
Here are the values for SyncState and WhenSynced during various stages of halting virtual
copy promote.

Table 5-45. State Transitions for Halting Virtual Copy Promote

Operation SyncState WhenSynced

Promote in progress RestoreInProgress (10) Previous sync time

Halt complete Broken (12) Previous sync time

Promote Failed Idle (11) New sync time

(This indicates that

the halt has failed
and the promote
was allowed to
finish).

Copy Services Subprofile 5.89

 CIM API Programming Reference InForm OS Version 2.3.1

STATE DIAGRAM

Figure 5-6. State Transition Diagram of Virtual Copy

5.10.5.2.1 Job Control Indications

The following job control subprofile indications are supported for the job that is started as a
result of promote operation:

„ Modification of Job Status for a Concrete Job – promote sv/update snapspace started.

„ Modification of Operational Status for a Concrete Job to Complete and OK – promote sv/
update snapshot space successful.

„ Modification of Operational Status for a Concrete Job to Complete and Error – promote sv/
update snapshot space failed.

The type of indication generated is TPD_ConcreteJobInstModification, sub-classed from

CIM_InstModification.

5.90 Copy Services Subprofile

 CIM API Programming Reference

5.10.6 Job Control

5.10.6.1 Overview
Only the following tasks are supported

„ Create physical copy

„ Resync physical copy

„ Promote virtual copy

„ Update snapshot space

5.10.6.2 TPD_ConcreteJob
This is a new class, and each instance of this class represents a task.

5.10.6.2.1 RequestStateChange() Method

This method can be used to cancel a task. The input parameter RequestedState can only be
set to Terminate(4), since the InformOS task framework only supports task canceling.
uint32 RequestStateChange(
[In, REQ,
Values {“Start”, “Suspend”, “Terminate”, “Kill”,
“Service”},
ValueMap {“2”, “3”, “4”, “5”, “6”}]
Uint16 RequestedState,
[In] dateTime TimeoutPeriod);
„ RequestedState: Changes the state of a job.

‹ Start: changes the state to running; not supported.

‹ Suspend: stops the job temporarily which can be resumed; not supported.

‹ Terminate: stops the job cleanly and orderly; this is the only supported value.

‹ Kill: terminate the job immediately; not supported.

‹ Service: puts the job into a service state; not supported.

„ TimeoutPeriod: A timeout period that specifies the maximum amount of time that the
client expects the transition to the new state to take. This is not supported and must be
NULL.

Copy Services Subprofile 5.91

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-46. Return Values for RequestStateChange() Operation

ValueMap Values Explanation/Notes

1 Not supported RequestedState not supported.

4 Failed

5 Invalid Parameter

4096 Method Parameters Checked - This is the normal successful return

Transition Started case, as a task may not be
terminated immediately.

4098 Use of Timeout Parameter Not If TimeoutPeriod parameter is not

Supported NULL.

5.10.6.2.2 GetError() Method

When the job is executing or has terminated without error, then this method returns no
CIM_Error instance. However, if the job has failed because of some internal error, then a
CIM_Error instance is returned. This method is only used to fetch the failure reason for jobs
that failed on their own, i.e., not jobs that are canceled by the user.
uint32 GetError(
[Out,
EmbeddedInstance (“CIM_Error”}]
String Error);
„ Error: If the OperationalStatus on the Job is not “OK”, then this method returns a CIM
Error instance. Otherwise, when the Job is "OK", null is returned.

Table 5-47. Return Values for GetError()Operation

ValueMap Values Explanation/Notes

0 Success

5 Invalid Parameter

5.92 Copy Services Subprofile

 CIM API Programming Reference

5.10.6.2.3 Mapping Error Code to CIM_Error

A CIM_Error object consists of the following properties:

„ OwningEntity – the string “SNIA”

„ MessageID –DRM26, Resource not available. Consult SMI-S section on “Standard

Messages” for detailed information on the meaning of the DRM messages.

„ MessageArguments[] – An array containing the dynamic content of the message. There is

only one element, “Operation has failed”.

„ Message – The formatted message. In the case of DRM26, MessageArguments and

Message are the same, “Operation has failed”.

„ PerceivedSeverity – describes the severity of the error from the notifier's point of view.
This value is Low (2).

„ ProbableCause - describes the probable cause of the error. This value is “Configuration/
Customization Error” (8).

„ CIMStatusCode - The CIM status code that characterizes this instance. This value is
ERR_ACCESS_DENIED (2).

„ CIMStatusCodeDescription – “CIM_ERR_ACCESS_DENIED”

Copy Services Subprofile 5.93

 CIM API Programming Reference InForm OS Version 2.3.1

DELETING JOB

CLI EQUIVALENCE

removetask

DELETEINSTANCE
An instance of TPD_ConcreteJob can be deleted using the intrinsic method
TPD_ConcreteJob.DeleteInstance(). If not deleted, a job exists indefinitely.

TPD_METHODRESULT
This class is used to report the extrinsic method that triggered the job and the parameters
passed to it, so that a third party client can tell what the job is and what it is doing. The class
consists of the following mandatory properties:

„ InstanceID – this is a key and is identical to that of ConcreteJob this is associated with.

„ PrecallIndication – string representing an embedded instance of the

CIM_InstMethodCall class, which contains the method called that triggered this job,
(e.g., if this is a create vv copy job, then this contains a CIM_InstMethodCall instance
representing AttachOrModifyReplica. CIM_InstMethodCall contains the following
values:

‹ MethodName – string of the methodName, e.g., AttachOrModifyReplica.

‹ MethodParameters - parameters of the method, formatted as an EmbeddedObject

(with a predefined class name of “__MethodParameters"). This only contains the
input parameters; output parameter (Job) is not included.

‹ PreCall - Boolean indicating whether the Indication is sent before the method begins
executing (TRUE) or when the method completes (FALSE). In this case this value is TRUE.

„ PostCallindication – string representing an embedded instance of the

CIM_InstMethodCall class, which contains the method called that triggered. However,
this differs from the case in PreCallIndication in that output parameters is also
included in the MethodParameters parameter. Output parameter in this case is Job.

‹ MethodName – string of the methodName, e.g., AttachOrModifyReplica.

‹ MethodParameters - parameters of the method, formatted as an EmbeddedObject

(with a predefined class name of “__MethodParameters"). This contains both input
and output parameters. Job parameter is a reference to the TPD_ConcreteJob that
was created.

5.94 Copy Services Subprofile

 CIM API Programming Reference

‹ PreCall – FALSE

‹ ReturnValue - contains string representation of the method's return value, e.g.,

“Failed”

‹ ReturnValueType - the type of the method return value. This is always “uint32” (9)
since all replication methods that we support have a return value type of uint32.

5.10.6.3 TPD_OwningJobElement
Association between TPD_StorageConfigurationService and TPD_ConcreteJob.

5.10.6.4 TPD_AffectedJobElement
Association between TPD_ConcreteJob and one or more TPD_StorageVolume affected by
the job. The affected volumes are the source and target volumes, with the exception of update
snapspace task, where the affected volumes are those snapshots that are being updated.

5.10.6.5 TPD_AssociatedJobMethodResult
Association between TPD_ConcreteJob and TPD_MethodResult.

5.10.6.6 Indications
The following Job Control subprofile indication is supported:

“SELECT * FROM CIM_InstModification WHERE SourceInstance ISA

CIM_ConcreteJob”.

5.11 Location Subprofile

The Location subprofile models information about the location of a physical device. In the case
of the Array profile, it is used to provide information about the physical location of a storage
array. The information provided through this subprofile is the physical location of the InServ
Storage Server.

For detailed information regarding the Location subprofile, refer to SMI-S at http://
www.snia.org.

5.11.1 Location Subprofile CIM Classes

Table 5-48 shows the Location subprofile key CIM classes:

Location Subprofile 5.95

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-48. Location Subprofile CIM Classes

Class Description

TPD_SystemPackage The Physical Element whose Location is specified. This represents

the physical aspects of the InServ storage array.

TPD_SystemLocation The Location of the specified Physical Element.

5.11.2 Supported Methods

Table 5-49 shows the supported methods of the Location subprofile:

Table 5-49. Methods for TPD_SystemLocation

Method Description

createInstance() Creates an instance of TPD_SystemLocation.

deleteInstance() Deletes an instance of TPD_SystemLocation.

5.12 Multiple Computer System Subprofile

The Multiple Computer System subprofile models the underlying systems or controllers that
cooperate to present a single top-level system (such as a Cluster) that provides added
redundancy or increased functionality. This subprofile provides information about the
Controller Nodes that comprise the InServ Storage Server cluster. The cluster is modeled as
multiple tiers with each tier representing a pair of Controller Nodes.

For detailed information regarding the FC Target Ports subprofile, refer to SMI-S at http://
www.snia.org.

5.12.1 Multiple Computer System Subprofile CIM Classes

Table 5-50 shows the Multiple Computer System subprofile key CIM classes:

5.96 Multiple Computer System Subprofile

 CIM API Programming Reference

Table 5-50. Multiple Computer System Subprofile CIM Classes

Class Description

TPD_StorageSystem Represents the storage array as a whole.

TPD_NodeSystem Represents a Controller Node on an InServ Storage System.

TPD_NodePairSystem Represents a pair of Controller Nodes on an InServ Storage

System.

TPD_NodePairRedundancySet Members of this set are node pairs that make up the InServ
Storage System cluster.

TPD_RedundancySet Members of this set are Controller Nodes that make up a node
pair within the InServ Storage System.

5.12.2 Supported Methods

None.

5.13 Software Subprofile

The Software subprofile models information on installed controller software, including version
information, build numbers, and manufacturer identification. The information provided
through this subprofile is specific for the version of the InForm OS installed on the
TPD_ComputerSystem that represents the InServ Storage Server.

For detailed information regarding the Software subprofile, refer to SMI-S at http://
www.snia.org.

5.13.1 Software Subprofile CIM Classes

Table 5-51 shows the Software subprofile key CIM classes:

Software Subprofile 5.97

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-51. Software Subprofile CIM Classes

Class Description

TPD_StorageSystem The storage array on which the software is installed.

TPD_SoftwareIdentity Information on installed software on the specified

TPD_ComputerSystem.

5.13.2 Supported Methods

Table 5-52 shows the supported method of the software subprofile:

Table 5-52. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for
the StorageSystem.

5.14 Masking and Mapping Subprofile

The Masking and Mapping subprofile is used to determine which LUNs are visible to which
initiators through which target ports. The effect is that a given exported volume is only visible
to specific hosts through specific target ports. Per SMI-S, the ability to limit access is defined as
Device Masking; the ability to specify the device address seen by particular initiators is defined
as Device Mapping. The subprofile also specifies methods to allow administrators to actively
manage (export and delete) LUNs. The 3PAR CIM Server supports the Masking and Mapping
subprofile and allows for both the display and active management of LUNs.

For detailed information regarding the Masking and Mapping subprofile, refer to SMI-S at
http://www.snia.org.

5.14.1 Masking and Mapping Subprofile CIM Classes

Table 5-53 shows the Masking and Mapping subprofile key CIM classes:

5.98 Masking and Mapping Subprofile

 CIM API Programming Reference

Table 5-53. Masking and Mapping Subprofile CIM Classes

Class Description

TPD_AuthorizedPrivilege Represents the access permission that a

StorageHardwareID is allowed on a
SCSIProtocolController.

TPD_StorageSystem The storage array.

TPD_SCSIController Represents the SCSI view of ports as seen by SCSI

initiators.

TPD_iSCSIController Represents the iSCSI view of ports as seen by

iSCSI initiators.

TPD_ControllerConfigurationService Provides methods that allow a client to export

and delete LUNs on an InServ Storage Server.

TPD_StorageHardwareID An initiator port identifier, i.e., a host path.

TPD_StorageHardwareIDCollection A collection of related host paths. This is

equivalent to a Host as seen on an InServ Storage
Server.

CIM_StorageHardwareIDManagementService Provides methods that allow a client to create,

add/or delete hosts or host paths.

TPD_ProtocolControllerMaskingCapabilities Defines the masking related capabilities of the

InServ Storage System.

TPD_StorageVolume The storage volume to be exported.

Masking and Mapping Subprofile 5.99

 CIM API Programming Reference InForm OS Version 2.3.1

5.14.2 Supported Methods

Table 5-54 - Table 5-56 shows the supported methods of the masking and mapping subprofile:

Table 5-54. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact

information for the StorageSystem.

Table 5-55. Methods for TPD_HardwareIDManagementService

Method Description

CreateStorageHardwareID() Expose SCSI Logical units.

DeleteStorageHardwareID() Hide a list of SCSI logical units.

CreateStorageHardwareIDCollection() Create a collection of StorageHardwareIDs.

DeleteStorageHardwareIDCollection() Delete a collection of StorageHardwareIDs.

Table 5-56. Methods for TPD_ControllerConfigurationService

Method Description

ExposePaths() Expose SCSI Logical units.

HidePath() Hide a list of SCSI logical units.

5.100 Masking and Mapping Subprofile

 CIM API Programming Reference

Table 5-56. Methods for TPD_ControllerConfigurationService (continued)

Method Description

ExportDefaultLUs() Expose a list of SCSI logical units (such as RAID

volumes) through a “default view”
SCSIProtocolController (SPC) through a list
of target ports. The “default view” SPC exposes
logical units to all initiators. This SPC is identified
by an association to a StorageHardwareID with
Name property set to the empty string.

HideDefaultLUs() Hide a list of SCSI Logical Units (such as RAID

volumes) through a default view
SCSIProtocolController through a list of
target ports on a default view
SCSIProtocolController.

ExposeLUsToStorageHardwareIDCollection() Expose a list of SCSI logical units to a list of

StorageHardwareIDCollections (hosts).

HideLUsFromStorageHardwareIDCollection() Hide a list of SCSI logical units through a list of

StorageHardwareIDCollections (hosts).

5.14.3 SMI-S View and Paths

Storage arrays usually provide a means for the administrator to specify which initiators can
access what volumes via what logical unit number (LUN). The goal is that a given volume is
only accessible to SCSI commands originated from the specified initiators through specific sets
of target ports. The ability to limit access is called Device Masking. The ability to specify the
device address (LUN) seen by particular initiators is called Device Mapping. In InServ, storage
volumes must be explicitly exported to be visible to hosts or they are not accessible to any host.

A view is a list of logical units exposed through a list of target ports, modeled as
SCSIProtocolController (SPC) with associated StorageVolume, StorageHardwareIDs
(host WWN/iSCSIName), and SCSIProtocolEndPoints (port WWNs/iscsiNames). A path is a
combination of one each: logical unit (volume), initiator port (host port), and target port. An
SPC serves as a collection of paths.

Three kinds of SPCs are supported in the InServ environment:

Masking and Mapping Subprofile 5.101

 CIM API Programming Reference InForm OS Version 2.3.1

„ Full path SPC, where an SPC is a collection of paths with each path containing a
combination of logical unit (volume), initiator port (host port), and target port. Use
ExposePaths and HidePaths methods for adding/hiding this kind of path.

„ Default SPC, where an SPC is a collection of paths with each path containing a
combination of SCSIProtocolEndpoints (target port) and StorageVolume (LU), and
whatever host WWN/iSCSIName (StorageHardwareID) the target port is connected to.
Volumes in this kind of SPCs are exposed to any host that are connected to the target port.
In 3PAR parlance, this is termed a port-present VLUN. Each target port on an InServ node
controller has a default SPC associated with it. Each default SPC is associated to an
AuthorizedPrivilege which is then associated to a StorageHardwareID with a null
StorageID property. There is only one instance of null-StorageID
StorageHardwareID per InServ system. Use the ExposeDefaultLUs and
HideDefaultLUs methods for adding/hiding this kind of path.

„ SPC with no Target Ports, where an SPC is a collection of paths with each path containing
a combination of host collection (StorageHardwareIDCollection) and
StorageVolume (LU), and whatever target port the host is connected to. Volumes in this
kind of SPCs are exposed to the specified host collection regardless of which target port it is
connected to. This in 3PAR terms is called host-sees VLUN. Use the
ExposeLUsToStorageHardwareIDCollection and
HideLUsFromStorageHardwareIDCollection methods for adding/hiding this kind of
path.

5.102 Masking and Mapping Subprofile

 CIM API Programming Reference

Figure 5-7. Masking and Mapping Example 1 (Direct Attached Host)

Example 1 shows that there are views from 2 FC hosts with same volumes:

„ SPC_1: Volume_1 is exported to Server 1 via Port_WWN_1 (target port on InServ) as LUN 1
and Volume_2 as LUN 2. The host HBA is represented as Host_WWN_1.

„ SPC_2: Volume_2 is exported to Server 2 via Port_WWN_2 (target port on InServ) as LUN 5
and Volume_2 as LUN 6. The host HBA is represented as Host_WWN_2. Different LU
numbers are used in this example, but they can be assigned the same LUNs as in SPC_1.

Masking and Mapping Subprofile 5.103

 CIM API Programming Reference InForm OS Version 2.3.1

Figure 5-8. Masking and Mapping Example 2 (one InServ port connecting to fabric)

5.104 Masking and Mapping Subprofile

 CIM API Programming Reference

Figure 5-9. Masking and Mapping Example 3 (two InServ ports connecting to fabric).

5.14.4 ProtocolControllerMaskingCapabilities
This class describes the capabilities of the SPC in an InServ storage system, which describes the
kind of controller configuration and StorageHardwareID management services that are
available to clients. The following settings are fixed and cannot be modified:

„ PortsPerView:

‹ Release 2.2.4 and before: 2; one port per view.

‹ Release 2.3.1, 3, Multiple ports per view.

„ ClientSelectableDeviceNumbers: true; LUN ID can be selected by a client. For release

2.2.4 and before, the DeviceNumbers parameter is mandatory in the ExposePaths,
ExposeDefaultLUs and ExposeLUsToStorageHardwareIDCollection methods. For
release 2.3.1, the DeviceNumbers parameter is no longer mandatory.

„ AttachDeviceSupported: false.

Masking and Mapping Subprofile 5.105

 CIM API Programming Reference InForm OS Version 2.3.1

„ OneHardwareIDPerView:

‹ Release 2.2.4 and before: true; only one StorageHardwareID (host HBA WWN/
iSCSIName) per SPC.

‹ Release 2.3.1: false.

„ UniqueUnitNumbersPerPort: false.

„ PrivilegeDeniedSupported: false.

„ ProtocolControllerRequiresAuthorizedIdentity: false;
CreateProtocolControllerWithPorts method is not supported.

„ ProtocolControllerSupportsCollections: true; a collection of StorageHardwareIDs

(host HBA WWNs/iSCSNames) is supported.

„ ExposePathsSupported: true; InServ supports the ExposePaths method.

„ CreateProtocolControllerSupported: false; explicit creation of SPC is not supported.

„ MaximumMapCount: 0 (unlimited); a virtual volume can be exported unlimited number

of times.

„ SPCAllowsNoLUs: false; clients cannot create SPC that has no associations to LUs
(volumes). Default SPC is a special case in that it has no association with volumes, but
default SPC is only used as an input to the ExposeDefaultLUs method when adding LUs
to a view, in which case the resulting output SPC from the method, if successful, is not a
default SPC.

„ SPCAllowsNoTargets: false; clients cannot create SPC that has no associations to target
ports.

„ SPCAllowsNoInitiators: false; clients cannot create SPC that has no associations to host
HBA WWNs.

„ SPCSupportDefaultViews: true; default SPC which allows a volume to be exposed to all

initiators through a target port is supported (port-present VLUNs).

5.106 Masking and Mapping Subprofile

 CIM API Programming Reference

5.14.5 ControllerConfigurationService
ControllerConfigurationService (CCS) is the main class of Masking and Mapping (MM)
subprofile. This class enables clients to export and delete VLUNs. A client can get a handle of
CCS by using a HostedService association from ComputerSystem (StorageSystem).

Table 5-57 provides a brief summary of the CSS methods and their corresponding CLI
commands:

Table 5-57. CCS Methods and CLI Command Equivalents

Methods CLI Equivalences Comments

ExposePaths createvlun vvname lunID Host HBA WWN/iSCSIName

hostname n:s:p (StorageHardwareID) is
specified for ExposePaths
method; host name
(StorageHardwareIDCollecti
on.ElementName) is
specified for the CLI
createvlun command, not
the individual HBA WWN/
iSCSIName.

HidePaths removevlun vvname Host HBA WWN/iSCSIName

lunID hostname n:s:p (StorageHardwareID) is
specified for HidePaths
method; host name
(StorageHardwareIDCollecti
on.ElementName) is
specified for the CLI
removevlun command, not
the individual HBA WWN/
iSCSIName.

ExposeDefaultLUs createvlun vvname lunID

n:s:p

Masking and Mapping Subprofile 5.107

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-57. CCS Methods and CLI Command Equivalents (continued)

Methods CLI Equivalences Comments

HideDefaultLUs removevlun vvname

lunID n:s:p

ExposeLUsToStorageHard createvlun vvname lunID

wareIDCollection hostname

HideLUsFromStorageHard removevlun vvname

wareIDCollection lunID hostname

5.14.5.1 ExposePaths (Creating Matched-Set VLUNs)

ControllerConfigurationService.ExposePaths() performs VLUN export in one
method call. It exposes a list of volumes to a list of host port (HBAs - initiators) via a list of
InServ ports (targets). This method can be used either to create an
SCSIProtocolController (SPC) and modify an existing SPC. If the ProtocolController
parameter is null, the provider is supposed to create a new SPC.

This operation is similar to createvlun of matched-set VLUNs. For port-present VLUNs, see
ExportDefaultLUs. For host-sees VLUNs, see
ExposeLUsToStorageHardwareIDCollection. One difference between this method and
the CLI createvlun command is that for this method, the exact host WWN is specified
(InitiatorPortIDs), whereas for the createvlun command, the name of the host is
specified, not the WWN itself.

The method signature is described below:

uint32 ExposedPaths (
[Out] CIM_ConcreteJob ref Job,
[In] String LUNames[],
[In] String InitiatorPortIDs[],
[In] String TargetPortIDs[],
[In] String DeviceNumbers[],
[In] unit16 DeviceAccesses[],
[In/Out] CIM_SCSIProtocolController ref
ProtocolController[],
[In] boolean Override,
[In] boolean NoVCN,

5.108 Masking and Mapping Subprofile

 CIM API Programming Reference

[Out] String ResultDescriptions[]);

Masking and Mapping Subprofile 5.109

 CIM API Programming Reference InForm OS Version 2.3.1

„ Job: This is ignored since InServ does not support job control.

„ LUNames[]: An array of IDs of logical unit instances. The LU instances must already exist.
The members of this array must match the Name property of StorageVolume instances.

„ InitiatorPortIDs[]: IDs of initiator ports (host HBA WWNs). If an existing

StorageHardwareID instances exist, it is used. If no StorageHardwareID instance
matches, one is NOT implicitly created as is usually done from SMI-S. See the method
description for conditions where this may be null.

„ TargetPortIDs[]: IDs of target ports (InServ’s front-end FC port). See Table 5-58 on
page 5.111 for conditions where this may be null.

„ DeviceNumbers[]: A list of logical unit numbers to assign to the corresponding logical

unit in the LUNames parameter. (within the context of the elements specified in the other
parameters). If the LUNames parameter is null, then this parameter must be null. This
parameter is mandatory for release 2.2.4 and before. For release 2.3.1, this is optional; if
this parameter is NULL, the logical unit number will be assigned by the system.

„ DeviceAccesses[]: A list of permissions to assign to the corresponding logical unit in the

LUNames parameter. This specifies the permission to assign within the context of the
elements specified in the other parameters. This is mandatory only because SMI-S requires
it. For InServ, access permissions cannot be specified when creating a VLUN. Rather, each
volume has its own access permission. So the 3PAR ControllerConfigurationService
provider checks the passed in DeviceAccesses values against the permission of the
specified LU (volume), and the operation fails if the two values do not match.

„ ProtocolControllers[]: An array of references to SCSIProtocolControllers (SPCs). On

input, this can be null, or contain exactly one element; there may be multiple references on
output. If null on input, the instrumentation creates one or more new SPC instances. If SPC
is included on input, this can either be a reference to TPD_SCSIController for an FC
host or TPD_iSCSIController for a iSCSI host.

„ Override: Override existing lower priority VLUNs, if necessary. Can be used only when
exporting to a specific host. This parameter is a vendor-specific extension for 3PAR. The
default value is false.

„ NoVCN: Do not issue a VLUN (Virtual Logical Unit Number) Change Notification (VCN) after
export. For direct connect or loop configuration, a VCN consists of a fibre channel Loop
Initialization Primitive (LIP). For fabric configuration a VCN consists of Registered State
Change Notification (RSCN) being sent to the fabric controller. This parameter is a vendor-
specific extension for 3PAR. The default value is false.

5.110 Masking and Mapping Subprofile

 CIM API Programming Reference

„ ResultDescriptions[]: An array of descriptive text of the result of the operation, with each
entry containing the result of each expose path operation. This parameter is a vendor-
specific extension for 3PAR.

Table 5-58. ExposePath Use Cases

Use Cases LUNames InitiatorPortIDs TargetPortIDs DeviceNumbers DeviceAccesses ProtocolCon-

trollers
(On input)

Create a Mandatory Mandatory Mandatory Mandatory Mandatory NULL

new view for 2.2.4
and prior,
Optional
for 2.3.1
and above.

Add LUs to Mandatory NULL NULL Mandatory Mandatory Contains a

a view [not single SPC
supported ref
in 2.3.1]

Add NULL Mandatory NULL NULL NULL Contains a

InitiatorIDs single SPC
to View ref
[2.3.1 only]

Parameters “Override” and “NoVCN” are optional. All other combinations of the parameters
are rejected.

There are two use cases of the ExposePaths() method (See Table 5-58 on page 5.111 for
details).

„ Creating a new view: export a list of volumes to a list of host HBAs via specific target
port. This creates a “matched-set” VLUN. This case is indicated by NULL input
ProtocolController parameter.

„ Add InitiatorIDs to view: add another initiator ID (host path) to a view. The new initiator
port must be zoned with the same target port as that used by the view or else the
operation is rejected.

Masking and Mapping Subprofile 5.111

 CIM API Programming Reference InForm OS Version 2.3.1

5.14.5.2 HidePaths (Removing Matched-Set VLUNs)

HidePaths() is the inverse of ExposePaths. It hides a list of storage volumes from a list of
initiators through a list of target ports, through one or more SCSIProtocolControllers
(SPCs).

This operation is similar to removevlun of matched-set VLUNs. For port-present VLUNs, see
HideDefaultLUs. For host-sees VLUNs, see
HideLUsFromStorageHardwareIDCollection. One difference between this method and
the CLI removevlun command is that for this method, the exact host WWN/iscsiName is
specified (InitiatorPortIDs), whereas for the removevlun command, the name of the host is
specified, not the WWN/iscsiName itself.

The method signature is described below:

uint32 HidePaths (
[Out] CIM_ConcreteJob ref Job,
[In] String LUNames[],
[In] String InitiatorPortIDs[],
[In] String TargetPortIDs[],
[In] String DeviceNumbers[],
[In/Out] CIM_SCSIProtocolController ref
ProtocolController[],
[In] boolean NoVCN,
[Out] String ResultDescriptions[]);
„ Job: This is ignored since InServ does not support job control.

„ LUNames[]: An array of IDs of logical unit instances. The LU instances must already exist.
The members of this array must match the Name property of the StorageVolume
instances.

„ InitiatorPortIDs[]: IDs of initiator ports (host HBA WWNs)

„ TargetPortIDs[]: IDs of target ports (InServ’s front-end FC port).

„ DeviceNumbers[]: A list of logical unit numbers corresponding to the logical unit in the
LUNames parameter. This is a 3PAR vendor-specific extension and therefore is optional.

„ ProtocolControllers[]: An array of references to SCSIProtocolControllers (SPCs). On

input, this contain exactly one element; there may be multiple references on output. If SPC
is included on input, this can either be reference to TPD_SCSIController for FC host or
TPD_iSCSIController for iSCSI host.

5.112 Masking and Mapping Subprofile

 CIM API Programming Reference

„ NoVCN: Do not issue a VLUN (Virtual Logical Unit Number) Change Notification (VCN) after
removal. For direct connect or loop configuration, a VCN consists of a fibre channel Loop
Initialization Primitive (LIP). For fabric configuration a VCN consists of Registered State
Change Notification (RSCN) being sent to the fabric controller. This parameter is a vendor-
specific extension for 3PAR. The default value is false.

„ ResultDescriptions[]: An array of descriptive text of the result of the operation, with each
entry containing the result of each hide path operation. This parameter is a vendor-specific
extension for 3PAR.

Table 5-59. HidePaths Use Cases

Use Cases LUNames InitiatorPortIDs TagetPortIDs ProtocolControllers

(On input)

Remove Mandatory NULL NULL Contains a single

LUs from SPC ref
a view

Hide full Mandatory Mandatory Mandatory Contains a single

paths SPC ref
from a
view

Remove NULL Mandatory NULL Contains a single

Initiator SPC ref
IDs from
view
[2.3.1]

Parameters DeviceNumbers and NoVCN are optional. All other combinations of the
parameters are rejected.

The use cases are:

„ Remove volumes from a view: the volume has been exported to an SPC, it’ll be removed
from the SPC (e.g. it won’t be accessible from host HBA anymore).

„ Hide full paths from a view: similar to Remove LUs from a view, but
InitiatorPortIDs and TargetPortIDs parameters are included.

Masking and Mapping Subprofile 5.113

 CIM API Programming Reference InForm OS Version 2.3.1

„ Remove initiatorID from a view: Remove an initiator port from a view, valid only if
several host paths are zoned with a single target port.

5.14.5.3 ExposeDefaultLUs (Creating Port-Present VLUNs)

ControllerConfigurationService.ExposeDefaultLUs() is similar to ExposePaths,
except ExportDefaultLUs works with ‘default SPCs’, and exposes volumes to all initiators
through a list of target ports through the ‘default view’ SPC. This default SPC is identified by
an association to StorageHardwareID with StorageID property set to null (not zero-length
string).

This operation is similar to createvlun of port-present VLUNs. For matched-set VLUNs, see
ExportPaths. For host-sees VLUNs, see ExposeLUsToStorageHardwareIDCollection.

The method signature is described below:

uint32 ExposedDefaultLUs (
[Out] CIM_ConcreteJob ref Job,
[In] String LUNames[],
[In] String TargetPortIDs[],
[In] String DeviceNumbers[],
[In] unit16 DeviceAccesses[],
[In/Out] CIM_SCSIProtocolController ref
ProtocolController[],
[In] boolean Override,
[In] boolean NoVCN,
[Out] String ResultDescriptions[]);
„ Job: This is ignored since InServ does not support job control.

„ LUNames[]: An array of IDs of logical unit instances. The LU instances must already exist.
The members of this array must match the Name property of StorageVolume instances.

„ TargetPortIDs[]: IDs of target ports (InServ’s front-end FC port). See for conditions where
this may be null.

„ DeviceNumbers[]: A list of logical unit numbers to assign to the corresponding logical

unit in the LUNames parameter. (within the context of the elements specified in the other
parameters). If the LUNames parameter is null, then this parameter must be null. This
parameter is mandatory for release 2.2.4 and before. For release 2.3.1, this is optional; if
this parameter is NULL, the logical unit number will be assigned by the system.

„ DeviceAccesses[]: A list of permissions to assign to the corresponding logical unit in the

LUNames parameter. This specifies the permission to assign within the context of the

5.114 Masking and Mapping Subprofile

 CIM API Programming Reference

elements specified in the other parameters. This is mandatory only because SMI-S requires
it. For InServ, access permissions cannot be specified when creating a VLUN. Rather, each
volume has its own access permission. So the 3PAR ControllerConfigurationService
provider checks the passed in DeviceAccesses value against the permission of the
specified LU (volume), and the operation fails if the two values do not match.

„ ProtocolControllers[]: An array of references to SCSIProtocolControllers (SPCs). On

input, this can be null, or contain exactly one default SPC; there may be multiple references
on output. If null on input, the instrumentation creates one or more new SPC instances, but
these new SPC instances are NOT default SPCs, in the sense that they have associations to
host HBA WWN/iscsiName as well as to target ports and the exposed volumes.

„ Override: Override existing lower priority VLUNs, if necessary. Can be used only when
exporting to a specific host. This parameter is a vendor-specific extension for 3PAR. The
default value is false.

„ NoVCN: Do not issue a VLUN (Virtual Logical Unit Number) Change Notification (VCN) after
export. For direct connect or loop configuration, a VCN consists of a fibre channel Loop
Initialization Primitive (LIP). For fabric configuration a VCN consists of Registered State
Change Notification (RSCN) being sent to the fabric controller. This parameter is a vendor-
specific extension for 3PAR. The default value is false.

„ ResultDescriptions[]: An array of descriptive text of the result of the operation, with each
entry containing the result of each expose path operation. This parameter is a vendor-
specific extension for 3PAR.

Masking and Mapping Subprofile 5.115

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-60. ExposeDefaultLUs Use Cases

ProtocolCon
Use LUNames TargetPortIDs DeviceNumbers DeviceAccesses trollers
Cases (On input)

Create a Mandatory Mandatory Mandatory for Mandatory NULL

new 2.2.4 and
default before, optional
view for 2.3.1 and
beyond.

Add LUs Mandatory NULL Mandatory Mandatory Contains a

to a single
view [ default SPC
(Not ref
support
ed in
2.3.1)

Parameters “Override” and “NoVCN” are optional. All other combinations of the parameters
are rejected.

There are two use cases of ExposeDefaultLUs() method (See Table 5-60 on page 5.116):

1 Creating a new default view: export a list of volumes to all host HBAs that are
connected to the specified list of target ports. This creates a “port-present” VLUN. This case
is indicated by NULL input ProtocolController parameter.

2 Add LUs to a view: add volumes to an existing SPC view. (This feature is not supported in
version 2.3.1.)

5.14.5.4 HideDefaultLUs (Removing Port-Present VLUNs)

HideDefaultLUs() is the similar to HidePaths, except HideDefaultLUs works with
‘default SPCs’, and hides volumes from all initiators through a list of target ports through the
‘default view’ SPC. This default SPC is identified by an association to StorageHardwareID
with StorageID property set to null (not zero-length string).

5.116 Masking and Mapping Subprofile

 CIM API Programming Reference

This operation is similar to removevlun of port-present VLUNs. For matched-set VLUNs, see
HidePaths. For host-sees VLUNs, see HideLUsFromStorageHardwareIDCollection.

The method signature is described below:

uint32 HideDefaultLUs (
[Out] CIM_ConcreteJob ref Job,
[In] String LUNames[],
[In] String TargetPortIDs[],
[In] String DeviceNumbers[],
[In/Out] CIM_SCSIProtocolController ref
ProtocolController[],
[In] boolean NoVCN,
[Out] String ResultDescriptions[]);
„ Job: This is ignored since InServ does not support job control.

„ LUNames[]: An array of IDs of logical unit instances. The LU instances must already exist.
The members of this array must match the Name property of StorageVolume instances.

„ TargetPortIDs[]: IDs of target ports (InServ’s front-end FC port). This has to be NULL.

„ DeviceNumbers[]: A list of logical unit numbers corresponding to the logical unit in the
LUNames parameter. This is a 3PAR vendor-specific extension and therefore is optional.

„ ProtocolControllers[]:An array of references to SCSIProtocolControllers (SPCs). On

input, this must contain exactly one default SPC. On output, this is the set of SPCs affected.

„ NoVCN: Do not issue a VLUN (Virtual Logical Unit Number) Change Notification (VCN) after
removal. For direct connect or loop configuration, a VCN consists of a fibre channel Loop
Initialization Primitive (LIP). For fabric configuration a VCN consists of Registered State
Change Notification (RSCN) being sent to the fabric controller. This parameter is a vendor-
specific extension for 3PAR. The default value is false.

„ ResultDescriptions[]: An array of descriptive text of the result of the operation, with each
entry containing the result of each hide path operation. This parameter is a vendor-specific
extension for 3PAR.

Masking and Mapping Subprofile 5.117

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-61. HideDefaultLUs Use Cases

Use Cases LUNames TagetPortIDs ProtocolControllers

(On input)

Remove LUs from Mandatory NULL Contains a single default SPC

a view. ref.

Parameters “DeviceNumbers” and “NoVCN” are optional. All other combinations of the
parameters are rejected.

The use cases are:

„ Remove volumes from a view: the volume has been exported to an SPC, it’ll be removed
from the SPC (e.g. it won’t be accessible from host HBA anymore).

5.14.5.5 ExposeLUsToStorageHardwareIDCollection
(Creating Host-Sees VLUNs) (3PAR proprietary method)
ControllerConfigurationService.ExposeLUsToStorageHardware
IDCollection() is similar to ExposePaths, except
ExposeLUsToStorageHardwareIDCollection exposes volumes to all the initiator ports
(StorageHardwareID) on the specified hosts (StorageHardwareIDCollection)
regardless of which target ports they are connected to.

For release 2.2.4 and before, this method can only be used to create host-sees vluns. In release
2.3.1, an extra parameter, TargetPortLIPDs, is added which if specified also allows for
creation of matched-set VLUNs; this allows for more flexibility in creating template VLUNs to
target ports that might not exist yet.

The method signature is described below:

uint32 ExposedLUsToStorageHardwareIDCollection (
[Out] CIM_ConcreteJob ref Job,
[In] String LUNames[],
[In] String HostNames[],
[In] string TargetPortLPIDs[],
[In] String DeviceNumbers[],
[In] unit16 DeviceAccesses[],
[In/Out] CIM_SCSIProtocolController ref
ProtocolController[],

5.118 Masking and Mapping Subprofile

 CIM API Programming Reference

[In] boolean Override,

[In] boolean NoVCN,
[Out] String ResultDescriptions[]);

„ Job: This is ignored since InServ does not support job control.

„ LUNames[]: An array of IDs of logical unit instances. The LU instances must already exist.
The members of this array must match the Name property of StorageVolume instances.

„ HostNames[]: An array of names for the hosts (StorageHardwareIDCollection).

Instances MUST already exist. The members of this array MUST match the ElementName
property of TPD_StorageHardwareIDCollection.

„ TargetPortLPIDs[]: An array of target port LPIDs, in '<node>:<slot>:<port>' format. If

this is empty, then host-sees vlun is created; otherwise matched set vlun(s) is created.

„ DeviceNumbers[]: A list of logical unit numbers to assign to the corresponding logical

unit in the LUNames parameter. (within the context of the elements specified in the other
parameters). If the LUNames parameter is null, then this parameter must be null. This
parameter is mandatory for release 2.2.4 and before. For release 2.3.1, this is optional; if
this parameter is NULL, the logical unit number will be assigned by the system.

„ DeviceAccesses[]: A list of permissions to assign to the corresponding logical unit in the

LUNames parameter. This specifies the permission to assign within the context of the
elements specified in the other parameters. This is mandatory only to be consistent with
other methods. For InServ, access permissions cannot be specified when creating a VLUN.
Rather, each volume has its own access permission. So the 3PAR
ControllerConfigurationService provider checks the passed in DeviceAccesses
value against the permission of the specified LU (volume), and the operation fails if the two
values do not match.

„ ProtocolControllers[]: An array of references to SCSIProtocolControllers (SPCs). On

input, this can be null, or contain exactly one SPC; there may be multiple references on
output. If null on input, the instrumentation creates one or more new SPC instances. If SPC
is included on input, this can either be reference to TPD_SCSIController for FC host or
TPD_iSCSIController for iSCSI host

„ Override: Override existing lower priority VLUNs, if necessary. Can be used only when
exporting to a specific host. This parameter is a vendor-specific extension for 3PAR. The
default value is false.

Masking and Mapping Subprofile 5.119

 CIM API Programming Reference InForm OS Version 2.3.1

„ NoVCN: Do not issue a VLUN (Virtual Logical Unit Number) Change Notification (VCN) after
export. For direct connect or loop configuration, a VCN consists of a fibre channel Loop
Initialization Primitive (LIP). For fabric configuration a VCN consists of Registered State
Change Notification (RSCN) being sent to the fabric controller. This parameter is a vendor-
specific extension for 3PAR. The default value is false.

„ ResultDescriptions[]: An array of descriptive text of the result of the operation, with each
entry containing the result of each expose path operation. This parameter is a vendor-
specific extension for 3PAR.

Table 5-62. ExposeLUsToStorageHardwareIDCollection Use Cases

Use LUNames HostNames TargetPortLPIDs DeviceNumbers DeviceAccesses ProtocolControllers

Cases (On input)

Create Mandatory Mandatory Optional Mandatory for Mandatory NULL

a new 2.2.4 and
view before,
optional for
2.3.1 and
beyond.

Add Mandatory NULL N/A Mandatory Mandatory Contains a single

LUs to SPC ref
a view
[not
suppo
rted
in
2.3.1]

Parameters “Override” and “NoVCN” are optional. All other combinations of the parameters
are rejected.

There are two use cases of ExposeLUsToStorageHardwareIDCollection() method (See

Table 5-62 on page 5.120).

1 Creating a new default view: export a list of volumes to all host HBAs on a host
regardless of which target ports they are connected to. For release 2.2.4 and before, this
can only create a “host-sees” VLUN. For release 2.3.1, this creates host-sees VLUN if
TargetPortLPIDs is NULL, or matched-set VLUN if TargetPortLPIDs is specified. This
case is indicated by NULL input ProtocolController parameter.

5.120 Masking and Mapping Subprofile

 CIM API Programming Reference

2 Add LUs to a view: add volumes to an existing SPC view. (this feature is not supported in
2.3.1.)

5.15 HideLUsFromStorageHardwareIDCollection
(Removing Host-Sees VLUNs)
HideLUsFromStorageHardwareIDCollection()is a 3PAR proprietary method that is
similar to HidePaths, except that it hides volumes from all host HBA initiator ports on the
specified hosts.

This operation is similar to removevlun of host-sees VLUNs. For matched-set VLUNs, see
HidePaths. For port-present VLUNs, see HideDefaultLUs.

The method signature is described below:

uint32 HideLUsFromStorageHardwareIDCollection (
[Out] CIM_ConcreteJob ref Job,
[In] String LUNames[],
[In] String DeviceNumbers[],
[In/Out] CIM_SCSIProtocolController ref
ProtocolController[],
[In] boolean NoVCN,
[Out] String ResultDescriptions[]);
„ Job: This is ignored since InServ does not support job control.

„ LUNames[]: An array of IDs of logical unit instances. The LU instances must already exist.
The members of this array must match the Name property of StorageVolume instances.

‹ DeviceNumbers[]: A list of logical unit numbers corresponding to the logical unit in

the LUNames parameter. This is a 3PAR vendor-specific extension and is optional.

„ ProtocolControllers[]:An array of references to SCSIProtocolControllers (SPCs). On

input, this must contain exactly one SPC. On output, this is the set of SPCs affected. If SPC is
included on input, this can either be reference to TPD_SCSIController for a FC host or
TPD_iSCSIController for an iSCSI host.

„ NoVCN: Do not issue a VLUN (Virtual Logical Unit Number) Change Notification (VCN) after
removal. For direct connect or loop configuration, a VCN consists of a fibre channel Loop
Initialization Primitive (LIP). For fabric configuration a VCN consists of Registered State
Change Notification (RSCN) being sent to the fabric controller. This parameter is a vendor-
specific extension for 3PAR. The default value is false.

HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs) 5.121

 CIM API Programming Reference InForm OS Version 2.3.1

„ ResultDescriptions[]: An array of descriptive text of the result of the operation, with each
entry containing the result of each hide path operation. This parameter is a vendor-specific
extension for 3PAR.

Table 5-63. HideLUsFromStorageHardwareIDCollection Use Cases

Use Cases LUNames ProtocolControllers

(On input)

Remove LUs from a view Mandatory Contains a single SPC ref

Parameters “DeviceNumbers” and “NoVCN” are optional. All other combinations of the
parameters are rejected.

The use cases are:

„ Remove volumes from a view: the volume has been exported to an SPC, it’ll be removed
from the SPC (e.g., it won’t be accessible from host HBA anymore).

5.15.0.1 StorageHardwareIDManagementService
StorageHardwareIDManagementService provides methods for manipulating instances of
StorageHardwareIDs and manipulating the trust of these IDs in the underlying storage
system. This class enables clients to create and delete StorageHardwareID, create
StorageHardwareIDCollection and add StorageHardwareID to a collection. A client
can get a handle of StorageHardwareIDManagementService by using a HostedService
association from ComputerSystem (StorageSystem).

Here is a brief summary of the methods and their corresponding CLI commands:

5.122 HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs)

 CIM API Programming Reference

Table 5-64. StorageHardwareIDManagementService Methods and CLI Equivalents

Methods CLI Equivalence Comments

CreateStorageHardwareID createhost Only 1 host HBA

hostname WWN WWN/iscsiName
(StorageID) can be
specified at a time for
CreateStorage
HardwareID method.

DeleteStorageHardwareID removehost Only 1 host HBA

hostname WWN WWN/iscsiName
(StorageID) can be
deleted at a time for
DeleteStorage
HardwareID method.

CreateStorageHardwareIDCollection createhost
hostname [WWN …]

AddHardwareIDsToCollection createhost –add

hostname WWN…

StorageHardwareIDCollection.DeleteInstance removehost Delete the entire host

hostname and any path to the
host (Storage
HardwareID).

5.15.0.2 CreateStorageHardwareID (Creating Host and Path)

This method creates a StorageHardwareID (host HBA WWN/iscsiBane) on a host, it creates
the association TPD_MgmtServicesForStorageHWIDCollection between
TPD_StorageHardwareIDManagementService and the new TPD_StorageHardwareID.

This operation is similar to “createhost <hostname> <wwn>” or “createhost –iscsi

<hostname> <iscsiName>”. The host as specified in <hostname> must not have existed. If
the host already exists, use the method AddHardwareIDsToCollection instead to add host
HBA WWN/iscsiName.

HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs) 5.123

 CIM API Programming Reference InForm OS Version 2.3.1

The method signature is described below:

uint32 CreateStorageHardwareID (
[In] String ElementName,
[In] String StorageID,
[In] Uint16 IDType,
[In] String OtherIDType,
[In] CIM_StorageClientSettingData REF Setting,
[Out] CIM_StorageHardwareID REF HardwareID);

„ ElementName: This is the name of the host to create the host HBA WWN on. The host
must not have existed. This corresponds to the ElementName property of the
StorageHardwareID instance. If the host already exist, use
AddHardwareIDsToCollection instead. This is mandatory.

„ StorageID: WWN of the FC host HBA or iscsiName of the iSCSI host HBA to create. This is
mandatory.

„ IDType: Type of StorageID property. This must be 2 (Port WWN for FC target port) or 5
(iscsiName for iSCSI target port); all other values are rejected. This is mandatory.

„ OtherIDType: Description of the type of StorageID if IDType is 1 (Other). Since only

IDType of 2 and 5 is accepted, this value is ignored.

„ Setting: Reference to the StorageClientSettingData containing the OSType

appropriate for this initiator. For release 2.2.4 and before, this can only be NULL. For release
2.3.1, this refers to an TPD_StorageClientSettingData which is equivalent to a host
persona; if not specified then the host persona defaults to Generic.

„ HardwareID: Reference to the new StorageHardwareID instance. Must be NULL on

input.

5.15.0.3 DeleteStorageHardwareID (Removing a Path from a Host)

This method deletes a named StorageHardwareID (host HBA WWN/iscsiName) from a host,
and also tears down the associations that are no longer needed, including
CIM_ConcreteDependency and CIM_AuthorizedSubject.

This operation is similar to “removehost <hostname> <wwn>” or “removehost –iscsi

<hostname> <iscsiName>”.

The method signature is described below:

uint32 DeleteStorageHardwareID (

5.124 HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs)

 CIM API Programming Reference

[In] CIM_StorageHardwareID REF HardwareID);

„ HardwareID: Reference to the new StorageHardwareID instance to delete. This is
mandatory.

5.15.0.4 CreateStorageHardwareIDCollection (Creating a Host)

This method creates a StorageHardwareIDCollection (host) and optionally a list of
WWNs/iscsiNames to assign to it. This is useful to define a set of authorized subjects that can
access volumes. This method causes the creation of the HostedCollection association and
MemberOfCollection association to the members of the IDs parameter.

This operation is similar to “createhost <hostname>” and “createhost <hostname>

<wwn …>” or “createhost –iscsi <hostname> <iscsiName>”. The host as specified in
<hostname> must not have existed. If HardwareIDs (WWN/iscsiNames) are not specified,
then only the host is created.

The method signature is described below:

uint32 CreateStorageHardwareIDCollection (
[In] String ElementName,
[In] String HardwareIDs[],
[In] CIM_StorageClientSettingData REF Setting, [2.3.1]
[Out] CIM_SystemSpecificCollection REF Collection);
„ ElementName: This is the name of the host to create the host HBA WWN/iscsiName on.
The host must not have existed. This corresponds to the ElementName property of the
StorageHardwareID instance. If the host already exist, use
AddHardwareIDsToCollection instead. This is mandatory.

„ HardwareIDs: A list of WWN’s/iscsiNames to assign to the host. If this is null, only the host
(without WWN/iscsiName assigned) is created.

„ Setting: Reference to the StorageClientSettingData containing the OSType

appropriate for this initiator. This refers to an TPD_StorageClientSettingData which
is equivalent to a host persona; if not specified then the host persona defaults to Generic.
This parameter is added in 2.3.1.

„ Collection: Reference to the new StorageHardwareIDCollection (host) instance.

Must be NULL on input.

HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs) 5.125

 CIM API Programming Reference InForm OS Version 2.3.1

5.15.0.5 AddStorageHardwareIDsToCollection (Adding a Path to a Host)

This method adds a list of WWNs (StorageHardwareID) to the host
(StorageHardwareIDCollection). This creates the MemberOfCollection instances
between the specified Collection and the StorageHardwareIDs.

This operation is similar to “createhost -add <hostname> <wwn …>“ or “createhost

–add –iscsi <hostname> <iscsiName>”. The host as specified in <hostname> must have
existed.

The method signature is described below:

uint32 AddHardwareIDsToCollection (
[In] String HardwareIDs[],
[In] CIM_SystemSpecificCollection REF Collection);

„ HardwareIDs: A list of WWN’s/iscsiNames to assign to the host. This is mandatory.

„ Collection: A reference to the StorageHardwareIDCollection (host) to add the

WWN’s/iscsiNames to. This is mandatory.

5.15.0.6 StorageHardwareIDCollection.DeleteInstance (Deleting a Host)

The intrinsic method DeleteInstance is used to delete StorageHardwareIDCollection
(host).

5.15.1 ConcreteDependency
There are 3 ConcreteDependency classes in MM subprofile:

„ TPD_ConfigServicesForSCSIController: association between CCS with

TPD_SCSIProtocolController.

„ TPD_ConfigServicesForiSCSIController: association between CCS with

TPD_iSCSIProtocolController.

„ TPD_MgmtServicesForStorageHWIDCollection: association between

StorageHardwareID and StorageHardwareIDManagementService.

5.15.2 SAPAvailableForElement
This class replaces PrococolControllerForPort in SMI-S 1.0.2.
TPD_SAPAvailableForElement associates TPD_SCSIPrococolController to
TPD_SCSIPrococolEndPoint (FC target port). When a host is directly attached to InServ,

5.126 HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs)

 CIM API Programming Reference

SAPAvailableForElement represents a one-to-one relationship between SPC and

SCSIProtocolEndPoint because only one host can connect to one target port. When one
InServ port is connected to a switch in a fabric, there can be multiple hosts connecting to InServ
via the same target port (1-to-many association). When more than one InServ port are
connecting to the fabric with multiple hosts in the same zone, this association becomes n-to-n
relationship.

5.15.3 iSCSISAPAvailableForElement
This class replaces PrococolControllerForPort in SMI-S 1.0.2.
TPD_iSCSISAPAvailableForElement associates TPD_iSCSIPrococolController to
TPD_iSCSIPrococolEndPoint (iSCSI target port). When a host is directly attached to InServ,
iSCSISAPAvailableForElement represents a one-to-one relationship between SPC and
iSCSIPrococolEndPoint because only one host can connect to one target port. When one
InServ port is connected to a switch in a fabric, there can be multiple hosts connecting to InServ
via the same target port (1-to-many association). When more than one InServ port are
connecting to the fabric with multiple hosts in the same zone, this association becomes n-to-n
relationship.

5.15.4 SCSIPrococolController
SCSIPrococolController (SPC) represents the view described in SMI-S View and Paths on
page 5.101 for a Fiber-channel host.

5.15.5 iSCSIPrococolController
iSCSIPrococolController (SPC) represents the view described in SMI-S View and Paths on
page 5.101 for an iSCSI host.

5.15.6 SCSIPrococolEndpoint
SCSIPrococolEndpoint (subclass of LogicalPort) models SCSI aspect of an FC port. It is
associated with one or more FCPorts. One instance of this class must be created for each
target port (connecting to host or fabric).

Table 5-65. Properties for SCSIPrococolEndpoint

Properties Values

string Name Target port WWN

HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs) 5.127

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-65. Properties for SCSIPrococolEndpoint

Uint16 ProtocolIFType 56 (Fibre Channel)

Uint16 ConnectionType 2 (Fibre Channel)

Uint16 Role 2 (target port)

5.15.7 iSCSIPrococolEndpoint
iSCSIPrococolEndpoint (subclass of LogicalPort) models SCSI aspects of an iSCSI port.
Unlike TPD_SCSIPrococolEndpoint, however, this class is not associated to any
CIM_LogicalPort class since one does not exist for iSCSI port. One instance of this class must
be created for each target port (connecting to host or fabric).

Table 5-66. Properties Values for ISCSIPrococolEndpoint

Properties Values

string Name Target port iSCSIName + ‘t’ + TPGT

Uint16 ProtocolIFType 1 (other)

string OtherTypeDescription “iSCSI”

Uint16 ConnectionType 7 (iSCSI)

Uint16 Role 3 (target port)

5.15.8 ControllerForUnit
TPD_ControllerForUnit associates TPD_SCSIController for an FC host with
StorageVolumes. The LUN is modeled as the DeviceNumber property of
ProtocolControllerForUnit. The access permission is represented as DeviceAccess
property.

5.128 HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs)

 CIM API Programming Reference

Table 5-67. Property Values for TPD_ControllerForUnit

Properties Values

TPD_SCSIController Antecedent Reference to a TPD_SCSIController instance.

TPD_StorageVolume Dependent Reference to an exported TPD_StorageVolume

instance that is visible to protocol controller
above.

string DeviceNumber LUN of the storage volume via the above

protocol controller.

Uint16 DeviceAccess This value has to match that of StorageVolume.

Figure 5-10. Relationships between StorageHardwareID, SCSIProtocolEndpoint and StorageVolume

5.15.9 iSCSIControllerForUnit
Similar to TPD_SCSIControllerForUnit, except that TPD_iSCSIControllerForUnit
associates TPD_iSCSIController for an iSCSI host with StorageVolumes.

HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs) 5.129

 CIM API Programming Reference InForm OS Version 2.3.1

5.15.10 StorageClientSettingData
An array has several fixed instances of this class, each corresponding to a host persona. Each
instance of StorageHardwareID and StorageHardwareIDCollection has an
ElementSettingData association with an instance of StorageClientSettingData that
corresponds to the persona of the host.

To change the StorageClientSettingData of a host, a client should do a

ModifyInstance of the TPD_StorageHardwareIDCollection.Setting property.

5.15.11 StorageHardwareID
StorageHardwareID (subclass of Identity) represents the host HBA WWN/iscsiName.

5.15.12 TPD_StorageHardwareIDCollection
This is sub-classed from SystemSpecificCollection is used to hold a set of
StorageHardwareID objects which can access storage volumes.

5.15.13 Supporting classes

5.15.13.1 AuthorizedPrivilege
AuthorizedPrivilege represents access permission (read-write) that a
StorageHardwareID (host HBA) is allowed on a SCSIProtocolController. This
permission is associated with StorageHardwareID via AuthorizedSubject.

Table 5-68. Property Values for AuthorizedPrivilege

Properties Values

string ElementName User friendly name.

string InstanceID Opaque unique identifier.

boolean PrivilegeGranted True – privilege is granted, False – not granted.

Uint16[] Activities SMI-S: this array must contain 5 (read) and 6

(write).

5.130 HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs)

 CIM API Programming Reference

5.15.13.2 AuthorizedSubject
AuthorizedSubject associates StorageHardwareID to its access permission
(AuthorizedPrivilege).

5.15.13.3 AuthorizedTarget
AuthorizedTarget is an association that ties AuthorizedPrivilege with
SCSIProtocolController.

5.15.13.4 ConcreteDependency
ConcreteDependency links the SCSIProtocolController to
ControllerConfigurationService.

5.15.13.5 SystemEndpoint (HostedAccessPoint)

TPD_SystemEndpoint (a subclass of CIM_HostedAccessPoint) is an association between
ComputerSystem and SCSIProtocolEndpoint.

5.15.13.6 ElementCapabilities
ElementCapabilities is an association between ComputerSystem and
ProtocolControllerMaskingCapabilities.

5.15.13.7 ElementSettingData
There are 2 kinds of ElementSettingData associations:

1 Association between StorageHardwareID and StorageClientSettingData.

2 Association between StorageHardwareIDCollection and

StorageClientSettingData.

5.15.13.8 MemberOfCollection
MemberOfCollection is an association between StorageHardwareID and
SystemSpecificCollection. It indicates that a specific StorageHardwareID (host hba
wwn/iscsiName) is a member of SystemSpecificCollection/
StorageHardwareIDCollection (host).

5.15.13.9 ProtocolControllerMaskingCapabilities
See ProtocolControllerMaskingCapabilities on page 5.105.

HideLUsFromStorageHardwareIDCollection (Removing Host-Sees VLUNs) 5.131

 CIM API Programming Reference InForm OS Version 2.3.1

5.16 FC Target Ports Subprofile

The FC Target Ports subprofile models Fibre Channel specific aspects of a target storage system.
This subprofile provides information about FC ports on an InServ Storage Server that are
connected to hosts or FC switches.

For detailed information regarding the FC Target Ports subprofile, refer to SMI-S at http://
www.snia.org.

5.16.1 FC Target Ports Subprofile CIM Classes

Table 5-69 describes the FC Target Ports subprofile key CIM classes:

Table 5-69. FC Target Ports Subprofile CIM Classes

Class Description

TPD_StorageSystem The storage array on which the target ports reside.

TPD_SCSIProtocolFCEndpoint A SCSI transport endpoint. In this context, this represents a

target port on the InServ Storage System.

TPD_FCPort A Fibre Channel Port residing on the TPD_ComputerSystem.

TPD_SCSIController Represents the SCSI view of ports as seen by SCSI initiators.

5.16.2 Supported Methods

None

5.17 FC Initiator Ports Subprofile

The FC Initiator Ports subprofile models Fibre Channel specific aspects of a storage system. This
subprofile provides information about the backend Fibre Channel ports that are used to
connect InServ Storage Server Controller Nodes to backend Disk Enclosures (Drive Cages).

For detailed information regarding the FC Target Ports subprofile, refer to SMI-S at http://
www.snia.org.

5.132 FC Target Ports Subprofile

 CIM API Programming Reference

5.17.1 FC Initiator Ports Subprofile CIM Classes

Table 5-70 describes the FC Initiator Ports subprofile key CIM classes:
d

Table 5-70. FC Initiator Ports Subprofile CIM Classes

Class Description

TPD_StorageSystem The storage array on which the initiator ports reside.

TPD_SCSIProtocolFCEndpoint A SCSI transport endpoint. In this context, this represents an

initiator port on the InServ Storage System.

TPD_FCPort A Fibre Channel Port residing on the TPD_StorageSystem.

5.17.2 Supported Methods

Table 5-71 describes the supported methods of the FIbre Channel initiator ports subprofile:

Table 5-71. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for
the StorageSystem.

5.18 iSCSI Target Ports Subprofile

The iSCSI Target Ports subprofile models iSCSI specific aspects of a target storage system. This
subprofile provides information about FC ports on an InServ Storage Server that are connected
to hosts or FC switches.

The Multiple Computer System subprofile models the underlying systems or controllers that
cooperate to present a single, top-level system (Cluster) which provides for added redundancy
or increased functionality.
For detailed information regarding the FC Target Ports subprofile, refer to SMI-S at http://
www.snia.org.

iSCSI Target Ports Subprofile 5.133

 CIM API Programming Reference InForm OS Version 2.3.1

The 3PAR CIM Server supports the Multiple Computer System subprofile as defined in SMI-S
v1.1.0. This subprofile provides information about the Controller Nodes that comprise the
InServ Storage Server cluster. The cluster is modeled as multiple tiers with each tier
representing a pair of Controller Nodes.

5.18.1 iSCSI Target Ports Subprofile CIM Classes

Table 5-72 describes the iSCSI Target Ports subprofile key CIM classes:

Table 5-72. iSCSI Target Ports Subprofile CIM Classes

Class Description

TPD_StorageSystem The storage array on which the target ports reside.

TPD_iSCSIProtocolEndpoint An iSCSI transport endpoint. Represents an iSCSI port.

TPD_EthernetPort An Ethernet Port residing on the TPD_StorageSystem.

TPD_SCSIController Represents the SCSI view of ports as seen by SCSI initiators.

TPD_iSCSICapabilities Provides information about the iSCSI capabilities of an InServ

Storage System.

TPD_iSCSISession Provides information about iSCSI Sessions, which are established

between an initiator port and a target port.

TPD_iSCSISessionSettings Provides information about session-wide operational properties,

which are used during negotiation when creating new iSCSI
Sessions.

TPD_iSCSIConnection Provides information about the negotiated values for an iSCSI

connection.

5.134 iSCSI Target Ports Subprofile

 CIM API Programming Reference

5.18.2 Supported Methods

Table 5-73 describes the supported methods of the iSCSI target ports subprofile:

Table 5-73. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for
the StorageSystem.

5.19 Disk Drive Lite Subprofile

The Disk Drive Lite subprofile models information for disk drive devices. The information
provided via this subprofile is information about the disks that are accessible to a specific
InServ Storage Server.

For detailed information regarding the Disk Drive Lite subprofile, refer to SMI-S at http://
www.snia.org.

5.19.1 Disk Drive Lite Subprofile CIM Classes

Table 5-74 describes the Disk Drive Lite subprofile key CIM classes:

Table 5-74. Disk Drive Lite Subprofile CIM Classes

Class Description

TPD_StorageSystem The storage array on which the disk drives reside.

TPD_DiskDrive Information about a specific disk drive residing in the

TPD_StorageSystem.

TPD_DiskDrivePackage Provides physical information about the disk drive such as

Vendor, Model, Serial Number.

TPD_DiskSoftwareIdentity Provides information about installed firmware for disk drives.

Disk Drive Lite Subprofile 5.135

 CIM API Programming Reference InForm OS Version 2.3.1

Table 5-74. Disk Drive Lite Subprofile CIM Classes (continued)

Class Description

TPD_DiskStorageExtent Provides capacity information for disk drives.

TPD_StoragePool Identifies which Storage Pool contains the storage provided by

specific disk drives.

TPD_VolumeBasedOnDiskExtent Associations between a StorageVolume and the

DiskStorageExtent that makes up the volume. Includes
support for TPVV.

TPD_StoragePoolComponent Associations between a storage pool and the

DiskStorageExtent that make up the pool. Support for
DynamicStoragePool (CPG) and
DeltaReplicaStoragePool (snap space) is included.

5.19.2 Supported Methods

Table 5-75 lists the supported method of the Disk Drive Lite subprofile:

Table 5-75. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for
the StorageSystem.

5.136 Disk Drive Lite Subprofile

 CIM API Programming Reference

5.20 Block Server Performance Subprofile

The Block Server Performance Subprofile defines classes and methods for managing
performance information (statistics) in block servers.

For detailed information regarding the Block Server Performance subprofile, refer to SMI-S at
http://www.snia.org.

5.20.1 Block Server Performance Subprofile CIM Classes

Table 5-76 describes the various block server performance subprofile key CIM classes:

Table 5-76. Block Server Performance Subprofile CIM Classes

Class Description

TPD_StorageSystem The storage array on which the statistics are to be collected.

TPD_StatisticsCollection A collection of statistics data.

TPD_DiskStatisticalData An instance of statistics data for a TPD_DiskDrive.

TPD_PortStatisticalData An instance of statistics data for a TPD_FCPort.

TPD_VolumeStatisticalData An instance of statistics data for a TPD_StorageVolume.

TPD_LUNStatisticalData An instance of statistics data for an exported

TPD_StorageVolume.

TPD_ArrayStatisticalData An instance of statistics data for the entire array.

TPD_NodeStatisticalData An instance of statistics data for a particular node controller.

Block Server Performance Subprofile 5.137

 CIM API Programming Reference InForm OS Version 2.3.1

5.138 Block Server Performance Subprofile

InForm OS Version 2.3.1 CIM API Programming Reference

6
CIM Indications

In this chapter
6.1 Overview 6.1

6.2 Fibre Channel Ports 6.1

6.1 Overview
SMI-S provides for asynchronous notification of events that indicate changes in the CIM server
or the managed elements controlled by the CIM server. CIM Indications are the mechanism for
delivery of such events. A CIM client must subscribe to indications it wants to receive event
notifications from the CIM server. For detailed information regarding Indications, refer to
SMI S at http://www.snia.org.

6.2 Fibre Channel Ports

The 3PAR CIM Server currently supports indication subscriptions for changes in the operational
status of Fibre Channel ports. Clients must send the following query string to the 3PAR CIM
Server:

SELECT * FROM CIM_InstModification WHERE SourceInstance = CIM_FCPort

CIM Indications 6.1

 CIM API Programming Reference InForm OS Version 2.3.1

6.3 Job Control for Copy Services

The 3PAR CIM Server supports indication subscriptions for changes in the operational status of
a concrete job related to Copy Services. Clients must send the following query string to the
3PAR CIM Server:

SELECT * FROM CIM_InstModification WHERE SourceInstance ISA CIM_ConcreteJob

6.4 Thin Provisioning

The 3PAR CIM Server supports indication subscriptions for various thin provisioning related
alert indications. Clients may send the following query string to the 3PAR CIM Server to receive
all of the alert indications:

SELECT * FROM CIM_AlertIndication

As an alternative, the client can send any of the following to choose the specific indication(s)
to receive:

SELECT * FROM TPD_StoragePoolGrowWarningAlert

SELECT * FROM TPD_StoragePoolGrowLimitAlert

SELECT * FROM TPD_StoragePoolGrowFailureAlert

SELECT * FROM TPD_StoragePoolOverUsedWarningAlert

SELECT * FROM TPD_StorageVolumeAllocationFailureAlert

SELECT * FROM TPD_StorageVolumeAllocationWarningAlert

SELECT * FROM TPD_StorageVolumeAllocationLimitAlert

SELECT * FROM TPD_SnapShotAdminSpaceAlert

SELECT * FROM TPD_SnapShotUserSpaceAlert

6.2 Job Control for Copy Services

InForm OS Version 2.3.1 CIM API Programming Reference

7
3PAR CIM-API Extensions

In this chapter
7.1 Health Management 7.2

7.1.1 Controller Node Subsystem 7.2

7.1.2 Supported Methods 7.5

7.1.3 Disk Enclosure Subsystem 7.6

7.1.4 Supported Methods 7.9

7.1.5 Power and Cooling 7.10

7.1.6 Supported Methods 7.14

7.2 Inventory Management 7.15

7.2.1 Controller Node Subsystem 7.15

7.2.2 Supported Methods 7.19

7.2.3 Disk Enclosure Subsystem 7.20

7.2.4 Supported Methods 7.24

7.2.5 Power and Cooling 7.25

7.2.6 Supported Methods 7.28

3PAR CIM-API Extensions 7.1

 CIM API Programming Reference InForm OS Version 2.3.1

The 3PAR CIM Server supports additional classes that provide management for InServ Storage
Server specific features not covered by SMI-S.

7.1 Health Management

The 3PAR CIM Server provides the ability to retrieve health information about the physical
devices that comprise the InServ Storage Server. This can be broken down into the following
areas:

„ The Controller Node Subsystem

„ The Disk Enclosure Subsystem

„ Power and Cooling

7.1.1 Controller Node Subsystem

The 3PAR CIM Server provides the ability to manage the health of Controller Nodes and all of
the components that comprise the Controller Node Subsystem portion of the InServ Storage
Server.

7.1.1.1 Controller Node Subsystem CIM Classes

Table 7-1 shows the Controller Node Subsystem CIM key classes:

Table 7-1. Controller Node Subsystem CIM Classes

Class Description

TPD_StorageSystem The Storage array.

TPD_NodeSystem Provides information about the Controller Nodes that make up the
InServ Storage Server.

TPD_NodePackage Physical aspects of a Controller Node. This class is used to gather

information about all associated physical components of a Node
System.

TPD_PCICard Provides information about any PCI Cards installed in a Controller

Node.

7.2 Health Management

InForm OS Version 2.3.1 CIM API Programming Reference

Table 7-1. Controller Node Subsystem CIM Classes (continued)

Class Description

TPD_NodeCPU Provides information about the CPU(s) contained within each

Controller Node.

TPD_PhysicalMemory Provides information about the physical memory contained within

each Controller Node.

TPD_IDEDrive Provides information about the onboard IDE drive contained within
each Controller Node.

7.1.1.2 Properties for TPD_StorageSystem

Table 7-2. TPD_StorageSystem Properties

Property Description

Name The node WWN for the storage system.

ElementName User friendly-name of the storage system.

OperationalStatus Overall status of the storage system. Refer to SMI-S for possible values
of this property.

OtherOperationalStatus 3PAR specific operational status for the StorageSystem.

7.1.1.3 Properties for TPD_NodeSystem

Table 7-3. TPD_NodeSystem Properties

Property Description

Position The position of the controller node in the storage system (i.e., node
number).

ElementName User friendly-name of the controller node.

Health Management 7.3

 CIM API Programming Reference InForm OS Version 2.3.1

Table 7-3. TPD_NodeSystem Properties (continued)

Property Description

OperationalStatus Overall status of the controller node. Refer to SMI-S for possible
values of this property.

OtherOperationalStatus 3PAR specific operational status for the NodeSystem.

7.1.1.4 Properties for TPD_PCICard

Table 7-4. TPD_PCICard Properties

Property Description

Slot Slot number in which this card is inserted.

OperationalStatus Overall status of the PCI Card. Refer to SMI-S for possible values of
this property.

OtherOperationalStatus 3PAR specific operational status for the PCI Card.

7.1.1.5 Properties for TPD_NodeCPU

Table 7-5. TPD_NodeCPU Properties

Property Description

Position The position/CPU number of this component.

OperationalStatus Overall status of the CPU. Refer to SMI-S for possible values of this
property.

OtherOperationalStatus 3PAR specific operational status for the CPU.

7.4 Health Management

InForm OS Version 2.3.1 CIM API Programming Reference

7.1.1.6 Properties for TPD_PhysicalMemory

Table 7-6. TPD_PhysicalMemory Properties

Property Description

Slot Slot number in which this memory card is inserted.

SlotID Connector ID where this card is inserted (such as J1101).

OperationalStatus Overall status of the memory card. Refer to SMI-S for possible values
of this property.

OtherOperationalStatus 3PAR specific operational status for the memory card.

7.1.1.7 Properties for TPD_IDEDrive

Table 7-7. TPD_IDEDrive Properties

Property Description

Position The position number of this component.

OperationalStatus Overall status of the IDE Drive. Refer to SMI-S for possible values of
this property.

OtherOperationalStatus 3PAR specific operational status for the IDE Drive.

7.1.2 Supported Methods

Table 7-1 shows the supported methods of the StorageSystem:

Table 7-8. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for the
StorageSystem.

Health Management 7.5

 CIM API Programming Reference InForm OS Version 2.3.1

7.1.2.1 UML Diagram

Figure 7-1. Controller Node Subsystem

7.1.3 Disk Enclosure Subsystem

The 3PAR CIM Server provides the ability to manage the health of physical devices that
comprise the backend Disk Enclosure portion of the InServ Storage Server.

7.1.3.1 Disk Enclosure Subsystem CIM Classes

Table 7-9 shows the key classes of the Disk Enclosure Subsystem:

Table 7-9. Disk Enclosure Subsystem

Class Description

TPD_StorageSystem The storage array.

TPD_DriveCage Provides information about InServ Storage Server drive cages.

TPD_CageInterfaceCard Provides information about the Fibre Channel interface cards

contained within a TPD_DriveCage.

7.6 Health Management

InForm OS Version 2.3.1 CIM API Programming Reference

Table 7-9. Disk Enclosure Subsystem (continued)

Class Description

TPD_Magazine Provides information about drive magazines contained within a

TPD_DriveCage.

TPD_DiskDrive Provides information about disk drives.

TPD_DiskDrivePackage Physical aspects of a disk drive. This class is used to gather

information about the association of drive magazines to disk drives.

7.1.3.2 Properties for TPD_StorageSystem

Table 7-10. TPD_StorageSystem Properties

Property Description

Name The node WWN for the storage system.

ElementName User-friendly name of the storage system.

OperationalStatus Overall status of the storage system. Refer to the SMI-S for possible
values of this property.

OtherOperationalStatus 3PAR specific operational status for the StorageSystem.

7.1.3.3 Properties for TPD_DriveCage

Table 7-11. TPD_DriveCage Properties

Property Description

Position The position of the drive cage in the storage system (i.e., cage
number).

ElementName User-friendly name of the drive cage.

Health Management 7.7

 CIM API Programming Reference InForm OS Version 2.3.1

Table 7-11. TPD_DriveCage Properties (continued)

Property Description

OperationalStatus Overall status of the drive cage. Refer to SMI-S for possible values for
this property.

OtherOperationalStatus 3PAR specific operational status for the DriveCage.

7.1.3.4 Properties for TPD_CageInterfaceCard

Table 7-12. TPD_CageInterfaceCard Properties

Property Description

Position The position of the CageInterfaceCard in the DriveCage.

OperationalStatus Overall status of the CageInterfaceCard. Refer to SMI-S for

possible values of this property.

7.1.3.5 Properties for TPD_Magazine

Table 7-13. TPD_Magazine Properties

Property Description

ElementName User-friendly name of the drive magazine. The format vary

depending on type of drive cage.

Position The position of this drive magazine in the drive cage.

OperationalStatus Overall status of the drive magazine. Refer to SMI-S for possible
values of this property.

OtherOperationalStatus 3PAR specific operational status for the Magazine.

7.8 Health Management

InForm OS Version 2.3.1 CIM API Programming Reference

7.1.3.6 Properties for TPD_DiskDrive

Table 7-14. TPD_DiskDrive Properties

Property Description

ElementName User-friendly name of the disk drive. The format varies depending on
the type of the drive cage.

Name The Fibre Channel WWN of this disk drive.

Position The position of this disk drive in the drive magazine.

ID ID assigned to this Disk Drive by the system.

OperationalStatus Overall status of the disk drive. Refer to SMI-S for possible values of
this property.

OtherOperationalStatus 3PAR specific operational status for the DiskDrive.

7.1.4 Supported Methods

Table 7-1 shows the supported methods of the StorageSystem:

Table 7-15. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for the
StorageSystem.

Health Management 7.9

 CIM API Programming Reference InForm OS Version 2.3.1

7.1.4.1 UML Diagram

Figure 7-2. Disk Enclosure Subsystem

7.1.5 Power and Cooling

The 3PAR CIM Server provides information about the devices used to power and cool the
InServ Storage Server.

7.1.5.1 Power and Cooling CIM Classes

Table 7-16 shows the key CIM classes:

Table 7-16. Power and Cooling CIM Classes

Class Description

TPD_StorageSystem The storage array.

TPD_NodeSystem Provides information about the controller nodes that make up the InServ
Storage Server.

7.10 Health Management

InForm OS Version 2.3.1 CIM API Programming Reference

Table 7-16. Power and Cooling CIM Classes (continued)

Class Description

TPD_DriveCage Provides information about InServ Storage Server drive cages.

TPD_PowerSupply Provides information about power supplies for both controller nodes and
disk cages.

TPD_Battery Provides information about batteries attached to controller node power

supplies.

TPD_Fan Provides information about fans, including fans within each power supply
and external fans connected to controller nodes.

7.1.5.2 Properties for TPD_StorageSystem

Table 7-17. TPD_StorageSystem Properties

Property Description

Name The node WWN for the storage system.

ElementName User-friendly name of the storage system.

OperationalStatus Overall status of the StorageSystem. Please refer to SMI-S for

possible values of this property.

OtherOperationalStatus 3PAR specific operational status for the StorageSystem.

7.1.5.3 Properties for TPD_NodeSystem

Table 7-18. TPD_NodeSystem Properties

Property Description

Position The position of the Controller Node in the storage system (such as
the node number).

ElementName User-friendly name of the Controller Node.

Health Management 7.11

 CIM API Programming Reference InForm OS Version 2.3.1

Table 7-18. TPD_NodeSystem Properties (continued)

Property Description

OperationalStatus Overall status of the Controller Node. Please refer to SMI-S for
possible values of this property.

OtherOperationalStatus 3PAR specific operational status for the NodeSystem.

7.1.5.4 Properties for TPD_DriveCage

Table 7-19. TPD_DriveCage Properties

Property Description

Position The position of the DriveCage in the storage system (such as the
cage number).

ElementName User-friendly name of the DriveCage.

OperationalStatus Overall status of the DriveCage. Please refer to SMI-S for possible
values of this property.

OtherOperationalStatus 3PAR specific operational status for the DriveCage.

7.1.5.5 Properties for TPD_PowerSupply

Table 7-20. TPD_PowerSupply Properties

Property Description

Position The position of the PowerSupply in the storage system (such as the
PS number).

OperationalStatus Overall status of the PowerSupply. Please refer to SMI-S for possible
values of this property.

OtherOperationalStatus 3PAR specific operational status for the PowerSupply.

7.12 Health Management

InForm OS Version 2.3.1 CIM API Programming Reference

Table 7-20. TPD_PowerSupply Properties (continued)

Property Description

ACStatus Provides information about the AC status of a power supply.

DCStatus Provides information about the DC status of a power supply.

7.1.5.6 Properties for TPD_Battery

Table 7-21. TPD_Battery Properties

Property Description

Position The position of the Battery in the storage system (such as the battery
number).

OperationalStatus Overall status of the Battery. Please refer to SMI-S for possible values
of this property.

OtherOperationalStatus 3PAR specific operational status for the Battery.

BatteryStatus Detailed status information about the Battery.

7.1.5.7 Properties for TPD_Fan

Table 7-22. TPD_Fan Properties

Property Description

Position The position of the Fan in the PowerSupply or Storage System (such
as the fan number).

OperationalStatus Overall status of the Fan. Please refer to SMI-S for possible values of
this property.

OtherOperationalStatus 3PAR specific operational status for the Fan.

Health Management 7.13

 CIM API Programming Reference InForm OS Version 2.3.1

7.1.6 Supported Methods

Table 7-1 shows the supported methods of the StorageSystem:

Table 7-23. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for the
StorageSystem.

7.1.6.1 UML Diagram

Figure 7-3. Power and Cooling

7.14 Health Management

InForm OS Version 2.3.1 CIM API Programming Reference

7.2 Inventory Management

The 3PAR CIM Server provides the ability to retrieve inventory information for Controller
Nodes and all of the components that comprise the Controller Node Subsystem portion of the
InServ Storage Server.

7.2.1 Controller Node Subsystem

The 3PAR CIM Server provides the ability to retrieve inventory information about the physical
devices that comprise the InServ Storage Server. This can be broken down into the following
areas:

„ The Controller Node Subsystem

„ The Disk Enclosure Subsystem

„ Power and Cooling

7.2.1.1 Controller Node Subsystem CIM Classes

Table 7-24 shows the Controller Node Subsystem key classes:

Table 7-24. Controller Node Subsystem CIM Classes

Class Description

TPD_StorageSystem The Storage array.

TPD_NodeSystem Provides information about the Controller Nodes that make up the
InServ Storage Server.

TPD_NodePackage Physical aspects of a Controller Node. This class is used to gather

information about all associated physical components of a Node
System.

TPD_PCICard Provides information about any PCI Cards installed in a Controller

Node.

TPD_NodeCPU Provides information about the CPU(s) contained within each

Controller Node.

Inventory Management 7.15

 CIM API Programming Reference InForm OS Version 2.3.1

Table 7-24. Controller Node Subsystem CIM Classes (continued)

Class Description

TPD_PhysicalMemory Provides information about the physical memory contained within

each Controller Node.

TPD_IDEDrive Provides information about the onboard IDE drive contained within
each Controller Node.

7.2.1.2 Properties for TPD_StorageSystem

Table 7-25. TPD_StorageSystem Properties

Property Description

Name The Node WWN for the storage system.

ElementName User friendly-name of the storage system.

7.2.1.3 Properties for TPD_SystemPackage

Table 7-26. TPD_SystemPackage Properties

Property Description

Manufacturer Manufacturer of the StorageSystem (3PAR).

Model Model of the StorageSystem.

SerialNumber Serial number of the StorageSystem.

Version Version of the software running on the StorageSystem.

7.16 Inventory Management

InForm OS Version 2.3.1 CIM API Programming Reference

7.2.1.4 Properties for TPD_NodeSystem

Table 7-27. TPD_NodeSystem Properties

Property Description

Position The position of the Controller Node in the storage system (such as
the node number).

ElementName User friendly name of the Controller Node.

7.2.1.5 Properties for TPD_NodePackage

Table 7-28. TPD_NodePackage Properties

Property Description

Manufacturer Manufacturer of the Controller Node.

Model Model of the Controller Node.

SerialNumber Serial number of the Controller Node.

7.2.1.6 Properties for TPD_PCICard

Table 7-29. TPD_PCICard Properties

Property Description

Slot Slot number in which this card is inserted.

Manufacturer Manufacturer of the PCI Card.

Model Model of the PCI Card.

SerialNumber Serial number of the PCI Card.

Revision The revision of the PCI Card.

FirmwareVersion Revision of the firmware running on the card.

Inventory Management 7.17

 CIM API Programming Reference InForm OS Version 2.3.1

7.2.1.7 Properties for TPD_NodeCPU

Table 7-30. TPD_NodeCPU Properties

Property Description

Position The position/CPU number of this component.

Manufacturer Manufacturer of the CPU.

Model Model number for the CPU.

SerialNumber Serial number for the CPU.

7.2.1.8 Properties for TPD_PhysicalMemory

Table 7-31. TPD_PhysicalMemory Properties

Property Description

Slot Slot number where this memory card is inserted.

SlotID Connector ID where this card is inserted (such as slot J1101).

Manufacturer Manufacturer for the memory card.

PartNumber Part number for the memory card.

SerialNumber Serial number for the memory card.

7.2.1.9 Properties for TPD_IDEDrive

Table 7-32. TPD_IDEDrive Properties

Property Description

Position The position number of this component.

Manufacturer Manufacturer of the drive.

Model Model number for the drive.

7.18 Inventory Management

InForm OS Version 2.3.1 CIM API Programming Reference

Table 7-32. TPD_IDEDrive Properties (continued)

Property Description

SerialNumber Serial number for the drive.

FwRevision Revision of the firmware running on the drive.

7.2.2 Supported Methods

Table 7-1 shows the supported method of the StorageSystem:

Table 7-33. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for the
StorageSystem.

7.2.2.1 UML Diagram

Figure 7-4. Controller Node Subsystem

Inventory Management 7.19

 CIM API Programming Reference InForm OS Version 2.3.1

7.2.3 Disk Enclosure Subsystem

The 3PAR CIM Server provides the ability to retrieve inventory information for all of the
components that comprise the backend Disk Enclosure portion of the InServ Storage Server.

7.2.3.1 Disk Enclosure Subsystem CIM Classes

Table 7-34 shows the Disk Enclosure Subsystem key classes:

Table 7-34. Disk Enclosure Subsystem

Class Description

TPD_StorageSystem The storage array.

TPD_DriveCage Provides information about InServ Storage Server drive cages.

TPD_CageInterfaceCard Provides information about the Fibre Channel interface cards

contained within a TPD_DriveCage.

TPD_Magazine Provides information about drive magazines contained within a

TPD_DriveCage.

TPD_DiskDrive Provides information about disk drives.

TPD_DiskDrivePackage Physical aspects of a disk drive. This class is used to gather

information about the association of drive magazines to disk drives.

7.2.3.2 Properties for TPD_StorageSystem

Table 7-35. TPD_StorageSystem Properties

Property Description

Name The node WWN for the storage system.

ElementName User-friendly name of the storage system.

7.20 Inventory Management

InForm OS Version 2.3.1 CIM API Programming Reference

7.2.3.3 Properties for TPD_DriveCage

Table 7-36. TPD_DriveCage Properties

Property Description

Position The position of the drive cage in the storage system (such as the cage
number).

ElementName User-friendly name of the Drive Cage.

Manufacturer Manufacturer of the Drive Cage.

Model Model of the Drive Cage.

SerialNumber Serial number of the Drive Cage.

7.2.3.4 Properties for TPD_CageInterfaceCard

Table 7-37. TPD_CageInterfaceCard Properties

Property Description

Position The position of the CageInterfaceCard in the DriveCage.

Manufacturer Manufacturer of the CageInterfaceCard.

Model Model of the CageInterfaceCard.

SerialNumber SerialNumber of the CageInterfaceCard.

FirmwareVersion Revision of the firmware running on the CageInterfaceCard.

Inventory Management 7.21

 CIM API Programming Reference InForm OS Version 2.3.1

7.2.3.5 Properties for TPD_Magazine

Table 7-38. TPD_Magazine Properties

Property Description

ElementName User-friendly name of the drive magazine. The format vary

depending on type of drive cage.

Position The position of this drive magazine in the drive cage.

Manufacturer Manufacturer of the magazine.

Model Model of the magazine.

SerialNumber Serial number of the magazine.

7.2.3.6 Properties for TPD_DiskDrive

Table 7-39. TPD_DiskDrive Properties

Property Description

ElementName User-friendly name of the DiskDrive. The format vary depending

on the type of the DriveCage.

Name The Fibre Channel WWN of this DiskDrive.

Position The position of this DiskDrive in the magazine.

ID ID assigned to this DiskDrive by the system.

7.2.3.7 Properties for TPD_DiskDrivePackage

Table 7-40. TPD_DiskDrivePackage Properties

Property Description

Manufacturer Manufacturer of the DiskDrive.

7.22 Inventory Management

InForm OS Version 2.3.1 CIM API Programming Reference

Table 7-40. TPD_DiskDrivePackage Properties (continued)

Property Description

Model Model of the DiskDrive.

SerialNumber Serial number of the DiskDrive.

7.2.3.8 Properties for TPD_DiskSoftwareIdentity

Table 7-41. TPD_DiskSoftwareIdentity Properties

Property Description

Manufacturer Manufacturer of the DiskDrive firmware.

VersionString Version of the firmware running on the DiskDrive.

Inventory Management 7.23

 CIM API Programming Reference InForm OS Version 2.3.1

7.2.4 Supported Methods

Table 7-1 shows the supported method of the StorageSystem :

Table 7-42. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for the
StorageSystem.

7.2.4.1 UML Diagram

Figure 7-5. Disk Enclosure Subsystem

7.24 Inventory Management

InForm OS Version 2.3.1 CIM API Programming Reference

7.2.5 Power and Cooling

The 3PAR CIM Server provides the ability to retrieve inventory information for the physical
devices used to power and cool the InServ Storage Server.

7.2.5.1 Power and Cooling CIM Classes

Table 7-43 shows the Power and Cooling key classes:

Table 7-43. Power and Cooling CIM Classes

Class Description

TPD_StorageSystem The storage array.

TPD_NodeSystem Provides information about the controller nodes that make up the InServ
Storage Server.

TPD_DriveCage Provides information about InServ Storage Server drive cages.

TPD_PowerSupply Provides information about power supplies for both controller nodes and
disk cages.

TPD_Battery Provides information about batteries attached to controller node power

supplies.

TPD_Fan Provides information about fans, including fans within each power supply
and external fans connected to controller nodes.

7.2.5.2 Properties for TPD_StorageSystem

Table 7-44. TPD_StorageSystem Properties

Property Description

Name The node WWN for the storage system.

ElementName User-friendly name of the storage system.

Inventory Management 7.25

 CIM API Programming Reference InForm OS Version 2.3.1

7.2.5.3 Properties for TPD_NodeSystem

Table 7-45. TPD_NodeSystem Properties

Property Description

Position The position of the Controller Node in the storage system (such as
the node number).

ElementName User-friendly name of the Controller Node.

7.2.5.4 Properties for TPD_DriveCage

Table 7-46. TPD_DriveCage Properties

Property Description

Position The position of the DriveCage in the storage system (such as the
cage number).

ElementName User-friendly name of the DriveCage.

Manufacturer Manufacturer of the Drive Cage.

Model Model of the Drive Cage.

SerialNumber Serial number of the Drive Cage.

7.2.5.5 Properties for TPD_PowerSupply

Table 7-47. TPD_PowerSupply Properties

Property Description

Position The position of the PowerSupply in the storage system (such as the
PS number).

Manufacturer Manufacturer of the PowerSupply.

7.26 Inventory Management

InForm OS Version 2.3.1 CIM API Programming Reference

Table 7-47. TPD_PowerSupply Properties (continued)

Property Description

Model Model of the PowerSupply.

SerialNumber Serial number of the PowerSupply.

7.2.5.6 Properties for TPD_Battery

Table 7-48. TPD_Battery Properties

Property Description

Position The position of the Battery in the storage system (such as the battery
number).

Manufacturer Manufacturer of the Battery.

Model Model of the Battery.

SerialNumber Serial number of the Battery.

7.2.5.7 Properties for TPD_Fan

Table 7-49. TPD_Fan Properties

Property Description

Position The position of the Fan in the PowerSupply or Storage System (such
as the fan number).

Manufacturer Manufacturer of the Fan.

Model Model of the Fan.

SerialNumber Serial number of the Fan.

Inventory Management 7.27

 CIM API Programming Reference InForm OS Version 2.3.1

7.2.6 Supported Methods

Table 7-1 shows the supported method of the StorageSystem:

Table 7-50. Methods for TPD_StorageSystem

Method Description

modifyInstance() Provides the ability to set owner and contact information for the
StorageSystem.

7.2.6.1 UML Diagram

Figure 7-6. Power and Cooling

7.3 Thin Provisioning and TPVV Manipulations

Please see Chapter 5, 3PAR CIM API SMI-S Support for complete details on DynamicStoragePool
(DSP) and TPVV manipulations.

7.28 Thin Provisioning and TPVV Manipulations

InForm OS Version 2.3.1 CIM API Programming Reference

A
Managed Object Format
Files

In this appendix
A.1 3PAR_InterOp.mof A.2

A.2 3PAR_TPD.mof A.7

A.3 3PAR_TPDCage.mof A.65

A.4 PAR_TPDDisk.mof A.81

A.5 3PAR_TPDNode.mof A.90

A.6 3PAR_TPDEnv.mof A.101

A.7 3PAR_TPDLocation.mof A.109

A.8 3PAR_TPDEthPort.mof A.110

A.9 3PAR_TPDiSCSI.mof A.113

A.10 3PAR_TPDStats.mof A.124

This appendix provides the contents of the Managed Object Format (MOF) files for the InServ
Storage Server. These MOF files derive from the standard MOF files contained in CIM, version
2.11. For information regarding standard MOF files, please refer to DMTF at http://
www.dmtf.org.

Managed Object Format Files A.1

 CIM API Programming Reference InForm OS Version 2.3.1

NOTE: The MOF's in this chapter might not be current; for the up-to-date MOFs,
please copy and paste from the files in the /net/toolchest/export/bk/swiss_2.3.1/
tpdsrc/umod/api/pegasus/Schemas/TPD directory.

A.1 3PAR_InterOp.mof
This MOF contains 3PAR classes that loaded into the root/PG_InterOp namespace.

// ==================================================================
// RegisteredProfile
// ==================================================================
[Description (
"RegisteredProfile tells clients what profiles 3PAR InServ Storage "
"Server supports. ")]
class TPD_RegisteredProfile : CIM_RegisteredProfile {
};

// ==================================================================
// RegisteredSubProfile
// ==================================================================
[Description (
"A RegisteredSubProfile subclasses RegisteredProfile to "
"indicate that a scoping profile is required to provide "
"context. The latter is specified by the mandatory association, "
"SubProfileRequiresProfile.")]
class TPD_RegisteredSubProfile : CIM_RegisteredSubProfile {
};

// ==================================================================
// SubProfileRequiresProfile - association between RegisteredProfile and
// RegisteredSubProfile
// ==================================================================
[Association,
Description (
"A subprofile requires another RegisteredProfile for context. "
"This association mandates the scoping relationship between a "
"subprofile and its scoping profile.")]
class TPD_SubProfileRequiresProfile : CIM_SubProfileRequiresProfile {

A.2 3PAR_InterOp.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Override ( "Antecedent" ), Min ( 1 ), Description (

"The RegisteredProfile that is referenced/required by the "
"subprofile.")]
TPD_RegisteredProfile REF Antecedent;

[Override ( "Dependent" ), Description (

"A RegisteredSubProfile that requires a scoping profile, for "
"context.")]
TPD_RegisteredSubProfile REF Dependent;
};

// ==================================================================
// RegisteredProfile and ComputerSystem association
// ==================================================================
[Association, Description (
"The CIM_ElementConformsToProfile association defines the "
"RegisteredProfiles to which the referenced ManagedElement is "
"conformant. This association specifically ties RegisteredProfile "
"with 3PAR InServ Storage Server (TPD_StorageSystem, subclass of "
"CIM_ComputerSystem) if the profile is Array, and with the "
"Object Manager if the profile is Server.")]
class TPD_ElementConformsToProfile : CIM_ElementConformsToProfile {

[Override ("ConformantStandard"), Description (

"The RegisteredProfile to which the InServ Storage Server conforms.")]
TPD_RegisteredProfile REF ConformantStandard;
};

// ==================================================================
// ObjectManager
// ==================================================================
[Description (
"TPD_ObjectManager defines the capabilities of the 3PAR InServ "
"Storage System CIM Server in which this ObjectManager class "
"resides. Details related to communicating with the ObjectManager, "
"and the Manager's basic capabilities, are stored in instances of the "
"associated TPD_CIMXMLCommunicationMechanism class available through "
"the TPD_CommMechanismForManager association. ")]
class TPD_ObjectManager : CIM_ObjectManager {
};

// ==================================================================
// TPD_HostedOMService: Association between CIM_System and TPD_ObjectManager
// ==================================================================
[Association,

3PAR_InterOp.mof A.3
 CIM API Programming Reference InForm OS Version 2.3.1

Description (
"TPD_HostedOMService is an association between TPD_ObjectManager and the
"
"System on which the functionality resides. The cardinality of "
"this association is 1-to-many. A System may host many "
"Services. Services are weak with respect to their hosting "
"System. Heuristic: A Service is hosted on the System where the "
"LogicalDevices or SoftwareFeatures that implement the Service "
"are located. The model does not represent Services hosted "
"across multiple systems. This is modeled as an "
"ApplicationSystem that acts as an aggregation point for "
"Services, that are each located on a single host.")]
class TPD_HostedOMService : CIM_HostedService {

[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (

"The InServ StorageSystem.")]
TPD_StorageSystem REF Antecedent;

[Override ( "Dependent" ), Weak, Description (

"The Object Manager hosted on the 3PAR InServ Storage System.")]
TPD_ObjectManager REF Dependent;
};

// ==================================================================
// Namespace
// ==================================================================
[Description (
"Namespace provides a domain (in other words, a container), in "
"which the instances [of a class] are guaranteed to be unique "
"per the KEY qualifier definitions. It is named relative to the "
"TPD_ObjectManager implementation that provides such a domain.")]
class TPD_Namespace : CIM_Namespace {
};

// ==================================================================
// NamespaceInManager - association between Namespace and Object Mgr
// ==================================================================
[Association,
Description (
"NamespaceInManager is an association describing the Namespaces "
"hosted by the TPD_ObjectManager.")]
class TPD_NamespaceInManager: CIM_NamespaceInManager {

[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (

"The ObjectManager containing a Namespace.")]

A.4 3PAR_InterOp.mof
InForm OS Version 2.3.1 CIM API Programming Reference

TPD_ObjectManager REF Antecedent;

[Override ( "Dependent" ), Weak, Description (

"The Namespace in an ObjectManager.")]
TPD_Namespace REF Dependent;
};

// ==================================================================
// CIMXMLCommunicationMechanism
// ==================================================================
[Description (
"This class specializes ObjectManagerCommunicationMechanism, "
"adding properties specific to the CIM-XML protocol (XML "
"encoding and CIM Operations) supported by the 3PAR CIM "
"server Object Manager.")]
class TPD_CIMXMLCommunicationMechanism : CIM_CIMXMLCommunicationMechanism {
[Description ( "Is this link encrypted or not. http or https. ")]
String namespaceType;

[Description ( "NamespaceType definition. Note that namespaceType"

"is the official name of this field in the CIM specification "
"Object Name definition."),
ValueMap {"0", "2", "3", "4..100" },
Values { "Unknown", "http", "https", "Pegasus Reserved" }]
Uint16 namespaceAccessProtocol;

[Description ( "IP Address for this comm mechanism. This MUST "
"BE the complete address so that the CIM Server can be "
"addressed from the network. It must include the port "
"number unless the DMTF defined default ports are used." )]
String IPAddress;
};

// ==================================================================
// TPD_CommMechanismForManager - Association between TPD_ObjectManager
// and TPD_CIMXMLCommunicationMechanism
// ==================================================================
[Association,
Description (
"CommMechanismForManager is an association between an "
"ObjectManager and an TPD_CIMXMLCommunicationMechanism "
"class. The latter describes a possible encoding/protocol/ set "
"of operations for accessing the referenced ObjectManager.")]
class TPD_CommMechanismForManager : CIM_CommMechanismForManager {

3PAR_InterOp.mof A.5
 CIM API Programming Reference InForm OS Version 2.3.1

[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (

"The 3PAR CIM server ObjectManager whose communication mechanism is "
"described.")]
TPD_ObjectManager REF Antecedent;

[Override ( "Dependent" ), Min ( 1 ), Description (

"The encoding/protocol/set of operations that may be used to "
"communicate with the referenced ObjectManager.")]
TPD_CIMXMLCommunicationMechanism REF Dependent;
};

// ==================================================================
// TPD_HostedCIMXMLCommMechanism - Association between TPD_StorageSystem
// and TPD_CIMXMLCommunicationMechanism
// ==================================================================
[Association,
Description (
"HostedCIMXMLCommMechanism is an association between a Service "
"AccessPoint and the System on which it is provided. The "
"cardinality of this association is 1-to-many and is weak with "
"respect to the System. Each System may host many "
"ServiceAccessPoints. Heuristic: If the implementation of the "
"ServiceAccessPoint is modeled, it must be implemented by a "
"Device or SoftwareFeature that is part of the System hosting "
"the ServiceAccessPoint.")]
class TPD_HostedCIMXMLCommMechanism : CIM_HostedAccessPoint {

[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (

"The InServ StorageSystem.")]
TPD_StorageSystem REF Antecedent;

[Override ( "Dependent" ), Weak, Description (

"The encoding/protocol/set of operations that may be used to "
"communicate with the referenced ObjectManager.")]
TPD_CIMXMLCommunicationMechanism REF Dependent;
};

// ==================================================================
// 3PAR ObjMgrSoftwareIdentity
// ==================================================================
[Description (
"3PAR ObjMgrSoftwareIdentity describes the Object Manager"
"software used to instrument the various profiles and subprofiles.")]
class TPD_ObjMgrSoftwareIdentity : CIM_SoftwareIdentity
{

A.6 3PAR_InterOp.mof
InForm OS Version 2.3.1 CIM API Programming Reference

};

// ==================================================================
// 3PAR Profiles and Subprofiles software identity
// ==================================================================
[Association,
Description (
"3PAR ObjMgrSoftwareIdentity and RegisteredProfile"
" and RegisteredSubProfile mapping")]
class TPD_ProfileSoftwareIdentity : CIM_ElementSoftwareIdentity {

[Override ( "Antecedent" ), Description (

"The software that is needed to instrument the providers for "
"the RegisterdProfiles and RegisteredSubProfiles.")]
TPD_ObjMgrSoftwareIdentity REF Antecedent;

[Override ( "Dependent" ), Description (

"The RegisterdProfile or RegisteredSubProfile.")]
CIM_RegisteredProfile REF Dependent;
};

A.2 3PAR_TPD.mof
This MOF contains 3PAR classes that loaded into the root/tpd namespace.

// ==================================================================
// 3PAR SCSIController
// ==================================================================
[Description (
"3PAR Data SCSI ProtocolController ")]
class TPD_SCSIController: CIM_SCSIProtocolController
{
};

// ==================================================================
// 3PAR StoragePool
// ==================================================================
[Description (
"3PAR Data StoragePool ")]
class TPD_StoragePool: CIM_StoragePool
{
[Description (
"Type of disk drives that are in this pool. Not applicable "

3PAR_TPD.mof A.7
 CIM API Programming Reference InForm OS Version 2.3.1

"to primordial pool."),

ValueMap {"0", "1", "2"},
Values {"Unknown", "FC", "Nearline"} ]
uint16 DiskDeviceType;

};

// ==================================================================
// 3PAR StorageVolume
// ==================================================================
[Description (
"3PAR Data StorageVolume ")]
class TPD_StorageVolume: CIM_StorageVolume
{
[Description (
"Describe the RAID type of the volume. This value makes it easy"
" for traversing ElementSettingData association."),
ValueMap {"0", "10", "50"},
Values {"RAID0", "RAID10", "RAID50"} ]
uint16 RaidType;

[Description (
"Volume overall state. Possible value is a combination of following
states: "
"0x00000000, 0x00000001, 0x00000002, 0x00000004, 0x00000008, 0x00000010,
"
"0x00000020, 0x00000040, 0x00000080, 0x00000100, 0x00000200, 0x00000400,
"
"0x00000800"),
BitMap { "0","1","2","3","4","5","6","7","8","9","10","11","12" },
BitValues {"Unknown", "Started", "Not Started", "Auto-Check",
"Checking", "Need Check", "Need Disk", "Promoting",
"Copy Failed", "Stale", "Copying", "Admin Failed", "Preserved"} ]
uint32 OtherOperationalStatus;

[Description (
"Describe the type of the volume."),
ValueMap {"0", "1", "2", "3", "4"},
Values {"Unknown", "Base", "Physical Copy", "Virtual Copy", "Remote Copy"}
]
uint16 VolumeType;

[Description (
"Total number of logically contiguous blocks, of size Block "
"Size, which form Raw Size Admin. The total size "

A.8 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"can be calculated by multiplying BlockSize by RawAdminBlocks.")]

uint64 RawAdminBlocks;

[Description (
"The maximum number of blocks, of size BlockSize, which are "
"available for consumption in Admin space. The total size "
"can be calculated by multiplying BlockSize by ConsumableAdminBlocks.")]
uint64 ConsumableAdminBlocks;

[Description (
"Total number of logically contiguous blocks, of size Block "
"Size, which form Free Size Admin. The total size "
"can be calculated by multiplying BlockSize by FreeAdminBlocks.")]
uint64 FreeAdminBlocks;

[Description (
"Total number of logically contiguous blocks, of size Block "
"Size, which form Raw Size Copy. The total size "
"can be calculated by multiplying BlockSize by RawCopyBlocks.")]
uint64 RawCopyBlocks;

[Description (
"The maximum number of blocks, of size BlockSize, which are "
"available for consumption in Copy space. The total size "
"can be calculated by multiplying BlockSize by ConsumableCopyBlocks.")]
uint64 ConsumableCopyBlocks;

[Description (
"Total number of logically contiguous blocks, of size Block "
"Size, which form Free Size Copy. The total size "
"can be calculated by multiplying BlockSize by FreeCopyBlocks.")]
uint64 FreeCopyBlocks;

[Description (
"Total number of zones in the Admin space.")]
uint64 TotalAdminZones;

[Description (
"Total number of zones in the Copy space.")]
uint64 TotalCopyZones;

[Description (
"Number of free zones in the Admin space.")]
uint64 FreeAdminZones;

3PAR_TPD.mof A.9
 CIM API Programming Reference InForm OS Version 2.3.1

[Description (
"Number of free zones in the Copy space.")]
uint64 FreeCopyZones;

[Description (
"The date this volume was created.")]
datetime DateCreated;

[Description (
"Master node ID.") ]
uint16 MasterNode;

[Description (
"Backup 1 node ID.") ]
uint16 BackupNode1;

[Description (
"Backup 2 node ID.") ]
uint16 BackupNode2;

[Description (
"Parent volume ID.") ]
uint32 ParentID;

[Description (
"Volume policy bits used to store policies information. "
"The available policies are: "
"DisallowStaleSnapshot - When copy-on-write fails, don't write to r/w "
" base so that r/o snapshots remain valid/consistent with r/w "
" base. This means failures to update snapshot will be "
" considered a failure to write to the base volume as well. "
"AllowStaleSnapshot - When copy-on-write fails, allow write to r/w base "
" to succeed, but snapshot becomes invalid or stale. This means "
" failures to update snapshot will not affect the write to the "
" base volume, but the snapshot will then be considered invalid. "
" This is the default setting. "
"System - Volume is intended to be used for internal system purposes."
"NoSystem - Volume is not intended to be used for internal system "
" purposes."
"TPZeroFill - For Thin Provisioned volumes, if a host write results in "
" allocation of a new data page that is only partially "
" filled by the host write, then do a zero-fill on the "
" unwritten portion of the page to ensure that the host can "
" never read old data from deleted volumes or snapshots. "
" Current allocation page size is 16kb. This is the "

A.10 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

" default setting. "

"TPNoZeroFill - Bypass the zero-fill stage on allocation of partially "
" written data pages. This is a performance improvement "
" setting for Thin Provisioned volumes. "
"OneHost - This constrains the export of a volume to one host or "
" one host cluster (when cluster names may be used as a "
" host name). Unless the volume is under the complete "
" control of a cluster aware application, multiple hosts "
" (with NoOneHost policy) will corrupt each other's data. "
"NoOneHost - This policy should only be used when exporting a volume to "
" multiple hosts for use by a cluster-aware application, "
" or if your shop uses 'port presents' VLUNs. "
" This is the default policy setting."
"ZeroDetect - Check If incoming data is zero. If so, reclaim the space."
"NoZeroDetect - No need to check if incoming data is zero."
"Possible value is a combination of following values: "
" 0x80000000 - DisallowStaleSnapshot"
" 0x40000000 - AllowStaleSnapshot"
" 0x20000000 - System"
" 0x10000000 - NoSystem"
" 0x08000000 - TPZeroFill"
" 0x04000000 - TPNoZeroFill"
" 0x02000000 - OneHost"
" 0x01000000 - NoOneHost"
" 0x00200000 - ZeroDetection"
" 0x00100000 - NoZeroDetection"),
BitMap { "31","30","29","28","27","26","25","24","21", "20" },
BitValues {"DisallowStaleSnapshot", "AllowStaleSnapshot",
"System", "NoSystem", "TPZeroFill", "TPNoZeroFill",
"OneHost", "NoOneHost", "ZeroDetection", "NoZeroDetection"}]
uint32 Policy;

[Description (
"Describes the preferred availability of the volume. "
"This value might be different from CurrentAvailability."),
ValueMap {"0", "1", "2", "3", "4", "5"},
Values {"Unknown", "Cage", "Magazine", "Port", "Disk", "Chunklet"} ]
uint16 PreferredAvailability;

[Description (
"Describes the current availability of the volume. "
"This value might be different from PreferredAvailability."),
ValueMap {"0", "1", "2", "3", "4", "5"},
Values {"Unknown", "Cage", "Magazine", "Port", "Disk", "Chunklet"} ]
uint16 CurrentAvailability;

3PAR_TPD.mof A.11
 CIM API Programming Reference InForm OS Version 2.3.1

[Description (
"Describes the export state of the volume."),
ValueMap {"0", "1", "2"},
Values {"None", "Active", "Template"} ]
uint16 ExportState;

[Description (
"Type of disk drives that are used to create this volume."),
ValueMap {"0", "1", "2"},
Values {"Unknown", "FC", "Nearline"} ]
uint16 DiskDeviceType;

[Description (
"Allocation warning. Generate a warning alert when SD space "
"of the volume exceeds the specified percentage of the volume "
"size."),
Units ( "Percent" )]
uint32 SnapSpaceAllocationWarning;

[Description (
"Allocation limit. The SD space of the volume is prevented "
"from growing beyond the specified percentage of the volume "
"size."),
Units ( "Percent" )]
uint32 SnapSpaceAllocationLimit;

[Description (
"Allocation warning. Generate a warning alert when user space "
"of the volume exceeds the specified percentage of the volume "
"size. Applicable only to a thin-provisioned volume."),
Units ( "Percent" )]
uint32 UserSpaceAllocationWarning;

[Description (
"Allocation limit. The user space of the volume is prevented "
"from growing beyong the specified percentage of the volume "
"size. Applicable only to a thin-provisioned volume."),
Units ( "Percent" )]
uint32 UserSpaceAllocationLimit;

[Description (
"The DynamicStoragePool (DSP) the snapshot data (SD) "
"are provisioned from.\n")]
String SnapDSPName;

A.12 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Description (
"The DynamicStoragePool (DSP) the user space "
"is provisioned from.\n")]
String UserDSPName;

[Description (
"The number of user blocks that are actually allocated to a "
"thin-provisioned volume. "
"This is applicable only for a thin-provisioned volume.")]
uint64 ProvisionedConsumableBlocks;

[Description (
"Name of the administrative domain that this volume belongs "
"to.\n")]
String Domain;

[Description (
"Number of chunklets in a set. "
"For RAID 0 volume, this is always 1. "
"For RAID 10 volume, this is equal to StorageSetting.DataRedundancy. "
"Minimum value for RAID 10 volume is 2, maximum value is 4. "
"For RAID 50 volume, this is also known as the parity "
"set size."),
MinValue ( 1 ) ]
uint16 SetSize;

[Description (
"Number of chunklets in a set that contains data. "
"Meaningful for RAID 60 volume only."),
MinValue ( 3 ) ]
uint16 SetData;

[Description ("The time specifies when the volume will expire and "
"can be deleted.") ]
datetime ExpirationTime;

[Description ("The time specifies the volume needs to be retained and "
"can not remove until the retention time is expired.") ]
datetime RetentionTime;
};

// ==================================================================
// 3PAR HostedStoragePool
// ==================================================================

3PAR_TPD.mof A.13
 CIM API Programming Reference InForm OS Version 2.3.1

[Association, Aggregation, Composition,

Description (
"3PAR HostedStoragePool (association between StoragePool and "
"StorageSystem) ")]
class TPD_HostedStoragePool: CIM_HostedStoragePool
{
[Override ("GroupComponent"), Aggregate, Max (1), Min (1),
Description ("The parent system in the association.") ]
TPD_StorageSystem REF GroupComponent;

[Override ("PartComponent"), Description (

"The StoragePool that is on the system.") ]
TPD_StoragePool REF PartComponent;
};

// ==================================================================
// 3PAR AllocatedFromStoragePool
// ==================================================================
[Association,
Description (
"TPD_AllocatedFromStoragePool is an association describing how "
"StorageVolume are allocated from underlying StoragePools."
"This association is used to figure out the remaining space "
"and the consumed space in the pool.") ]
class TPD_AllocatedFromStoragePool: CIM_AllocatedFromStoragePool
{
[Override ( "Antecedent" ), Description (
"The StoragePool.")]
TPD_StoragePool REF Antecedent;
};

// ==================================================================
// 3PAR StorageSetting
// ==================================================================
[Description (
"3PAR Data StorageSetting ")]
class TPD_StorageSetting: CIM_StorageSetting
{
[Write, Description (
"The number of data chunklets in a RAID 50 parity set. "
"The system default is 4 chunklets: 3 for data and 1 for "
"parity (3+1).\n"
"This is meaningless for RAID 0 or RAID 10 volumes."),
MinValue ( 3 ), MaxValue ( 9 ) ]

A.14 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

uint16 ParitySetSize;

[Write, Description (
"Base ID of the volume. If NULL, the next available "
"id used."),
MinValue ( 1 ) ]
uint32 BaseID;

[Write, Description (
"Whether a RAID 10 or RAID 50 volume supports a failure "
"of one port pair, one cage or one magazine. For RAID 10 "
"and RAID 50, the default for user, snap admin and snap "
"data areas are cage. For RAID 0, the default for the "
"snap admin area is cage.\n"),
ValueMap { "1", "2", "3" },
Values { "Cage", "Magazine", "Port" }]
uint16 HighAvailability;

[Write, Description (
"Chunklet location preference. Allows chunklets to "
"be placed physically close to other chunklets with "
"the same location preference.\n"
" First - attempt to use the lowest numbered\n"
" available chunklets.\n"
" Last - attempt to use the highest numbered\n"
" available chunklets.\n"
"The default value is First.\n"),
ValueMap { "1", "2" },
Values { "First", "Last" }]
uint16 ChunkletLocationPreference;

[Write, Description (
"Size for the snap volume in bytes (maximum 1073741568). "
"The default value is not set.\n"
"If CPGName is specified, this value should be 0.\n"
"Only one of DeltaReservationGoal and SnapVolumeSize "
"can be set.\n"),
Units ( "Bytes" )]
uint64 SnapVolumeSize;

[Write, Description (
"Size for the admin volume in bytes (maximum 1073741568). "
"The default value is not set.\n"
"This property is valid only in a grow volume operation."),
Units ( "Bytes" )]

3PAR_TPD.mof A.15
 CIM API Programming Reference InForm OS Version 2.3.1

uint64 AdminVolumeSize;

[Write, Description (
"Provision snapshot data (SD) and snapshot admin (SA) "
"space from the Common Provisioning Group CPGName.\n")]
String CPGName;

[Write, Description (
"If TRUE, the volume or pool is thinly provisioned.") ]
boolean ThinlyProvisioned;

[Write, Description (
"Define volume policy. The available policies are: "
"DisallowStaleSnapshot - When copy-on-write fails, don't write to r/w "
" base so that r/o snapshots remain valid/consistent with r/w "
" base. This means failures to update snapshot will be "
" considered a failure to write to the base volume as well. "
"AllowStaleSnapshot - When copy-on-write fails, allow write to r/w base "
" to succeed, but snapshot becomes invalid or stale. This means "
" failures to update snapshot will not affect the write to the "
" base volume, but the snapshot will then be considered invalid. "
" This is the default setting. "
"System - Volume is intended to be used for internal system purposes."
"NoSystem - The volume is not intended to be used for internal system "
" purposes."
"TPZeroFill - For Thin Provisioned volumes, if a host write results in "
" allocation of a new data page that is only partially "
" filled by the host write, then do a zero-fill on the "
" unwritten portion of the page to ensure that the host can "
" never read old data from deleted volumes or snapshots. "
" Current allocation page size is 16kb. This is the "
" default setting. "
"TPNoZeroFill - Bypass the zero-fill stage on allocation of partially "
" written data pages. This is a performance improvement "
" setting for Thin Provisioned volumes. "
"OneHost - This constrains the export of a volume to one host or "
" one host cluster (when cluster names may be used as a "
" host name). Unless the volume is under the complete "
" control of a cluster aware application, multiple hosts "
" (with NoOneHost policy) will corrupt each other's data. "
"NoOneHost - This policy should only be used when exporting a volume to "
" multiple hosts for use by a cluster-aware application, "
" or if your shop uses 'port presents' VLUNs. "
" This is the default policy setting."
"ZeroDetect - Check If incoming data is zero. If so, reclaim the space."

A.16 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"NoZeroDetect - No need to check if incoming data is zero."

"Possible value is a combination of following values: "
" 0x80000000 - DisallowStaleSnapshot"
" 0x40000000 - AllowStaleSnapshot"
" 0x20000000 - System"
" 0x10000000 - NoSystem"
" 0x08000000 - TPZeroFill"
" 0x04000000 - TPNoZeroFill"
" 0x02000000 - OneHost"
" 0x01000000 - NoOneHost"
" 0x00200000 - ZeroDetection"
" 0x00100000 - NoZeroDetection"
),
BitMap { "31","30","29","28","27","26","25","24","21","20" },
BitValues {"DisallowStaleSnapshot", "AllowStaleSnapshot",
"System", "NoSystem", "TPZeroFill", "TPNoZeroFill",
"OneHost", "NoOneHost", "ZeroDetection", "NoZeroDetection"} ]
uint32 Policy;

[Write, Description (
"Specifies the node number, the list of node numbers or "
"the range of node numbers the disks must have their "
"primary path on.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"Empty string means that the value is not specified for "
"this particular set of patterns. \n"
"The string must be in one of the following formats:\n"
" <nb> - nb is an integer\n"
" <nb>,<nb> - a list of integers\n"
" <nb>-<nb> - a range of integers\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",
"DiskCages",
"DiskMagazines",
"DiskMagPositions",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",
"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskPackageModels" }]

3PAR_TPD.mof A.17
 CIM API Programming Reference InForm OS Version 2.3.1

String DiskPrimPathNodes[];

[Write, Description (
"Specifies the PCI slot, the list of PCI slots or "
"the range of PCI slots the disks must have their "
"primary path on.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"Empty string means that the value is not specified for "
"this particular set of patterns. \n"
"The string must be in one of the following formats:\n"
" <nb> - nb is an integer\n"
" <nb>,<nb> - a list of integers\n"
" <nb>-<nb> - a range of integers\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"DiskPrimPathNodes",
"DiskPrimPathPorts",
"DiskCages",
"DiskMagazines",
"DiskMagPositions",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",
"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskPackageModels" }]
String DiskPrimPathPCISlots[];

[Write, Description (
"Specifies the port number, the list of port numbers or "
"the range of port numbers the disks must have their "
"primary path on.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"Empty string means that the value is not specified for "
"this particular set of patterns. \n"
"The string must be in one of the following formats:\n"
" <nb> - nb is an integer\n"
" <nb>,<nb> - a list of integers\n"
" <nb>-<nb> - a range of integers\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {

A.18 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"DiskPrimPathPCISlots",
"DiskPrimPathNodes",
"DiskCages",
"DiskMagazines",
"DiskMagPositions",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",
"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskPackageModels" }]
String DiskPrimPathPorts[];

[Write, Description (
"Specifies the cage number, the list of cage numbers or "
"the range of cage numbers the disks must be in.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"Empty string means that the value is not specified for "
"this particular set of patterns. \n"
"The string must be in one of the following formats:\n"
" <nb> - nb is an integer\n"
" <nb>,<nb> - a list of integers\n"
" <nb>-<nb> - a range of integers\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",
"DiskPrimPathNodes",
"DiskMagazines",
"DiskMagPositions",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",
"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskPackageModels" }]
String DiskCages[];

[Write, Description (
"Specifies the magazine number, the list of magazine numbers or "
"the range of magazine numbers the disks must be in. The '1.' "
"or '0.' that indicates the side of the cage is omitted.\n"
"Each element in this array represents one instance of "

3PAR_TPD.mof A.19
 CIM API Programming Reference InForm OS Version 2.3.1

"pattern for candidate disks; multiple array element adds "

"additional candidate disks that match the pattern.\n"
"Empty string means that the value is not specified for "
"this particular set of patterns. \n"
"The string must be in one of the following formats:\n"
" <nb> - nb is an integer\n"
" <nb>,<nb> - a list of integers\n"
" <nb>-<nb> - a range of integers\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",
"DiskPrimPathNodes",
"DiskCages",
"DiskMagPositions",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",
"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskPackageModels" }]
String DiskMagazines[];

[Write, Description (
"Specifies the magazine position, the list of magazine positions or "
"the range of magazine positions the disks must be in.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"Empty string means that the value is not specified for "
"this particular set of patterns. \n"
"The string must be in one of the following formats:\n"
" <nb> - nb is an integer\n"
" <nb>,<nb> - a list of integers\n"
" <nb>-<nb> - a range of integers\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",
"DiskPrimPathNodes",
"DiskMagazines",
"DiskCages",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",

A.20 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskPackageModels" }]
String DiskMagPositions[];

[Write, Description (
"Specifies the ID, the list of IDs or the range of IDs "
"the disks must have.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"Empty string means that the value is not specified for "
"this particular set of patterns. \n"
"The string must be in one of the following formats:\n"
" <nb> - nb is an integer\n"
" <nb>,<nb> - a list of integers\n"
" <nb>-<nb> - a range of integers\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",
"DiskPrimPathNodes",
"DiskMagazines",
"DiskMagPositions",
"DiskCages",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",
"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskPackageModels" }]
String DiskIDs[];

[Write, Description (
"The total number of chunklets in the disk must be "
"greater than this value.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"A value of -1 means that the value is not specified for "
"this particular set of patterns. All other negative integers "
"are invalid.\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",

3PAR_TPD.mof A.21
 CIM API Programming Reference InForm OS Version 2.3.1

"DiskPrimPathNodes",
"DiskMagazines",
"DiskMagPositions",
"DiskIDs",
"DiskCages",
"DiskTotalChunkletLT",
"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskPackageModels" }]
sint32 DiskTotalChunkletGT[];

[Write, Description (
"The total number of chunklets in the disk must be "
"less than this value.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"A value of -1 means that the value is not specified for "
"this particular set of patterns. All other negative integers "
"are invalid.\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",
"DiskPrimPathNodes",
"DiskMagazines",
"DiskMagPositions",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskCages",
"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskPackageModels" }]
sint32 DiskTotalChunkletLT[];

[Write, Description (
"The total number of free or initializing chunklets in "
"the disk must be greater than this value.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"A value of -1 means that the value is not specified for "
"this particular set of patterns. All other negative integers "
"are invalid.\n"),
ArrayType ( "Indexed" ),

A.22 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

ModelCorrespondence {
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",
"DiskPrimPathNodes",
"DiskMagazines",
"DiskMagPositions",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",
"DiskCages",
"DiskFreeChunkletLT",
"DiskPackageModels" }]
sint32 DiskFreeChunkletGT[];

[Write, Description (
"The total number of free or initializing chunklets in "
"the disk must be less than this value.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"A value of -1 means that the value is not specified for "
"this particular set of patterns. All other negative integers "
"are invalid.\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",
"DiskPrimPathNodes",
"DiskMagazines",
"DiskMagPositions",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",
"DiskFreeChunkletGT",
"DiskCages",
"DiskPackageModels" }]
sint32 DiskFreeChunkletLT[];

[Write, Description (
"Disks must have package models that match one of the "
"specified list of models.\n"
"Each element in this array represents one instance of "
"pattern for candidate disks; multiple array element adds "
"additional candidate disks that match the pattern.\n"
"Empty string means that the value is not specified for "

3PAR_TPD.mof A.23
 CIM API Programming Reference InForm OS Version 2.3.1

"this particular set of patterns. \n"

"The string must be in one of the following formats:\n"
" <model> - the disk drive model\n"
" <model>,<model> - a list of disk drive models\n"),
ArrayType ( "Indexed" ),
ModelCorrespondence {
"TPD_DiskDrivePackage.Model",
"DiskPrimPathPCISlots",
"DiskPrimPathPorts",
"DiskPrimPathNodes",
"DiskMagazines",
"DiskMagPositions",
"DiskIDs",
"DiskTotalChunkletGT",
"DiskTotalChunkletLT",
"DiskFreeChunkletGT",
"DiskFreeChunkletLT",
"DiskCages" }]
String DiskPackageModels[];

[Description ("The time specifies when the volume will expire and "
"can be deleted.") ]
datetime ExpirationTime;

[Description ("The time specifies the volume needs to be retained and "
"can not remove until the retention time is expired.") ]
datetime RetentionTime;
};

// ==================================================================
// 3PAR ElementSettingData
// ==================================================================
[Association,
Description (
"TPD_ElementSettingData is an association between "
"StorageVolume and StorageSetting."
"This association is used to figure out the desired setting "
"data is used when the volume is created.") ]
class TPD_ElementSettingData: CIM_ElementSettingData
{
[Override ( "ManagedElement" ), Description (
"The StorageVolume.")]
TPD_StorageVolume REF ManagedElement;

[Override ( "SettingData" ), Description (

A.24 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"The setting data used when volume is allocated")]

TPD_StorageSetting REF SettingData;
};

// ==================================================================
// 3PAR StorageConfigurationService
// ==================================================================
[Description
("The StorageConfigurationService provides methods that allow "
"a client to create, modify and delete storage pools and "
"volumes.")]
class TPD_StorageConfigurationService : CIM_StorageConfigurationService
{
[Override ("CreateOrModifyStoragePool"), Description (
"Starts a job to create (or modify) a StoragePool. The "
"StoragePool (or must be) scoped to the same System "
"as this Service. One of the parameters for this method is "
"Size. As an input parameter, Size specifies the desired "
"size of the pool. As an output parameter, it specifies the "
"size achieved. Space is taken from either or both of the "
"specified input StoragePools and StorageExtents (InPools "
"and InExtents). The capability requirements that the Pool "
"must support are defined using the Goal parameter. If the "
"requested pool size cannot be created, no action "
"taken, the Return Value 4097/0x1001, and the output "
"value of Size set to the nearest possible size. If "
"0 is returned, then the task completed successfully and the "
"use of ConcreteJob was not required. If the task take "
"some time to complete, a ConcreteJob created and "
"its reference returned in the output parameter Job. "
"For 3PAR InServ provider, only a pool with ElementName of "
"'all' can be created from the primordial pool, thus, all "
"other ElementName rejected. The parameter 'pool' "
"can either be NULL or contain only reference to the 'all' "
"pool; all other references rejected. "
"3PAR provider does not support creating a pool that "
"matches an input Size; it create a pool either out "
"of the specified InExtents parameter, or out of all "
"available extents in the system if the no input "
"InExtents are specified. In either case, Size requirement is "
"ignored. However, the resulting pool size still be "
"returned in the Size parameter."),
ValueMap { "0", "1", "2", "3", "4", "5", "6", "..", "4096",
"4097", "4098..32767", "32768..65535" },
Values { "Job Completed with No Error", "Not Supported",

3PAR_TPD.mof A.25
 CIM API Programming Reference InForm OS Version 2.3.1

"Unknown", "Timeout", "Failed", "Invalid Parameter",

"In Use", "DMTF Reserved",
"Method Parameters Checked - Job Started",
"Size Not Supported", "Method Reserved", "Vendor Specific" }]
uint32 CreateOrModifyStoragePool (
[IN, Description (
"A end user relevant name for the pool being created. If "
"NULL, then a system supplied default name can be used. "
"The value stored in the 'ElementName' property "
"for the created pool. If not NULL, this parameter "
"supply a new name when modifying an existing pool. "
"For 3PAR provider, the pool that is created "
"from primordial pool can only be named 'all'.")]
string ElementName,
[IN ( false ), OUT, Description (
"Reference to the job (may be null if job completed).")]
CIM_ConcreteJob REF Job,
[IN, Description (
"Reference to an instance of StorageSetting that defines "
"the desired capabilities of the StoragePool. If set to a "
"null value, the default configuration from the source "
"pool used. If not NULL, this parameter "
"supply a new Goal setting when modifying an existing "
"pool. "
"For 3PAR InServ provider, only NULL is supported; "
"otherwise the operation rejected with an "
"invalid parameter error.")]
CIM_StorageSetting REF Goal,
[IN, OUT, Description (
"As an input parameter this specifies the desired pool "
"size in bytes. As an output parameter this specifies the "
"size achieved. "
"3PAR provider does not support creating a pool that "
"matches an input Size; it create a pool either out "
"of the specified InExtents parameter, or out of all "
"available extents in the system if the no input "
"InExtents are specified. In either case, Size requirement is "
"ignored. However, the resulting pool size still be "
"returned in this parameter."),
Units ( "Bytes" )]
uint64 Size,
[IN, Description (
"Array of strings containing representations of "
"references to CIM_StoragePool instances, that are used "
"to create the Pool or modify the source pools. "

A.26 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"For 3PAR provider, this can only contain string reference "
"to the primordial pool, as creation of pool from another "
"pool is not supported.")]
string InPools[],
[IN, Description (
"Array of strings containing representations of "
"references to CIM_StorageExtent instances, that are used "
"to create the Pool or modify the source extents. "
"For 3PAR provider, if this is NULL, then all available "
"extents in the system used to create the pool.")]
string InExtents[],
[IN, OUT, Description (
"As an input parameter: if null, creates a new "
"StoragePool. If not null, modifies the referenced Pool. "
"When returned, it is a reference to the resulting "
"StoragePool. "
"For 3PAR provider, this can either be NULL or a reference "
"to the 'all' pool.")]
CIM_StoragePool REF Pool);

};

// ==================================================================
// 3PAR StorageConfigurationCapabilities
// ==================================================================
[Description
("3PAR StorageConfigurationCapabilities describes the storage "
"elements and methods supported by StorageConfigurationService.")]
class TPD_StorageConfigurationCapabilities :
CIM_StorageConfigurationCapabilities
{
};

// ==================================================================
// 3PAR CapabilitiesOfStorageConfigurationService
// ==================================================================
[Association,
Description (
"TPD_CapabilitiesOfStorageConfigurationService is an association "
"between StorageConfigurationCapabilities and "
"StorageConfigurationService. This association is used to query "
"the features and functions supported by "
"StorageConfigurationService.") ]
class TPD_CapabilitiesOfStorageConfigurationService: CIM_ElementCapabilities
{

3PAR_TPD.mof A.27
 CIM API Programming Reference InForm OS Version 2.3.1

[Override ( "ManagedElement" ), Description (

"The StorageConfigurationService.")]
TPD_StorageConfigurationService REF ManagedElement;

[Override ( "Capabilities" ), Description (

"The features supported by StorageConfigurationService.")]
TPD_StorageConfigurationCapabilities REF Capabilities;
};

// ==================================================================
// 3PAR System and ControllerConfigurationService association.
// ==================================================================
[Association,
Description (
"TPD_HostedStorageConfigurationService is an association "
"between TPD_StorageSystem and TPD_StorageConfigurationService. "
"The cardinality of this association is 1-to-1. A System may "
"host only one StorageConfigurationService. ")]
class TPD_HostedStorageConfigurationService : CIM_HostedService {
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The InServ StorageSystem.")]
TPD_StorageSystem REF Antecedent;

[Override ( "Dependent" ), Weak, Description (

"The StorageConfigurationService hosted on the 3PAR InServ.")]
TPD_StorageConfigurationService REF Dependent;
};

// ==================================================================
// 3PAR Frontend FC Port
// ==================================================================
[Description ("3PAR Data InServ FC front end Port ")]
class TPD_FCPort : CIM_FCPort
{
[Description (" "),
ValueMap {"0", "1", "2", "3", "4", "7", "8",
"9", "10", "11", "12", "13"},
Values {"Config Wait", "Alpa Wait", "Login Wait", "OK", "Loss Sync",
"Nonparticipate", "Core Dump", "Offline", "FW Dead",
"Link Idle For Reset", "DHCP In Progress", "Pending Reset"} ]
uint16 OtherOperationalStatus;

[Description ("Topology of the port"),

ValueMap {"0", "1", "2", "3", "4"},
Values {"Unknown", "Private loop", "Public loop", "Point to point",

A.28 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"Fabric"} ]
uint16 Topology;

[Description ("Daisy chain configuration of the port"),

ValueMap {"0", "1", "2"},
Values {"Unknown", "Valid", "Invalid"} ]
uint16 Configuration;

[Description ("Mode of the port"),

ValueMap {"0", "1", "2"},
Values {"Suspended", "Target", "Initiator"} ]
uint16 Mode;

[Description ("Shows if the mode change is allowed or not.")]

boolean ModeChangeAllowed;

[Description ("Node WWN of the port.") ]

uint64 NodeWWN;

[Description ("Describes device type this port is connected to."),

ValueMap {"0", "1", "2", "3", "4"},
Values {"Free", "Host", "Disk", "IPort", "FCRC"} ]
uint16 DeviceTypeConnected;

[Description ("List of devices, this port is connected to.") ]

string ConnectedTo;

[Description ("Persona of the port.") ]

uint16 Persona;

[Description ("Connection type."),

ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "Loop", "Point-to-Point", "Loop Point-to-Point"} ]
uint16 ConnectionType;

[Description ("Class 2 support."),

ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "ack0", "ack1", "Disable"} ]
uint16 Class2Support;

[Description ("VLUN Change Notification (VCN) support."),

ValueMap {"0", "1", "2"},
Values {"Unknown", "Enable", "Disable"} ]
uint16 VCN;

3PAR_TPD.mof A.29
 CIM API Programming Reference InForm OS Version 2.3.1

[Description ("Interrupt coalescing support."),

ValueMap {"0", "1", "2"},
Values {"Unknown", "Enable", "Disable"} ]
uint16 InterruptCoalescing;

// =========================================
// Operations
// =========================================
[Description (
"This method sets port Offline."
"The method should return 0 if successful, 1 if the request is not "
"supported, and some other value if any other error occurred. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 SetOffline(
);

[Description (
"This method resets the port. If the port was set offline, it "
"be set back to online state."
"The method should return 0 if successful, 1 if the request is not "
"supported, and some other value if any other error occurred. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 Reset(
);

[Description (
"This method reloads firmware of the port."
"The method should return 0 if successful, 1 if the request is not "
"supported, and some other value if any other error occurred. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 ReloadFirmware(
);

[Description (
"If private loop topology, a Loop Initialization (LIP) "
"be issued from the port. If point-to-point topology, the link "
" reset. If public loop or fabric topology, a Registered "
"State Change Notification (RSCN) message issued to the "
"fabric controller."
"The method should return 0 if successful, 1 if the request is not "
"supported, and some other value if any other error occurred. "),
ValueMap {"0", "1", "2"},

A.30 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

Values {"OK", "Not Supported", "Error"} ]

uint32 InitializeLoop(
[IN, Description (
"Name of the cage to issue LIP through."),
ModelCorrespondence { "TPD_DriveCage.ElementName" }]
string CageName
);

[Description (
"Verify current port database with Name Server when fabric attached. "
"Devices in database but not in Name Server removed. "
"If RSCN messages are suppressed or lost in the fabric then such "
"devices shown until removed with this command."
"The method should return 0 if successful, 1 if the request is not "
"supported, and some other value if any other error occurred. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 SyncDatabase(
);
};

// ==================================================================
// 3PAR FCAL Port
// ==================================================================
// [Description ("3PAR Data InServ FCAL Port ")]
// class TPD_FCALPort : CIM_FCPort
//{
// [Description (" "),
// ValueMap {"0", "1", "2", "4", "7", "8",
// "9", "10", "11"},
// Values {"config wait", "alpa wait", "login wait", "loss sync",
// "nonparticipate", "core dump", "offline",
// "fw dead", "link idle for reset"} ]
// uint16 OtherOperationalStatus;

// [Description ("Node WWN the FCAL port is connected to.") ]

// uint64 NodeWWN;
//};

// ==================================================================
// 3PAR SCSI Protocol Controller And FCPort association
// ==================================================================
[Association,
Description (
"3PAR Data InServ SCSI protocol controller and FC port"

3PAR_TPD.mof A.31
 CIM API Programming Reference InForm OS Version 2.3.1

" association. ")]

class TPD_ControllerForPort : CIM_ProtocolControllerForPort
{
[Override ("Antecedent"),
Description ("The SCSI Protocol Controller.") ]
TPD_SCSIController REF Antecedent;

[Override ("Dependent"), Weak, Description (

"The FCPort controlled by the SCSI protocol controller.") ]
TPD_FCPort REF Dependent;
// CIM_FCPort REF Dependent; -- reenable this line if we support
TPD_SCSIInitTargetLUPath
};

// ==================================================================
// 3PAR SCSI Protocol Controller And StorageVolume association
// ==================================================================
[Association,
Description (
"3PAR Data InServ SCSI protocol controller and storage volume "
"association. ")]
class TPD_ControllerForUnit : CIM_ProtocolControllerForUnit
{
[Override ("Antecedent"),
Description ("The SCSI Protocol Controller.") ]
TPD_SCSIController REF Antecedent;

[Override ("Dependent"), Weak, Description (

"The storage volume controlled by the SCSI protocol controller.") ]
TPD_StorageVolume REF Dependent;
};

// ==================================================================
// 3PAR SCSIProtocolEndpoint (front-end FC port)
// ==================================================================
[Description
("3PAR Data InServ SCSIProtocolEndpoint (front-end FC port). "
"This class represent FC ports that are connecting to hosts or "
"fabric. ")]
class TPD_SCSIProtocolFCEndpoint : CIM_SCSIProtocolEndpoint
{
};

// ==================================================================

A.32 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// 3PAR SCSIProtocolEndpoint on FC-AL card (connects to initiator

// endpoint on the node controller)
// ==================================================================
//[Description
// ("3PAR Data InServ SCSIProtocolEndpoint that resides on the "
// "FC-AL card. This endpoint is connected to the initiator FC "
// "endpoint the node controller.")]
//class TPD_SCSIProtocolFCALEndpoint : CIM_SCSIProtocolEndpoint
//{
//};

// ==================================================================
// 3PAR SCSIProtocolController And SCSIProtocolEndpoint association.
// NOTE: In SMI-S 1.1, this association replaces ControllerForPort
// association (SMI-S 1.02).
// ==================================================================
[Association,
Description (
"3PAR Data InServ SCSI protocol controller and the front end "
"target SCSIProtocolEndpoint association. ")]
class TPD_SAPAvailableForElement : CIM_SAPAvailableForElement
{
[Override ("AvailableSAP"), Description (
"The SCSIProtocolEndpoint (front end port).") ]
TPD_SCSIProtocolFCEndpoint REF AvailableSAP;

[Override ("ManagedElement"), Description (

"The SCSI Protocol Controller (service).") ]
TPD_SCSIController REF ManagedElement;
};

// ===================================================================
// DeviceSAPImplementation - association between SCSIEndpoint and
// FCPort
// ===================================================================
[Association,
Description (
"An association between a 3PAR SCSI protocol endpoint and its "
"implementation on FC port.")]
class TPD_FCPortSCSIEndpointImplementation: CIM_DeviceSAPImplementation {

[Override ( "Antecedent" ), Description (

"The FC port.")]
TPD_FCPort REF Antecedent;

3PAR_TPD.mof A.33
 CIM API Programming Reference InForm OS Version 2.3.1

// CIM_FCPort REF Antecedent; -- reenable this line if we support

TPD_SCSIInitTargetLUPath

[Override ( "Dependent" ), Description (

"The SCSIProtocolEndpoint implemented using the FC port.")]
TPD_SCSIProtocolFCEndpoint REF Dependent;
// CIM_SCSIProtocolEndpoint REF Dependent; -- reenable this line if we
support TPD_SCSIInitTargetLUPath
};

// ==================================================================
// ControllerConfigurationService
// ==================================================================
[Description
("The ControllerConfigurationService provides methods that allow "
"a client to export and delete VLUNs in an InServ.")]
class TPD_ControllerConfigurationService : CIM_ControllerConfigurationService
{
[Override ("ExposePaths"), Description (
"3PAR version of the ExposePaths operation, adding an extra "
"property ResultDescription to better describe the result "
"of the expose path operation. \n"
"\n"
"Expose a list of SCSI logical units (such as RAID volumes "
"or tape drives) to a list of initiators through a list of "
"target ports, through one or more SCSIProtocolControllers "
"(SPCs). \n"
"\n"
"The parameters for this method are: Job - null if no job "
"created, otherwise this is a reference to the job. LUNames "
"- the list of names of the logical units to use. "
"InitiatorPortIDs - the names of the initiator ports to use. "
"TargetPortIDs - the names of the target ports to use. "
"DeviceNumbers - the device numbers (LUNs) to use. "
"DeviceAccesses - permissions for the logical units. "
"ProtocolControllers - SPCs involved in this operation. \n"
"\n"
"There are two modes of operation, create and modify. If a "
"NULL value is passed in for the SPC, then the "
"instrumentation create at least one SPC that satisfies "
"the request. Since "
"CIM_ProtocolControllerMaskingCapabilities.OneHardwareIDPerView "
"for the 3PAR InServ is true, more than one SPC could be created "
"if more than one initiatorID was passed in. If an SPC is "
"passed in, then the instrumentation attempts to add the new "

A.34 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"paths to the existing SPC. \n"

"\n"
"For creating an SPC, all parameters, except ProtocolControllers, "
"MUST be specified since SPCAllowsNoLUs, SPCAllowsNoTargets and "
"SPCAllowsNoInitiators properties are all false, and "
"ClientSelectableDeviceNumbers property is true, for a 3PAR "
"InServ array. \n"
"\n"
"The LUNames, DeviceNumbers, and DeviceAccesses parameters "
"are mutually indexed arrays - any element in DeviceNumbers "
"or DeviceAccesses set a property relative to the "
"LogicalDevice instance named in the corresponding element "
"of LUNames. LUNames, DeviceNumbers and DeviceAccesses MUST "
"have the same number of elements. If these conditions are "
"not met, the instrumentation MUST return a 'Invalid Parameter' "
"status or a CIM_Error. \n"
"\n"
"For modifying an SPC, the 3PAR InServ array supports only "
"the Add LUs to a view use case."
"Add LUs to a view requires that the LUNames and DeviceNumbers "
"parameters not be null and that the InitiatorIDs and TargetPortIDs "
"parameters be null. \n"
"\n"
"The relevant rules of SCSI semantics are: \n"
"- an SPC MAY NOT be exposed through a particular "
"host/target port pair that is in use by another SPC. (In "
"other words, an SPC and its associated logical units and "
"ports together correspond to the logical unit inventory "
"provided by SCSI REPORT LUNS and INQUIRY commands) \n"
"- each LogicalDevice associated to an SPC MUST have a "
"unique ProtocolControllerForUnit DeviceNumber (logical unit "
"number) \n"
"The instrumentation MUST report an error if the client "
"request would violate one of these rules. \n"
"\n"
"If the instrumentation provides PrivilegeManagementService, "
"the results of setting DeviceAccesses MUST be synchronized "
"with PrivilegeManagementService as described in the "
"ProtocolControllerForUnit DeviceAccess description."),
ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
"4097", "4098", "4099", "4100", "4101", "4102", "4103",
"4104..32767", "32768..65535" },
Values { "Success", "Not Supported", "Unspecified Error",
"Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
"Method Parameters Checked - Job Started",

3PAR_TPD.mof A.35
 CIM API Programming Reference InForm OS Version 2.3.1

"Invalid logical unit ID", "Invalid initiator port ID",

"Invalid target port ID", "Invalid permission",
"Target/initiator combination already exposed",
"Requested logical unit number in use",
"Maximum Map Count Exceeded", "Method Reserved",
"Vendor Specific" }]
uint32 ExposePaths (
[IN ( false ), OUT, Description (
"Reference to the job if 'Method Parameters Checked - Job "
"Started' is returned (MAY be null if job completed).")]
CIM_ConcreteJob REF Job,
[Required, IN, Description (
"An array of IDs of logical unit instances. The LU "
"instances MUST already exist. The members of this array "
"MUST match the Name property of LogicalDevice instances "
"that represent SCSI logical units. See the method "
"description for conditions where this MAY be null."),
ModelCorrespondence { "CIM_LogicalDevice.Name"}]
string LUNames[],
[IN, Description (
"IDs of initiator ports. If existing StorageHardwareID "
"instances exist, they MUST be used. Implicit creation "
"of StorageHardwareID if no instance matches is "
"NOT supported."),
ModelCorrespondence { "CIM_StorageHardwareID.StorageID"}]
string InitiatorPortIDs[],
[IN, Description (
"IDs of target ports. See the method description for "
"conditions where this MAY be null."),
ModelCorrespondence { "CIM_SCSIProtocolEndpoint.Name"}]
string TargetPortIDs[],

[IN, Description (
"A list of logical unit numbers to assign to the "
"corresponding logical unit in the LUNames parameter. "
"(within the context of the elements specified in the "
"other parameters). If the LUNames parameter is null, "
"then this parameter MUST be null. Otherwise, if this "
"parameter is null, all LU numbers are assigned by the "
"hardware or instrumentation."),
ModelCorrespondence {
"CIM_ProtocolControllerForUnit.DeviceNumber"}]
string DeviceNumbers[],

[IN, Description (

A.36 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"A list of permissions to assign to the corresponding "

"logical unit in the LUNames parameter. This specifies "
"the permission to assign within the context of the "
"elements specified in the other parameters. Setting this "
"to 'No Access' assigns the DeviceNumber for the "
"associated initiators, but does not grant read or write "
"access. If the LUNames parameter is not null then this "
"parameter MUST be specified."),
ValueMap { "0", "2", "3", "4", "5..15999", "16000.." },
Values { "Unknown", "Read Write", "Read-Only", "No Access",
"DMTF Reserved", "Vendor Reserved" },
ModelCorrespondence {
"CIM_ProtocolControllerForUnit.DeviceAccess" }]
uint16 DeviceAccesses[],

[IN, OUT, Description (

"An array of references to SCSIProtocolControllers "
"(SPCs). On input, this can be null, or contain exactly "
"one element; there MAY be multiple references on output. "
"If null on input, the instrumentation create one or "
"more new SPC instances. If an SPC is specified, the "
"instrumentation attempt to add associations to one "
"or more existing SPCs. If the first array element is a "
"valid SPC reference and SCSI semantics can be preserved, "
"the instrumentation MUST attach associations to the "
"specified SPC. If multiple elements are non-null on "
"input, the instrumentation MUST report an invalid "
"parameter. On output, this is an array of references to "
"SPCs created or modified as the result of processing the "
"request.")]
CIM_SCSIProtocolController REF ProtocolControllers[],

[IN, Description (
"Override existing lower priority VLUNs, if necessary. "
"Can be used only when exporting to a specific host. "
"This parameter is a vendor-specific extension for 3PAR. "
"The default value is false.")]
boolean Override,

[IN, Description (
"Do not issue a VLUN (Virtual Logical Unit Number) Change "
"Notification (VCN) after export. For direct connect or "
"loop configuration, a VCN consists of a Fibre Channel "
"Loop Initialization Primitive (LIP). For fabric "
"configuration a VCN consists of Registered State Change "

3PAR_TPD.mof A.37
 CIM API Programming Reference InForm OS Version 2.3.1

"Notification (RSCN) being sent to the fabric controller. "

"This parameter is a vendor-specific extension for 3PAR. "
"The default value is false.")]
boolean NoVCN,

[OUT, Description (
"An array of descriptive text of the result of the operation, "
"with each entry containing the result of each "
"expose path operation.")]
string ResultDescriptions[]);

[Override ("HidePaths"), Description (

"3PAR version of the HidePaths operation, adding an extra "
"property ResultDescription to better describe the result "
"of the hide path operation, and DeviceNumbers for more "
"efficient HidePaths operation.\n"
"\n"
"Hide a list of SCSI logical units (such as a RAID volume or "
"tape drive) from a list of initiators and/or target ports "
"on a SCSIProtocolController (SPC). \n"
"\n"
"The parameters for this method are: Job - null if no job "
"created, otherwise this is a reference to the job. LUNames "
"- the list of names of the logical units to use. "
"InitiatorPortIDs - the names of the initiator ports to use. "
"TargetPortIDs - the names of the target ports to use. "
"DeviceNumbers (optional) - the device numbers (LUNs) to use. "
"This is a 3PAR extension."
"ProtocolControllers - SPCs involved in this operation. \n"
"\n"
"The LUNames and the optional DeviceNumbers parameters "
"are mutually indexed arrays - any element in DeviceNumbers "
" set a property relative to the "
"LogicalDevice instance named in the corresponding element "
"of LUNames. DeviceNumbers MUST be null (the provider "
"deduce the DeviceNumbers of all the LU's in LUNames) or have "
"the same number of elements as LUNames. If these conditions "
"are not met, the instrumentation MUST return a 'Invalid Parameter' "
"status or a CIM_Error. \n"
"\n"
"When hiding logical units, 3PAR InServ array supports only "
"the Remove LUs from a view and Hide Full Paths from View. "
"Remove LUs from a view requires that the "
"LUNames parameter not be null and that the InitiatorIDs and "
"TargetPortIDs parameters be null. \n"

A.38 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"\n"
"The SPC is automatically deleted when the last logical unit "
"is removed since SPCAllowsNoLUs is false."),
ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
"4097", "4098", "4099", "4100", "4101..32767",
"32768..65535" },
Values { "Success", "Not Supported", "Unspecified Error",
"Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
"Method Parameters Checked - Job Started",
"Invalid logical unit ID", "Invalid initiator port ID",
"Invalid target port ID",
"Target/initiator combination not exposed",
"Method Reserved", "Vendor Specific" }]
uint32 HidePaths (
[IN ( false ), OUT, Description (
"Reference to the job if 'Method Parameters Checked - Job "
"Started' is returned (MAY be null if job completed).")]
CIM_ConcreteJob REF Job,

[Required, IN, Description (

"A list of IDs of logical units. Each LU instance MUST "
"already exist. See the method description for conditions "
"where this MAY be null."),
ModelCorrespondence {
"CIM_LogicalDevice.Name"}]
string LUNames[],

[IN, Description (
"IDs of initiator ports. See the method description for "
"conditions where this MAY be null."),
ModelCorrespondence { "CIM_StorageHardwareID.StorageID" }]
string InitiatorPortIDs[],

[IN, Description (
"IDs of target ports. See the method description for "
"conditions where this MAY be null."),
ModelCorrespondence { "CIM_SCSIProtocolEndpoint.Name" }]
string TargetPortIDs[],

[IN, Description (
"A list of logical unit numbers that corresponds to "
"logical unit in the LUNames parameter. "
"(within the context of the elements specified in the "
"other parameters). This parameter is a vendor-specific "
"extension for 3PAR. Use of this parameter is optional, "

3PAR_TPD.mof A.39
 CIM API Programming Reference InForm OS Version 2.3.1

"but its use enhance efficiency of the HidePaths "

"operation."),
ModelCorrespondence {
"CIM_ProtocolControllerForUnit.DeviceNumber"}]
string DeviceNumbers[],

[IN, OUT, Description (

"An array of references to SCSIProtocolControllers "
"(SPCs). On input, this MUST contain exactly one element; "
"there MAY be multiple references on output. The "
"instrumentation attempt to remove associations "
"(LUNames, InitiatorPortIDs, or TargetPortIDs) from this "
"SPC. Depending upon the specific implementation, the "
"instrumentation MAY need to create new SPCs with a "
"subset of the remaining associations. On output, this is "
"an array of references to SPCs created or modified as "
"the result of processing the request.")]
CIM_SCSIProtocolController REF ProtocolControllers[],

[IN, Description (
"Do not issue a VLUN (Virtual Logical Unit Number) Change "
"Notification (VCN) after removal. For direct connect or "
"loop configuration, a VCN consists of a Fibre Channel "
"Loop Initialization Primitive (LIP). For fabric "
"configuration a VCN consists of Registered State Change "
"Notification (RSCN) being sent to the fabric controller. "
"This parameter is a vendor-specific extension for 3PAR. "
"The default value is false.")]
boolean NoVCN,

[OUT, Description (
"An array of descriptive text of the result of the operation, "
"with each entry containing the result of the "
"hide path operation.")]
string ResultDescriptions[]);

[Override ("ExposeDefaultLUs"), Description (

"3PAR version of the ExposeDefaultLUs operation, adding an extra "
"property ResultDescription to better describe the result "
"of the expose logical units operation. \n"
"\n"
"Expose a list of SCSI logical units (such as RAID volumes "
"or tape drives) through a 'default view' "
"SCSIProtocolController (SPC) through a list of target "
"ports. The 'default view' SPC exposes logical units to all "

A.40 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"initiators. This SPC is identified by an association to a "

"StorageHardwareID with Name property set to the empty "
"string. \n"
"\n"
"The parameters for this method are: Job - null if no job "
"created, otherwise this is a reference to the job. LUNames "
"- the list of names of the logical units to use. "
"TargetPortIDs - the names of the target ports to use. "
"DeviceNumbers - the device numbers (LUNs) to use. "
"DeviceAccesses - permissions for the logical units. "
"ProtocolControllers - SPCs involved in this operation. \n"
"\n"
"There are two modes of operation, create and modify. If a "
"NULL value is passed in for the SPC, then the "
"instrumentation attempt to create a new default view. "
"There could be multiple default view SPCs associated with "
"each port. If an SPC is passed in, then the "
"instrumentation adds the new paths to the existing SPC. \n"
"\n"
"For creating a default view SPC, all parameters, except "
"ProtocolControllers, MUST be specified since SPCAllowsNoLUs, "
"SPCAllowsNoTargets and SPCAllowsNoInitiators properties are "
"all false, and ClientSelectableDeviceNumbers property is "
"true, for a 3PAR InServ array. \n"
"\n"
"The LUNames, DeviceNumbers, and DeviceAccesses parameters "
"are mutually indexed arrays - any element in DeviceNumbers "
"or DeviceAccesses set a property relative to the "
"LogicalDevice instance named in the corresponding element "
"of LUNames. LUNames, DeviceNumbers and DeviceAccesses MUST "
"have the same number of elements. If these conditions are "
"not met, the instrumentation MUST return a 'Invalid Parameter' "
"status or a CIM_Error. \n"
"\n"
"For modifying an SPC, the 3PAR InServ array supports only "
"the Add LUs to a view use case."
"Add LUs to a view requires that the LUNames and DeviceNumbers "
"parameters not be null and that the InitiatorIDs and TargetPortIDs "
"parameters be null. \n"
"\n"
"The relevant rules of SCSI semantics are: \n"
"- an SPC MAY NOT be exposed through a particular "
"host/target port pair that is in use by another SPC. (In "
"other words, an SPC and its associated logical units and "
"ports together correspond to the logical unit inventory "

3PAR_TPD.mof A.41
 CIM API Programming Reference InForm OS Version 2.3.1

"provided by SCSI REPORT LUNS and INQUIRY commands) \n"

"- each LogicalDevice associated to an SPC MUST have a "
"unique ProtocolControllerForUnit DeviceNumber (logical unit "
"number) \n"
"The instrumentation MUST report an error if the client "
"request would violate one of these rules. \n"
"\n"
"If the instrumentation provides PrivilegeManagementService, "
"the results of setting DeviceAccesses MUST be synchronized "
"with PrivilegeManagementService as described in the "
"ProtocolControllerForUnit DeviceAccess description."),
ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
"4097", "4098", "4099", "4100", "4101", "4102..32767",
"32768..65535" },
Values { "Success", "Not Supported", "Unspecified Error",
"Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
"Method Parameters Checked - Job Started",
"Invalid logical unit ID", "Invalid target port ID",
"Invalid permission", "Requested logical unit number in use",
"Maximum Map Count Exceeded", "Method Reserved",
"Vendor Specific" }]
uint32 ExposeDefaultLUs (
[IN ( false ), OUT, Description (
"Reference to the job if 'Method Parameters Checked - Job "
"Started' is returned (MAY be null if job completed).")]
CIM_ConcreteJob REF Job,
[Required, IN, Description (
"An array of IDs of logical unit instances. The LU "
"instances MUST already exist. The members of this array "
"MUST match the Name property of LogicalDevice instances "
"that represent SCSI logical units. See the method "
"description for conditions where this MAY be null."),
ModelCorrespondence { "CIM_LogicalDevice.Name"}]
string LUNames[],
[IN, Description (
"IDs of target ports. See the method description for "
"conditions where this MAY be null."),
ModelCorrespondence { "CIM_SCSIProtocolEndpoint.Name" }]
string TargetPortIDs[],

[IN, Description (
"A list of logical unit numbers to assign to the "
"corresponding logical unit in the LUNames parameter. "
"(within the context of the elements specified in the "
"other parameters). If the LUNames parameter is null, "

A.42 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"then this parameter MUST be null. Otherwise, if this "

"parameter is null, all LU numbers are assigned by the "
"hardware or instrumentation."),
ModelCorrespondence {
"CIM_ProtocolControllerForUnit.DeviceNumber"}]
string DeviceNumbers[],

[IN, Description (
"A list of permissions to assign to the corresponding "
"logical unit in the LUNames parameter. This specifies "
"the permission to assign within the context of the "
"elements specified in the other parameters. Setting this "
"to 'No Access' assigns the DeviceNumber for all "
"initiators, but does not grant read or write access. If "
"the LUNames parameter is not null then this parameter "
"MUST be specified."),
ValueMap { "0", "2", "3", "4", "5..15999", "16000.." },
Values { "Unknown", "Read Write", "Read-Only", "No Access",
"DMTF Reserved", "Vendor Reserved" },
ModelCorrespondence {
"CIM_ProtocolControllerForUnit.DeviceAccess" }]
uint16 DeviceAccesses[],

[IN, OUT, Description (

"An array of references to SCSIProtocolControllers "
"(SPCs). On input, this can be null, or contain exactly "
"one element; there MAY be multiple references on output. "
"If null on input, the instrumentation create one or "
"more new SPC instances. If an SPC is specified, the "
"instrumentation attempt to add associations to one "
"or more existing SPCs. If the first array element is a "
"valid SPC reference and SCSI semantics can be preserved, "
"the instrumentation MUST attach associations to the "
"specified SPC. If multiple elements are non-null on "
"input, the instrumentation MUST report an invalid "
"parameter. On output, this is an array of references to "
"SPCs created or modified as the result of processing the "
"request.")]
CIM_SCSIProtocolController REF ProtocolControllers[],

[IN, Description (
"Override existing lower priority VLUNs, if necessary. "
"Can be used only when exporting to a specific host. "
"This parameter is a vendor-specific extension for 3PAR. "
"The default value is false.")]

3PAR_TPD.mof A.43
 CIM API Programming Reference InForm OS Version 2.3.1

boolean Override,

[IN, Description (
"Do not issue a VLUN (Virtual Logical Unit Number) Change "
"Notification (VCN) after export. For direct connect or "
"loop configuration, a VCN consists of a Fibre Channel "
"Loop Initialization Primitive (LIP). For fabric "
"configuration a VCN consists of Registered State Change "
"Notification (RSCN) being sent to the fabric controller. "
"This parameter is a vendor-specific extension for 3PAR. "
"The default value is false.")]
boolean NoVCN,

[OUT, Description (
"An array of descriptive text of the result of the operation, "
"with each entry containing the result of the "
"expose Default LU operation.")]
string ResultDescriptions[]);

[Override ("HideDefaultLUs"), Description (

"3PAR version of the HideDefaultLUs operation, adding an extra "
"property ResultDescription to better describe the result "
"of the hide default logical units operation\n"
"\n"
"Hide a list of SCSI logical units (such as RAID volumes or "
"tape drives) through a list of target ports on a default "
"view SCSIProtocolController (SPC). \n"
"\n"
"The parameters for this method are: Job - null if no job "
"created, otherwise this is a reference to the job. LUNames "
"- the list of names of the logical units to use. "
"TargetPortIDs - the names of the target ports to use. "
"DeviceNumbers (optional) - the device numbers (LUNs) to use. "
"This is a 3PAR extension."
"ProtocolControllers - SPCs involved in this operation. \n"
"\n"
"The LUNames and the optional DeviceNumbers parameters "
"are mutually indexed arrays - any element in DeviceNumbers "
" set a property relative to the "
"LogicalDevice instance named in the corresponding element "
"of LUNames. DeviceNumbers MUST be null (the provider "
"deduce the DeviceNumbers of all the LU's in LUNames) or have "
"the same number of elements as LUNames. If these conditions "
"are not met, the instrumentation MUST return a 'Invalid Parameter' "
"status or a CIM_Error. \n"

A.44 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"\n"
"When hiding logical units, 3PAR InServ array supports only "
"the Remove LUs from a default view use case. "
"Remove LUs from a default view requires that the "
"LUNames parameter not be null and that the TargetPortIDs "
"parameters be null. \n"
"\n"
"The SPC is automatically deleted when the last logical unit "
"is removed since SPCAllowsNoLUs is false."),
ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
"4097", "4098", "4099", "4100..32767", "32768..65535" },
Values { "Success", "Not Supported", "Unspecified Error",
"Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
"Method Parameters Checked - Job Started",
"Invalid logical unit ID", "Invalid target port ID",
"Maximum Map Count Error", "Method Reserved",
"Vendor Specific" }]
uint32 HideDefaultLUs (
[IN ( false ), OUT, Description (
"Reference to the job if 'Method Parameters Checked - Job "
"Started' is returned (MAY be null if job completed).")]
CIM_ConcreteJob REF Job,

[Required, IN, Description (

"A list of IDs of logical units. Each LU instance MUST "
"already exist. See the method description for conditions "
"where this MAY be null."),
ModelCorrespondence {
"CIM_LogicalDevice.Name"}]
string LUNames[],

[IN, Description (
"IDs of target ports. See the method description for "
"conditions where this MAY be null."),
ModelCorrespondence { "CIM_SCSIProtocolEndpoint.Name" }]
string TargetPortIDs[],

[IN, Description (
"A list of logical unit numbers that corresponds to "
"logical unit in the LUNames parameter. "
"(within the context of the elements specified in the "
"other parameters). This parameter is a vendor-specific "
"extension for 3PAR. Use of this parameter is optional, "
"but its use enhance efficiency of the HideDefaultLUs "
"operation."),

3PAR_TPD.mof A.45
 CIM API Programming Reference InForm OS Version 2.3.1

ModelCorrespondence {
"CIM_ProtocolControllerForUnit.DeviceNumber" }]
string DeviceNumbers[],

[IN, OUT, Description (

"An array of references to SCSIProtocolControllers "
"(SPCs). On input, this MUST contain exactly one element; "
"there MAY be multiple references on output. The "
"instrumentation attempt to remove associations "
"(LUNames or TargetPortIDs) from this SPC. Depending upon "
"the specific implementation, the instrumentation MAY "
"need to create new SPCs with a subset of the remaining "
"associations. On output, this is an array of references "
"to SPCs created or modified as the result of processing "
"the request.")]
CIM_SCSIProtocolController REF ProtocolControllers[],

[IN, Description (
"Do not issue a VLUN (Virtual Logical Unit Number) Change "
"Notification (VCN) after removal. For direct connect or "
"loop configuration, a VCN consists of a Fibre Channel "
"Loop Initialization Primitive (LIP). For fabric "
"configuration a VCN consists of Registered State Change "
"Notification (RSCN) being sent to the fabric controller. "
"This parameter is a vendor-specific extension for 3PAR. "
"The default value is false.")]
boolean NoVCN,

[OUT, Description (
"An array of descriptive text of the result of the operation, "
"with each entry containing the result of the "
"hide default LU operation.")]
string ResultDescriptions[]);

[Description (
"Expose a list of SCSI logical units (such as RAID volumes "
"or tape drives) to a list of StorageHardwareIDCollections "
"(host names). "
"The logical units visible to all InitiatorPortIDs "
"that are member of the StorageHardwareIDCollections. \n"
"\n"
"The parameters for this method are: Job - null if no job "
"created, otherwise this is a reference to the job. LUNames "
"- the list of names of the logical units to use. "
"HostNames - the names of the StorageHardwareIDCollection to use. "

A.46 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"DeviceNumbers - the device numbers (LUNs) to use. "

"DeviceAccesses - permissions for the logical units. "
"ProtocolControllers - SPCs involved in this operation. \n"
"\n"
"There are two modes of operation, create and modify. If a "
"NULL value is passed in for the SPC, then the "
"instrumentation attempt to create a new view. "
"If an SPC is passed in, then the instrumentation adds the "
"new paths to the existing SPC. \n"
"\n"
"For creating a SPC, all parameters, except "
"ProtocolControllers, MUST be specified since SPCAllowsNoLUs, "
"SPCAllowsNoTargets and SPCAllowsNoInitiators properties are "
"all false, and ClientSelectableDeviceNumbers property is "
"true, for a 3PAR InServ array. \n"
"\n"
"The LUNames, DeviceNumbers, and DeviceAccesses parameters "
"are mutually indexed arrays - any element in DeviceNumbers "
"or DeviceAccesses set a property relative to the "
"LogicalDevice instance named in the corresponding element "
"of LUNames. LUNames, DeviceNumbers and DeviceAccesses MUST "
"have the same number of elements. If these conditions are "
"not met, the instrumentation MUST return a 'Invalid Parameter' "
"status or a CIM_Error. \n"
"\n"
"For modifying an SPC, the 3PAR InServ array supports only "
"the Add LUs to a view use case."
"Add LUs to a view requires that the LUNames and DeviceNumbers "
"parameters not be null and that the Hostnames "
"parameter be null. \n"
"\n"
"The relevant rules of SCSI semantics are: \n"
"- an SPC MAY NOT be exposed through a particular "
"host/target port pair that is in use by another SPC. (In "
"other words, an SPC and its associated logical units and "
"ports together correspond to the logical unit inventory "
"provided by SCSI REPORT LUNS and INQUIRY commands) \n"
"- each LogicalDevice associated to an SPC MUST have a "
"unique ProtocolControllerForUnit DeviceNumber (logical unit "
"number) \n"
"The instrumentation MUST report an error if the client "
"request would violate one of these rules. \n"
"\n"
"The relevant rules of SCSI semantics are: \n"
"- an SPC MAY NOT be exposed through a particular "

3PAR_TPD.mof A.47
 CIM API Programming Reference InForm OS Version 2.3.1

"host/target port pair that is in use by another SPC. (In "

"other words, an SPC and its associated logical units and "
"ports together correspond to the logical unit inventory "
"provided by SCSI REPORT LUNS and INQUIRY commands) \n"
"- each LogicalDevice associated to an SPC MUST have a "
"unique ProtocolControllerForUnit DeviceNumber (logical unit "
"number) \n"
"The instrumentation MUST report an error if the client "
"request would violate one of these rules. \n"
"\n"
"If the instrumentation provides PrivilegeManagementService, "
"the results of setting DeviceAccesses MUST be synchronized "
"with PrivilegeManagementService as described in the "
"ProtocolControllerForUnit DeviceAccess description."),
ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
"4097", "4098", "4099", "4100", "4101", "4102..32767",
"32768..65535" },
Values { "Success", "Not Supported", "Unspecified Error",
"Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
"Method Parameters Checked - Job Started",
"Invalid logical unit ID", "Invalid host name",
"Invalid permission", "Requested logical unit number in use",
"Maximum Map Count Exceeded", "Method Reserved",
"Vendor Specific" }]
uint32 ExposeLUsToStorageHardwareIDCollection (
[IN ( false ), OUT, Description (
"Reference to the job if 'Method Parameters Checked - Job "
"Started' is returned (MAY be null if job completed).")]
CIM_ConcreteJob REF Job,
[Required, IN, Description (
"An array of IDs of logical unit instances. The LU "
"instances MUST already exist. The members of this array "
"MUST match the Name property of LogicalDevice instances "
"that represent SCSI logical units. See the method "
"description for conditions where this MAY be null."),
ModelCorrespondence { "CIM_LogicalDevice.Name"}]
string LUNames[],

[Required, IN, Description (

"An array of names for the hosts (StorageHardwareIDCOllection). "
"Instances MUST already exist. The members of this array "
"MUST match the ElementName property of
TPD_StorageHardwareIDCollection "
"instances."),

A.48 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

ModelCorrespondence { "TPD_StorageHardwareIDCollection.ElementName"
}]
string HostNames[],

[IN, Description (
"A list of logical unit numbers to assign to the "
"corresponding logical unit in the LUNames parameter. "
"(within the context of the elements specified in the "
"other parameters). If the LUNames parameter is null, "
"then this parameter MUST be null. Otherwise, if this "
"parameter is null, all LU numbers are assigned by the "
"hardware or instrumentation."),
ModelCorrespondence {
"CIM_ProtocolControllerForUnit.DeviceNumber"}]
string DeviceNumbers[],

[IN, Description (
"A list of permissions to assign to the corresponding "
"logical unit in the LUNames parameter. This specifies "
"the permission to assign within the context of the "
"elements specified in the other parameters. Setting this "
"to 'No Access' assigns the DeviceNumber for all "
"initiators, but does not grant read or write access. If "
"the LUNames parameter is not null then this parameter "
"MUST be specified."),
ValueMap { "0", "2", "3", "4", "5..15999", "16000.." },
Values { "Unknown", "Read Write", "Read-Only", "No Access",
"DMTF Reserved", "Vendor Reserved" },
ModelCorrespondence {
"CIM_ProtocolControllerForUnit.DeviceAccess" }]
uint16 DeviceAccesses[],

[Required, IN, OUT, Description (

"An array of references to SCSIProtocolControllers "
"(SPCs). On input, this can be null, or contain exactly "
"one element; there MAY be multiple references on output. "
"If null on input, the instrumentation create one or "
"more new SPC instances. If an SPC is specified, the "
"instrumentation attempt to add associations to one "
"or more existing SPCs. If the first array element is a "
"valid SPC reference and SCSI semantics can be preserved, "
"the instrumentation MUST attach associations to the "
"specified SPC. If multiple elements are non-null on "
"input, the instrumentation MUST report an invalid "
"parameter. On output, this is an array of references to "

3PAR_TPD.mof A.49
 CIM API Programming Reference InForm OS Version 2.3.1

"SPCs created or modified as the result of processing the "

"request.")]
CIM_SCSIProtocolController REF ProtocolControllers[],

[IN, Description (
"Override existing lower priority VLUNs, if necessary. "
"Can be used only when exporting to a specific host. "
"This parameter is a vendor-specific extension for 3PAR. "
"The default value is false.")]
boolean Override,

[IN, Description (
"Do not issue a VLUN (Virtual Logical Unit Number) Change "
"Notification (VCN) after export. For direct connect or "
"loop configuration, a VCN consists of a Fibre Channel "
"Loop Initialization Primitive (LIP). For fabric "
"configuration a VCN consists of Registered State Change "
"Notification (RSCN) being sent to the fabric controller. "
"This parameter is a vendor-specific extension for 3PAR. "
"The default value is false.")]
boolean NoVCN,

[OUT, Description (
"An array of descriptive text of the result of the operation, "
"with each entry containing the result of the "
"expose LUs to StorageHardwareIDCollection operation.")]
string ResultDescriptions[]);

[Description (
"Hide a list of SCSI logical units (such as RAID volumes or "
"tape drives) through a list of StorageHardwareIDCollections. \n"
"\n"
"The parameters for this method are: Job - null if no job "
"created, otherwise this is a reference to the job. LUNames "
"- the list of names of the logical units to use. "
"DeviceNumbers (optional) - the device numbers (LUNs) to use. "
"ProtocolControllers - SPCs involved in this operation. \n"
"\n"
"The LUNames and the optional DeviceNumbers parameters "
"are mutually indexed arrays - any element in DeviceNumbers "
" set a property relative to the "
"LogicalDevice instance named in the corresponding element "
"of LUNames. DeviceNumbers MUST be null (the provider "
"hide all LU's in LUNames on the SPC) or have the same number "
"of elements as LUNames. If these conditions are not met, "

A.50 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"the instrumentation MUST return a 'Invalid Parameter' "

"status or a CIM_Error. \n"
"\n"
"When hiding logical units, 3PAR InServ array supports only "
"the Remove LUs from a view use case. "
"Remove LUs from a view requires that the "
"LUNames parameter not be null.\n"
"\n"
"The SPC is automatically deleted when the last logical unit "
"is removed since SPCAllowsNoLUs is false."),
ValueMap { "0", "1", "2", "3", "4", "5", "6..4095", "4096",
"4097", "4098", "4099", "4100..32767", "32768..65535" },
Values { "Success", "Not Supported", "Unspecified Error",
"Timeout", "Failed", "Invalid Parameter", "DMTF Reserved",
"Method Parameters Checked - Job Started",
"Invalid logical unit ID", "Invalid host name",
"Maximum Map Count Error", "Method Reserved",
"Vendor Specific" }]
uint32 HideLUsFromStorageHardwareIDCollection (
[IN ( false ), OUT, Description (
"Reference to the job if 'Method Parameters Checked - Job "
"Started' is returned (MAY be null if job completed).")]
CIM_ConcreteJob REF Job,

[Required, IN, Description (

"A list of IDs of logical units. Each LU instance MUST "
"already exist. See the method description for conditions "
"where this MAY be null."),
ModelCorrespondence {
"CIM_LogicalDevice.Name"}]
string LUNames[],

[IN, Description (
"A list of logical unit numbers that corresponds to "
"logical unit in the LUNames parameter. "
"(within the context of the elements specified in the "
"other parameters). This parameter is a vendor-specific "
"extension for 3PAR. Use of this parameter is optional, "
"but its use enhance efficiency of the HideDefaultLUs "
"operation."),
ModelCorrespondence {
"CIM_ProtocolControllerForUnit.DeviceNumber"}]
string DeviceNumbers[],

[IN, OUT, Description (

3PAR_TPD.mof A.51
 CIM API Programming Reference InForm OS Version 2.3.1

"An array of references to SCSIProtocolControllers "

"(SPCs). On input, this MUST contain exactly one element; "
"there MAY be multiple references on output. The "
"instrumentation attempt to remove associations "
"(LUNames or TargetPortIDs) from this SPC. Depending upon "
"the specific implementation, the instrumentation MAY "
"need to create new SPCs with a subset of the remaining "
"associations. On output, this is an array of references "
"to SPCs created or modified as the result of processing "
"the request.")]
CIM_SCSIProtocolController REF ProtocolControllers[],

[IN, Description (
"Do not issue a VLUN (Virtual Logical Unit Number) Change "
"Notification (VCN) after removal. For direct connect or "
"loop configuration, a VCN consists of a Fibre Channel "
"Loop Initialization Primitive (LIP). For fabric "
"configuration a VCN consists of Registered State Change "
"Notification (RSCN) being sent to the fabric controller. "
"This parameter is a vendor-specific extension for 3PAR. "
"The default value is false.")]
boolean NoVCN,

[OUT, Description (
"An array of descriptive text of the result of the operation, "
"with each entry containing the result of the "
"hide default LU operation.")]
string ResultDescriptions[]);
};

// ==================================================================
// ProtocolControllerMaskingCapabilities
// ==================================================================
[Description
("A subclass of Capabilities that defines the Masking-related "
"capabilities of the 3PAR InServ storage system.")]
class TPD_ProtocolControllerMaskingCapabilities :
CIM_ProtocolControllerMaskingCapabilities
{

};

// ==================================================================
// SystemControllerMaskingCapabilities

A.52 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// ==================================================================
[Association,
Description (
"TPD_SystemControllerMaskingCapabilities is an association between "
"StorageSystem and ProtocolControllerMaskingCapabilities.") ]
class TPD_SystemControllerMaskingCapabilities : CIM_ElementCapabilities
{
[Override ( "ManagedElement" ), Description (
"The StorageSystem.")]
TPD_StorageSystem REF ManagedElement;

[Override ( "Capabilities" ), Description (

"The protocol controller masking capabilities.")]
TPD_ProtocolControllerMaskingCapabilities REF Capabilities;
};

// ==================================================================
// ConfigServicesForSCSIController Association
// ==================================================================
[Association,
Description (
"TPD_ConfigServicesForSCSIController is an association between "
"TPD_SCSIController and ControllerConfigurationService.") ]
class TPD_ConfigServicesForSCSIController : CIM_ConcreteDependency
{
[Override ( "Antecedent" ), Description (
"The controller configuration service which the protocol "
"controller depends on for configuration.")]
TPD_ControllerConfigurationService REF Antecedent;

[Override ( "Dependent" ), Description (

"The protocol controller which uses the controller "
"configuration service.")]
TPD_SCSIController REF Dependent;
};

// ==================================================================
// 3PAR Storage System and Storage Volume association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"3PAR Data InServ Storage System and Storage Volume Association ") ]
class TPD_SystemVolume : CIM_SystemDevice
{
[Override ("GroupComponent"), Aggregate, Max (1), Min (1),

3PAR_TPD.mof A.53
 CIM API Programming Reference InForm OS Version 2.3.1

Description ("The storage system.") ]

TPD_StorageSystem REF GroupComponent;

[Override ("PartComponent"), Weak, Description (

"The storage volume on storage system.") ]
TPD_StorageVolume REF PartComponent;
};

// ==================================================================
// 3PAR SoftwareIdentity
// ==================================================================
[Description (
"3PAR SoftwareIdentity describes Inform OS version loaded "
"on InServ")]
class TPD_SoftwareIdentity : CIM_SoftwareIdentity
{
};

// ==================================================================
// 3PAR InstalledSoftwareIdentity
// ==================================================================
[Association,
Description (
"3PAR InstalledSoftwareIdentity is an association between "
"the system and Inform OS identity.")]
class TPD_InstalledSoftwareIdentity : CIM_InstalledSoftwareIdentity
{
[Override ("System"), Description (
"The system on which the Inform software is "
"installed. ") ]
TPD_StorageSystem REF System;

[Override ("InstalledSoftware"), Description (

"The SoftwareIdentity, e.g. Inform version and "
"release number, that is installed.") ]
TPD_SoftwareIdentity REF InstalledSoftware;
};

// ==================================================================
// 3PAR's system package describes InServ's system packaging attributes
// including model, serial number and OS version
// ==================================================================
[Description (

A.54 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"3PAR system package describes InServ's system packaging attributes "

" including model, serial number and OS version. ")]
class TPD_SystemPackage : CIM_PhysicalPackage
{
};

// ==================================================================
// 3PAR Storage System and System Package association
// ==================================================================
[Association,
Description (
"3PAR Data InServ Storage System and System Package Association.") ]
class TPD_ComputerSystemPackage : CIM_ComputerSystemPackage
{
[Override ("Antecedent"),
Description ("The InServ's physical package.") ]
TPD_SystemPackage REF Antecedent;

[Override ("Dependent"), Description (

"The InServ storage system.") ]
TPD_StorageSystem REF Dependent;
};

// ==================================================================
// 3PAR StorageCapabilities
// ==================================================================
[Description (
"3PAR Data StorageCapabilities. This class defines the capabilities "
"of a StoragePool. An instance of StorageCapabilities could be "
"associated with a StoragePool by using ElementCapabilities.")]
class TPD_StorageCapabilities: CIM_StorageCapabilities
{
};

// ==================================================================
// 3PAR CapabilitiesOfStoragePool
// ==================================================================
[Association,
Description (
"TPD_CapabilitiesOfStoragePool is an association between "
"StoragePool and StorageCapabilities."
"This association is used to figure out the service quality (RAID
types)"
" that a StoragePool can support.") ]

3PAR_TPD.mof A.55
 CIM API Programming Reference InForm OS Version 2.3.1

class TPD_CapabilitiesOfStoragePool: CIM_ElementCapabilities

{
[Override ( "ManagedElement" ), Description (
"The StoragePool.")]
TPD_StoragePool REF ManagedElement;

[Override ( "Capabilities" ), Description (

"The capabilities (RAID types) that the StoragePool can support.")]
TPD_StorageCapabilities REF Capabilities;
};

// ===================================================================
// 3PAR StorageSettingsAssociatedToCapabilities
// ===================================================================
[Association, Description (
"This association define StorageSettings that reflect the "
"capabilities of the associated StorageCapabilities. The "
"associated StorageSetting MAY NOT define the operational "
"characteristics (through settings properties) of any storage "
"element. Certain StorageSetting instances can be defined as "
"\"Fixed = Not Changeable\" by using the \"ChangeableType\" "
"attribute. \"Fixed\" settings have this special association. "
"This association SHALL be defined between \"Fixed - Not "
"Changeable\" instances of StorageSetting with the "
"StorageCapabilities instances that are associated with the "
"StoragePools which support the storage characteristics "
"described by the StorageSetting instance. \n"
"Fixed settings MAY be associated to many StorageCapabilities.")]
class TPD_StorageSettingsAssociatedToCapabilities :
CIM_StorageSettingsAssociatedToCapabilities
{
[Override ( "Antecedent" ), Description (
"3PAR StorageCapabilities.")]
TPD_StorageCapabilities REF Antecedent;

[Override ( "Dependent" ), Description (

"3PAR StorageSetting.")]
TPD_StorageSetting REF Dependent;
};

// ===================================================================
// 3PAR StorageSettingsGeneratedFromCapabilities
// ===================================================================
[Association, Description (

A.56 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"This association define StorageSettings that reflect the "

"capabilities of the associated StorageCapabilities. The "
"associated StorageSetting may not define the operational "
"characteristics (through settings properties) of any storage "
"element. StorageSettingsGeneratedFromCapabilities is the "
"association between instances of StorageCapabilities and those "
"instances of StorageSetting that have been created from the "
"StorageCapabilities instance using the StorageCapabilities "
"\"CreateSetting\" method. These settings have a "
"StorageSetting.ChangeableType of \"Changeable - Transient\" or "
"\"Changeable - Persistent\" The settings associated by this "
"class reflect the capabilities from which they are generated. "
"These setting SHALL be associated with one "
"StorageCapabilities. \n"
"A generated setting can be deleted by the implementation at "
"any time if it is a a StorageSetting of \"Changed - "
"Transient\" ChangeableType. \n"
"A client should not use this association to find transient "
"Settings to subsequently modify and/or use because that would "
"increase the likelihood of setting contention across clients. "
"Instead the implementation uses this association to define "
"transient settings, which can be located through any means, "
"that have special temporal based life cycle. \n"
"DefaultSetting is meaningless in this class.")]
class TPD_StorageSettingsGeneratedFromCapabilities :
CIM_StorageSettingsGeneratedFromCapabilities
{
[Override ( "Antecedent" ), Description (
"3PAR StorageCapabilities.")]
TPD_StorageCapabilities REF Antecedent;

[Override ( "Dependent" ), Description (

"3PAR StorageSetting.")]
TPD_StorageSetting REF Dependent;
};

// ==================================================================
// 3PAR's product package describes InServ's product attributes
// including vendor name, product name, serial number and OS version
// ==================================================================
[Description (
"3PAR product package describes InServ's product attributes"
" including vendor name, product name, serial number and OS version. ")]
class TPD_Product : CIM_Product
{

3PAR_TPD.mof A.57
 CIM API Programming Reference InForm OS Version 2.3.1

};

// ==================================================================
// 3PAR Product and System Package association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"3PAR Data InServ Product and System Package Association.") ]
class TPD_ProductPhysicalComponent : CIM_ProductPhysicalComponent
{
[Override ("GroupComponent"), Aggregate, Max (1), Min (1),
Description ("The InServ product.") ]
TPD_Product REF GroupComponent;

[Override ("PartComponent"), Description (

"The InServ's system packaging attributes.") ]
TPD_SystemPackage REF PartComponent;

};

// ==================================================================
// StorageHardwareID
// ==================================================================
[Description (
"StorageHardwareID represents the host HBA.")]
class TPD_StorageHardwareID : CIM_StorageHardwareID {
};

// ==================================================================
// AuthorizedPrivilege
// ==================================================================
[Description (
"AuthorizedPrivilege represents the access permission "
"that a StorageHardwareID is allowed on a "
"SCSIProtocolController.")]
class TPD_AuthorizedPrivilege : CIM_AuthorizedPrivilege {
};

// ==================================================================
// PrivilegeForStorageHardwareID
// ==================================================================
[Association,
Description (
"PrivilegeForStorageHardwareID associates StorageHardwareID "

A.58 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"to its access permission (AuthorizedPrivilege).")]

class TPD_PrivilegeForStorageHardwareID : CIM_AuthorizedSubject {
[Override ( "Privilege" ), Description (
"The AuthorizedPrivilege either granted or denied to an "
"Identity, Role or Collection. Whether the privilege is "
"granted or denied is defined by the inherited property, "
"CIM_Privilege.PrivilegeGranted.")]
TPD_AuthorizedPrivilege REF Privilege;

[Override ( "PrivilegedElement" ), Description (

"The host for which AuthorizedPrivileges are granted or "
"denied. Whether the privilege is granted or denied is "
"defined by the property, CIM_Privilege.PrivilegeGranted.")]
TPD_StorageHardwareID REF PrivilegedElement;
};

// ==================================================================
// PrivilegeForSCSIController
// ==================================================================
[Association, Description (
"PrivilegeForSCSIController is an association used to tie the "
"AuthorizedPrivileges to SCSIProtocolController resources.")]
class TPD_PrivilegeForSCSIController : CIM_AuthorizedTarget {

[Override ( "Privilege" ), Description (

"The AuthorizedPrivilege affecting the SCSIProtocolController "
"resource.")]
TPD_AuthorizedPrivilege REF Privilege;

[Override ( "TargetElement" ), Description (

"The SCSIProtocolController resources to which the "
"AuthorizedPrivilege applies.")]
TPD_SCSIController REF TargetElement;
};

// ==================================================================
// StorageHardwareIDCollection
// ==================================================================
[Description (
"A collection of StorageHardwareIDs (host WWN) within a host.")]
class TPD_StorageHardwareIDCollection : CIM_SystemSpecificCollection {
[Description (
"Number of StorageHardwareID's (WWN's) for this host.")]
uint16 StorageHardwareIDCount;
};

3PAR_TPD.mof A.59
 CIM API Programming Reference InForm OS Version 2.3.1

// ==================================================================
// MemberOfStorageHardwareIDCollection
// ==================================================================
[Association, Aggregation, Description (
"MemberOfStorageHardwareIDCollection is an aggregation used "
"to establish membership of StorageHardIDs (host WWNs) in a "
"host.")]
class TPD_MemberOfStorageHardwareIDCollection : CIM_MemberOfCollection {

[Key, Aggregate, Description (

"The MemberOfStorageHardwareIDCollection (host) that "
"aggregates StorageHardwareID (host WWNs).")]
TPD_StorageHardwareIDCollection REF Collection;

[Key, Description (
"The aggregated member of the "
"MemberOfStorageHardwareIDCollection.")]
TPD_StorageHardwareID REF Member;
};

// ==================================================================
// StorageHardwareIDManagementService
// ==================================================================
[Description (
"StorageHardwareIDManagementService provides methods for "
"manipulating instances of StorageHardwareIDs and manipulating "
"the trust of these IDs in the underlying storage system.")]
class TPD_StorageHardwareIDManagementService :
CIM_StorageHardwareIDManagementService {
};

// ==================================================================
// HostedStorageHWIDManagementService
// ==================================================================
[Association, Description (
"TPD_HostedStorageHWIDManagementService is an association "
"between TPD_StorageSystem and "
"TPD_StorageHardwareIDManagementService. The cardinality of "
"this association is 1-to-1. A System may host only one "
"StorageHardwareIDManagementService. ")]
class TPD_HostedStorageHWIDManagementService : CIM_HostedService {
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The InServ StorageSystem.")]
TPD_StorageSystem REF Antecedent;

A.60 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Override ( "Dependent" ), Weak, Description (

"The StorageHardwareID management service hosted on the "
"3PAR InServ.")]
TPD_StorageHardwareIDManagementService REF Dependent;
};

// ==================================================================
// HostedStorageHardwareIDCollection
// ==================================================================
[Association, Description (
"HostedStorageHardwareIDCollection defines a "
"TPD_StorageHardwareIDCollection in a context of a scoping "
"TPD_StorageSystem.")]
class TPD_HostedStorageHardwareIDCollection : CIM_HostedCollection {

[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (

"The 3PAR StorageSystem.")]
TPD_StorageSystem REF Antecedent;

[Override ( "Dependent" ), Description (

"The collection of StorageHardwareIDs in the context of "
"the StorageSystem.")]
TPD_StorageHardwareIDCollection REF Dependent;
};

// ==================================================================
// MgmtServicesForStorageHWIDCollection Association
// ==================================================================
[Association,
Description (
"TPD_MgmtServicesForStorageHWIDCollection is an association between "
"TPD_StorageHardwareID or TPD_StorageHardwareIDCollection and "
"TPD_StorageHardwareIDManagementService.") ]
class TPD_MgmtServicesForStorageHWIDCollection : CIM_ConcreteDependency
{
[Override ( "Antecedent" ), Description (
"The storage hardware ID management service which the "
"StorageHardwareIDCollection depends on for configuration.")]
TPD_StorageHardwareIDManagementService REF Antecedent;
};

// ==================================================================
// PrivilegeManagementService

3PAR_TPD.mof A.61
 CIM API Programming Reference InForm OS Version 2.3.1

// ==================================================================
[Description (
"3PAR PrivilegeManagementService is responsible for creating, "
"deleting, and associating AuthorizedPrivilege instances. "
"References to 'subject' and 'target' define the entities that "
"are associated with an AuthorizedPrivilege instance via the "
"relationships, AuthorizedSubject and AuthorizedTarget, "
"respectively. When created, an AuthorizedPrivilege instance is "
"related to this (PrivilegeManagement)Service via the "
"association, ConcreteDependency. Note: 3PAR does not support"
"changing or removing AuthorizedPrivilege.")]
class TPD_PrivilegeManagementService : CIM_PrivilegeManagementService
{
};

// ==================================================================
// 3PAR StorageSystem and PrivilegeManagementService association.
// ==================================================================
[Association,
Description (
"TPD_HostedPrivilegeManagementService is an association "
"between TPD_StorageSystem and TPD_PrivilegeManagementService. "
"The cardinality of this association is 1-to-1. A System may "
"host only one PrivilegeManagementService. ")]
class TPD_HostedPrivilegeManagementService : CIM_HostedService {
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The InServ StorageSystem.")]
TPD_StorageSystem REF Antecedent;

[Override ( "Dependent" ), Description (

"The PrivilegeManagementService hosted on the 3PAR InServ.")]
TPD_PrivilegeManagementService REF Dependent;
};

// ==================================================================
// ManagementServicesForAuthorizedPrivilege association
// ==================================================================
[Association,
Description (
"TPD_ManagementServiceForAuthorizedPrivilege is an association "
"between TPD_PrivilegeManagementService and "
"TPD_AuthorizedPrivilege.") ]
class TPD_ManagementServiceForAuthorizedPrivilege : CIM_ConcreteDependency
{

A.62 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Override ( "Antecedent" ), Description (

"The privilege management service which supports "
"authorized privilege.")]
TPD_PrivilegeManagementService REF Antecedent;

[Override ( "Dependent" ), Description (

"The authorized privilege which uses the management service.")]
TPD_AuthorizedPrivilege REF Dependent;
};

// ==================================================================
// Indication
// ==================================================================
[Indication,
Description (
"Indication specifying that the operational status of an FC "
"port has changed.")
]
class TPD_FCPortInstModification : CIM_InstModification
{
};

// ==================================================================
// 3PAR System and ControllerConfigurationService association.
// ==================================================================
[Association,
Description (
"TPD_SystemHostedCCS is an association between TPD_StorageSystem "
"and TPD_ControllerConfigurationService. The cardinality of "
"this association is 1-to-1. A System may host only one "
"ControllerConfigurationService. ")]
class TPD_SystemHostedCCS : CIM_HostedService {
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The InServ StorageSystem.")]
TPD_StorageSystem REF Antecedent;

[Override ( "Dependent" ), Weak, Description (

"The ControllerConfigurationService hosted on the 3PAR InServ.")]
TPD_ControllerConfigurationService REF Dependent;
};

// ==================================================================
// 3PAR SFP

3PAR_TPD.mof A.63
 CIM API Programming Reference InForm OS Version 2.3.1

// ==================================================================
[Description (
"3PAR SFP for Node FC ports.")]
class TPD_SFP : CIM_PhysicalConnector {

[Description ("Revision code.") ]

String Revision;

[Description (
"The current bandwidth of the SFP in Bits per Second."),
Units ( "Bits per Second" )]
uint64 Speed;

[Description ("Position of the TX disable pin. If pin position is HI, "

"TX laser is disabled"),
ValueMap {"0", "1", "2"},
Values {"Unknown", "LO", "HI"} ]
uint16 DisableTXPinPosition;

[Description ("Position of the RX loss pin. If pin position is HI, "

"RX loss of signal"),
ValueMap {"0", "1", "2"},
Values {"Unknown", "LO", "HI"} ]
uint16 LossRXPinPosition;

[Description ("Position of the TX fault pin. If pin position is HI, "

"TX fault"),
ValueMap {"0", "1", "2"},
Values {"Unknown", "LO", "HI"} ]
uint16 FaultTXPinPosition;

[Description ("If TRUE, SFP is not qualified.") ]

boolean IsUnqualified;

[Description ("If TRUE, RX Power is Low.") ]

boolean IsRXPowerLow;

[Description ("If TRUE, DDM information is available.") ]

boolean IsDDMAvailable;
};

// ==================================================================
// 3PAR Port SFP
// ==================================================================
[Association, Description (

A.64 3PAR_TPD.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"A relationship between FCPort and it's SFP.")]

class TPD_FCPortSFP : CIM_PortActiveConnection {

[Override ( "Antecedent" ), Description (

"The PhysicalConnector.")]
TPD_SFP REF Antecedent;

[Override ( "Dependent" ), Description (

"The NetworkPort that transmits using the Connector.")]
TPD_FCPort REF Dependent;
};

#pragma include ("3PAR_TPDCage.mof")

#pragma include ("3PAR_TPDDisk.mof")
#pragma include ("3PAR_TPDNode.mof")
#pragma include ("3PAR_TPDEnv.mof")
#pragma include ("3PAR_TPDLocation.mof")
#pragma include ("3PAR_TPDEthPort.mof")
#pragma include ("3PAR_TPDiSCSI.mof")
#pragma include ("3PAR_TPDView.mof")
#pragma include ("3PAR_TPDStats.mof")

A.3 3PAR_TPDCage.mof
This MOF contains 3PAR Cage classes that loaded into the root/tpd namespace.

// ==================================================================
// Base TPD Drive Cage
// ==================================================================
[Description (
"Base 3PAR Drive Cage")]
class TPD_DriveCage : CIM_Chassis
{
[Description ("Type of the cage."), Read,
ValueMap {"0", "1", "2", "3", "4"},
Values {"Unknown", "DC0", "DC1", "DC2", "DC3"} ]
uint16 CageType;

[Description ("Subtype of the cage."), Read,

ValueMap {"0", "1", "2"},

3PAR_TPDCage.mof A.65
 CIM API Programming Reference InForm OS Version 2.3.1

Values {"FC", "SATA", "ALPHAFC"} ]

uint16 CageSubType;

[Description ("Position of the cage in the node."), Read ]

uint16 Position;

[Description ("Location of the cage.") ]

string Location;

[Description ("Shows if the loop is split."), Read ]

boolean LoopSplit;

[Description ("Chain position of the A Loop."), Read ]

uint16 ChainPositionLoopA;

[Description ("Chain position of the B Loop."), Read ]

uint16 ChainPositionLoopB;

[Description ("Shows if the locate is ON."), Read ]

boolean LocateON;

// =========================================
// Operations
// =========================================
[Description (
"This method causes LEDs on the cage to blink, or turn amber."),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 Locate(
[IN, Description (
"Number of seconds to have locate cage turned on. "
"Default 60, maximum 255.")]
uint16 LocateTimer
);

[Description (
"This method upgrades firmware on the cage."),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 Upgrade(
[IN, Required, Description (
"The name of the file to download for firmware upgrade.")]
string FileName,
[IN, Required, Description (
"If TRUE, download A port, otherwise B port.")]

A.66 3PAR_TPDCage.mof
InForm OS Version 2.3.1 CIM API Programming Reference

boolean IsPortA
);
};

// ==================================================================
// DC0 and DC1 TPD Drive Cage
// ==================================================================
[Description (
"DC0 and DC1 3PAR Drive Cage")]
class TPD_DriveCageDC1 : TPD_DriveCage
{
[Description ("Side of the cage."), Read,
ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "Left", "Right", "Left and Right"} ]
uint16 CageSide;
};

// ==================================================================
// DC2 TPD Drive Cage
// ==================================================================
[Description (
"DC2 3PAR Drive Cage")]
class TPD_DriveCageDC2 : TPD_DriveCage
{
[Description ("Side of the cage."), Read,
ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "Left", "Right", "Left and Right"} ]
uint16 CageSide;

[Description ("Firmware version on the midplane CPU."), Read ]

string FirmwareVersion;

[Description ("Status of the firmware on the midplane CPU."), Read,

ValueMap {"0", "1", "2"},
Values {"Unknown", "Not Current", "Current"} ]
uint16 FirmwareStatus;

[Description ("State of midplane CPU."), Read,

ValueMap {"0", "1", "2", "3", "4", "5", "6"},
Values {"No Response", "Fatal Error", "OK",
"Hotplug Ready", "Loop Down Recovery", "Updating Firmware",
"Copying Firmware"} ]
uint16 CPUState;
};

3PAR_TPDCage.mof A.67
 CIM API Programming Reference InForm OS Version 2.3.1

// ==================================================================
// DC3 TPD Drive Cage
// ==================================================================
[Description (
"DC3 3PAR Drive Cage")]
class TPD_DriveCageDC3 : TPD_DriveCage
{
[Description ("Status of the temperature sensor."), Read,
ValueMap {"0", "1", "2", "3", "4", "5", "6", "7"},
Values {"Unknown", "OK", "Over Threshold", "Over/Under Threshold",
"Communication Error", "Not Present", "IM Sync failed",
"Not Available"} ]
uint16 TempSensorState;

[Description ("Value of the temperature sensor."), Read ]

uint16 TempSensorValue;

[Description ("Status of the temperature sensor threshold."), Read,

ValueMap {"0", "1", "2", "3", "4", "5"},
Values {"Unknown", "OK", "Under Warning Threshold",
"Under Failure Threshold", "Over Warning Threshold",
"Over Failure Threshold"} ]
uint16 TempSensorThreshold;

[Description ("Status of the operators panel."), Read,

ValueMap {"0", "1", "2", "3", "4", "5", "6"},
Values {"Unknown", "OK", "Failed", "Warning",
"Unrecoverable", "Not Present", "Not Available"} ]
uint16 OperatorPanelState;

[Description ("Status of the audible alarm."), Read,

ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "OK", "Muted", "Unrecoverable"} ]
uint16 AudibleAlarmState;

[Description ("Enclosure ID."), Read ]

uint16 EnclosureID;
};

// ==================================================================
// Base TPD Cage Interface Card
// ==================================================================
[Description (
"Base 3PAR Cage Interface Card ")]
class TPD_CageInterfaceCard : CIM_Card

A.68 3PAR_TPDCage.mof
InForm OS Version 2.3.1 CIM API Programming Reference

{
[Description ("Position of the Interface Card in the cage.") ]
uint16 Position;

[Description ("Type of the cage this Interface Card is in."),

ValueMap {"0", "1", "2", "3", "4"},
Values {"Unknown", "DC0", "DC1", "DC2", "DC3"} ]
uint16 CageType;

[Description ("Position of the Interface Card on the loop."),

ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "Loop A", "Loop B", "Both"} ]
uint16 LoopPosition;

[Description ("WWN of the Loop A ports in Interface Card. Array index 0"
" represents Loop A0, array index 1 represents"
" Loop A1, etc.") ]
uint64 LoopAPortWWNs[];

[Description ("WWN of the Loop B ports in Interface Card. Array index 0"
" represents Loop B0, array index 1 represents"
" Loop B1, etc.") ]
uint64 LoopBPortWWNs[];

[Description ("WWN of the Node FC Port connected to A Loop(s). Array index

0"
" represents Loop A0, array index 1 represents"
" Loop A1, etc.") ]
uint64 NodePortsLoopA[];

[Description ("WWN of the Node FC Port connected to B Loops. Array index 0"
" represents Loop B0, array index 1 represents"
" Loop B1, etc.") ]
uint64 NodePortsLoopB[];

[Description ("Loop A link speed. Array index 0"

" represents Loop A0, array index 1 represents"
" Loop A1, etc."),
ValueMap {"1", "2", "4", "10"},
Values {"1G", "2G", "4G", "10G"} ]
uint16 LoopALinkSpeed[];

[Description ("Loop B link speed. Array index 0"

" represents Loop B0, array index 1 represents"
" Loop B1, etc."),

3PAR_TPDCage.mof A.69
 CIM API Programming Reference InForm OS Version 2.3.1

ValueMap {"1", "2", "4", "10"},

Values {"1G", "2G", "4G", "10G"} ]
uint16 LoopBLinkSpeed[];
};

// ==================================================================
// TPD Cage Interface Card for DC0 and DC1 cage
// ==================================================================
[Description (
"3PAR Cage Interface Card for DC0 and DC1 cage")]
class TPD_CageInterfaceCardDC1 : TPD_CageInterfaceCard
{
[Description ("Split LED status."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 SplitLED;

[Description ("System LED status."),

ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 SystemLED;

[Description ("Hot-plug LED status."),

ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 HotplugLED;

[Description ("State of Interface Card CPU."),

ValueMap {"0", "1", "2", "3", "4", "5", "6"},
Values {"Partner Not Responding", "Fatal Error", "OK",
"Hotplug Ready", "Loop Down Recovery", "Updating Firmware",
"Copying Firmware"} ]
uint16 CPUSelfState;

[Description ("State of partner Interface Card CPU."),

ValueMap {"0", "1", "2", "3", "4", "5", "6"},
Values {"Partner Not Responding", "Fatal Error", "OK",
"Hotplug Ready", "Loop Down Recovery", "Updating Firmware",
"Copying Firmware"} ]
uint16 CPUPartnerState;

[Description ("Status of the firmware on the Interface Card processor."),

ValueMap {"0", "1", "2"},
Values {"Unknown", "Not Current", "Current"} ]
uint16 FirmwareStatus;

A.70 3PAR_TPDCage.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Description ("Firmware version on the Interface Card processor.") ]

string FirmwareVersion;

[Description ("Loop A link LED status."

" Array index 0 is Loop A0, array index 1 is Loop A1."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 LoopALinkLED[];

[Description ("Loop B link LED status."

" Array index 0 is Loop B0, array index 1 is Loop B1."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 LoopBLinkLED[];

[Description ("Shows if the locate is ON."

" Array index 0 is Loop A0, array index 1 is Loop A1.") ]
boolean LoopALocateON[];

[Description ("Shows if the locate is ON."

" Array index 0 is Loop B0, array index 1 is Loop B1.") ]
boolean LoopBLocateON[];

// =========================================
// Operations
// =========================================
[Description (
"This method causes the FC connection LED on the cage to blink. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 Locate(
[IN, Required, Description (
"The port of the FC-AL card in the cage to locate."),
ValueMap {"1", "2", "3", "4"},
Values {"A0", "A1", "B0", "B1" }]
uint16 Port,
[IN, Description (
"Number of seconds to have locate cage turned on. "
"Default 60, maximum 255.")]
uint16 LocateTimer
);
};

// ==================================================================

3PAR_TPDCage.mof A.71
 CIM API Programming Reference InForm OS Version 2.3.1

// TPD Cage Interface Card for DC2 cage

// ==================================================================
[Description (
"3PAR Cage Interface Card for DC2 cage")]
class TPD_CageInterfaceCardDC2 : TPD_CageInterfaceCard
{
[Description ("Split LED status."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 SplitLED;

[Description ("System LED status."),

ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 SystemLED;

[Description ("Hot-plug LED status."),

ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 HotplugLED;

[Description ("Loop A sfp link RX status."

" Array index 0 is Loop A0, array index 1 is Loop A1."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 LoopALinkRX[];

[Description ("Loop B sfp link RX status."

" Array index 0 is Loop A0, array index 1 is Loop A1."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 LoopBLinkRX[];

[Description ("Loop A sfp link TX status."

" Array index 0 is Loop B0, array index 1 is Loop B1."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 LoopALinkTX[];

[Description ("Loop B sfp link TX status."

" Array index 0 is Loop B0, array index 1 is Loop B1."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 LoopBLinkTX[];

A.72 3PAR_TPDCage.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Description ("Loop A SFP name."

" Array index 0 is Loop A0, array index 1 is Loop A1.") ]
string LoopASFPName[];

[Description ("Loop B SFP name."

" Array index 0 is Loop B0, array index 1 is Loop B1.") ]
string LoopBSFPName[];

[Description ("Loop A SFP state."

" Array index 0 is Loop A0, array index 1 is Loop A1."),
ValueMap {"0", "1", "2", "3", "4"},
Values {"Missing", "OK", "Unqualified", "EEPROM Fault",
"Unqualified, EEPROM Fault" } ]
uint16 LoopASFPState[];

[Description ("Loop B SFP state."

" Array index 0 is Loop B0, array index 1 is Loop B1."),
ValueMap {"0", "1", "2", "3", "4"},
Values {"Missing", "OK", "Unqualified", "EEPROM Fault",
"Unqualified, EEPROM Fault" } ]
uint16 LoopBSFPState[];

[Description ("Loop A SFP vendor."

" Array index 0 is Loop A0, array index 1 is Loop A1.") ]
string LoopASFPVendor[];

[Description ("Loop B SFP vendor."

" Array index 0 is Loop B0, array index 1 is Loop B1.") ]
string LoopBSFPVendor[];

[Description ("Loop A SFP model."

" Array index 0 is Loop A0, array index 1 is Loop A1.") ]
string LoopASFPModel[];

[Description ("Loop B SFP model."

" Array index 0 is Loop B0, array index 1 is Loop B1.") ]
string LoopBSFPmodel[];

[Description ("Loop A SFP serial number."

" Array index 0 is Loop A0, array index 1 is Loop A1.") ]
string LoopASFPSerial[];

[Description ("Loop B SFP serial number."

" Array index 0 is Loop B0, array index 1 is Loop B1.") ]
string LoopBSFPSerial[];

3PAR_TPDCage.mof A.73
 CIM API Programming Reference InForm OS Version 2.3.1

[Description ("Shows if the locate is ON."

" Array index 0 is Loop A0, array index 1 is Loop A1.") ]
boolean LoopALocateON[];

[Description ("Shows if the locate is ON."

" Array index 0 is Loop B0, array index 1 is Loop B1.") ]
boolean LoopBLocateON[];

// =========================================
// Operations
// =========================================
[Description (
"This method causes the FC connection LED on the cage to blink. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 Locate(
[IN, Required, Description (
"The port of the FC-AL card in the cage to locate."),
ValueMap {"1", "2", "3", "4"},
Values {"A0", "A1", "B0", "B1" }]
uint16 Port,
[IN, Description (
"Number of seconds to have locate cage turned on. "
"Default 60, maximum 255.")]
uint16 LocateTimer
);
};

// ==================================================================
// TPD Cage Interface Card for DC3 cage
// ==================================================================
[Description (
"3PAR Cage Interface Card for DC3 cage. DC3 cage has 2 FC-ALs, with one "
"having four A loops, and the other four B loops."
"Check LoopPosition to see if Cage Interface instance for A or B.")]
class TPD_CageInterfaceCardDC3 : TPD_CageInterfaceCard
{
[Description ("If master set to TRUE.") ]
boolean IsMaster;

[Description ("Loop A link speed. Array index 0"

" represents Loop A0, array index 1 represents"
" Loop A1, etc."),
ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9",

A.74 3PAR_TPDCage.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"10", "11", "12", "13", "14", "15", "16", "17", "18", "19",
"20", "21", "22", "23", "24", "25", "26", "27", "28", "29",
"30", "31", "32", "33"},
Values {"Unknown", "OK", "Warning,High LIP",
"Warning,Burst Word Errors", "Warning,High Word Errors",
"Warning,High CRC Errors", "Warning,High Clock Delta",
"Bypass", "No SFP Present", "Bypass,Tx Fault", "Bypass,LIP",
"Bypass,Data Timeout", "Bypass,RX Loss", "Bypass,Sync Loss",
"Bypass,PTFI", "Manual Bypass, System Manager",
"Manual Bypass,Redundant Port Connection",
"Manual Bypass,Stall Threshold",
"Manual Bypass,Burst Word Error Threshold",
"Manual Bypass,High Word Error Threshold",
"Manual Bypass,Burst CRC Error Threshold",
"Manual Bypass,High CRC Error Threshold",
"Manual Bypass,High Clock Delta Threshold",
"Manual Bypass,Mirror Configuration",
"Manual Bypass,Host Management Rules",
"Manual Bypass,Trunked Cabling Errors",
"Manual Bypass,TBD", "Manual Bypass,Looped Back",
"Manual Bypass,Insert Oscillation",
"Manual Bypass,Burst LIP Threshold",
"Manual Bypass,High LIP Threshold",
"Manual Bypass, Diagnostic Transmit",
"Manual Bypass,Drive Bypass", "Manual Bypass,Drive Fault"} ]
uint16 LoopState[];

[Description ("Status of the firmware on the Interface Card processor."),

ValueMap {"0", "1", "2"},
Values {"Unknown", "Not Current", "Current"} ]
uint16 FirmwareStatus;

[Description ("Firmware version on the Interface Card processor.") ]

string FirmwareVersion;

[Description ("State of Interface Card IFC."),

ValueMap {"0", "1", "2", "3", "4", "5", "6"},
Values {"Unknown", "OK", "Failed", "Warning",
"Unrecoverable", "Not Installed", "Not Available"} ]
uint16 IFCState;

[Description ("State of Interface Card ESH."),

ValueMap {"0", "1", "2", "3", "4", "5", "6"},
Values {"Unknown", "OK", "Failed", "Warning",
"Unrecoverable", "Not Installed", "Not Available"} ]

3PAR_TPDCage.mof A.75
 CIM API Programming Reference InForm OS Version 2.3.1

uint16 ESHState;

[Description ("Extended State of Interface Card ESH. Use this when ESHState"
"is set to 2"),
ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8"},
Values {"Unknown", "OK", "Microcontroller Failed POST",
"Microcontroller FATAL Error", "ASIC Not Functioning",
"ASIC Failed POST", "ASIC Port Failed POST",
"ASIC Clock Delta Beyond Threshold", "Unavailable"} ]
uint16 ExtendedESHState;
};

// ==================================================================
// 3PAR Drive Cage and Cage Interface Card association
// ==================================================================
[Association, Aggregation,
Description (
"3PAR Data Drive Cage and Interface Card association")]
class TPD_InterfaceCardInDriveCage : CIM_PackageInChassis {

[Aggregate, Override ( "GroupComponent" ), Max ( 1 ),

Description (
"The Drive Cage that contains FC-AL cards")]
TPD_DriveCage REF GroupComponent;

[Override ( "PartComponent" ), Description (

"The FC-AL card that is contained in the Drive Cage.")]
TPD_CageInterfaceCard REF PartComponent;
};

// ===================================================================
// Base 3PAR Magazine
// ===================================================================
[Description (
"Base 3PAR Disk Magazine ")]
class TPD_Magazine : CIM_Magazine {

[Description ("Position of the Magazine in the cage.") ]

uint16 Position;

[Description ("Side of the cage this magazine is in."),

ValueMap {"0", "1", "2"},
Values {"None", "Left", "Right"} ]
uint16 SideSplit;

A.76 3PAR_TPDCage.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Description ("Type of the cage this magazine is in."),

ValueMap {"0", "1", "2", "3", "4"},
Values {"Unknown", "DC0", "DC1", "DC2", "DC3"} ]
uint16 CageType;

[Description ("State of Magazine on Loop A."),

ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8"},
Values {"Unknown", "Not Present", "OK", "Loop Failed",
"I2C Transaction Failed", "Power Supply Failed",
"Manual Bypass, System Manager", "Manual Bypass, Port",
"Midplane I2C Transaction Failed"} ]
uint16 StateOnLoopA;

[Description ("State of Magazine on Loop B."),

ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8"},
Values {"Unknown", "Not Present", "OK", "Loop Failed",
"I2C Transaction Failed", "Power Supply Failed",
"Manual Bypass, System Manager", "Manual Bypass, Port",
"Midplane I2C Transaction Failed"} ]
uint16 StateOnLoopB;

[Description ("Shows if the locate is ON."), Read ]

boolean LocateON;

// =========================================
// Operations
// =========================================
[Description (
"This method causes LEDs on the magazine to blink, or turn amber. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 Locate(
[IN, Description (
"Number of seconds to have locate cage turned on. "
"Default 60, maximum 255.")]
uint16 LocateTimer
);
[Description (
"This method causes magazine to go on or off loop. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 SetLoopState(
[IN, Required, Description (
"If true, magazine set on-loop, if false "
"magazine set off-loop.")]

3PAR_TPDCage.mof A.77
 CIM API Programming Reference InForm OS Version 2.3.1

boolean IsOnloop,
[IN, Description (
"If true, operation performed on Port A, "
"if false, operation performed on Port B. "
"If not passed, operation performed on both.")]
boolean IsPortA
);
};

// ===================================================================
// 3PAR Magazine for DC0, DC1 cages
// ===================================================================
[Description (
"3PAR Disk Magazine for DC0, DC1 cages")]
class TPD_MagazineDC1 : TPD_Magazine {

[Description ("System LED status."),

ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 SystemLED;

[Description ("Hot-plug LED status."),

ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 HotplugLED;
};

// ===================================================================
// 3PAR Magazine for DC2 cages
// ===================================================================
[Description (
"3PAR Disk Magazine for DC2 cages")]
class TPD_MagazineDC2 : TPD_MagazineDC1 {
};

// ===================================================================
// 3PAR Magazine for DC3 cage
// ===================================================================
[Description (
"3PAR Disk Magazine for DC3 cage")]
class TPD_MagazineDC3 : TPD_Magazine {

[Description ("Overall state of the Loop A and B."),

ValueMap {"0", "2", "3", "6"},
Values {"Unknown", "OK", "Degraded", "Error"} ]

A.78 3PAR_TPDCage.mof
InForm OS Version 2.3.1 CIM API Programming Reference

uint16 OverallLoopState;
};

// ==================================================================
// 3PAR Drive Cage and Magazine association
// ==================================================================
[Association, Aggregation,
Description (
"3PAR Data Drive Cage and Magazine association")]
class TPD_MagazineInDriveCage : CIM_PackageInChassis {

[Aggregate, Override ( "GroupComponent" ), Max ( 1 ),

Description (
"The Drive Cage that contains Magazines")]
TPD_DriveCage REF GroupComponent;

[Override ( "PartComponent" ), Description (

"The Magazine that is contained in the Drive Cage.")]
TPD_Magazine REF PartComponent;
};

// ==================================================================
// TPD_SystemPackage and TPD_DriveCage association
// ==================================================================
[Association, Aggregation, Description (
"The SysCageContainer association represents the relationship between "
"a TPD_SystemPackage and TPD_DriveCage.")]
class TPD_SysCageContainer : CIM_Container {

[Aggregate, Override ( "GroupComponent" ), Max ( 1 ),

Description (
"The SystemPackage that contains DriveCage(s)")]
TPD_SystemPackage REF GroupComponent;

[Override ( "PartComponent" ), Description (

"The TPD_DriveCage which is contained in the SystemPackage.")]
TPD_DriveCage REF PartComponent;
};

// ==================================================================
// TPD Cage Sensor
// ==================================================================
[Description (
"TPD Cage Sensor information")]
class TPD_CageSensor : CIM_Sensor

3PAR_TPDCage.mof A.79
 CIM API Programming Reference InForm OS Version 2.3.1

{
[Description ("Position of the Sensor in the cage.") ]
uint16 Position;

[Description ("Sensor base unit."), Read ]

string BaseUnit;

[Description ("Current sensor reading (actual * 100)."), Read ]

uint16 CurrentReading;

[Description ("Low limit (actual * 100)."), Read ]

uint16 LowLimit;

[Description ("High limit (actual * 100)."), Read ]

uint16 HighLimit;

[Description ("Sensor state."),

ValueMap {"0", "1", "2"},
Values {"OK", "Under Limit", "Over Limit"} ]
uint16 State;
};

// ==================================================================
// TPD DriveCage Sensor
// ==================================================================
[Association, Description (
"Many Devices include Sensors or have Sensors installed nearby, "
"in order to measure critical input and output properties. This "
"association indicates that relationship.")]
class TPD_SensorInDriveCage : CIM_PackageDependency {

[Override ( "Antecedent" ), Description (

"The Sensor.")]
TPD_CageSensor REF Antecedent;

[Override ( "Dependent" ), Description (

"The LogicalDevice for which information is measured by the "
"Sensor.")]
TPD_DriveCageDC2 REF Dependent;
};

A.80 3PAR_TPDCage.mof
InForm OS Version 2.3.1 CIM API Programming Reference

A.4 PAR_TPDDisk.mof
This MOF contains 3PAR Disk Classes that loaded into the root/tpd namespace. (Disk Drive
Lite).

[Description (
"3PAR Disk Drive ")]
class TPD_DiskDrive : CIM_DiskDrive {

[Description ("Position of the Drive in the Magazine.") ]

uint16 Position;

[Description ("Type of the cage this disk is in."),

ValueMap {"0", "1", "2", "3", "4"},
Values {"Unknown", "DC0", "DC1", "DC2", "DC3"} ]
uint16 CageType;

[Description ("System id number of the Drive.") ]

uint32 ID;

[Description ("Device type of the Disk."),

ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "FC", "NL", "ALL"} ]
uint16 DeviceType;

[Description ("Temperature of the Drive in C.") ]

uint16 Temperature;

[Description ("If Drive can be used to allocate LD.") ]

boolean IsLDAllocateable;

[Description ("State of Disk on Loop A."),

ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",
"11", "12", "13", "14", "15", "16"},
Values {"Unknown", "Not Present", "Offloop", "New Onloop", "Spinning Up",
"OK", "Spin Up Failed", "Loop Failed", "Drive Error Bit On",
"Manual Bypass, System Manager", "Manual Bypass, Port",
"Not Ready", "Spundown, System Manager", "Spundown, Port",
"Spundown, Over Temperature", "Spinning Down Fail",
"I2C Transaction Failed"} ]
uint16 StateOnLoopA;

[Description ("State of Disk on Loop B."),

PAR_TPDDisk.mof A.81
 CIM API Programming Reference InForm OS Version 2.3.1

ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",
"11", "12", "13", "14", "15", "16"},
Values {"Unknown", "Not Present", "Offloop", "New Onloop", "Spinning Up",
"OK", "Spin Up Failed", "Loop Failed", "Drive Error Bit On",
"Manual Bypass, System Manager", "Manual Bypass, Port",
"Not Ready", "Spundown, System Manager", "Spundown, Port",
"Spundown, Over Temperature", "Spinning Down Fail",
"I2C Transaction Failed"} ]
uint16 StateOnLoopB;

[Description ("ALPA on Loop A.") ]

uint16 AlpaOnLoopA;

[Description ("ALPA on Loop B.") ]

uint16 AlpaOnLoopB;

[Description ("Size of the chunk.") ]

uint64 ChunkSize;

[Description ("Number of Normal Used OK chunks.") ]

uint16 ChunksNormalUsedOK;

[Description ("Number of Normal Used Fail chunks.") ]

uint16 ChunksNormalUsedFail;

[Description ("Number of Normal Unused Free chunks.") ]

uint16 ChunksNormalUnusedFree;

[Description ("Number of Normal Unused Uninitialized chunks.") ]

uint16 ChunksNormalUnusedUninit;

[Description ("Number of Normal Unused Fail chunks.") ]

uint16 ChunksNormalUnusedFail;

[Description ("Number of Spare Used OK chunks.") ]

uint16 ChunksSpareUsedOK;

[Description ("Number of Spare Used Fail chunks.") ]

uint16 ChunksSpareUsedFail;

[Description ("Number of Spare Unused Free chunks.") ]

uint16 ChunksSpareUnusedFree;

[Description ("Number of Spare Unused Uninitialized chunks.") ]

uint16 ChunksSpareUnusedUninit;

A.82 PAR_TPDDisk.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Description ("Number of Spare Unused Fail chunks.") ]

uint16 ChunksSpareUnusedFail;

[Description ("Number of Correctable READ Errors.") ]

uint64 CorrectableReadErrors;

[Description ("Number of Uncorrectable READ Errors.") ]

uint64 UncorrectableReadErrors;

[Description ("Number of Correctable WRITE Errors.") ]

uint64 CorrectableWriteErrors;

[Description ("Number of Uncorrectable WRITE Errors.") ]

uint64 UncorrectableWriteErrors;

[Description ("3PAR specific operational state for the disk"),

ValueMap {"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10",
"11"},
Values {"Unknown", "OK", "Error", "Not Ready",
"Missing", "Named in table but invalid label", "New",
"drive block size is not 512 bytes",
"Invalid drive type, unknown vendor", "Unknown firmware",
"Size reported does not allow the number of "
"chunklets specified in scsi database", "No cage found"} ]
uint16 OtherOperationalStatus;
};

[Description (
"3PAR Disk Drive for DC0 and DC1 cage")]
class TPD_DiskDriveDC1 : TPD_DiskDrive {
[Description ("System LED status."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 SystemLED;
};

[Description (
"3PAR Disk Drive for DC2 cage")]
class TPD_DiskDriveDC2 : TPD_DiskDrive {
[Description ("System LED status."),
ValueMap {"0", "1", "2"},
Values {"Off", "Amber", "Green"} ]
uint16 SystemLED;

PAR_TPDDisk.mof A.83
 CIM API Programming Reference InForm OS Version 2.3.1

[Description ("If Drive is used for ESI Channel.") ]

boolean IsESI;

[Description ("ESI State of Disk."),

ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "Not Present", "OK", "Failed"} ]
uint16 ESIState;
};

[Description (
"3PAR Disk Drive for DC3 cage")]
class TPD_DiskDriveDC3 : TPD_DiskDrive {
[Override ( "StateOnLoopA" ), Description ("State of Disk on Loop A."),
ValueMap {"0", "1", "5", "9", "0x0411", "0x0414", "0x0415", "0x0417",
"0x0418", "0x0421", "0x0423", "0x0424", "0x0425", "0x0426", "0x0427",
"0x0428", "0x0432", "0x0433", "0x0434", "0x0435", "0x0436", "0x0437",
"0x0438", "0x0439", "0x043B", "0x043C", "0x043E", "0x043F", "0x0440",
"0x0441", "0x0442", "0x044F", "0x0450", "0x0451"},
Values {"Unknown", "Not Present", "OK", "Bypass, System Manager",
"Warning,High LIP", "Warning,Word Error Burst", "Warning,Word Error
High",
"Warning,High CRC", "Warning,High Clock Delta", "Bypass",
"Bypass,TX Fault", "Bypass,LIP", "Bypass,DTMOUT", "Bypass,RX Loss",
"Bypass,Sync Loss", "Bypass,PTFI", "Manual Bypass,Redundant Port",
"Manual Bypass,Stall Threshold", "Manual Bypass,Word Error Burst",
"Manual Bypass,Word Error High", "Manual Bypass,Burst CRC",
"Manual Bypass,High CRC", "Manual Bypass,High Clock Delta",
"Manual Bypass,Mirror", "Manual Bypass,Host", "Manual Bypass,Trunked
Cable",
"Manual Bypass,TBD", "Loopback", "Manual Bypass,Ins_Osc",
"Manual Bypass,Burst LIP", "Manual Bypass,High LIP",
"Manual Bypass,Diag Transmit",
"Manual Bypass,Drive Bypass", "Manual Bypass,Drive Fault"} ]
uint16 StateOnLoopA;

[Override ( "StateOnLoopB" ), Description ("State of Disk on Loop B."),

ValueMap {"0", "1", "5", "9", "0x0411", "0x0414", "0x0415", "0x0417",
"0x0418", "0x0421", "0x0423", "0x0424", "0x0425", "0x0426", "0x0427",
"0x0428", "0x0432", "0x0433", "0x0434", "0x0435", "0x0436", "0x0437",
"0x0438", "0x0439", "0x043B", "0x043C", "0x043E", "0x043F", "0x0440",
"0x0441", "0x0442", "0x044F", "0x0450", "0x0451"},
Values {"Unknown", "Not Present", "OK", "Bypass, System Manager",
"Warning,High LIP", "Warning,Word Error Burst", "Warning,Word Error
High",
"Warning,High CRC", "Warning,High Clock Delta", "Bypass",

A.84 PAR_TPDDisk.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"Bypass,TX Fault", "Bypass,LIP", "Bypass,DTMOUT", "Bypass,RX Loss",

"Bypass,Sync Loss", "Bypass,PTFI", "Manual Bypass,Redundant Port",
"Manual Bypass,Stall Threshold", "Manual Bypass,Word Error Burst",
"Manual Bypass,Word Error High", "Manual Bypass,Burst CRC",
"Manual Bypass,High CRC", "Manual Bypass,High Clock Delta",
"Manual Bypass,Mirror", "Manual Bypass,Host", "Manual Bypass,Trunked
Cable",
"Manual Bypass,TBD", "Loopback", "Manual Bypass,Ins_Osc",
"Manual Bypass,Burst LIP", "Manual Bypass,High LIP",
"Manual Bypass,Diag Transmit",
"Manual Bypass,Drive Bypass", "Manual Bypass,Drive Fault"} ]
uint16 StateOnLoopB;

[Description ("If Drive is used for ESI Channel.") ]

boolean IsESI;

[Description ("ESI State of Disk."),

ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "Not Present", "OK", "Failed"} ]
uint16 ESIState;

[Description ("Overall state of the Loop A and B."),

ValueMap {"0", "2", "3", "6"},
Values {"Unknown", "OK", "Degraded", "Error"} ]
uint16 OverallLoopState;
};

// ==================================================================
// 3PAR DiskDrivePackage
// ==================================================================
[Description (
"3PAR Disk Drive Package for Vendor, Model, and Serial Number")]
class TPD_DiskDrivePackage : CIM_PhysicalPackage {
};

// ==================================================================
// 3PAR DiskDrive and DiskDrivePackage mapping
// ==================================================================
[Association,
Description (
"3PAR Data DiskDrivePackage and DiskDrive mapping")]
class TPD_DiskPackageRealizes : CIM_Realizes {

[Override ( "Antecedent" ), Description (

"The physical component that implements the Device.")]

PAR_TPDDisk.mof A.85
 CIM API Programming Reference InForm OS Version 2.3.1

TPD_DiskDrivePackage REF Antecedent;

[Override ( "Dependent" ), Description (

"The Disk Drive.")]
TPD_DiskDrive REF Dependent;
};

// ==================================================================
// 3PAR Disk StorageExtent
// ==================================================================
[Description (
"3PAR Disk Drive Storage Extent")]
class TPD_DiskStorageExtent : CIM_StorageExtent {
};

// ==================================================================
// 3PAR Disk StorageExtent
// ==================================================================
[Association,
Description (
"3PAR Disk Drive and Disk Storage Extent association")]
class TPD_DiskPresent : CIM_MediaPresent {
[Override ( "Antecedent" ), Description (
"The Disk Drive.")]
TPD_DiskDrive REF Antecedent;

[Override ( "Dependent" ), Description (

"The storage extent accessed using the Disk Drive.")]
TPD_DiskStorageExtent REF Dependent;
};

// ==================================================================
// 3PAR DiskDrive Software Identity
// ==================================================================
[Description (
"3PAR Disk Drive Software Identity")]
class TPD_DiskSoftwareIdentity : CIM_SoftwareIdentity {
[Description ("Status of the firmware on the disk drive."),
ValueMap {"0", "1", "2"},
Values {"Unknown", "Old", "Current"} ]
uint16 FirmwareStatus;
};

// ==================================================================
// 3PAR DiskDrive and DiskSoftwareIdentity association

A.86 PAR_TPDDisk.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// ==================================================================
[Association,
Description (
"3PAR Data DiskSoftwareIdentity and DiskDrive mapping")]
class TPD_DiskSoftware : CIM_ElementSoftwareIdentity {

[Override ( "Antecedent" ), Description (

"The software that is installed on the Disk Drive.")]
TPD_DiskSoftwareIdentity REF Antecedent;

[Override ( "Dependent" ), Description (

"The Disk Drive.")]
TPD_DiskDrive REF Dependent;
};

// ==================================================================
// TPD_DiskDrivePackage and TPD_Magazine association
// ==================================================================
[Association, Aggregation, Description (
"The MagazineContainer association represents the relationship between "
"a TPD_Magazine and TPD_DiskDrivePackage.")]
class TPD_MagazineContainer : CIM_Container {

[Aggregate, Override ( "GroupComponent" ), Max ( 1 ),

Description (
"The Magazine that contains DiskDrivePackage(s)")]
TPD_Magazine REF GroupComponent;

[Override ( "PartComponent" ), Description (

"The DiskDrivePackage which is contained in the Magazine.")]
TPD_DiskDrivePackage REF PartComponent;
};

// ==================================================================
// TPD_DiskDrive and TPD_StorageSystem association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"The SystemDisk association represents a relationship between "
"a TPD_DiskDrive and TPD_StorageSystem.")]
class TPD_SystemDisk : CIM_SystemDevice {

[Aggregate, Override ( "GroupComponent" ), Min ( 1 ), Max ( 1 ),

Description (
"The parent system in the Association.")]

PAR_TPDDisk.mof A.87
 CIM API Programming Reference InForm OS Version 2.3.1

TPD_StorageSystem REF GroupComponent;

[Override ( "PartComponent" ), Weak, Description (

"The DiskDrive that is a component of a StorageSystem.")]
TPD_DiskDrive REF PartComponent;
};

// ==================================================================
// StoragePoolComponent
// ==================================================================
[Association, Aggregation, Description (
"TPD_StoragePoolComponent is an association used to "
"establish 'part of' relationships between StoragePool and "
"Disk StorageExtent.")]
class TPD_StoragePoolComponent : CIM_ConcreteComponent {

[Aggregate, Override ( "GroupComponent" ), Description (

"The parent element in the association.")]
TPD_StoragePool REF GroupComponent;

[Override ( "PartComponent" ), Description (

"The child element in the association.")]
TPD_DiskStorageExtent REF PartComponent;
};

// ===================================================================
// SCSIInitiatorTargetLogicalUnitPath
// Comment this class out as it is still experimental
// ===================================================================

// [Association, Description (
// "An association that models a host driver path to a SCSI "
// "logical unit. Each permutation of initiator and target "
// "ProtocolEndpoints and logical units is considered a separate "
// "path. This class describes end-to-end path behavior such as "
// "properties and operations commonly used in multipath "
// "management.")]
//class TPD_SCSIInitTargetLUPath : CIM_SCSIInitiatorTargetLogicalUnitPath
//{
// [Override ("Initiator"), Description (
// "An initiator endpoint on a node that connects to the "
// "target endpoint on a cage.")]
// TPD_SCSIProtocolFCEndpoint REF Initiator;

// [Override ("Target"), Description (

A.88 PAR_TPDDisk.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// "The target endpoint residing on a cage that connects "

// "to the initiator endpoint on a node.")]
// TPD_SCSIProtocolFCALEndpoint REF Target;

// [Override ("LogicalUnit"), Description (

// "Storage extent of DiskDrive.")]
// TPD_DiskStorageExtent REF LogicalUnit;
//};

// ==================================================================
// TPD_DiskStorageExtent and TPD_StorageSystem association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"The SystemExtent association represents a relationship between "
"a TPD_DiskStorageExtent and TPD_StorageSystem.")]
class TPD_SystemExtent : CIM_SystemDevice {

[Aggregate, Override ( "GroupComponent" ), Min ( 1 ), Max ( 1 ),

Description (
"The parent system in the Association.")]
TPD_StorageSystem REF GroupComponent;

[Override ( "PartComponent" ), Weak, Description (

"The StorageExtent that is a component of a StorageSystem.")]
TPD_DiskStorageExtent REF PartComponent;
};

// ==================================================================
// TPD_DiskStorageExtent and TPD_StorageVolume association
// ==================================================================
[Association, Description (
"BasedOn is an association describing how StorageExtents can be "
"assembled from lower level Extents.")]
class TPD_VolumeBasedOnDiskExtent : CIM_BasedOn {

[Override ( "Antecedent" ), Description (

"The lower level StorageExtent.")]
TPD_DiskStorageExtent REF Antecedent;

[Override ( "Dependent" ), Description (

"The higher level StorageExtent.")]
TPD_StorageVolume REF Dependent;
};

PAR_TPDDisk.mof A.89
 CIM API Programming Reference InForm OS Version 2.3.1

A.5 3PAR_TPDNode.mof
This MOF contains 3PAR Node (MCS) classes that loaded into the root/tpd namespace.

//
//
//%////////////////////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////////////////////
//
// File : 3PAR_TPDNode.mof
//
// Purpose :
//
// Date created: 8/10/2005
//
///////////////////////////////////////////////////////////////////////////

// ==================================================================
// 3PAR NodeSystem
// ==================================================================
[Description (
"3PAR Controller Node ")]
class TPD_NodeSystem : CIM_ComputerSystem
{
[Description ("Position of the Node.") ]
uint16 Position;

[Description ("If this node is Master, set to TRUE.") ]

boolean IsMaster;

[Description ("If this node is Online, set to TRUE.") ]

boolean IsOnline;

[Description ("If this node is in Cluster, set to TRUE.") ]

boolean IsInCluster;

[Description ("Major part of kernel version.") ]

uint16 KernelMajor;

[Description ("Minor part of kernel version.") ]

uint16 KernelMinor;

A.90 3PAR_TPDNode.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Description ("Revision part of kernel version.") ]

uint16 KernelRevision;

[Description ("Build part of kernel version.") ]

uint16 KernelBuild;

[Description ("Kernel Version in String format.") ]

string KernelVersion;

[Description ("Major part of BIOS version.") ]

uint16 BiosMajor;

[Description ("Minor part of BIOS version.") ]

uint16 BiosMinor;

[Description ("Revision part of BIOS version.") ]

uint16 BiosRevision;

[Description ("Build part of BIOS version.") ]

uint16 BiosBuild;

[Description ("BIOS Version in String format.") ]

string BiosVersion;

[Description ("System LED status."),

ValueMap {"0", "1", "2", "3", "4"},
Values {"Off", "Amber", "Green", "Amber Blinking", "Green Blinking"} ]
uint16 SystemLED;

[Description ("Percentage of the node cache enabled.") ]

uint16 CacheEnabled;

[Description ("3PAR specific operational state for the disk"),

ValueMap {"0", "1", "2", "3", "4", "5", "6", "7"},
Values {"Unknown", "OK/Inited", "Error/Offline", "New",
"Defunct, mismatched kernel revisions",
"Defunct, node ide partition bad",
"Defunct, node is rebooting",
"Defunct, node is being shutdown"} ]
uint16 OtherOperationalStatus;
};

// ==================================================================
// 3PAR NodePackage
// ==================================================================

3PAR_TPDNode.mof A.91
 CIM API Programming Reference InForm OS Version 2.3.1

[Description (
"3PAR Controller Node Package for Vendor, Model, and Serial Number")]
class TPD_NodePackage : CIM_PhysicalPackage {
};

// ==================================================================
// 3PAR NodeSystem and NodePackage association
// ==================================================================
[Association,
Description (
"3PAR Data InServ NodeSystem and NodePackage Association.") ]
class TPD_NodeSystemPackage : CIM_ComputerSystemPackage
{
[Override ("Antecedent"),
Description ("The InServ's Node physical package.") ]
TPD_NodePackage REF Antecedent;

[Override ("Dependent"), Description (

"The InServ Node system.") ]
TPD_NodeSystem REF Dependent;
};

// ==================================================================
// 3PAR NodeRedundancySet
// ==================================================================
[Description (
"3PAR Controller Node redundancy set. It is associated with a max of "
"2 NodeSystem objects")]
class TPD_NodeRedundancySet : CIM_RedundancySet {
};

// ==================================================================
// 3PAR NodePairSystem
// ==================================================================
[Description (
"3PAR Controller Node Pair computer system. One for each of the "
"NodeRedundancySet object.")]
class TPD_NodePairSystem : CIM_ComputerSystem {
};

// ==================================================================
// 3PAR NodePairRedundancySet
// ==================================================================
[Description (
"3PAR Controller Node Pair redundancy set. This object is associated "

A.92 3PAR_TPDNode.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"to all the NodePairSystem objects.")]

class TPD_NodePairRedundancySet : CIM_RedundancySet {
};

// ==================================================================
// 3PAR NodeMemberOfSet
// ==================================================================
[Association, Aggregation, Description (
"TPD_NodeMemberOfSet is an aggregation used to establish "
"membership of TPD_NodeSystem in a TPD_NodeRedundancySet.")]
class TPD_NodeMemberOfSet : CIM_MemberOfCollection {

[Override ( "Collection" ), Description (

"The NodeRedundancySet that contains NodeSystems.")]
TPD_NodeRedundancySet REF Collection;

[Override ( "Member" ), Description (

"The NodeSystem that is contained in the NodeRedundancySet.")]
TPD_NodeSystem REF Member;
};

// ==================================================================
// 3PAR NodePairMemberOfSet
// ==================================================================
[Association, Aggregation, Description (
"TPD_NodePairMemberOfSet is an aggregation used to establish "
"membership of TPD_NodePairSystem in a TPD_NodePairRedundancySet.")]
class TPD_NodePairMemberOfSet : CIM_MemberOfCollection {

[Override ( "Collection" ), Description (

"The TPD_NodePairRedundancySet that contains TPD_NodePairSystem.")]
TPD_NodePairRedundancySet REF Collection;

[Override ( "Member" ), Description (

"The TPD_NodePairSystem that is contained "
"in the TPD_NodePairRedundancySet.")]
TPD_NodePairSystem REF Member;
};

// ==================================================================
// 3PAR NodeSetIdentity
// ==================================================================
[Association, Description (
"TPD_NodeSetIdentity associates two elements representing "
"different aspects of the same underlying entity: TPD_NodePairSystem"

3PAR_TPDNode.mof A.93
 CIM API Programming Reference InForm OS Version 2.3.1

" and TPD_NodeRedundancySet.")]

class TPD_NodeSetIdentity : CIM_ConcreteIdentity {

[Override ( "SystemElement" ), Description (

"NodePairSystem associated to the NodeRedundancySet")]
TPD_NodePairSystem REF SystemElement;

[Override ( "SameElement" ), Description (

"NodeRedundancySet for a NodePairSystem.")]
TPD_NodeRedundancySet REF SameElement;
};

// ==================================================================
// 3PAR NodePairSetIdentity
// ==================================================================
[Association, Description (
"TPD_NodePairSetIdentity associates two elements representing "
"different aspects of the same underlying entity: TPD_StorageSystem"
" and TPD_NodePairRedundancySet.")]
class TPD_NodePairSetIdentity : CIM_ConcreteIdentity {

[Override ( "SystemElement" ), Description (

"StorageSystem associated to the NodePairRedundancySet")]
TPD_StorageSystem REF SystemElement;

[Override ( "SameElement" ), Description (

"NodePairRedundancySet for a StorageSystem.")]
TPD_NodePairRedundancySet REF SameElement;
};

// ===================================================================
// NodePairComponentCS
// ===================================================================
[Association, Aggregation, Composition,
Description (
"A ComputerSystem can aggregate another ComputerSystem. This"
"class groups together TPD_StorageSystem and TPD_NodePairSystem.")]
class TPD_NodePairComponentCS : CIM_ComponentCS {

[Aggregate, Override ( "GroupComponent" ), Description (

"The ComputerSystem that contains and/or aggregates other "
"Systems.")]
TPD_StorageSystem REF GroupComponent;

[Override ( "PartComponent" ), Description (

A.94 3PAR_TPDNode.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"The contained (Sub)ComputerSystem.")]

TPD_NodePairSystem REF PartComponent;
};

// ===================================================================
// NodeComponentCS
// ===================================================================
[Association, Aggregation, Composition,
Description (
"A ComputerSystem can aggregate another ComputerSystem. This"
"class groups together TPD_StorageSystem and TPD_NodeSystem.")]
class TPD_NodeComponentCS : CIM_ComponentCS {

[Aggregate, Override ( "GroupComponent" ), Description (

"The ComputerSystem that contains and/or aggregates other "
"Systems.")]
TPD_StorageSystem REF GroupComponent;

[Override ( "PartComponent" ), Description (

"The contained (Sub)ComputerSystem.")]
TPD_NodeSystem REF PartComponent;
};

// =================================================================
// Node CPU
// =================================================================
class TPD_NodeCPU : CIM_Processor
{
[Description ("Position of the CPU in the node.") ]
uint16 Position;

[Description ("Bus speed in Mhz * 100") ]

uint32 BusSpeed;

[Description ("Vendor name of the CPU.") ]

string Manufacturer;

[Description ("Model type for CPU.") ]

string Model;

[Description ("Serial number of the CPU.") ]

string SerialNumber;
};

// ==================================================================

3PAR_TPDNode.mof A.95
 CIM API Programming Reference InForm OS Version 2.3.1

// ProcessorForNode
// ==================================================================
[Association, Aggregation, Composition,
Description (
"NodeCPU aggregated by a NodeSystem.")]
class TPD_ProcessorForNode : CIM_SystemDevice {

[Aggregate, Override ( "GroupComponent" ), Min ( 1 ), Max ( 1 ),

Description (
"The parent Node in the Association.")]
TPD_NodeSystem REF GroupComponent;

[Override ( "PartComponent" ), Weak, Description (

"The NodeCPU that is a component of a Node.")]
TPD_NodeCPU REF PartComponent;
};

// ==================================================================
// TPD Physical Memory (DIMM)
// ==================================================================
[Description (
"3PAR DIMM in Controller Node.")]
class TPD_PhysicalMemory : CIM_PhysicalMemory
{
[Description ("Slot number, memory is inserted in.") ]
uint16 Slot;

[Description ("Slot ID, memory is inserted in.") ]

string SlotID;

[Description ("Type of the cache memory is used for."),

ValueMap {"0", "1"},
Values {"Control (CPU)", "Data (Cluster)"} ]
uint16 CacheType;

[Description ("Single or double sided. Not supported yet."),

ValueMap {"0"},
Values {"Unknown"} ]
uint16 SideType;

[Description ("Standard or stacked chips. Not supported yet."),

ValueMap {"0"},
Values {"Unknown"} ]
uint16 ChipsType;

A.96 3PAR_TPDNode.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Description ("CAS latency. Format: CL<min>/<max>, in nS.") ]

string CASLatency;

[Description ("JEDEC ID.") ]

string JedecID;

[Description ("Revision code.") ]

string Revision;
};

3PAR_TPDNode.mof A.97
 CIM API Programming Reference InForm OS Version 2.3.1

// ==================================================================
// TPD NodePackagedMemory
// ==================================================================
[Association, Aggregation, Description (
"A Physical Memory contained by a Node PhysicalPackage.")]
class TPD_NodePackagedMemory : CIM_PackagedComponent {

[Aggregate, Override ( "GroupComponent" ), Max ( 1 ),

Description (
"The NodePackage that contains PhysicalMemory(s).")]
TPD_NodePackage REF GroupComponent;

[Override ( "PartComponent" ), Description (

"The PhysicalMemory which is contained in the NodePackage.")]
TPD_PhysicalMemory REF PartComponent;
};

// ==================================================================
// TPD IDE Drive
// ==================================================================
[Description (
"3PAR IDE Drive in Controller Node.")]
class TPD_IDEDrive : CIM_PhysicalComponent
{
[Description ("Position of the IDE Drive in the Node.") ]
uint16 Position;

[Description ("Firmware Revision code.") ]

string FirmwareVersion;

[Description ("Max Logical Block Address.") ]

uint64 MaxLBA;

[Description ("Capacity of the drive in bytes.") ]

uint64 Capacity;
};

// ==================================================================
// TPD NodePackagedIDE
// ==================================================================
[Association, Aggregation, Description (
"An IDE Drive contained by a Node PhysicalPackage.")]
class TPD_NodePackagedIDE : CIM_PackagedComponent {

[Aggregate, Override ( "GroupComponent" ), Max ( 1 ),

A.98 3PAR_TPDNode.mof
InForm OS Version 2.3.1 CIM API Programming Reference

Description (
"The NodePackage that contains IDE Drive(s).")]
TPD_NodePackage REF GroupComponent;

[Override ( "PartComponent" ), Description (

"The IDE Drive which is contained in the NodePackage.")]
TPD_IDEDrive REF PartComponent;
};

// ==================================================================
// TPD PCI Card
// ==================================================================
[Description (
"3PAR PCI Card.")]
class TPD_PCICard : CIM_Card
{
[Description ("Node slot the card is in.") ]
uint16 Slot;

[Description ("Firmware version on the PCI Card.") ]

string FirmwareVersion;

[Description ("Revision code.") ]

String Revision;

[Description ("Type of the PCI Card."),

ValueMap {"0", "1", "2", "3"},
Values {"Unknown", "FC", "Ethernet", "iSCSI"} ]
uint16 Type;
};

// ==================================================================
// 3PAR Node Package and PCI Card association
// ==================================================================
[Association, Aggregation,
Description (
"3PAR Node Package and PCI Card association")]
class TPD_PCICardInNode : CIM_Container {

[Aggregate, Override ( "GroupComponent" ), Max ( 1 ),

Description (
"The Node Package that contains PCI cards")]
TPD_NodePackage REF GroupComponent;

[Override ( "PartComponent" ), Description (

3PAR_TPDNode.mof A.99
 CIM API Programming Reference InForm OS Version 2.3.1

"The PCI card that is contained in the Node Package.")]

TPD_PCICard REF PartComponent;
};

// ==================================================================
// 3PAR SystemEndpoint: association between NodeSystem and
// SCSIProtocolEndpoint
// ==================================================================
[Association,
Description
("3PAR Data InServ NodeSystem and SCSIProtocolEndpoint association."
"This is a subclass of CIM_HostedAccessPoint. There are many "
"subclasses of CIM_HostedAcessPoint in the system. This class is "
" named TPD_SystemEndpoint to distinguish with other subclasses. ")]
class TPD_SystemEndpoint : CIM_HostedAccessPoint
{
// Indicate that this is one-to-many association
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The InServ node controller that hosted the protocol endpoint.")]
TPD_NodeSystem REF Antecedent;

[Override ( "Dependent" ), Weak, Description (

"The SCSIProtocolEndpoint representing front end port "
"on the system.")]
TPD_SCSIProtocolFCEndpoint REF Dependent;
// CIM_SCSIProtocolEndpoint REF Dependent; -- reenable this line if we
support TPD_SCSIInitTargetLUPath
};

// ==================================================================
// 3PAR NodeSystem and FCPort association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"3PAR Data InServ Node System and FC Port Association ") ]
class TPD_SystemFCPort : CIM_SystemDevice
{
[Override ("GroupComponent"), Aggregate, Max (1), Min (1),
Description("The InServ node controller that hosted the FC port.")]
TPD_NodeSystem REF GroupComponent;

[Override ("PartComponent"), Weak, Description (

"The front end FCPort port.") ]
TPD_FCPort REF PartComponent;

A.100 3PAR_TPDNode.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// CIM_FCPort REF Dependent; -- reenable this line if we support

TPD_SCSIInitTargetLUPath
};

// ==================================================================
// 3PAR Storage System and SCSI Controller association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"3PAR Data InServ Node System and SCSI Controller Association ") ]
class TPD_SystemController : CIM_SystemDevice
{
[Override ("GroupComponent"), Aggregate, Max (1), Min (1),
Description("The InServ node controller that associates with "
"the SCSI Protocol controller.")]
TPD_NodeSystem REF GroupComponent;

[Override ("PartComponent"), Weak, Description (

"The SCSI controller on the node system.") ]
TPD_SCSIController REF PartComponent;
};

A.6 3PAR_TPDEnv.mof
This MOF contains 3PAR Environment classes that loaded into the root/tpd namespace.

// ==================================================================
// TPD Power Supply
// ==================================================================
[Description (
"Capabilities and management of the 3PAR PowerSupply.")]
class TPD_PowerSupply : CIM_PowerSupply
{
[Description ("Manufacturer name of the PS.") ]
string Manufacturer;

[Description ("Model type for PS.") ]

string Model;

[Description ("Serial number of the PS.") ]

string SerialNumber;

3PAR_TPDEnv.mof A.101
 CIM API Programming Reference InForm OS Version 2.3.1

[Description ("Position of the PS.") ]

uint16 Position;

[Description ("State of the AC for the power supply."),

ValueMap {"0", "1", "2"},
Values {"Unknown", "OK", "Error"} ]
uint16 ACStatus[];

[Description ("3PAR specific operational state for the PS"),

ValueMap {"0", "1", "2", "4", "5", "6", "7" },
Values {"Unknown", "OK", "Error", "Filler",
"Degraded", "Communication Error", "Not Available"} ]
uint16 OtherOperationalStatus;
};

// ==================================================================
// TPD Cage Power Supply
// ==================================================================
[Description (
"Capabilities and management of the 3PAR Node PowerSupply.")]
class TPD_CagePowerSupply : TPD_PowerSupply
{
[Description ("Type of the cage this Power Supply is in."),
ValueMap {"0", "1", "2", "3", "4"},
Values {"Unknown", "DC0", "DC1", "DC2", "DC3"} ]
uint16 CageType;

[Description ("If TRUE, user can not modify model.") ]

boolean ModelReadOnly;
};

// ==================================================================
// TPD Node Power Supply
// ==================================================================
[Description (
"Capabilities and management of the 3PAR Node PowerSupply.")]
class TPD_NodePowerSupply : TPD_PowerSupply
{
[Description ("State of the DC for the power supply."),
ValueMap {"0", "1", "2"},
Values {"Unknown", "OK", "Error"} ]
uint16 DCStatus[];
};

// ==================================================================

A.102 3PAR_TPDEnv.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// CagePSDependency
// ==================================================================
[Association, Description (
"A PowerSupply is installed in a DriveCage, not for a specific Device,
but "
"to function with the DriveCage in general. This relationship is "
"described by the TPD_CagePSDependency association.")]
class TPD_CagePSDependency : CIM_PackageDependency {

[Override ( "Antecedent" ), Description (

"The PowerSupply for the DriveCage.")]
TPD_PowerSupply REF Antecedent;

[Override ( "Dependent" ), Description (

"The DriveCage whose environment is affected.")]
TPD_DriveCage REF Dependent;
};

// ==================================================================
// TPD Fan
// Based on the CIM schema, we need to use CIM_NumericSensor (Tachometer)
// to show the current speed of the fan. This is way too much for what
// we need, so I am going to add a new variable for speed. If
// we ever need to comply with the requirements, I will change it.
// ==================================================================
[Description (
"3PAR Fan ")]
class TPD_Fan : CIM_Fan
{
[Description ("Position of the Fan.") ]
uint16 Position;

[Description ("Fan speed."),

ValueMap {"0", "1", "2", "3", "4"},
Values {"Unknown", "Hi", "Low", "Medium", "Stopped"} ]
uint16 Speed;

[Description ("3PAR specific operational state for the Fan"),

ValueMap {"0", "1", "2", "4", "5", "6", "7" },
Values {"Unknown", "OK", "Error", "Critical", "Non Critical",
"Not Installed", "Not Available"} ]
uint16 OtherOperationalStatus;

[Description ("Fan LED status. This is ONLY available for system fans."),
ValueMap {"0", "1", "2", "3", "4"},

3PAR_TPDEnv.mof A.103
 CIM API Programming Reference InForm OS Version 2.3.1

Values {"Off", "Amber", "Green", "Amber Blinking", "Green Blinking"} ]

uint16 SystemFanLED;
};

// ===================================================================
// PowerSupply Cooling
// ===================================================================
[Association, Description (
"Many Devices, such as processors or power supplies, require "
"their own cooling devices. This association indicates where "
"fans or other CoolingDevices are specific to a Device, versus "
"providing enclosure or cabinet cooling.")]
class TPD_PowerSupplyCooling : CIM_AssociatedCooling {

[Override ( "Antecedent" ), Description (

"The Fan.")]
TPD_Fan REF Antecedent;

[Override ( "Dependent" ), Description (

"The PowerSupply being cooled.")]
TPD_PowerSupply REF Dependent;
};

// ===================================================================
// Node Cooling
// ===================================================================
[Association, Description (
"Describes association between SystemFan and "
"the Node Package it is cooling.")]
class TPD_NodePkgCooling : CIM_PackageDependency {

[Override ( "Antecedent" ), Description (

"The System Fan.")]
TPD_Fan REF Antecedent;

[Override ( "Dependent" ), Description (

"The Node being cooled.")]
TPD_NodePackage REF Dependent;
};

// ==================================================================
// TPD Battery
// ==================================================================
[Description (
"3PAR Battery connected to the PowerSupply in Node.")]

A.104 3PAR_TPDEnv.mof
InForm OS Version 2.3.1 CIM API Programming Reference

class TPD_Battery : CIM_Battery

{
[Description ("Position of the Battery.") ]
uint16 Position;

[Description ("Maximum battery life in minutes.") ]

uint32 MaxLife;

[Description ("If TRUE, MAX life is low and battery is failed.") ]

boolean MaxLifeLow;

[Description ("Manufacturing date of the Battery.") ]

datetime ManufacturingDate;

[Description ("Expiration date of the Battery.") ]

datetime ExpirationDate;

[Description ("Charge start date of the Battery.") ]

datetime ChargeStartDate;

[Description ("Vendor name of the Battery.") ]

string Manufacturer;

[Description ("Model type for Battery.") ]

string Model;

[Description ("Serial number of the Battery.") ]

string SerialNumber;

[Description ("TRUE if the test is running.") ]

boolean TestInProgress;

[Description ("3PAR specific operational state for the Battery"),

ValueMap {"0", "1", "2"},
Values {"Unknown", "OK", "Error"} ]
uint16 OtherOperationalStatus;

// ===================================================================
// The next 3 attributes describe log data for tests. Each index in the
// arrays represents single test log. All 3 attributes must be of the
// same length.
// ===================================================================
[Description ("The date the test has started."), ArrayType ( "Indexed" ),
ModelCorrespondence {"TPD_Battery.TestDuration",
"TPD_Battery.TestPassed"}]

3PAR_TPDEnv.mof A.105
 CIM API Programming Reference InForm OS Version 2.3.1

datetime TestStartDate[];

[Description ("The duration of the test in seconds."), ArrayType ( "Indexed"

),
ModelCorrespondence {"TPD_Battery.TestStartDate",
"TPD_Battery.TestPassed"} ]
uint16 TestDuration[];

[Description ("TRUE if the test passed, FALSE otherwise."), ArrayType (

"Indexed" ),
ModelCorrespondence {"TPD_Battery.TestStartDate",
"TPD_Battery.TestDuration"} ]
boolean TestPassed[];

// =========================================
// Operations
// =========================================
[Description (
"Resets the test log of the battery."
"The method should return 0 if successful, 1 if the request is not "
"supported, and some other value if any other error occurred. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 ResetLog(
);

[Description (
"Recharges battery."
"The method should return 0 if successful, 1 if the request is not "
"supported, and some other value if any other error occurred. "),
ValueMap {"0", "1", "2"},
Values {"OK", "Not Supported", "Error"} ]
uint32 Recharge(
);
};

// ===================================================================
// TPD_PowerSupplyBattery
// ===================================================================
[Association, Description (
"A Node PowerSupply may use or require one or more Batteries. This "
"relationship is described by the PowerSupplyBattery dependency.")]
class TPD_PowerSupplyBattery : CIM_AssociatedBattery
{
[Override ( "Antecedent" ), Description (

A.106 3PAR_TPDEnv.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"The Battery.")]
TPD_Battery REF Antecedent;

[Override ( "Dependent" ), Description (

"The Node PowerSupply needing or associated with the Battery.")]
TPD_PowerSupply REF Dependent;
};

// ==================================================================
// NodePkgPSDependency
// ==================================================================
[Association, Description (
"A PowerSupply is installed in a NodePackage, not for a specific "
"Device, but to function with the NodePackage in general. This "
"relationship is described by the TPD_NodePkgPSDependency "
"association.")]
class TPD_NodePkgPSDependency : CIM_PackageDependency {

[Override ( "Antecedent" ), Description (

"The PowerSupply for the NodePackage.")]
TPD_PowerSupply REF Antecedent;

[Override ( "Dependent" ), Description (

"The NodePackage whose environment is affected.")]
TPD_NodePackage REF Dependent;
};

// ==================================================================
// TPD_Battery and TPD_NodeSystem association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"The NodeBattery association represents a relationship between "
"a TPD_Battery and TPD_NodeSystem.")]
class TPD_NodeBattery : CIM_SystemDevice {

[Aggregate, Override ( "GroupComponent" ), Min ( 1 ), Max ( 1 ),

Description (
"The parent system in the Association.")]
TPD_NodeSystem REF GroupComponent;

[Override ( "PartComponent" ), Weak, Description (

"The Battery that is a component of a NodeSystem.")]
TPD_Battery REF PartComponent;
};

3PAR_TPDEnv.mof A.107
 CIM API Programming Reference InForm OS Version 2.3.1

// ==================================================================
// TPD_PowerSupply and CIM_ComputerSystem association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"The SystemPowerSupply association represents a relationship between "
"a TPD_PowerSupply and CIM_ComputerSystem (TPD_NodeSystem or "
"TPD_StorageSystem).")]
class TPD_SystemPowerSupply : CIM_SystemDevice {

[Aggregate, Override ( "GroupComponent" ), Min ( 1 ), Max ( 1 ),

Description (
"The parent system in the Association. Could be either "
"StorageSystem or NodeSystem.")]
CIM_ComputerSystem REF GroupComponent;

[Override ( "PartComponent" ), Weak, Description (

"The PowerSupply that is a component of a ComputerSystem.")]
TPD_PowerSupply REF PartComponent;
};

// ==================================================================
// TPD_Fan and CIM_ComputerSystem association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"The SystemPowerSupply association represents a relationship between "
"a TPD_Fan and CIM_ComputerSystem (TPD_NodeSystem or "
"TPD_StorageSystem).")]
class TPD_SystemFan : CIM_SystemDevice {

[Aggregate, Override ( "GroupComponent" ), Min ( 1 ), Max ( 1 ),

Description (
"The parent system in the Association. Could be either "
"StorageSystem or NodeSystem.")]
CIM_ComputerSystem REF GroupComponent;

[Override ( "PartComponent" ), Weak, Description (

"The Fan that is a component of a ComputerSystem.")]
TPD_Fan REF PartComponent;
};

A.108 3PAR_TPDEnv.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// ==================================================================
// TPD Cage PowerSupply Sensor
// ==================================================================
[Association, Description (
"Many Devices include Sensors or have Sensors installed nearby, "
"in order to measure critical input and output properties. This "
"association indicates that relationship.")]
class TPD_SensorInCagePS : CIM_AssociatedSensor {

[Override ( "Antecedent" ), Description (

"The Sensor.")]
TPD_CageSensor REF Antecedent;

[Override ( "Dependent" ), Description (

"The LogicalDevice for which information is measured by the "
"Sensor.")]
TPD_CagePowerSupply REF Dependent;
};

A.7 3PAR_TPDLocation.mof
This MOF contains 3PAR Location classes that loaded into the root/tpd namespace.

// ==================================================================
// TPD System location
// ==================================================================
[Description (
"Location of the InServ array.")]
class TPD_SystemLocation : CIM_Location
{
};

// ==================================================================
// TPD System Package and Location association
// ==================================================================
[Association, Description (
"SystemPackageLocation associates a SystemPackage with a "
"Location object for inventory or replacement purposes.")]
class TPD_SystemPackageLocation : CIM_PhysicalElementLocation {

[Override ( "Element" ), Description (

3PAR_TPDLocation.mof A.109
 CIM API Programming Reference InForm OS Version 2.3.1

"The PhysicalElement whose Location is specified.")]

TPD_SystemPackage REF Element;

[Override ( "PhysicalLocation" ), Max ( 1 ), Description (

"The PhysicalElement's Location.")]
TPD_SystemLocation REF PhysicalLocation;
};

A.8 3PAR_TPDEthPort.mof
This MOF contains 3PAR Ethernet Port classes that loaded into the root/tpd namespace.

// ===================================================================
// 3PAR EthernetPort
// ===================================================================
[Description (
"Capabilities and management of an EthernetPort.")]
class TPD_EthernetPort : CIM_EthernetPort {

[Description ("TPD specific operational status"),

ValueMap {"3", "4", "9"},
Values {"ready", "loss sync", "offline"} ]
uint16 OtherOperationalStatus;
};

// ==================================================================
// 3PAR IPProtocolEndpoint
// ==================================================================
[Description (
"A ProtocolEndpoint that is dedicated to running IP.")]
class TPD_IPProtocolEndpoint : CIM_IPProtocolEndpoint {

[Description (
"The Gateway address for this ProtocolEndpoint.")]
string Gateway;
};

// ===================================================================
// 3PAR EthPortSAPImplementation
// ===================================================================
[Association, Description (
"An association between a ServiceAccessPoint and how it is "

A.110 3PAR_TPDEthPort.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"implemented.")]
class TPD_EthPortSAPImplementation : CIM_DeviceSAPImplementation {

[Override ( "Antecedent" ), Description (

"The Ethernet Port.")]
TPD_EthernetPort REF Antecedent;

[Override ( "Dependent" ), Description (

"The IP Protocol Endpoint implemented using the Ethernet Port.")]
TPD_IPProtocolEndpoint REF Dependent;
};

// ==================================================================
// 3PAR SystemIPEndpoint: association between NodeSystem and
// IPProtocolEndpoint
// ==================================================================
[Association,
Description
("3PAR Data InServ NodeSystem and IPProtocolEndpoint association."
"This is a subclass of CIM_HostedAccessPoint. There are many "
"subclasses of CIM_HostedAcessPoint in the system. This class is "
" named TPD_SystemIPEndpoint to distinguish with other subclasses. ")]
class TPD_SystemIPEndpoint : CIM_HostedAccessPoint
{
// Indicate that this is one-to-many association
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The InServ node controller that hosted the protocol endpoint.")]
TPD_NodeSystem REF Antecedent;

[Override ( "Dependent" ), Weak, Description (

"The IPProtocolEndpoint representing ethernet port "
"on the system.")]
TPD_IPProtocolEndpoint REF Dependent;
};

// ==================================================================
// 3PAR NodeSystem and EthernetPort association
// ==================================================================
[Association, Aggregation, Composition,
Description (
"3PAR Data InServ Storage System and Ethernet Port Association ") ]
class TPD_SystemEthPort : CIM_SystemDevice
{
[Override ("GroupComponent"), Aggregate, Max (1), Min (1),
Description("The InServ node controller that hosted the Ethernet port.")]

3PAR_TPDEthPort.mof A.111
 CIM API Programming Reference InForm OS Version 2.3.1

TPD_NodeSystem REF GroupComponent;

[Override ("PartComponent"), Weak, Description (

"The Ethernet Port.") ]
TPD_EthernetPort REF PartComponent;
};

// ==================================================================
// 3PAR TCPProtocolEndpoint
// ==================================================================
[Description (
"A TPD protocol endpoint that is dedicated to running TCP.")]
class TPD_TCPProtocolEndpoint : CIM_TCPProtocolEndpoint {

};

// ==================================================================
// 3PAR BindsToIPEndpoint
// ==================================================================
[Association, Description (
"This association makes explicit the dependency of a "
"TCPProtocolEndpoint on an underlying IPProtocolEndpoint, on the same "
"system.")]
class TPD_BindsToIPEndpoint : CIM_BindsTo {

[Override ( "Antecedent" ), Description (

"The underlying IPProtocolEndpoint, which is depended upon.")]
TPD_IPProtocolEndpoint REF Antecedent;

[Override ( "Dependent" ), Description (

"The TCPProtocolEndpoint dependent on the IPProtocolEndpoint.")]
TPD_TCPProtocolEndpoint REF Dependent;
};

// ==================================================================
// 3PAR SystemTCPEndpoint: association between NodeSystem and
// TCPProtocolEndpoint
// ==================================================================
[Association,
Description
("3PAR Data InServ NodeSystem and IPProtocolEndpoint association."
"This is a subclass of CIM_HostedAccessPoint. There are many "
"subclasses of CIM_HostedAcessPoint in the system. This class is "
" named TPD_SystemIPEndpoint to distinguish with other subclasses. ")]
class TPD_SystemTCPEndpoint : CIM_HostedAccessPoint

A.112 3PAR_TPDEthPort.mof
InForm OS Version 2.3.1 CIM API Programming Reference

{
// Indicate that this is one-to-many association
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The InServ node controller that hosted the protocol endpoint.")]
TPD_NodeSystem REF Antecedent;

[Override ( "Dependent" ), Weak, Description (

"The TCPProtocolEndpoint representing ethernet port "
"on the system.")]
TPD_TCPProtocolEndpoint REF Dependent;
};

A.9 3PAR_TPDiSCSI.mof
This MOF contains 3PAR iSCSI classes that loaded into the root/tpd namespace.

// ==================================================================
// 3PAR iSCSIController
// ==================================================================
[Description (
"iSCSIController is a type of SCSIProtocolController, "
"managing an iSCSI interface.")]
class TPD_iSCSIController : CIM_SCSIProtocolController {

};

// ==================================================================
// 3PAR iSCSIProtocolEndpoint
// ==================================================================
class TPD_iSCSIProtocolEndpoint : CIM_iSCSIProtocolEndpoint {

};

// ==================================================================
// 3PAR BindsToTCPEndpoint
// ==================================================================
[Association, Description (
"This association makes explicit the dependency of a "
"iSCSIProtocolEndpoint on an underlying TCPProtocolEndpoint, on the same "
"system.")]
class TPD_BindsToTCPEndpoint : CIM_BindsTo {

3PAR_TPDiSCSI.mof A.113
 CIM API Programming Reference InForm OS Version 2.3.1

[Override ( "Antecedent" ), Description (

"The underlying TCPProtocolEndpoint, which is depended upon.")]
TPD_TCPProtocolEndpoint REF Antecedent;

[Override ( "Dependent" ), Description (

"The iSCSIProtocolEndpoint dependent on the TCPProtocolEndpoint.")]
TPD_iSCSIProtocolEndpoint REF Dependent;
};

// ==================================================================
// 3PAR SystemiSCSIEndpoint: association between NodeSystem and
// iSCSIProtocolEndpoint
// ==================================================================
[Association, Description (
"3PAR Data InServ NodeSystem and IPProtocolEndpoint association."
"This is a subclass of CIM_HostedAccessPoint. There are many "
"subclasses of CIM_HostedAcessPoint in the system. This class is "
" named TPD_SystemIPEndpoint to distinguish with other subclasses. ")]
class TPD_SystemiSCSIEndpoint : CIM_HostedAccessPoint
{
// Indicate that this is one-to-many association
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The InServ node controller that hosted the protocol endpoint.")]
TPD_NodeSystem REF Antecedent;

[Override ( "Dependent" ), Weak, Description (

"The iSCSIProtocolEndpoint representing ethernet port "
"on the system.")]
TPD_iSCSIProtocolEndpoint REF Dependent;
};

// ===================================================================
// 3PAR iSCSISAPImplementation
// ===================================================================
[Association, Description (
"An association between a ServiceAccessPoint and how it is "
"implemented.")]
class TPD_iSCSISAPImplementation : CIM_DeviceSAPImplementation {

[Override ( "Antecedent" ), Description (

"The Ethernet Port.")]
TPD_EthernetPort REF Antecedent;

[Override ( "Dependent" ), Description (

"The iSCSI Protocol Endpoint implemented using the Ethernet Port.")]

A.114 3PAR_TPDiSCSI.mof
InForm OS Version 2.3.1 CIM API Programming Reference

TPD_iSCSIProtocolEndpoint REF Dependent;

};

// ==================================================================
// 3PAR PrivilegeForiSCSIController
// ==================================================================
[Association, Description (
"PrivilegeForiSCSIController is an association used to tie the "
"AuthorizedPrivileges to iSCSIController resources.")]
class TPD_PrivilegeForiSCSIController : CIM_AuthorizedTarget {

[Override ( "Privilege" ), Description (

"The AuthorizedPrivilege affecting the iSCSIProtocolController "
"resource.")]
TPD_AuthorizedPrivilege REF Privilege;

[Override ( "TargetElement" ), Description (

"The iSCSIProtocolController resources to which the "
"AuthorizedPrivilege applies.")]
TPD_iSCSIController REF TargetElement;
};

// ==================================================================
// 3PAR ConfigServicesForiSCSIController Association
// ==================================================================
[Association,
Description (
"TPD_ConfigServicesForiSCSIController is an association between "
"TPD_iSCSIController and ControllerConfigurationService.") ]
class TPD_ConfigServicesForiSCSIController : CIM_ConcreteDependency
{
[Override ( "Antecedent" ), Description (
"The controller configuration service which the protocol "
"controller depends on for configuration.")]
TPD_ControllerConfigurationService REF Antecedent;

[Override ( "Dependent" ), Description (

"The iSCSI protocol controller which uses the controller "
"configuration service.")]
TPD_iSCSIController REF Dependent;
};

3PAR_TPDiSCSI.mof A.115
 CIM API Programming Reference InForm OS Version 2.3.1

// ==================================================================
// 3PAR iSCSI Protocol Controller And StorageVolume association
// ==================================================================
[Association,
Description (
"3PAR Data InServ iSCSI protocol controller and storage volume "
"association. ")]
class TPD_iSCSIControllerForUnit : CIM_ProtocolControllerForUnit
{
[Override ("Antecedent"),
Description ("The iSCSI Protocol Controller.") ]
TPD_iSCSIController REF Antecedent;

[Override ("Dependent"), Weak, Description (

"The storage volume controlled by the iSCSI protocol controller.") ]
TPD_StorageVolume REF Dependent;
};

// ==================================================================
// 3PAR iSCSISessionSettings
// ==================================================================
[Description (
"The default negotiation settings for an iSCSI Session. These "
"properties are used as the starting position for login "
"negotiations between initiator and target nodes. The "
"properties describing the resulting outcome of the login "
"negotiation are in the iSCSISession class.")]
class TPD_iSCSISessionSettings : CIM_iSCSISessionSettings {

};

// ==================================================================
// 3PAR iSCSISessionSystemSetting
// ==================================================================
[Association, Description (
"ElementSettingData represents the association between "
"ManagedElements and applicable setting data. This association "
"also describes whether this is a default or current setting.")]
class TPD_iSCSISessionSystemSetting : CIM_ElementSettingData {

[Override ( "ManagedElement" ), Description (

"The managed element.")]
TPD_StorageSystem REF ManagedElement;

A.116 3PAR_TPDiSCSI.mof
InForm OS Version 2.3.1 CIM API Programming Reference

[Override ( "SettingData" ), Description (

"The SettingData object associated with the element.")]
TPD_iSCSISessionSettings REF SettingData;
};

// ==================================================================
// 3PAR iSCSIConnectionSettings
// ==================================================================
[Description (
"The settings for the usage of an iSCSI NetworkPortal by an "
"iSCSIProtcolEndpoint. These settings are the starting point "
"for negotiation for connection establishment. "
"The properties that reflect the actual outcome "
"of the negotiation are found in the iSCSIConnection class.")]
class TPD_iSCSIConnectionSettings : CIM_iSCSIConnectionSettings {

};

// ==================================================================
// 3PAR iSCSIConnectionTCPSetting
// ==================================================================
[Association, Description (
"ElementSettingData represents the association between "
"ManagedElements and applicable setting data. This association "
"also describes whether this is a default or current setting.")]
class TPD_iSCSIConnectionTCPSetting : CIM_ElementSettingData {

[Override ( "ManagedElement" ), Description (

"The managed element.")]
TPD_TCPProtocolEndpoint REF ManagedElement;

[Override ( "SettingData" ), Description (

"The SettingData object associated with the element.")]
TPD_iSCSIConnectionSettings REF SettingData;
};

// ==================================================================
// 3PAR iSCSISession
// ==================================================================
[Description (
"iSCSISession is a network pipe between an initiator and target "
"SCSIProtocolEndpoints. An iSCSISession is composed of one or "
"more TCP connections which MUST be selected from a "
"SystemSpecificCollection representing an iSCSI Portal Group. "
"NetworkPipeComposition aggregates NetworkPipe instances "

3PAR_TPDiSCSI.mof A.117
 CIM API Programming Reference InForm OS Version 2.3.1

"representing iSCSI connections, which are associated to "

"TCPProtocolEndpoints. Only an iSCSI initiator can create an "
"iSCSI Session, an iSCSI Target MUST accept (or reject) a "
"session request. EndOfNetworkPipe associates iSCSISession with "
"SCSIProtocolEndpoint.")]
class TPD_iSCSISession : CIM_iSCSISession {

};

// ==================================================================
// 3PAR EndpointOfiSCSISession
// ==================================================================
[Association, Description (
"EndpointOfNetworkPipe describes the endpoints between which a "
"pipe transfers information. Whether an endpoint is a source or "
"sink is indicated by a property of the association, "
"SourceOrSink.")]
class TPD_EndpointOfiSCSISession : CIM_EndpointOfNetworkPipe {

[Override ( "Antecedent" ), Min ( 2 ), Max ( 2 ), Description (

"One of the endpoints of the pipe.")]
TPD_iSCSIProtocolEndpoint REF Antecedent;

[Override ( "Dependent" ), Description (

"The pipe which is dependent on the endpoints as the source "
"or sink of the transferred information.")]
TPD_iSCSISession REF Dependent;
};
/*
// ==================================================================
// 3PAR iSCSIConnection
// ==================================================================
[Description (
"This class contains the attributes of and negotiated values "
"for, an iSCSI Connection which is modeled as a subclass of "
"NetworkPipe. The original settings that are a starting point "
"for negotiation are found in the class "
"iSCSIConnectionSettings.")]
class TPD_iSCSIConnection : CIM_iSCSIConnection {

};
// ==================================================================
// 3PAR EndpointOfiSCSIConnection
// ==================================================================
[Association, Description (

A.118 3PAR_TPDiSCSI.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"EndpointOfNetworkPipe describes the endpoints between which a "

"pipe transfers information. Whether an endpoint is a source or "
"sink is indicated by a property of the association, "
"SourceOrSink.")]
class CIM_EndpointOfiSCSIConnection : CIM_EndpointOfNetworkPipe {

[Override ( "Antecedent" ), Min ( 2 ), Max ( 2 ), Description (

"One of the endpoints of the pipe.")]
TPD_TCPProtocolEndpoint REF Antecedent;

[Override ( "Dependent" ), Description (

"The pipe which is dependent on the endpoints as the source "
"or sink of the transferred information.")]
TPD_iSCSIConnection REF Dependent;
};

// ==================================================================
// 3PAR iSCSIPipeComposition
// ==================================================================
[Association, Aggregation, Composition, Description (
"NetworkPipeComposition describes the makeup a pipe, based on "
"lower-level ones. If the pipe is not composed of lower-level "
"entities (i.e., its AggregationBehavior property is set to 2), "
"then no instances of this association should be defined where "
"the pipe has the role of GroupComponent.")]
class TPD_iSCSIPipeComposition : CIM_NetworkPipeComposition {

[Aggregate, Override ( "GroupComponent" ), Description (

"The higher level pipe that is composed of lower-level "
"parts/pipes.")]
TPD_iSCSISession REF GroupComponent;

[Override ( "PartComponent" ), Description (

"A pipe which is a part of a higher-level one.")]
TPD_iSCSIConnection REF PartComponent;
};
*/
// ==================================================================
// 3PAR iSCSISessionStatistics
// ==================================================================
[Description (
"Traffic and error statistics for an iSCSI Session. An instance "
"of this class associated by ElementStatisticalData to "
"the instance of iSCSISession.")]
class TPD_iSCSISessionStatistics : CIM_iSCSISessionStatistics {

3PAR_TPDiSCSI.mof A.119
 CIM API Programming Reference InForm OS Version 2.3.1

};

// ==================================================================
// 3PAR iSCSISessionStatisticalData
// ==================================================================
[Association, Description (
"CIM_ElementStatisticalData is an association that relates a "
"ManagedElement to its StatisticalData. Note that the "
"cardinality of the ManagedElement reference is Min(1), Max(1). "
"This cardinality mandates the instantiation of the "
"ElementStatisticalData association for the referenced instance "
"of CIM_StatisticalData. ElementStatisticalData describes the "
"existence requirements and context for the "
"CIM_StatisticalData, relative to a specific ManagedElement.")]
class TPD_iSCSISessionStatisticalData : CIM_ElementStatisticalData {

[Key, Min ( 1 ), Max ( 1 ), Description (

"The ManagedElement for which statistical or metric data is "
"defined.")]
TPD_iSCSISession REF ManagedElement;

[Key, Description (
"The statistic information/object.")]
TPD_iSCSISessionStatistics REF Stats;
};

// ==================================================================
// 3PAR iSCSICapabilities
// ==================================================================
[Description (
"The capabilites for an iSCSI Network Entity. An instance of "
"this class associated by ElementCapabilities to a "
"instance of ComputerSystem that represents the Network Entity. "
"These capability properties are associated to a Network "
"Entity/ComputerSystem since they affect all login negotiations "
"on all iSCSI ProtocolEndpoints aggregated to the system.")]
class TPD_iSCSICapabilities : CIM_iSCSICapabilities {

};

// ==================================================================
// 3PAR iSCSIElementCapabilities
// ==================================================================
[Association, Description (
"ElementCapabilities represents the association between "

A.120 3PAR_TPDiSCSI.mof
InForm OS Version 2.3.1 CIM API Programming Reference

"ManagedElements and their Capabilities. Note that the "

"cardinality of the ManagedElement reference is Min(1), Max(1). "
"This cardinality mandates the instantiation of the "
"ElementCapabilities association for the referenced instance of "
"Capabilities. ElementCapabilities describes the existence "
"requirements and context for the referenced instance of "
"ManagedElement. Specifically, the ManagedElement MUST exist "
"and provides the context for the Capabilities.")]
class TPD_iSCSIElementCapabilities : CIM_ElementCapabilities {

[Key, Min ( 1 ), Max ( 1 ), Description (

"The managed element.")]
TPD_StorageSystem REF ManagedElement;

[Key, Description (
"The Capabilities object associated with the element.")]
TPD_iSCSICapabilities REF Capabilities;
};

// ==================================================================
// 3PAR iSCSISAPAvailableForElement
// ==================================================================
[Association, Description (
"CIM_SAPAvailableForElement conveys the semantics of a Service "
"Access Point that is available for a ManagedElement. When "
"CIM_SAPAvailableForElement is not instantiated, then the SAP "
"is assumed to be generally available. If instantiated, the SAP "
"is available only for the associated ManagedElements. For "
"example, a device might provide management access through a "
"URL. This association allows the URL to be advertised for the "
"device.")]
class TPD_iSCSISAPAvailableForElement : CIM_SAPAvailableForElement {

[Key, Description (
"The Service Access Point that is available.")]
TPD_iSCSIProtocolEndpoint REF AvailableSAP;

[Key, Description (
"The ManagedElement for which the SAP is available.")]
TPD_iSCSIController REF ManagedElement;
};

// ==================================================================
// 3PAR NodeSystem and iSCSIController association
// ==================================================================

3PAR_TPDiSCSI.mof A.121
 CIM API Programming Reference InForm OS Version 2.3.1

[Association, Aggregation, Composition,

Description (
"3PAR Data InServ Storage System and iSCSI Controller Association ") ]
class TPD_SystemiSCSIController : CIM_SystemDevice
{
[Override ("GroupComponent"), Aggregate, Max (1), Min (1), Description(
"The InServ node controller that hosted the iSCSI Controller.")]
TPD_NodeSystem REF GroupComponent;

[Override ("PartComponent"), Weak, Description (

"The iSCSI Controller.") ]
TPD_iSCSIController REF PartComponent;
};

// ==================================================================
// 3PAR iSCSISessionFailures
// ==================================================================
[Description (
"Failure Statistics for Sessions associated with a iSCSI Node. "
"An instance of this class associated by "
"ElementStatisticalData to an instance of "
"SCSIProtocolController representing an iSCSI Node. These "
"statistics are associated to a Node since they describe the "
"aggregated Session data for all failed Sessions associated to "
"iSCSI protocol endpoints used by the Node.")]
class TPD_iSCSISessionFailures : CIM_iSCSISessionFailures {

};

// ==================================================================
// 3PAR iSCSILoginStatistics
// ==================================================================
[Description (
"Statistics for Logins and Logouts to or from an iSCSI Node. An "
"instance of this class associated by "
"ElementStatisticalData to an instance of "
"SCSIProtocolController that represents the Node. The Node can "
"be either an Initiator or Target and so the interpretation of "
"the properties in this class varies accordingly.")]
class TPD_iSCSILoginStatistics : CIM_iSCSILoginStatistics {

};

// ==================================================================
// 3PAR iSCSISessionFailuresData

A.122 3PAR_TPDiSCSI.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// ==================================================================
[Association, Description (
"CIM_ElementStatisticalData is an association that relates a "
"ManagedElement to its StatisticalData. Note that the "
"cardinality of the ManagedElement reference is Min(1), Max(1). "
"This cardinality mandates the instantiation of the "
"ElementStatisticalData association for the referenced instance "
"of CIM_StatisticalData. ElementStatisticalData describes the "
"existence requirements and context for the "
"CIM_StatisticalData, relative to a specific ManagedElement.")]
class TPD_iSCSISessionFailuresData : CIM_ElementStatisticalData {

[Key, Min ( 1 ), Max ( 1 ), Description (

"The ManagedElement for which statistical or metric data is "
"defined.")]
TPD_iSCSIController REF ManagedElement;

[Key, Description (
"The statistic information/object.")]
TPD_iSCSISessionFailures REF Stats;
};

// ==================================================================
// 3PAR iSCSILoginStatisticsData
// ==================================================================
[Association, Description (
"CIM_ElementStatisticalData is an association that relates a "
"ManagedElement to its StatisticalData. Note that the "
"cardinality of the ManagedElement reference is Min(1), Max(1). "
"This cardinality mandates the instantiation of the "
"ElementStatisticalData association for the referenced instance "
"of CIM_StatisticalData. ElementStatisticalData describes the "
"existence requirements and context for the "
"CIM_StatisticalData, relative to a specific ManagedElement.")]
class TPD_iSCSILoginStatisticsData : CIM_ElementStatisticalData {

[Key, Min ( 1 ), Max ( 1 ), Description (

"The ManagedElement for which statistical or metric data is "
"defined.")]
TPD_iSCSIController REF ManagedElement;

[Key, Description (
"The statistic information/object.")]
TPD_iSCSILoginStatistics REF Stats;
};

3PAR_TPDiSCSI.mof A.123
 CIM API Programming Reference InForm OS Version 2.3.1

A.10 3PAR_TPDStats.mof
This MOF contains 3PAR Statistical (Block Server Performance Subprofile) classes that loaded
into the root/tpd namespace.

// ==================================================================
// Statistics Collection
// ==================================================================
[Description (
"Statistics collection")]
class TPD_StatisticsCollection : CIM_StatisticsCollection
{
};

// ==================================================================
// Hosted Statistics Collection
// ==================================================================
[Association, Description (
"HostedCollection defines a SystemSpecificCollection in the "
"context of a scoping System. It represents a Collection that "
"has meaning only in the context of a System, a Collection "
"whose elements are restricted by the definition of the System, "
"or both of these types of Collections.")]
class TPD_HostedStatisticsCollection : CIM_HostedCollection
{
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The scoping system.")]
TPD_StorageSystem REF Antecedent;

[Override ( "Dependent" ), Description (

"The collection defined in the context of a system.")]
TPD_StatisticsCollection REF Dependent;
};

// ==================================================================
// Block Statistics Statistics Collection
// ==================================================================
[Description (
"Block Statistics Statistics collection")]
class TPD_BlockStatisticsManifestCollection :
CIM_BlockStatisticsManifestCollection

A.124 3PAR_TPDStats.mof
InForm OS Version 2.3.1 CIM API Programming Reference

{
};

// ==================================================================
// Associated Block Statistics Manifest Collection
// ==================================================================
[Association, Description (
"Instances of this class associate a "
"BlockStatisticsManifestCollection to the StatisticsCollection "
"to which is is applied. The ManifestCollection contains the "
"Manifests that are used to filter requests for the retrieval "
"of statistics.")]
class TPD_AssociatedBlockStatisticsManifestCollection :
CIM_AssociatedBlockStatisticsManifestCollection
{
[Key, Min ( 1 ), Max ( 1 ), Description (
"The collection of statistics filtered by the "
"BlockStatisticsManifestCollection.")]
TPD_StatisticsCollection REF Statistics;

[Key, Description (
"The collection of Manifests applied to the "
"StatisticsCollection.")]
TPD_BlockStatisticsManifestCollection REF ManifestCollection;
};

// ==================================================================
// Block Statistics Manifest
// ==================================================================
[Description (
"Block Statistics manifest")]
class TPD_BlockStatisticsManifest : CIM_BlockStatisticsManifest
{
};

3PAR_TPDStats.mof A.125
 CIM API Programming Reference InForm OS Version 2.3.1

// ==================================================================
// Member Of Block Statistics Manifest Collection
// ==================================================================
[Association, Aggregation, Description (
"Aggregation used to establish "
"membership of ManagedElements in a Collection.")]
class TPD_MemberOfBlockStatisticsManifestCollection : CIM_MemberOfCollection {

[Key, Aggregate, Description (

"The Collection that aggregates members.")]
TPD_BlockStatisticsManifestCollection REF Collection;

[Key, Description (
"The aggregated member of the Collection.")]
TPD_BlockStatisticsManifest REF Member;
};

// ==================================================================
// Member Of Statistics Collection
// ==================================================================
[Association, Aggregation, Description (
"Aggregation used to establish "
"membership of ManagedElements in a Collection.")]
class TPD_MemberOfStatisticsCollection : CIM_MemberOfCollection {

[Key, Aggregate, Description (

"The Collection that aggregates members.")]
TPD_StatisticsCollection REF Collection;

[Key, Description (
"The aggregated member of the Collection.")]
CIM_BlockStorageStatisticalData REF Member;
};

// ==================================================================
// Disk Drive Statistical Data
// ==================================================================
[Description (
"Statistical data for the Disk Drive")]
class TPD_DiskStatisticalData : CIM_BlockStorageStatisticalData
{
};
// ==================================================================
// Disk Element Statistical Data

A.126 3PAR_TPDStats.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// ==================================================================
[Association, Description (
"An association that relates a "
"ManagedElement to its StatisticalData. Note that the "
"cardinality of the ManagedElement reference is Min(1), Max(1). "
"This cardinality mandates the instantiation of the "
"ElementStatisticalData association for the referenced instance "
"of CIM_StatisticalData. ElementStatisticalData describes the "
"existence requirements and context for the "
"CIM_StatisticalData, relative to a specific ManagedElement.")]
class TPD_DiskElementStatisticalData : CIM_ElementStatisticalData
{
[Key, Min ( 1 ), Max ( 1 ), Description (
"The ManagedElement for which statistical or metric data is "
"defined.")]
TPD_DiskDrive REF ManagedElement;

[Key, Description (
"The statistic information/object.")]
TPD_DiskStatisticalData REF Stats;
};

// ==================================================================
// Port Statistical Data
// ==================================================================
[Description (
"Statistical data for the Port")]
class TPD_PortStatisticalData : CIM_BlockStorageStatisticalData
{
};

// ==================================================================
// Port Element Statistical Data
// ==================================================================
[Association, Description (
"An association that relates a "
"ManagedElement to its StatisticalData. Note that the "
"cardinality of the ManagedElement reference is Min(1), Max(1). "
"This cardinality mandates the instantiation of the "
"ElementStatisticalData association for the referenced instance "
"of CIM_StatisticalData. ElementStatisticalData describes the "
"existence requirements and context for the "
"CIM_StatisticalData, relative to a specific ManagedElement.")]
class TPD_PortElementStatisticalData : CIM_ElementStatisticalData
{

3PAR_TPDStats.mof A.127
 CIM API Programming Reference InForm OS Version 2.3.1

[Key, Min ( 1 ), Max ( 1 ), Description (

"The ManagedElement for which statistical or metric data is "
"defined.")]
CIM_NetworkPort REF ManagedElement;

[Key, Description (
"The statistic information/object.")]
TPD_PortStatisticalData REF Stats;
};

// ==================================================================
// Volume Statistical Data
// ==================================================================
[Description (
"Statistical data for the Volume")]
class TPD_VolumeStatisticalData : CIM_BlockStorageStatisticalData
{
};

// ==================================================================
// Storage Volume Element Statistical Data
// ==================================================================
[Association, Description (
"An association that relates a "
"ManagedElement to its StatisticalData. Note that the "
"cardinality of the ManagedElement reference is Min(1), Max(1). "
"This cardinality mandates the instantiation of the "
"ElementStatisticalData association for the referenced instance "
"of CIM_StatisticalData. ElementStatisticalData describes the "
"existence requirements and context for the "
"CIM_StatisticalData, relative to a specific ManagedElement.")]
class TPD_VolumeElementStatisticalData : CIM_ElementStatisticalData
{
[Key, Min ( 1 ), Max ( 1 ), Description (
"The ManagedElement for which statistical or metric data is "
"defined.")]
TPD_StorageVolume REF ManagedElement;

[Key, Description (
"The statistic information/object.")]
TPD_VolumeStatisticalData REF Stats;
};

// ==================================================================
// Block Statistics Service

A.128 3PAR_TPDStats.mof
InForm OS Version 2.3.1 CIM API Programming Reference

// ==================================================================
class TPD_BlockStatisticsService : CIM_BlockStatisticsService
{
};

// ==================================================================
// Hosted Statistics Service
// ==================================================================
[Association, Description (
"An association between a Service and the "
"System on which the functionality is located. The cardinality "
"of this association is one-to-many. A System can host many "
"Services. Services are weak with respect to their hosting "
"System. Heuristic: A Service is hosted on the System where the "
"LogicalDevices or SoftwareFeatures that implement the Service "
"are located. The model does not represent Services hosted "
"across multiple systems. The model is as an ApplicationSystem "
"that acts as an aggregation point for Services that are each "
"located on a single host.")]
class TPD_HostedStatisticsService : CIM_HostedService
{
[Override ( "Antecedent" ), Min ( 1 ), Max ( 1 ), Description (
"The scoping system.")]
TPD_StorageSystem REF Antecedent;

[Override ( "Dependent" ), Description (

"The collection defined in the context of a system.")]
TPD_BlockStatisticsService REF Dependent;
};

// ==================================================================
// Block Statistics Capabilities
// ==================================================================
class TPD_BlockStatisticsCapabilities : CIM_BlockStatisticsCapabilities
{
};

// ==================================================================
// Statistics Element Capabilities
// ==================================================================
[Association, Description (
"ElementCapabilities represents the association between "
"ManagedElements and their Capabilities. Note that the "
"cardinality of the ManagedElement reference is Min(1), Max(1). "
"This cardinality mandates the instantiation of the "

3PAR_TPDStats.mof A.129
 CIM API Programming Reference InForm OS Version 2.3.1

"ElementCapabilities association for the referenced instance of "

"Capabilities. ElementCapabilities describes the existence "
"requirements and context for the referenced instance of "
"ManagedElement. Specifically, the ManagedElement MUST exist "
"and provides the context for the Capabilities.")]
class TPD_StatisticsElementCapabilities : CIM_ElementCapabilities {

[Key, Min ( 1 ), Max ( 1 ), Description (

"The managed element.")]
TPD_BlockStatisticsService REF ManagedElement;

[Key, Description (
"The Capabilities object associated with the element.")]
TPD_BlockStatisticsCapabilities REF Capabilities;
};

// ==================================================================
// LUNs Statistical Data
// ==================================================================
[Description (
"Statistical data for the LUNs")]
class TPD_LUNStatisticalData : CIM_BlockStorageStatisticalData
{
};

A.130 3PAR_TPDStats.mof
InForm OS Version 2.3.1 CIM API Programming Reference

Index
3PAR InForm operating environment 1.2
3PAR InServ Storage Servers 1.2
D
developers 1.1
dialog elements 1.3
A disabling
advisories, conventions 1.4 CIM server 4.3
audience 1.1 disk array 2.1
displaying
CIM server status 4.3
C Distributed Management Task Force
cautions and notes 1.4 DMTF 2.2
chapter summaries 1.2 DMTF
CIM namespaces 4.7 Distributed Management Task Force 2.2
CIM server documentation, related 1.2
disabling 4.3
enabling 4.2 E
CIM server status
displaying 4.3 enabling
CIMNavigator 4.5 CIM server 4.2
CIM-XML 2.2
commands
setcim 4.2
F
showcim 4.2, 4.3, 4.4 Fibre Channel switches 2.1
showversion 4.4
startcim 4.2
stopcim 4.2, 4.3
N
conventions notes and cautions 1.4
advisories 1.4 notes, about 1.4
typographical 1.3

Index IX.1
 CIM API Programming Reference InForm OS Version 2.3.1

R
related documentation 1.2
revision history RH.1

S
Service Location Protocol version 2
SLPv2 2.1, 5.3
setcim command 4.2
showcim command 4.2, 4.3, 4.4
showversion command 4.4
SLPV2
Service Location Protocol version 2 2.1, 5.3
SMI-S 2.1, 2.2
startcim command 4.2
stopcim command 4.2, 4.3

T
typographical conventions 1.3

W
WBEM 2.2
Distributed Management Task Force
Initiative 2.2
Web-Based Enterprise Management Initiative
WBEM 2.2

IX.2 Index
InForm OS Version 2.3.1 CIM API Programming Reference

Revision History
Release Level Revision Summary

320-200164 Rev A First release of this manual to support 3PAR InForm OS release 2.3.1.
October 2009

320-200164 Rev B Added new volume options for 2.3.1, expiration and retention time.
February 2010 Added support for SSD storage pool for 3.1.1, which manifests itself
as an instance of StoragePool with InstanceID of “3PAR:all-SSD”.

Revision History RH.1

 CIM API Programming Reference InForm OS Version 2.3.1

RH.2