IBM TotalStorage Enterprise Storage Server


Application Programming Interface

Reference

GC35-0489-01
IBM TotalStorage Enterprise Storage Server


Application Programming Interface

Reference

GC35-0489-01
 Note:
Before using this information and the product it supports, read the information in “Notices” on page 261.

Second Edition (May 2004)

This edition replaces GC35-0489-00.
© Copyright International Business Machines Corporation 2004. All rights reserved.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

About this guide . . . . . . . . . . . . . . . . . . . . . . . . xi

Who should use this guide . . . . . . . . . . . . . . . . . . . . . xi
Conventions used in this guide . . . . . . . . . . . . . . . . . . . xii
How to send your comments . . . . . . . . . . . . . . . . . . . . xii
Related information . . . . . . . . . . . . . . . . . . . . . . . xii
ESS library . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Other IBM publications . . . . . . . . . . . . . . . . . . . . . xiv
Ordering IBM publications . . . . . . . . . . . . . . . . . . . . xx
Non-IBM publications . . . . . . . . . . . . . . . . . . . . . xxi
Web sites . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi

Summary of Changes . . . . . . . . . . . . . . . . . . . . . xxiii

Summary of Changes for GC35-0489-01 IBM TotalStorage Enterprise Storage
Server Application Programming Interface Reference . . . . . . . . . xxiii
New Information . . . . . . . . . . . . . . . . . . . . . . . xxiii
Changed Information . . . . . . . . . . . . . . . . . . . . . xxiii
Moved Information . . . . . . . . . . . . . . . . . . . . . . xxiii
Deleted Information . . . . . . . . . . . . . . . . . . . . . . xxiii

Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . 1
ESS API overview . . . . . . . . . . . . . . . . . . . . . . . . 1
CIM Agent overview . . . . . . . . . . . . . . . . . . . . . . . 2
CIM Agent components . . . . . . . . . . . . . . . . . . . . . . 3
CIM concepts . . . . . . . . . . . . . . . . . . . . . . . . . . 4
ESS CIM Agent installation requirements . . . . . . . . . . . . . . . . 5
Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Workstation space . . . . . . . . . . . . . . . . . . . . . . . 5
Software . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
ESS CIM Agent installation methods . . . . . . . . . . . . . . . . . 6
ESS CIM Agent security . . . . . . . . . . . . . . . . . . . . . . 6

Chapter 2. CIM Agent on AIX . . . . . . . . . . . . . . . . . . . 7

Installation overview for AIX . . . . . . . . . . . . . . . . . . . . 7
Installing the ESS CLI on AIX . . . . . . . . . . . . . . . . . . . . 7
Mounting the CD on AIX . . . . . . . . . . . . . . . . . . . . . . 9
Installing the CIM Agent on AIX in graphical mode . . . . . . . . . . . . 10
Installing the CIM Agent on AIX in unattended (silent) mode . . . . . . . . 19
Verifying the CIM Agent installation on AIX . . . . . . . . . . . . . . . 21
Configuring the CIM Agent on AIX . . . . . . . . . . . . . . . . . . 22
Configuring the CIM Agent to run in unsecure mode . . . . . . . . . . . 25
Verifying connection to the ESS . . . . . . . . . . . . . . . . . . . 25
Removing the CIM Agent on AIX . . . . . . . . . . . . . . . . . . 27
Removing in graphical mode . . . . . . . . . . . . . . . . . . . 28
Removing in unattended (silent) mode . . . . . . . . . . . . . . . 32

Chapter 3. CIM Agent for Linux . . . . . . . . . . . . . . . . . . 33

Installation overview for Linux . . . . . . . . . . . . . . . . . . . 33
Installing the ESS CLI on Linux . . . . . . . . . . . . . . . . . . . 33
Installing the CIM Agent on Linux in graphical mode . . . . . . . . . . . 35

© Copyright IBM Corp. 2004 iii

 Installing the CIM Agent on Linux in unattended (silent) mode . . . . . . . 43
Verifying the CIM Agent installation on Linux . . . . . . . . . . . . . . 47
Configuring the CIM Agent on Linux . . . . . . . . . . . . . . . . . 47
Configuring the CIM Agent to run in unsecure mode on Linux . . . . . . . . 50
Verifying connection to the ESS . . . . . . . . . . . . . . . . . . . 51
Removing the CIM Agent on Linux. . . . . . . . . . . . . . . . . . 52
Removing in graphical mode . . . . . . . . . . . . . . . . . . . 53
Removing in unattended (silent) mode . . . . . . . . . . . . . . . 57

Chapter 4. ESS CIM Agent for Windows . . . . . . . . . . . . . . . 59

Installation overview for Windows . . . . . . . . . . . . . . . . . . 59
Installing the ESS CLI for Windows . . . . . . . . . . . . . . . . . 60
Installing the ESS CIM Agent on Windows in graphical mode . . . . . . . . 61
Installing the ESS CIM Agent on Windows in unattended (silent) mode . . . . 69
Verifying the ESS CIM Agent Windows installation . . . . . . . . . . . . 71
Configuring the ESS CIM Agent for Windows . . . . . . . . . . . . . . 72
Configuring the ESS CIM Agent to run in unsecure mode . . . . . . . . . 75
Verifying connection to the ESS . . . . . . . . . . . . . . . . . . . 76
Removing the ESS CIM Agent for Windows . . . . . . . . . . . . . . 80

Chapter 5. CIM Agent installation and configuration commands . . . . . 87

Overview of the CIM Agent commands and subcommands . . . . . . . . . 87
Description of commands . . . . . . . . . . . . . . . . . . . . 87
Invoking the CIM Agent . . . . . . . . . . . . . . . . . . . . . 88
Conventions used in this chapter . . . . . . . . . . . . . . . . . . 88
Syntax diagrams . . . . . . . . . . . . . . . . . . . . . . . 88
Special characters . . . . . . . . . . . . . . . . . . . . . . 90
Emphasis . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Anatomy of a command line . . . . . . . . . . . . . . . . . . . 90
Configuration commands . . . . . . . . . . . . . . . . . . . . . 91
Description of subcommands . . . . . . . . . . . . . . . . . . . 91
setuser . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
adduser . . . . . . . . . . . . . . . . . . . . . . . . . . 94
chuser . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
lsuser . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
rmuser . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
setentry . . . . . . . . . . . . . . . . . . . . . . . . . . 98
setoutput . . . . . . . . . . . . . . . . . . . . . . . . . . 99
setdevice . . . . . . . . . . . . . . . . . . . . . . . . . 100
addess . . . . . . . . . . . . . . . . . . . . . . . . . . 101
addessserver . . . . . . . . . . . . . . . . . . . . . . . . 103
chess . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
chessserver . . . . . . . . . . . . . . . . . . . . . . . . 107
lsess . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
lsessserver . . . . . . . . . . . . . . . . . . . . . . . . . 110
rmess . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
rmessserver . . . . . . . . . . . . . . . . . . . . . . . . 112
setentry . . . . . . . . . . . . . . . . . . . . . . . . . . 113
setoutput . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Operational commands . . . . . . . . . . . . . . . . . . . . . 115
startcimom . . . . . . . . . . . . . . . . . . . . . . . . . 116
stopcimom . . . . . . . . . . . . . . . . . . . . . . . . . 117
Utility commands . . . . . . . . . . . . . . . . . . . . . . . . 118
mkcertificate . . . . . . . . . . . . . . . . . . . . . . . . 119
slpd . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
verifyconfig . . . . . . . . . . . . . . . . . . . . . . . . . 121

iv ESS API Reference

 modifyconfig . . . . . . . . . . . . . . . . . . . . . . . . 122

Appendix A. ESS API component definitions . . . . . . . . . . . . 123

Appendix B. CIM Agent communication with the ESS API . . . . . . . 125

CIM Agent communication concepts . . . . . . . . . . . . . . . . 125
CIM Agent Communication methods . . . . . . . . . . . . . . . . 126
CIM Agent Functional Groups . . . . . . . . . . . . . . . . . . . 136
Error codes returned by the CIMOM . . . . . . . . . . . . . . . . 137

Appendix C. CIM Agent class information for the ESS API . . . . . . . 141
CIM Agent class definitions quick reference . . . . . . . . . . . . . . 141
ESS API class definitions . . . . . . . . . . . . . . . . . . . . 147
ESS class definition schemas . . . . . . . . . . . . . . . . . . . 231

Appendix D. ESS API support for Microsoft Volume Shadow Copy Service
for Windows . . . . . . . . . . . . . . . . . . . . . . . . 241
ESS API Support for Microsoft’s Volume Shadow Copy Service Overview 241
ESS API support for Microsoft Volume Shadow Copy Service installation
overview . . . . . . . . . . . . . . . . . . . . . . . . . . 242
ESS API support for Microsoft Volume Shadow Copy Service installation
requirements . . . . . . . . . . . . . . . . . . . . . . . . 242
Hardware . . . . . . . . . . . . . . . . . . . . . . . . . 242
Software . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Installing ESS API support for Microsoft Volume Shadow Copy Service on
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Verifying ESS API support for Microsoft Volume Shadow Copy Service
Windows installation . . . . . . . . . . . . . . . . . . . . . 252
Creating the VSS_FREE and VSS_RESERVED pools . . . . . . . . . . 252
Verifying ESS API support for Microsoft Volume Shadow Copy Service
Windows configuration . . . . . . . . . . . . . . . . . . . . . 253
ESS API support for Microsoft Volume Shadow Copy Service reconfiguration
commands . . . . . . . . . . . . . . . . . . . . . . . . . 253
Error codes returned by Microsoft Volume Shadow Copy Service . . . . . . 256
Uninstalling ESS API support for Microsoft Volume Shadow Copy Service on
Windows . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Appendix E. Accessibility . . . . . . . . . . . . . . . . . . . . 259

Features . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Navigating by keyboard . . . . . . . . . . . . . . . . . . . . . 259
Accessing the publications . . . . . . . . . . . . . . . . . . . . 259

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Trademarks. . . . . . . . . . . . . . . . . . . . . . . . . . 262
Java Compatibility logo . . . . . . . . . . . . . . . . . . . . . 263

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . 265

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

Contents v
vi ESS API Reference
Tables
1. Conventions used in this guide . . . . . . . . . . . . . . . . . . . . . . . . . . xii
2. Summary of CIM Agent commands . . . . . . . . . . . . . . . . . . . . . . . . 87
3. Summary of CIM Agent setuser and setdevice subcommands . . . . . . . . . . . . . . 91
4. GetClass method parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 126
5. GetInstance method parameters . . . . . . . . . . . . . . . . . . . . . . . . . 126
6. DeleteInstance method parameters . . . . . . . . . . . . . . . . . . . . . . . 127
7. CreateInstance method parameters . . . . . . . . . . . . . . . . . . . . . . . 127
8. ModifyInstance method parameters . . . . . . . . . . . . . . . . . . . . . . . 128
9. EnumerateClasses method parameters . . . . . . . . . . . . . . . . . . . . . . 128
10. EnumerateClassNames method parameters . . . . . . . . . . . . . . . . . . . . 129
11. EnumerateInstances method parameters . . . . . . . . . . . . . . . . . . . . . 130
12. EnumerateInstanceNames method parameters . . . . . . . . . . . . . . . . . . . 130
13. ExecQuery method parameters . . . . . . . . . . . . . . . . . . . . . . . . . 131
14. Associators method parameters . . . . . . . . . . . . . . . . . . . . . . . . . 131
15. AssociatorNames method parameters. . . . . . . . . . . . . . . . . . . . . . . 132
16. References method parameters . . . . . . . . . . . . . . . . . . . . . . . . . 132
17. ReferenceNames method parameters . . . . . . . . . . . . . . . . . . . . . . . 133
18. GetProperty method parameters . . . . . . . . . . . . . . . . . . . . . . . . . 133
19. SetProperty method parameters . . . . . . . . . . . . . . . . . . . . . . . . . 134
20. GetQualifier method parameters . . . . . . . . . . . . . . . . . . . . . . . . . 134
21. SetQualifier method parameters . . . . . . . . . . . . . . . . . . . . . . . . . 135
22. Functional groups for the CIM Agent . . . . . . . . . . . . . . . . . . . . . . . 136
23. Return error codes for the CIMON . . . . . . . . . . . . . . . . . . . . . . . . 137
24. CIM Agent class definitions (quick reference) . . . . . . . . . . . . . . . . . . . . 141
25. IBMTSESS_StorageSystem class properties . . . . . . . . . . . . . . . . . . . . 147
26. IBMTSESS_VolumeSpace class properties . . . . . . . . . . . . . . . . . . . . . 148
27. IBMTSESS_Volume class properties . . . . . . . . . . . . . . . . . . . . . . . 150
28. IBMTSESS_FCPort class properties . . . . . . . . . . . . . . . . . . . . . . . 153
29. IBMTSESS_SCSIProtocolController class properties . . . . . . . . . . . . . . . . . 154
30. IBMTSESS_Privilege class properties . . . . . . . . . . . . . . . . . . . . . . . 155
31. IBMTSESS_StorageHardwareID class properties . . . . . . . . . . . . . . . . . . 156
32. IBMTSESS_StorageConfigurationService class properties . . . . . . . . . . . . . . . 157
33. IBMTSESS_LunMaskPrivilegeService class properties . . . . . . . . . . . . . . . . 171
34. IBMTSESS_StorageHardwareIDManagementService class properties . . . . . . . . . . . 174
35. IBMTSESS_Product class properties . . . . . . . . . . . . . . . . . . . . . . . 176
36. IBMTSESS_AllocatedFromStoragePool class properties . . . . . . . . . . . . . . . . 177
37. IBMTSESS_StorageSystemToVolume class properties . . . . . . . . . . . . . . . . 177
38. IBMTSESS_StorageSystemToPort class properties . . . . . . . . . . . . . . . . . . 177
39. IBMTSESS_StorageSystemToController class properties . . . . . . . . . . . . . . . . 178
40. IBMTSESS_ProtocolControllerForUnit class properties . . . . . . . . . . . . . . . . 178
41. IBMTSESS_ProtocolControllerForPort class properties . . . . . . . . . . . . . . . . 178
42. IBMTSESS_AuthorizedTarget class properties . . . . . . . . . . . . . . . . . . . 179
43. IBMTSESS_AuthorizedSubject class properties . . . . . . . . . . . . . . . . . . . 179
44. IBMTSESS_ConcreteDependencyPrivilege class properties. . . . . . . . . . . . . . . 180
45. IBMTSESS_ConcreteDependencyStorageHardwareID class properties . . . . . . . . . . 180
46. IBMTSESS_HostedService class properties . . . . . . . . . . . . . . . . . . . . 180
47. IBMTSESS_HostedService2 class properties . . . . . . . . . . . . . . . . . . . . 181
48. IBMTSESS_HostedService3 class properties . . . . . . . . . . . . . . . . . . . . 181
49. IBMTSESS_ElementSettingData class properties . . . . . . . . . . . . . . . . . . 181
50. IBMTSESS_ElementCapabilities class properties . . . . . . . . . . . . . . . . . . 181
51. IBMTSESS_HostedStoragePool class properties . . . . . . . . . . . . . . . . . . . 181
52. IBMTSESS_StorageCapabilities class properties . . . . . . . . . . . . . . . . . . . 182
53. IBMTSESS_StorageSetting class properties . . . . . . . . . . . . . . . . . . . . 184
© Copyright IBM Corp. 2004 vii
 54. IBMTSESS_Chassis class properties . . . . . . . . . . . . . . . . . . . . . . . 185
55. IBMTSESS_ComputerSystemPackage class properties . . . . . . . . . . . . . . . . 186
56. IBMTSESS_ExtraCapacitySet class properties . . . . . . . . . . . . . . . . . . . 186
57. IBMTSESS_ConcreteIdentityCapSet class properties . . . . . . . . . . . . . . . . . 187
58. IBMTSESS_ProductPhysicalComponent class properties . . . . . . . . . . . . . . . 187
59. IBMTSESS_RemoteServiceAccessPoint class properties . . . . . . . . . . . . . . . 187
60. IBMTSESS_HostedAccessPoint class properties . . . . . . . . . . . . . . . . . . . 189
61. IBMTSESS_StorageProcessorCard class properties . . . . . . . . . . . . . . . . . 189
62. IBMTSESS_ComputerSystemPackageCard class properties . . . . . . . . . . . . . . 189
63. IBMTSESS_MemberOfCollection class properties . . . . . . . . . . . . . . . . . . 190
64. IBMTSESS_DiskDrive properties . . . . . . . . . . . . . . . . . . . . . . . . 190
65. IBMTSESS_PhysicalPackage class properties . . . . . . . . . . . . . . . . . . . 192
66. IBMTSESS_Realizes class properties . . . . . . . . . . . . . . . . . . . . . . . 193
67. IBMTSESS_SystemDevice class properties . . . . . . . . . . . . . . . . . . . . 193
68. IBMTSESS_ControllerConfigurationService class properties . . . . . . . . . . . . . . 193
69. IBMTSESS_HostedService4 class properties . . . . . . . . . . . . . . . . . . . . 199
70. IBMTSESS_DeviceMaskingCapabilities class properties . . . . . . . . . . . . . . . . 199
71. IBMTSESS_ElementCapabilitiesMasking class properties . . . . . . . . . . . . . . . 202
72. IBMTSESS_ConcreteDependencyController class properties . . . . . . . . . . . . . . 202
73. IBMTSESS_RegisteredProfile class properties . . . . . . . . . . . . . . . . . . . 203
74. IBMTSESS_SubProfileExtendsProfile class properties . . . . . . . . . . . . . . . . . 204
75. IBMTSESS_ElementConformsToProfile class properties . . . . . . . . . . . . . . . . 205
76. IBMTSESS_Location class properties . . . . . . . . . . . . . . . . . . . . . . . 205
77. IBMTSESS_PhysicalElementLocation class properties . . . . . . . . . . . . . . . . 205
78. IBMTSESS_StorageClientSettingData class properties . . . . . . . . . . . . . . . . 206
79. IBMTSESS_InitiatorElementSettingData class properties . . . . . . . . . . . . . . . . 206
80. IBMTSESS_StorageExtent class properties . . . . . . . . . . . . . . . . . . . . 207
| 81. IBMTSESS_MediaPresentExtent class properties . . . . . . . . . . . . . . . . . . 209
82. IBMTSESS_Component class properties . . . . . . . . . . . . . . . . . . . . . 209
83. IBMTSESS_PrimordialStoragePool class properties . . . . . . . . . . . . . . . . . 210
84. IBMTSESS_HostedPrimordialStoragePool class properties . . . . . . . . . . . . . . . 211
85. IBMTSESS_StorageSynchronized class properties . . . . . . . . . . . . . . . . . . 211
86. IBMTSESS_EltCapabilitiesStgPool class properties . . . . . . . . . . . . . . . . . . 211
87. IBMTSESS_Provider class properties . . . . . . . . . . . . . . . . . . . . . . . 212
88. IBMTSESS_VolumeStatistics class properties . . . . . . . . . . . . . . . . . . . . 213
89. IBMTSESS_VolumeSpaceStatistics class properties . . . . . . . . . . . . . . . . . 215
90. IBMTSESS_VolumeStatisticalData class properties . . . . . . . . . . . . . . . . . . 216
91. IBMTSESS_VolumeSpaceStatisticalData class properties . . . . . . . . . . . . . . . 217
92. IBMTSESS_PerformanceStatisticsService class properties . . . . . . . . . . . . . . . 217
93. IBMTSESS_HostedService6 class properties . . . . . . . . . . . . . . . . . . . . 219
94. IBMTSESS_RemoteVolume . . . . . . . . . . . . . . . . . . . . . . . . . . 219
95. IBMTSESS_RemoteSourceStorageSynchronized class properties . . . . . . . . . . . . 219
96. IBMTSESS_RemoteTargetStorageSynchronized . . . . . . . . . . . . . . . . . . . 220
97. IBMTSESS_PPRCPath . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
| 98. IBMTSESS_Pool2PrimordialPool . . . . . . . . . . . . . . . . . . . . . . . . 223
| 99. IBMTSESS_AsyncPPRCService . . . . . . . . . . . . . . . . . . . . . . . . . 223
100. Microsoft Volume Shadow Copy Service reconfiguration commands . . . . . . . . . . . 254
101. Return error codes for Microsoft Volume Shadow Copy Service . . . . . . . . . . . . . 256

viii ESS API Reference

Figures
1. How a CIM Agent works . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. The MOF compiler stores the model in the CIMOM data store. . . . . . . . . . . . . . . 4
3. LaunchPad window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
4. LaunchPad window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
5. LaunchPad window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
6. Physical package instance diagram . . . . . . . . . . . . . . . . . . . . . . . 232
7. Array profile instance diagram . . . . . . . . . . . . . . . . . . . . . . . . . 233
8. Access point subprofile instance diagram . . . . . . . . . . . . . . . . . . . . . 234
9. Extra capacity set subprofile instance diagram . . . . . . . . . . . . . . . . . . . 234
10. Location subprofile instance diagram . . . . . . . . . . . . . . . . . . . . . . . 235
11. Copy services subprofile instance diagram . . . . . . . . . . . . . . . . . . . . . 235
12. Pool manipulation, capacity, and settings subprofile instance diagram . . . . . . . . . . . 236
13. LUN creation subprofile instance diagram . . . . . . . . . . . . . . . . . . . . . 237
14. LUN mapping and masking subprofile instance diagram . . . . . . . . . . . . . . . . 238
15. Performance extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
16. Disk drive subprofile instance diagram . . . . . . . . . . . . . . . . . . . . . . 239

© Copyright IBM Corp. 2004 ix

x ESS API Reference
About this guide
This publication introduces the IBM® TotalStorage™ Enterprise Storage Server™
(ESS) Application Programming Interface (API) and provides instructions for
installing and configuring the Common Information Model Agent (CIM Agent) on the
following operating systems:
v IBM Advanced Interactive Executive (AIX®)
v Linux
v Microsoft® Windows® 2000 or later
You can install the ESS CIM Agent on a host server or on a workstation within a
network.

This publication also lists the components of the Common Information Model (CIM)
and provides descriptions of the commands that you use during the installation and
configuration tasks.

Once the ESS CIM Agent is installed and configured on your machine, you can
implement the ESS API. Reference material in the appendixes includes the
following information that might assist you in writing your CIM-based applications for
the ESS API:
v ESS API component definitions
This appendix describes the elements, the namespace, and the object name for
the ESS API.
v CIM Agent communication with the ESS API
This appendix describes the concepts and methods for communication between
the ESS CIM Agent and the ESS API and lists error codes that the CIM object
manager (CIMOM) returns.
v ESS API object classes
This appendix provides ESS API object classes that are used by the ESS CIM
Agent to manage its model of the ESS. A visual representation of the ESS API
architecture for the ESS is also included.
v ESS API support for Microsoft Volume Shadow Copy Service Overview
This appendix provides instructions for installing and configuring Microsoft
Volume Shadow Copy Service on Windows. Microsoft Volume Shadow Copy
Service is used by the ESS CIM Agent for FlashCopy.

Note: See the IBM TotalStorage ESS Interoperability Web site for the availability
of Microsoft Volume Shadow Copy Service.

http://www.ibm.com/storage/hardsoft/products/ess/supserver.htm

Who should use this guide

This publication is for system administrators and system and application
programmers, or whoever is responsible for implementing the ESS API and
installing and configuring the ESS CIM Agent. This publication assumes that you
understand the general concepts of the operating system and Internet capabilities
for your enterprise.

Reference material for application programmers who write CIM-based ESS API
applications is in the appendixes.

© Copyright IBM Corp. 2004 xi

Conventions used in this guide
This guide uses bold, italic, and other typographic styles to highlight various types
of information in the text. See Table 1 for a list of conventions.
Table 1. Conventions used in this guide
Denotes a command, user ID, password, or
bold
labels on buttons.
italics Denotes titles of other manuals or books.
monospace Denotes a Web address that needs to be typed
in. Also denotes an example.
Used to show the screen output you should see.
screen

Note Introduces special considerations about the

current topic.
(>) greater than and (<) less than Shows the optional and substitution parameters
in the description of commands. The explanation
of the optional or substitution parameters are
included following the word ″Where.″

How to send your comments

Your feedback is important to help us provide the highest quality information. If you
have any comments about this book or any other ESS documentation, you can
submit them in one of the following ways:
v e-mail
Submit your comments electronically to the following e-mail address:
[email protected]
Be sure to include the name and order number of the book and, if applicable, the
specific location of the text you are commenting on, such as a page number or
table number.
v Mail
Fill out the Readers’ Comments form (RCF) at the back of this book. Return it by
mail or give it to an IBM representative. If the RCF has been removed, you can
address your comments to:
International Business Machines Corporation
Information Development
Department 61c
9000 South Rita road
Tucson, AZ 85775-4401
U.S.A.

Related information
The tables in this section list and describe the following publications:
v The publications that make up the IBM® TotalStorage™ Enterprise Storage
Server™ (ESS) library
v Other IBM publications that relate to the ESS
v Non-IBM publications that relate to the ESS

xii ESS API Reference

 See “Ordering IBM publications” on page xx for information about how to order
publications in the IBM TotalStorage ESS publication library. See “How to send your
comments” on page xii for information about how to send comments about the
publications.

ESS library
The following customer publications make up the ESS library. Unless otherwise
noted, these publications are available in Adobe portable document format (PDF) on
a compact disc (CD) that comes with the ESS. If you need additional copies of this
CD, the order number is SK2T-8803. These publications are also available as PDF
files by clicking on the Documentation link on the following ESS Web site:

http://www-1.ibm.com/servers/storage/support/disk/2105.html

See “IBM publications center” on page xxi for information about ordering these and
other IBM publications.

Order
Title Description
Number
IBM TotalStorage This guide describes the commands that you can use from the ESS Copy SC26-7494
Enterprise Storage Services command-line interface (CLI) for managing your ESS (See Note.)
Server: Command-Line configuration and Copy Services relationships. The CLI application
Interfaces User’s Guide provides a set of commands that you can use to write customized scripts
for a host system. The scripts initiate predefined tasks in an ESS Copy
Services server application. You can use the CLI commands to indirectly
control peer-to-peer remote copy and FlashCopy® configuration tasks
within an ESS Copy Services server group.
IBM TotalStorage This guide provides guidelines and work sheets for planning the logical SC26-7477
Enterprise Storage configuration of an ESS that attaches to open-systems hosts. (See Note.)
Server: Configuration
Planner for
Open-Systems Hosts
IBM TotalStorage This guide provides guidelines and work sheets for planning the logical SC26-7476
Enterprise Storage configuration of an ESS that attaches to either the IBM S/390® and IBM (See Note.)
Server: Configuration ERserver zSeries™ host system.
Planner for S/390 and
IBM ERserver zSeries
Hosts
IBM TotalStorage This guide provides guidelines for attaching the ESS to your host system SC26-7446
Enterprise Storage and for migrating to fibre-channel attachment from either a small computer (See Note.)
Server: Host Systems system interface or from the IBM SAN Data Gateway.
Attachment Guide
IBM 2105 TotalStorage This publication provides an overview of the ESS and highlights its unique SC26-7440
Enterprise Storage capabilities. It also describes Data Facility Storage Management (See Note.)
Server: DFSMS Subsystems (DFSMS) software support for the ESS, including support for
Software Support large volumes.
Reference
IBM TotalStorage This guide introduces the ESS product and lists the features you can GC26-7444
Enterprise Storage order. It also provides guidelines for planning the installation and
Server: Introduction and configuration of the ESS.
Planning Guide

About this guide xiii

 Order
Title Description
Number
IBM TotalStorage This booklet provides flow charts for using the TotalStorage Enterprise SC26-7354
Enterprise Storage Storage Server Specialist (ESS Specialist). The flow charts provide a
Server: Quick high-level view of the tasks that the IBM service support representative
Configuration Guide performs during initial logical configuration. You can also use the flow
charts for tasks that you might perform when you are modifying the logical
configuration.
IBM TotalStorage This publication describes the functions of the ESS and provides SC26-7298
Enterprise Storage reference information, such as channel commands, sense bytes, and error
Server: S/390 Command recovery procedures for IBM S/390 and zSeries hosts.
Reference
IBM TotalStorage This publication provides translations of the danger notices and caution GC26-7229
Storage Solutions Safety notices that IBM uses in ESS publications.
Notices
IBM TotalStorage This publication describes the functions of the ESS. It provides reference SC26-7297
Enterprise Storage information, such as channel commands, sense bytes, and error recovery
Server: SCSI Command procedures for UNIX®, IBM Application System/400® (AS/400®), and
Reference Eserver iSeries™ 400 hosts.
Subsystem Device This publication describes how to use the IBM Subsystem Device Driver SC26-7540
Driver’s User’s Guide for (SDD) on open-systems hosts to enhance performance and availability on
IBM TotalStorage the ESS. SDD creates redundant paths for shared logical unit numbers.
Enterprise Storage SDD permits applications to run without interruption when path errors
Server and IBM occur. It balances the workload across paths, and it transparently
TotalStorage SAN integrates with applications.
Volume Controller
IBM TotalStorage This guide provides instructions for setting up and operating the ESS and SC26-7445
Enterprise Storage for analyzing problems. (See Note.)
Server: User’s Guide
IBM TotalStorage This guide provides instructions for using the two ESS Web interfaces, SC26-7448
Enterprise Storage ESS Specialist and ESS Copy Services. (See Note.)
Server: Web Interface
User’s Guide
IBM TotalStorage This guide introduces the common interface model (CIM) concept and GC35-0485
Common Information provides instructions for installing and configuring the CIM Agent. The CIM
Model Agent for the Agent acts as an open-system standards interpreter, allowing other
Enterprise Storage CIM-compliant storage resource management applications (IBM and
Server: Installation and non-IBM) to interoperate with each other.
Configuration Guide
IBM TotalStorage This publication provides reference information for the IBM TotalStorage GC35-0489
Enterprise Storage Enterprise Storage Server (ESS) application programming interface (API)
Server Application and provides instructions for installing the Common Information Model
Programming Interfaces Agent, which implements the ESS API.
Reference
Note: No hardcopy book is produced for this publication. However, a PDF file is available from the following Web
site:

http://www-1.ibm.com/servers/storage/support/disk//2105.html

Other IBM publications

Other IBM publications contain additional information that is related to the ESS. The
following list is divided into categories to help you find publications that are related

xiv ESS API Reference

 to specific topics. Some of the publications are listed under more than one category.
See “IBM publications center” on page xxi for information about ordering these and
other IBM publications.

Order
Title Description
Number
Data-copy services
z/OS DFSMS Advanced This publication helps you understand and use IBM Advanced Copy SC35-0428
Copy Services Services functions. It describes three dynamic copy functions and several
point-in-time copy functions. These functions provide backup and recovery
of data if a disaster occurs to your data center. The dynamic copy functions
are peer-to-peer remote copy, extended remote copy, and coupled
extended remote copy. Collectively, these functions are known as remote
copy. FlashCopy, ShapShot, and concurrent copy are the point-in-time copy
functions.
DFSMS/MVS V1: This publication provides guidelines for using remote copy functions with SC35-0169
Remote Copy Guide and S/390 and zSeries hosts.
Reference
IBM Enterprise Storage This publication, from the IBM International Technical Support Organization, SG24-5465
Server introduces the ESS and provides an understanding of its benefits. It also
describes in detail the architecture, hardware, and functions, including the
advanced copy functions, of the ESS.
Implementing Copy This publication, from the IBM International Technical Support Organization, SG24-5680
Services 0n S/390 tells you how to install, customize, and configure Copy Services on an ESS
that is attached to an S/390 or zSeries host system. Copy Services
functions include peer-to-peer remote copy, extended remote copy,
FlashCopy®, and concurrent copy. This publication describes the functions,
prerequisites, and corequisites and describes how to implement each
function into your environment.
IBM TotalStorage ESS This publication, from the IBM International Technical Support Organization, SG24-5757
Implementing Copy tells you how to install, customize, and configure ESS Copy Services on
Services in an Open UNIX, Windows NT®, Windows 2000, Sun Solaris, HP-UX, Tru64,
Environment OpenVMS, and iSeries host systems. The Copy Services functions that are
described include peer-to-peer remote copy and FlashCopy. This
publication describes the functions and shows you how to implement them
into your environment. It also shows you how to implement these functions
in a high-availability cluster multiprocessing environment.
Fibre channel
Fibre Channel This publication provides information about the fiber-channel I/O interface. SA24-7172
Connection (FICON) I/O This book is also available as a PDF file from the following Web site:
Interface: Physical Layer
www.ibm.com/servers/resourcelink/
Fibre-channel This publication tells you how to attach the IBM xSeries™ 430 and No order
Subsystem Installation NUMA-Q® host systems with fibre-channel adapters to the ESS. number
Guide
Contact your sales representative to obtain this publication.
Fibre Transport Services This publication provides information about fibre-optic and ESCON-trunking GA22-7234
(FTS): Physical and systems.
Configuration Planning
Guide
IBM SAN Fibre Channel This guide explains how to convert the IBM SAN Fibre Channel Managed SY27–7616
Managed Hub: 3534 Hub from a Fibre-Channel Arbitrated Loop (FC-AL) configuration to a
Service Guide fabric-capable switched environment.

About this guide xv

 Order
Title Description
Number
IBM SAN Fibre Channel This guide provides an overview of the product and discusses available GC26-7391
Managed Hub: 3534 features and upgrades. It also tells you how to install the hub, how to
User’s Guide manage and monitor it using zoning, and how to manage it remotely. It also
tells you how to use the IBM 3534 SAN Fibre Channel Managed Hub
TotalStorage ESS Specialist.
IBM SAN Fibre Channel This guide describes how to install and maintain the IBM SAN Fibre SC26-7350
Switch: 2109 Model S08 Channel Switch 2109 Model S08.
Installation and Service
Guide
IBM SAN Fibre Channel This guide describes the IBM SAN Fibre Channel Switch and the IBM SC26-7349
Switch: 2109 Model S08 TotalStorage ESS Specialist. It provides information about the commands
User’s Guide and how to manage the switch with Telnet and the Simple Network
Management Protocol.
IBM SAN Fibre Channel This publication describes how to install and maintain the IBM SAN Fibre SC26-7352
Switch: 2109 Model S16 Channel Switch 2109 Model S16. It is intended for trained service
Installation and Service representatives and service providers.
Guide
IBM SAN Fibre Channel This guide introduces the IBM SAN Fibre Channel Switch 2109 Model S16 SC26-7351
Switch: 2109 Model S16 and tells you how to manage and monitor the switch using zoning and how
User’s Guide to manage the switch remotely.
Implementing Fibre This publication, from the IBM International Technical Support Organization, SG24-6113
Channel Attachment on helps you install, tailor, and configure fibre-channel attachment of
the ESS open-systems hosts to the ESS. It provides you with a broad
understanding of the procedures that are involved and describes the
prerequisites and requirements. It also shows you how to implement
fibre-channel attachment. This book also describes the steps required to
migrate to direct fibre-channel attachment from native SCSI adapters and
from fibre-channel attachment through the SAN Data Gateway.
Open-systems hosts
ESA/390: ESCON I/O This publication provides a description of the physical and logical ESA/390 SA22-7202
Interface I/O interface and the protocols that govern information transfer over that
interface. It is intended for designers of programs and equipment
associated with the ESCON I/O interface and for service personnel who
maintain that equipment. However, anyone concerned with the functional
details of the ESCON I/O interface can find it useful.
ESS Solutions for Open This publication, from the IBM International Technical Support Organization, SG24-6119
Systems Storage: helps you install, tailor, and configure the ESS when you attach Compaq
Compaq AlphaServer, AlphaServer (running Tru64 UNIX), HP, and Sun hosts. This book does not
HP, and Sun cover Compaq AlphaServer that is running the OpenVMS operating
system. This book also focuses on the settings that are required to give
optimal performance and on the settings for device driver levels. This book
is for the experienced UNIX professional who has a broad understanding of
storage concepts.
Fibre-channel This publication tells you how to attach the IBM xSeries 430 and NUMA-Q No order
Subsystem Installation host systems with fibre-channel adapters to the ESS. number
Guide
Contact your sales representative to obtain this publication.

xvi ESS API Reference

 Order
Title Description
Number
IBM TotalStorage ESS This publication, from the IBM International Technical Support Organization, SG24-5757
Implementing Copy tells you how to install, customize, and configure ESS Copy Services on
Services in an Open UNIX, Windows NT, or Windows 2000 host systems. The Copy Services
Environment functions that are described include peer-to-peer remote copy and
FlashCopy. This publication describes the functions and shows you how to
implement them into your environment. It also shows you how to
implement these functions in a high-availability cluster multiprocessing
environment.
Implementing Fibre This publication, from the IBM International Technical Support Organization, SG24-6113
Channel Attachment on helps you install, tailor, and configure fibre-channel attachment of
the ESS open-systems hosts to the ESS. It gives you a broad understanding of the
procedures that are involved and describes the prerequisites and
requirements. It also shows you how to implement fibre-channel
attachment. This book also describes the steps that are required to migrate
to direct fibre-channel attachment from native SCSI adapters and from
fibre-channel attachment through the SAN Data Gateway.
S/390 and zSeries hosts
Device Support This publication describes the IBM Device Support Facilities (ICKDSF) GC35-0033
Facilities: User’s Guide product that are used with IBM direct access storage device (DASD)
and Reference subsystems. ICKDSF is a program that you can use to perform functions
that are needed for the installation, the use, and the maintenance of IBM
DASD. You can also use it to perform service functions, error detection,
and media maintenance.
z/OS Advanced Copy This publication helps you understand and use IBM Advanced Copy SC35-0428
Services Services functions. It describes three dynamic copy functions and several
point-in-time copy functions. These functions provide backup and recovery
of data if a disaster occurs to your data center. The dynamic copy functions
are peer-to-peer remote copy, extended remote copy, and coupled
extended remote copy. Collectively, these functions are known as remote
copy. FlashCopy, SnapShot, and concurrent copy are the point-in-time copy
functions.
DFSMS/MVS V1: This publication provides guidelines for using remote copy functions with SC35-0169
Remote Copy Guide and S/390 and zSeries hosts.
Reference
ESA/390: ESCON I/O This publication provides a description of the physical and logical ESA/390 SA22-7202
Interface I/O interface and the protocols that govern information transfer over that
interface. It is intended for designers of programs and equipment
associated with the ESCON I/O interface and for service personnel who
maintain that equipment. However, anyone concerned with the functional
details of the ESCON I/O interface will find it useful.
Fibre Transport Services This publication provides information about fibre-optic and ESCON-trunking GA22-7234
(FTS): Physical and systems.
Configuration Planning
Guide
Implementing ESS Copy This publication, from the IBM International Technical Support Organization, SG24-5680
Services on S/390 tells you how to install, customize, and configure Copy Services on an ESS
that is attached to an S/390 or zSeries host system. Copy Services
functions include Peer-to-Peer Remote Copy, Extended Remote Copy,
FlashCopy, and Concurrent Copy. This publication describes the functions,
prerequisites, and corequisites and describes how to implement each
function into your environment.

About this guide xvii

 Order
Title Description
Number
ES/9000, ES/3090: This publication describes the Input/Output Configuration Program that GC38-0097
IOCP User Guide supports the Enterprise Systems Connection (ESCON) architecture. It
Volume A04 describes how to define, install, and configure the channels or channel
paths, control units, and I/O devices on the ES/9000 processors and the
IBM ES/3090 Processor Complex.
IOCP User’s Guide, IBM This publication describes the Input/Output Configuration Program that SB10-7029
Eserver zSeries 800 supports the zSeries 800 and 900 servers. This publication is available in
and 900 PDF format by accessing ResourceLink at the following Web site:

www.ibm.com/servers/resourcelink/
IOCP User’s Guide, IBM This publication describes the Input/Output Configuration Program that SB10-7037
Eserver zSeries supports the zSeries server. This publication is available in PDF format by
accessing ResourceLink at the following Web site:

www.ibm.com/servers/resourcelink/
S/390: Input/Output This publication describes the Input/Output Configuration Program that GC38-0401
Configuration Program supports ESCON architecture and the ESCON multiple image facility.
User’s Guide and
ESCON
Channel-to-Channel
Reference
IBM z/OS Hardware This guide provides conceptual and procedural information to help you use SC33-7988
Configuration Definition the z/OS Hardware Configuration Definition (HCD) application. It also
User’s Guide explains:
v How to migrate existing IOCP/MVSCP definitions
v How to use HCD to dynamically activate a new configuration
v How to resolve problems in conjunction with MVS/ESA HCD
OS/390: Hardware This guide provides detailed information about the input/output definition SC28-1848
Configuration Definition file and about how to configure parallel access volumes. This guide
User’s Guide discusses how to use Hardware Configuration Definition for both OS/390®
and z/OS V1R1.
OS/390 V2R10.0: MVS This publication lists OS/390 MVS™ system messages ABA to ASA. GC28-1784
System Messages
Volume 1 (ABA - ASA)
Using IBM 3390 Direct This publication provides device-specific information for the various models GG26-4575
Access Storage in a VM of the 3390 and describes methods you can use to manage storage
Environment efficiently using the VM operating system. It provides guidance on
managing system performance, availability, and space through effective
use of the direct access storage subsystem.
Using IBM 3390 Direct This publication helps you use the 3390 in a VSE environment. It includes GC26-4576
Access Storage in a planning information for adding new 3390 units and instructions for
VSE Environment installing devices, migrating data, and performing ongoing storage
management activities.
Using IBM 3390 Direct This publication helps you use the 3390 in an MVS environment. It GC26-4574
Access Storage in an includes device-specific information for the various models of the 3390 and
MVS Environment illustrates techniques for more efficient storage management. It also offers
guidance on managing system performance, availability, and space
utilization through effective use of the direct access storage subsystem.
z/Architecture Principles This publication provides a detailed definition of the z/Architecture™. It is SA22-7832
of Operation written as a reference for use primarily by assembler language
programmers and describes each function at the level of detail needed to
prepare an assembler language program that relies on a particular
function. However, anyone concerned with the functional details of
z/Architecture will find this publication useful.

xviii ESS API Reference

 Order
Title Description
Number
SAN
IBM OS/390 Hardware This guide explains how to use the Hardware Configuration Data SC28-1848
Configuration Definition application to perform the following tasks:
User’s Guide v Define new hardware configurations
v View and modify existing hardware configurations
v Activate configurations
v Query supported hardware
v Maintain input/output definition files (IODFs)
v Compare two IODFs or compare an IODF with an actual configuration
v Print reports of configurations
v Create graphical reports of a configuration
v Migrate existing configuration data
IBM SAN Fibre Channel This guide explains how to convert the IBM SAN Fibre Channel Managed SY27–7616
Managed Hub: 3534 Hub from a Fibre-Channel Arbitrated Loop (FC-AL) configuration to a
Service Guide fabric-capable switched environment.
IBM SAN Fibre Channel This guide provides an overview of the product and discussed the features GC26-7391
Managed Hub: 3534 and upgrades available. It also tells you how to install the hub, how to
User’s Guide manage and monitor it using zoning, and how to manage it remotely. It also
tells you how to use the IBM 3534 SAN Fibre Channel Managed Hub
TotalStorage ESS Specialist.
IBM SAN Fibre Channel This guide describes how to install and maintain the IBM SAN Fibre SC26-7350
Switch: 2109 Model S08 Channel Switch 2109 Model S08.
Installation and Service
Guide
IBM SAN Fibre Channel This guide describes the IBM SAN Fibre Channel Switch and the IBM SC26-7349
Switch: 2109 Model S08 TotalStorage ESS Specialist. It provides information about the commands
User’s Guide and how to manage the switch with Telnet and the Simple Network
Management Protocol (SNMP).
IBM SAN Fibre Channel This publication describes how to install and maintain the IBM SAN Fibre SC26-7352
Switch: 2109 Model S16 Channel Switch 2109 Model S16. It is intended for trained service
Installation and Service representatives and service providers.
Guide
IBM SAN Fibre Channel This guide introduces the IBM SAN Fibre Channel Switch 2109 Model S16 SC26-7351
Switch: 2109 Model S16 and tells you how to manage and monitor the switch using zoning and how
User’s Guide to manage the switch remotely.
Implementing Fibre This publication, from the IBM International Technical Support Organization, SG24-6113
Channel Attachment on helps you install, tailor, and configure fibre-channel attachment of
the ESS open-systems hosts to the ESS. It provides you with a broad
understanding of the procedures that are involved and describes the
prerequisites and requirements. It also shows you how to implement
fibre-channel attachment. This book also describes the steps required to
migrate to direct fibre-channel attachment from native SCSI adapters and
from fibre-channel attachment through the SAN Data Gateway.
Seascape family
IBM Enterprise Storage This publication, from the IBM International Technical Support Organization, SG24-5465
Server introduces the ESS and provides an understanding of its benefits. It also
describes in detail the architecture, hardware, and functions, including the
advanced copy functions, of the ESS.

About this guide xix

 Order
Title Description
Number
IBM Enterprise Storage This guide, from the IBM International Technical Support Organization, SG24-5656
Server Performance provides guidance on the best way to configure, monitor, and manage your
Monitoring and Tuning ESS to ensure optimum performance.
Guide
IBM Versatile Storage This publication introduces the IBM Versatile Storage Server™ and lists the GC26-7223
Server: Introduction and features you can order. It also provides planning information for both 2105
Planning Guide Models B09 and 100.
Implementing the IBM This publication, from the IBM International Technical Support Organization, SG24-5420
Enterprise Storage can help you install, tailor, and configure the ESS in your environment.
Server in Your
Environment
Storage management
Device Support This publication describes the IBM Device Support Facilities (ICKDSF) GC35-0033
Facilities: User’s Guide product used with IBM direct access storage device (DASD) subsystems.
and Reference ICKDSF is a program that you can use to perform functions that are
needed for the installation, the use, and the maintenance of IBM DASD.
You can also use it to perform service functions, error detection, and media
maintenance.
IBM TotalStorage This handbook, from the IBM International Technical Support Organization, SG24-5250
Solutions Handbook helps you understand what makes up enterprise storage management. The
concepts include the key technologies that you must know and the IBM
subsystems, software, and solutions that are available today. It also
provides guidelines for implementing various enterprise storage
administration tasks so that you can establish your own enterprise storage
management environment.
IBM TotalStorage Expert: This guide, from the IBM International Technical Support Organization, SG24-6102
Hands-On Usage Guide helps you install, tailor, configure, and use TotalStorage ESS Expert.
IBM TotalStorage Expert This guide helps you install the IBM TotalStorage Expert (formerly the IBM GC26-7436
Installation Guide StorWatch Expert) program. The IBM TotalStorage Expert provides asset,
capacity, and performance management information for disk and tape
storage systems.
Using IBM 3390 Direct This publication provides device-specific information for the various models GG26-4575
Access Storage in a VM of the 3390 and describes methods that you can use to manage storage
Environment efficiently using the VM operating system. It provides guidance for
managing system performance, availability, and space through effective
use of the direct access storage subsystem.
Using IBM 3390 Direct This publication helps you use the 3390 in a VSE environment. It includes GC26-4576
Access Storage in a planning information for adding new 3390 units and instructions for
VSE Environment installing devices, migrating data, and performing ongoing storage
management activities.
Using IBM 3390 Direct This publication helps you use the 3390 in an MVS environment. It GC26-4574
Access Storage in an includes device-specific information for the various models of the 3390 and
MVS Environment illustrates techniques for more efficient storage management. It also offers
guidance for managing system performance, availability, and space use
through effective use of the direct access storage subsystem.

Ordering IBM publications

This section tells you how to order copies of IBM publications and how to set up a
profile to receive notifications about new or changed publications.

xx ESS API Reference

 IBM publications center
The publications center is a worldwide central repository for IBM product
publications and marketing material.

The IBM publications center offers customized search functions to help you find the
publications that you need. Some publications are available for you to view or
download free of charge. You can also order publications. The publications center
displays prices in your local currency. You can access the IBM publications center
through the following Web site:

www.ibm.com/shop/publications/order/

Publications notification system

The IBM publications center Web site offers you a notification system for IBM
publications. Register and you can create your own profile of publications that
interest you. The publications notification system sends you a daily e-mail that
contains information about new or revised publications that are based on your
profile.

If you want to subscribe, you can access the publications notification system from
the IBM publications center at the following Web site:

www.ibm.com/shop/publications/order/

Non-IBM publications
Other related publications are not available through IBM ordering systems. To order
them, contact the sales representative at the branch office in your locality.

Title Description
Quick Start Guide: An Example with Network File System This guide tells you how to configure the Veritas Cluster
(NFS) Server. See also the companion document, Veritas
Cluster Server User’s Guide.
Veritas Cluster Server Installation Guide This guide tells you how to install the Veritas Cluster
Server. See also the companion document, Veritas
Cluster Server Release Notes.
Veritas Cluster Server Release Notes These release notes tell you how to install the Veritas
Cluster Server. See also the companion document,
Veritas Cluster Server Installation Guide.
Veritas Cluster Server User’s Guide This guide tells you how to configure the Veritas Cluster
Server. See also the companion document, Quick Start
Guide: An Example with Network File System (NFS).
Veritas Volume Manager Hardware Notes These hardware notes tell you how to implement multiple
paths dynamically.
Veritas Volume Manager Installation Guide This guide tells you how to install VxVM.
Veritas Volume Manager Storage Administrators Guide This guide tells you how to administer and configure the
disk volume groups.

Web sites
The following Web sites provide information about the ESS and other IBM storage
products.

About this guide xxi

Type of Storage Information Web Site
Concurrent Copy for S/390 and http://www.storage.ibm.com/software/sms/sdm/
zSeries host systems
Enterprise Storage Server (ESS) http://www.storage.ibm.com/disk/ess/index.html?/ess.htm
ESS Copy Services command-line http://www-1.ibm.com/servers/storage/support/software/cscli.html
interface (CLI)
ESS publications http://www-1.ibm.com/servers/storage/support/disk/2105.html

Click Documentation.
FlashCopy for S/390 and zSeries http://www.storage.ibm.com/software/sms/sdm/
host systems
Host system models, operating http://www-1.ibm.com/servers/storage/support/disk/2105.html
systems, and adapters that the ESS
supports Click Interoperability matrix.
IBM storage products http://www.storage.ibm.com/
IBM version of the Java (JRE) that is http://www-106.ibm.com/developerworks/java/jdk/
often required for IBM products
Multiple Device Manager (MDM) http://www.ibm.com/servers/storage/support/

Click Storage Virtualization.

NUMA-Q host systems http://publib.boulder.ibm.com/xseries/
PPRC for S/390 and zSeries host http://www.storage.ibm.com/software/sms/sdm/
systems
SAN fibre channel switches http://www.ibm.com/storage/fcswitch/
Storage Area Network Gateway and http://www-1.ibm.com/servers/storage/support/san/index.html?
Router
Subsystem Device Driver (SDD) http://www-1.ibm.com/servers/storage/support/software/sdd.html
TotalStorage Expert http://www-1.ibm.com/servers/storage/support/software/swexpert.html
XRC for S/390 and zSeries host http://www.storage.ibm.com/software/sms/sdm/
systems

xxii ESS API Reference

Summary of Changes
This document contains terminology, maintenance, and editorial changes. Technical
changes or additions to the text and illustrations are indicated by a vertical line to
the left of the change. This summary of changes describes new functions that have
been added to this release.

Summary of Changes for GC35-0489-01 IBM TotalStorage Enterprise

Storage Server Application Programming Interface Reference
This document contains information previously presented in IBM TotalStorage
Enterprise Storage Server Application Programming Interface Reference,
GC35-0489-00.

The following sections summarize the changes to that information.

New Information
This edition includes the following new information:
v Asynchronous Peer-to-Peer Remote Copy (PPRC) is supported by the ESS API.
Asynchronous PPRC provides a two-site extended distance remote copy solution
that is suitable for disaster recovery.
v Two FlashCopy withdraw options: commit and revert, are supported by the ESS
API. Withdraw FlashCopy Commit is a feature that makes the FlashCopy relation
no longer revertible, commits the new relation data, updates the FlashCopy
bitmap, and resets source “Write Inhibited”. Withdraw FlashCopy Revert is a
feature that reverts the relation to the state saved by the last Establish Revertible
FlashCopy command and resets source “Write Inhibited”.

Changed Information
No information has changed significantly.

Moved Information
No information has moved.

Deleted Information
No information has been deleted.

© Copyright IBM Corp. 2004 xxiii

xxiv ESS API Reference
 Chapter 1. Introduction
This chapter provides the following information about the IBM TotalStorage
Enterprise Storage Server Application Programming Interface (ESS API), Common
Information Model (CIM) standards, and CIM Agent installation:
v ESS API overview
v CIM Agent overview
v CIM Agent components
v CIM concepts
v ESS CIM Agent installation requirements
v ESS CIM Agent installation methods
v ESS CIM Agent security

ESS API overview

| The ESS API is a nonproprietary storage management client application that
| supports routine LUN management activities, such as LUN creation, mapping and
| masking, and the creation or deletion of RAID5 and RAID10 volume spaces. The
| ESS API also enables Copy Services configuration and use activities, such as
| FlashCopy, with support for Microsoft Volume Shadow Copy Service, PPRC, and
| Asynchronous PPRC. The ESS API supports these activities through the use of the
| Storage Management Initiative Specification (SMIS), as defined by the Storage
| Networking Industry Association (SNIA). For more information about Copy Services
| FlashCopy, PPRC, and Asynchronous PPRC, see IBM TotalStorage Enterprise
| Storage Server: User’s Guide.

The ESS API helps integrate ESS configuration management support into storage
resource management (SRM) applications, which allow customers to benefit from
existing SRM applications and infrastructures. The ESS API also enables the
automation of configuration management through customer-written applications.
Either way, the ESS API presents another option for managing ESSs by
complementing the use of the IBM TotalStorage Enterprise Storage Server
Specialist web-based interface, the ESS command-line interface, and the Copy
Services command-line interface.

You must implement the ESS API through the IBM TotalStorage Common
Information Model Agent (CIM Agent), a middleware application that provides a
CIM-compliant interface. The ESS API uses the CIM technology to manage
proprietary devices as open system devices through storage management
applications. The ESS API allows these storage management applications to
communicate with an ESS.

The CIM Agent is available for the AIX, Linux, and Windows 2000, or later,
operating system environments. The ESS API must be used on ESSs with Fibre
ports.

Related topics:
v Appendix D, “ESS API support for Microsoft Volume Shadow Copy Service for
Windows,” on page 241

© Copyright IBM Corp. 2004 1

 CIM Agent overview
A Common Information Model (CIM) Agent provides a means by which a device can
be managed by common building blocks rather than proprietary software. If a
device is CIM-compliant, software that is also CIM-compliant can manage the
device. Vendor applications can benefit from adopting the common information
model because they can manage CIM-compliant devices in a common way, rather
than using device-specific programming interfaces. Using CIM, you can perform
tasks in a consistent manner across devices and vendor applications.

A CIM agent consists of the components shown in Figure 1. The main components
are the CIM object manager (CIMOM), the service location protocol (SLP) and the
device provider. A device can be a storage server such as your IBM Enterprise
Storage Server (ESS). The CIM Agent registers itself with SLP to enable discovery
by the Client application. The SLP is a directory service that a client application
calls to locate the CIM Object Manager. The client application and the CIMOM
communicate through CIM Messages. The CIMOM and device provider
communicate through method calls made from the CIMOM to the provider. The
device provider communicates with the device through proprietary calls.

Client
Application

SLP
CIMMessages encoded
within XML

CIMOM

CIM Agent
Method calls made from
CIMOM to Provider

Device Provider

Proprietary calls

Device

Figure 1. How a CIM Agent works

The CIMOM supports the following specifications and standards:

v Distributed Management Task Force (DMTF) Specification for CIM Operations
over HTTP, Version 1.0
For more information about the DMTF Specification, visit the following Web site:
| http://www.dmtf.org/standards/documents/WBEM/dsp200.html
v Common Information Model (CIM) Specification, Version 2.2

2 ESS API Reference

 For more information about CIM Specification and CIM standards, visit the
following Web site:
| http://www.dmtf.org/standards/cim
v Storage Networking Industry Association (SNIA) Storage Management Initiative
(SMI) Specification and the Shared Storage Model, a framework for describing
storage architectures (a white paper from the SNIA Technical Council)
For more information about SNIA, visit the following Web site:
http://www.snia.org/home

Note: You can access the white paper and other SNIA reports from this Web
site. Contact SNIA regarding access to the specification.
Conformance to these specifications allows a CIM Agent to act as an open-system
standards interpreter, allowing other CIM-compliant storage resource management
applications (IBM and non-IBM) to interoperate with each other.

When you have installed, configured, and enabled the CIM Agent on a host server
or an administrator’s workstation within your network, that host server or workstation
can communicate with your ESS through the CIM Agent. This allows CIM-compliant
applications like the ESS API to manage the data on your ESS. See the appendixes
to this guide for reference information about the ESS API.

CIM Agent components

The following list describes the components of a CIM Agent:
client application A storage management API that initiates a request
to a device or a data storage server such as an
ESS
CIM Agent An agent that interprets open-system data as it is
transferred between the API and a device or a
storage server.
service location protocol (SLP)
A directory service that a client application calls to
locate the CIM Object Manager.
CIM object manager (CIMOM)
A common conceptual framework for data
management. Receives, validates, and
authenticates client application requests, then
directs requests to the appropriate functional
component or to a device provider.
device provider A device-specific handler that receives client
application requests that are destined for its device
or storage server.
device (also known as a storage server or an ESS)
The final destination of a client application request,
and the processor of the request.

Chapter 1. Introduction 3
 CIM concepts
The common information model (CIM) is an open approach to the management of
systems and networks. The CIM provides a common conceptual framework
applicable to all areas of management including systems, applications, databases,
networks, and devices. The CIM specification provides the language and the
methodology used to describe management data.

The CIM defines a set of classes with properties and associations which in turn
provide a conceptual framework. The framework enables the organization of data
for a specific managed environment, such as data storage. CIM Schema 2.7 for
Managing a Storage Array, provides information about enabling management
applications to manage data in a common way. For more information about the CIM
specifications and standards visit the following Web site:
| http://www.dmtf.org/standards/cim

The CIM standards and the DMTF specification provide information about
Web-based enterprise management (WBEM) operations over HTTP. For additional
information about CIM operations over HTTP, visit the following Web site:
| http://www.dmtf.org/standards/documents/WBEM/dsp200.html

A client application finds the location of the CIMOM by calling an SLP directory
service. When the CIMOM first starts, it registers itself to the SLP and provides
information about its location (IP address and port) and the type of service it
provides. After obtaining this information, the client application opens direct
communication with the CIMOM.

A client sends requests to a CIMOM in the context of a CIM model. The model is
defined by the CIM schema and loaded into the repository of the CIMOM. Figure 2
shows how the schema is loaded into the data store of the CIMOM. The managed
object format (MOF) compilation and creation of the data store is handled
automatically during installation.

As requests arrive, the CIMOM validates and authenticates each request. Requests
are either directed to the appropriate functional component of the CIMOM or
directed to a device-specific handler called a provider.

Figure 2. The MOF compiler stores the model in the CIMOM data store.

4 ESS API Reference

 A provider makes device-unique programming interface calls on behalf of the
CIMOM to satisfy a client application request. Such requests generally map a CIM
request to the propriety programming interface for a device. A request to get an
instance of a class or a property of an instance, for example, might be directed to a
Provider and a Provider might make one or many requests of a device using the
unique API for the device. Figure 1 on page 2 shows the communication protocol
between the device and the client application.

ESS CIM Agent installation requirements

Ensure that your system satisfies the following prerequisites for installing the ESS
CIM Agent on a Windows 2000 or later, AIX, or Linux operating system before
starting the installation.
v You must install the ESS command-line interface (CLI) on your operating system
before you install the ESS CIM Agent.
ESS CLI installation is unique for each operating system. See the appropriate
chapter in this publication for the instructions for installing the ESS CLI on your
operating system:
– Chapter 4, “ESS CIM Agent for Windows,” on page 59
– Chapter 2, “CIM Agent on AIX,” on page 7
– Chapter 3, “CIM Agent for Linux,” on page 33

Note: All prerequisite software must be installed before you start the installation
of the ESS CIM Agent. The ESS CIM Agent installation program will check
for the existence of the ESS CLI. If the program does not detect the ESS
CLI, the installation of the ESS CIM Agent will not complete successfully.

Hardware
The following hardware is required:
v Personal computer, workstation, or server with Intel® Pentium® III or higher
processor (Linux and Windows only)
v CD-ROM drive
v Video graphics adapter display or better

Workstation space
The following space on your workstation is required:
v 256 megabytes (MB) of random-access memory (RAM) minimum depending on
your system configuration
v 1 gigabyte disk space minimum

Note: You might need to increase the total available disk space on your hard
drives if the ESS CIM Agent and other associated products are split
between more than one logical drive. Also, the ESS CIM Agent might
require additional memory to operate if you configure it to manage many
devices or devices with large configurations.
v 1 gigahertz processor speed minimum
v Up to 50 MB of temporary disk space for installation purposes

Chapter 1. Introduction 5
 Software
The following software is required:
v Operating systems:
– Windows 2000 or later
– AIX 5.1 or later
| – Linux RedHat 7.2 and later
v ESS CLI level 2.3.0.13. This software is on the ESS CLI CD.
v Common Information Model (CIM) Agent. This software is on the CIM Agent for
ESS CD.
v Transmission Control Protocol/Internet Protocol (TCP/IP)
v Adobe Acrobat Reader version 4.0 or later
You need the Adobe Acrobat Reader to read License Agreement and product
information from the ESS CIM Agent LaunchPad. You can download the Adobe
Acrobat Reader from the following Web site:
– http://www.adobe.com/support/downloads/main.html

ESS CIM Agent installation methods

You can choose to install the ESS CIM Agent in graphical mode with the help of the
installation Wizard or in unattended mode (also known as silent mode), which
involves customizing a response file and issuing a command. Follow the
instructions in the chapter appropriate for your operating system:
v Chapter 4, “ESS CIM Agent for Windows,” on page 59
v Chapter 2, “CIM Agent on AIX,” on page 7
v Chapter 3, “CIM Agent for Linux,” on page 33

ESS CIM Agent security

The ESS CIM Agent can operate in both secure and unsecure modes.
Secure mode
All requests between the client application and the CIMOM are XML
encoded requests sent over Hypertext Transfer Protocol (HTTP) or HTTP
over Secure Sockets Layer (SSL). The CIMOM, upon receiving a request,
parses the request and processes it. Responses, when they are returned to
the client application, are transformed into XML-encoded CIM status and
returned in HTTP responses to the client. The default of the ESS CIM Agent
is to run in secure mode using SSL.
Unsecure mode
Some vendor software might not be capable of communicating with the
ESS CIM Agent in a secure mode. You can still use this vendor software by
configuring the ESS CIM Agent to run with only basic user name and
password security. See the configuration instructions for your operating
system for the instructions for configuring the ESS CIM Agent for this less
secure mode.

6 ESS API Reference

Chapter 2. CIM Agent on AIX
This chapter includes an overview of the installation process and instructions for
installing and configuring the CIM Agent on an IBM AIX® operating system.

Installation overview for AIX

This section provides an overview and instructions for installing and configuring the
CIM Agent on the AIX operating system. You should have some knowledge of how
to administer AIX operating system before you begin to install the CIM Agent. You
should also become familiar with the command explanations that you use to install
and configure the CIM Agent. See Chapter 5, “CIM Agent installation and
configuration commands,” on page 87 for information about the commands.

The following list of installation and configuration tasks are discussed in the order in
which they should be performed:
1. Before you install the CIM Agent on an AIX operating system, check the
hardware and software requirements listed in “ESS CIM Agent installation
requirements” on page 5.
2. Install the prerequisite ESS CLI 2105 for AIX software as instructed in “Installing
the ESS CLI on AIX.”
Attention: If you are upgrading from a previous version of the ESS CIM Agent,
you must upgrade the ESS CLI software to the new level required which is a
minimum level of 2.3.0.13.
3. You can choose to install the CIM Agent either in graphical mode with the help
of a wizard or in unattended mode (also known as silent mode), which involves
customizing a response file and issuing a command. To mount the CIM Agent
for ESS CD for either mode, perform the instructions in “Mounting the CD on
AIX” on page 9.
a. If you want to install the CIM Agent in graphical mode, perform the
instructions in “Installing the CIM Agent on AIX in graphical mode” on page
10.
b. If you want to install the CIM Agent in unattended mode, perform the
instructions in “Installing the CIM Agent on AIX in unattended (silent) mode”
on page 19.
4. Configure the CIM Agent by performing the instructions in “Configuring the CIM
Agent on AIX” on page 22. You might want to revisit this section in the future as
you add, change, or delete CIMOM authentication and ESS information.
5. Enable the CIM Agent by performing the instructions in “Verifying connection to
the ESS” on page 25.
6. For instructions about removing the CIM Agent, see “Removing the CIM Agent
on AIX” on page 27. You only need to perform this optional task if you get errors
during installation verification or if the CIM Agent did not set the environment
variables.

Installing the ESS CLI on AIX

Before you install the CIM Agent, you must install the ESS CLI. The ESS CLI must
be installed first because the CIM Agent sets the path information in shell scripts for
you based on the location of the ESS CLI. The CIM Agent installation wizard
checks your system for the existence of the ESS CLI and the wizard stops if the
ESS CLI is not installed.

© Copyright IBM Corp. 2004 7

 Steps:

Perform the following steps to install the ESS CLI for AIX:
1. Select the ESS CLI CD.
This ESS CLI CD contains the ESS CLI installation packages and the IBM
TotalStorage Enterprise Storage Server Command-Line Interfaces User’s
Guide.
2. Insert the ESS CLI CD, but do not mount the CD device.
3. Type the following command to list the installation packages:

smitty install_update
4. Select the Install and Update from ALL Available Software option.
5. Use the list command (F4) to list all of the devices and then select the
system’s CD-ROM drive, for example, /dev/cd0 (16 Bit SCSI Multimedia
CD-ROM Drive).
6. When you return to the panel, use the list command (F4) on the “*SOFTWARE
to Install” line to list all the software on the CD-ROM.
7. Select the ibm2105esscli package, which is at the bottom of the list:
@ 2.3.0.13 IBM 2105 ESS Storage Management CLI (Includes the CS CLI)

Attention
There are two packages: ibm2105esscli and ibm2105cli. You must select
and install the ibm2105esscli package. This package contains both the
ESS CLI and the Copy Services CLI. Do not select the ibm2105cli
because this file contains only the Copy Services CLI, not the ESS CLI.

The CIM Agent supports ESS CLI level 2.3.0.13.

8. Follow the installation instructions from the IBM TotalStorage Enterprise

Storage Server Command-Line Interfaces User’s Guide, which can be found
on the IBM TotalStorage Enterprise Storage Server Customer Documents CD
to install the ESS CLI. In this guide, the “ESS CLI” is referred to as the
“Storage Management CLI”.
9. Verify that the ESS CLI is installed.
Type the following command to review the installed programs on your AIX
operating system. The level of the software should be 2.3.0.13 or higher.
# lslpp -l "ibm2105*"

If the ESS CLI is installed, a message similar to the following is displayed.

ibm2105esscli.rte 2.3.0.13 COMMITTED IBM 2105 ESS Storage
Management CLI (Includes the CS CLI)

| 10. Follow the instructions in “Verifying connection to the ESS” on page 25 to

| verify that the ESS CLI has connectivity to your ESS and that the CLI.CFG file
| is set correctly.
11. Verify that the ESS CLI is operational and that all the environment variables
have been set.

8 ESS API Reference

 The ESS CLI does not set the system path. You need to find where the esscli
is installed. If you do not know where the esscli is installed, type the following
command to find out:
# lslpp -f ibm2105esscli.rte | grep esscli

The following example output indicates that the esscli is installed at level
2.3.0.13 in /usr/opt/ibm2105cli.
ibm2105esscli.rte 2.3.0.13 /usr/opt/ibm/ibm2105cli/esscli

Type the following command from a Command Prompt window to see a listing
of the esscli commands:
#/usr/opt/ibm/ibm2105cli/esscli

The following output is an example of a listing of the esscli commands.

Thu Oct 09 11:46:14 PDT 2003 IBM ESSCLI 2.3.0.1

esscli -a AccessFile [-key KeyName] | -u Username -p Password

-s ServerAddress [-b BackupServer]
[-v|-nov] [-hdr|-nohdr] [-ssl|-nossl][-debug|-nodebug]
[-refresh|-norefresh][-fmt "Format"]
Cmnd_Action Cmnd_Category [-d "argument_pairs"]

List of Cmnd_Actions, Cmnd_Categories, and argument_pairs:

==========================================================

DiskGroup Category:
-------------------
list DiskGroup [-d "ess=EssId"]
[-fmt server,dg,loc,raid,width,cap,rpm,dd,status]

....................lines ommitted from sample..........................

WebUserAccount Category:
------------------------
list WebUserAccount [-d "ess=EssId"]
[-fmt user,acclvl,iprange,comments]
create WebUserAccount -d "ess=EssId user=UserId pwd=Password
acclvl=AccessLevel iprange=IPRange comments=’Comments’"
set WebUserAccount -d "ess=EssId user=UserId
(newuser=NewUserId|newpwd=NewPassword|
newacclvl=NewAccessLevel|newiprange=NewIPRange|
newcomments=’NewComments’)*"
delete WebUserAccount -d "ess=EssId user=UserId"

Mounting the CD on AIX

This section provides instructions about how to mount a CD.

Steps:

Perform the following steps to mount the CIM Agent for ESS CD.

Note: You must mount the CIM Agent for ESS CD for both a graphical and
unattended installation.
1. Log on as a user with root authority.

Chapter 2. CIM Agent on AIX 9

 2. Create a mount point or choose an existing mount point.
To create a mount point called /cdrom, type the following command:

# mkdir /cdrom
3. Type the following command to mount the CD file system at the desired mount
point:

# mount -o ro -v cdrfs /dev/cd0 /cdrom

4. Change the current directory to the mount point for the CD drive in the AIX
subdirectory. For example, if the CD was mounted at the /cdrom mount point,
type the following command:

# cd /cdrom/AIX

Installing the CIM Agent on AIX in graphical mode

This section includes the steps to install the CIM Agent in your AIX environment
using the graphical mode. You must comply with all prerequisites listed in “ESS CIM
Agent installation requirements” on page 5 before you start the installation.

You can choose to install the CIM Agent in graphical mode with the help of an
installation wizard or in unattended (silent) mode, which involves customizing a
response file and issuing a command. If you want to install the CIM Agent in
unattended mode, see “Installing the CIM Agent on AIX in unattended (silent) mode”
on page 19, otherwise continue with this section. After the completion of either kind
of installation, you will then verify the installation of the CIM Agent in section,
“Verifying the CIM Agent installation on AIX” on page 21. Before you install the CIM
Agent on AIX, you should check the hardware and software requirements listed in
“ESS CIM Agent installation requirements” on page 5.

Steps:

This task will assist you with the installation of the CIM Agent in your AIX
environment using the graphical mode.

Perform the following steps to install the CIM Agent on your AIX operating system:
1. Log on as a user with root authority.
2. You can run the wizard from either the main console or from a remote X server.
If you run it from a remote X server, perform the following steps prior to running
the wizard:
a. Set the DISPLAY variable to hostname:displaynumber.screennumber
where:
hostname
The host name of the platform on which the X server runs and from
which the wizard starts.
displaynumber
Use the number 0 if X server controls more than one keyboard and
monitor unit, for instance, a network of X terminals.
screennumber
This specifies which monitor to use in a multiple monitor setup.
<hostname>:<displaynumber.screennumber>

10 ESS API Reference

 Note: If you logged on as a root user from the AIX main console, you do
not need to perform the next two substeps because the correct
settings are automatically set. However, if you did not log on as a
root user, you will need to manually specify these settings under the
following circumstances:
1) If you log on as a nonroot user, switch to the root user
(depending on the profile of the root user).
2) If you log on using another computer (another UNIX machine or a
PC running an X emulator), referred to as an X server, you must
properly set the DISPLAY environment variable. An X server is a
graphical machine that is acting as a graphical terminal for a
UNIX (in this case AIX) computer through a special protocol. The
application running on the AIX operating system must know the
host name (or IP address), display and screen number (normally
0) of the machine acting as the X server. You make this
information available to the application setting the DISPLAY
environment variable (the command for this is:

export DISPLAY=x_server_hostname:displaynumber.screennumber

The X server (if it is a UNIX machine) must be configured to

allow clients running on remote hosts to access it, using the
xhost command. The form, xhost +, enables any graphical
application running on any machine to use the X server. Or you
can use a more restrictive command, such as xhost
aix_name_or_ip, instead.
b. Run the following command to enable any graphical application running on
any host to make connections to the X server.
# xhost +

3. The CIM Agent installation in graphical mode begins with a LaunchPad facility to
launch the installation program wizard. The LaunchPad facility provides links for
you to view various text files, such as the product overview, product readme,
post installation tasks, and various Adobe Acrobat files, such as the Installation
guide, product license agreement, and a browser link to the IBM storage
product technical support page.
The Installation guide and license agreement are in Adobe Acrobat file format
(.pdf). In order for the LaunchPad to provide links to the Adobe Acrobat files,
your system must have Adobe Acrobat Reader installed. In order for the
browser to link to the IBM storage product technical support page, you must
have a browser installed on your system where you start the LaunchPad facility.
If you wish to use the LaunchPad facility links to view the Adobe Acrobat files,
you must have the Adobe Acrobat Reader bin location in your PATH
environment variable. You can verify this by running the following command:

echo $PATH

Locate the Adobe Acrobat Reader bin location in the PATH, for example,
usr/lpp/Acrobat5/bin. If the Adobe Acrobat Reader bin location is not in the
environment path, you can set it by typing the following command:

export PATH=$PATH:/usr/lpp/Acrobat5/bin

Chapter 2. CIM Agent on AIX 11

 where /usr/lpp/Acrobat5/bin is the location of the Adobe Acrobat Reader bin
directory.
4. Run the wizard launcher, launchpad_aix, from the AIX directory of the CD by
typing the following command:
# ./launchpad_aix

This will start the CIM Agent LaunchPad, a small program that launches the
wizard.
5. Choose from the following options in the LaunchPad window:
CIM Agent overview
Offers information about the CIM Agent.
Readme file
Offers any last minute product information that did not make it into this
installation guide.
Installation guide
Offers instructions on how to install the CIM Agent.
License Agreement
Offers information about the license of the CIM Agent.
CIM Agent Web site
Offers information from the product Web site.
Installation wizard
Starts the CIM Agent installation program.
Post installation tasks
Offers information about configuring the users and device
communications.
Exit Exits the LaunchPad program.
The LaunchPad window remains open (behind the wizard) during the
installation. You can access product information after the installation has started.
The LaunchPad returns to the foreground when the installation is complete. You
can click Exit to close the LaunchPad.

12 ESS API Reference

Figure 3. LaunchPad window

6. Check the readme file by clicking the Readme file on the LaunchPad window or
by viewing the README.aix file located in the AIX directory on the CIM Agent
installation CD. The readme file might provide additional information that
supersedes information in this guide.
You can also find this installation guide on the CIM Agent CD under the file
name installguide.pdf in the doc subdirectory.
7. Click Installation wizard to start the installation program.
8. The Welcome window text suggests which documentation to review prior to
installation. Click Next to continue or Cancel to exit.

Chapter 2. CIM Agent on AIX 13

 9. Read the license agreement. Click either I accept the terms of the license
agreement and click Next to proceed, or click I do not accept the terms of
the license agreement and click Cancel to cancel the installation.

10. The Product Installation Check window opens and the wizard verifies that
your machine meets the installation requirements.
v If you have a service location protocol (SLP) daemon that is different from
the SLP that the CIM Agent requires, the wizard displays an error and asks
you to stop the installation and remove this SLP daemon from the system.

14 ESS API Reference

 v The wizard checks if the ESS CLI client is installed on your machine.
v The wizard checks if a version of the CIM Agent is already installed. If the
CIM Agent is installed, it checks if the SLP daemon and the IBM CIM Object
Manager (CIMOM) daemon is started. If these daemons are started and you
want to continue the installation program, select the Next button. Or, if you
want to exit the installation program, select the Cancel button. If you choose
to continue with the installation, you must stop all of the processes and
dependent applications that use these daemons. You can save the old
configuration settings (for example, user names, passwords, and device IP
addresses) by selecting the check box that you see on the window.

11. The Destination Directory window opens. Click Next to accept the default
directory, or click Browse to select a different directory for installation and then
click Next.

Chapter 2. CIM Agent on AIX 15

 Notes:
a. The Destination Directory window is displayed only if the CIM Agent is not
already installed. Otherwise, the CIM Agent will be reinstalled or upgraded
to the same install location.
b. If the wizard detects insufficient space for the CIM Agent in the file system
containing the chosen directory, you can perform one of the following steps:
1) Free some space in that directory and then click Next, or
2) Click Cancel to exit the wizard, free some space in that filesystem, and
then restart the wizard, or
3) Click Back and choose another filesystem for the product.
12. The Updating CIMOM Port window opens. Click Next to accept the default
port. If the default port is the same as another port already in use, modify the
default port and click Next. Use the following command to check which ports
are in use:

netstat -a

Or, click Cancel to exit the wizard.

16 ESS API Reference

13. The Installation Confirmation window opens. Click Install to confirm the
installation directory and file size. Or, click Cancel to exit the wizard.

14. The Installation Progress window opens indicating how much of the installation
has been completed. Installation usually takes 3 - 10 minutes depending on
your machine configuration. If you do not want to continue with the installation,
click Cancel to exit.

Chapter 2. CIM Agent on AIX 17

 15. The Finish window opens and notifies you whether the installation was
successful. Check the View post installation tasks check box if you want to
continue with post installation tasks when the wizard closes. Click Finish to
exit the wizard. You can view the installation log under <des-
path>/logs/install.log, where <des-path> is your destination directory.

16. Exit the LaunchPad program by clicking Exit on the LaunchPad window. If you
have not done so already, continue with the post installation tasks for the ESS

18 ESS API Reference

 CIM Agent in the following sections. “Verifying the CIM Agent installation on
AIX” on page 21 is the next task. You can also continue the post installation
tasks using the following option:
a. Click Post installation tasks on the LaunchPad window.
b. Continue with the post installation tasks for the ESS CIM Agent by
following the instructions in this file.

Related topics:
v “Verifying the CIM Agent installation on AIX” on page 21
v “Installing the CIM Agent on AIX in unattended (silent) mode”
v “Removing the CIM Agent on AIX” on page 27

Installing the CIM Agent on AIX in unattended (silent) mode

This section includes the steps to install the CIM Agent in your AIX environment
using the unattended (silent) mode. You must comply with all prerequisites listed in
“ESS CIM Agent installation requirements” on page 5 before you start the
installation.

You can choose to install the CIM Agent in unattended (silent) mode, which involves
customizing a response file and issuing a command or in graphical mode with the
help of an installation wizard. If you want to install the CIM Agent in graphical mode,
see “Installing the CIM Agent on AIX in graphical mode” on page 10, otherwise
continue with this section. After the completion of either kind of installation, you will
then verify the installation of the CIM Agent in section, “Verifying the CIM Agent
installation on AIX” on page 21.

Context:

The unattended (silent) installation capability enables you to run an installation

process unattended. You can create a standard response file to ensure that the
product is installed consistently on multiple systems. The responsefile file is a
template located on the CIM Agent CD that you must copy to disk and modify. To
use the silent mode installation method, you will be performing the following tasks:
1. Find the responsefile file template on the CIM Agent installation compact disk.
2. Copy the responsefile template to your hard disk drive.
3. Customize the responsefile file to your specifications.
4. Save the updated responsefile file.
5. Invoke the response file using the setupaix script.

Steps:

Perform the following steps to install the CIM Agent in your AIX environment using
the unattended (silent) mode:
1. Log on as a user with root authority.
2. Locate the responsefile file on your CIM Agent for ESS CD.
3. Retrieve and copy the responsefile file to your hard disk drive by typing the
following commands:

# mkdir /tmp/cimagent
# cp -p /cdrom/AIX/responsefile /tmp/cimagent

where /tmp/cimagent is your desired directory.

Chapter 2. CIM Agent on AIX 19

 You must also modify the responsefile with your desired CIM Agent destination
directory (<dest-path>).
4. To change the permissions on the responsefile so you can edit and save it to
disk, type the following command:

chmod 777 /xxxx/responsefile

where xxxx is your desired directory.

5. Customize the responsefile file with your parameters as follows:
Using a text editor, modify the default options in the responsefile file with your
desired values in a text editor such as vi:
v If you do not want to use the default value, remove the # character from the
beginning of the line. Change the default value to the value that you want for
that option. You must enclose all values in double quotation marks (“ ”).
v The <product.installLocation> option is used to define the default directory
where the product will be installed. To use another destination directory,
remove the # character from the corresponding line and replace this default
directory with the desired directory.
v The <-G checkPrerequisite> option enables checking the prerequisites. To
disable checking the prerequisites, remove the # character from the
corresponding line and change its option’s value to “no”.
v The <-G startUpgrade> option enables the installation of CIM Agent over a
previous installation of CIM Agent having the same version (reinstall) or lower
version (upgrade). To do this, remove the # character from the corresponding
line and change its option’s value to “yes”.
v The <-G stopProcessesResponse> option tells the install program whether to
automatically stop SLP and CIM Agent daemons when you are reinstalling or
upgrading the product. By default this option is set to “no”. If you do not
change this default value, the reinstallation or upgrade ends when these
daemons are running. To automatically stop the SLP and CIMOM, remove the
# character from the corresponding line and change its value to “yes”.
v The <-G saveConfiguration> option specifies whether you to save the
configuration settings (for example, user names, passwords, and device IP
addresses) when you are reinstalling or upgrading the product. If you do not
want to save the configuration settings, remove the # character from the
corresponding line and change the value of the option to “no”.
v The <-W cimObjectManagerPorts.port> option specifies the ESS CIM Agent
server port. If you want to change the default value during installation,
remove the # character from the corresponding line and change the default
port value (5989) with the desired port value.
v The <-W cimObjectManagerPorts.serverCommunication> option specifies the
ESS CIM Agent server communication protocol. If you want to change the
default value during installation, remove the # character from the
corresponding line and change the default server communication protocol
(HTTPS) with HTTP protocol.
6. Save the modified responsefile file in your desired directory.
7. Type the following command to run the install file:

# ./setupaix -options <responsefile-path>/responsefile

Note: <responsefile-path> is the path of the responsefile file.

8. Wait for the wizard to complete the installation.

20 ESS API Reference

 9. Check for installation errors in the install.log file. This file can be found in the
<dest-path>/logs directory. Your install.log file should look similar to the following
install.log file:
(Oct 13, 2003 10:32:25 AM), This summary log is an overview of the sequence of the
installation of the IBM TotalStorage CIM Agent for ESS V1R2 1.2.0.1
(Oct 13, 2003 10:32:29 AM), Checking AIX operating system level.
(Oct 13, 2003 10:32:29 AM), AIX level required:5.1.0.0; AIX level detected:5.1.0.0.
(Oct 13, 2003 10:32:44 AM), IBM TotalStorage CIM Agent for ESS V1R2 installation
process started with the following install parameters:
Target Directory: /opt/IBM/cimagent
(Oct 13, 2003 10:32:50 AM), Copying Service Location Protocol Files ...
(Oct 13, 2003 10:32:51 AM), Copying CIM Object Manager Files ...
(Oct 13, 2003 10:33:27 AM), IBM CIM Object Manager - ESS port successfully updated.
(Oct 13, 2003 10:33:27 AM), IBM CIM Object Manager - ESS communication protocol
successfully updated.
(Oct 13, 2003 10:33:27 AM), The file setupCmdLine successfully updated.
(Oct 13, 2003 10:33:27 AM), Compile MOF files started ...
(Oct 13, 2003 10:35:27 AM), MOF files successfully compiled.
(Oct 13, 2003 10:35:27 AM), Generate a certificate store started ...
(Oct 13, 2003 10:35:50 AM), Certificate store called truststore successfully generated.
(Oct 13, 2003 10:35:50 AM), Updating the Software Vital Product Data.
This action will take several minutes. Please wait...
(Oct 13, 2003 10:36:50 AM), The following services started successfully:
Service Location Protocol
IBM CIM Object Manager - ESS
(Oct 13, 2003 10:36:50 AM), INSTSUCC: The IBM TotalStorage CIM Agent for ESS V1R2 has
been successfully installed.

Note: If the installation fails before the target <dest-path> directory is created,
you can find the temporary log in /tmp/cimagent/install.log.
10. Close the command prompt window by entering a command, for example exit.
Continue with the post installation tasks for the ESS CIM Agent in the following
sections. “Verifying the CIM Agent installation on AIX” is the next task. You can
also continue the post installation tasks using the following option:
a. Open the LaunchPad from the AIX directory of the CIM Agent for ESS CD
by typing # ./launchpad_aix.
b. Click Post installation tasks on the LaunchPad window. Continue with the
post installation tasks for the ESS CIM Agent by following the instructions
in this file.

Related topics:
v “Verifying the CIM Agent installation on AIX”
v “Installing the CIM Agent on AIX in graphical mode” on page 10
v “Configuring the CIM Agent on AIX” on page 22
v “Removing the CIM Agent on AIX” on page 27

Verifying the CIM Agent installation on AIX

This section includes the steps necessary to verify that your CIM Agent is installed
correctly on your AIX operating system.

Steps:

Perform the following steps to verify your CIM Agent installation:

1. Verify the installation of the service location protocol (SLP).
a. Open a Command Prompt window and type the following command to verify
that SLP is started:
# ps -ef | grep slpd

Chapter 2. CIM Agent on AIX 21

 If the SLP daemon is started, the following output is displayed:
root 26438 26986 0 12:36:44 pts/3 0:00 grep slpd
daemon 20730 1 0 12:51:47 - 0:00 /opt/IBM/cimagent/slp/slpd

2. Verify the installation of the CIM Agent.

a. Check that the CIMOM daemon is installed and started by typing the
following command:
# ps -ef | grep CIMOM
The following is a sample output:
root 32518 1 0 15:52:05 - 0:08 /opt/IBM/cimagent/ibmjava131
/jre/bin/java -Xms128m -Xmx256m -cp /opt/IBM/cimagent/lib/xml4j-4_0_5/xercesImpl.
jar:/opt/IBM/cimagent/lib/xml4j-4_0_5/xmlParserAPIs.jar:/opt/IBM/cimagent/
ibmjava131/jre/lib/ext/ibmjsse.jar:/opt/IBM/cimagent/lib/JCE/IBMJCEfw.jar:/opt/IBM/
cimagent/lib/JCE/IBMJCEProvider.jar:/opt/IBM/cimagent/lib/JCE/local_policy.jar:/opt
/IBM/cimagent/lib/JCE/US_export_policy.jar:/opt/IBM/cimagent/lib/JCE/ibmpkcs.jar:
/opt/IBM/cimagent/ibmjava131/jre/lib/rt.jar:/opt/IBM/cimagent/ibmica.jar
com.ibm.cimom.CIMOM
root 28838 23968 0 15:57:21 pts/0 0:00 grep cimom

3. Start the CIMOM, if it is not started, by typing the following command:

# <dest-path>/startcimom

where <dest-path> is the destination directory where the CIM Agent is installed.
4. When you are finished with the CIM Agent CD, you can release the CD with the
umount command, for example,

Note: If you are currently residing in /cdrom/AIX, you must exit out of the
/cdrom directory by typing cd /. You will not be able to unmount the CD if
you are residing in /cdrom/AIX.

# umount /dev/cd0
# umount /cdrom

Result:

If you are able to perform all of the verification tasks successfully, then the CIM
Agent has been successfully installed on your AIX operating system.

Related topics:
v “Configuring the CIM Agent on AIX”

Configuring the CIM Agent on AIX

This section includes the steps to configure the CIM Agent after it has been
successfully installed.

Context:

This task is performed after successful installation of the CIM Agent. This
installation program performs the following tasks:
v Copies the directories and files from the ESS CIM Agent CD-ROM into the
chosen destination directory
v Updates some script files using the selected destination

22 ESS API Reference

v Compiles the MOF files, creates the persistent subdirectory in the destination
directory
v Generates a certificate called truststore in the destination directory, only for the
server

Note: For a client installation, you must copy this certificate from the server and
install it in the destination directory on the client machine if you intend to
run in secure mode.

Steps:

Perform the following steps to configure the CIM Agent:

Note: In addition to the configuration steps below, you can use the modifyconfig
command to change the configuration of some of the parameters that were
configured during installation. You can change the CIM Agent port value,
protocol (HTTP/HTTPS), and enable or disable the debug option. See
“modifyconfig” on page 122 for a description of the modifyconfig command
syntax.
1. Configure the CIM Agent for each ESS that the CIM Agent can access.
a. Type the following command:
# <dest-path>/setdevice

where <dest-path> is the destination directory where the CIM Agent is

installed.
The following is a sample output:
Application setdevice started in interactive mode
To terminate the application enter: exit
To get a help message enter: help
>>>

b. Obtain an IP address, user name, and password for each ESS that the CIM
Agent will manage.
c. Type the following command for each ESS:
>>>addess <9.111.111.111> <essuser> <esspass>

where
v 9.111.111.111 represents the IP address of the Enterprise Storage Server
v essuser represents the Enterprise Storage Server Specialist user name
v esspass represents the Enterprise Storage Server Specialist password for
the user name
The following is a sample output:
An ess provider entry for IP 9.111.111.111 successfully added

where 9.111.111.111 is the IP address.

d. Type the following command for each ESS server that is configured for
Copy Services:
>>> addessserver <9.111.111.111> <essuser> <esspass>

where
v 9.111.111.111 represents the IP address of the Enterprise Storage Server

Chapter 2. CIM Agent on AIX 23

 v essuser represents teh Enterprise Storage Server Specialist user name
v esspass represents the Enterprise Storage Server Specialist password for
the user name
The following is a sample output:
An essserver entry for IP 9.111.111.111 successfully added

where 9.111.111.111 is the IP address.

e. Type the exit command to exit the CIMOM configuration program. A file
named provider-cfg.xml is created in the destination directory.
2. Once you have defined all of the ESS servers, you must stop and start the
CIMOM to make the CIMOM initialize the settings for the ESS servers. Because
the CIMOM collects and caches the information from the defined ESSs at
startup time, the CIMOM might take longer to start the next time you start it.
3. Configure the CIMOM for each user that you want to have authority to use the
CIMOM by running the CIMOM configuration program.
During the ESS CIM Agent installation, the default user name to access the
ESS CIM Agent CIMOM is created. The default user name is “superuser” with a
default password of “passw0rd”. You must use the default user name and
password when using the setuser command for the first time after installation.
Once you have added other users, you can initiate the setuser command using
a user name that you defined instead of the default.
a. Start the CIMOM, if it is not started, by typing the following command:

# <dest-path>/startcimom

where <dest-path> is the destination directory where the CIM Agent is

installed.
b. Type the following command:

# <dest-path>/setuser -u superuser -p passw0rd

where <dest-path> is the destination path where the CIM Agent is installed.
The following is a sample output:
Application setuser started in interactive mode
To terminate the application enter: exit
To get a help message enter: help
>>>

Restriction: You cannot delete or modify the current user logged in using
the setuser command.
c. Obtain a user name and password for each user that can manage the
CIMOM. Type the following command for each user:
>>>adduser <cimuser> <cimpass>

where
v cimuser represents the new user name to access the ESS CIM Agent
CIMOM
v cimpass represents the password for the new user name to access the
ESS CIM Agent CIMOM
The following is a sample output:

24 ESS API Reference

 An entry for user cimuser successfully added

where cimuser is your new user name.

d. When you have completed adding new users to access the ESS CIM Agent
CIMOM, issue the exit command.
e. You can change the default password for ″superuser″ by starting the
setuser command for a user that you added in step c above. Then issue
the following command to change the password:
>>>chuser superuser <newpasswd>

where newpasswd is the new password for the superuser.

Or, delete the superuser by issuing the following command:
>>>deluser superuser
f. Type the exit command to exit the CIMOM configuration program.

Result:

If you are able to perform all of the configuring tasks successfully, the CIM Agent
has been successfully installed on your AIX operating system.

Related topics:
v “Verifying connection to the ESS”

Configuring the CIM Agent to run in unsecure mode

Some vendor software might not be capable of communicating with the CIM Agent
in a secure fashion. If you wish to, you can still use this vendor software by
configuring the CIM Agent to run with only basic user and password security.

Steps:

Perform the following steps to configure in unsecure mode:

1. Type the stopcimom command in the destination directory to stop the CIMOM.
2. Find the cimom.properties file in the target directory and edit it with a tool such
as vi editor. The following is an example:
ServerCommunication=HTTP
Port=5988
DigestAuthentication=False

3. Type the startcimom command to restart the CIMOM.

4. Verify that the server started on Port 5988 by opening the cimom.log file.

Verifying connection to the ESS

| This section includes the steps you must perform to verify connection to the ESS
| and that the CLI.CFG file is set correctly.

Prerequisites:

| Issue the rsTestConnection command from a Command Prompt window to test

| network connectivity and determine if the CLI.CFG is set correctly. The

Chapter 2. CIM Agent on AIX 25

| rsTestConnection command primarily tests the connection to the Copy Services
| primary server. Issue the esscli list server command to confirm connectivity to the
| rest of the ESSs in the domain.
| rsTestConnection.sh -s -v primaryservername

| where:
| v -s primaryservername represents the IP address or the complete host name of
| an ESS Copy Services server.
| v -v designates that all responses from the server be displayed.

| This following example is output that you receive if the CLI.CFG is set correctly
| (sltb0c0 is the ESS primary Copy Services server in this example):
| [root@bluegrass ibm2105cli]# ./rsTestConnection.sh -v -s sltb0c0
| rsWebTest: Using sltb0c0 as server name
| rsWebTest: HeartBeat to the server was successful.
| rsWebTest: command successful
||

Issue the esscli list server command from a Command Prompt window to confirm
connectivity to the rest of the ESSs in the domain.
esscli -u <essuser> -p <esspass> -s <9.111.111.111> list server

where:
v essuser is an Enterprise Storage Server Specialist user name.
v esspass is the Enterprise Storage Server Specialist password for that user name.
v 9.111.111.111 is the IP address of the Enterprise Storage Server.

Note: The ESS CLI does not set the PATH variable. Update the PATH environment
variable using the path where the CLI for ESS 2105 is installed. See
“Installing the ESS CLI on AIX” on page 7 for more information.
A response similar to the following is displayed:
Thu Oct 09 13:20:40 PDT 2003 IBM ESSCLI 2.3.0.1

Server Model Mfg WWN CodeEC Cache NVS Racks

---------- ----- --- ---------------- --------- ----- ----- -----
2105.22232 800 013 5005076300C09470 2.3.0.357 8GB 2GB 1

Steps:

Perform the following to start and verify the service location protocol (SLP) daemon
and the CIMOM.
1. Type the following command to see if the SLP daemon is started:

ps -ef | grep slpd

If the SLP daemon is not started, continue with the next step. If the SLP
daemon is started, go to step 3.
2. Start the SLP daemon, if it is not started, by typing the following command from
a separate window.
# /etc/rc.slpd
This session will remain active until you stop it. You should keep it running as
long as the CIM Agent is running.
3. Type the following command to see if the CIMOM is started:

26 ESS API Reference

 ps -ef | grep CIMOM

If the CIMOM is not started, go to step 4. If the CIMOM is started, go to step 5.

4. Start the CIMOM by running the startcimom script:

# <dest-path>/startcimom

Where <dest-path> is the destination directory where the CIM Agent is installed.
The default is to start the secure CIMOM. It will register itself with SLP and
accept requests on Port 5989.

| Note: The startcimom command quickly returns a prompt; however, a returned

| prompt does not mean the processing is complete. If there are a large
| number of LUNs to enumerate in the ESSNI domain, it takes
| considerable time for the CIMOM to find and enumerate all those disks.
| Do not issue the verifyconfig command until CIMOM processing is
| complete.
5. Type the following command to locate all WBEM services (for example,
CIMOMs) in the local network.
Type the following command from a Command Prompt window:
# <dest-path>/verifyconfig -u <user> -p <password>
where <user> and <password> are the user ID and passwords for a CIMOM
user that was created using setuser command.
A message similar to the following is displayed:
# ./verifyconfig -u xxxx -p nnnn
Verifying configuration of ESS CIM Agent...
Communicating with SLP to find WBEM services...
3 WBEM services found
host=baboon, port=5988
host=gorilla, port=5988
host=tpc03, port=5988
Connecting to ESS CIM Agent, host=baboon, port=5988
Found 1 IBMTSESS_StorageSystem instances
Verification Successful

where xxxx is your user ID and nnnn is your password.

Result:

The CIM Agent is now running.

Removing the CIM Agent on AIX

This optional task includes the steps necessary to remove the CIM Agent from your
AIX operating system.

Prerequisites:

Perform the following steps before starting the removal:

1. Log in as a user with root authority.
2. Stop all the processes (like SLP or CIMOM) and applications that use them that
are running on your system before you remove the CIM Agent product.

Steps:

Chapter 2. CIM Agent on AIX 27

 Perform the following steps to remove the CIM Agent:
1. Log on as a user with root authority.
2. Stop all the processes and applications that use SLP and CIMOM, that are
running on your system before you remove the CIM Agent for ESS.
3. Type the following command to stop the IBM CIM Object Manager (CIMOM)
daemon.

# <dest-path>/stopcimom

where <dest-path> is the destination directory where the product was installed.
4. Type the following command to see if SLP daemon is running:

# ps -ef | grep slpd

If SLP is running, the following output is displayed:
daemon 24452 1 0 Nov 13 - 0:00 /opt/IBM/cimagent/slp/slpd
root 37756 27328 0 14:55:47 pts/1 0:00 grep slpd

5. Type the following command to stop the service location protocol (SLP):

# kill 24452
6. Run the removal program in graphical mode (see “Removing in graphical
mode”) or in unattended (silent) mode (see “Removing in unattended (silent)
mode” on page 32) to remove the CIM Agent and Service Location Protocol.

Removing in graphical mode

Perform the following steps to remove the CIM Agent using graphical mode:
1. Type the following command to run the removal program from the _uninst
subdirectory of the <dest-path>:

# <dest-path>/_uninst/uninstaller

where <dest-path> is the destination directory where the CIM Agent is installed.
2. If the removal program was not created during the CIM Agent installation, type
the following command:

# <dest-path>/ibmjava131/jre/bin/java -jar <dest-path>/_uninst/

uninstall.jar

where <dest-path> is the destination directory where the CIM Agent is installed.
3. The Welcome window opens. Click Next to continue with the removal program,
or click Cancel to exit the removal program.

28 ESS API Reference

The program detects if the service location protocol (SLP) and the IBM CIM
Object Manager (CIMOM) services are running and displays the following
information:
v If the SLP and the CIMOM are running, the Stopping Services window asks if
you want to continue with the removal program. In that case, click Next to
stop the services. Click Cancel to stop the services manually, which is
recommended.
v If you want to manually stop the services, you must exit the removal program,
stop the services and the applications that use them, and then run the
removal program again from the beginning.
Attention: You must be careful if you have other applications that use the
SLP service. If you do, you must stop these applications before you stop the
SLP service because the SLP service is deleted during the removal process.

Chapter 2. CIM Agent on AIX 29

 v If neither the SLP service nor the CIMOM service is running, the removal
program continues with the Preview window.
4. The Confirmation window opens, displaying the location of the product that will
be removed. Click Remove to continue with the removal program, or click
Cancel to exit.

30 ESS API Reference

5. The Uninstallation Progress window opens. Wait for the program to remove the
CIM Agent. If you do not want to continue with the removal, click Cancel to
return to the Confirmation window.

6. The Finish window opens displaying information about the result of removal
(successfully or failed).

Click Finish to end the removal program.

Chapter 2. CIM Agent on AIX 31

Removing in unattended (silent) mode
Steps:

Perform the following steps to remove the CIM Agent in unattended (silent) mode:
1. Stop SLP, CIMOM, and all related processes.
2. Type the following command to run the removal program from the _uninst
subdirectory:

<dest-path>/_uninst/uninstaller -silent

where <dest-path> is the destination directory where the CIM Agent is installed.
If the program detects that the service location protocol (SLP) or the IBM CIM
Object Manager (CIMOM) services are running, it displays an error message
and the uninstallation fails. You can look for details in the
/tmp/cimagent/uninstall.log file. However, if you want the program to
automatically stop the services, you must set the stopProcessesResponse
option to yes in the command line:

<dest-path>/_uninst/uninstaller -silent -G stopProcessesResponse=yes

Post-processing requirements:

The CIM Agent removal process does not remove configuration files, logs, and
similar files that are created during or after the installation process. They are
located in the destination path where CIM Agent was installed. For example, the
default destination path is /opt/IBM/cimagent.

Remove the directory and all of its contents (especially if you plan to reinstall the
CIM Agent).

Note: If you want to keep the old configuration files, save them in another location
on your system before removing them from the installation destination path,
so you can restore them later.

To remove the directory, cimagent, you must type the following command, for
example, from the IBM directory.

# rm -r /opt/IBM/cimagent

Note: The recursive remove is used in this example because the CIM Agent has a
deep directory structure. The recursive remove is very powerful and
dangerous. You should use the fully qualified directory name.

32 ESS API Reference

Chapter 3. CIM Agent for Linux
This chapter includes an overview of the installation process and instructions for
installing and configuring the CIM Agent on a Linux (Red Hat 7.2) operating system.

Installation overview for Linux

This section provides an overview and instructions for installing and configuring the
CIM Agent on the Linux (Red Hat 7.2) operating system. You should have some
knowledge of how to administer Linux operating system before you begin to install
the CIM Agent. You should also become familiar with the command explanations
that you use to install and configure the CIM Agent. See Chapter 5, “CIM Agent
installation and configuration commands,” on page 87 for information about the
commands.

The following list of installation and configuration tasks are discussed in the order in
which they should be performed:
1. Before you install the CIM Agent on a Linux operating system, check the
hardware and software requirements listed in “ESS CIM Agent installation
requirements” on page 5.
2. Install the prerequisite ESS CLI 2105 for Linux software as instructed in
“Installing the ESS CLI on Linux.”
Attention: If you are upgrading from a previous version of the ESS CIM Agent,
you must uninstall the ESS CLI software that the previous CIM Agent required
and reinstall the latest ESS CLI software, which is level 2.3.0.13.
3. You can choose to install the CIM Agent either in graphical mode with the help
of a wizard or in unattended mode (also known as silent mode), which involves
customizing a response file and issuing a command.
a. If you want to install the CIM Agent in graphical mode, perform the
instructions in “Installing the CIM Agent on Linux in graphical mode” on page
35.
b. If you want to install the CIM Agent in unattended mode, perform the
instructions in “Installing the CIM Agent on Linux in unattended (silent)
mode” on page 43.
4. Configure the CIM Agent by performing the instructions in “Configuring the CIM
Agent on Linux” on page 47. You might want to revisit this section in the future
as you add, change, or delete CIMOM authentication and ESS information.
5. Enable the CIM Agent by performing the instructions in “Verifying connection to
the ESS” on page 51.
6. For instructions about removing the CIM Agent, see “Removing the CIM Agent
on Linux” on page 52. You only need to perform this optional task if you get
errors during installation verification or if the CIM Agent did not set the
environment variables.

Installing the ESS CLI on Linux

Before you install the CIM Agent, you must install the ESS CLI. The ESS CLI must
be installed first because the CIM Agent sets the path information in shell scripts for
you based on the location of the ESS CLI. The CIM Agent installation wizard
checks your system for the existence of the ESS CLI, and the wizard stops if the
ESS CLI is not installed.

© Copyright IBM Corp. 2004 33

 Steps:

Perform the following steps to install the ESS CLI on Linux (Red Hat 7.2):
1. Select the ESS CLI CD.
This ESS CLI CD contains the ESS CLI installation packages and the IBM
TotalStorage Enterprise Storage Server Command-Line Interfaces User’s Guide.
2. Select the IBMesscli-2.3.0.13-0.i386.rpm package.

Note: The CIM Agent supports ESS CLI level 2.3.0.13.

3. Follow the installation instructions from the IBM TotalStorage Enterprise Storage
Server Command-Line Interfaces User’s Guide, which can be found on the IBM
TotalStorage Enterprise Storage Server Customer Documents CD to install the
ESS CLI. You must download and install the required Java before you install the
ESS CLI. In this guide, the “ESS CLI” is referred to as the “Storage
Management CLI”.
If you have an earlier version of the ESS CLI installed, the rpm install
command does not allow you to install the IBMesscli-2.3.0.13-0.i386.rpm
package unless you uninstall the earlier version. If an earlier version of the ESS
CLI is installed, a message similar to the following is displayed:
# IBMesscli-V.R.M.F-X

where
v V represents the CLI version number
v R represents the release number
v M represents the number of times that the release package was built
v F represents the fix level
v X represents the number of times that the release package was built
Issue the following command to remove the earlier version of the ESS CLI:
# rpm -e IBMesscli -V.R.M.F-X

where
v V represents the CLI version number
v R represents the release number
v M represents the number of times that the release package was built
v F represents the fix level
v X represents the number of times that the release package was built
4. Verify that the required version of the ESS CLI is installed.
Review the installed programs on your Red Hat Linux system. The level of the
ESS CLI software must be 2.3.0.13 or later. To check the level, type the
following command:
# rpm -qa | grep IBMesscli

If the ESS CLI is installed, a message similar to the following is displayed:

# # IBMesscli-V2.3.0.13-0

| 5. Follow the instructions in “Verifying connection to the ESS” on page 51 to verify

| that the ESS CLI has connectivity to your ESS and that the CLI.CFG file is set
| correctly.
6. Verify if the ESS CLI is operational and all the environment variables have been
set.

34 ESS API Reference

 Note: Before you run the esscli, you must know where the ESS CLI is installed.
You can find out where it is installed by typing the following command:

# rpm -ql IBMesscli-2.3.0.13-0 | grep esscli

where 2.3.0.13-0 is the level reported from the rpm -qa command in step
4.
To verify if the ESS CLI is operational, type the following command:
# /opt/ibm2105cli/esscli

The following is a sample output:

[root@store03 ibm2105cli]# ./esscli
Thu Oct 09 11:27:32 PDT 2003 IBM ESSCLI 2.3.0.1

esscli -a AccessFile [-key KeyName] | -u Username -p Password

-s ServerAddress [-b BackupServer]
[-v|-nov] [-hdr|-nohdr] [-ssl|-nossl][-debug|-nodebug]
[-refresh|-norefresh][-fmt "Format"]
Cmnd_Action Cmnd_Category [-d "argument_pairs"]

List of Cmnd_Actions, Cmnd_Categories, and argument_pairs:

==========================================================

DiskGroup Category:
-------------------
list DiskGroup [-d "ess=EssId"]

........................lines ommitted from sample..............................

WebUserAccount Category:
------------------------
list WebUserAccount [-d "ess=EssId"]
[-fmt user,acclvl,iprange,comments]
create WebUserAccount -d "ess=EssId user=UserId pwd=Password
acclvl=AccessLevel iprange=IPRange comments=’Comments’"
set WebUserAccount -d "ess=EssId user=UserId
(newuser=NewUserId|newpwd=NewPassword|
newacclvl=NewAccessLevel|newiprange=NewIPRange|
newcomments=’NewComments’)*"
delete WebUserAccount -d "ess=EssId user=UserId"

[root@store03 ibm2105cli]#

Installing the CIM Agent on Linux in graphical mode

This section includes the steps to install the CIM Agent in your Linux environment
using the graphical mode. You must comply with all prerequisites listed in “ESS CIM
Agent installation requirements” on page 5 before you start the installation.

You can choose to install the CIM Agent in graphical mode with the help of an
installation wizard or in unattended (silent) mode, which involves customizing a
response file and issuing a command. If you want to install the CIM Agent in
unattended mode, see “Installing the CIM Agent on Linux in unattended (silent)
mode” on page 43, otherwise continue with this section. After the completion of
either kind of installation, you will then verify the installation of the CIM Agent in
section, “Verifying the CIM Agent installation on Linux” on page 47. Before you
install the CIM Agent on Linux, you should check the hardware and software
requirements listed in “ESS CIM Agent installation requirements” on page 5.

Steps:

Chapter 3. CIM Agent for Linux 35

 You should have some knowledge about how to administer Linux before you begin
installing the CIM Agent.

Note: The description of commands in this task have the convention of optional
and substitution parameters between greater than “>” and less than “<”
symbols. You should become familiar with the explanation before entering
the command.

Perform the following steps to install the CIM Agent on your Linux system:
1. Log on as a user with root authority.
2. Insert the CIM Agent for ESS CD.
3. Create a mount point or choose an existing mount point.
Type the following command to create a mount point called /mnt/cdrom:

# mkdir /mnt/cdrom
4. Type the following command to mount the CD-ROM file system at the desired
mount point:

# mount/dev/cdrom/mnt/cdrom
5. Change the current directory to the mount point for the CD drive, in the LINUX
directory. For example, if the CD was mounted at the /mnt/cdrom mount point,
type the following command:

# cd /mnt/cdrom/LINUX
6. Check the README.linux file located in the LINUX directory on the CIM Agent
for ESS CD. The README.linux file can provide additional information that
supersedes information in this guide.
You can also find this installation guide on the CIM Agent for ESS CD under
the file name installguide.pdf in the document subdirectory.
7. The CIM Agent installation in graphical mode begins with a LaunchPad facility
to launch the installation program wizard. The LaunchPad facility provides links
for you to view various text files, such as the product overview, product
readme, post installation tasks, and various Adobe Acrobat files, such as, the
Installation guide, product license agreement and a browser link to the IBM
storage product technical support page.
The Installation guide and license agreement are in Adobe Acrobat file format
(.pdf). In order for the LaunchPad to provide links to the Adobe Acrobat files,
your system must have Adobe Acrobat Reader installed. In order for the
browser to link to the IBM storage product technical support page, you must
have a browser installed on your system where you start the LaunchPad
facility.
If you wish to use the LaunchPad facility links to view the Adobe Acrobat files,
you must have the Adobe Acrobat Reader bin location in your PATH
environment variable. You can verify this by running the following command:

echo $PATH

Locate the Adobe Acrobat Reader bin location in the PATH, for example,
/usr/opt/Acrobat5/bin. If the Adobe Acrobat Reader bin location is not in the
environment path, you can set it by typing the following command:

export PATH=$PATH:/usr/opt/Acrobat5/bin

36 ESS API Reference

 where /usr/opt/Acrobat5/bin is the location of the Adobe Acrobat Reader bin
directory.
8. Run the wizard launcher, launchpad_linux, from the Linux directory of the CD
by typing the following command:

# ./launchpad_linux

This command starts the CIM Agent LaunchPad, a small graphical program
that launches the wizard.
9. The LaunchPad window opens. Choose from the following options:
CIM Agent overview
Offers information about the CIM Agent.
Readme file
Offers any last minute product information that did not make it into this
installation guide.
Installation guide
Offers instructions on how to install the CIM Agent.
License Agreement
Offers information about the license of the CIM Agent.
CIM Agent Web site
Offers information from the product Web site.
Installation wizard
Starts the CIM Agent installation program.
Post installation tasks
Offers information about configuring the users and device
communications.
Exit Exits the Launchpad program.
The LaunchPad window remains open (behind the wizard) during the
installation. You can access product information after the installation has
started. The LaunchPad returns to the foreground when the installation is
complete. You can click Exit to close the LaunchPad.

Chapter 3. CIM Agent for Linux 37

 Figure 4. LaunchPad window

10. Click Installation wizard to begin the CIM Agent installation.

11. The Welcome window opens suggesting which documentation you should
review prior to installation. Click Next to continue or click Cancel to exit.

38 ESS API Reference

12. Read the license agreement information. Click I accept the terms of the
license agreement and click Next to proceed, or click I do not accept the
terms of the license agreement and click Cancel to exit the installation.

13. The Product Installation Check window opens and the wizard verifies that your
machine meets the installation requirements.
v If you have a service location protocol (SLP) service that is different from
the SLP that the CIM Agent requires, the wizard displays an error and asks
you to stop the installation and remove this SLP service from the system.
v The wizard checks whether the ESS CLI client is installed on your machine.
v The wizard checks whether a version of the CIM Agent is already installed.
If the CIM Agent is installed, it checks if the SLP service and the IBM CIM
Object Manager (CIMOM) service is started. If these services are started
and you want to continue the installation program, select the Next button.
Or, if you want to exit the installation program, select the Cancel button. If
you choose to continue, you must stop all of the daemons and dependent
applications that use these services. You can save the old configuration (for
example, user names, passwords, and device IP addresses) by selecting
the check box that you see on the window.

Chapter 3. CIM Agent for Linux 39

 14. The Destination Directory window opens. Click Next to accept the default
directory, or click Browse to select a different directory for installation and then
click Next.

40 ESS API Reference

 Notes:
a. The Destination Directory window is displayed only if a version of CIM
Agent is not already installed. Otherwise, the CIM Agent will be reinstalled
or upgraded to the same install location.
b. If the wizard detects insufficient space for the CIM Agent in the filesystem
containing the chosen directory, you can perform one of the following
steps:
1) Free some space in that directory and then click Next.
2) Click Cancel to exit the wizard, free some space in that filesystem, and
then restart the wizard, or
3) Click Back and choose another filesystem for the product.
15. The Updating CIMOM Port window opens. Click Next to accept the default
port. If the default port is the same as another port already in use, modify the
default port and click Next. Use the following command to check which ports
are in use:

netstat -a

Or, click Cancel to exit the wizard.

16. The Installation Confirmation window opens. Click Install to confirm the
installation directory and file size, or click Cancel to exit the wizard.

Chapter 3. CIM Agent for Linux 41

 17. The Installation Progress window opens indicating how much of the installation
has been completed. Installation usually takes 3 - 10 minutes depending on
your machine configuration. If you do not want to continue with the installation,
click Cancel to exit.

18. The Finish window opens and notifies you whether the installation was
successful. Check the View post installation tasks check box if you want to
continue with post installation tasks when the wizard closes. Click Finish to
42 ESS API Reference
 exit the wizard. You can view the installation log under <des-
path>/logs/install.log, where <des-path> is your destination directory.

19. Exit the LaunchPad program by clicking Exit on the LaunchPad window. If you
have not done so already, continue with the post installation tasks for the ESS
CIM Agent in the following sections. “Verifying the CIM Agent installation on
Linux” on page 47 is the next task. You can also continue the post installation
tasks using the following option:
a. Click Post installation tasks on the LaunchPad window.
b. Continue with the post installation tasks for the ESS CIM Agent by
following the instructions in this file.
20. When you are finished with the CIM Agent for ESS CD, type the following
command to remove the CD:

# umount/mnt/cdrom

where /mnt/cdrom is where the CD is mounted.

Related topics:
v “Installing the CIM Agent on Linux in unattended (silent) mode”
v “Verifying the CIM Agent installation on Linux” on page 47
v “Installing the CIM Agent on Linux in graphical mode” on page 35
v “Removing the CIM Agent on Linux” on page 52

Installing the CIM Agent on Linux in unattended (silent) mode

This section includes the steps to install the CIM Agent in your Linux environment
using the unattended (silent) mode. You must comply with all prerequisites that are
listed in “ESS CIM Agent installation requirements” on page 5 before you start the
installation.

Chapter 3. CIM Agent for Linux 43

 You can choose to install the CIM Agent in unattended (silent) mode, which involves
customizing a response file and issuing a command or in graphical mode with the
help of an installation wizard. If you want to install the CIM Agent in graphical mode,
see “Installing the CIM Agent on Linux in graphical mode” on page 35, otherwise
continue with this section. After the completion of either kind of installation, you will
then verify the installation of the CIM Agent in section, “Verifying the CIM Agent
installation on Linux” on page 47.

Context:

The unattended (silent) installation capability enables you to run an installation

process unattended. You can create a standard response file to ensure that the
product is installed consistently on multiple systems. The responsefile file is a
template located on the CIM Agent CD that you must copy to disk and modify. To
use the silent mode installation method, you will be performing the following tasks:
1. Find the responsefile file template on the CIM Agent installation compact disk.
2. Copy the responsefile template to your hard disk drive.
3. Customize the responsefile file to your specifications.
4. Save the updated responsefile file.
5. Invoke the response file using the setuplinux script.

Steps:

Perform the following steps to install the CIM Agent in your Linux environment using
the unattended (silent) mode:
1. Log on as a user with root authority.
2. Type the following commands to locate the responsefile file on your CIM Agent
for ESS CD.

# cd /mnt/cdrom
# cd LINUX
3. Copy the responsefile file to your hard disk drive by typing the following
command:

# cp ./responsefile /root/xxxx

where xxxx is your desired directory.

4. Customize the responsefile file with your parameters as follows:
Using a text editor, modify the default options in the responsefile file with your
desired values:
v If you do not want to use the default value, remove the # character from the
beginning of the line. Change the default value to the value that you want for
that option. You must enclose all values in double quotation marks (“ ”).
v Use the option <-P product.installLocation> to define the default directory
where you want the product installed. To use another destination directory,
remove the # character from the corresponding line, and replace this default
directory with the desired directory.
v The option <-G checkPrerequisite> enables checking the prerequisites. To
disable checking the prerequisites, remove the # character from the
corresponding line and change the value of the option to “no”.
v The option <-G startUpgrade> enables the installation of CIM Agent over a
previous installation of CIM Agent having the same version (reinstall) or lower

44 ESS API Reference

 version (upgrade). To do this, remove the # character from the corresponding
line and change the value of the option to “yes”.
v The option <-G stopProcessesResponse> tells the install program whether or
not to automatically stop SLP and CIM Agent services when reinstalling or
upgrading the product. By default this option is set to “no”. If you do not
change this default value, the reinstallation or upgrade will abort when these
service are running.
– To automatically stop the SLP and CIMOM, remove the # character from
the corresponding line and change the value of the option to “yes”.
v The <-G saveConfiguration> option specifies whether to save the
configuration settings (for example, user names, passwords, and device IP
addresses) when reinstalling or upgrading the product. If you do not want to
save the configuration settings when reinstalling or upgrading, remove the #
character from the corresponding line and change the value of the option
to“no”.
v The <-W cimObjectManagerPorts.port> option specifies the ESS CIM Agent
server port. If you want to change the default value during installation,
remove the # character from the corresponding line and change the default
port value (5989) with the desired port value.
v The <-W cimObjectManagerPorts.serverCommunication> option specifies the
ESS CIM Agent server communication protocol. If you want to change the
default value during installation, remove the # character from the
corresponding line and change the default server communication protocol
(HTTPS) to HTTP protocol.
5. Save the modified responsefile in your desired directory.
6. To launch the wizard in unattended (silent) mode with the customized
responsefile, type the following command from the Linux directory on your CIM
Agent for ESS CD:

# ./setuplinux -options <responsefile-path>/responsefile

where <response file path> is the path of the responsefile file.

7. Wait for the wizard to complete the installation.
8. Check for installation errors in the install.log file. The log file is initially created in
/tmp/cimagent/install.log. At the end of the installation, the log can be found in
<dest-path>/logs/install.log, where <dest-path> is the destination directory where
the CIM Agent was installed. If the installation ends before the creation of
<dest-path> the log should be looked for in /tmp/cimagent/install.log. Your
install.log file should look similar to the following:

Chapter 3. CIM Agent for Linux 45

 (Oct 13, 2003 2:57:50 PM), This summary log is an overview of the sequence of the
installation of the IBM TotalStorage CIM Agent for ESS V1R2 1.2.0.1
(Oct 13, 2003 2:57:51 PM), The package rpm-build 4.0.4 7x.20 was found on your LINUX
system.
(Oct 13, 2003 2:57:51 PM), The package chkconfig 1.2.24 1 was found on your LINUX
system.
(Oct 13, 2003 2:57:51 PM), The package IBMesscli 2.3.0.13 0 was found on your LINUX
system.
(Oct 13, 2003 2:57:55 PM), IBM TotalStorage CIM Agent for ESS V1R2 installation
process started with the following install parameters:
Target Directory: /opt/IBM/cimagent
(Oct 13, 2003 2:57:59 PM), Copying Service Location Protocol Files ...
(Oct 13, 2003 2:57:59 PM), Copy file /opt/IBM/cimagent/slp/slp.conf to /etc/slp.conf .
(Oct 13, 2003 2:57:59 PM), Command to be executed:
/bin/ln -sf libslp.so.1.0.0 /opt/IBM/cimagent/slp/libslp.so
(Oct 13, 2003 2:57:59 PM), Command to be executed:
/bin/ln -sf libslp.so.1.0.0 /opt/IBM/cimagent/slp/libslp.so.1
(Oct 13, 2003 2:57:59 PM), Copy file /cdrom/LINUX/startup/slpdRed Hat to
/etc/init.d/slpd .
(Oct 13, 2003 2:57:59 PM), Command to be executed:
/sbin/chkconfig --add slpd
(Oct 13, 2003 2:58:01 PM), Copying CIM Object Manager Files ...
(Oct 13, 2003 2:58:12 PM), IBM CIM Object Manager - ESS port successfully updated.
(Oct 13, 2003 2:58:12 PM), IBM CIM Object Manager - ESS communication protocol
successfully updated.
(Oct 13, 2003 2:58:12 PM), The file setupCmdLine successfully updated.
(Oct 13, 2003 2:58:12 PM), Compile MOF files started ...
(Oct 13, 2003 2:59:31 PM), MOF files successfully compiled.
(Oct 13, 2003 2:59:31 PM), Generate a certificate store started ...
(Oct 13, 2003 3:00:13 PM), Certificate store called truststore successfully generated.
(Oct 13, 2003 3:00:13 PM), Copy file /cdrom/LINUX/startup/cimomRed Hat to
/etc/init.d/cimom .
(Oct 13, 2003 3:00:13 PM), Command to be executed:
/sbin/chkconfig --add cimom
(Oct 13, 2003 3:00:39 PM), The following services started successfully:
Service Location Protocol
IBM CIM Object Manager - ESS
(Oct 13, 2003 3:00:39 PM), INSTSUCC: The IBM TotalStorage CIM Agent for ESS V1R2 has
been successfully installed.

9. Close the command prompt window by entering a command, for example exit.
Continue with the post installation tasks for the ESS CIM Agent in the following
sections. “Verifying the CIM Agent installation on Linux” on page 47 is the next
task. You can also continue the post installation tasks using the following option:
a. Open the LaunchPad from the Linux directory of the CIM Agent for ESS CD
by typing # ./launchpad_linux.
b. Click Post installation tasks on the LaunchPad window. Continue with the
post installation tasks for the ESS CIM Agent by following the instructions in
this file.

Related topics:
v “Verifying the CIM Agent installation on Linux” on page 47
v “Installing the CIM Agent on Linux in graphical mode” on page 35
v “Configuring the CIM Agent on Linux” on page 47
v “Removing the CIM Agent on Linux” on page 52

46 ESS API Reference

Verifying the CIM Agent installation on Linux
This section includes the steps necessary to verify that your CIM Agent is installed
correctly on your Linux system.

Steps:

Perform the following steps to verify your CIM Agent installation:

1. Verify the installation of the service location protocol (SLP).
a. Open a Command Prompt window and type the following command to verify
that SLP is installed:
# ps -ef | grep -v grep | grep slpd
If the SLP daemon is started, the following output is displayed:
daemon 16054 1 0 18:54 ? 00:00:00 /opt/IBM/cimagent/slp/slpd

2. Verify the installation of CIM Agent.

a. Check that the CIMOM daemon is installed and started by typing the
following command:
# ps -ef --columns 1000 | grep -E "com.ibm.cimom.CIMOM"

The following is a sample output of the command.

root 27696 27014 0 Oct08 ? 00:00:00 /opt/IBM/cimagent/ibmjava131/jre
/bin/exe/java -Xms128m -Xmx256m -cp /opt/IBM/cimagent/lib/xml4j-4_0_5/xercesImpl
.jar:/opt/IBM/cimagent/lib/xml4j-4_0_5/xmlParserAPIs.jar:/opt/IBM/cimagent/ibmja
va131/jre/lib/ext/ibmjsse.jar:/opt/IBM/cimagent/lib/JCE/IBMJCEfw.jar:/opt/IBM/ci
magent/lib/JCE/IBMJCEProvider.jar:/opt/IBM/cimagent/lib/JCE/local_policy.jar:/op
t/IBM/cimagent/lib/JCE/US_export_policy.jar:/opt/IBM/cimagent/lib/JCE/ibmpkcs.ja
r:/opt/IBM/cimagent/ibmjava131/jre/lib/rt.jar:/opt/IBM/cimagent/ibmica.jar:/opt/
IBM/cimagent/lib/logger.jar:/opt/IBM/cimagent/lib/ESSNIClient.jar:/opt/IBM/cimag
ent/lib/ESSNICommon.jar:/opt/IBM/cimagent/lib/ESSNIServer.jar:/opt/IBM/cimagent/
lib/jlog.jar com.ibm.cimom.CIMOM -Prime
root 666 591 0 14:03 pts/3 00:00:00 grep -E com.ibm.cimom.CIMOM
[root@store03 root]#

b. If the CIMOM is not started, issue the following command to run the
startcimom file.
<dest-path>/startcimom

where <dest-path> is the destination directory where the CIM Agent is

installed.

Result:

If you are able to perform all of the verification tasks successfully, then the CIM
Agent has been successfully installed on your Linux system.

Related topics:
v “Configuring the CIM Agent on Linux”

Configuring the CIM Agent on Linux

This section includes the steps to configure the CIM Agent after it has been
successfully installed.

Context:

Chapter 3. CIM Agent for Linux 47

 This task is performed after successful installation of the CIM Agent. This
installation program performs the following tasks:
v Copies the directories and files from the ESS CIM Agent CD-ROM into the
chosen destination directory
v Updates some script files using the selected destination
v Compiles the MOF files, creates the persistent subdirectory in the destination
directory
v Generates a certificate called truststore in the destination directory, only for the
server

Note: For a client installation, you must copy this certificate from the server and
install it in the destination directory on the client machine if you intend to
run in secure mode.

Steps:

Perform the following steps to configure the CIM Agent:

Note: In addition to the configuration steps below, you can use the modifyconfig
command to change the configuration of some of the parameters that were
configured during installation. You can change the CIM Agent port value,
protocol (HTTP/HTTPS), and enable or disable the debug option. See
“modifyconfig” on page 122 for a description of the modifyconfig command
syntax.
1. Configure the CIM Agent for each ESS that the CIM Agent can access.
a. Type the following command:
# <dest-path>/setdevice

where <dest-path> is the destination directory where the CIM Agent is

installed.
The following is a sample output:
Application setdevice started in interactive mode
To terminate the application enter: exit
To get a help message enter: help
>>>

b. Obtain an IP address, user name, and password for each ESS that the CIM
Agent will manage.
c. Type the following command for each ESS:
>>>addess <9.111.111.111> <essuser> <esspass>

where
v 9.111.111.111 represents the IP address of the Enterprise Storage Server
v essuser represents the Enterprise Storage Server Specialist user name
v esspass represents the Enterprise Storage Server Specialist password for
the user name
The following is a sample output:
An ess provider entry for IP 9.111.111.111 successfully added

where 9.111.111.111 is the IP address.

48 ESS API Reference

 d. Type the following command for each ESS server configured for Copy
Services:
>>> addessserver <9.111.111.111> <essuser> <esspass>

where
v 9.111.111.111 represents the IP address of the Enterprise Storage Server
v essuser represents teh Enterprise Storage Server Specialist user name
v esspass represents the Enterprise Storage Server Specialist password for
the user name
The following is a sample output:
An essserver entry for IP 9.111.111.111 successfully added

where 9.111.111.111 is the IP address.

e. Type the exit command to exit the CIMOM configuration program. A file
named provider-cfg.xml is created in the destination directory.
2. Once you have defined all of the ESS servers, you must stop and start the
CIMOM to make the CIMOM initialize the settings for the ESS servers. Because
the CIMOM collects and caches the information from the defined ESSs at
startup time, the CIMOM might take longer to start the next time you start it.
3. Configure the CIMOM for each user that you want to have authority to use the
CIMOM by running the CIMOM configuration program.
During the ESS CIM Agent installation, the default user name to access the
ESS CIM Agent CIMOM is created. The default user name is “superuser” with a
default password of “passw0rd”. You must use the default user name and
password when using the setuser command for the first time after installation.
Once you have added other users, you can initiate the setuser command using
a user name that you defined instead of the default.
a. Start the CIMOM, if it is not started, by typing the following command:

# <dest-path>/startcimom

where <dest-path> is the destination directory where the CIM Agent is

installed.
b. Type the following command:

# <dest-path>/setuser -u username -p password

where <dest-path> is the destination path where the CIM Agent is installed.

Chapter 3. CIM Agent for Linux 49

 The following is a sample output:
Application setuser started in interactive mode
To terminate the application enter: exit
To get a help message enter: help
>>>

Restriction: You cannot delete or modify the current user that is logged in
using the setuser command.
c. Obtain a user name and password for each user that can manage the
CIMOM. Type the following command for each user:
>>>adduser <cimuser> <cimpass>

where
v cimuser represents the new user name to access the ESS CIM Agent
CIMOM
v cimpass represents the password for the new user name to access the
ESS CIM Agent CIMOM
The following is a sample output:
An entry for user cimuser successfully added

where cimuser is your new user name.

d. When you have completed adding new users to access the ESS CIM Agent
CIMOM, issue the exit command.
e. You can change the default password for “superuser” by starting the setuser
command and providing a password for a user that was established in step
c above. Issue the following command to change the password:
>>>chuser superuser <newpasswd>

where newpasswd is the new password for the superuser.

Or, remove the superuser by issuing the following command:
>>>rmuser superuser
f. Type the exit command to exit the CIMOM configuration program.

Result:

If you are able to perform all of the configuring tasks successfully, then the CIM
Agent has been successfully installed on your Linux system.

Related topics:
v “Verifying connection to the ESS” on page 51

Configuring the CIM Agent to run in unsecure mode on Linux

Some vendor software might not be capable of communicating with the CIM Agent
in a secure fashion. If you wish to, you can still use this vendor software by
configuring the CIM Agent to run with only basic user and password security.

Perform the following steps to configure in unsecure mode:

1. Type the stopcimom command in the destination directory to stop the CIMOM.
2. Find the cimom.properties file in the target directory and edit it with a tool such
as vi editor. The following is an example:

50 ESS API Reference

 ServerCommunication=HTTP
Port=5988
DigestAuthentication=False

3. Type the startcimom command to restart the CIMOM.

4. Verify that the server started on Port 5988 by opening the cimom.log file.

Verifying connection to the ESS

| This section includes the steps that you must perform to verify connection to the
| ESS and that the CLI.CFG file is set correctly.

Prerequisites:

| Issue the rsTestConnection command from a Command Prompt window to test

| network connectivity and determine if the CLI.CFG is set correctly. The
| rsTestConnection command primarily tests the connection to the Copy Services
| primary server. Issue the esscli list server command to confirm connectivity to the
| rest of the ESSs in the domain.
| rsTestConnection.sh -s -v primaryservername

| where:
| v -s primaryservername represents the IP address or the complete host name of
| an ESS Copy Services server.
| v -v designates that all responses from the server be displayed.

| This following is an example of the output you receive if the CLI.CFG is set
| correctly (sltb0c0 is the ESS primary Copy Services server in this example):
| [root@bluegrass ibm2105cli]# ./rsTestConnection.sh -v -s sltb0c0
| rsWebTest: Using sltb0c0 as server name
| rsWebTest: HeartBeat to the server was successful.
| rsWebTest: command successful
||

Issue the esscli list server command from a Command Prompt window to confirm
connectivity to the rest of the ESSs in the domain.
esscli -u <essuser> -p <esspass> -s <9.111.111.111> list server

where:
v essuser is an Enterprise Storage Server Specialist user name.
v esspass is the Enterprise Storage Server Specialist password for that user name.
v 9.111.111.111 is the IP address of the Enterprise Storage Server.

Note: The ESS CLI does not set the PATH variable. Update the PATH environment
variable using the path where the CLI for ESS 2105 is installed. See
“Installing the ESS CLI on Linux” on page 33 for more information.
A response similar to the following is displayed:
Thu Oct 09 11:26:32 PDT 2003 IBM ESSCLI 2.3.0.1

Server Model Mfg WWN CodeEC Cache NVS Racks

---------- ----- --- ---------------- --------- ----- ----- -----
2105.22232 800 013 5005076300C09470 2.3.0.357 8GB 2GB 1

Chapter 3. CIM Agent for Linux 51

 The installation, verification, and configuration of the CIM Agent need to be
completed prior to this task. The tasks being performed are starting and verifying
the Service Location Protocol (SLP) daemon, and starting and verifying the CIMOM.

Steps:

Perform the following to start and verify the service location protocol (SLP) daemon
and the CIMOM.
1. If the SLP daemon is not started, type the following command from a separate
Command Prompt window:
# /etc/init.d/slpd start
This session will remain active until you stop it. You should keep it running as
long as the CIM Agent is running.
2. If the CIMOM is not started, start it by performing the following steps:
a. Run the startcimom file in a Command Prompt window, by typing the
following command:
# <dest-path>/startcimom
where <dest-path> is the destination directory where the CIM Agent is
installed.
b. The default is to start the secure CIMOM. It will register itself with SLP and
accept requests on port 5989.
3. Enter the following command to locate all WBEM services (for example,
CIMOMs) in the local network, display them and then call the CIMOMs on the
local machine only requesting information about whether the CIMOMs know of
any ESS.
Run the following command from a Command Prompt window:
# <dest-path>/verifyconfig -u <user> -p <password>
Where <user> and <password> are the user and password of a cimom userid
created with setuser command.
Here is a sample output:
# verifyconfig -u guest -p guest
Verifying configuration of ESS CIM Agent...
Communicating with SLP to find WBEM services...
1 WBEM services found
host=kirchhofer, port=5989
Connecting to ESS CIM Agent, host=kirchhofer, port=5989
Found 1 IBMTSESS_StorageSystem instances
Verification Successful

Result:

This completes the execution of the TotalStorage CIM Agent.

Removing the CIM Agent on Linux

This optional task includes the steps necessary to remove the CIM Agent from your
Linux system.

Steps:

Perform the following steps to remove the CIM Agent:

1. Log on as a user with root authority.

52 ESS API Reference

 2. If the IBM CIM Object Manager Service and the Service Location Protocol
services are started, you must stop them by typing the following command:
# ps -ef --columns 1000 | grep -v "com/.ibm/.cimom/.CIMOM"

Output similar to the following is displayed:

root 52858 1 0 Oct 16 pts/7 2:29 /opt/IBM/ICAT/ibmjava131/jre/bin/
java -Xms128m -Xmx256m -cp /opt/IBM/ICAT/lib/xml4j-4_0_5/xercesImpl.jar:
/opt/IBM/ICAT/lib/xml4j-4_0_5/xmlParserAPIs.jar:/opt/IBM/ICAT/ibmjava131/
jre/lib/ext/ibmjsse.jar:/opt/IBM/ICAT/lib/JCE/IBMJCEfw.jar:/opt/IBM/ICAT/
lib/JCE/IBMJCEProvider.jar:/opt/IBM/ICAT/lib/JCE/local_policy.jar:/opt/
IBM/ICAT/lib/JCE/US_export_policy.jar:/opt/IBM/ICAT/lib/JCE/ibmpkcs.jar:
/opt/IBM/ICAT/ibmjava131/jre/lib/rt.jar:/opt/IBM/ICAT/ibmica.jar com.
ibm.cimom.CIMOM
root 62884 40012 3 18:29:22 pts/7 0:00 grep cimom

If the CIMOM daemon is started, type the following command to stop it:
# <dest-path>/stopcimom

where <dest-path> is the directory where the CIMOM daemon resides.

3. Type the following command to see if the SLP daemon is started:
# ps -ef | grep slpd
daemon 61026 1 0 Oct 16 - 0:18 /opt/IBM/ICAT/slp/slpd
root 62884 40012 3 18:29:22 pts/7 0:00 grep slpd

# kill 61026
4. Run the removal program in graphical mode (see “Removing in graphical
mode”) or in unattended (silent) mode (see “Removing in unattended (silent)
mode” on page 57) to remove the IBM CIM Object Manager Service and
Service Location Protocol.

Removing in graphical mode

Perform the following steps to remove the CIM Agent in graphical mode:
1. Type the following command to run the uninstall program from the _uninst
subdirectory:
# cd <dest-path>/_uninst
# uninstaller

where <dest-path> is the target directory where CIM Agent is installed.

2. If the wizard was not created during the CIM Agent installation, type the
following command:
# <dest-path>/ibmjava131/jre/bin/java -jar <dest-path>/_uninst/uninstall.jar

where <dest-path> is the target directory where CIM Agent is installed.

3. The Welcome window opens. Click Next to continue with the removal program,
or click Cancel to exit the removal program.

Chapter 3. CIM Agent for Linux 53

 The program detects if the service location protocol (SLP) and the IBM CIM
Object Manager (CIMOM) services are running and displays the following
information:
v If the SLP and CIMOM are running, the Stopping Services window asks if
you want to continue with the removal program. In that case, click Next to
stop the services. Click Cancel to stop the services yourself (manually).
v If you want to manually stop the services, you must exit the removal program,
stop the services and the applications that use them, and then run the
removal program again from the beginning.
Attention: You must be careful if you have other applications that use the
SLP service. If you do, you must stop these applications before you stop the
SLP service because the SLP service is deleted during the removal process.

54 ESS API Reference

 v If neither the SLP service nor the CIMOM service is running, the removal
program continues with the Confirmation window.
4. The Confirmation window opens, displaying the location of the product that will
be removed. Click Remove to continue with the removal program, or click
Cancel to exit.

Chapter 3. CIM Agent for Linux 55

 5. The Uninstallation Progress window opens. Wait for the program to remove the
CIM Agent. If you do not want to continue with the removal, click Cancel to
return to the Confirmation window.

6. The Finish window opens displaying information about the result of removal
(successfully or failed).

Click Finish to end the removal program.

56 ESS API Reference

Removing in unattended (silent) mode
Steps:

Perform the following step to remove the CIM Agent in unattended (silent) mode:
1. You can invoke the unattended (silent) uninstall program by issuing the
following commands:

# <dest-path>/_uninst/uninstaller -silent

If the CIMOM Agent server or the Service Location Protocol are still running, the
uninstall will fail. In this case, you must stop both of those services or run the
uninstall program with -G stopProcessesResponse=“yes”:

# <dest-path>/_uninst/uninstaller -silent -G stopProcessesResponse=“yes”

The removal program messages are logged in /tmp/cimagent/uninstall.log.

Post-processing requirements:

The CIM Agent removal process does not remove configuration files, logs, and
similar files that are created during or after the installation process. They are
located in the destination path where CIM Agent component was installed. For
example, the default target directory is /opt/IBM/cimagent.

Remove the directory and all of its contents (especially if you plan to reinstall CIM
Agent).

Note: If you want to keep the old configuration files, before removing them from the
installation destination path, save them in another location on your system to
restore them later.

To remove the directory cimagent you must type the following command:
# rm -Rf /opt/IBM/cimagent

Note: The recursive remove is used in the example because the CIM Agent has a
deep directory structure. The recursive remove is very powerful and
dangerous. You must use the fully qualified directory name.

Chapter 3. CIM Agent for Linux 57

58 ESS API Reference
Chapter 4. ESS CIM Agent for Windows
This chapter includes an overview of the installation process and instructions for
installing and configuring the ESS CIM Agent on a Windows 2000, or later,
operating system.

Installation overview for Windows

This section provides an overview of the installation and configuration of the ESS
CIM Agent on a Windows 2000, or later, operating system. Ensure that you have
knowledge of how to administer a Windows 2000, or later, operating system before
you install the ESS CIM Agent. Also be familiar with the commands that you use
during installation and configuration of the ESS CIM Agent. See Chapter 5, “CIM
Agent installation and configuration commands,” on page 87 for information about
the commands.

The following list of installation and configuration tasks are in the order in which
they should be performed:
1. Before you install the ESS CIM Agent for Windows, you should check the
hardware and software requirements listed in “ESS CIM Agent installation
requirements” on page 5.
2. Install the prerequisite ESS CLI software, as instructed in “Installing the ESS
CLI for Windows” on page 60.
Attention: If you are upgrading from a previous version of the ESS CIM Agent,
you must uninstall the ESS CLI software that was required by the previous CIM
Agent and reinstall the latest ESS CLI software, which is level 2.3.0.13.
3. You can choose to install the ESS CIM Agent either in graphical mode with the
help of an installation wizard or in unattended mode (also known as silent
mode), which involves customizing a response file and issuing a command.
a. If you want to install the ESS CIM Agent in graphical mode perform the
instructions in “Installing the ESS CIM Agent on Windows in graphical mode”
on page 61.
b. If you want to install the ESS CIM Agent in unattended mode perform the
instructions in “Installing the ESS CIM Agent on Windows in unattended
(silent) mode” on page 69.
4. Verify the installation by performing the instructions in “Verifying the ESS CIM
Agent Windows installation” on page 71.
5. Configure the ESS CIM Agent for Windows by performing the instructions in
“Configuring the ESS CIM Agent for Windows” on page 72. You might want to
revisit this section in the future as you add, change, or delete CIMOM
authentication and ESS information.
6. Configure the ESS CIM Agent to run in secure mode by performing the optional
instructions in “Configuring the ESS CIM Agent to run in unsecure mode” on
page 75. Verify connection to your ESS by performing the instructions in
“Verifying connection to the ESS” on page 76.
7. Remove the ESS CIM Agent by performing the instructions in “Removing the
ESS CIM Agent for Windows” on page 80. You only need to perform this
optional task if you get errors during installation verification or if the ESS CIM
Agent did not set the environment variables.

© Copyright IBM Corp. 2004 59

Installing the ESS CLI for Windows
Before you install the ESS CIM Agent you must install the IBM TotalStorage
Enterprise Storage System Command Line Interface (ESS CLI). The ESS CIM
Agent installation program checks your system for the existence of the ESS CLI
and reports that it cannot continue if the ESS CLI is not installed.

Requirement: You must have a minimum ESS CLI level of 2.3.0.13.

Steps:

Perform the following steps to install the ESS CLI for Windows:
1. Insert the CD for the ESS CLI in the CD-ROM drive.
The ESS CLI software can be found on the CD with the label ESS CLI.

Note: The ESS CLI installation wizard detects if you have an earlier level of the
ESS CLI software installed on your system and uninstalls the earlier
level. After the uninstallation, you must restart the ESS CLI installation
program to install the current level of the ESS CLI.
2. Open the document IBM TotalStorage Enterprise Storage Server:
Command-Line Interfaces User’s Guide on the ESS CLI CD. (The ESS CLI is
referred as the Storage Management CLI in this Guide.)
3. Follow the instructions in the guide for installing the ESS CLI on a Windows
operating system. The product you need can be found in the winCLI\IBMesscli
subdirectory of the ESS CLI installation CD.
4. Respond Yes if you are prompted by the ESS CLI installation program to have it
set the system path for you.
5. Reboot your system now or before proceeding with the ESS CIM Agent
installation. You must do this because the ESS CLI is dependent on
environmental variable settings which will not be effective for the ESS CIM
Agent. This is because the CIM Agent runs as a service unless you reboot your
system.
6. Verify that the ESS CLI is installed:
a. Click Start –> Settings –> Control Panel.
b. Double-click the Add/Remove Programs icon.
c. Verify that there is an “IBM ESS CLI” entry.
7. Verify that the ESS CLI is operational and can connect to the ESS. For
example, from a command prompt window, issue the following command:
esscli -u essuser -p esspass -s 9.111.111.111 list server
where
v 9.111.111.111 represents the IP address of the Enterprise Storage Server
v essuser represents the Enterprise Storage Server Specialist user name
v esspass represents the Enterprise Storage Server Specialist password for the
user name
The following response is displayed:
Thu Oct 09 11:22:28 PDT 2003 IBM ESSCLI 2.3.0.1

Server Model Mfg WWN CodeEC Cache NVS Racks

---------- ----- --- ---------------- --------- ----- ----- -----
2105.22232 800 013 5005076300C09470 2.3.0.357 8GB 2GB 1

60 ESS API Reference

| 8. Verify that the CLI.CFG file is set correctly. From the Command Prompt window,
| issue the following command:
| rsTestConnection.exe /s /v primaryservername
| where
| v /s primaryservername represents the IP address or the complete host name
| of an ESS Copy Services server.
| v /v designates that all responses from the server be displayed.

Post-processing requirements:

If the ESS CLI is installed, but the environmental variable PATH that is available to
the parent process does not include the IBM ESS CLI directory location, the
program might display an error message. This can occur when the ESS CLI is
invoked from the IBM ESS CLI directory in the Command Prompt window that was
opened before the ESS CLI was installed, for example:
C:\Program Files\IBM>esscli
“esscli” is not recognized as an internal or external command, operable program or
batch file.

If the ESS CLI was recently installed, the INSTALL environmental variable will not
be available to processes which started before the CLI installation such as
Command Prompts or the Windows Services Manager. You may see the following
message in a Command Prompt window which was started before the installation of
the ESS CLI.
C:\Program Files\IBM ESS CLI>esscli
esscli: No value is specified for the <INSTALL> system variable. If the CLI was recently
installed,it might be necessary to reboot in order to refresh the INSTALL environment
variable.

Note: It is necessary to reboot in order to make the INSTALL environment variable

available to Windows Services Manager before you run the ESS CIM Agent,
otherwise the CIM Agent runs as a Windows Service otherwise.

If you receive error messages similar to these, you must reboot the system to
ensure that the ESS CLI environmental variables take effect.

Installing the ESS CIM Agent on Windows in graphical mode

This section includes the steps to install the ESS CIM Agent in your Windows
system. If you choose to install the ESS CIM Agent in unattended mode skip this
section and follow the instructions in “Installing the ESS CIM Agent on Windows in
unattended (silent) mode” on page 69. You must satisfy all prerequisites listed in
“ESS CIM Agent installation requirements” on page 5 before starting the installation.

Steps:

Perform the following steps to install the ESS CIM Agent:

1. Log on to your system as the local administrator.
2. Insert the CIM Agent for ESS CD into the CD-ROM drive.
The ESS CIM Agent program should start within 15 - 30 seconds if you have
autorun mode set on your system. If the LaunchPad window does not open,
perform the following steps:

Chapter 4. ESS CIM Agent for Windows 61

 a. Use a Command Prompt or Windows Explorer to change to the Windows
directory on the CD.
b. If you are using a Command Prompt window, type:
LaunchPad
c. If you are using Windows Explorer, double-click on the LaunchPad.bat file.

Note: If you are viewing the folder with Windows Explorer with the option
selected to hide file extensions for known file types, find the
LaunchPad file with the file type of MS-DOS Batch File.
3. The following options are displayed when the LaunchPad window opens:
CIM Agent Overview Offers information about the ESS CIM Agent
Readme file Offers any last minute product information that
did not make it into this installation guide
Installation guide Offers instructions on how to install the ESS
CIM Agent (a softcopy of this document)
License agreement Offers information about the license for the ESS
CIM Agent
CIM Agent Web site Offers information from the product Web site
Installation wizard Starts the ESS CIM Agent installation program
Post installation tasks Offers information about configuring users and
device communication
Exit Exits the ESS CIM Agent LaunchPad program

Figure 5. LaunchPad window

62 ESS API Reference

4. Click the Readme file from the LaunchPad window or from the README.txt file
located in the doc or Windows directory on the CIM Agent for ESS CD to check
for information that might supersede the information in this guide.
5. Click Installation wizard from the LaunchPad window to start the installation.

Note: The LaunchPad window remains open behind the installation wizard so
that you can access product information during the installation process.
Click Exit if you want to close the LaunchPad.
6. There might be a slight delay while the software loads on your system. After the
software loads a DOS prompt window opens to display the following message:
Initializing InstallShield Wizard...
Preparing Java (tm) Virtual Machine ............................. .
......................................................

7. The Welcome window opens suggesting what documentation you should review
prior to installation. Click Next to continue, or click Cancel to exit the
installation.

8. The License Agreement window opens. Read the license agreement

information. Select I accept the terms of the license agreement, then click
Next to accept the license agreement. Otherwise, keep the selection I do not
accept the terms of the license agreement (it is the default) and click Cancel
to exit the installation.

Chapter 4. ESS CIM Agent for Windows 63

 9. The Product Installation Check window opens and the wizard verifies that your
machine meets the installation requirements.
v If you have a service location protocol (SLP) service that is different from the
SLP that the ESS CIM Agent requires, the installation wizard displays an
error and asks you to stop the installation and remove this SLP service from
the system.
v If the installation wizard detects an SLP Windows service that was previously
installed by a different CIM Agent (for example, SVCC or SVCCisco), the
Service Location Protocol Check window opens. If you would like to use the
ESS CIM Agent SLP, you must uninstall the previously installed SLP and then
proceed with the installation of the ESS CIM Agent SLP. Otherwise, continue
the ESS CIM Agent installation using the existing SLP. In this case, the ESS
CIM Agent SLP files are copied to the hard disk and the SLP is not installed
as a Windows service.
v The installation wizard checks if the ESS CLI client is installed on your
machine at a version level which is at or above the minimum prerequisite
level.
v The wizard checks whether a version of the CIM Agent is already installed. If
the CIM Agent is installed, it checks whether the SLP service and the IBM
CIM Object Manager (CIMOM) service are started. If these services are
started and you want to continue the installation program, select the Next
button. Or, if you want to exit the installation program, select the Cancel
button. If you choose to continue, you must stop all of the daemons and
dependent applications that use these services. You can save the old
configuration settings (for example, user names, passwords, and device IP
addresses) by selecting the check box that you see on the window.

64 ESS API Reference

10. The Destination Directory window opens. Select one of the following options:
a. Click Next to accept the default directory.
b. Click Browse to select a different directory for installation and then click
Next to continue the installation process.
c. Click Cancel to exit the installation process.

Chapter 4. ESS CIM Agent for Windows 65

 Notes:
a. The Destination Directory window is displayed only if a version of CIM
Agent is not already installed. Otherwise, the CIM Agent is reinstalled or
upgraded to the same install location.
b. If the program detects insufficient space for the ESS CIM Agent installation
in the chosen destination, an error message is displayed. You can free
some space on the destination drive and then click Next or you can stop
the installation program by clicking Cancel. You can also go back by
clicking Back, and choose another destination directory for the product.
11. The Updating CIMOM Port window opens. Click Next to accept the default
port. If the default port is the same as another port already in use, modify the
default port and click Next. Use the following command to check which ports
are in use:

netstat -a

Or, click Cancel to exit the wizard.

12. The Installation Confirmation window opens. Click Install to confirm the
installation location and file size. Click Cancel to exit the installation wizard or
go back to the previous window by clicking Back.

66 ESS API Reference

13. The Installation Progress window opens indicating how much of the installation
has been completed. Installation usually takes 3 - 10 minutes depending on
the configuration of your machine. You can click Cancel to exit the installation
wizard.

Note: If you click Cancel a popup window opens asking you to confirm the
cancellation of the installation wizard: “Cancel the current operation?
Yes No”. Be aware that if you confirm the cancellation by clicking Yes,
the information you entered or selected in previous windows is not
saved. You must start the installation again from the first step.

Chapter 4. ESS CIM Agent for Windows 67

 14. When the Installation Progress window closes, the Finish window opens.
Check the View post installation tasks check box if you want to continue
with post installation tasks when the wizard closes. Before proceeding, you
might want to review the log file for any possible error messages. The log file
is located in xxx\logs\install.log, where xxx is the destination directory where
the ESS CIM Agent for Windows is installed. The install.log contains a trace of
the installation actions.
15. Click Finish to exit the installation wizard.

68 ESS API Reference

 Note: Ordinarily, you do not need to restart your system during or after the
installation of the ESS CIM Agent. However, the installation wizard
might determine that a restart is necessary. Restart your system if
required. After you restart the system, the installation wizard continues
with the installation.
16. Exit the LaunchPad program by clicking Exit on the LaunchPad window. If you
have not done so already, continue with the post installation tasks for the ESS
CIM Agent using the instructions in the following sections. “Verifying the ESS
CIM Agent Windows installation” on page 71 is the next task. You can also
continue the post installation tasks using the following option:
a. Click Post installation tasks on the LaunchPad window.
b. Continue with the post installation tasks for the ESS CIM Agent by
following the instructions in this file.

Related topics:
v “Installing the ESS CIM Agent on Windows in unattended (silent) mode”
v “Verifying the ESS CIM Agent Windows installation” on page 71
v “Configuring the ESS CIM Agent for Windows” on page 72
v “Configuring the ESS CIM Agent to run in unsecure mode” on page 75
v “Verifying connection to the ESS” on page 76
v “Removing the ESS CIM Agent for Windows” on page 80

Installing the ESS CIM Agent on Windows in unattended (silent) mode

The unattended (silent) install option allows you to run installation unattended. Use
this method of installation to customize a response file and issue a command from
a command prompt window. The response file is a template on the ESS CIM Agent
CD. You can also create a standard response file to ensure that the product is
installed consistently on multiple systems. You must satisfy all prerequisites listed in
“ESS CIM Agent installation requirements” on page 5 before starting the installation.

Steps:

Perform the following steps to install the ESS CIM Agent in your Windows
environment using the unattended mode:
1. Log on as local administrator user.
2. Insert the CIM Agent for ESS CD.
3. Locate the response file (named responsefile) on your CIM Agent for ESS CD in
the W2K directory.
4. Using Windows Explorer or a command prompt, copy the response file to your
hard drive.
5. Using a text editor modify the default options in the response file with the values
you want:
v Remove the # character from the beginning of a line if you do not want to
use the default value. Change the default value to the value that you want for
that option. You must enclose all values in double quotation marks (″″).
v The <-P product.installLocation> option defines the default directory where
the product is to be installed. To specify a destination directory other than the
default, remove the # character from the corresponding line and replace the
default directory with the desired directory.

Chapter 4. ESS CIM Agent for Windows 69

 v The <-G checkPrerequisite> option checks the prerequisites. If you want to
disable this option, remove the # character from the corresponding line and
change the value of the option to no.
v The <-G startUpgrade> option enables the installation of the CIM Agent over
a previous installation of CIM Agent having the same version (reinstall) or
lower version (upgrade). If you want to enable this option, remove the #
character from the corresponding line and change the value of the option to
yes.
v The <-G stopProcessesResponse> option tells the install program whether to
automatically stop SLP and CIM Agent services when you reinstall or
upgrade the product. By default this option is set to no. If you do not change
this default value, the reinstallation or upgrade stops when these service are
running. If you want to automatically stop the SLP and CIMOM, remove the #
character from the corresponding line and change its value to yes.
v The <-G saveConfiguration> option specifies whether to save the
configuration settings (for example, user names, passwords, and device IP
addresses) when reinstalling or upgrading the product. If you do not want to
save the configuration settings when reinstalling or upgrading, remove the #
character from the corresponding line and change the value of the option to
no.
v The <-W cimObjectManagerPorts.port> option specifies the ESS CIM Agent
server port. If you want to change the default value during installation,
remove the # character from the corresponding line and change the default
port value (5989) with the desired port value.
v The <-W cimObjectManagerPorts.serverCommunication> option specifies the
ESS CIM Agent server communication protocol. If you want to change the
default value during installation, remove the # character from the
corresponding line and change the default server communication protocol
(HTTPS) to HTTP protocol.
6. Save the modifications to the responsefile file. Save the file without a file
extension such as .txt.
7. From a command prompt window, type the following command:
<CD drive path>\W2K\install -options <response file
path>\responsefile
where <CD drive path> is the path of your CD-ROM drive. <response file path>
is the path of the responsefile file that you copied in step 4 on page 69 and
customized in step 5 on page 69.
8. During the installation you will see dotted lines scrolling across the screen.
When the installation program ends you see the cursor.
9. Check for installation errors in the install.log file. After all the prerequisites
checks have been performed, the log file is copied to the <dest-path>\logs
directory. This file can be found in the <dest-path >\logs\ directory.. This file is
initially created in the system temporary file under the subdirectory cimagent.
The following is an example of an install.log file:

70 ESS API Reference

 (Oct 13, 2003 11:35:58 AM), This summary log is an overview of the sequence of the
installation of the IBM
TotalStorage CIM Agent for ESS V1R2 1.2.0.1
(Oct 13, 2003 11:36:11 AM), IBM TotalStorage CIM Agent for ESS V1R2 installation
process started with the following install parameters:
Target Directory: "C:\Program Files\IBM\cimagent"
(Oct 13, 2003 11:36:13 AM), Copying Service Location Protocol Files ...
(Oct 13, 2003 11:36:14 AM), Service Location Protocol successfully installed
(Oct 13, 2003 11:36:14 AM), Copying CIM Object Manager Files ...
(Oct 13, 2003 11:37:06 AM), IBM CIM Object Manager - ESS port successfully updated.
(Oct 13, 2003 11:37:06 AM), IBM CIM Object Manager - ESS communication protocol
successfully updated.
(Oct 13, 2003 11:37:06 AM), The file setupCmdLine.bat successfully updated.
(Oct 13, 2003 11:37:06 AM), Compile MOF files started ...
(Oct 13, 2003 11:38:18 AM), MOF files successfully compiled.
(Oct 13, 2003 11:38:18 AM), Generate a certificate store started ...
(Oct 13, 2003 11:38:27 AM), Certificate store called truststore successfully generated.
(Oct 13, 2003 11:38:27 AM), IBM CIM Object Manager - ESS successfully installed
(Oct 13, 2003 11:38:36 AM), Command to be executed : net start cimomsrv
(Oct 13, 2003 11:38:46 AM), The following services started successfully:
Service Location Protocol
IBM CIM Object Manager - ESS
(Oct 13, 2003 11:38:46 AM), INSTSUCC: The IBM TotalStorage CIM Agent for ESS V1R2 has
been successfully installed.

10. Close the command prompt window by entering a command, for example exit.
Continue with the post installation tasks for the ESS CIM Agent using the
instructions in the following sections. “Verifying the ESS CIM Agent Windows
installation” is the next task. You can also continue the post installation tasks
using the following option:
a. Open the LaunchPad from the command prompt window by typing
LaunchPad.
b. Click Post installation tasks on the LaunchPad window. Continue with the
post installation tasks for the ESS CIM Agent by following the instructions
in this file.

Related topics:
v “Verifying the ESS CIM Agent Windows installation”
v “Installing the ESS CIM Agent on Windows in graphical mode” on page 61
v “Configuring the ESS CIM Agent for Windows” on page 72
v “Configuring the ESS CIM Agent to run in unsecure mode” on page 75
v “Verifying connection to the ESS” on page 76
v “Removing the ESS CIM Agent for Windows” on page 80

Verifying the ESS CIM Agent Windows installation

This task verifies that your ESS CIM Agent is installed correctly on your Windows
system.

Steps:

Perform the following steps to verify your ESS CIM Agent installation:
1. Verify the installation of the Service Location Protocol (SLP).
a. Verify that the Service Location Protocol is started. Select Start -> Settings
-> Control Panel. Double-click the Administrative Tools icon. Double-click
the Services icon.

Chapter 4. ESS CIM Agent for Windows 71

 b. Find Service Location Protocol in the Services window list. For this
component, the Status column should be marked Started and the Startup
Type column should be marked Manual.
c. If SLP is not started, right-click on the SLP and select Start from the pop-up
menu. Wait for the Status column to be changed to Started.
d. Do not close the Services window because you will also use it to verify the
CIM object manager (CIMOM) service.
2. Verify the installation of the ESS CIM Agent.
a. Verify that the CIMOM service is started. If you closed the Services window,
select Start -> Settings -> Control Panel. Double-click the Administrative
Tools icon. Double-click the Services icon.
b. Find the IBM CIM Object Manager - ESS in the Services window list. For
this component, the Status column should be marked Started and the
Startup Type column should be marked Automatic.
c. If the IBM CIM Object Manager is not started, right click on the IBM CIM
Object Manager - ESS and select Start from the pop-up menu. Wait for the
Status column to change to Started.
d. Close the Services window.
e. Close the Administrative Tools window.

Result:

If you are able to perform all of the verification tasks successfully, the ESS CIM
Agent has been successfully installed on your Windows system. Next, perform the
configuration tasks in “Configuring the ESS CIM Agent for Windows.”

Related topics:
v “Configuring the ESS CIM Agent for Windows”
v “Configuring the ESS CIM Agent to run in unsecure mode” on page 75
v “Verifying connection to the ESS” on page 76
v “Removing the ESS CIM Agent for Windows” on page 80

Configuring the ESS CIM Agent for Windows

This task configures the ESS CIM Agent after it has been successfully installed.
This section repeats the instructions in the Post Installation Tasks option that you
open from the LaunchPad window (see Figure 5 on page 62).

72 ESS API Reference

Steps:

Perform the following steps to configure the ESS CIM Agent:

Note: In addition to the configuration steps below, you can use the modifyconfig
command to change the configuration of some of the parameters that were
configured during installation. You can change the CIM Agent port value,
protocol (HTTP/HTTPS), and enable or disable the debug option. See
“modifyconfig” on page 122 for a description of the modifyconfig command
syntax.
1. Configure the ESS CIM Agent for each Enterprise Storage Server to which the
ESS CIM Agent can have access. Open a Command Prompt window and
change directory into the ESS CIM Agent directory, for example: C:\Program
Files\IBM\cimagent. Type the following command to start the interactive
setdevice tool to identify ESSs servers to the CIMOM:
setdevice
Obtain an IP address, user name, and password for each device (such as, an
ESS) that the ESS CIM Agent is to manage:
a. Type the following command for each ESS:
>>>addess 9.111.111.111 essuser esspass

where
v 9.111.111.111 represents the IP address of the Enterprise Storage Server
v essuser represents the Enterprise Storage Server Specialist user name
v esspass represents the Enterprise Storage Server Specialist password for
the user name
The following is a sample output:
An ess provider entry for IP 9.111.111.111 successfully added

where 9.111.111.111 is the IP address.

b. Type the following command for each ESS server that is configured for
Copy Services:
>>> addessserver 9.111.111.111 essuser esspass

where
v 9.111.111.111 represents the IP address of the Enterprise Storage Server
v essuser represents the Enterprise Storage Server Specialist user name
v esspass represents the Enterprise Storage Server Specialist password for
the user name
The following is a sample output:
An essserver entry for IP 9.111.111.111 successfully added

where 9.111.111.111 is the IP address.

2. Repeat step 1 for each additional device (an ESS) that you want to configure.
3. Close the setdevice interactive session by typing exit.
4. Once you have defined all the ESS servers, you must stop and restart the
CIMOM to make the CIMOM initialize the information for the ESS servers.

Chapter 4. ESS CIM Agent for Windows 73

 Because the CIMOM collects and caches the information from the defined ESS
servers at startup time, the starting of the CIMOM might take a longer period of
time the next time you start it.
Perform the following steps to use the Windows Start Menu facility to stop and
restart the CIMOM:
a. Stop the CIMOM by selecting Start -> Programs -> IBM TotalStorage CIM
Agent for ESS -> Stop CIMOM service. A Command Prompt window
opens to track the stoppage of the CIMOM.

Note: You might see an error message popup window labeled “java.exe -
Application Error”. You must click OK to close that window to
continue.
If the CIMOM has stopped successfully, the following message is displayed:
The IBM CIM Object Manager - ESS service was stopped successfully.

Press any key to close the Command Prompt Window.

b. Restart the CIMOM by selecting Start -> Programs -> IBM TotalStorage
CIM Agent for ESS -> Start CIMOM service. A Command Prompt Window
opens to track the progress of the starting of the CIMOM.
The restarting of the CIMOM may take a while because it is connecting to
the defined ESS servers and is caching that information for future use. If the
CIMOM has started successfully, the following message displayed:
The IBM CIM Object Manager - ESS service was started successfully.

Press any key to close the Command Prompt Window.

5. Use the setuser interactive tool to configure the CIMOM for the users who will
have the authority to use the CIMOM.

Note: The users which you will configure to have authority to use the CIMOM
are uniquely defined to the CIMOM software and have no required
relationship to operating system user names, the ESS Specialist user
names, or the ESS Copy Services user names.
Upon installation of the CIM Agent for ESS, the provided default user name is
“superuser” with a default password of “passw0rd”. The first time you use the
setuser tool, you must use this user name and password combination. Once
you have defined other user names, you can start the setuser command by
specifying other defined CIMOM user names.

Note: The CIMOM must have been started to run the setuser command.
a. Open a Command Prompt window and change directory to the ESS CIM
Agent directory, for example:
C:\Program Files\IBM\cimagent
b. Type the following command at the command prompt to start the setuser
interactive session to identify users to the CIMOM:
setuser -u superuser -p passw0rd
c. Type the following command in the setuser interactive session to define
new users:
>>>adduser cimuser cimpass

where

74 ESS API Reference

 v cimuser represents the new user name to access the ESS CIM Agent
CIMOM
v cimpass represents the password for the new user name to access the
ESS CIM Agent CIMOM
The following is a sample output:
An entry for user cimuser successfully added

where cimuser is your new user name.

Restriction: You cannot delete or modify the current user who started the
setuser interactive session.
6. Repeat step 5c on page 74 for each additional user name that you want to
configure.
7. You can change the default password for “superuser” by starting the setuser
command and providing a user name and password. Then, issue the setuser
interactive session command to change the password for the superuser:
>>>chuser superuser newpasswd

where newpasswd is the new password for the superuser.

You can also delete the superuser by issuing the following setuser interactive
session command:
>>>rmuser superuser
8. Close the setdevice interactive session by typing exit.

Note: Unlike the setdevice actions, you do not need to stop and restart the
CIMOM to make the setuser actions take effect.

Result:

If you were able to perform all of the configuring tasks successfully, the ESS CIM
Agent has been successfully installed and configured on your Windows system.

Related topics:
v “Configuring the ESS CIM Agent to run in unsecure mode”
v “Verifying connection to the ESS” on page 76
v “Removing the ESS CIM Agent for Windows” on page 80

Configuring the ESS CIM Agent to run in unsecure mode

Some vendor software might not be capable of communicating with the ESS CIM
Agent in a secure fashion. If you wish to, you can still use this vendor software by
configuring the ESS CIM Agent to run with only basic user and password security.

Chapter 4. ESS CIM Agent for Windows 75

 Steps:

Perform the following steps to configure the ESS CIM Agent to run in unsecure
mode:
1. Using the Windows Start Menu facility, stop the CIMOM by selecting Start ->
Programs -> IBM TotalStorage CIM Agent for ESS -> Stop CIMOM service.
2. Using the Windows Services facility, stop and start the Service Location
Protocol (SLP) service by selecting Start -> Settings -> Control Panel.
Double-click Administrative Tools and double click Services. Right click
Service Location Protocol in the Name column and select Stop in the menu.
After the SLP stops, start it again by right-clicking on Service Location Protocol
in the Name column and selecting Start in the menu. After the SLP starts, close
the Services Window and the Administrative Tools Window.
3. Find the cimom.properties file and edit it with a tool such as notepad, setting the
properties as shown in the following example:

Port=5988
ServerCommunication=HTTP
DigestAuthentication=False
Once the CIMOM starts, it accepts requests over HTTP using basic
authentication.

Note: To completely disable security checking, set “Authorization=False ” in the

cimom.properties file.
4. Using the Windows Start Menu facility, restart the CIMOM by selecting Start ->
Programs -> IBM TotalStorage CIM Agent for ESS -> Start CIMOM service.
The CIMOM registers itself with SLP using the revised attributes.
5. Close this window by pressing any key when you are prompted by the following
display:
The IBM CIM Object Manager service is starting .....
The IBM CIM Object Manager service was started successfully
Press any key to continue ...

Related topics:
v “Verifying connection to the ESS”
v “Removing the ESS CIM Agent for Windows” on page 80

Verifying connection to the ESS

During this task the ESS CIM Agent software connects to the Enterprise Storage
Server (ESS) that you identified in the configuration task. The connection to the
ESS is through the ESS CLI software. If the network connectivity fails or if the user
name and password that you set in the configuration task is incorrect, the ESS CIM
Agent cannot connect successfully to the ESS. The installation, verification, and
configuration of the ESS CIM Agent must be completed before you verify the
connection to the ESS.
1. Verify that you have network connectivity to the ESS from the system where the
ESS CIM Agent is installed. To do this, perform the following steps:
a. Open a Command Prompt Window.
b. Issue a ping command to the ESS, for example:

76 ESS API Reference

 ping 9.11.111.111

where 9.11.111.111 is the ESS IP address

c. Check that you can see reply statistics from the ESS IP address. The
following is example output:
Pinging 9.11.111.111 with 32 bytes of data:

Reply from 9.11.111.111: bytes=32 time<10ms TTL=255

Reply from 9.11.111.111: bytes=32 time<10ms TTL=255
Reply from 9.11.111.111: bytes=32 time<10ms TTL=255
Reply from 9.11.111.111: bytes=32 time<10ms TTL=255

If you see other messages indicating that the request has timed out, see
your Network Administrator for help on establishing network connectivity
from the system where the ESS CIM Agent is installed.
2. Verify that the ESS CLI is operational and can connect to the ESS. To do this,
perform the following steps:
a. Open a Command Prompt Window.
b. Issue the following command:
essc i -u essuser -p esspass
-s 9.111.111.111 list server

where
v 9.111.111.111 represents the IP address of the Enterprise Storage Server
v essuser represents the Enterprise Storage Server Specialist user name
v esspass represents the Enterprise Storage Server Specialist password for
the user name
The following is an example of a successful response:
Thu Oct 09 11:22:28 PDT 2003 IBM ESSCLI 2.3.0.1
Server Mode Mfg WWN CodeEC Cache NVS Racks
---------- ----- --- ---------------- --------- ----- ----- -----
2105.22232 800 013 5005076300C09470 2.3.0.357 8GB 2GB

| c. Verify that the CLI.CFG file is set correctly. From the command prompt
| window, issue the following command:
| rsTestConnection.exe /s /v primaryservername
| where
| v /s primaryservername represents the IP address or the complete host
| name of an ESS Copy Services server.
| v /v designates that all responses from the server be displayed.

Note: It has been found in some cases that the ESS CLI will not work correctly
unless the system has been rebooted following the new installation of the
ESS CLI.
3. Using the Windows Services Facility, verify that the SLP is active by selecting
Start -> Settings -> Control Panel. Double-click the Administrative Tools
icon. Double-Click the Services icon.
v Find the Service Location Protocol (SLP) in the Name column.
For this component, the Status column should be marked Started and the
Startup Type column should be marked Manual.

Chapter 4. ESS CIM Agent for Windows 77

 v If SLP is not started, right click on Service Location Protocol and click Start
from the popup menu. Wait for the Status to change to Started.
v Close the Services window and the Administrative Tools window.
4. Verify that the CIMOM is active by selecting Start -> Programs -> IBM
TotalStorage CIM Agent for ESS->Start CIMOM service. A Command Prompt
window opens to start the CIMOM. If the CIMOM is already started, the
following message is displayed:
The requested service has alredy been started.

Otherwise, the window tracks the progress of the starting of the CIMOM. Be
aware that the starting of the CIMOM might take a while because it is
connecting to the defined ESS servers and is caching that information for future
use. When the CIMOM has completed starting, the following message is
displayed:
The IBM CIM Object Manager - ESS service was started successfully

Press any key to close the Command Prompt Window.

5. Verify CIMOM registration with SLP by selecting Start->Programs-
>TotalStorage CIM Agent for ESS->Check CIMOM Registration. The window
closes when you press any key, as instructed in the output:
service: wbem:http://tpc035/ 5988, 65535
press any key to continue...

Note: If the verification of the CIMOM registration is not successful, stop and
restart the SLP and CIMOM services.
6. Use the verifyconfig command to locate all WBEM services in the local
network. This command verifies that you have configured the ESS CIM Agent
and can connect to at least one ESS.
Type the verifyconfig command in another command prompt window in the
directory where the ESS CIM Agent was installed, for example:
c:\program files\ibm\cimagent
verifyconfig -u <username> -p <password>
where username is the user name and password is the password for the user
name that you configured to manage the CIMOM.
If successful, output similar to the following is displayed:
C:\program files\ibm\cimagent>verifyconfig -u guest -p guest
Verifying configuration of ESS CIM Agent...
Communicating with SLP to find WBEM services...
1 WBEM services found
host=kirchhofer, port=5989
Connecting to ESS CIM Agent, host=kirchhofer, port=5989
Found 1 IBMTSESS_StorageSystem instances
Verification Successful

You might run into the following errors:

v Error Type 1. E CMMOM0002E CIM_ERR_ACCESS_DENIED
If you enter an invalid CIMOM user name or password or forget to pass the
CIMOM user name or password on the invocation of verifyconfig, the
following message series is displayed near the end of the output messages:

78 ESS API Reference

 E CMMOM0002E CIM_ERR_ACCESS_DENIED
at com.ibm.http.HTTPClient.sendRequest(Unknown Source)
at com.ibm.http.HTTPClient.sendRequest(Unknown Source)
at com.ibm.xml.XMLOperationGeneric.intrinsicMethod(Unknown Source)
at com.ibm.xml.XMLOperationGeneric.intrinsicMethod(Unknown Source)
at com.ibm.xml.XMLEnumerateInstances.enumInstances(Unknown Source)
at com.ibm.xml.CIMOMHandleXML.enumInstances(Unknown Source)
at com.ibm.cim.CIMClient.enumInstances(Unknown Source)
at com.ibm.cimom.install.VerifyConfig.enumInstances(Unknown Source)
at com.ibm.cimom.install.VerifyConfig.enumInstances(Unknown Source)
at com.ibm.cimom.install.VerifyConfig.main(Unknown Source)
FAILED requesting IBMTSESS_StorageSystem instances

v Error Type 2. ESS CIM Agent not correctly configured

If any of the following are true:
– You have never used the setdevice tool to define an ESS to the CIMOM
– You made an error in the ESS IP address, user name, or password
– You did not restart the CIMOM after adding the ESS
the following message series is displayed near the end of the output
messages:
Connecting to ESS CIM Agent, host=1.11.111.111, port=5689
Found 0 IBMTSESS_StorageSystem instances
ESS CIM Agent not correctly configured

You can find more information about the possible cause of this error message
by examining the cimomx.log (where x can be a number from 1 - 9).
If you have a network connection problem or you have set an incorrect IP
address for the ESS while using the setdevice tool, the ESS CLI cannot
connect to the ESS. A message pair similar to the following can appear in the
log:
2003-10-30 08:37:03,PST-08:00 E CIMOM[com.ibm.provider.ess.EssCLICmdHandler.
outputEssCliError(Unknown Source)]: ESSCLI Error
[java.lang.Object{esscli 204: The connection to the specified server was
not established.}]

2003-10-30 08:37:03,PST-08:00 E CIMOM[com.ibm.provider.ess.EssProvider.initialize

(Unknown Source)]: esscli list server failed for 9.43.227.19,
trying again... [java.lang.Object{Operation Failed. RC=2}]

If you have entered an incorrect user name or password for the ESS while
using the setdevice tool, the ESS CLI can connect to the ESS but will not be
able to authenticate. A message pair similar to the following can appear in the
log:
2003-10-30 10:32:53,PST-08:00 E CIMOM[com.ibm.provider.ess.EssCLICmdHandler.
outputEssCliError(Unknown Source)]: ESSCLI Error
[java.lang.Object{esscli 510: Access was denied by the server.}]

2003-10-30 10:32:53,PST-08:00 E CIMOM[com.ibm.provider.ess.EssProvider.initialize

(Unknown Source)]: esscli list server failed for 9.43.227.19,
trying again... [java.lang.Object{Operation Failed. RC=5}]

If you did not reboot after installing the ESS CLI or before you ran the ESS
CIM Agent verifyconfig program, the ESS CLI will have a problem finding an
environmental variable. A message similar to the following can appear in the
log:

Chapter 4. ESS CIM Agent for Windows 79

 2003-10-29 17:26:02.608-08:00 [java.lang.Object{esscli: No value is
specified for the <INSTALL> system variable.}] I
CIMOM[com.ibm.provider.ess.EssProvider.initialize(Unknown Source)]:
store01.storage.sanjose.ibm.com IP esscli list server failed, tryin again...

v Error Type 3. E CMMOM0001E CIM_ERR_FAILED(E CMMOM0001E

CIM_ERR_FAILED)
If you have not installed the ESS CLI on your system, the following message
series is displayed near the end of the output messages:
Connecting to ESS CIM Agent, host=1.11.111.11, port=5689
E CMMOM0001E CIM_ERR_FAILED(E CMMOM0001E CIM_ERR_FAILED)
at com.ibm.xml.XMLOperationGeneric.processReturnStream(Unknown Source)
at com.ibm.xml.XMLOperationGeneric.intrinsicMethod(Unknown Source)
at com.ibm.xml.XMLOperationGeneric.intrinsicMethod(Unknown Source)
at com.ibm.xml.XMLEnumerateInstances.enumInstances(Unknown Source)
at com.ibm.xml.CIMOMHandleXML.enumInstances(Unknown Source)
at com.ibm.cim.CIMClient.enumInstances(Unknown Source)
at com.ibm.cimom.install.VerifyConfig.enumInstances(Unknown Source)
at com.ibm.cimom.install.VerifyConfig.enumInstances(Unknown Source)
at com.ibm.cimom.install.VerifyConfig.main(Unknown Source)
FAILED requesting IBMTSESS_StorageSystem instances

v Error Type 4. No ESS CIM Agent running or registered with SLP on current
host
If the ESS CIM Agent is not started or it has not registered with SLP on the
current host, the following message is displayed in the output messages in
the Command Prompt window:
No ESS CIM Agent running or registered with SLP on current host

Result:

This completes the verification of the connection to the ESS.

Removing the ESS CIM Agent for Windows

This optional task gives the instructions for removing the ESS CIM Agent from your
Windows system.

Steps:

Perform the following steps to remove the ESS CIM Agent:

1. Log on to the system where the ESS CIM Agent is installed. Log on with a
user name that is a local system administrator.
2. Stop the CIMOM and the SLP services if they are started.
a. Click Start -> Settings -> Control Panel. In the Control Panel window,
double-click on the Administrative Tools icon and then double-click the
Services icon. The Services window opens.
b. Stop the SLP service if it has already been installed by the ESS CIM Agent
installer:
1) In the Services window, scroll to IBM CIM Object Manager - ESS.
Click on the service to select it.
2) If the Status column shows Started, right-click the service, then click
Stop on the menu.
c. Stop the SLP service:

80 ESS API Reference

 Note: You must be careful if you have other applications that use SLP
service. In this case, you must stop these applications before
stopping SLP service, because during the removal process the SLP
service will be deleted. You must also stop the configuration utilities
for the ESS CIM Agent, if they are running.
1) In the Services window, scroll to Service Location Protocol. Click on
this service to select it.
2) If it is running (the Status column shows Started), right-click the
service, then click Stop on the menu.
(If you did not stop the IBM CIM Object Manager service, the system
now asks if you want to stop the IBM CIM Object Manager service.
Because CIM Object Manager service is dependent on the Service
Location Protocol service which you just stopped, you must click YES
to stop the CIM Object Manager service.)
3) Wait for the services to stop.
4) Close the Services window.
5) Close the Administrative Tools window.
3. Use the Windows Add/Remove Programs facility to remove the ESS CIM
Agent and the Service Location Protocol components.
a. From the Windows menu bar, click Start -> Settings -> Control Panel.
Double-click Add/Remove Programs.
b. Click IBM TotalStorage CIM Agent for ESS from the list of currently
installed programs and click Remove to remove the product.

4. The Welcome window for the Uninstaller opens. Click Next to continue or click
Cancel to stop the removal of the ESS CIM Agent.

Chapter 4. ESS CIM Agent for Windows 81

 5. The program detects whether the SLP and the CIMOM services are running.
v You should consider at this point whether applications other than the ESS
CIM Agent are dependent on the services.
a. Click Next to have the program stop the services for you.
b. Click Cancel to exit the removal process if you wish to manually stop
the services and any dependent applications, which is recommended.
Instructions for stopping the services are described in step 2 on page
80. You must then restart the removal process from the Windows
Add/Remove facility.
v If the SLP service is not started, the program continues with a Confirmation
window for the Uninstaller. The Confirmation window displays the location
from which the ESS CIM Agent and the SLP and CIMOM features 5916 will
be removed.

Note: If the SLP service was installed by a CIM Agent other than the ESS
CIM Agent, only the SLP files that were copied during the ESS CIM
Agent installation are removed and the SLP windows service will not
be uninstalled.

82 ESS API Reference

6. Click Remove to continue or click Cancel to stop the removal of the ESS CIM
Agent. Click Back to return to the previous window.

7. The Uninstallation Progress window opens. Wait for the program to remove the
ESS CIM Agent product.

Chapter 4. ESS CIM Agent for Windows 83

 8. The Finish window for the Uninstaller opens. This window indicates the result
of the removal process (successful or failed). Click Finish to complete the
removal process and exit the wizard.

If the program could not remove some information from the system, the
Restart window opens. You will need to restart your system. At the restart, the
previously locked files are released and automatically deleted.
9. Close the Add/Remove Programs window.
10. Restart the system (now or later) to complete the removal process.

84 ESS API Reference

Post-processing requirements:

Perform the following steps to complete the removal process:

1. If the system has not been restarted since ESS CIM Agent was removed, do so
now.
2. Log on as a local administrator.
3. Remove other files and folders for ESS CIM Agent, as the removal process
does not delete configuration files, logs, and similar files that were created
during or after the installation process. The files are located in the destination
path where you installed the ESS CIM Agent. An example of the default
destination path is: C:\Program Files\IBM\cimagent. Remove the cimagent
folder and all of its contents (especially if you plan to reinstall ESS CIM Agent).

Note: If you want to keep the old configuration files, save them in another
location on your system to restore them later before removing them from
the installation destination path.
4. Perform other cleanup tasks:
a. Close both the Services and the Add/Remove Program windows if you have
not already done so.
b. Empty your Windows Recycle Bin to reclaim the disk space that was made
available during the removal process.

Chapter 4. ESS CIM Agent for Windows 85

86 ESS API Reference
Chapter 5. CIM Agent installation and configuration
commands
This chapter includes information about the commands that you use when you
install and configure the CIM Agent on a server or workstation running Linux, UNIX,
or Windows 2000 or later operating system. This chapter also presents a complete
character syntax of the programs, commands, flags, and values that you can use
for each command. There is also a section that shows examples of commands and
the output that results from issuing the command.

Overview of the CIM Agent commands and subcommands

This section briefly introduces the CIM Agent commands and provides general
guidelines for using the commands.

Before you use the commands, refer to the appropriate chapter for your operating
system for information about how to install or configure and enable the CIM Agent:
v AIX: Chapter 2, “CIM Agent on AIX,” on page 7
v Linux: Chapter 3, “CIM Agent for Linux,” on page 33
v Windows 2000 or later: Chapter 4, “ESS CIM Agent for Windows,” on page 59

Description of commands
You can use several commands on the CIM Agent command line interface to
perform various tasks within the CIM Agent. Table 2 lists the commands that you
can use with the CIM Agent.
Table 2. Summary of CIM Agent commands
Command Type of Description
command
modifyconfig Configuration Updates the cimom.properties configuration
file.
mkcertificate Utility Runs during installation to ensure that your
security is not compromised.
setdevice Configuration Updates the configuration of the managed
devices
setuser Configuration Updates the configuration for the users of the
Enterprise Storage Server.
slpd Utility Starts automatically during installation and
registers itself with the SLP daemon and
enables the client code to find the ESS CIM
Agent service.
startcimom Operational Starts the CIM Agent
stopcimom Operational Stops the CIM Agent
verifyconfig Utility Locates all WBEM services in the local
network and displays them, then calls the
CIMOMs on the local machine to request
information about the ESS.

© Copyright IBM Corp. 2004 87

Invoking the CIM Agent
There are two ways to invoke the CIM Agent:
v Single command line invocation
You can invoke a command by including all the relevant subcommands,
parameters and values on one command line.
v Interactive mode
You can invoke a program which opens an interactive session and displays the
following command prompt >>> at the beginning of each line.

Conventions used in this chapter

This section describes the notational conventions that are used in this chapter for
the syntax diagrams.

Syntax diagrams
A syntax diagram uses symbols to represent the elements of a command and to
specify the rules for using these elements. This section shows you how to read the
syntax diagrams that represent the CIM Agent commands. In doing so, it defines
the symbols that represent the CIM Agent command elements.
Main path line



Begins on the left with double arrowheads (>>) and ends on the right with
two arrowheads facing each other (><). If a diagram is longer than one line,
each line to be continued ends with a single arrowhead (>) and the next
line begins with a single arrowhead. Read the diagrams from left-to-right,
top-to-bottom, following the main path line.
Keyword

setuser


Represents the name of a command, flag, parameter, or argument. A

keyword is not in italics. Spell a keyword exactly as it is shown in the
syntax diagram.
Required keywords

adduser


Indicate the parameters or arguments you must specify for the command.
Required keywords appear on the main path line. Required keywords that
cannot be used together are stacked vertically.
Optional keywords


-h
-help
-?

88 ESS API Reference

 Indicate the parameters or arguments you can choose to specify for the
command. Optional keywords appear below the main path line. Optional
keywords that cannot be used together are stacked vertically.
Default value

on


-cre off


Appears above the main path line.

Repeatable keyword or value

 newports ALL

PortId1,PortId2,...

Represents a parameter or argument that you can specify more than once.
A repeatable keyword or value is represented by an arrow returning to the
left above the keyword or value.
parameter values

user password


Represents the value you need to supply for a parameter or argument,

such as a file name, user name, or password. Variables are in italics.
Space separator

chuser password


Adds a blank space on the main path line to separate keywords,

parameters, arguments, or variables from each other.
Syntax fragment

Fragment name


Fragment name:

( fragment details )

Breaks up syntax diagrams that are too long, too complex, or repetitious.
The fragment name is inserted in the main diagram, and the actual
fragment is shown below the main diagram.

Chapter 5. CIM Agent installation and configuration commands 89

Special characters
The following special characters are used in the command examples:
− (minus) or / (slash) sign
Flags are prefixed with a − (minus) or / (slash) sign. Flags define
the action of a command or modify the operation of a command.
You can use multiple flags, followed by parameters, when you issue
a command.
[] square brackets
Optional values are enclosed in square brackets.
{ } braces Required or expected values are enclosed in braces.
| vertical bar A vertical bar signifies that you choose only one value.
For example, [ a | b ] indicates that you can choose a, b, or
nothing. Similarly, { a | b } indicates that you must choose either
a or b.
... ellipsis An ellipsis signifies the values that can be repeated on the
command line.

Emphasis
The following typefaces are used to show emphasis:
boldface Text in boldface represents menu items and command names.
italics Text in italics is used to emphasize a word. In command syntax, it
is used for variables for which you supply actual values.
monospace Text in monospace identifies the data or command instances that you
type, samples of command output, examples of program code or
messages from the system, or names of command flags,
parameters, arguments, and name-value pairs.

Anatomy of a command line

This section describes the parts of a command line string and also shows an
example of a command line string

The command-line string, as discussed in this document, consists of the following

parts:
Command name Name of the command, such as setuser, that the
user invokes to use the command line interface
Subcommand name Name of the command that the user executes, such
as adduser or addess.
Command options Options that modify the behavior of the command.
Command options can be required or optional.
Flags Command options marked with dash before the
name, such as -create. Sometimes flags require
extra parameters and sometimes they do not.
Values Command options that set the value of a flag.
Arguments Required target (object) of the command and are
always the last items, not associated with an option,
on the command line

90 ESS API Reference

 This is an example of a command line string.

setuser -u userlogin -p loginpassword

Configuration commands
The following sections describe the following CIM agent configuration commands
that you can invoke in interactive mode:
v setuser
v setdevice
v modifyconfig

Description of subcommands
You can use several subcommands on the CIM Agent configuration commands to
perform various configuration tasks within the CIM Agent. Table 3 describes of the
subcommands that you can use with the CIM Agent configuration commands in
interactive mode:
Table 3. Summary of CIM Agent setuser and setdevice subcommands
Command Subcommands and description
setuser
adduser Adds a user entry to the password file.
chuser Changes the user entry in the password
file.
lsuser Lists the users that currently exist in the
password file.
rmuser Removes the user from the password file.
setentry Lists or sets the -create, -quiet, or -equiv
options globally.
setoutput Lists or sets the -hdr option globally.
exit Terminates the interactive session and
exits from the application.
help or ? Lists the available subcommands.

Chapter 5. CIM Agent installation and configuration commands 91

 Table 3. Summary of CIM Agent setuser and setdevice subcommands (continued)
Command Subcommands and description
setdevice
addess Adds the specified ESS provider entry to
the configuration file.
addessserver Adds the specified ESS server entry to the
configuration file.
chess Changes the specified ESS provider entry
in the configuration file.
chessserver Changes the specified ESS server entry in
the configuration file.
lsess Lists the ESS provider entries that
currently exist in the configuration file and
meet the optional search criteria.
lsessserver Lists the ESS server entries that currently
exist in the configuration file and that meet
the optional search criteria.
rmess Removes the specified ESS provider entry
from the configuration file.
rmessserver Removes the specified ESS server entry
from the configuration file.
setentry Lists or sets the -create, -quiet, or -equiv
options globally.
setoutput Lists or sets the -hdr option globally.
exit Terminates the interactive session and
exits from the application.
help or ? Lists the available subcommands.
modifyconfig There are no subcommands for the modifyconfig
command.

92 ESS API Reference

setuser
Description
Use the setuser command in interactive mode to update the configuration file
containing the user names and encrypted passwords for the users allowed to
access the ESS CIM Agent CIMOM. You can list one or all users, add a user,
change a user password, or remove a user.

You can use the following subcommands with the setuser command:
v adduser
v chuser
v lsuser
v rmuser
v setentry
v setoutput
v exit
v help or ?

Syntax


setuser -u user -p password


This section describes the syntax for the options and values that you can use with
the setuser subcommand.

Parameters
[-u] Use -u with your username to log on to CIMOM and modify accounts.
[-p] Use -p with your password to log on to CIMOM and modify accounts.

Examples
When you type the following subcommand, using the setuser command in
interactive mode,
>>>adduser jsmith abcdef

The following output displays on your screen:

An entry for user jsmith successfully added

Chapter 5. CIM Agent installation and configuration commands 93

adduser
Use the adduser subcommand to add a user entry to the password file.

Syntax


adduser

-h -q on
-help -quiet off

user password


Parameters
This section describes the syntax for the options and values you can use with the
adduser subcommand.
[-h | -help]
Displays a help message.
[-q[uiet] on | off]
Use -q or -quiet to prevent the dialog for confirmation or parameter input if it is
to replace an existing entry.
If you set the value to on, you do not get a prompt that requests that you
confirm the parameter input.
If you set the value to off, you get a prompt that requests that you confirm the
parameter input if it is to replace an existing entry.

Examples
When you type the following subcommand, using the setuser command in
interactive mode,
>>>adduser jsmith abcdef

The following output displays on your screen:

An entry for user jsmith successfully added

94 ESS API Reference

chuser
Use the chuser subcommand to change the user entry in the password file.

Syntax


chuser

-h -q on
-help -quiet off

user password


Parameters
This section describes the syntax for the options and values you can use with the
chuser subcommand.
[-h | -help]
Displays a help message.
[-q[uiet] on | off]
Use -q or -quiet to prevent the dialog for confirmation or parameter input.
If you set the value to on, you do not get a prompt that requests that you
confirm the parameter input.
If you set the value to off, you get a prompt that requests that you confirm the
parameter input before the subcommand executes effectively.

Examples
When you type the following subcommand using the setuser command in
interactive mode:
>>>chuser jsmith xyztuv

The following output displays on your screen:

Tne entry for user jsmith successfully changed

Chapter 5. CIM Agent installation and configuration commands 95

lsuser
Use the lsuser subcommand to list the users that currently exist in the password
file.

Syntax


lsuser

-h -hdr on user
-help off

Parameters
This section describes the syntax for the options and values you can use with the
lsuser subcommand.
[-h | -help]
Displays a help message.
[-hdr on | off]
Use -hdr to specify whether or not the lsuser subcommand displays the header
line.
If you set the value to on, the lsuser subcommand displays a header line
before the lines containing information about the users.
If you set the value to off, the lsuser subcommand does not display the header
line.

Examples
When you type the following subcommand using the setuser command in
interactive mode:
>>>lsuser -hdr on

The following output displays on your screen:

USER : ENCRYPTED PASSWORD
jsmith : PyyvPJl1/VTa+1TD
ljohnson : gKguQMSQjpnKEii3
bcollins : Uj15YZ6uNg==

96 ESS API Reference

rmuser
Use the rmuser subcommand to remove the user from the password file.

Syntax


rmuser user

-h -q on
-help -quiet off

Parameters
This section describes the syntax for the options and values you can use with the
rmuser subcommand.
[-h | -help]
Displays a help message.
[-q[uiet] on | off]
Use -q or -quiet to prevent the dialog for confirmation or parameter input.
If you set the value to on, you do not get a prompt that requests that you
confirm the parameter input.
If you set the value to off, you get a prompt that requests that you confirm the
parameter input before the command executes effectively.

Examples
When you type the following subcommand using the setuser command in
interactive mode:
>>>rmuser jsmith

The following output displays on your screen:

User jsmith successfully removed

Chapter 5. CIM Agent installation and configuration commands 97

setentry
Use the setentry subcommand to list or set the -quiet option globally.

Syntax


setentry

-h -q on
-help -quiet off

Parameters
This section describes the syntax for the options and values you can use with the
setentry command.
[-h | -help]
Displays a help message.
[-q[uiet] on | off]
Use -quiet in interactive mode to set the -quiet option to on or off for the
subsequent commands in the interactive session. It applies as a default to the
subsequent adduser, chuser or rmuser subcommands, except for the
subcommands that explicitly specify the -quiet option.
Notes:
1. When the setuser command starts, the -quiet option is set to either the
value that is specified as command options (if present in the command line)
or to the following initial default value: -quiet on.
2. The setentry subcommand without any argument displays the current state
of the options -quiet.

Examples
When you type the following subcommand and parameters using the setuser
command in interactive mode:
>>>setentry

The following output displays on your screen:

quiet=on

98 ESS API Reference

setoutput
Use the setoutput command to list or set the -hdr option globally

Syntax


setoutput

-h -hdr on
-help off

Parameters
This section describes the syntax for the options and values you can use with the
setoutput command.
[-h | -help]
Displays a help message.
[-hdr on | off]
Use -hdr in interactive mode to set the -hdr option to on or off for the
subsequent commands in the interactive session. It applies as a default to the
subsequent lsuser commands, except for the commands that explicitly specify
the -hdr option.
Notes:
1. When the setuser command starts, the -hdr option is set to the value
specified as command option (if present in the command line) or to the
following initial default value: -hdr on.
2. The setentry subcommand without any argument displays the current state
of the option -hdr.

Examples
When you type the following subcommand and parameters using the setuser
command in interactive mode:
>>>setoutput

The following output displays on your screen:

hdr=on

Chapter 5. CIM Agent installation and configuration commands 99

setdevice
Description
Use the setdevice command to update the configuration of managed devices. You
can also use the setdevice command to define the ESS that is managed by the
ESS CIM Agent. You must have a username, password, and valid internet protocol
address of an ESS to access the ESS CIM Agent.

There are two ways to invoke the setdevice command:

v Single command line invocation
You can invoke a command by including all the relevant subcommands,
parameters and values on one command line.
v Interactive mode
You can invoke a program which opens an interactive session and displays the
following command prompt >>> at the beginning of each line.

You can use the following commands with the setdevice command:
v addess
v addessserver
v chess
v chessserver
v lsess
v lsessserver
v rmess
v rmessserver
v setentry
v setoutput
v exit
v help or ?

100 ESS API Reference

addess
Use the addess subcommand to add the specified ESS provider entry to the
configuration file.

Syntax


addess

-h -cre on
-help -create off

-q on -e on
-quiet off -equiv off

ip user password


Parameters
This section describes the syntax for the options and values you can use with the
addess subcommand.
[-h | -help]
Use -h or -help to display the help for the adduser subcommand.
[-cre[ate] on | off]
Use -cre or -create to create the configuration file if it does not already exist.
If you set the value to on, the command automatically creates the configuration
file if it does not already exist.
If you set the value to off and the configuration file does not already exist, you
get an error message and the operation stops.
[-e[quiv] on | off]
Use -e or -equiv to specify whether or not the addess and chess
subcommands are equivalent.
If you set the value to on, the addess and chess subcommands are equivalent.
The commands create an entry if an entry with the same key does not exist. Or,
the command updates the existing entry if an entry with the same key already
exists.
If you set the value to off, addess and chess are not considered equivalent.
You get an error message when you use addess if an entry with the same key
already exists. Or, you get an error message when you use chess if an entry
with the same key does not exist.
[-q[uiet] on | off]
Use -q or -quiet to prevent the dialog for confirmation or parameter input.
If you set the value to on, you do not get a prompt that requests that you
confirm the parameter input.
If you set the value to off, you get a prompt that requests that you confirm the
parameter input if it is to replace an existing entry (assuming -equiv on).

Chapter 5. CIM Agent installation and configuration commands 101

 Examples
When you type the following subcommand and parameters using the setdevice
command in interactive mode,
>>>addess 1.2.3.4 msmith abcdef

The following output displays on your screen:

An ess provider entry for IP 1.2.3.4 successfully added

102 ESS API Reference

addessserver
Use the addessserver subcommand to add the specified ESS server entry to the
configuration file.

Syntax


addessserver

-h -cre on
-help -create off

-q on -e on
-quiet off -equiv off

ip user password


Parameters
This section describes the syntax for the options and values you can use with the
addessserver subcommand.
[-h | -help]
Use -h or -help to display the help for the adduserserver subcommand.
[-cre[ate] on | off]
Use -cre or -create to create the configuration file if it does not already exist.
If you set the value to on, the command automatically creates the configuration
file if it does not already exist.
If you set the value to off and the configuration file does not already exist, you
get an error message and the operation stops.
[-e[quiv] on | off]
Use -e or -equiv to specify whether or not the addessserver and chess
subcommands are equivalent.
If you set the value to on, the addessserver and chess subcommands are
equivalent. The commands create an entry if an entry with the same key does
not exist. Or, the command updates the existing entry if an entry with the same
key already exists.
If you set the value to off, addessserver and chess are not considered
equivalent. You get an error message when you use addessserver if an entry
with the same key already exists. Or, you get an error message when you use
chess if an entry with the same key does not exist.
[-q[uiet] on | off]
Use -q or -quiet to prevent the dialog for confirmation or parameter input.
If you set the value to on, you do not get a prompt that requests that you
confirm the parameter input.
If you set the value to off, you get a prompt that requests that you confirm the
parameter input if it is to replace an existing entry (assuming -equiv on).

Chapter 5. CIM Agent installation and configuration commands 103

 Examples
When you type the following subcommand and parameters using the setdevice
command in interactive mode,
>>>addessserver 1.2.3.4 msmith abcdef

The following output displays on your screen:

An ess copy services provider entry for IP 1.2.3.4 successfully added

104 ESS API Reference

chess
Use the chess subcommand to change the specified ESS provider entry in the
configuration file.

Syntax


chess

-h -cre on
-help -create off

-q on -e on
-quiet off -equiv off

ip user password


Parameters
This section describes the syntax for the options and values you can use with the
chess subcommand.
[-h | -help]
Use -h or -help to display the help for the chess subcommand.
[-cre[ate] on | off]
Use -cre or -create to create the configuration file if it does not already exist.
If you set the value to on, the command automatically creates the configuration
file if it does not already exist.
If you set the value to off and the configuration file does not already exist, you
get an error message and the operation stops.
[-e[quiv] on | off]
Use -e or -equiv to specify whether or not the addess and chess
subcommands are equivalent.
If you set the value to on, the addess and chess subcommands are equivalent.
The commands create an entry if an entry with the same key does not exist. Or
the command updates the existing entry if an entry with the same key already
exists.
If you set the value to off, addess and chess are not considered equivalent.
You get an error message when you use addess if an entry with the same key
already exists. Or, you get an error message when you use chess if an entry
with the same key does not exist.
[-q[uiet] on | off]
Use -q or -quiet to prevent the dialog for confirmation or parameter input.
If you set the value to on, you do not get a prompt that requests that you
confirm the parameter input.
If you set the value to off, you get a prompt that requests that you confirm the
parameter input before the command executes successfully.

Chapter 5. CIM Agent installation and configuration commands 105

 Examples
When you type the following subcommand and parameters using the setdevice
command in interactive mode:
>>>chess 1.2.3.4 ljohnson xyztuv

The following output displays on your screen:

The ess provider entry for IP 1.2.3.4 successfully changed

106 ESS API Reference

chessserver
Use the chessserver subcommand to change the specified ESS Copy Services
server entry in the configuration file.

Syntax


chessserver

-h -cre on
-help -create off

-q on -e on
-quiet off -equiv off

ip user password


Parameters
This section describes the syntax for the options and values that you can use with
the chessserver subcommand.
[-h | -help]
Use -h or -help to display the help for the chessserver subcommand.
[-cre[ate] on | off]
Use -cre or -create to create the configuration file if it does not already exist.
If you set the value to on, the command automatically creates the configuration
file if it does not already exist.
If you set the value to off and the configuration file does not already exist, you
get an error message and the operation stops.
[-e[quiv] on | off]
Use -e or -equiv to specify whether or not the addessserver and chessserver
subcommands are equivalent.
If you set the value to on, the addessserver and chessserver subcommands
are equivalent. The commands create an entry if an entry with the same key
does not exist. Or, the command updates the existing entry if an entry with the
same key already exists.
If you set the value to off, addessserver and chessserver are not considered
equivalent. You get an error message when you use addessserver if an entry
with the same key already exists. Or, you get an error message when you use
chessserver if an entry with the same key does not exist.
[-q[uiet] on | off]
Use -q or -quiet to prevent the dialog for confirmation or parameter input.
If you set the value to on, you do not get a prompt that requests that you
confirm the parameter input.
If you set the value to off, you get a prompt that requests that you confirm the
parameter input before the command executes successfully.

Chapter 5. CIM Agent installation and configuration commands 107

 Examples
When you type the following subcommand and parameters using the setdevice
command in interactive mode:
>>>chessserver 1.2.3.4 ljohnson xyztuv

The following output displays on your screen:

The ess provider entry for IP 1.2.3.4 successfully changed

108 ESS API Reference

lsess
Use the lsess subcommand to list the ESS provider entries that currently exist in
the configuration file and meet the optional search criteria.

Syntax


lsess

-h -hdr on
-help off


ip
user

Parameters
This section describes the syntax for the options and values you can use with the
lsess subcommand.
[-h | -help]
Use -h or -help to display the help for the lsess subcommand.
[-hdr] on | off]
Use -hdr to control the display of the header line when using the lsess
subcommand.
If you set the value to on, the lsess subcommand displays a header line before
the lines containing information about the ESS entries.
If you set the value to off, the lsess subcommand does not display the header
line before the lines containing information about the ESS entries.

Examples
When you type the following subcommand and parameters using setdevice
command in interactive mode:
>>>lsess -hdr off 1.2.3.4

The following output displays on your screen:

1.2.3.4:ljohnson:ol8xPOgGhB0=

Chapter 5. CIM Agent installation and configuration commands 109

lsessserver
Use the lsessserver subcommand to list the ESS server entries that currently exist
in the configuration file and that meet the optional search criteria.

Syntax


lsessserver

-h -hdr on
-help off


ip
user

Parameters
This section describes the syntax for the options and values you can use with the
lsess subcommand.
[-h | -help]
Use -h or -help to display the help for the lsessserver subcommand.
[-hdr] on | off]
Use -hdr to control the display of the header line when using the lsessserver
subcommand.
If you set the value to on, the lsessserver subcommand displays a header line
before the lines that contain information about the ESS Copy Services entries.
If you set the value to off, the lsessserver subcommand does not display the
header line before the lines that contain information about the ESS Copy
Services entries.

Examples
When you type the following subcommand and parameters using setdevice
command in interactive mode:
>>>lsessserver -hdr off 1.2.3.4

The following output displays on your screen:

1.2.3.4:ljohnson:ol8xPOgGhB0=

110 ESS API Reference

rmess
Use the rmess subcommand to remove the specified ESS provider entry from the
configuration file.

Syntax


rmess

-h -cre on
-help -create off

ip

-q on
-quiet off

Parameters
This section describes the syntax for the options and values you can use with the
rmess subcommand.
[-h | -help]
Use -h or -help to display the help for the rmess subcommand.
[-cre[ate] on | off]
Use -cre or -create to create the configuration file if it does not already exist.
If you set the value to on, the command automatically creates the configuration
file if it does not already exist.
If you set the value to off and the configuration file does not already exist, you
get an error message and the operation stops.
[-q[uiet] on | off]
Use -q or -quiet to prevent the dialog for confirmation or parameter input.
If you set the value to on, you do not get a prompt that requests that you
confirm the parameter input.
If you set the value to off, you get a prompt that requests that you confirm the
parameter input before the command executes effectively.

Examples
When you type the following subcommand and parameters using the setdevice
command in interactive mode:
>>>rmess -q on 1.2.3.4

The following output displays on your screen:

The ess provider entry for IP 1.2.3.4 successfully removed

Chapter 5. CIM Agent installation and configuration commands 111

rmessserver
Use the rmessserver subcommand to remove the specified ESS Copy Services
server entry from the configuration file.

Syntax


rmessserver

-h -cre on
-help -create off

ip

-q on
-quiet off

Parameters
This section describes the syntax for the options and values you can use with the
rmessserver subcommand.
[-h | -help]
Use -h or -help to display the help for the rmessserver subcommand.
[-cre[ate] on | off]
Use -cre or -create to create the configuration file if it does not already exist.
If you set the value to on, the command automatically creates the configuration
file if it does not already exist.
If you set the value to off and the configuration file does not already exist, you
get an error message and the operation stops.
[-q[uiet] on | off]
Use -q or -quiet to prevent the dialog for confirmation or parameter input.
If you set the value to on, you do not get a prompt that requests that you
confirm the parameter input.
If you set the value to off, you get a prompt that requests that you confirm the
parameter input before the command executes effectively.

Examples
When you type the following subcommand and parameters using the setdevice
command in interactive mode:
>>>rmessserver -q on 1.2.3.4

The following output displays on your screen:

The ess provider entry for IP 1.2.3.4 successfully removed

112 ESS API Reference

setentry
Use the setentry subcommand to list or set the -quiet option globally.

Syntax


setentry

-h -q on
-help -quiet off

Parameters
This section describes the syntax for the options and values you can use with the
setentry subcommand.
[-h | -help]
Displays a help message.
[-q[uiet] on | off]
Use -quiet in interactive mode to set the -quiet option to on or off for the
subsequent subcommands in the interactive session. It applies as a default to
the subsequent addess, chess or rmess subcommands, except for the
subcommands that explicitly specify the -quiet option.
Notes:
1. When the setdevice command starts, the -quiet option is set to the values
that are specified as command options (if present in the command line) or
to the initial default value of -quiet on.
2. The setentry subcommand without any argument displays the current state
of the -quiet option.

Examples
When you type the following subcommand and parameters using the setdevice
command in interactive mode,
>>>setentry

The following output displays on your screen:

quiet=on

Chapter 5. CIM Agent installation and configuration commands 113

setoutput
Use the setoutput subcommand to list or set the -hdr option globally

Syntax


setoutput

-h -hdr on
-help off

Parameters
This section describes the syntax for the options and values you can use with the
setoutput subcommand.
[-h | -help]
Displays a help message.
[-hdr on | off]
Use -hdr in interactive mode to set the -hdr option to on or off for the
subsequent subcommands in the interactive session. It applies as a default to
the subsequent lsuser subcommands, except for the subcommands that
explicitly specify the -hdr option.
Notes:
1. When the setdevice command starts, the -hdr option is set to the value
specified as command option (if present in the command line), or to the
initial default value: -hdr on.
2. The setentry subcommand without any argument displays the current state
of the option -hdr.

Examples
When you type the following subcommand and parameters using the setdevice
command in interactive mode,
>>>setoutput

The following output displays on your screen:

hdr=on

114 ESS API Reference

Operational commands
This section describes the following CIM Agent operational commands:
v startcimom
v stopcimom

Chapter 5. CIM Agent installation and configuration commands 115

startcimom
Use the startcimom command to start the CIM Agent.

Syntax


startcimom


Description
Use the startcimom command to run the CIM Agent code. When you use the
startcimom command, it registers itself with SLP and accepts requests on the port
specified in the cimom.properties file (by default 5989).

This command starts the ESS CIM Agent when the ESS CIM Agent is installed.
Generally it is installed as a service or part of the system inittab. In most cases,
there is no reason to start the ESS CIM Agent manually; however, this command
will start the ESS CIM Agent, if needed.

The certificate used by the ESS CIM Agent must also be made available to each
client software product that intends to communicate with the ESS CIM Agent.

116 ESS API Reference

stopcimom
Use the stopcimom command to stop the CIM Agent.

Syntax


stopcimom


Parameters
There are no options for the stopcimom command.

Description
Use the stopcimom command to stop the ESS CIM Agent.

Related topics
v See “startcimom” on page 116 for the startcimom command.

Chapter 5. CIM Agent installation and configuration commands 117

Utility commands
The following sections describe the following CIM Agent utility commands:
v mkcertificate
v slpd
v verifyconfig

118 ESS API Reference

 mkcertificate
Use the mkcertificate command to check the level of security on your host.

Syntax


mkcertificate


Description
The mkcertificate runs at install time and can be rerun whenever the user feels
that security might be compromised. The mkcertificate command creates an X.509
certificate and places it in a certificate store called truststore. The certificate is
required by client code that communicates with the ESS CIM Agent using SSL
secure communication. If you have installed a product that uses this type of
communication with the ESS CIM Agent, you must be sure that the certificate that is
created with the mkcertificate command is available to all clients and software
products that communicate with the ESS CIM Agent.

| Note: If you get error message CMMOMO116E when you try to connect to
| CIMOM, ensure that the following files are in the same directory where the
| client program resides:
| v truststore
| v cimom.properties
| v niClientLogging.properties
| v logger.properties

Chapter 5. CIM Agent installation and configuration commands 119

slpd
Use the slpd command to enable the client code to find the ESS CIM Agent
service.

Syntax


slpd


Description
The SLP daemon starts automatically by the installation program or at the system
reboot, but you can also start it manually if it is not already running. The ESS Agent
registers itself with the SLP daemon to enable client code to find the ESS CIM
Agent service. You should always keep the SLP daemon running.

The Service Agents (SA) communicate with each other on one subnet of an IP
network to find each other’s services. If you install products that use the ESS CIM
Agent but the products run on multiple subnets, consider designating one of your
SLP daemons to act as a Directory Agent (DA). To do this, change the configuration
that is used by each SLP daemon (slpd.conf) to point to the IP address of the SLP
daemon that is to act as the DA. To do this, change the isDA configuration variable
so that the slpd.conf is true. See the documentation for Open SLP at
http://www.openslp.org/Documentation.

120 ESS API Reference

verifyconfig
Use the verifyconfig command to locate all WBEM services (for example,
CIMOMs) in the local network.

Syntax


verifyconfig

-b
-u
-p

Parameters
This section describes the syntax for the options and values you can use with the
verifyconfig command.
-b Gets basic authentication if authentication is disabled.
-u The username used to log into CIMOM.
-p The password for the username.

Description
The verifyconfig command is used to locate all WBEM services (for example,
CIMOMs) in the local network, display them and then call the CIMOMs on the local
machine only requesting information about whether the CIMOMs know of any ESS.
Locates all WBEM services in the network. These may include ESS CIM Agents or
CIM Agents of other hardware devices. It then communicates with the WBEM
service (that is, CIMOM) running on the local machine, if it is found, and attempts to
retrieve some basic instance information from the CIMOM running there.

Chapter 5. CIM Agent installation and configuration commands 121

modifyconfig
Use the modifyconfig subcommand to modify cimom.properties file properties.

Syntax


modifyconfig

-h -cre on
-help -create off

file propertiesfile

-p port -c http
-port https

user password

-d on
-debug off

Parameters
This section describes the syntax for the options and values you can use with the
modifyconfig command.
[-h | -help]
Displays a help message.
[-cre[ate] on | off]
If you set the value to on, the command automatically creates the properties file
if it does not already exist.
If you set the value to off and the properties file does not already exist, you get
an error message and the operation stops.
[-file propertiesfile]
Use -file flag to specify the properties file, if you want to use a file other than
the default (cimom.properties) file, that must be used by this command.
[-p[ort] port]
Use the -p flag to update the port property value. The port parameter specifies
the value of the port property.
[-c http|https]
Use the -c flag to update the communication protocol value. The possible
values are http or https.
[-d[ebug] on|off]
Use -d or -debug to specify the debug mode. If you set the value to on, the
debug is enabled. If you set the value to off, the debug is disabled.

Examples
When you type the following subcommand, using the modifyconfig command in
interactive mode:
modifyconfig -p 5989 -d on

The following output displays on your screen:

Port (set to 5989) and Debug (set to On)

122 ESS API Reference

Appendix A. ESS API component definitions
This section describes the elements, the namespace, and the object name for the
ESS API.

Elements:

The ESS API consists of the following elements: schemas, classes, properties,
methods, indications, associations, references and qualifiers. The following list
describes each type of element:
Schema A group of classes defined to a single namespace. Within the CIM
Agent, the schemas that are supported are the ones loaded through
the managed object format (MOF) compiler.
Class The definition of an object within some hierarchy. Classes can have
methods and properties and be the target of an association.
Property A value used to characterize instances of a class.
Method An implementation of a function on a class.
Indication An object representation of an event.
Association A class that contains two references which define a relationship
between two objects.
Reference The role that an object plays in an association.
Qualifier Additional information about other elements, classes, associations,
indications, methods, method parameters, instances, properties, or
references.

Namespace: A namespace defines the scope over which an ESS API schema
applies. The only namespace supported by the CIM Agent is root/cimv2. An ESS
API schema or version is loaded into a namespace when that schema is compiled
by the Managed Object Format compiler. ESS API operations always execute within
the context of a namespace. The namespace must be specified within the message
that the client sends to the CIM Agent.

Clients cannot create new namespaces. Attempts to do so result in errors.

Object name: An object name consists of a namespace path and a model path.
The namespace path provides access to the ESS API implementation managed by
the CIM Agent. The model path provides navigation within the implementation. An
example of an object name is:
http://cimom.storage.sanjose.ibm.com/root/cimv2:CIMDisk.key1=value1, key2=value2

where http://cimom.storage.sanjose.ibm.com/root/CIMV2 is the namespace path and

the rest is the model path.

Related topics:
v “CIM Agent communication concepts” on page 125
v “CIM Agent Communication methods” on page 126
v “Error codes returned by the CIMOM” on page 137
v “ESS API class definitions” on page 147
v “ESS class definition schemas” on page 231

© Copyright IBM Corp. 2004 123

124 ESS API Reference
Appendix B. CIM Agent communication with the ESS API
This section describes communication between the ESS CIM Agent and ESS API. It
includes the following information:
v CIM Agent communication concepts
v CIM Agent communication methods
v CIM Agent functional groups
v Error codes returned by the CIMOM

CIM Agent communication concepts

This section describes the concepts involved in communication between the ESS
CIM Agent and the client application.

Client communication:

A client application communicates with the CIM Agent through operation request
messages encoded within XML. The CIM Agent returns responses with operation
response messages. Requests and responses are sub- elements of the CIM
<MESSAGE> element.

A <MESSAGE> sent to the CIM Agent must contain an ID attribute. A response

from the CIM Agent returns this value and thereby enables the client to track
requests and their responses.

The CIM Agent supports simple requests and simple responses. Simple requests
are operation request messages that contain the <SIMPLEREQ> XML tag. Simple
responses are operation response messages that contain the <SIMPLERSP> tag. A
client application determines that the CIM Agent only supports simple operation
requests and responses by examining the results of running the OPTIONS method.

Intrinsic and Extrinsic Methods:

All operations on the CIM Agent are performed by running one or more methods. A
method is either an intrinsic method or an extrinsic method. Intrinsic methods are
supported by the CIM Agent itself. These methods are included within XML
<IMETHODCALL> tags sent in messages to the CIM Agent. Extrinsic methods are
defined by the schema supported by the CIM Agent. These methods are included
within XML <METHODCALL> tags sent in messages to the CIM Agent.

Client applications can call on the CIM Agent using the methods described in “CIM
Agent Communication methods” on page 126. These methods fall within certain
functional groups that might or might not actually be supported by the CIM Agent.

Related topics:
v Appendix A, “ESS API component definitions,” on page 123
v “CIM Agent Communication methods” on page 126
v “Error codes returned by the CIMOM” on page 137
v “ESS API class definitions” on page 147
v “ESS class definition schemas” on page 231

© Copyright IBM Corp. 2004 125

CIM Agent Communication methods
The following sections and tables list the CIM intrinsic and extrinsic communication
methods along with their parameters. Client application calls to these intrinsic
methods result in CIM Agent calls to the device provider, if the device provider
surfaces the classes or instances that are referenced in those calls.

The CIM Agent returns <IMETHODRESPONSE> or <METHODRESPONSE>

elements to the client application when the intrinsic or extrinsic methods are
executed. These elements are contained within a <MESSAGERESPONSE> tag.

GetClass:

Table 4 defines the properties of the GetClass method, which is used to return a
single class from the target namespace.
Table 4. GetClass method parameters
Parameter Type Description
ClassName String Defines the name of the class to retrieve.
LocalOnly Boolean TRUE returns all properties, methods, and qualifiers overridden within the
definition of the class.
IncludeQualifiers Boolean TRUE returns all qualifiers for the class, its properties, methods, or
method parameters. FALSE returns no qualifiers.
IncludeClassOrigin Boolean TRUE returns the CLASSORIGIN attribute of the class.

Return values: Either a single class or one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_FAILED

See Table 23 on page 137 for an explanation of the error codes.

GetInstance:

Table 5 defines the properties of the GetInstance method, which is used to return a
single instance from the target namespace.
Table 5. GetInstance method parameters
Parameter Type Description
InstanceName String Defines the name of the instance to retrieve.
LocalOnly Boolean TRUE returns all properties and qualifiers overridden within the definition
of the class.
IncludeQualifiers Boolean TRUE returns all qualifiers for the class, its properties, methods, or
method parameters. FALSE returns no qualifiers.
IncludeClassOrigin Boolean TRUE returns the CLASSORIGIN attribute of the class.

Return values: Either a single class or one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE

126 ESS API Reference

 v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_NOT_FOUND
v CIM_ERR_FAILED

DeleteClass:

The DeleteClass method is used to delete a single class from the target
namespace.

Note: This operation is not supported. The CIM_ERR_NOT_SUPPORTED error

code is returned to the client application if a request to execute this
operation is received.

DeleteInstance:

Table 6 defines the properties of the DeleteInstance method, which is used to delete
a single instance from the target namespace.
Table 6. DeleteInstance method parameters
Parameter Type Description
InstanceName String Defines the name of the instance to delete.

Return values: The named instance is deleted or one of the following error codes
is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_NOT_FOUND
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

CreateClass:

The CreateClass method is used to create a new class from the target namespace.

Note: This operation is not supported. The CIM_ERR_NOT_SUPPORTED error

code is returned to the client application if a request to execute this
operation is received.

CreateInstance:

Table 7 defines the properties of the CreateInstance method, which is used to

create an instance in the target namespace. The instance must not already exist.
Table 7. CreateInstance method parameters
Parameter Type Description
Instance Object The instance to be created. The instance must be based on a class already
defined in the target namespace.

Appendix B. CIM Agent communication with the ESS API 127

 Return values: If successful, the specified instance is created. Otherwise, one of
the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_ALREADY_EXISTS
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

ModifyClass:

The ModifyClass method is used to modify an existing class.

Note: This operation is not supported. The CIM_ERR_NOT_SUPPORTED error

code is returned to the client application if a request to execute this
operation is received.

ModifyInstance:

Table 8 defines the properties of the ModifyInstance method, which is used to

modify an existing instance in the target namespace. The instance must already
exist.
Table 8. ModifyInstance method parameters
Parameter Type Description
Instance Object Defines the modified instance.

Return values: If successful, the specified instance is updated. Otherwise, one of

the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_NOT_FOUND
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

EnumerateClasses:

Table 9 defines the properties of the EnumerateClasses method, which is used to

return a single class from the target namespace.
Table 9. EnumerateClasses method parameters
Parameter Type Description
ClassName String Defines the name of the class for which subclasses are to be returned. If
this field is NULL, all base classes within the target namespace are
returned.
DeepInheritance Boolean TRUE returns all subclasses of the specified class. FALSE returns only
immediate child subclasses.

128 ESS API Reference

Table 9. EnumerateClasses method parameters (continued)
Parameter Type Description
LocalOnly Boolean TRUE returns all properties, methods, and qualifiers, that are overridden
within the definition of the class.
IncludeQualifiers Boolean TRUE returns all qualifiers for the class, its properties, methods, or
method parameters. FALSE returns no qualifiers.
IncludeClassOrigin Boolean TRUE returns the CLASSORIGIN of the class.

Return values: If successful, zero or more classes (CIMClass) are returned.

Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

EnumerateClassNames:

Table 10 defines the properties of the EnumerateClassNames method, which is

used to enumerate the names of subclasses of a class defined within the target
namespace.
Table 10. EnumerateClassNames method parameters
Parameter Type Description
ClassName String Defines the name of the class for which subclass names are to be
returned. If this field is NULL, all base class names within the target
namespace are returned.
DeepInheritance Boolean TRUE returns all subclass names of the specified class. FALSE returns
only immediate child subclass names.

Return values: If successful, zero or more class names are returned. Otherwise,
one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

EnumerateInstances:

Table 11 on page 130 defines the properties of the EnumerateInstances method,

which is used to enumerate instances of a class defined in the target namespace.

Appendix B. CIM Agent communication with the ESS API 129

Table 11. EnumerateInstances method parameters
Parameter Type Description
ClassName String Defines the name of the class for which instances are to be returned.
LocalOnly Boolean TRUE returns all properties, methods, and qualifiers that are overridden
within the definition of the class.
DeepInheritance Boolean TRUE returns all instances and all properties of the instance, including
those added by subclassing. FALSE returns only properties defined for
the specified class.
IncludeQualifiers Boolean TRUE returns all qualifiers for each instance, its properties, methods, or
method parameters. FALSE returns no qualifiers.
IncludeClassOrigin Boolean TRUE returns the CLASSORIGIN attribute of the class within the
instance.

Return values: If successful, zero or more instances (Objects) are returned.

Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

EnumerateInstanceNames:

Table 12 defines the properties of the EnumerateInstanceNames method, which is

used to enumerate the names of the instances of a class within a target
namespace.
Table 12. EnumerateInstanceNames method parameters
Parameter Type Description
ClassName String Defines the name of the class for which instance names are to be returned.

Return values: If successful, zero or more names of instances are returned.

Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

ExecQuery:

Table 13 on page 131 defines the properties of the ExecQuery method, which is
used to execute a query against the target namespace.

130 ESS API Reference

Table 13. ExecQuery method parameters
Parameter Type Description
QueryLanguage String Defines the query language in which the query parameter is expressed.
Query String Defines the query to be executed.

Return values: If successful, zero or more classes (CIMClass) or instances

(Objects) are returned. Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

Associators:

Table 14 defines the properties of the Associators method, which is used to

enumerate classes or instances that are associated to a particular CIM Object.
Table 14. Associators method parameters
Parameter Type Description
ObjectName String Defines the class name or instance name that is the source of the
association.
AssocClass String If not NULL, indicates that all objects must be associated to the source
object through an instance of this class or one of its subclasses.
ResultClass String If not NULL, indicates that all returned objects must be instances of this
class or one of its subclasses or be this class.
Role String If not NULL, indicates that each return object must be associated to the
source object through an association in which the source object plays the
specified role. The name of the property in the association class that
refers to the source object must match the value of this parameter.
ResultRole String If not NULL, indicates that each returned object must be associated to the
source object via an association in which the return object plays the
specified role. That is, the name of the property in the association class
that refers to the returned object must match the value of this parameter.
IncludeQualifiers Boolean TRUE returns all qualifiers for the class, its properties, methods, or
method parameters. FALSE returns no qualifiers.
IncludeClassOrigin Boolean TRUE returns the CLASSORIGIN attribute of the class.

Return values: If successful, zero or more classes (CIMClass) or instances

(Objects) are returned. Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

Appendix B. CIM Agent communication with the ESS API 131

 AssociatorNames:

Table 15 defines the properties of the AssociatorNames method, which is used to

enumerate the names of the classes or instances that are associated with a
particular CIM Object.
Table 15. AssociatorNames method parameters
Parameter Type Description
ObjectName String Defines the class name or instances name that is the source of the association.
AssocClass String If not NULL, indicates that all object paths returned identify an object that is
associated to the source object through an instance of this class or one of its
subclasses.
ResultClass String If not NULL, indicates that all returned object paths must identify instances of this
class or one of its subclasses or must be this class.
Role String If not NULL, the name of the property in the association class that refers to the
source object must match the value of this parameter.
ResultRole String If not NULL, the name of the property in the association class that refers to the
return object must match the value of this parameter.

Return values: If successful, zero or more class paths (CIMObjectPath) are

returned. Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

References:

Table 16 defines the properties of the References method, which is used to

enumerate the association objects that refer to a particular target class or instance.
Table 16. References method parameters
Parameter Type Description
ObjectName String Defines the class name or instance name whose referring objects are to
be returned.
ResultClass String If not NULL, indicates that all returned objects must be instances of this
class or one of its subclasses or must be this class.
Role String If not NULL, must be a valid property name. Each returned object must
refer to the target object through a property whose name matches the
value of this parameter.
IncludeQualifiers Boolean TRUE returns all qualifiers for the class, its properties, methods, or
method parameters. FALSE returns no qualifiers.
IncludeClassOrigin Boolean TRUE returns the CLASSORIGIN attribute of the class.

Return values: If successful, zero or more classes (CIMClass) or instances

(Objects) are returned. Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER

132 ESS API Reference

 v CIM_ERR_INVALID_CLASS
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

ReferenceNames:

Table 17 defines the properties of the ReferenceNames method, which is used to

enumerate the association objects that refer to a particular target class or instance.
Table 17. ReferenceNames method parameters
Parameter Type Description
ObjectName String Defines the class name or instance name whose referring objects are to be
returned.
ResultClass String If not NULL, indicates that all returned object paths must be object paths of
instances of this class or one of its subclasses, or must be this class.
Role String If not NULL, must be a valid property name. Each returned object must refer to
the target object through a property whose name matches the value of this
parameter.

Return values: If successful, the return value specifies the value of the requested
property. Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_NOT_FOUND
v CIM_ERR_NO_SUCH_PROPERTY
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

GetProperty:

Table 18 defines the properties of the GetProperty method, which is used to retrieve
a single property value from an instance in the target namespace.
Table 18. GetProperty method parameters
Parameter Type Description
InstanceName String Defines the name of the instance.
Property String The name of the property whose value is to be returned from the instance.

Return values: If successful, the return value specifies the value of the requested
property. Otherwise, one of the following return codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_NOT_FOUND
v CIM_ERR_NO_SUCH_PROPERTY

Appendix B. CIM Agent communication with the ESS API 133

 v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

SetProperty:

Table 19 defines the properties of the SetProperty method, which is used to set a
single property value within an instance in the target namespace.
Table 19. SetProperty method parameters
Parameter Type Description
InstanceName String Defines the name of the instance.
PropertyName String The name of the property whose value is to be updated.

Return values: If successful, the instance is updated. Otherwise, one of the

following return codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_INVALID_CLASS
v CIM_ERR_NOT_FOUND
v CIM_ERR_NO_SUCH_PROPERTY
v CIM_ERR_TYPE_MISMATCH
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

GetQualifier:

Table 20 defines the properties of the GetQualifier method, which is used to retrieve
a single qualifier declaration from the target namespace.
Table 20. GetQualifier method parameters
Parameter Type Description
QualifierName String Defines the qualifier whose declaration is to be returned.

Return Values: If successful, the value of the qualifier is returned. Otherwise, one
of the following return codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_NOT_FOUND
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

SetQualifier:

Table 21 on page 135 defines the properties of the SetQualifier method, which is
used to create or update a qualifier declaration in the target namespace.

134 ESS API Reference

Table 21. SetQualifier method parameters
Parameter Type Description
QualifierDeclaration Void Defines the qualifier declaration to be added to the target namespace.

Return values: If successful, the qualifier is updated in the target namespace.

Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_NOT_FOUND
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

DeleteQualifier:

The DeleteQualifier method is used to delete a single class from the target
namespace.

Note: This operation is not supported. The CIM_ERR_NOT_SUPPORTED error

message is returned to the client application if a request to execute this
operation is received.

EnumerateQualifiers:

The EnumerateQualifiers method is used to enumerate qualifier declarations from

the target namespace.

There are no parameters for this method.

Return Values: If successful, zero or more qualifier declarations are returned.

Otherwise, one of the following error codes is returned:
v CIM_ERR_ACCESS_DENIED
v CIM_ERR_INVALID_NAMESPACE
v CIM_ERR_INVALID_PARAMETER
v CIM_ERR_FAILED
See Table 23 on page 137 for an explanation of the error codes.

Related topics:
v “CIM Agent communication concepts” on page 125
v Appendix A, “ESS API component definitions,” on page 123
v “Error codes returned by the CIMOM” on page 137
v “ESS API class definitions” on page 147
v “ESS class definition schemas” on page 231
v “CIM Agent Functional Groups” on page 136

Appendix B. CIM Agent communication with the ESS API 135

CIM Agent Functional Groups
Table 22 describes the functional groups supported by the CIM Agent. This
information is also returned to a client which makes an OPTIONS request of the
CIM Agent.
Table 22. Functional groups for the CIM Agent
Functional group Parameters Supported or Not Supported
Basic read v GetClass Supported
v EnumerateClasses
v EnumerateClassNames
v GetInstance
v EnumerateInstances
v EnumerateInstanceNames
v GetProperty
Basic write v SetProperty Supported

Schema manipulation v CreateClass Not Supported

v ModifyClass
v DeleteClass
Instance manipulation v CreateInstance Supported
v ModifyInstance
v DeleteInstance
Association traversal v Associators Supported
v AssociatorNames
v References
v ReferenceNames
Qualifier declaration v GetQualifier Supported
v SetQualifier
v DeleteQualifier
v EnumerateQualifiers
Query execution v ExecQuery Supported

Related topics:
v “CIM Agent communication concepts” on page 125
v Appendix A, “ESS API component definitions,” on page 123
v “CIM Agent Communication methods” on page 126
v “Error codes returned by the CIMOM” on page 137
v “ESS API class definitions” on page 147
v “ESS class definition schemas” on page 231

136 ESS API Reference

Error codes returned by the CIMOM
This section identifies the possible error codes returned by CIMOM communication
methods.

Return Error Codes:

The CIMOM might return status to the client application in one of two ways:
v Through HTTP status messages or
v Through error codes contained within <METHODRESPONSE> or
<IMETHODRESPONSE> XML tags

Table 23 describes the status codes that the CIMON might return.
Table 23. Return error codes for the CIMON
Symbolic Name Code Definition
CIM_ERR_FAILED 1 A general error occurred that is not covered
by a more specific error code.
CIM_ERR_ACCESS_DENIED 2 Access to a CIM resource was not available
to the client.
CIM_ERR_INVALID_NAMESPACE 3 The target namespace does not exist.
CIM_ERR_INVALID_PARAMETER 4 One or more parameter values passed to the
method were invalid.
CIM_ERR_INVALID_CLASS 5 The specified class does not exist.
CIM_ERR_NOT_FOUND 6 The requested object could not be found.
CIM_ERR_NOT_SUPPORTED 7 The requested operation is not supported.
CIM_ERR_CLASS_HAS_CHILDREN 8 The operation cannot be carried out on this
class because it has instances.
CIM_ERR_CLASS_HAS_INSTANCES 9 The operation cannot be carried out on this
class because it has instances.
CIM_ERR_INVALID_SUPERCLASS 10 The operation cannot be carried out since the
specified superclass does not exist.
CIM_ERR_ALREADY_EXISTS 11 The operation cannot be carried out because
an object already exists.
CIM_ERR_NO_SUCH_PROPERTY 12 The specified property does not exist.
CIM_ERR_TYPE_MISMATCH 13 The value supplied is incompatible with the
type.
CIM_ERR_QUERY_LANGUAGE_NOT_SUPPORTED 14 The query language is not recognized or
supported.
CIM_ERR_INVALID_QUERY 15 The query is not valid for the specified query
language.
CIM_ERR_METHOD_NOT_AVAILABLE 16 The extrinsic method could not be executed.
CIM_ERR_METHOD_NOT_FOUND 17 The specified extrinsic method does not exist.
CIM_ERR_LOW_ON_MEMORY 20 There is not enough memory.
XMLERROR 21 An XML error has occurred.
CIM_ERR_LISTNER_ALREADY_DEFINED 22 The listener is already defined`.
CIM_ERR_INDICATION_NOT_COLLECTED 23 The indications are not collected.
CIM_ERR_NO_METHOD_NAME 24 The method name is null.

Appendix B. CIM Agent communication with the ESS API 137

Table 23. Return error codes for the CIMON (continued)
Symbolic Name Code Definition
CIM_ERR_INVALID_QUALIFIER_DATATYPE 25 The datatype qualifier is invalid.
CIM_ERR_NAMESPACE_NOT_IN_MANAGER 26 The namespace value is not found.
CIM_ERR_INSTANTIATE_FAILED 27 The instantiation failed.
CIM_ERR_FAILED_TO_LOCATE_INDICATION_HANDLER 28 The indication handler is not found.
CIM_ERR_IO_EXCEPTION 29 An IO exception has occurred.
CIM_ERR_COULD_NOT_DELETE_FILE 30 The file could not be deleted.
INVALID_QUALIFIER_NAME 31 The qualifier name is null.
NO_QUALIFIER_VALUE 32 The qualifier value is null.
NO_SUCH_QUALIFIER1 33 There is no such qualifier.
NO_SUCH_QUALIFIER2 34 There is no such qualifier.
QUALIFIER_UNOVERRIDABLE 35 The qualifer is unoverridable.
SCOPE_ERROR 36 A scope error has occurred.
TYPE_ERROR 37 A type error has occurred.
CIM_ERR_MISSING_KEY 38 The key is missing.
CIM_ERR_KEY_CANNOT_MODIFY 39 The key cannot be modified.
CIM_ERR_NO_KEYS 40 There are no keys found.
CIM_ERR_KEYS_NOT_UNIQUE 41 The keys are not unique.
CIM_ERR_SET_CLASS_NOT_SUPPORTED 100 The set class operation is not supported.
CIM_ERR_SET_INSTANCE_NOT_SUPPORTED 101 The set instance operation is not supported.
CIM_ERR_QUALIFIER_NOT_FOUND 102 The qualifier value is not found.
CIM_ERR_QUALIFIERTYPE_NOT_FOUND 103 The qualifier type is not found.
CIM_ERR_CONNECTION_FAILURE 104 The connection failed.
CIM_ERR_FAIL_TO_WRITE_TO_SERVER 105 There is a fail to write to the server.
CIM_ERR_SERVER_NOT_SPECIFIED 106 The server not specified.
CIM_ERR_INDICATION_ERROR 107 There is an indication processing error.
CIM_ERR_FAIL_TO_WRITE_TO_CIMOM 108 There is a fail to write to the CIMOM.
CIM_ERR_SUBSCRIPTION_EXISTS 109 A subscription already exists.
CIM_ERR_INVALID_SUBSCRIPTION_DEST 110 The subscription destination is invalid.
CIM_ERR_INVALID_FILTER_PATH 111 The filter path is invalid.
CIM_ERR_INVALID_HANDLER_PATH 112 The handler path is invalid.
CIM_ERR_NO_FILTER_INSTANCE 113 The filter instance is not found.
CIM_ERR_NO_HANDLER_INSTANCE 114 The handler instance is not found.
CIM_ERR_UNSUPPPORTED_FILTER 115 There is an unsupported filter referenced in
the subscription.
CIM_ERR_INVALID_TRUSTSTORE 116 The CIMOM cannot be connected to because
there is a bad or missing truststore or an
incorrect truststore password.
CIM_ERR_ALREADY_CONNECTED 117 The CIMOM cannot be connected to because
it is already connected.
CIM_ERR_UNKNOWN_SERVER 118 The server is unknown. The CIMOM cannot
be connected to.

138 ESS API Reference

Table 23. Return error codes for the CIMON (continued)
Symbolic Name Code Definition
CIM_ERR_INVALID_CERTIFICATE 119 The correct certificate cannot be found in
truststore. The CIMOM cannot be connected
to.

Related topics:
v “CIM Agent communication concepts” on page 125
v Appendix A, “ESS API component definitions,” on page 123
v “CIM Agent Communication methods” on page 126
v “ESS API class definitions” on page 147
v “ESS class definition schemas” on page 231

Appendix B. CIM Agent communication with the ESS API 139

140 ESS API Reference
 Appendix C. CIM Agent class information for the ESS API
The CIM Agent uses the classes that are described in this section to manage the
implementation of the ESS API. A visual representation of the CIM agent
architecture for the ESS is also included. This information assists you in writing your
ESS API-based applications. This section includes the following information:
v CIM Agent class definitions quick reference
v CIM Agent class definitions
v ESS class definition schemas

CIM Agent class definitions quick reference

Table 24 provides a quick reference for the CIM Agent class definitions.
Table 24. CIM Agent class definitions (quick reference)
Related
IBMTSESS class name Description section
IBMTSESS_AllocatedFromStoragePool An association that associates a volume with the Table 36 on
volumespace from which it is allocated; derived page 177
from the CIM_AllocatedFromStoragePool class.
| IBMTSESS_AsyncPPRCService Contains methods that allow the manipulation of Table 99 on
| Asynchronous PPRC volumes. The page 223
| IBMTSESS_AsyncPPRCService is derived from
| the StorageConfigurationService class.
IBMTSESS_AuthorizedSubject An association that ties specific privileges to Table 43 on
specific subjects (for example, identities or page 179
roles). The IBMTSESS_AuthorizedSubject is
derived from the CIM_AuthorizedSubject class.
IBMTSESS_AuthorizedTarget An association that ties the identity or role Table 42 on
privileges to specific target resources. The page 179
IBMTSESS_AuthorizedTarget is derived from the
CIM_AuthorizedTarget class.
IBMTSESS_Chassis A representation of a chassis that contains one Table 54 on
physical ESS; derived from the CIM_Chassis page 185
class.
IBMTSESS_Component An association between storage extent and Table 82 on
VolumeSpace. The IBMTSESS_Component is page 209
derived from the CIM_Component class.
IBMTSESS_ComputerSystemPackage An association between a physical package and Table 55 on
the computer system; derived from the page 186
CIM_ComputerSystemPackage class.
IBMTSESS_ComputerSystemPackageCard An association between a physical package and Table 62 on
the computer system; derived from the page 189
CIM_ComputerSystemPackage class.
IBMTSESS_ConcreteDependencyController A generic association that establishes Table 72 on
dependency relationships between managed page 202
elements. The
IBMTSESS_ConcreteDependencyController is
derived from the CIM_ConcreteDependency
class.

© Copyright IBM Corp. 2004 141

Table 24. CIM Agent class definitions (quick reference) (continued)
Related
IBMTSESS class name Description section
IBMTSESS_ConcreteDependencyPrivilege A generic association that establishes Table 44 on
dependency relationships between managed page 180
elements. The
IBMTSESS_ConcreteDependencyPrivilege is
derived from the CIM_ConcreteDependency
class.
IBMTSESS_ A generic association that establishes Table 45 on
ConcreteDependencyStorageHardwareID dependency relationships between managed page 180
elements. The IBMTSESS_
ConcreteDependencyStorageHardwareID is
derived from the CIM_ConcreteDependency
class.
IBMTSESS_ConcreteIdentityCapSet An association that associates two elements Table 57 on
representing different aspects of the same page 187
underlying entity; derived from the
CIM_ConcreteIdentity class.
IBMTSESS_ControllerConfigurationService Includes methods that allow a client to Table 68 on
manipulate LUN Masking in a storage system. page 193
The IBMTSESS_ControllerConfigurationService
is derived from the
CIM_ControllerConfigurationService class.
IBMTSESS_DeviceMaskingCapabilities A subclass of capabilities that defines the Table 70 on
masking-related capabilities of a storage system. page 199
The IBMTSESS_DeviceMaskingCapabilities is
derived from the
CIM_ProtocolControllerMaskingCapabilities
class.
IBMTSESS_DiskDrive A description of the physical disk on the ESS; Table 64 on
derived from the CIM_DiskDrive class. page 190
IBMTSESS_ElementCapabilities An association between managed elements and Table 50 on
their capabilities; derived from the page 181
CIM_ElementCapabilities class.
IBMTSESS_ElementCapabilitiesMasking An association between managed elements and Table 71 on
their capabilities. The page 202
IBMTSESS_ElementCapabilitiesMasking is
derived from the CIM_ElementCapabilities class.
IBMTSESS_ElementConformsToProfile The registered profile that a managed element is Table 75 on
conformant to. The page 205
IBMTSESS_ElementConformsToProfile is
derived from the CIM_ElementConformsToProfile
class.
IBMTSESS_ElementSettingData An association between managed elements and Table 49 on
applicable setting data. This association also page 181
describes whether this is a default or current
setting. The IBMTSESS_ElementSettingData is
derived from the CIM_ElementSettingData class.
IBMTSESS_EltCapabilitiesStgPool An association between managed elements and Table 86 on
their capabilities. The page 211
IBMTSESS_EltCapabilitiesStgPool is derived
from the CIM_ElementCapabilities class.

142 ESS API Reference

Table 24. CIM Agent class definitions (quick reference) (continued)
Related
IBMTSESS class name Description section
IBMTSESS_ExtraCapacitySet A description of the type of redundancy available Table 56 on
in the storage system; derived from the page 186
CIM_ExtraCapacitySet class.
IBMTSESS_FCPort A description of a single fibre-channel adapter Table 28 on
I/O port on the ESS; derived from the page 153
CIM_FCPort class.
IBMTSESS_HostedAccessPoint An association between a service access point Table 60 on
and the system on which it is provided; derived page 189
from the CIM_HostedAccessPoint class.
IBMTSESS_HostedPrimordialStoragePool An association that establishes that the Table 84 on
storagepool is defined in the context of the page 211
primordialstoragepool. The
IBMTSESS_HostedPrimordialStoragePool is
derived from the CIM_HostedStoragePool class.
IBMTSESS_HostedService An association between a system and the Table 46 on
storage configuration service; derived from the page 180
CIM_HostedService class.
IBMTSESS_HostedService2 An association between a system and the Table 47 on
privilege management service; derived from the page 181
CIM_HostedService class.
IBMTSESS_HostedService3 An association between a system and the Table 48 on
storage hardware ID management service; page 181
derived from the CIM_HostedService class.
IBMTSESS_HostedService4 An association between a system and the Table 69 on
controller configuration service; drived from the page 199
CIM_HostedService class.
IBMTSESS_HostedService6 An association between a service and the Table 93 on
system on which the functionality resides. The page 219
IBMTSESS_HostedService6 is derived from the
CIM_HostedService class.
IBMTSESS_HostedStoragePool An association that establishes that the storage Table 51 on
pool is defined in the context of the System; page 181
derived from the CIM_HostedStoragePool class.
IBMTSESS_InitiatorElementSettingData The association between managed elements and Table 79 on
applicable setting data. This association also page 206
describes whether this is a default or current
setting. The
IBMTSESS_InitiatorElementSettingData is
derived from the CIM_ElementSettingData class.
IBMTSESS_Location The position and address of a physical element. Table 76 on
The IBMTSESS_Location is derived from the page 205
CIM_Location class.
IBMTSESS_LunMaskPrivilegeService Manages privilege instances. The Table 33 on
IBMTSESS_LunMaskPrivilegeService is derived page 171
from the LunMaskPrivilegeService class.
IBMTSESS_MemberOfCollection An aggregation used to establish membership of Table 63 on
managed elements in a Collection; derived from page 190
the CIM_MemberOfCollection class.

Appendix C. CIM Agent class information for the ESS API 143
 Table 24. CIM Agent class definitions (quick reference) (continued)
Related
IBMTSESS class name Description section
IBMTSESS_MediaPresentExtent The association between a media access device Table 81 on
and the StorageExtent. The page 209
IBMTSESS_MediaPresentExtent is derived from
the CIM_MediaPresent class.
IBMTSESS_PerformanceStatisticsService Includes methods that enable and disable the Table 92 on
collection of performance statistics. In addition, it page 217
supports a method to retrieve the statistics file
for ESS volumes and volume spaces. The
IBMTSESS_PerformanceStatisticsService is
derived from the CIM_Service class.
IBMTSESS_PhysicalElementLocation A description of the association between a Table 77 on
physical element with a location object for page 205
inventory or replacement purposes. The
IBMTSESS_PhysicalElementLocation is derived
from the CIM_PhysicalElementLocation class.
IBMTSESS_PhysicalPackage A representation of physical elements that Table 65 on
contain or host other components; derived from page 192
the CIM_PhysicalPackage class.
| IBMTSESS_Pool2PrimordialPool An association describing how VolumeSpaces Table 98 on
| are allocated from PrimordialStoragePool. The page 223
| IBMTSESS_Pool2PrimordialPool is derived from
| the AllocatedFromStoragePool class.
IBMTSESS_PPRCPath Derived from the CIM_LogicalDevice class. Table 97 on
page 221
IBMTSESS_PrimordialStoragePool Derived from the CIM_StoragePool class. Table 83 on
page 210
IBMTSESS_Privilege Derived from the CIM_Privilege class. Table 30 on
page 155
IBMTSESS_Product A representation of the top-level description of Table 35 on
physical components that make up a product, in page 176
this case, the entire ESS; derived from the
CIM_Product class.
IBMTSESS_ProductPhysicalComponent An association that indicates that the referenced Table 58 on
physical element is acquired as part of a page 187
product; derived from the
CIM_ProductPhysicalComponent class.
IBMTSESS_ProtocolControllerForPort An association that defines a relationship Table 41 on
between a protocol controllers and a port. The page 178
IBMTSESS_ProtocolControllerForPort is derived
from the CIM_ProtocolControllerForPort class.
IBMTSESS_ProtocolControllerForUnit An association that defines a relationship Table 40 on
between a protocol controllers and an exposed page 178
logical unit (for example, a storage volume). The
IBMTSESS_ProtocolControllerForUnit is derived
from the CIM_ProtocolControllerForUnit class.
IBMTSESS_Provider Derived from the CIM_Provider class. Table 87 on
page 212
IBMTSESS_Realizes An association that associates a logical device Table 66 on
and the physical elements that implement them; page 193
derived from the CIM_Realizes class.

144 ESS API Reference

Table 24. CIM Agent class definitions (quick reference) (continued)
Related
IBMTSESS class name Description section
IBMTSESS_RegisteredProfile The IBMTSESS_RegisteredProfile is derived Table 73 on
from the CIM_RegisteredProfile class. page 203
IBMTSESS_RemoteServiceAccessPoint A description of access and addressing Table 59 on
information for a remote connection that is page 187
known to a local network element; derived from
the CIM_RemoteServiceAccessPoint class.
IBMTSESS_RemoteSourceStorageSynchronized A representation of the relationship involving a Table 95 on
remote domain volume. For this association the page 219
remote volume is the source and the local
volume the target. The
IBMTSESS_RemoteSourceStorageSynchronized
is derived from the CIM_ManagedElement class.
IBMTSESS_RemoteTargetStorageSynchronized A representation of the relationship involving a Table 96 on
remote domain volume. For this association the page 220
remote volume is the target and the local volume
is the source of the relationship. The
IBMTSESS_RemoteTargetStorageSynchronized
is derived from the CIM_ManagedElement class.
IBMTSESS_RemoteVolume A representation of a volume that is contained Table 94 on
within a domain that is unaccessible. page 219
IBMTSESS_RemoteVolume has PPRC copy
relationship with IBMTSESS_Volume, which is
contained within a domain that is accessible. The
IBMTSESS_RemoteVolume is derived from the
CIM_ManagedElement class.
IBMTSESS_SCSIProtocolController Derived from the CIM_SCSIProtocolController Table 29 on
class. page 154
IBMTSESS_StorageCapabilities There is one instance for all the ESS machines; Table 52 on
derived from the CIM_StorageCapabilities class. page 182
IBMTSESS_StorageClientSettingData Derived from the CIM_StorageClientSettingData Table 78 on
class. page 206
IBMTSESS_StorageConfigurationService A service provided by the CIM Agent to enable Table 32 on
volume creation, volumespace creation, page 157
volumespace deletion and copy services
functions; derived from the
CIM_StorageConfigurationService class.
IBMTSESS_StorageExtent Derived from the CIM_StorageExtent class. Table 80 on
page 207
IBMTSESS_StorageHardwareID Derived from the CIM_StorageHardwareID class. Table 31 on
page 156
IBMTSESS_ Includes methods for creating creating and Table 34 on
StorageHardwareIDManagementService deleting storage hardware IDs; derived from the page 174
CIM_StorageHardwareIDManagementService
class.
IBMTSESS_StorageSetting A service level objective. There are two Table 53 on
instances for all the ESS machines; derived from page 184
the CIM_StorageSetting class.

Appendix C. CIM Agent class information for the ESS API 145
Table 24. CIM Agent class definitions (quick reference) (continued)
Related
IBMTSESS class name Description section
IBMTSESS_StorageProcessorCard A representation of a type of physical container Table 61 on
that can be plugged into another card or hosting page 189
board, or is itself a hosting board or mother
board in a chassis. Each ESS has two instances
of IBMTSESS_StorageProcessorCard; derived
from the CIM_Card class.
IBMTSESS_StorageSynchronized An association that indicates that two storage Table 85 on
objects were replicated at the specified point in page 211
time. The IBMTSESS_StorageSynchronized is
derived from the CIM_StorageSynchronized
class.
IBMTSESS_StorageSystem A representation of the entire ESS machine in Table 25 on
the configuration; derived from the page 147
CIM_ComputerSystem class.
IBMTSESS_StorageSystemToController An association that associates a controller with a Table 39 on
storage subsystem; derived from the page 178
CIM_SystemDevice.
IBMTSESS_StorageSystemToPort An association that associates a port with a Table 38 on
storage subsystem; derived from the page 177
CIM_SystemDevice class.
IBMTSESS_StorageSystemToVolume An association that associates a volume with a Table 37 on
storage subsystem; derived from the page 177
CIM_SystemDevice class.
IBMTSESS_SubProfileExtendsProfile Derived from the CIM_ReferencedProfile class. Table 74 on
page 204
IBMTSESS_SystemDevice An association that describes the aggregation of Table 67 on
logical devices by a system; derived from the page 193
CIM_SystemDevice class.
IBMTSESS_Volume A representation one storage volume for the Table 27 on
ESS; derived from the CIM_StorageVolume page 150
class.
IBMTSESS_VolumeSpace A representation of an ESS volume group from Table 26 on
which storage volumes can be created; derived page 148
from the CIM_StoragePool class.
IBMTSESS_VolumeStatisticalData A connection is made from the Table 90 on
IBMTSESS_Volume with its corresponding page 216
statistics instance.The
IBMTSESS_VolumeStatisticalData is derived
from the CIM_ElementStatisticalData class.
IBMTSESS_VolumeSpaceStatisticalData A connection is made between Table 91 on
IBMTSESS_VolumeSpace with its corresponding page 217
statistics instance. The
IBMTSESS_VolumeSpaceStatisticalData is
derived from the CIM_ElementStatisticalData
class.
IBMTSESS_VolumeSpaceStatistics Derived from the CIM_StatisticalData class. Table 89 on
page 215
IBMTSESS_VolumeStatistics Derived from the CIM_StatisticalData class. Table 88 on
page 213

146 ESS API Reference

 Related topics:
v “ESS API class definitions”
v “ESS class definition schemas” on page 231

ESS API class definitions

The following class definition tables list the properties, types, qualifiers, and
descriptions, for each CIM Agent class definition. Each table lists the properties,
qualifiers, and descriptions for one class.
Table 25. IBMTSESS_StorageSystem class properties
Qualifier or
Property Type Parameter Description
CIM_ManagedElement
Caption String MaxLen(64) Short textual description.
Description String Textual description of the object.
ElementName String This property enables each instance to define a
user-friendly name in addition to its key properties or
identity data, and description information.

The value for IBMTSESS_StorageSystem is Enterprise

Storage Server.
CIM_ManagedSystemElement
InstallDate datetime When the object was installed. A lack of a value does
not indicate that the object is not installed.
Name String MaxLen(256) Defines the label by which the object is known. When
subclassed, the Name property can be overridden to be
a Key property.
OperationalStatus[] uint16 Indicates the current status of the element. The following
functional and nonfunctional statuses are defined: 2
(OK), 6 (Error), 11 (In Service) , 12 (No Contact).
Note: The same object can have multiple statuses.

The value for IBMTSESS_StorageSystem is 2.

CIM_LogicalElement
CIM_EnabledLogicalElement
EnabledState uint16 Indicates the enabled or disabled states of an element.
ValueMap {0, 1, 2, 3, 4, 5, 6, 7,8, 9, 10, 11..32767,
32768..65535 } Values {Unknown, Other, Enabled,
Disabled, Shutting Down, Not Applicable, Enabled but
Offline, In Test, Deferred, Quiesce, Starting, DMTF
Reserved, Vendor Reserved }
OtherEnabledState String Describes the enabled or disabled state of the element
when the EnabledState property is set to 1 (other).
CIM_System
CreationClassName String Key, MaxLen(256) Indicates the name of the class or the subclass used in
the creation of an instance. When used with the other
key properties of this class, this property enables all
instances of this class and its subclasses to be uniquely
identified.

The value for IBMTSESS_StorageSystem is

IBMTSESS_StorageSystem.

Appendix C. CIM Agent class information for the ESS API 147
Table 25. IBMTSESS_StorageSystem class properties (continued)
Qualifier or
Property Type Parameter Description
Name String Key, MaxLen(256) Serves as the key of a System instance in an enterprise
environment.

The value for IBMTSESS_StorageSystem is the serial

number of the ESS.
NameFormat String Identifies how the System name was generated.

The value for IBMTSESS_StorageSystem is Other.

PrimaryOwnerName String The name of the primary system owner.

The value for IBMTSESS_StorageSystem is IBM

Corporation.
PrimaryOwnerContact String Provides information on how the primary system owner
can be reached.

The value for IBMTSESS_StorageSystem is IBM

Customer.
CIM_ComputerSystem
OtherIdentifyingInfo String[] Captures additional data, beyond System Name
information, that could be used to identify a
ComputerSystem.

The value for IBMTSESS_StorageSystem is {IP address

of ESS, the DNS Name of the ESS, the value of WWN
for the ESS}.
IdentifyingDescriptions String[] Provides explanations and details behind the entries in
the OtherIdentifyingInfo array.
Note: Each entry of this array is related to the entry in
OtherIdentifyingInfo that is located at the same index.

The value is {"ESS IP Address","DNS Name","WWN"}.

Dedicated uint16[] BlockServer Indicates whether the ComputerSystem is a
special-purpose System or general-purpose System.

The value for IBMTSESS_StorageSystem is {3,15},

which means the System is {″Storage″, ″BlockServer″}.
IBMTSESS_StorageSystem
Model String Describes the model number of the ESS.
Codelevel String Describes the code level of the ESS.
Cache String Describes the memory size of the ESS in gigabytes.
NVS String Describes nonvolatile storage of the ESS in megabytes.
NVS is used to store a second copy of write data to
ensure data integrity.

Table 26. IBMTSESS_VolumeSpace class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement

148 ESS API Reference

Table 26. IBMTSESS_VolumeSpace class properties (continued)
Qualifier or
Property Type Parameter Description
ElementName String Enables each instance to define a user-friendly name in
addition to its key properties or identity data, and
description information.

The value for IBMTSESS_VolumeSpace is VolumeSpace

on ESS plus the ESS serial number.
CIM_ManagedSystemElement
OperationalStatus uint16[] Indicates the current status of the element. Various
functional and nonfunctional statuses are defined: OK (2),
Error (6), In Service (11), Not Contact (12).

The value for IBMTSESS_VolumeSpace is 2.

CIM_LogicalElement
CIM_StoragePool
InstanceID String Key Identifies a unique instance of StoragePool.

The value for IBMTSESS_VolumeSpace is the

volumeSpaceID-ESS ID.
RemainingManagedSpace uint64 Describes the remaining capacity available in bytes.
Primordial Boolean If true, \“Primordial\” indicates that the containing System
does not have the ability to create or delete this
operational element.

The value for IBMTSESS_VolumeSpace is FALSE.

PoolID String A unique name in the context of the system that identifies
this pool. The value for IBMTSESS_VolumeSpace is the
volumespace ID obtained from esscli command such as
“vs0”.
TotalManagedSpace uint64 The total amount of raw storage (in bytes) managed by
this StoragePool in bytes.
IBMTSESS_VolumeSpace
Redundancy String Describes the volume type (RAID level).
Cap real32 Describes the capacity of the VolumeSpace in gigabytes.
Free real32 Describes the remaining capacity available in gigabytes.
Format String Describes the format of the volumespace, that is, FB or
3390.
Basedon String Describes the disk group or disk that the VolumeSpace is
based on.
Volumes uint16 Describes the number of allocated volumes.
LSS String Describes any volumes allocated in this VolumeSpace
that are associated with this logical subsystem.
Status String Describes the status of VolumeSpace.
SystemName String Describes the name of the scoping System.

The value for IBMTSESS_VolumeSpace is the ESS serial

number to which this VolumeSpace belongs.
ssID String Describes the SS ID in 4-digits hexidecimal.

Appendix C. CIM Agent class information for the ESS API 149
Table 27. IBMTSESS_Volume class properties
Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a
user-friendly name in addition to its key
properties or identity data, and description
information.

The value for IBMTSESS_Volume is Volume:

LSS + LSSId + VolumeID + volumeID.
CIM_ManagedSystemElement
Name String Defines the label by which the object is
known. When subclassed, the Name property
can be overridden to be a Key property.

The value for IBMTSESS_Volume is

0000000000000000000000000000+volumeID.
OperationalStatus uint16[] Indicates the current statuses of the element.

The value for IBMTSESS_Volume is 2, which

means “OK”.
CIM_LogicalElement
CIM_EnabledLogicalElement
EnabledState uint16 Indicates the enabled or disabled states of an
element. ValueMap {0, 1, 2, 3, 4, 5, 6, 7,8, 9,
10, 11..32767, 32768..65535 } Values
{Unknown, Other, Enabled, Disabled, Shutting
Down, Not Applicable, Enabled but Offline,
In Test, Deferred, Quiesce, Starting, DMTF
Reserved, Vendor Reserved }

The value for IBMTSESS_Volume is 2 which

means “Enabled”.
RequestedState uint16 Indicates the last requested or desired state
for the element. ValueMap {2, 3, 4, 5, 6, 7, 8,
9, 10..32767, 32768..65535} Values {Enabled,
Disabled, Shut Down, No Change, Offline,
Test, Deferred, Quiesce, DMTF Reserved,
Vendor Reserved}

The value for IBMTSESS_Volume is 2.

EnabledDefault uint16 Indicates an administrator’s default or startup
configuration for the Enabled Status for an
element. By default, the element is Enabled
(value=2).
CIM_LogicalDevice
SystemCreationClassName String Key, Describes the CreationClassName for the
MaxLen(256) scoping System.

The value for IBMTSESS_Volume is

IBMTSESS_StorageSystem.

150 ESS API Reference

Table 27. IBMTSESS_Volume class properties (continued)
Qualifier or
Property Type Parameter Description
SystemName String Key, Describes the name of the scoping System.
MaxLen(256)
The value for IBMTSESS_Volume is the ESS
serial number to which this volume belongs.
CreationClassName String Key, Indicates the name of the class or the
MaxLen(256) subclass used in the creation of an instance.
When used with the other key properties of
this class, this property enables all instances
of this class and its subclasses to be
uniquely identified.

The value for IBMTSESS_Volume is

IBMTSESS_Volume.
DeviceID String Key, Describes an address or other identifying
MaxLen(64) information to uniquely name the
LogicalDevice.

The value for IBMTSESS_Volume is the

volume ID obtained from the esscli, such as
0A05.
OtherIdentifyingInfo String[] Describes the volume serial number.

The value is the serial number of the volume,

such as DBA001.
IdentifyingDescriptions String[] Describes an array of free-form strings that
provide explanations and details of the
entries in the OtherIdentifyingInfo array.
Note: Each entry of this array is related to the
entry in OtherIdentifyingInfo that is located at
the same index. The value for
IBMTSESS_Volume is Serial.
CIM_StorageExtent
DataOrganization uint16 Describes the type of data organization
used.ValueMap {0, 1, 2, 3, 4, Values {Other,
Unknown, Fixed Block, Variable Block, Count
Key Data, }
Access uint16 Describes whether the media is readable
(value=1), writeable (value=2), both readable
and writeable (value=3), write once (value=4),
unknown (value=0).

The value for IBMTSESS_Volume is 3.

BlockSize uint64 Describes the size in bytes of the blocks that
form this StorageExtent.

The value for IBMTSESS_Volume is 512.

NumberOfBlocks uint64 Describes the total number of logically
contiguous blocks, of size Block Size, which
form this Extent. The total size of the Extent
can be calculated by multiplying BlockSize by
NumberOfBlocks.

Appendix C. CIM Agent class information for the ESS API 151
Table 27. IBMTSESS_Volume class properties (continued)
Qualifier or
Property Type Parameter Description
ConsumableBlocks uint64 Describes the maximum number of blocks, of
size BlockSize, that are available for
consumption when layering StorageExtents
using the BasedOn association.

The value for IBMTSESS_Volume is 0.

DataRedundancy uint16 Describes the number of complete copies of
data maintained.

The value for IBMTSESS_Volume is 1.

DeltaReservation uint8 Describes the current value for Delta
reservation. This is a percentage that
specifies the amount of space that should be
reserved in a replica for cahing changes.

The value for IBMTSESS_Volume is 100.

NoSinglePointOfFailure Boolean Indicates if no single point of failure exists.

The value for IBMTSESS_Volume is TRUE.

ExtentStatus uint16[] Describes the information captured in the
VolumeStatus property.

The value for IBMTSESS_Volume is 2, which

means none or not applicable.
SequentialAccess Boolean Values are:
TRUE The Storage is sequentially
accessed by a MediaAccessDevice.

The value for IBMTSESS_Volume is FALSE.

IsBasedOnUnderlyingRedundancy Boolean Values are:
TRUE The underlying StorageExtents
participate in a
StorageRedundancyGroup.

The value for IBMTSESS_Volume is TRUE.

PackageRedundancy uint16 Describes how many physical packages can
currently fail without data loss. For example,
in the storage domain, this might be disk
spindles.

The value for IBMTSESS_Volume is 1.

CIM_StorageVolume
NameFormat uint16 Format of the Name property. ValueMap {0, 1,
2, 3, 4, 5, 6, 7, 8}, Values {Unknown, Other,
VPD83NAA6, VPD83NAA5, VPD83Type2,
VPD83Type1, VPD83Type0, SNVM, NodeWWN}

The value for IBMTSESS_Volume is 6.

IBMTSESS_Volume
Cap real32 Describes the volume capacity in units of GB
or cylinders.
Unit String Describes the unit of volume capacity.

152 ESS API Reference

Table 27. IBMTSESS_Volume class properties (continued)
Qualifier or
Property Type Parameter Description
Lss String Describes the logical subsystem identifiers .
Vs String Describes the VolumeSpace to which the
volume belongs.
Format String Describes the format of the volume, that is,
FB, 3390.
Controlled Boolean Provides a quick interface for finding Devices
with no ProtocolControllerForUnit
associations to Controllers. Values are: TRUE
TRUE The device is accessed by initiator.
FALSE The device exists but is not
accessed by any initiators.
SpindleRedundancy uint16 Describes how many disk spindles can fail
without data loss.

The value for IBMTSESS_Volume is 2.

Ss String Describes the SS ID in 4-digits hexidecimal.
Status String Describes the status of the volume.

Table 28. IBMTSESS_FCPort class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a user-friendly name in
addition to key properties or identity data, and description
information.

The value for IBMTSESS_FCPort is Port + portID.

CIM_ManagedSystemElement
OperationalStatus uint16[] Indicates the current statuses of the element.

The value for IBMTSESS_FCPort is 2, which means OK.

CIM_EnabledLogicalElement
CIM_LogicalDevice
SystemCreationClassName String Key, Describes the CreationClassName for the scoping
MaxLen(256) System.

The value for IBMTSESS_FCPort is

IBMTSESS_StorageSystem.
SystemName String Key, Describes the name of the scoping System.
MaxLen(256)
The value for IBMTSESS_FCPort is the ESS serial
number to which this controller belongs.
CreationClassName String Key, Indicates the name of the class or the subclass used in
MaxLen(256) the creation of an instance. When used with the other
key properties of this class, this property enables all
instances of this class and its subclasses to be uniquely
identified.

The value for IBMTSESS_FCPort is IBMTSESS_FCPort.

Appendix C. CIM Agent class information for the ESS API 153
Table 28. IBMTSESS_FCPort class properties (continued)
Qualifier or
Property Type Parameter Description
DeviceID String Key, Describes an address or other identifying information to
MaxLen(64) uniquely name the LogicalDevice. In this case, it is the
port number.

The value for IBMTSESS_FCPort is the port ID obtained

from ESSCLI, such as 04.
CIM_LogicalPort
UsageRestriction uint16 Describes that in some circumstances, a LogicalPort
might be identifiable as a front end or back end port.
ValueMap {0, 2, 3, 4}, Values {Unknown, Front-end only,
Back-end only, Not restricted}.

The value for IBMTSESS_FCPort is 2.

CIM_NetworkPort
PermanentAddress String Defines the network address that is hard coded into a
port.

The value of IBMTSESS_FCPort is the port worldwide

name.
NetworkAddresses String[] An array of strings indicating the network addresses for
the port.

The value for IBMTSESS_FCPort is the last 6 digits of

the port worldwide name.
PortType uint16 Indicates the port is a Fibre Channel Node Port capable
of supporting Fibre Channel Arbitrated Loop.

The value of IBMTSESS_FCPort is 11.

Speed uint64 Describes the estimate of the current bandwidth in bits
per second (bps).

The value for IBMTSESS_FCPort is 16000000000 bps.

CIM_FCPort
IBMTSESS_FCPort
Loc String Describes the physical location of the port on the ESS,
including Bay A, Adapter Y and Port Z.
Topology String
Wwn String Describes the port worldwide name.
Type String Describes the adapter type.

Table 29. IBMTSESS_SCSIProtocolController class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Allows each instance to define a user-friendly
name in addition to its key properties/identity data
and description information.

The value for IBMTESS_SCSIProtocolController

is Controller.

154 ESS API Reference

Table 29. IBMTSESS_SCSIProtocolController class properties (continued)
Qualifier or
Property Type Parameter Description
CIM_ManagedSystemElement
OperationalStatus uint16[] Indicates the current status(es) of the element.

The value for IBMTSESS_SCSIProtocolController

is 2, which means ″OK″.
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_LogicalDevice
SystemCreationClassName String Key, Describes the scoping System’s
MaxLen(256) CreationClassName.

The value for IBMTSESS_SCSIProtocolController

is IBMTSESS_StorageSystem.
SystemName String Key, Describes the scoping System’s Name.
MaxLen(256)
The value for IBMTSESS_SCSIProtocolController
is the ESS serial number.
CreationClassName String Key, Indicates the name of the class or the subclass
MaxLen(256) that is used in the creation of an instance. When
used with the other key properties of this class,
this property allows all instances of this class and
its subclasses to be uniquely identified.

The value for IBMTSESS_SCSIProtocolController

is IBMTSESS_SCSIProtocolController.
DeviceID String Key, MaxLen(64) The value for IBMTSESS_SCSIProtocolController
is initiatorID.
CIM_ProtocolController
MaxUnitsControlled uint32 Describes the maximum number of units that can
be controlled by or accessed through this
protocol controller.

The value for IBMTSESS_SCSIProtocolController

is 0.
CIM_SCSIProtocolController
IBMTSESS_SCSIProtocolController
ProtocolSupported uint64 The value for IBMTSESS_SCSIProtocolController
is 2.

Table 30. IBMTSESS_Privilege class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Allows each instance to define a
user-friendly name in addition to its key
properties or identity data and description
information.

The value for IBMTSESS_Privilege

is initID.

Appendix C. CIM Agent class information for the ESS API 155
Table 30. IBMTSESS_Privilege class properties (continued)
Qualifier or
Property Type Parameter Description
CIM_Privilege
InstanceID String Key Identifies a unique instance of Privilege.

The value for IBMTSESS_Privilege is ESS

serial number-initID.
PrivilegeGranted Boolean Indicating whether this Privilege grants or
denies permission.
TRUE Grants permission.
FALSE Denies permission.

The value for IBMTSESS_Privilege is

TRUE.
IBMTSESS_Privilege

Table 31. IBMTSESS_StorageHardwareID class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Allows each instance to define a
user-friendly name in addition to its key
properties/identity data. It also provides
description information.

The value for

IBMTSESS_StorageHardwareID is the
host name.
CIM_Identity
InstanceID String Key Identifies a unique instance of Identity.

The value for

IBMTSESS_StorageHardwareID is ESS
serial number-initID.
CurrentlyAuthenticated Boolean Indicates whether this Identity has been
authenticated, and is currently known
within the scope of an
AuthenticationService or authority.
TRUE The authenticity should be
assumed.
FALSE The authenticity should not be
assumed.

The value for

IBMTSESS_StorageHarewareID is FALSE.
CIM_StorageHardwareID
StorageID String Provides the hardware worldwide unique
ID. The value for
IBMTSESS_StorageHardwareID will be
initiator ID.

156 ESS API Reference

Table 31. IBMTSESS_StorageHardwareID class properties (continued)
Qualifier or
Property Type Parameter Description
IDType uint16 Provides the type of the ID property.
ValueMap {1, 2, 3, 4}, Values {Other,
PortWWN, NodeWWN, Hostname}

The value for

IBMTSESS_StorageHardwardID is 2.
IBMTSESS_StorageHardwareID
profile uint16 Defines the platform or operating system
type associated with the host.
ValueMap{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11,
12, 13, 14, 15} Values {aix, dgux, dynix,
hpux, irix, iscsigate, linux, linuxppc,
linux390, netware, nt4, openvms, os400,
solaris251, solaris26, tru64}

Table 32. IBMTSESS_StorageConfigurationService class properties

Property Type Qualifier or Parameter Description
CIM_ManagedElement
ElementName String This property enables each instance to
define a user-friendly name in addition to
its key properties or identity data, and
description information.

The value for

IBMTSESS_StorageConfigurationService
is StorageConfigurationService.
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Service
SystemCreationClassName String Key, MaxLen(256) Describes the CreationClassName for the
scoping System.

The value for

IBMTSESS_StorageConfigurationService
is IBMTSESS_StorageSystem.
SystemName String Key, MaxLen(256) Describes the name of the scoping
System.

The value for

IBMTSESS_StorageConfigurationService
is the ESS serial number.
CreationClassName String Key, MaxLen(256) Indicates the name of the class or the
subclass used in the creation of an
instance. When used with the other key
properties of this class, this property
enables all instances of this class and its
subclasses to be uniquely identified.

The value for IBMTSESS_Storage

ConfigurationService is
IBMTSESS_StorageConfigurationService.

Appendix C. CIM Agent class information for the ESS API 157
Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
Name String Key, MaxLen(64) Describes an address or other identifying
information to uniquely name the
LogicalElement.

The value for IBMTSESS_Storage

ConfigurationService is ConfigService.
StorageConfigurationService
IBMTSESS_StorageConfigurationService
CreateOrModifyElementFrom uint32 Method Start a job to create (or modify) a
StoragePool specified element (for example, a volume)
from a StoragePool.
ElementType uint16 Parameter of Enumeration indicating the type of
CreateOrModifyElement element being created or modified. If the
FromStoragePool input parameter Element is specified (for
the case of modify), this type value must
match the type of that instance.
CIM_StorageSetting REF Goal Parameter of The requirements for the element to
CreateOrModifyElement maintain. If set to a null value, the default
FromStoragePool configuration from the source pool will be
used.
Size uint64 Parameter of As an input parameter Size specifies the
CreateOrModifyElement desired size in Bytes. As an output
FromStoragePool parameter Size specifies the size
achieved.
IBMTSESS_VolumeSpace REF InPool Parameter of The Pool to create the Element from.
CreateOrModifyElement This parameter must be set to null if the
FromStoragePool input parameter Element is specified (in
the case for modify).
IBMTSESS_Volume REF TheElement Parameter of As an input parameter: if null create a
CreateOrModifyElement new element. If not null, then modify the
FromStoragePool specified element. Returned parameter is
a reference to the resulting element.

158 ESS API Reference

Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
Return Values — Return Values of Description of return values:
CreateOrModifyElement
FromStoragePool 0 Success
1 Not Supported
4 Failed (Result might be
intermittent. You might need to
investigate it.)
0x1001 Input Size is bigger than the
free spaces left in the InPool
0x8000 Authorization failure
0x8002 Invalid parameter Goal
0x8004 Input Size is invalid, either less
than or equal to 0, or is null
0x8005 Invalid parameter InPool

0x8010 ElementType should be 2

meaning “StorageVolume”

0x8020 IBMTSESS does not support

modification of volumes.

0x8021 IBMTSESS cannot create the

volume as specified (ESS CLI
cannot “create volume” as
specified)

0x8022 The LSS already contains

maximum number of volumes.

0x8023 Insufficient volume addresses

in the given logical subsystems.

0x8030 Creating indication failure.

CreateOrModifyStorage Pool uint32 Method Create a pool of storage with a set of
StorageCapabilites defined by the input
StorageSetting. The source of the storage
can be other pools or storage extents.
CIM_StorageSetting REF Goal Parameter of Reference to an instance of
CreateOrModifyStorage StorageSetting that defines the desired
Pool capabilities of the StoragePool. If set to a
null value, the default configuration from
the source pool will be used. If not NULL,
this parameter will supply a new Goal
setting when modifying an existing pool
Size uint64 Parameter of As an input parameter this specifies the
CreateOrModifyStorage desired pool size in bytes. As an output
Pool parameter this specifies the size
achieved. [Units (″Bytes″)]
InPools[] String Parameter of Array of strings containing
CreateOrModifyStorage representations of references to
Pool IBMTSESS_PrimordialStoragePool
instances, that are used to create the
Pool or modify the source pools.
InExtents[] String Parameter of Array of strings containing
CreateOrModifyStorage representations of references to
Pool IBMTSESS_StorageExtent instances, that
are used to create the Pool or modify the
source extents.

Appendix C. CIM Agent class information for the ESS API 159
Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
IBMTSESS_VolumeSpace REF Pool Parameter of As an input parameter: if null, creates a
CreateOrModifyStorage new StoragePool. else modifies the
Pool storagePool
VolType String Parameter of As an input parameter: It specifies the
CreateOrModifyStorage ESS logical volume type. If null, a new
Pool StoragePool with Format as FB will be
created. If not null, the a new
StoragePool with specified Format will be
created. The possible value of VolType
will be 3380, 3390, or FB.
LssNum uint16 Parameter of As an input parameter: It specifies the
CreateOrModifyStorage LSS where the volumespace will be
Pool created. LssNum is unavoidable if the
VolType is either 3380 or 3390. The
LssNum is in decimal: 0 to 21 (from 0x00
to 0x15)
Return values — Return Values of Description of return values:
CreateOrModifyStorage
Pool 0 Success

4 Failed (Result might be

intermittent. You may need to
look into it.)

0x1002 Size is not supported

0x8002 Invalid Goal

0x8004 Invalid Size (Size is equal to or

less than 0)

0x8005 Invalid InPools

0x8007 Either InPools or InExtents

should be defined, but not both.

0x8008 Invalid VolType

0x8009 Invalid LssNum

0x8020 IBMTSESS doesn not support

modification of volumespace

0x8021 IBMTSESS cannot create

volumespace as specified
0x8030 Creating indication failure
DeleteStoragePool uint32 Method Delete a storage pool.
IBMTSESS_VolumeSpace REF Pool Parameter of Reference to the pool to delete.
DeleteStoragePool
Return values — Return values of Description of return values:
DeleteStoragePool
0 Success
0x8005 Invalid VolumeSpace
0x8021 IBMTSESS cannot delete
storage pool as specified
ModifySynchronization uint32 Method Starts a job to modify the synchronization
association between two storage objects.

160 ESS API Reference

 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
Operation uint16 Parameter of Operation describes the type of
ModifySynchronization modification to be made to the
replica.), ValueMap {0, 1, 2, 3, 4, 5, 6, 7,
8, 9, 10, 11, .., 0x8000..0xFFFF}, Values
{DMTF Reserved″, DMTF Reserved, Detach,
Fracture, Resync Replica, Restore from
Replica, Prepare, Unprepare, Quiesce,
Unquiesce, Reset To Sync, Reset To
Async, DMTF Reserved, Vendor Specific}
IBMTSESS_StorageSynchronized REF Synchroniz Parameter of The reference to the
ation ModifySynchronization StorageSynchronized association
describing the storage source/replica
relationship.
| Options[] uint16 Parameter of A client can specify with the
| ModifySynchronization ModifySynchronization method. ValueMap
| {20203, 20304, 30203, 30304, 40203, 40208,
| 40209, 40407, 50202, 50203, 50208, 50209},
| Values {IssueTarget, IssueTarget,
| IssueTarget, IssueTarget, IssueTarget,
| Commit, Revert, InitiateBackgroundCopy,
| InitiateBackgroundCopy, IssueTarget,
| Commit, Revert}
CIM_ManagedElement REF Remote Parameter of It is either
Synchroniz ModifySynchronization IBMTSESS_RemoteSourceStorage
ation Synchronized or
IBMTSESS_TargetSourceStorage
Synchronized. If Synchronization is not
null, then RemoteSynchronization must
be null.
DetachPath boolean Parameter of It allows the user to set DetachPath after
ModifySynchronization Detach operation. The default value is
TRUE, meaning DetachPath will be
executed after Detach Operation.
| ClassType unit16 Parameter of Describes the replication policy. If it is not
| ModifySynchronization NULL, no query on copy relationship
| through ESSNI is made. ValueMap {2, 3,
| 4, 5}, Values {Async, Sync, UnSyncAssoc,
| UnSyncUnAssoc}

Appendix C. CIM Agent class information for the ESS API 161
 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
Return values — Return values of Description of return values
ModifySynchronization
0 Success
4 Failed
5 Invalid parameter for either
Synchronization or
RemoteSynchronization.
0x8013 Invalid Operation
0x8014 Synchronization Or
RemoteSynchronization does
not exist.
0x8016 Current copyType doesn’t
provide specified option under
given operation
0x8017 Specified operation does not
provide the given option

0x8018 Can’t request both

InitiateBackgroundCopy and
IssueTarget at the same time

0x8020 SourceVolume is already a

TargetElement in other
StorageSynchronized
relationship

0x8024 Invalid option

0x8025 Invalid combinaton of options

0x8030 Invalid parameter

| ModifySynchronizations uint32 Method Starts a job to modify the synchronization
| association between two storage objects.
| Operation uint16 Parameter of Operation describes the type of
| ModifySynchronizations modification to be made to the
| replica.), ValueMap {0, 1, 2, 3, 4, 5, 6, 7,
| 8, 9, 10, 11, .., 0x8000..0xFFFF}, Values
| {DMTF Reserved, DMTF Reserved, Detach,
| Fracture, Resync Replica, Restore from
| Replica, Prepare, Unprepare, Quiesce,
| Unquiesce, Reset To Sync, Reset To
| Async, DMTF Reserved, Vendor Specific}
| IBMTSESS_StorageSynchronized string Parameter of The reference to the
| ModifySynchronizations StorageSynchronized associations
| describing the storage source/replica
| relationship.
| Options[] uint16 Parameter of A client can specify with the
| ModifySynchronizations ModifySynchronization method. ValueMap
| {20203, 20304, 30203, 30304, 40203, 40208,
| 40209, 40407, 50202, 50203, 50208, 50209},
| Values {IssueTarget, IssueTarget,
| IssueTarget, IssueTarget, IssueTarget,
| Commit, Revert, InitiateBackgroundCopy,
| InitiateBackgroundCopy, IssueTarget,
| Commit, Revert}

162 ESS API Reference

 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
| RemoteSynchronization string Parameter of It is either
| ModifySynchronizations IBMTSESS_RemoteSourceStorage
| Synchronized or
| IBMTSESS_TargetSourceStorage
| Synchronized. If Synchronization is not
| null, then RemoteSynchronization must
| be null.
| DetachPathnromESSNI boolean Parameter of It allows the user to set DetachPath after
| ModifySynchronizations Detach operation. The default value is
| TRUE, meaning DetachPath will be
| executed after Detach Operation.
| SourceOrTargetInfo unit16 Parameter of Provides decimal information about
| ModifySynchronizations remote Volumes needed for copy types 2
| and 3. The SourceOrTargetInfo parameter
| is used for Async/Sync PPRC and
| contains SSIDs for volumes that are
| located on a remote machine. There is no
| reason to use this parameter with copy
| relationships that are not remote.
| ClassType unit16 Parameter of Describes the replication policy. If it is not
| ModifySynchronizations NULL, no query on copy relationship
| through ESSNI is made. ValueMap {2, 3,
| 4, 5}, Values {Async, Sync, UnSyncAssoc,
| UnSyncUnAssoc}
| NIResults[] String Parameter of Array of returned code status of attached
| ModifySynchronizations replicas

Appendix C. CIM Agent class information for the ESS API 163
 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
| Return values — Return values of Description of return values
| ModifySynchronizations
| 0 Success

| 4 Failed

| 5 Invalid parameter for either

| Synchronization or
| RemoteSynchronization.

| 0x8010 Could not retrieve internal

| Service

| 0x8011 Could not retrieve internal

| volume IDs

| 0x8012 Could not connect to internal

| services

| 0x8013 Invalid Operation

| 0x8014 Synchronization Or
| RemoteSynchronization does
| not exist.

| 0x8016 Current copyType doesn’t

| provide specified option under
| given operation

| 0x8017 Specified operation does not

| provide the given option

| 0x8018 Can not request both

| InitiateBackgroundCopy and
| IssueTarget at the same time

| 0x8020 SourceVolume is already a

| TargetElement in other
| StorageSynchronized
| relationship

| 0x8024 Invalid option

| 0x8025 Invalid combinaton of options

| 0x8029 StorageSynchronized is already

| in required state

| 0x8030 Invalid parameter

AttachPaths uint32 Method AttachPaths enables the creation of ESS
paths between logical subsystems. A
logical subsystem (LSS) is represented
by an instance of
IBMTSESS_VolumeSpace. The
AttachPaths method creates one or more
ESS Path associations between one
VolumeSpace and another. A path is
represented by an instance of
IBMTSESS_PPRCPath.
Type uint16 Parameter of A path (IBMTSESS_PPRCPath) has a
AttachPaths type. It can be either ESCON or FCP.
Only one type can be added to associate
to IBMTSESS_VolumeSpyces
IBMTSESS_VolumeSpace REF Source Parameter of ObjectPath reference to an ESS
AttachPaths VolumeSpace representing a source
logical subsystem from which one or
more paths are to be defined.

164 ESS API Reference

 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
IBMTSESS_VolumeSpace REF Target Parameter of ObjectPath reference to an ESS
AttachPaths VolumeSpace representing the target
logical subsystem to which one or more
paths are to be defined.
SourcePorts[] uint16 Parameter of An array of source ports to use for
AttachPaths establishing ports.
TargetPorts[] uint16 Parameter of An array of target ports to use for
AttachPaths establishing paths. The number of target
ports must match the number of source
ports.
Number uint16 Parameter of “Number of paths to define”
AttachPaths
Options[] uint16 Parameter of An array of the following options:
AttachPaths ConsistencyGroup, ForceReplace,
SuspendAfterCreate, and
ForceIfPairsExist. All default values are
No. ValueMap {0, 1, 2}, Values
{DoNotCreateIfPath exists,
ConsistencyGroup, ForceReplace}
TargetLSSNumber String Parameter of “LSS Number of LSS on target ESS”
AttachPaths (This parameter is optional. It can be
specified if the target ESS is not
managed by ICAT)
TargetSSID String Parameter of “SSID for the LSS on the target ESS, in
AttachPaths hexadecimal ranging from 0x0001
through 0xFEFF” (This parameter is
optional. It can be specified if the target
ESS is not managed by ICAT)
TargetESSSequenceNumber String Parameter of “ESS Sequence (5 to 12-character
AttachPaths alphanumeric string, right-justified with
leading zeroes removed. ex. 21975)”
(This parameter is optional. It can be
specified if the target ESS is not
managed by ICAT)
| TargetWWNN String Parameter of Provides the WWNN of the target ESS
| AttachPaths (assuming the source ESS is known to
| the CS domain). (This parameter is
| optional. It can be specified if the target
| ESS is not managed by ICAT)
Return values — Return values of Description of return values:
AttachPaths
0 Success
5 Invalid parameter

0x8021 Could not get Candidate

Connections (Connection Array
is empty)
DetachPaths uint32 Method DetachPaths removes all path
associations represented by
IBMTSESS_PPRCPath that exist
between two IBMTSESS_VolumeSpaces.
Type uint16 Parameter of The type of path to remove. ValueMap {0,
DetachPaths 1}, Values {ESCON, FCP}
IBMTSESS_VolumeSpace REF Source Parameter of ObjectPath reference to an ESS
DetachPaths VolumeSpace representing a source
logical subsystem from which one or
more paths are to be removed.

Appendix C. CIM Agent class information for the ESS API 165
Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
IBMTSESS_VolumeSpace REF Target Parameter of ObjectPath reference to an ESS
DetachPaths VolumeSpace representing the target
logical subsystem from which one or
more paths are to be removed.
Options[] uint16 Parameter of Options: ForceIfPairsExist. All default
DetachPaths values are No), ValueMap {1}, Values
{ForceIfPairsExist}
TargetLSSNumber String Parameter of “LSS Number of LSS on target ESS”
DetachPaths (This parameter is optional. It can be
specified if the target ESS is not
managed by ICAT)
TargetSSID String Parameter of “SSID for the LSS on the target ESS, in
DetachPaths hexadecimal ranging from 0x0001
through 0xFEFF” (This parameter is
optional. It can be specified if the target
ESS is not managed by ICAT)
TargetESSSequenceNumber String Parameter of “ESS Sequence (5 to 12-character
DetachPaths alphanumeric string, right-justified with
leading zeroes removed. ex. 21975)”
(This parameter is optional. It can be
specified if the target ESS is not
managed by ICAT)
Return values — Return values of Description of return values:
DetachPaths
0 Success

5 Invalid parameter
AttachReplica uint32 Method Create a StorageSynchronized
relationship between two existing storage
objects.
CIM_ConcreteJob REF Job Parameter of Reference to the job (may be null if the
AttachReplica task completed).
IBMTSESS_Volume REF Source Parameter of The source storage object which may be
Element AttachReplica a StorageVolume or other storage object.
IBMTSESS_Volume REF Target Parameter of Reference to the target storage element.
Element AttachReplica
CopyType uint16 Parameter of CopyType describes the type of
AttachReplica synchronized relationship that will be
created. ValueMap {2, 3, 4, 5, ..,
0x8000..0xFFFF}, Values {Async, Sync,
UnSyncAssoc, UnSyncUnAssoc, DMTF
Reserved, Vendor Specific}
Return values — Return values of Description of return values:
AttachReplica
0 Success
5 Invalid Parameter
0x8011 Could not retrieve internal
VolumeID from CIM Volume
Object

0x8021 Failed to establish PPRC path

0x8030 Exception in establishing copy
relationship
AttachReplicas uint32 Method Create (or start a job to create) a
StorageSynchronized relationship
between two existing storage objects.
CIM_ConcreteJob REF Job Parameter of Reference to the job (may be null if the
AttachReplicas task completed).

166 ESS API Reference

 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
ElementName String Parameter of A end user relevant name for the element
AttachReplicas being created. If NULL then a system
supplied default name can be used. The
value will be stored in ’ElementName’
property for the created element.
SourceElement[] String Parameter of The source storage object references
AttachReplicas which may be StorageVolumes or other
storage objects
TargetElement[] String Parameter of Reference to the target storage elements.
AttachReplicas
CopyType uint16 Parameter of CopyType describes the type of
AttachReplicas Synchronized relationship that will be
created. ValueMap {2, 3, 4, 5, ..,
0x8000..0xFFFF}, Values {Async, Sync,
UnSyncAssoc, UnSyncUnAssoc, DMTF
Reserved, Vendor Specific}
| Options[] uint16 Parameter of Options describes the ESS-specific
| AttachReplicas options for creating StorageSynchronized
| association. ValueMap {201, 202, 203, 204,
| 205, 206, 207, 301, 302, 303, 304,305, 306,
| 401, 402, 403, 404, 405, 406, 407, 408, 409,
| 410, 501, 502, 503, 504, 505, 506, 507, 508,
| 509}, Values {CriticalMode, Failback,
| Failover, NoInitialCopy,
| NoExtendedDistance,
| SuspendAfterCreate,
| SecondaryReadEnabled, CriticalMode,
| Failback, Failover, NoInitialCopy,
| NoExtendedDistance,
| SuspendAfterCreate,
| SecondaryReadEnabled,
| AcceleratedDestage,NoBackgroundCopy,
| FreezeConsistency,
| InhibitTargetWrites,
| NoPermitIfTargetOnline,
| NoRecordChange, Revertible,
| InhibitSourceWrites,
| FastReverseRestore, AllowPPRCPrimary,
| NoBackgroundCopy, FreezeConsistency,
| InhibitTargetWrites,
| NoPermitIfTargetOnline, Revertible,
| InhibitSourceWrites,
| FastReverseRestore, AllowPPRCPrimary}
CreatePaths boolean Parameter of Check if PPRC Paths exist, if not, create
AttachReplicas them. Default is TRUE.
| SourceOrTargetInfo unit16 Parameter of Provides decimal information about
| AttachReplicas remote Volumes needed for copy types 2
| and 3. The SourceOrTargetInfo parameter
| is used for Async/Sync PPRC and
| contains SSIDs for volumes that are
| located on a remote machine. There is no
| reason to use this parameter with copy
| relationships that are not remote.
NIResults[] String Parameter of Array of returned code status of attached
AttachReplicas replicas.

Appendix C. CIM Agent class information for the ESS API 167
 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
Return values — Return values of Description of return values:
AttachReplicas
0 Success
5 Invalid Parameter
0x8015 Current copyType does not
provide specified option under
given operation
0x8020 SourceVolume is already a
TargetElement in other
StorageSynchronized
relationship
0x8021 Failed to establish PPRC path
0x8024 Invalid option
0x8025 Invalid combinaton of options
0x8030 Invalid parameter
FreezeConsistencyGroup uint32 Method FreezeConsistencyGroup stops all I/O to
source and target volume pairs for the
given source and target VolumeSpaces.
Sources[] String Parameter of Array of strings containing
FreezeConsistency representations of references to
Group IBMTSESS_VolumeSpace instances,
Each element must have a 1-1
relationship with the target parameter.
Targets[] String Parameter of Array of strings containing
FreezeConsistency representations of references to
Group IBMTSESS_VolumeSpace instances.
Each element must have a 1-1
relationship with the source parameter.
| sourceESSIDs[] String Parameter of Array of strings containing EssIDs used
| FreezeConsistency to create the NILSSIDs for the remote
| Group source volumespaces, the number of
| sources and sourceSSIDs must be the
| same or null.
| sourceSSIDs[] String Parameter of Array of strings containing ssIDs used to
| FreezeConsistency create the NILSSIDs for the remote
| Group source volumespaces, the number of
| sources and sourceSSIDs must be the
| same.
| sourceLSSs[] String Parameter of Freeze Array of strings containing LSSes used to
| ConsistencyGroup create the NILSSIDs for the remote
| source volumespaces, the number of
| sources and sourceLSSs must be the
| same.
| targetESSIDs[] String Parameter of Array of strings containing ESSID used to
| FreezeConsistency create the NILSSIDs for the remote target
| Group volumespaces, the number of targets and
| sourceSSIDs must be the same.
| targetSSIDs[] String Parameter of Array of strings containing ssIDs used to
| FreezeConsistency create the NILSSIDs for the remote target
| Group volumespaces, the number of targets and
| targetSSIDs must be the same.
targetLSSs[] String Parameter of Array of strings containing LSSes used to
FreezeConsistency create the NILSSIDs for the remote target
Group volumespaces, the number of targets and
targetLSSs must be the same.

168 ESS API Reference

 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
Return values — Return values of Description of return values:
FreezeConsistency
Group 0 Success
0x8003 Could not retrieve instance
0x8005 Invalid Sources or Targets
0x8030 Invalid parameter
ThawConsistencyGroup uint32 Method ThawConsistencyGroup un-does the
freeze and enables I/O to be again
performed on the given source and target
VolumeSpaces.
Sources[] String Parameter of Array of strings containing
ThawConsistencyGroup representations of references to
IBMTSESS_VolumeSpaces instances,
Each element must have a 1-1
relationship with the target parameter.
Targets[] String Parameter of Array of strings containing
ThawConsistencyGroup representations of references to
IBMTSESS_VolumeSpaces instances,
Each element must have a 1-1
relationship with the source parameter.
| sourceESSIDs[] String Parameter of Array of strings containing EssIDs used
| ThawConsistencyGroup to create the NILSSIDs for the remote
| source volumespaces, the number of
| sources and sourceSSIDs must be the
| same or null.
| sourceSSIDs[] String Parameter of Array of strings containing ssIDs used to
| ThawConsistencyGroup create the NILSSIDs for the remote
| source volumespaces, the number of
| sources and sourceSSIDs must be the
| same.
| sourceLSSs[] String Parameter of Array of strings containing LSSes used to
| ThawConsistencyGroup create the NILSSIDs for the remote
| source volumespaces, the number of
| sources and sourceLSSs must be the
| same.
| targetSSIDs[] String Parameter of Array of strings containing ssIDs used to
| ThawConsistencyGroup create the NILSSIDs for the remote target
| volumespaces, the number of targets and
| targetSSIDs must be the same.
| targetESSIDs[] String Parameter of Array of strings containing ESSID used to
| ThawConsistencyGroup create the NILSSIDs for the remote target
| volumespaces, the number of targets and
| sourceSSIDs must be the same.
| targetSSIDs[] String Parameter of Array of strings containing ssIDs used to
| ThawConsistencyGroup create the NILSSIDs for the remote target
| volumespaces, the number of targets and
| targetSSIDs must be the same.
targetLSSs[] String Parameter of Array of strings containing LSSes used to
ThawConsistencyGroup create the NILSSIDs for the remote target
volumespaces, the number of targets and
targetLSSs must be the same
Return values — Return values of Description of return values:
ThawConsistencyGroup
0 Success
0x8003 Could not retrieve instance
0x8005 Invalid Sources or Targets
0x8030 Invalid Parameter

Appendix C. CIM Agent class information for the ESS API 169
 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
queryConsistencyGroupSetting uint32 Method queryConsistencyGroupSetting allows
application to query for the current
PPRC/FlashCopy Consistency Group
settings
LSSID String Parameter of Logical Subsystem for which attributes
queryConsistencyGroup should be queried
Setting
Timeout uint16 Parameter of Number of seconds for the PPRC
queryConsistencyGroup ConsistencyGroup timeout (Maximum of
Setting 600000 seconds)
| Return values — Return values of Description of return values:
| queryConsistencyGroup
| 0 Success

| 0x8013 Could not retrieve to

| NICopyCommonService

| 0x8014 Could not retrieve NILSSID

| instance

| 0x8015 Could not create an NILSSID

| instance

| 0x8017 Could not retrieve

| NIConsistencyGroupAttribute
| setConsistencyGroupSetting uint32 Method setConsistencyGroupSetting allows the
| application to replace the current
| Consistency Group attributes
| LSSID String Parameter of Logical Subsystem for which attributes
| setConsistencyGroup should be set
| Setting
| Timeout uint16 Parameter of Number of seconds for the PPRC
| setConsistencyGroup ConsistencyGroup timeout (Maximum of
| Setting 600000 seconds)
| Return values — Return values of Description of return values:
| setConsistencyGroup
|| Setting 0 Success

| 0x8013 Cannot retrieve to

| NICopyCommonService

| 0x8014 Cannot retrieve NILSSID

| instance

| 0x8015 Cannot create an NILSSID

| instance

| 0x8017 Error in setting

| ConsistencyGroupSetting

| 0x8030 setConsistencyGroup
| Setting() failed
| getCRStatus uint32 Method Allows an application to query the staatus
| of the copy relationship.
| Synchronizations String Parameter of Copy relationship of Synchronizations
| getCRStatus
| RemoteSynchronizations String Parameter of It is either
| getCRStatus IBMTSESS_RemoteSourceStorage
| Synchronized or
| IBMTSESS_TargetSourceStorage
| Synchronized. If synchronizations is not
| null, then remoteSynchronizations must
| be null.

170 ESS API Reference

 Table 32. IBMTSESS_StorageConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
| Status String Parameter of For FlashCopy, each entry of Status is
| getCRStatus CopyType, syncState, revertible. For
| PPRC, it is CopyType, syncState,
| suspensionreason. If one relationship
| cannot be retrieved, its Status entry will
| be null. If all entries of Status are null,
| then Status itself will be null.
| Return values — Return values of Description of return values:
| getCRStatus
| 0 Success

| 5 Something wrong with either

| Synchronizations and/or
| RemoteSynchronizations

| 0x8010 Cannot retrieve internal service

| 0x8011 Cannot retrieve internal Volume

| IDs

| 0x8012 Cannot connect to internal

| services

| 0x8020 Fail to query relationship

Table 33. IBMTSESS_LunMaskPrivilegeService class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String This property allows each instance to
define a user-friendly name in addition to
its key properties and identity data and
description information.

The value for

IBMTSESS_LunMaskPrivilegeService is
LunMaskPrivilegeService.
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Service
SystemCreationClassName String Key, MaxLen(256) Describes the scoping system’s
CreationClassName.

The value for

IBMTSESS_LunMaskPrivilegeService is
IBMTSESS_StorageSystem.
SystemName String Key, MaxLen(256) Describes the scoping System’s Name.

The value for

IBMTSESS_LunMaskPrivilegeService is
ESS serial number.

Appendix C. CIM Agent class information for the ESS API 171
 Table 33. IBMTSESS_LunMaskPrivilegeService class properties (continued)
Qualifier or
Property Type Parameter Description
CreationClassName String Key, MaxLen(256) Indicates the name of the class or the
subclass used in the creation of an
instance. When used with the other key
properties of this class, this property
allows all instances of this class and its
subclasses to be uniquely identified. The
value

for IBMTSESS_LunMaskPrivilegeService
is IBMTSESS_LunMaskPrivilegeService.
Name String Key, MaxLen(64) Describes an address or other identifying
information to uniquely name the
LogicalElement.

The value for

IBMTSESS_LunMaskPrivilegeService is
LunMaskPrivilegeService.
CIM_SecurityService
CIM_AuthorizationService
CIM_PrivilegeManagementService
IBMTSESS_LunMaskPrivilegeService
AssignAccess uint32 Method Creates a
IBMTSESS_AccessControlInformation,
and it is linked using an
AuthorizationSubject association to
IBMTSESS_HardwareAccount, and using
AuthorizationTarget association to
Controller, and is associated to
AuthorizationService using
AuthorizedUse.
PrivilegeGranted boolean Parameter of A reference to the PrivilegesGranted flag
AssignAccess in the new/existing Privilege.
Activities[] uint16 Parameter of The activities granted in the new
AssignAccess Privilege. ArrayType (″Indexed″), Values
{0, 1, 2, 3, 4, 5, 6, 7, 8..15999, 16000, ..},
ValueMap {Other, Create, Delete, Detect,
Read, Write, Execute, DMTF Reserved,
Vendor Reserved}
ActivityQualifiers[] string Parameterof The activity qualifiers set in the new
AssignAccess Privilege.
QualifierFormats[] uint16 Parameter of The qualifier formats set in the new
AssignAccess Privilege.
| IBMTSESS_Privileged Ref Privilege Parameter of Reference to the Privilege used or
| AssignAccess created.

172 ESS API Reference

Table 33. IBMTSESS_LunMaskPrivilegeService class properties (continued)
Qualifier or
Property Type Parameter Description
Return values — Return values of Description of return values:
AssignAccess
0 Success
1 Not Supported
4 Failed (Result might be
intermittent. You may need to
look into it.)
5 Missing required property within
Subject or Target
0x8001 Invalid parameter Subject
0x8003 Invalid parameter Target
0x8010 Support Single Target only
0x8020 IBMTSESS cannot
AssignAccess as specified (ESS
CLI cannot create or set
hostconnection.)
0x8021 Controller processing fails
0x8022 HardwareAccount processing
fails
0x8030 Creating indication failure
RemoveAccess uint32 Method Deletes the the associated
AuthorizedSubject instances for the
named subjects.
IBMTSESS_StorageHardwareID REF Subject Parameter of The Subject parameter is a reference to
RemoveAccess the ManagedElement instance
(associated using AuthorizedSubject) for
which privileges are to be revoked.
IBMTSESS_Privilege REF Parameter of A reference to the Privilege to be
Privilege RemoveAccess revoked.
IBMTSESS_SCSIProtocol REF Target Parameter of The Target parameter is a reference to
Controller RemoveAccess the ManagedElement (associated using
AuthorizedTarget) which will no longer be
protected using the Privilege.

Appendix C. CIM Agent class information for the ESS API 173
Table 33. IBMTSESS_LunMaskPrivilegeService class properties (continued)
Qualifier or
Property Type Parameter Description
Return values — Return values of Description of return values:
RemoveAccess
0 Success
1 Not Supported
4 Failed (Result might be
intermittent. You may need to
look into it)
0x8001 Invalid parameter Subject
0x8003 Invalid parameter Target
0x8004 Access not assigned yet
0x8005 The specified Subject and Target
are not associated
0x8010 Support Single Target only
0x8011 Should DetachDevice first
0x8020 IBMTSESS cannot
RemoveAccess as specified
(ESS CLI cannot delete or set
hostconnection, as specified.)
0x8021 Controller processing fails
0x8022 HardwareAccount processing
fails
0x8030 Creating indication failure

Table 34. IBMTSESS_StorageHardwareIDManagementService class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Allows each instance to define a user-friendly
name in addition to its key properties/identity data
and description information.

The value for IBMTSESS_

StorageHardwareIDManagementService is
StorageHardwareIDManagementService.
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Service
SystemCreationClassName String Key, Describes the scoping System’s
MaxLen(256) CreationClassName.

The value for IBMTSESS_

StorageHardwareIDManagementService is
IBMTSESS_StorageSystem.

174 ESS API Reference

 Table 34. IBMTSESS_StorageHardwareIDManagementService class properties (continued)
Qualifier or
Property Type Parameter Description
SystemName String Key, Describes the scoping System’s Name.
MaxLen(256)
The value for IBMTSESS_
StorageHardwareIDManagementService is ESS
serial number.
CreationClassName String Key, Indicates the name of the class or the subclass
MaxLen(256) used in the creation of an instance. When used
with the other key properties of this class, this
property allows all instances of this class and its
subclasses to be uniquely identified.

The value for IBMTSESS_

StorageHardwareIDManagementService is
"IBMTSESS_
StorageHardwareIDManagementService.
Name String Key, MaxLen(64) Describes an address or other identifying
information to uniquely name the LogicalElement.

The value for IBMTSESS_StorageHardwareID

ManagementService is StorageHardwareID
ManagementService.
CIM_SecurityService
CIM_AuthenticationService
CIM_StorageHardwareIDManagementService
IBMTSESS_StorageHardwareIDManagementService
| CreateStorageHardwareID uint32 Method This method creates a CIM_StorageHardwareID.
| It also creates the association
| CIM_ConcreteDependency between this service
| and the new CIM_StorageHardwareID.
| ElementName String Parameter of Refers to the value used by the SecurityService
| CreateStorage to represent identity — in this case, a hardware
| HardwareID worldwide unique name.
| StorageID String Parameter of Refers to the ElementName of the new
| CreateStorage StorageHardwareID instance.
| HardwareID
| IDType String Parameter of Refers to the type of the StorageID property.
| CreateStorage ValueMap{1, 2, 3, 4, } Values {Other, PortWWN,
| HardwareID NodeWWN, Hostname }
| OtherIDType String Parameter of Refers to the type of storage ID when IDType is
| CreateStorage \“Other\”.”
| HardwareID
| CIM_StorageClientSettingData REF Parameter of Refers to the StorageClientSettingData
| Setting CreateStorage containing the OSType appropriate for this
| HardwareID initiator.
| IBMTSESS_StorageHardwareID REF Parameter of Refers to the new StorageHardwareID instance.
| Hardware CreateStorage
| ID HardwareID

Appendix C. CIM Agent class information for the ESS API 175
 Table 34. IBMTSESS_StorageHardwareIDManagementService class properties (continued)
Qualifier or
Property Type Parameter Description
| Return values — Return values of Description of return values:
| CreateStorage
|| HardwareID
0 Success
| 1 Not Supported
| 5 Invalid Parameter
| 0x8010 UserIDType should be PortWWN
| 0x8020 CreateHardwareAccount processing fails
| 0x8030 Creating indication failure
| DeleteStorageHardwareID uint32 Method This method deletes a named
| IBMTSESS_HardwareAccount and all
| associations. ValueMap{0, 1, 2, 3, 4, 5, 6..0xFFF,
| 0x1000, 0x1001..0x7FFF, 0x8000.. } Values
| {Success, Not Supported, Unknown, Timeout,
| Failed, Invalid Parameter, DMFT Reserved,
| Specified instance not found, Method
| Reserved, Vendor Specific }
| IBMTSESS_StorageHardwareID REF Parameter of Refers to the StorageHardwareID instance to be
| Hardware DeleteStorage deleted.
| ID HardwareID
| Return values — Return values of Description of return values:
| DeleteStorage
|| HardwareID
0 Success
| 1 Not Supported
| 5 Invalid Parameter
| 0x8010 Should remove access first
| 0x8020 DeleteHardwareAccount processing fails
| 0x8030 Creating indication failure

Table 35. IBMTSESS_Product class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a user-friendly name in
addition to its key properties or identity data, and description
information.

The value for IBMTSESS_Product is IBM Product + its

version.
CIM_Product
Name String Key Commonly used product name.

The value for IBMTSESS_Product is IBM TotalStorage

Enterprise Storage Server (ESS).
IdentifyingNumber String Key Product identification such as a serial number on software.

The value for IBMTSESS_Product is the ESS serial number.

176 ESS API Reference

Table 35. IBMTSESS_Product class properties (continued)
Qualifier or
Property Type Parameter Description
Vendor String Key The name of the supplier of the Product.

The value for IBMTSESS_Product isIBM.

Version String Key Product version information.

The value for IBMTSESS_Product is the codelevel obtained

from the output report that is generated by the ESSCLI
command, with the list server parameter specified.
IBMTSESS_Product

Table 36. IBMTSESS_AllocatedFromStoragePool class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_AllocatedFromStoragePool
IBMTSESS_AllocatedFromStoragePool
Antecedent (override) IBMTSESS_VolumeSpace Key StoragePool
Dependent (override) IBMTSESS_Volume Key Subsidiary element
SpaceConsumed uint64 Space consumed from this pool, units
(″Bytes″)

Table 37. IBMTSESS_StorageSystemToVolume class properties

Qualifier or
Property Type Parameter Description
CIM_Component
CIM_SystemComponent
CIM_SystemDevice
IBMTSESS_StorageSystemToVolume
GroupComponent IBMTSESS_StorageSystem Key Parent system in the Association
(override)
PartComponent IBMTSESS_Volume Key A component of a System
(override)

Table 38. IBMTSESS_StorageSystemToPort class properties

Qualifier or
Property Type Parameter Description
CIM_Component
CIM_SystemComponent
CIM_SystemDevice
IBMTSESS_StorageSystemToPort
GroupComponent IBMTSESS_StorageSystem Key Parent system in the Association
(override)
PartComponent IBMTSESS_FCPort Key A component of a System
(override)

Appendix C. CIM Agent class information for the ESS API 177
Table 39. IBMTSESS_StorageSystemToController class properties
Qualifier or
Property Type Parameter Description
CIM_Component
CIM_SystemComponent
CIM_SystemDevice
IBMTSESS_StorageSystemToController
GroupComponent IBMTSESS_StorageSystem Key Parent system in the Association
(override)
PartComponent IBMTSESS_Controller Key A component of a System
(override)

Table 40. IBMTSESS_ProtocolControllerForUnit class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_ProtocolControllerForDevice
DeviceNumber String Describes the address of an associated Device
in context of the antecedent Controller.

The value for

IBMTSESS_ProtocolControllerForUnit is the
LUN ID from “list volumeaccess” of the esscli
command.
AccessPriority uint16 Describes the priority given to accesses of the
device through this controller. The highest
priority path will have the lowest value for this
parameter.

The value for

IBMTSESS_ProtocolControllerForUnit is 0.
AccessState uint16 Indicates whether the Controller is actively
commanding or accessing the Device
(value=2) or not (value=3). Also, the value,
\″Unknown\″ (0), can be defined. ValueMap {0,
2, 3}, Values {Unknown, Active, Inactive}.

The value for

IBMTSESS_ProtocolControllerForUnit is 3.
CIM_ProtocolControllerForUnit
IBMTSESS_ProtocolControllerForUnit
Antecedent IBMTSESS_ Key The protocol Controller.
(override) SCSIProtocolController
Dependent (override) IBMTSESS_Volume Key It is the logical unit.

Table 41. IBMTSESS_ProtocolControllerForPort class properties

Qualifier
or
Property Type Parameter Description
CIM_Dependency
CIM_ProtocolControllerForDevice

178 ESS API Reference

Table 41. IBMTSESS_ProtocolControllerForPort class properties (continued)
Qualifier
or
Property Type Parameter Description
DeviceNumber String Describes the address of an
associated Device in context of the
antecedent Controller. The value
for IBMTSESS_
ProtocolControllerForPort is port
ID.
AccessPriority uint16 Describes the priority given to
accesses of the device through
this controller. The highest priority
path will have the lowest value for
this parameter.

The value for IBMTSESS_

ProtocolControllerForPort is 0.
AccessState uint16 Indicates whether the Controller is
actively commanding or accessing
the Device (value=2) or not
(value=3). Also, the value,
\“Unknown\” (0), can be defined.

The value for IBMTSESS_

ProtocolControllerForPort is 3.
CIM_ProtocolControllerForPort
IBMTSESS_ConcreteIdentityPort
Antecedent IBMTSESS_SCSIProtocolController Key It is the protocol controller.
(override)
Dependent (override) IBMTSESS_FCPort Key It is the port.

Table 42. IBMTSESS_AuthorizedTarget class properties

Qualifier or
Property Type Parameter Description
CIM_AuthorizedTarget
IBMTSESS_AuthorizationTarget
Privilege (override) IBMTSESS_Privilege Key Describes the Privilege
affecting the target
resource.
TargetElement IBMTSESS_SCSIProtocolController Key Describes the target set of
(override) resources to which the
Privilege applies.

Table 43. IBMTSESS_AuthorizedSubject class properties

Qualifier or
Property Type Parameter Description
CIM_AuthorizedSubject
IBMTSESS_AuthorizedSubject

Appendix C. CIM Agent class information for the ESS API 179
Table 43. IBMTSESS_AuthorizedSubject class properties (continued)
Qualifier or
Property Type Parameter Description
Privilege (override) IBMTSESS_Privilege Key Describes the Privilege either
granted or denied to an
Identity or group of Identities
collected by a Role.
PrivilegedElement IBMTSESS_StorageHardwareID Key Describes the Subject for
(override) which Privileges are granted
or denied.

Table 44. IBMTSESS_ConcreteDependencyPrivilege class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_ConcreteDependency
IBMTSESS_ConcreteDependencyPrivilege
Antecedent IBMTSESS_LunMaskPrivilegeService Key Represents the independent
(override) object in this association.
Dependent IBMTSESS_Privilege Key Represents the object
(override) dependent on the
Antecedent.

Table 45. IBMTSESS_ConcreteDependencyStorageHardwareID class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_ConcreteDependency
IBMTSESS_ConcreteDependencyStorageHardwareID
Antecedent IBMTSESS_ Key Represents the independent
(override) StorageHardwareIDManagementService object in this association.
Dependent IBMTSESS_StorageHardwareID Key Represents the object
(override) dependent on the
Antecedent.

Table 46. IBMTSESS_HostedService class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_HostedService
IBMTSESS_HostedService
Antecedent IBMTSESS_StorageSystem Key Describes the hosting System
(override)
Dependent IBMTSESS_StorageConfigurationService Key Describes the service hosted on the
(override) System

180 ESS API Reference

Table 47. IBMTSESS_HostedService2 class properties
Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_HostedService
IBMTSESS_HostedService2
Antecedent IBMTSESS_StorageSystem Key Describes the hosting
(override) System
Dependent (override) IBMTSESS_LunMaskingPrivilegeService Key Describes the service
hosted on the System

Table 48. IBMTSESS_HostedService3 class properties

Qualifier
or
Property Type Parameter Description
CIM_Dependency
CIM_HostedService
IBMTSESS_HostedService3
Antecedent IBMTSESS_StorageSystem Key Describes the hosting System
(override)
Dependent IBMTSESS_StorageHardwareID Key Describes the service hosted on the System
(override) ManagementService

Table 49. IBMTSESS_ElementSettingData class properties

Qualifier or
Property Type Parameter Description
CIM_ElementSettingData
IBMTSESS_ElementSettingData
ManagedElement IBMTSESS_Volume Key Describes the managed element.
(override)
SettingData (override) IBMTSESS_StorageSetting Key Describes the SettingData object
associated with the element.

Table 50. IBMTSESS_ElementCapabilities class properties

Qualifier or
Property Type Parameter Description
CIM_ElementCapabilities
IBMTSESS_ElementCapabilities
ManagedElement IBMTSESS_VolumeSpace Key Describes the ManagedElement.
(override)
Capabilities (override) IBMTSESS_StorageCapabilities Key Describes the capabilities object
associated with the element.

Table 51. IBMTSESS_HostedStoragePool class properties

Qualifier or
Property Type Parameter Description
CIM_Component

Appendix C. CIM Agent class information for the ESS API 181
Table 51. IBMTSESS_HostedStoragePool class properties (continued)
Qualifier or
Property Type Parameter Description
CIM_SystemComponent
CIM_HostedStoragePool
IBMTSESS_HostedStoragePool
GroupComponent IBMTSESS_StorageSystem Key Represents the parent system in the
(override) Association
PartComponent IBMTSESS_VolumeSpace Key Represents the component of a System
(override)

Table 52. IBMTSESS_StorageCapabilities class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a user-friendly
name in addition to its key properties or identity
data, and description information.

The value for IBMTSESS_StorageCapabilities is

Storage Capabilities for VolumeSpace.
CIM_Capabilities
InstanceID String Key Identifies a unique instance of Capabilities.

The value for IBMTSESS_StorageCapabilities is

IBMTSESS.
CIM_StorageCapabilities
IBMTSESS_StorageCapabilities
ElementType uint16 Indicates the type of element to which this
StorageCapabilities applies. ValueMap{0, 1, 2, 3,
4, 5, 6}, Values {Unknown, Reserved, Any Type,
StorageVolume, StorageExtent, StoragePool,
StorageConfigurationService}.

The value for IBMTSESS_StorageCapabilities is

5.
NoSinglePointOfFailure Boolean Indicates whether or not the associated element
supports no single point of failure. Values are:
FALSE Does not support no single point of
failure.
TRUE Supports no single point of failure.

The value for IBMTSESS_StorageCapabilities is

TRUE.
NoSinglePointOfFailureDefault Boolean Indicates the default value for the
NoSinglePointOfFailure property.

The value for IBMTSESS_StorageCapabilities is

TRUE.

182 ESS API Reference

Table 52. IBMTSESS_StorageCapabilities class properties (continued)
Qualifier or
Property Type Parameter Description
DataRedundancyMax uint16 Describes the maximum number of complete
copies of data that can be maintained.

The value for IBMTSESS_StorageCapabilities is

1.
DataRedundancyMin uint16 Describes the minimum number of complete
copies of data that can be maintained.

The value for IBMTSESS_StorageCapabilities is

1.
DataRedundancyDefault uint16 Describes the default number of complete copies
of data that can be maintained.

The value for IBMTSESS_StorageCapabilities is

1.
PackageRedundancyMax uint16 Describes the maximum number of redundant
packages that can be used.

The value for IBMTSESS_StorageCapabilities is

1.
PackageRedundancyMin uint16 Describes the minimum number of redundant
packages that can be used.

The value for IBMTSESS_StorageCapabilities

is1.
PackageRedundancyDefault uint16 Describes the default number of redundant
packages that is used.

The value for IBMTSESS_StorageCapabilities is

1.
DeltaReservationMax uint16 DeltaReservationMin is a number between 1
(1%) and a 100 (100%) that specifies the
minimum amount of space that should be
reserved in a replica for caching changes.

The value for IBMTSESS_StorageCapabilities is

100.
DeltaReservationMin uint16 DeltaReservationMin is a number between 1
(1%) and a 100 (100%) that specifies the
minimum amount of space that should be
reserved in a replica for caching changes.

The value for IBMTSESS_StorageCapabilities is

100.
DeltaReservationDefault uint16 Delta reservation is a number between 1 (1%)
and a 100 (100%) that specifies how much
space should be reserved by default in a replica
for caching changes.

The value for IBMTSESS_StorageCapabilities is

100.
IBMTSESS_StorageCapabilities

Appendix C. CIM Agent class information for the ESS API 183
Table 53. IBMTSESS_StorageSetting class properties
Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a user-friendly name in
addition to its key properties or identity data, and
description information.

The value for IBMTSESS_StorageSetting is Storage

Setting for RAID5 or Storage Setting for RAID10.
CIM_SettingData
InstanceID String Key Identifies an unique instance of Capabilities.

The value for IBMTSESS_StorageSetting is raid5

or raid10.
CIM_StorageSetting
NoSinglePointOfFailure Boolean Indicates the desired value for No Single Point of
Failure. Values are:
TRUE There is no single point of failure.
FALSE There is a single point of failure.

The value for IBMTSESS_StorageSetting is TRUE.

DataRedundancyMax uint16 Describes the maximum number of complete copies of
data to be maintained.

The value for raid5 is 1.

The value for raid10 is 2.

DataRedundancyMin uint16 Describes the minimum number of complete copies of
data to be maintained.

The value for raid5 is 1.

The value for raid10 is 2.

DataRedundancyGoal uint16 Describes the desired number of complete copies of
data to be maintained.

The value for raid5 is 1.

The value for raid10 is 2.

PackageRedundancyMax uint16 Describes the maximum number of redundant packages
to be used.

The value for IBMTSESS_StorageSettingis 1.

PackageRedundancyMin uint16 Describes the minimum number of redundant packages
to be used.

The value for IBMTSESS_StorageSettingis 1.

PackageRedundancyGoal uint16 Describes the desired number of redundant packages to
be used.

The value for IBMTSESS_StorageSettingis 1.

184 ESS API Reference

Table 53. IBMTSESS_StorageSetting class properties (continued)
Qualifier or
Property Type Parameter Description
DeltaReservationMax uint8 DeltaReservationMax is a number between 1 (1%) and
a 100 (100%) which specifies the maximum amount of
space that should be reserved in a replica for caching
changes.

The value for IBMTSESS_StorageSettingis 100.

DeltaReservationMin uint8 DeltaReservationMin is a number between 1 (1%) and a
100 (100%) which specifies the minimum amount of
space that should be reserved in a replica for caching
changes.

The value for IBMTSESS_StorageSettingis 100.

DeltaReservationGoal uint8 DeltaReservationGoal is a number between 1 (1%) and
a 100 (100%) which specifies the desired amount of
space that should be reserved in a replica for caching
changes.

The value for IBMTSESS_StorageSettingis 100.

IBMTSESS_StorageSetting

Table 54. IBMTSESS_Chassis class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a user-friendly name in
addition to its key properties or identity data, and
description information.

The value for IBMTSESS_Chassis is Chassis.

CIM_ManagedSystemElement
CIM_PhysicalElement
Tag String Key Uniquely identifies the Physical Element.

The value for IBMTSESS_Chassis is the ESS serial

number.
CreationClassName String Key Indicates the name of the class of the subclass used in
the creation of an instance.

The value IBMTSESS_Chassis is IBMTSESS_Chassis.

CIM_PhysicalPackage
CIM_PhysicalFrame
CIM_Chassis
NumberOfPowerCords uint16 Indicates the number of power cords which must be
connected to the Chassis for all the components to
operate.

The value for IBMTSESS_Chassis is 2.

CurrentRequiredOrProduced uint16 The value for IBMTSESS_Chassis is -1.

Appendix C. CIM Agent class information for the ESS API 185
Table 54. IBMTSESS_Chassis class properties (continued)
Qualifier or
Property Type Parameter Description
HeatGeneration uint16 Describes the amount of heat generated by the Chassis
in BTU/hour.

The value for IBMTSESS_Chassis is 0.

ChassisType uint16 Indicates the type of Chassis.

The value for IBMTSESS_Chassis is 22, which means

Storage Chassis.
TypeDescriptions String Provides more information on the ChassisTypes array
entries.

The value for IBMTSESS_Chassis is IBM Enterprise

System Server.
IBMTSESS_Chassis

Table 55. IBMTSESS_ComputerSystemPackage class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_SystemPackaging
CIM_ComputerSystemPackage
IBMTSESS_ComputerSystemPackage
Antecedent IBMTSESS_Chassis Key Describes the PhysicalPackage that realizes a
(override) Unitary ComputerSystem.
Dependent IBMTSESS_StorageSystem Key Describes the UnitaryComputerSystem.
(override)

Table 56. IBMTSESS_ExtraCapacitySet class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a user-friendly name in
addition to its key properties or identity data, and description
information.

The value for IBMTSESS_ExtraCapacitySet is Extra

Capacity Set.
CIM_Collection
CIM_SystemSpecificCollection
InstanceID String Key Identifies a unique instance of collection that is scoped
(contained) by a System.

The value for IBMTSESS_ExtraCapacitySet is ESS ids.

CIM_RedundancySet

186 ESS API Reference

Table 56. IBMTSESS_ExtraCapacitySet class properties (continued)
Qualifier or
Property Type Parameter Description
RedundancyStatus uint16 Provides information on the state of the RedundancySet.
ValueMap {0, 1, 2, 3, 4}, Values {Unknown, Other, Fully
Redundant, Degraded Redundancy, Redundancy Lost}.

The value for IBMTSESS_ExtraCapacitySet is 0.

CIM_ExtraCapacitySet
MinNumberNeeded uint32 Indicates the smallest number of elements that must be
operational in order to function.

The value for IBMTSESS_ExtraCapacitySet is 1.

MaxNumberSupported uint32 Indicates the largest number of elements that can participate
in the ExtraCapacitySet. A value of 0 indicates that there is
not limit on the number of elements.

The value for IBMTSESS_ExtraCapacitySet is 2.

LoadBalancedSet Boolean Indicates whether load balancing is supported by the
ExtraCapacitySet.

The value for IBMTSESS_ExtraCapacitySet is TRUE.

IBMTSESS_ExtraCapacitySet

Table 57. IBMTSESS_ConcreteIdentityCapSet class properties

Qualifier or
Property Type Parameter Description
CIM_LogicalIdentity
CIM_ConcreteIdentity
IBMTSESS_ConcreteIdentityCapSet
SystemElement IBMTSESS_StorageSystem Key Describes one aspect of the
(override) ManagedElement
SameElement IBMTSESS_ExtraCapacitySet Key Describes another aspect of the
(override) ManagedElement

Table 58. IBMTSESS_ProductPhysicalComponent class properties

Qualifier or
Property Type Parameter Description
CIM_Component
CIM_ProductPhysicalComponent
IBMTSESS_ProductPhysicalComponent
GroupComponent IBMTSESS_Product Key Describes the Product.
(override)
PartComponent IBMTSESS_Chassis Key Describes the PhysicalElement that is part of the
(override) Product.

Table 59. IBMTSESS_RemoteServiceAccessPoint class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement

Appendix C. CIM Agent class information for the ESS API 187
Table 59. IBMTSESS_RemoteServiceAccessPoint class properties (continued)
Qualifier or
Property Type Parameter Description
ElementName String Enables each instance to define a user-friendly name in
addition to its key properties or identity data, and
description information.

The value for IBMTSESS_RemoteServiceAccessPoint is

System Management URL.
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_ServiceAccessPoint
SystemCreationClassName String Key Identifies the CreationClassName for the scoping
System.

The value for IBMTSESS_RemoteServiceAccessPoint is

IBMTSESS_StorageSystem.
SystemName String Key Describes the name of the scoping System.

The value for IBMTSESS_RemoteServiceAccessPoint is

the ESS ID.
CreationClassName String Key Indicates the name of the class or the subclass used in
the creation of an instance.

The value for IBMTSESS_RemoteServiceAccessPoint is

IBMTSESS_RemoteServiceAccessPoint.
Name String Key Uniquely identifies the ServiceAccessPoint and provides
an indication of the functionality that is managed.

The value for IBMTSESS_RemoteServiceAccessPoint is

RemoteServiceAccessPoint.
CIM_RemoteServiceAccessPoint
AccessInfo String Access, addressing information, or both for a remote
connection.

The value for IBMTSESS_RemoteServiceAccessPoint is

http://"+ip address of SHARK.
InfoFormat uint16 Describes the format and interpretation of the
AccessInfo property. ValueMap {1, 2, 3, 4, 5, 6, 7, 8, 9,
10, 11, 12, 13, 100, 101, 102, 103, 104, 200, 201, 202, 203,
204, 205, .., 32768..65535}. Values {Other, Host Name,
IPv4 Address, IPv6 Address, IPX Address, DECnet
Address, SNA Address, Autonomous System Number, MPLS
Label, IPv4 Subnet Address, IPv6 Subnet Address, IPv4
Address Range, IPv6 Address Range, Dial String,
Ethernet Address, Token Ring Address, ATM Address,
Frame Relay Address, URL, FQDN, User FQDN, DER ASN1
DN, DER ASN1 GN, Key ID, DMTF Reserved, Vendor
Reserved}

The value for IBMTSESS_RemoteServiceAccessPoint is

200.
IBMTSESS_RemoteServiceAccessPoint

188 ESS API Reference

Table 60. IBMTSESS_HostedAccessPoint class properties
Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_HostedAccessPoint
IBMTSESS_HostedAccessPoint
Antecedent IBMTSESS_StorageSystem Key Describes the hosting System.
(override)
Dependent IBMTSESS_RemoteServiceAccessPoint Key Describes the SAPs that are hosted
(override) on this System.

Table 61. IBMTSESS_StorageProcessorCard class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a user-friendly name in
addition to its key properties or identity data, and
description information.

The value for IBMTSESS_StorageProcessorCard is

Cluster One Processor Card and Cluster Two Processor
Card.
CIM_ManagedSystemElement
OperationalStatus uint16[] Indicates the current statuses of the element.

The value for IBMTSESS_StorageProcessorCard is 2,

which means OK.
CIM_PhysicalElement
Tag String Key Uniquely identifies the Physical Element and serves as the
key for the Element.

The value for IBMTSESS_StorageProcessorCard is the

ESS ID + ″Cluster One″ or ″Cluster Two″.
CreationClassName String Key Indicates the name of the class or the subclass used in the
creation of an instance.

The value for IBMTSESS_StorageProcessorCard is

IBMTSESS_StorageProcessorCard.
CIM_PhysicalPackage
CIM_Card
IBMTSESS_StorageProcessorCard

Table 62. IBMTSESS_ComputerSystemPackageCard class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_SystemPackaging
CIM_ComputerSystemPackaging
IBMTSESS_ComputerSystemPackageCard

Appendix C. CIM Agent class information for the ESS API 189
Table 62. IBMTSESS_ComputerSystemPackageCard class properties (continued)
Qualifier or
Property Type Parameter Description
Antecedent IBMTSESS_StorageProcessorCard Key Describes the PhysicalPackage that
(override) realizes a Unitary ComputerSystem
Dependent IBMTSESS_StorageSystem Key Describe a ComputerSystem.
(override)

Table 63. IBMTSESS_MemberOfCollection class properties

Qualifier or
Property Type Parameter Description
CIM_MemberOfCollection
IBMTSESS_MemberOfCollection
Collection IBMTSESS_ExtraCapacitySet Key Describes the collection that aggregates
(override) members.
Member IBMTSESS_StorageSystem Key Describes the aggregated member of the
(override) Collection.

Table 64. IBMTSESS_DiskDrive properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a
user-friendly name in addition to its key
properties or identity data, and description
information. The value for
IBMTSESS_DiskDrive is Disk Drive on
+diskgroupId.
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_LogicalDevice
SystemCreationClassName String Key, Describes the CreationClassName for the
MaxLen(256) scoping System. The value for
IBMTSESS_DiskDrive is
IBMTSESS_StorageSystem.
SystemName String Key, Describes the name of the scoping System.
MaxLen(256) The value for IBMTSESS_DiskDrive is the
serial number of the ESS.
CreationClassName String Key, Indicates the name of the class or the
MaxLen(256) subclass used in the creation of an instance.
When used with the other key properties of
this class, this property enables all instances
of this class and its subclasses to be uniquely
identified. The value for IBMTSESS_DiskDrive
is IBMTSESS_DiskDrive.

190 ESS API Reference

Table 64. IBMTSESS_DiskDrive properties (continued)
Qualifier or
Property Type Parameter Description
DeviceID String Key, MaxLen(64) Describes an address or other identifying
information to uniquely name the
LogicalDevice. The value for
IBMTSESS_DiskDrive is the disk number,
such as dd0105.
CIM_MediaAccessDevice
Capabilities uint16[] Capabilities of the MediaAccessDevice.
ValueMap {0, 1, 2, 3, 4, 5, 6, 7, 8, 9,10, 11, 12}
Values{Unknown, Other, Sequential Access,
Random Access, Supports Writing ,
Encryption, Compression, Supports
Removeable Media, Manual Cleaning,
Automatic Cleaning, SMART Notification,
Supports Dual Sided Media ,Predismount
Eject Not Required The value for
IBMTSESS_DiskDrive is 3.
CapabilityDescriptions String[] Provides more detailed explanation for any of
the AccessDevice features indicated in the
Capabilities array. The value for
IBMTSESS_DiskDrive is disk capacity + GB
Disk Drive.
NumberOfMediaSupported uint32 The value for IBMTSESS_DiskDrive is 1.
MaxMediaSize uint64 Describes the maximum size, in KBytes, of
media supported by this device
DefaultBlockSize uint64 Describes the default block size, in bytes, for
this device. The value for
IBMTSESS_DiskDrive is 512.
MaxBlockSize uint64 Describes the maximum block size, in bytes,
for media accessed by this device. The value
for IBMTSESS_DiskDrive is 512.
MinBlockSize uint64 Describes the minimum block size, in bytes,
for media accessed by this device. The value
for IBMTSESS_DiskDrive is 512.
NeedsCleaning Boolean Indicates that the MediaAccessDevice needs
cleaning. The value for IBMTSESS_DiskDrive
is FALSE.
MediaIsLocked Boolean Indicates that the media is locked in the
device and cannot be ejected. The value for
IBMTSESS_DiskDrive is FALSE.
Security uint16 Indicates the operational security defined for
the MediaAccessDevice. ValueMap {1, 2, 3, 4,
5, 6, 7} Values {Other, Unknown, None, Read
Only, Locked Out, Boot Bypass, Boot Bypass
and Read Only} The value for
IBMTSESS_DiskDrive is 1.
DiskDrive
IBMTSESS_DiskDrive

Appendix C. CIM Agent class information for the ESS API 191
Table 65. IBMTSESS_PhysicalPackage class properties
Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Enables each instance to define a user-friendly
name in addition to its key properties or identity
data and description information. The value for
IBMTSESS_PhysicalPackage is Disk Group on
ESS + ESS serial number.
CIM_ManagedSystemElement
Name String Defines the label by which the object is known.
When subclassed, the Name property can be
overridden to be a Key property. The value for
IBMTSESS_PhysicalPackage will be ESS serial
number.
CIM_PhysicalElement
Tag String Key Uniquely identifies the Physical Element and
serves as the key for the Element. The value for
IBMTSESS_PhysicalPackage is diskGroupId-ESS
serial number.
CreationClassName String Key Indicates the name of the class or the subclass
used in the creation of an instance. The value for
IBMTSESS_PhysicalPackage is
IBMTSESS_PhysicalPackage.
Manufacturer String Describes the name of the organization
responsible for producing the PhysicalElement.
The value for IBMTSESS_PhysicalPackage is IBM.
Model String Describes the name by which the PhysicalElement
is generally known. The value for
IBMTSESS_PhysicalPackage is 2105.
PoweredOn Boolean Indicates that the PhysicalElement is powered on.
The value for IBMTSESS_PhysicalPackage is
TRUE.
CanBeFRUed Boolean Indicates whether this PhysicalElement uses field
replaceable units (FRUs). The value for
IBMTSESS_PhysicalPackage is TRUE.
OtherIdentifyingInfo String Captures additional data, beyond that of the Tag
information, that is used to identify a
PhysicalElement.

The value for IBMTSESS_PhysicalPackage is the

redundancy type for the disk group.
CIM_PhysicalPackage
Removable Boolean A PhysicalPackage is Removable if it is designed
to be taken in and out of the physical container in
which it is normally found, without impairing the
function of the overall packaging.

The value for IBMTSESS_PhysicalPackage is

FALSE.

192 ESS API Reference

Table 65. IBMTSESS_PhysicalPackage class properties (continued)
Qualifier or
Property Type Parameter Description
Replaceable Boolean A PhysicalPackage is Replaceable if it is possible
to replace the Element with a physically different
one.

The value for IBMTSESS_PhysicalPackage is

TRUE.
HotSwappable Boolean A PhysicalPackage is HotSwappable if it is
possible to replace the Element with a physically
different but equivalent one while the containing
Package has power applied to it.

The value for IBMTSESS_PhysicalPackage is

FALSE.
Width real32 The width of the PhysicalPackage.
IBMTSESS_PhysicalPackage
location string Describes the location of the diskgroup.

Table 66. IBMTSESS_Realizes class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_Realizes
IBMTSESS_Realizes
Antecedent IBMTSESS_PhysicalPackage Key Describes the physical component that
(override) implements the Device.
Dependent IBMTSESS_DiskDrive Key Describes the LogicalDevice.
(override)

Table 67. IBMTSESS_SystemDevice class properties

Qualifier or
Property Type Parameter Description
CIM_Component
CIM_SystemComponentt
SystemDevice
IBMTSESS_SystemDevice
GroupComponent IBMTSESS_StorageSystem Key Describes the parent system in the
(override) Association.
PartComponent IBMTSESS_DiskDrive Key Describes the component of a
(override) System.

Table 68. IBMTSESS_ControllerConfigurationService class properties

Property Type Qualifier or Parameter Description
CIM_ManagedElement

Appendix C. CIM Agent class information for the ESS API 193
Table 68. IBMTSESS_ControllerConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
ElementName String Allows each instance to define a
user-friendly name in addition to its
key properties/identity data and
description information.

The value for IBMTSESS_

ControllerConfiguration
Service is ControllerConfiguration
Service.
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Service
SystemCreationClassName String Key, MaxLen(256) Describes the scoping System’s
CreationClassName.

The value for IBMTSESS_

ControllerConfigurationService is
IBMTSESS_StorageSystem.
SystemName String Key, MaxLen(256) Describes the scoping System’s
Name.

The value for IBMTSESS_

ControllerConfigurationService is ESS
serial number.
CreationClassName String Key, MaxLen(256) Indicates the name of the class or the
subclass used in the creation of an
instance. When used with the other
key properties of this class, this
property allows all instances of this
class and its subclasses to be
uniquely identified.

The value for IBMTSESS_

ControllerConfigurationService is
IBMTSESS_Controller
ConfigurationService.
Name String Key, MaxLen(64) Describes an address or other
identifying information to uniquely
name the LogicalElement.

The value for IBMTSESS_

ControllerConfigurationService is
Controller
Configuration Service.
CIM_ControllerConfigurationService
IBMTSESS_ControllerConfigurationService
CreateProtocolController uint32 Method Creates an appropriate subclass of
withPorts ProtocolController.
ElementName String Parameter of The string to be used in the
CreateProtocolController ElementName of the new
withPorts ProtocolController

194 ESS API Reference

Table 68. IBMTSESS_ControllerConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
Ports[] String Parameter of Array of strings containing
CreateProtocolController representations of references to
withPorts IBMTSESS_FCPort (or subclass)
instances
Protocol uint16 Parameter of The protocol type for the new
CreateProtocolController ProtocolController
withPorts
CIM_Privilege REF Parameter of Refers to a CIM_Privilege (or
Privilege CreateProtocolController subclass) instance.
withPorts
CIM_Identity REF Parameter of Refers to the CIM_Identity (or
Identity CreateProtocolController subclass) instance.
withPorts
CIM_ProtocolController REF Parameter of Refers to the new ProtocolController
Protocol CreateProtocolController that is created.
Controller withPorts
Return values — Return values of Description of return values:
CreateProtocolController
0 Success
withPorts
4 Failed (Result might be
intermittent, You may need to
look into it.)
5 Invalid Parameter Ports
0x8000 Invalid Protocol
0x8011 Cannot create temporary
controller in CIMOM
repository.
DeleteProtocolController uint32 Method Deletes the ProtocolController and all
associations connected directly to this
ProtocolController.
IBMTSESS_SCSIProtocol REF Parameter of The ProtocolController to be deleted
Controller Protocol DeleteProtocolController
Controller
Return values — Return values of Description of return values:
DeleteProtocolController
0 Success
1 Not Supported
4 Failed (Result might be
intermittent. You may need to
look into it.)
5 Invalid ProtocolController
0x8010 You should remove access
first.
0x8020 Controller processing fails
(Fail to delete controller.)
AttachDevice uint32 Method Associates a LogicalDevice subclass
to a ProtocolController.

Appendix C. CIM Agent class information for the ESS API 195
Table 68. IBMTSESS_ControllerConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
IBMTSESS_SCSIProtocol REF Parameter of AttachDevice The ProtocolController instance
Controller Protocol
Controller
IBMTSESS_Volume REF Parameter of AttachDevice The LogicalDevice instance to attach
Device
DeviceNumber String Parameter of AttachDevice The number assigned to
ProtocolControllerForUnit.
DeviceNumber if supported by the
hardware (indicated by Masking
Capabilities. MapUnits set to true) or
if MapUnits is false, but the
DeviceNumber has not been
established in an existing
ProtocolControllerForDevice subclass.
Return values — Return values of AttachDevice Description of return values:
0 Success
1 Not Supported
4 Failed (Result might be
intermittent.You may need to
look into it.)
5 Invalid SCSIProtocol
Controller
0x1000 Invalid Parameter Device
0x8000 Authorization failure
0x8010 You should AssignAccess
first.
0x8011 Device instance is already
attached to a Host.
0x8020 IBMTSESS cannot attach
device as specified. (ESS
CLI cannot create
volumeaccess as specified.)
0x8030
Creating an indication failure

196 ESS API Reference

Table 68. IBMTSESS_ControllerConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
AttachDeviceS uint32 Method This method associates a number of
LogicalDevice subclass (specifically a
StorageVolume or
MediaAccessDevice subclass) to the
referenced ProtocolController. The
associations are persisted as
instances of
ProtocolControllerForUnit. The
management instrumentation provider
must verify that the logical unit
numbers (defined using the
DeviceNumber input parameter) are
unique for the ProtocolController.
When the Protocol Controller is
actively masking a device (that is, is
part of an AuthorizedTarget
association), the provider should
update the access configuration in the
underlying hardware as appropriate.
IBMTSESS_SCSIProtocol REF Parameter of AttachDeviceS The ProtocolController instance.
Controller Protocol
Controller
Devices[] String Parameter of AttachDeviceS The Devices to attach.
DeviceNumber String Parameter of AttachDeviceS The number assigned to
ProtocolController for Unit.
DeviceNumber if supported by the
hardware (indicated by Masking
Capabilities, MapUnits set to true) or
if MapUnits is false, but the
DeviceNumber has not been
established in an existing
ProtocolControllerForDevice subclass.
Return values — Return values of Description of return values:
AttachDeviceS
0 Success
1 Not Supported
4 Failed (Result might be
intermittent. You might need
to look into it.)
5 Invalid SCSIProtocol
Controller
0x1000 Invalid Parameter Device
0x8010 You should AssignAccess
first.
0x8020 IBMTSESS cannot attach
device as specified. (ESS
CLI cannot ″create
volumeaccess″ as specified.)
0x8030
Creating an indication failure

Appendix C. CIM Agent class information for the ESS API 197
Table 68. IBMTSESS_ControllerConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
DetachDevice uint32 Method Removes the
ProtocolControllerForDevice
association subclass between the
ProtocolController and device.
IBMTSESS_SCSIProtocol REF Parameter of DetachDevice The ProtocolController instance
Controller Protocol
Controller
IBMTSESS_Volume REF Parameter of DetachDevice The LogicalDevice instance to detach
Device
Return values — Return values of Description of return values:
DetachDevice
0 Success
1 Not Supported
4 Failed (Result might be
intermittent. You may need to
look into it.)
5 Invalid Controller
0x1000 Invalid parameter Device
0x8001 Cannot remove device since
it is not attached.
0x8020 IBMTSESS cannot remove
device as specified. (ESS
CLI cannot ″delete
volumeacess″ as specified.)
0x8030 Creating an indication failure
DetachDeviceS uint32 Method This method removes the
ProtocolControllerForDevice
association subclass between the
ProtocolController and a set of
LogicalDevice, such as a set of
StorageVolumes. When the
ProtocolController is actively masking
a device (for example, is part of an
AuthorizedTarget association, the
management instrumentation provider
should update the hardware access
configuration when DetachDevice is
called. ValueMap {0, 1, 2, 3, 4, 5,
6..4095, 4096, 4097, 4098..32767,
32768..65535} Values {Success, Not
Supported, Unspecified Error,
Timeout, Failed, Invalid Parameter,
DMTF Reserved, LogicalDevice
Instance not Associated with
Controller, Busy, Method Reserved,
Vendor Specific}
IBMTSESS_SCSIProtocol REF Parameter of DettachDeviceS The ProtocolController instance.
Controller Protocol
Controller
Devices[] String Parameter of DettachDeviceS The LogicalDevice instance to detach.

198 ESS API Reference

Table 68. IBMTSESS_ControllerConfigurationService class properties (continued)
Property Type Qualifier or Parameter Description
Return values — Return values of Description of return values:
DettachDeviceS
0 Success
4 Failed (Result might be
intermittent. You may need to
look into it.)
5 Invalid Controller
0x1000 Invalid parameter Device
0x8020 IBMTSESS cannot remove
device as specified. (ESS
CLI cannot ″delete
volumeacess″ as specified.)
0x8030 Creating an indication failure

Table 69. IBMTSESS_HostedService4 class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_HostedService
IBMTSESS_HostedService2
Antecedent IBMTSESS_StorageSystem Key Describes the hosting
(override) System.
Dependent IBMTSESS_ControllerConfigurationservice Key Describes the Service
(override) hosted on the System.

Table 70. IBMTSESS_DeviceMaskingCapabilities class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Allows each instance to define a
user-friendly name in addition to its key
properties/identity data and description
information.

The value for IBMTSESS_

DeviceMaskingCapabilities is IBMTS.
Caption String The value for IBMTSESS_
DeviceMaskingCapabilities is IBM ESS
Masking Capabilities.
Description String The value for IBMTSESS_
DeviceMaskingCapabilities is IBM ESS
Masking Capabilities.
CIM_Capabilities

Appendix C. CIM Agent class information for the ESS API 199
Table 70. IBMTSESS_DeviceMaskingCapabilities class properties (continued)
Qualifier or
Property Type Parameter Description
InstanceID String Key Identifies a unique instance of
Capabilities.

The value for IBMTSESS_

DeviceMaskingCapabilities is IBM
DeviceMaskingCapabilities.
CIM_ProtocolControllerMaskingCapabilities
ValidHardwareIdTypes uint16[] A list of the valid values for
StrorageHardwareID. IDType ValueMap
{1, 2, 3, 4}, Values {Other, PortWWN,
NodeWWN, Hostname}.

The value for IBMTSESS_

DeviceMaskingCapabilities is 2.
AccessControlByPorts Boolean Indicates whether the associated
storage system allows
ProtocolControllers with different
authorization permissions or subjects
associated with a subset of the storage
system’s ports. Values are:
TRUE The associated storage system
allows ProtocolControllers with
different authorization
permissions or subjects
associated with a subset of the
storage system’s ports.
FALSE The associated storage system
always grants access to
initiators identically through all
storage system ports.

The value for IBMTSESS_

DeviceMaskingCapabilities is TRUE.

200 ESS API Reference

Table 70. IBMTSESS_DeviceMaskingCapabilities class properties (continued)
Qualifier or
Property Type Parameter Description
ClientSelectableDeviceNumbers Boolean Indicates whether this storage system
allows the client to specify the
DeviceNumber parameter when calling
ControllerConfigurationService.
AttachDevice(). Values are:
TRUE This storage system allows the
client to specify the
DeviceNumber parameter
when calling
ControllerConfigurationService.
AttachDevice().
FALSE The implementation does not
allow unit numbers to vary
across ProtocolController.
If set to false and the Device is already
the Dependent of a
ProtocolControllerForUnit association,
then the client can omit the
DeviceNumber parameter (or supply the
same value) in subsequent
ControllerConfigurationService.
AttachDevice calls.

The value for IBMTSESS_

DeviceMaskingCapabilities is FALSE.
AttachDeviceSupported Boolean Indicates whether this storage system
supports the AttachDevice method.
Values are:
TRUE This storage system supports
the AttachDevice method.
FALSE This storage system does not
support the AttachDevice
method.

The value for IBMTSESS_

DeviceMaskingCapabilities is TRUE.
OneHardwareIDPerView Boolean Indicates whether this storage system
limits configurations to a single subject
hardware ID per view. Values are:
TRUE This storage system limits
configurations to a single
subject hardware ID per view.
FALSE This storage system does not
limit configurations to a single
subject hardware ID per view.

The value for IBMTSESS_

DeviceMaskingCapabilities is TRUE.

Appendix C. CIM Agent class information for the ESS API 201
Table 70. IBMTSESS_DeviceMaskingCapabilities class properties (continued)
Qualifier or
Property Type Parameter Description
OnePortPerView Boolean Indicates whether this storage system
limits configurations to a single port per
view. Values are:
TRUE This storage system limits
configurations to a single port
per view.
FALSE This storage system does not
limit configurations to a single
port per view.

The value for IBMTSESS_

DeviceMaskingCapabilities is TRUE.
UniqueUnitNumbersPerPort Boolean Indicates whether this storage system
requires unique unit numbers across all
the ProtocolControllers connected to a
port. Values are:
TRUE This storage system requires
unique unit numbers across all
the ProtocolControllers
connected to a port.
FALSE Different ProtocolContollers
attached to a port can expose
the same unit numbers.

The value for IBMTSESS_

DeviceMaskingCapabilities is FALSE.
IBMTSESS_DeviceMaskingCapabilities

Table 71. IBMTSESS_ElementCapabilitiesMasking class properties

Qualifier or
Property Type Parameter Description
CIM_ElementCapabilities
IBMTSESS_ElementCapabilitiesMasking
ManagedElement IBMTSESS_ Key Describes the
(override) ControllerConfigurationservice ManagedElement.
Capabilities (override) IBMTSESS_ Key Describes the Capabilities
DeviceMaskingCapabilities object associated with the
element.

Table 72. IBMTSESS_ConcreteDependencyController class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_ConcreteDependency
IBMTSESS_ConcreteDependencyController
Antecedent IBMTSESS_ControllerConfigurationService Key Represents the
(override) independent object in
this association.

202 ESS API Reference

Table 72. IBMTSESS_ConcreteDependencyController class properties (continued)
Qualifier or
Property Type Parameter Description
Dependent IBMTSESS_SCSIProtocolController Key Represents the
(override) object dependent on
the Antecedent.

Table 73. IBMTSESS_RegisteredProfile class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
CIM_RegisteredProfile
InstanceID String Key Uniquely identifies an instance of this
class.

The value for

IBMTSESS_StandardProfile is
RegisteredProfile1 or
RegisteredProfile2 or
RegisteredProfile3 or
RegisteredProfile4 or
RegisteredProfile5 or
RegisteredProfile6 or
RegisteredProfile7 or
RegisteredProfile8 or
RegisteredProfile9 or
RegisteredProfile10.
RegisteredOrganization uint16 The organization that defines the
definition for this standard. ValueMap
{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13,
14, 15, 16, 17, 18, 19, Values {Other,
DMTF, CompTIA, Consortium for
Service Innovation, FAST, GGF,
INTAP, itSMF, NAC, Northwest Energy
Efficiency Alliance, SNIA, TM
Forum, The Open Group, ANSI, IEEE,
IETF, INCITS, ISO, W3C}.

The value for

IBMTSESS_StandardProfile is 11.

Appendix C. CIM Agent class information for the ESS API 203
Table 73. IBMTSESS_RegisteredProfile class properties (continued)
Qualifier or
Property Type Parameter Description
RegisteredName String Identifies this standard (profile or
subprofile). It is the responsibility of
the organization to ensure that the
standard’s name is unique within the
scope of the organization .

The value for “RegisteredProfile1” is

Array.

The value for “RegisteredProfile2” is

Cluster.

The value for “RegisteredProfile3” is

Extra Capacity Sets.

The value for “RegisteredProfile4” is

Software.

The value for “RegisteredProfile5” is

Location.

The value for “RegisteredProfile6” is

Access Points.

The value for “RegisteredProfile7” is

Pool Manipulation, Capabilities &
Settings.

The value for “RegisteredProfile8” is

Configuration - LUN creation.

The value for “RegisteredProfile9” is

LUN Mapping & MaskingThe value for
“RegisteredProfile10” is Copy
Services.
RegisteredVersion String The version of this standard (profile
or subprofile).

The value for

IBMTSESS_StandardProfile is 0.1.0.
IBMTSESS_RegisteredProfile

Table 74. IBMTSESS_SubProfileExtendsProfile class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_ReferencedProfile
IBMTSESS_SubProfileExtendsProfile
Antecedent IBMTSESS_RegisteredProfile Key The RegisteredProfile that is
(override) referenced by the Dependent
Profile.
Dependent IBMTSESS_RegisteredProfile Key A RegisteredProfile that
(override) references other profiles.

204 ESS API Reference

Table 75. IBMTSESS_ElementConformsToProfile class properties
Qualifier or
Property Type Parameter Description
CIM_ElementConformsToProfile
IBMTSESS_ElementConformsToProfile
ConformantStandard IBMTSESS_RegisteredProfile Key The RegisteredProfile to
(override) which the
ManagedElement
conforms.
ManagedElement (override) IBMTSESS_StorageSystem Key The ManagedElement
that conforms to the
RegisteredProfile.

Table 76. IBMTSESS_Location class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Allows each instance to define a
user-friendly name in addition to its key
properties/identity data and description
information.

The value for IBMTSESS_Location is

DataCenter1.
CIM_Location
Name String Key Describes a free-form string defining a
label for the Location. It is a part of the
key for the object.

The value for IBMTSESS_Location is

DataCenter1.
PhysicalPosition String Key Describes a free-form string indicating
the placement of a PhysicalElement. It
can specify slot information on a
HostingBoard, mounting site in a
Cabinet, or latitude and longitude
information, for example, from a GPS. It
is part of the key of the Location object.

The value for IBMTSESS_Location is

Some Rack.
IBMTSESS_Location

Table 77. IBMTSESS_PhysicalElementLocation class properties

Qualifier or
Property Type Parameter Description
CIM_ElementLocation
CIM_PhysicalElementLocation
IBMTSESS_PhysicalElementLocation
Element (override) IBMTSESS_Chassis Key Represents the PhysicalElement
whose Location is specified.

Appendix C. CIM Agent class information for the ESS API 205
Table 77. IBMTSESS_PhysicalElementLocation class properties (continued)
Qualifier or
Property Type Parameter Description
PhysicalLocation IBMTSESS_Location Key Represents the
(override) PhysicalElement’s Location.

Table 78. IBMTSESS_StorageClientSettingData class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Allows each instance to define a
user-friendly name in addition to its key
properties/identity data, and description
information.

The value for

IBMTSESS_InitiatorSettingData is
"StorageClientSetting for "+operation
system.
CIM_SettingData
InstanceID String Key Identifies an unique instance of
Capabilities.

The value for

IBMTSESS_InitiatorSettingData is
operating system.
CIM_StorageClientSettingData
ClientTypes uint16[] These names map to combinations of
OperatingSystem, Version, Driver, and
other host environment factors that
influence the behavior exposed by storage
systems. ValueMap {3, 4, 5, 6, 7, 9, 10, 11,
12, 13, 14, 15, 16} Values {Solaris, HPUX,
OpenVMS, Tru64, Netware, AIX, DGUX, Dynix,
Irix, Cisco iSCSI Storage Router, Linux,
Microsoft Windows, OS400}
OtherClientTypeDescriptions String Array entries correspond to entries in
InitiatorTypes to allow variations or
qualifications of InitiatorTypes. If
InitiatorTypes is 3, then it is
{SOLARIS251,SOLARIS26}. If InitiatorTypes is
14, then it is {LINUX,LINUXPPC,LINUX390}.
IBMTSESS_StorageClientSettingData

Table 79. IBMTSESS_InitiatorElementSettingData class properties

Qualifier or
Property Type Parameter Description
CIM_ElementSettingData
IBMTSESS_InitiatorElementSettingData
ManagedElement IBMTSESS_StorageHardwareID Key Describes the
(override) managed element.

206 ESS API Reference

Table 79. IBMTSESS_InitiatorElementSettingData class properties (continued)
Qualifier or
Property Type Parameter Description
SettingData (override) IBMTSESS_ Key Describes the
StorageClientSettingData SettingData object
associated with the
element.

Table 80. IBMTSESS_StorageExtent class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
CIM_ManagedSystemElement
OperationalStatus uint16[] Indicates the current status of the
element. Various functional and
non-functional statuses are defined.
ValueMap {0, 1, 2, 3, 4, 5, 6, 7, 8, 9,
10, 11, 12, 13, 14, 15, 16, 17, 18},
Values {Unknown, Other, OK, Degraded,
Stressed, Predictive Failure, Error,
Non-Recoverable Error, Starting,
Stopping, Stopped, In Service, No
Contact, Lost Communication,
Aborted, Dormant, Supporting Entity
in Error, Completed, Power Mode}.

The value for

IBMTSESS_StorageExtent is {2}.
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_LogicalDevice
SystemCreationClassName String Key, MaxLen(256) Describes the scoping System’s
CreationClassName.

The value for

IBMTSESS_StorageExtent is
IBMTSESS_
StorageSystem.
SystemName String Key, MaxLen(256) Describes the scoping System’s
Name.

The value for

IBMTSESS_StorageExtent is the ESS
serial number to which this diskgroup
belongs.

Appendix C. CIM Agent class information for the ESS API 207
Table 80. IBMTSESS_StorageExtent class properties (continued)
Qualifier or
Property Type Parameter Description
CreationClassName String Key, MaxLen(256) Indicates the name of the class or the
subclass used in the creation of an
instance. When used with the other
key properties of this class, this
property allows all instances of this
class and its subclasses to be
uniquely identified.

The value for

IBMTSESS_StorageExtent is
IBMTSESS_StorageExtent.
DeviceID String Key, MaxLen(64) Describes an address or other
identifying information to uniquely
name the LogicalDevice.

The value for

IBMTSESS_StorageExtent is the
diskgroup id obtained from the esscli,
such as dg2.
CIM_StorageExtent
Primordial Boolean Indicates whether the containing
System does not have the ability to
create or delete this operational
element. Values are:
TRUE \“Primordial\”indicates that
the containing System does
not have the ability to create
or delete this operational
element.
FALSE \“Primordial\”indicates that
the containing System has
the ability to create or delete
this operational element.

The value for

IBMTSESS_StorageExtent is FALSE.
BlockSize uint64 Describes the size in bytes of the
blocks which form this StorageExtent.
If variable block size, then the
maximum block size in bytes should
be specified. If the block size is
unknown or if a block concept is not
valid (for example, for
AggregateExtents, Memory or
LogicalDisks), enter a 1. Units
(″Bytes″).

The value for

IBMTSESS_StorageExtent is 1.

208 ESS API Reference

 Table 80. IBMTSESS_StorageExtent class properties (continued)
Qualifier or
Property Type Parameter Description
NumberOfBlocks uint64 Describes the total number of logically
contiguous blocks, of size Block Size,
which form this Extent. The total size
of the Extent is calculated by
multiplying BlockSize by
NumberOfBlocks. If the BlockSize is
1, this property is the total size of the
Extent.
ExtentStatus uint16[] StorageExtents have additional status
information beyond that captured in
the OperationalStatus and other
properties, inherited from
ManagedSystemElement. ValueMap
{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12,
13, 14, 15..32767, 32768..65535},
Values {Other, Unknown, None/Not
Applicable, Broken, Data Lost,
Dynamic Reconfig, Exposed,
Fractionally Exposed, Partially
Exposed, Protection Disabled,
Readying,Rebuild, Recalculate, Spare
in Use, Verify In Progress, DMTF
Reserved, Vendor Reserved}.

The value for

IBMTSESS_StorageExtent is {2}.
IBMTSESS_StorageExtent
diskGrpStatus String Describes the status of the diskgroup
from ESS CLI.

| Table 81. IBMTSESS_MediaPresentExtent class properties

| Qualifier or
| Property Type Parameter Description
| CIM_Dependency
| CIM_MediaPresent
| Antecedent (override) IBMTSESS_ Key This refers to the
| DiskDrive MediaAccessDevice.
| Dependent (override) IBMTSESS_ Key This refers to the StorageExtent.
| Storage
| Extent
|
Table 82. IBMTSESS_Component class properties
Qualifier or
Property Type Parameter Description
CIM_Component
IBMTSESS_Component
GroupComponent IBMTSESS_StorageExtent Key Describes the
(override) GroupComponent.

Appendix C. CIM Agent class information for the ESS API 209
Table 82. IBMTSESS_Component class properties (continued)
Qualifier or
Property Type Parameter Description
PartComponent (override) IBMTSESS_VolumeSpace Key Describes the
PartComponent.

Table 83. IBMTSESS_PrimordialStoragePool class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
ElementName String Allows each instances to define a
user-friendly name in addition to its key
properties/identity data and description
information.

The value for IBMTSESS

_PrimordialStoragePool is Primordial
StoragePool.
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_StoragePool
InstanceID String Key Identifies a unique instance of StoragePool.

The value for IBMTSESS_

PrimordialStoragePool is the ESS serial
number.
PoolID String A unique name in the context of the System
that identifies this pool.

The value for

IBMTSESS_PrimordialStoragePool is
Primordial StoragePoo.
Primordial Boolean Indicates that the containing System does
not have the ability to create or delete this
operational element.
TRUE \″Primordial\″ indicates that the
containing System does not have
the ability to create or delete this
operational element.
FALSE \″Primordial\″ indicates that the
containing System has the ability
to create or delete this operational
element.

The value for IBMTSESS_

PrimordailStoragePool is TRUE.
TotalManagedSpace uint64 The total amount of raw storage (in bytes)
managed by this StoragePool.

The value for IBMTSESS_

PrimordialStoragePool is the total size of
the diskgroups.
RemainingManagedSpace uint64 Describes the remaining capacity available
in bytes.

210 ESS API Reference

Table 83. IBMTSESS_PrimordialStoragePool class properties (continued)
Qualifier or
Property Type Parameter Description
IBMTSESS_PrimordialStoragePool
GetSupportedSizes String Method Used to retrieve a list of supported sizes for
pool creation.
ElementType uint16 Parameter of The type of element for which supported
GetSupportedSizes sizes are reported. ValueMap{2, 3}, Values
{Storage Pool, Storage Volume}
CIM_StorageSetting REF Goal Parameter of Not Supported
GetSupportedSizes
Sizes[] uint64 Parameter of List of support sizes for a Volume/Pool
GetSupportedSizes creation or modification.), Units (“Bytes”)
Return values — Return values of Description of return values:
GetSupportedSizes
0 Success
4 Failed (Result might be
intermittent. You may need to
investigate it.)
0x8000 ElementType is invalid.

Table 84. IBMTSESS_HostedPrimordialStoragePool class properties

Qualifier or
Property Type Parameter Description
CIM_Component
CIM_SystemComponent
CIM_HostedStoragePool
IBMTSESS_HostedPrimordialStoragePool
GroupComponent IBMTSESS_StorageSystem Key Describes the
(override) GroupComponent.
PartComponent IBMTSESS_PrimordialStoragePool Key Describes the
(override) PartComponent.

Table 85. IBMTSESS_StorageSynchronized class properties

Property Type Qualifier or Parameter Description
CIM_Synchronized
CIM_StorageSynchronized
IBMTSESS_StorageSynchronized
SystemElement (override) IBMTSESS_Volume Key Represents the Storage that is
the source of the replication.
SyncedElement (override) IBMTSESS_Volume Key Represents the Storage that is
the target of the replication.

Table 86. IBMTSESS_EltCapabilitiesStgPool class properties

Qualifier or
Property Type Parameter Description
CIM_ElementCapabilities

Appendix C. CIM Agent class information for the ESS API 211
 Table 86. IBMTSESS_EltCapabilitiesStgPool class properties (continued)
Qualifier or
Property Type Parameter Description
IBMTSESS_EltCapabilitiesStgPool
ManagedElement IBMTSESS_ Key Describes the
(override) PrimordialStoragePool ManagedElement.
Capabilities (override) IBMTSESS_StorageCapabilities Key Describes the Capabilities
object associated with the
element.

Table 87. IBMTSESS_Provider class properties

Property Type Qualifier or Parameter Description
| CIM_ManagedElement
| CIM_ManagedSystemElement
| CIM_LogicalElement
| CIM_EnabledLogicalElement
| CIM_Service
| SystemCreationClassName String Key, MaxLen(256) Describes the scoping System’s
| CreationClassName.

| The value for

| IBMTSESS_Provider is IBMTS.
SystemName String Key, MaxLen(256) Describes the scoping System’s
Name.

The value for

IBMTSESS_Provider is IBM
Provider.
CreationClassName String Key, MaxLen(256) Indicates the name of the class
or the subclass used in the
creation of an instance. When
used with the other key
properties of this class, this
property allows all instances of
this class and its subclasses to
be uniquely identified.

The value for

IBMTSESS_Provider is
IBMTSESS_Provider.
Name String Key, MaxLen(64) Describes an address or other
identifying information to
uniquely name the
LogicalElement.

The value for

IBMTSESS_Provider is IBM ESS
Provider.
CIM_WBEMService
CIM_Provider
IBMTSESS_Provider

212 ESS API Reference

Table 87. IBMTSESS_Provider class properties (continued)
Property Type Qualifier or Parameter Description
Version String Describes the version of the
ESS Provider code.

Table 88. IBMTSESS_VolumeStatistics class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
CIM_StatisticalData
InstanceID String Key InstanceID opaquely identifies a
unique instance of StatisticalData.
The key contains
[ESSID]+″-″+[VolID] where VolID
is the DeviceID of the
corresponding
IBMTSESS_Volume.
ElementName String The user-friendly name for this
instance of StatisticalData.
StartStatisticTime Datetime Retrieves the time when the
statistics collection started.
StatisticTime Datetime Provides the timestamp for this
statistics instance.
SampleInterval Datetime Describes the frequency of the
statistics collection.
IBMTSESS_VolumeStatistics
ReadIOOperations uint64 SeqReadIOOperations +
DirectReadIOOperations
WriteIOOperations uint64 SeqWriteIOOperations +
DirectWriteIOOperations
SeqReadIOOperations uint64 Taken from the ESS statistics file
(Volume Statistics): Sequential
I/O - I/O requests - Read Count.
DirectReadIOOperations uint64 Taken from the ESS statistics file
(Volume Statistics): Normal I/O -
I/O requests - Read Count.
SeqWriteIOOperations uint64 Taken from the ESS statistics file
(Volume Statistics): Sequential
I/O - I/O requests - Write Count.
DirectWriteIOOperations uint64 Taken from the ESS statistics file
(Volume Statistics): Normal I/O -
I/O requests - Write Count.
BytesRead uint64 Not supported.
BytesWritten uint64 Taken from the ESS statistics file
(Volume Statistics): Cache ->
Disk ops.
SeqBytesRead uint64 Taken from the ESS statistics file
(Volume Statistics): Disk ->
Cache seq.

Appendix C. CIM Agent class information for the ESS API 213
Table 88. IBMTSESS_VolumeStatistics class properties (continued)
Qualifier or
Property Type Parameter Description
DirectBytesRead uint64 Taken from the ESS statistics file
(Volume Statistics): Disk ->
Cache ops.
NumberOfCacheHitsforReads uint64 NumberOfCacheIOsforReadSeq
+
NumberOfCacheIOsforReadDirect
NumberOfCacheHitsforWrites uint64 NumberOfCacheIOsforWriteSeq
+
NumberOfCacheIOsforWriteDirect
NumberOfCacheIOsforReadSeq uint64 Taken from the ESS statistics file
(Volume Statistics): Sequential
I/O - Cache hits - Read Count.
NumberOfCacheIOsforWriteSeq uint64 Taken from the ESS statistics file
(Volume Statistics): Sequential
I/O - Cache hits - Write Count.
NumberOfCacheIOsforReadDirect uint64 Taken from the ESS statistics file
(Volume Statistics): Normal I/O -
Cache hits - Read Count.
NumberOfCacheIOsforWriteDirect uint64 Taken from the ESS statistics file
(Volume Statistics): Normal I/O -
Cache hits - Write Count.
IOOperations uint64 ReadIOOperations +
WriteIOOperations
NumberOfIOsServicedFromCache uint64 NumberOfCacheHitsforReads +
NumberOfCacheHitsforWrites.
DasdFastWriteIOs uint64 Taken from the ESS statistics file
(Volume Statistics):
DasdFastWrite ops.
DasdFastWriteSeq uint64 Taken from the ESS statistics file
(Volume Statistics):
DasdFastWrite seq.
VolumeNumber uint64 Taken from the ESS statistics file
(Volume Statistics): Volume
number.
RankName String Taken from the ESS statistics file
(Volume Statistics): Rank name.
RankID uint64 Taken from the ESS statistics file
(Volume Statistics): Rank ID.
CacheAvailable Boolean Taken from the ESS statistics file
(Volume Statistics): Cache
Available.
DasdFastWriteDel uint64 Taken from the ESS statistics file
(Volume Statistics):
DasdFastWrite del.
RecCacheReadMisses uint64 Taken from the ESS statistics file
(Volume Statistics):
RecCacheRead Misses.

214 ESS API Reference

Table 88. IBMTSESS_VolumeStatistics class properties (continued)
Qualifier or
Property Type Parameter Description
TrackPromFailures uint64 Taken from the ESS statistics file
(Volume Statistics): TrackProm.
Failures.
RecModeReads uint64 Taken from the ESS statistics file
(Volume Statistics): RecMode
reads.
NVSAllocations uint64 Taken from the ESS statistics file
(Volume Statistics): NVS
Allocations.
CCXRCReadOps uint64 Taken from the ESS statistics file
(Volume Statistics): CC/XRC ops
- Read Count.
CCXRCWriteOps uint64 Taken from the ESS statistics file
(Volume Statistics): CC/XRC ops
- Write Count.
PPRCTransfers uint64 Taken from the ESS statistics file
(Volume Statistics): PPRC
Transfers.
CSCDelayedOps uint64 Taken from the ESS statistics file
(Volume Statistics): CSC Delayed
ops.
CacheFastWriteIOReadCount uint64 Taken from the ESS statistics file
(Volume Statistics): Cache Fast
Write I/O - Read Count.
CacheFastWriteIOWriteCount uint64 Taken from the ESS statistics file
(Volume Statistics): Cache Fast
Write I/O - Write Count.
QuickWritePromotes uint64 Taken from the ESS statistics file
(Volume Statistics): Quick write
promotes.
IrregularTrackAccess uint64 Taken from the ESS statistics file
(Volume Statistics): Irregular track
access.
IrregularTrackAccessHits uint64 Taken from the ESS statistics file
(Volume Statistics): Irregular track
access hits.

Table 89. IBMTSESS_VolumeSpaceStatistics class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
CIM_StatisticalData
InstanceID String Key Identifies a unique instance of
StatisticalData. The key contains
[VolSpaceID]+″-″+[ESSID] where
VolSpaceID is the DeviceID of the
corresponding IBMTSESS_VolumeSpace.
ElementName String The user-friendly name for this instance
of StatisticalData.

Appendix C. CIM Agent class information for the ESS API 215
Table 89. IBMTSESS_VolumeSpaceStatistics class properties (continued)
Qualifier or
Property Type Parameter Description
StartStatisticTime Datetime Retrieves the time when the statistics
collection started.
StatisticTime Datetime Retrieves the timestamp for this statistics
instance.
SampleInterval Datetime Describes the frequency of the statistics
collection.
IBMTSESS_VolumeSpaceStatistics
ReadIOOperations uint64 Taken from the ESS statistics file (Disk
Group Statistics): I/O requests - Read
Count.
WriteIOOperations uint64 Taken from the ESS statistics file (Disk
Group Statistics): I/O requests - Write
Count.
BytesRead uint64 Taken from the ESS statistics file (Disk
Group Statistics): FixedBlockSec ops -
Read Count.
BytesWritten uint64 Taken from the ESS statistics file (Disk
Group Statistics): FixedBlockSec ops -
Write Count.
ReadTime uint64 Taken from the ESS statistics file (Disk
Group Statistics): Response Time - Read
Count.
WriteTime uint64 Taken from the ESS statistics file (Disk
Group Statistics): Response Time - Write
Count.
IOOperations uint64 ReadIOOperations + WriteIOOperations
BytesTransferred uint64 BytesRead + BytesWritten
RankName String Taken from the ESS statistics file (Disk
Group Statistics): Rank.
RankID String Taken from the ESS statistics file (Disk
Group Statistics): Rank ID.
NumberOfDDMs uint64 Taken from the ESS statistics file (Disk
Group Statistics): Number of DDMs.
SectorSize uint64 Taken from the ESS statistics file (Disk
Group Statistics): Sector Size.
RankType uint64 Taken from the ESS statistics file (Disk
Group Statistics): Rank Type.
VS String The DeviceID of the corresponding
IBMTSESS_VolumeSpace.

Table 90. IBMTSESS_VolumeStatisticalData class properties

Qualifier or
Property Type Parameter Description
CIM_ElementStatisticalData
IBMTSESS_VolumeStatisticalData

216 ESS API Reference

Table 90. IBMTSESS_VolumeStatisticalData class properties (continued)
Qualifier or
Property Type Parameter Description
ManagedElement IBMTSESS_Volume Key Describes the Volume.
(override)
Stats (override) IBMTSESS_VolumeStatistics Key Descrbes the
VolumeStatistics.

Table 91. IBMTSESS_VolumeSpaceStatisticalData class properties

Qualifier or
Property Type Parameter Description
CIM_ElementStatisticalData
IBMTSESS_VolumeSpaceStatisticalData
ManagedElement IBMTSESS_ Key Describes the VolumeSpace.
(override) VolumeSpace
Stats (override) IBMTSESS_ Key Describes the
VolumeSpaceStatistics VolumeSpaceStatistics.

Table 92. IBMTSESS_PerformanceStatisticsService class properties

Qualifier or
Property Type Parameter Description
ElementName String Allows each instance to define a
user-friendly name in addition to its key
properties/identity data and description
information.
CIM_ManagedSystemElement
CIM_LogicalElement
CIM_EnabledLogicalElement
CIM_Service
SystemCreationClassName String Key, MaxLen(256) Describes the scoping System’s
CreationClassName.

The value for IBMTSESS_

PerformanceStatisticsService is
IBMTSESS_StorageSystem.
SystemName String Key, MaxLen(256) Describes the scoping System’s Name.

The value for

IBMTSESS_PerformanceStatisticsService
is the ESS serial number.
CreationClassName String Key, MaxLen(256) Indicates the name of the class or the
subclass used in the creation of an
instance. When used with the other key
properties of this class, this property
allows all instances of this class and its
subclasses to be uniquely identified.

The value for

IBMTSESS_PerformanceStatisticsService
is IBMTSESS_
PerformanceStatisticsService.

Appendix C. CIM Agent class information for the ESS API 217
Table 92. IBMTSESS_PerformanceStatisticsService class properties (continued)
Qualifier or
Property Type Parameter Description
Name String Key, MaxLen(64) Describes an address or other identifying
information to uniquely name the
LogicalElement.
IBMTSESS_PerformanceStatisticsService
StatisticsCollection String It is ’enabled’ if the performance statistics
collection is turned on. It is ’disabled’ if
the performance statistics collection is
turned off.
Frequency uint64 Describes the collection frequency.
Port uint16 Describes the port on the host that
receives the performance data.
GetStatisticsFiles uint32 Method Retrieves the performance statistics files.
The statistics files can only be retrieved
when the performance statistics collection
is turned on.
FileClusterOne[] String Parameter of The statistics file for cluster one. Each line
GetStatisticsFiles of the file is one string in the array
FileClusterTwo[] String Parameter of The statistics file for cluster two. Each line
GetStatisticsFiles of the file is one string in the array
Return values — Return values of Description of return values:
GetStatisticsFiles
0 Success
1 Failed
StartStatisticsCollection uint32 Method Starts the statistics collection.
Port uint16 Parameter of The port on the host that receives the
StartStatistics performance data. This parameter is
Collection optional
Frequency uint16 Parameter of The collection frequency in minutes. This
StartStatistics parameter is optional
Collection
Duration uint16 Parameter of The duration of collecting statistics in
StartStatistics hours. This parameter is optional
Collection
Return values — Return values of Description of return values:
StartStatistics
0 Success
Collection
This return code indicates that the
performance statistics collection has been
started successfully.
1 Failed
This return code indicates that the
performance statistics collection could not
be started. A possible reason is that the
ESS is not able to serve client requests at
this time.
2 The performance statistics
collection has already been
started.
StopStatisticsCollection uint32 Method Stops the statistics collection.

218 ESS API Reference

Table 92. IBMTSESS_PerformanceStatisticsService class properties (continued)
Qualifier or
Property Type Parameter Description
Return values — Return values of Description of return values:
StopStatistics
0 Success
Collection
This return code indicates that the
performance statistics collection has been
stopped successfully.
1 Failed
This return code indicates that the
performance statistics collection can not
be stopped. A possible reason is that the
ESS is not able to serve client requests at
this time.
2 The performance statistics
collection has not been started
before.

Table 93. IBMTSESS_HostedService6 class properties

Qualifier or
Property Type Parameter Description
CIM_Dependency
CIM_HostedService
IBMTSESS_HostedService6
Antecedent IBMTSESS_StorageSystem Key Describes the
(override) hosting System.
Dependent IBMTSESS_PerformanceStatisticsService Key Describes the
(override) Service hosted on
the System.

Table 94. IBMTSESS_RemoteVolume

Property Type Qualifier or Parameter Description
CIM_ManagedElement
EssID String Key Describes the ESS Serial
Number, such as
2105.22232.
LssID String Key Describes the Logical
SubSystem Number. It is a
string in two digits
hexidecimal.
VolID String Key Describes the VolumeID. It
is a string in 4 digits
hexidecimal.

Table 95. IBMTSESS_RemoteSourceStorageSynchronized class properties

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
IBMTSESS_RemoteSourceStorageSynchronized

Appendix C. CIM Agent class information for the ESS API 219
Table 95. IBMTSESS_RemoteSourceStorageSynchronized class properties (continued)
Qualifier or
Property Type Parameter Description
SystemElement IBMTSESS_ Key Represents the Storage that is the source of
(override) RemoteVolume the replication.
SyncedElement IBMTSESS_Volume Key Represents the Storage that is the target of
(override) the replication.
CopyType uint16 Describes the Replication Policy. ValueMap 2,
3, 4, 5, .., 0x8000 ...}, Values Async, Sync,
UnSyncAssoc, UnSyncUnAssoc, DMTF Reserved,
Vendor Specific}
SyncMaintained Boolean Indicates whether the synchronization is being
maintained on an ongoing basis.

This property’s value maybe TRUE or FALSE. A

transition from TRUE to FALSE indicates that a
fracture has occurred or been requested. A
transition from FALSE to TRUE indicates that a
resync operation has occurred or been
requested. SyncMaintained is always FALSE
for point-in-time copies (that is, Flash Copy).
SyncState uint16 Describes the state of the association with
respect to Replication activity.

The values may be Fractured, ReSync In

Progress , or Idle.
Ordered Boolean Indicates whether writes to the replica may
not be in the same sequence as writes to the
source.
TRUE Writes to the replica may be in the
same sequence as writes to the
source.
FALSE Writes to the replica may not be in
the same sequence as writes to the
source.

The value for IBMTSESS_

RemoteSourceStorageSynchronized is FALSE.
Incremental boolean TRUE if the copy is Incremental.
isStateFromSecondary boolean TRUE if the SyncState comes from
SyncedElement.

Table 96. IBMTSESS_RemoteTargetStorageSynchronized

Qualifier or
Property Type Parameter Description
CIM_ManagedElement
IBMTSESS_RemoteTargetStorageSynchronized
SystemElement IBMTSESS_Volume Key Represents the Storage that is the source of
(override) the replication.
SyncedElement IBMTSESS_ Key Represents the Storage that is the target of
(override) RemoteVolume the replication.

220 ESS API Reference

Table 96. IBMTSESS_RemoteTargetStorageSynchronized (continued)
Qualifier or
Property Type Parameter Description
CopyType uint16 Describes the Replication Policy. ValueMap
{2, 3, 4, 5, .., 0x8000...}, Values {Async, Sync,
UnSyncAssoc, UnSyncUnAssoc, DMTF Reserved,
Vendor Specific}
SyncMaintained Boolean Indicates whether the synchronization is
being maintained on an ongoing basis.

This property’s value may be TRUE or FALSE.

A transition from TRUE to FALSE indicates that
a fracture has occurred or been requested. A
transition from FALSE to TRUE indicates that a
resync operation has occurred or been
requested. SyncMaintained is always FALSE
for point-in-time copies (i.e. Flash Copy).
SyncState uint16 Describes the state of the association with
respect to Replication activity.

The values may be Fractured, ReSync In

Progress, or Idle.
Ordered Boolean Indicates whether writes to the replica may
not be in the same sequence as writes to the
source.
TRUE Writes to the replica may be in the
same sequence as writes to the
source.
FALSE Writes to the replica may not be in
the same sequence as writes to the
source.

The value for IBMTSESS_

RemoteTargetStorageSynchronized will be
FALSE.
Incremental boolean TRUE if the copy is Incremental.
isStateFromSecondary boolean TRUE if the SyncState comes from
SyncedElement.

Table 97. IBMTSESS_PPRCPath

Property Type Qualifier or Parameter Description
ManagedElement
ManagedSystemElement
LogicalElement
EnabledLogicalElement
LogicalDevice
SystemCreationClass String Key, MaxLen(256) Describes the scoping System’s
Name CreationClassName.

The value for

IBMTSESS_PPRCPath is
IBMTSESS_StorageSystem.

Appendix C. CIM Agent class information for the ESS API 221
 Table 97. IBMTSESS_PPRCPath (continued)
Property Type Qualifier or Parameter Description
SystemName String Key, MaxLen(256) Describes the scoping System’s
Name.

The value for

IBMTSESS_PPRCPath is the
ESS serial number.
CreationClassName String Key, MaxLen(256) Indicates the name of the class
or the subclass used in the
creation of an instance. When
used with the other key
properties of this class, this
property allows all instances of
this class and its subclasses to
be uniquely identified.

The value for

IBMTSESS_PPRCPath is
IBMTSESS_PPRCPath.
DeviceID String Key, MaxLen(256) Describes an address or other
identifying information to
uniquely name the
LogicalDevice.

The value for

IBMTSESS_PPRCPath is
essid+"-"+sourceLSSNumber+"-
"+targetLSSNumber+"-
"+sourcePortNumber.
IBMTSESS_PPRCPath
Type uint16 Specifies that a path
(IBMTSESS_PPRCPath) has a
type. It can be either ESCON or
FCP. ValueMap {0, 1}, Values
{ESCON, FCP}
State uint16 Describes the state of the path.
SourcePort String Describes the port number of
the source lss.
SourceLSSID String Describes the source LSS ID.
TargetLSSID String Describes the target LSS ID.
SourceServer String Describes the identification of
the source machine (ESS).
TargetSequenceNumber String Describes the sequence number
of the target machine (ESS)
TargetSSID uint16 Describes the Subsystem
Identifer (SSID) of the target
machine (ESS)
| SourceSSID uint16 Describes the Subsystem
| Identifer (SSID) of the source
| machine (ESS)

222 ESS API Reference

| Table 98. IBMTSESS_Pool2PrimordialPool
| Property Type Qualifier or Parameter Description
| CIM_Dependency
| CIM_AllocatedFromStoragePool
| IBMTSESS_Pool2PrimordialPool
| Antecedent (override) IBMTSESS_Primordial Key It is the StoragePool.
| StoragePool
| Dependent (override) IBMTSESS_VolumeSpace Key It is the subsidiary element.
| SpaceConsumed uint64 Space consumed from this
| Pool, in bytes.
|
| Table 99. IBMTSESS_AsyncPPRCService
| Property Type Qualifier or Parameter Description
| ManagedElement
| ElementName String Allows each instance to define a
| user-friendly name in addition to its
| key properties or identity data and
| description information.

| The value for

| IBMTSESS_AsyncPPRCService is
| AsyncPPRCService.
| ManagedSystemElement
| LogicalElement
| EnabledLogicalElement
| Service
| SystemCreationClassName String Key, MaxLen(256) Describes the CreationClassName of
| the scoping system.

| The value for

| IBMTSESS_AsyncPPRCService is
| IBMTSESS_StorageSystem.
| SystemName String Key, MaxLen(256) Describes the name of the scoping
| system.

| The value for

| IBMTSESS_AsyncPPRCService is the
| ESS serial number.
| CreationClassName String Key, MaxLen(256) Indicates the name of the class or the
| subclass that is used in the creation of
| an instance. When
| CreationClassName is used with the
| other key properties of this class, this
| property allows all instances of this
| class and its subclasses to be uniquely
| identified.

| The value for

| IBMTSESS_AsyncPPRCService is
| IBMTSESS_AsyncPPRCService.

Appendix C. CIM Agent class information for the ESS API 223
| Table 99. IBMTSESS_AsyncPPRCService (continued)
| Property Type Qualifier or Parameter Description
| Name String Key, MaxLen(64) Describes an address or other
| identifying information to uniquely
| name the LogicalElement.
| StorageConfigurationService
| IBMTSESS_AsyncPPRCService
| ManageSession uint32 Method Creates or destroys a session that
| constitutes a group of volumes that
| belong to a specified LSS and that
| have some consistency correlation.
| SessionNumber uint16 Parameter of Session number in decimal (1-255)
| ManageSession
| SessionType string Parameter of Session type in hexadecimal, for
| ManageSession example, 0x40 for XDC session, 0x30
| for Flash Copy session, 0x20 for
| PPRC session, 0x10 for XRC session
| LSS string Parameter of LSS for the session, in format
| ManageSession ESSID:LSSID:SSID where ESSID is of
| format like 2105.FA120 and LSSID is a
| 1 or 2 byte hexadecimal LSS number
| SSID is a 1 or 2 byte hexadecimal SS
| ID (empty string if undefined)
| Operation uint16 Parameter of Type of operation - open or close
| ManageSession session. ValueMap{0, 1}, Values {Open,
| Close }
| Return values — Return valuesof Description of return values:
| ManageSession
| 0 Success
| 1 Not Supported
| 5 Invalid input parameter
| 0x8010 Cannot retrieve internal
| Service
| 0x8012 Cannot connect to internal
| Services
| 0x8013 Cannot retrieve internal
| SessionService
| 0x8014 Cannot create NILLSID
| 0x8015 Cannot create SessionID
| 0x8030 Exception in executing
| ManageSession
| 0x8031 Session already opened
| 0x8080 Internal returned NULL in
| ManageSession
| 0x9000 and above are internal return
| values
| ManageSessionVolume uint32 Method Adds or removes the specified
| volumes to or from a session.

224 ESS API Reference

| Table 99. IBMTSESS_AsyncPPRCService (continued)
| Property Type Qualifier or Parameter Description
| SessionNumber uint16 Parameter of Session number in decimal (1-255)
| ManageSessionVolume
| SessionType string Parameter of Session type in hexadecimal, for
| ManageSessionVolume example, 0x40 for XDC session, 0x30
| for FlashCopy session, 0x20 for PPRC
| session, 0x10 for XRC session
| LSS string Parameter of LSS for the session, in the format
| ManageSessionVolume ESSID:LSSID:SSID where ESSID is of
| format like 2105.FA120 and LSSID is a
| 1 or 2 byte hexadecimal LSS number
| and SSID is a 1 or 2 byte hexadecimal
| SS ID (empty string if undefined)
| Volume string[] Parameter of Volumes to be added to or from the
| ManageSessionVolume session volume deviceID in hex.
| Operation uint16 Parameterof Type of operation - add or remove
| ManageSessionVolume volume to/from session. ValueMap {0,
| 1}, Values { Add, Remove }
| Return values — Return values of Description of return values:
| ManageSessionVolume
| 0 Success
| 1 Not Supported
| 5 Invalid input parameter
| 0x8010 Cannot retrieve internal
| Service
| 0x8012 Cannot connect to internal
| Services
| 0x8013 Cannot retrieve internal
| SessionService
| 0x8014 Cannot create NILLSID
| 0x8015 Cannot create SessionID
| 0x8030 Exception in executing
| ManageSessionVolume
| 0x8080 Internal returned NULL in
| ManageSessionVolume
| 0x9000 and above are internal return
| values
| ManageAsyncPPRC uint32 Method Manages an ESS Asynchronous
| PPRC copy relationship, based on
| specified operation.
| SessionNumber uint16 Parameter of Session number in decimal (1-255)
| ManageAsyncPPRC
| SessionType string Parameter of Session type in hexadecimal, for
| ManageAsyncPPRC example, 0x40 for XDC session, 0x30
| for FlashCopy session, 0x20 for PPRC
| session, 0x10 for XRC session

Appendix C. CIM Agent class information for the ESS API 225
| Table 99. IBMTSESS_AsyncPPRCService (continued)
| Property Type Qualifier or Parameter Description
| MasterLSS string Parameter of Master LSS for the copy relationship in
| ManageAsyncPPRC the format ESSID:LSSID:SSID, where
| ESSID is of format like 2105.FA120
| and LSSID is a 1 or 2 byte
| hexadecimal LSS number, and SSID is
| a 1 or 2 byte hexadecimal SS ID
| (empty string if undefined)
| ControlPath string[] Parameter of Array of Path pairs between the
| ManageAsyncPPRC Leader LSS and the Follower LSS in
| the format ESSID:LSSID:SSID –
| ESSID:LSSID:SSID, where the first is
| for the Leader and the second is for
| the Follower. ESSID is of format like
| 2105.FA120 and LSSID is a 1 or 2
| byte hexadecimal LSS number, and
| SSID is a 1 or 2 byte hexadecimal SS
| ID (empty string if undefined)
| Operation uint16 Parameter of Operation type. ValueMap {0, 1, 2, 3},
| ManageAsyncPPRC Values { Start, Pause, Resume,
| Terminate}
| ConsistencyGroupInterval uint16 Parameter of Interval (in seconds) between
| ManageAsyncPPRC ConsistencyGroup formation. The
| following use requirements apply:
| v Start — Required
| v Resume — Optional
| v Pause — Ignored
| v Terminate — Ignored
| MaxXDCCoordinationTime uint16 Parameter of Maximum time (in milliseconds)
| ManageAsyncPPRC allowed for Leader to coordinate
| Followers to form Consistency Group.
| Default 50 millisec. The following use
| requirements apply:
| v Start — Required
| v Resume — Optional
| v Pause — Ignored
| v Terminate — Ignored
| MaxConsistencyGroupDrain uint16 Parameter of Maximum time (in minutes) allowed to
| ManageAsyncPPRC drain Out-Of-Sync data to B volumes.
| Default 4 minutes. The following use
| requirements apply:
| v Start — Required
| v Resume — Optional
| v Pause — Ignored
| v Terminate — Ignored

226 ESS API Reference

| Table 99. IBMTSESS_AsyncPPRCService (continued)
| Property Type Qualifier or Parameter Description
| Return values — Return values of Description of return values:
| ManageAsyncPPRC
| 0 Success
| 1 Not Supported
| 5 Invalid input parameter
| 0x8010 Cannot retrieve internal
| Service
| 0x8012 Cannot connect to internal
| Services
| 0x8013 Cannot retrieve internal
| SessionService
| 0x8015 Cannot create SessionID
| 0x8016 Cannot create NILSSID for
| MasterLSS
| 0x8017 Cannot create NILSSID for
| Master/Subordinate
| 0x8030 Exception in executing
| ManageAsyncPPRC
| 0x8080 Internal returned NULL in
| ManageAsyncPPRC
| 0x9000 and above are internal return
| values
| QueryXDCIncrementStatus uint32 Method Retrieves information about Extended
| Distance Consistency’s Consistency
| Group and FlashCopy status. The
| scope can be either one ESS or one
| LSS.
| SessionNumber uint16 Parameter of Session number in decimal (1-255)
| QueryXDCIncrement
| Status
| SessionType string Parameter of Session type in hexadecimal, for
| QueryXDCIncrement example, 0x40 for XDC session, 0x30
| Status for Flash Copy session, 0x20 for
| PPRC session, 0x10 for XRC session
| Scope string Parameter of LSSID of format ESSID:LSSID:SSID
| QueryXDCIncrement where ESSID is of format like
| Status 2105.FA120 and LSSID is a 1 or 2
| byte hexadecial LSS number and
| SSID is a 1 or 2 byte hexadecimal
| SSID (empty string if undefined)
|| Option uint16 Parameter of v 0 for whole ESS (the Scope
|| QueryXDCIncrement parameter can use an existing
|| Status LSS for the ESS)
| v 1 for background FlashCopy query
| v 2 for consistency group query
| v 3 for out-of-sync bit map query

Appendix C. CIM Agent class information for the ESS API 227
| Table 99. IBMTSESS_AsyncPPRCService (continued)
| Property Type Qualifier or Parameter Description
| Result uint32 Output Parameter of Result of format specified in ESS
| QueryXDCIncrement Attachment Specification, DSO
| Status command, suborder x4A, each Uint32
| represents 4 bytes of data
| Return values — Return values of Description of return values:
| QueryXDCIncrement
|| Status
0 Success
| 1 Not Supported
| 5 Invalid input parameter
| 0x8010 Cannot retrieve NI Service
| 0x8011 Cannot connect to NI
| 0x8013 Cannot get NI
| AsyncPPRCService
| 0x8015 Cannot create SessionID
| 0x8016 Cannot create
| NIESSID/NILSSID for Scope
| parameter
| 0x8024 Invalid option
| 0x8025 Invalid combination of options
| 0x8030 Exception in executing
| queryXDCIncrementStatus
| 0x8080 Internal returned NULL in
| ManageSessionVolume
| 0x9000 and above are internal return
| values
| QueryXDCOutOfSyncStatus uint32 Method Retrieves information about Extended
| Distance Consistency’s Out-of-Sync
| Tracks. The scope can be either one
| ESS or one LSS.
| SessionNumber uint16 Parameter of Session number in decimal (1-255)
| QueryXDCOutOfSync
| Status
| SessionType string Parameter of Session type in hexadecimal, for
| QueryXDCOutOfSync example, 0x40 for XDC session, 0x30
| Status for FlashCopy session, 0x20 for PPRC
| session, 0x10 for XRC session
| Scope string Parameter of LSSID of format ESSID:LSSID:SSID
| QueryXDCOutOfSync where ESSID is of format like
| Status 2105.FA120 and LSSID is a 1 or 2
| byte hexadecial LSS number and
| SSID is a 1 or 2 byte hexadecimal
| SSID (empty string if undefined)
| Option uint16 Parameter of 0 for whole ESS (the Scope parameter
| QueryXDCOutOfSync can use any existing LSS for the ESS)
| Status

228 ESS API Reference

| Table 99. IBMTSESS_AsyncPPRCService (continued)
| Property Type Qualifier or Parameter Description
| Result uint32 Output Parameter of Result of format specified in ESS
| QueryXDCOutOfSync Attachment Specification, DSO
| Status command, suborder x4B, each uint32
| represents 4 bytes of data.
| Return values — Return values of Description of return values:
| QueryXDCOutOfSync
|| Status
0 Success
| 1 Not Supported
| 5 Invalid input parameter
| 0x8010 Cannot retrieve NI Service
| 0x8011 Cannot connect to NI
| 0x8013 Cannot get NI
| AsyncPPRCService
| 0x8015 Cannot create SessionID
| 0x8016 Cannot create
| NIESSID/NILSSID for Scope
| parameter
| 0x8024 Invalid option
| 0x8025 Invalid combination of options
| 0x8030 Exception in executing
| QueryXDCOutOfSyncStatus
| 0x8080 Internal returned NULL in
| QueryXDCOutOfSyncStatus
| 0x9000 and above are internal return
| values
| QueryXDCSessionsAndDevices uint32 Method Retrieves information about Extended
| Distance Consistency’s sessions and
| volumes. The scope is always for a
| given LSS.
| SessionNumber uint16 Parameter of Session number in decimal (1-255)
| QueryXDCSessionsAnd
| Devices
| SessionType string Parameter of Session type in hexadecimal, for
| QueryXDCSessionsAnd example, 0x40 for XDC session, 0x30
| Devices for FlashCopy session, 0x20 for PPRC
| session, 0x10 for XRC session
| Scope string Parameter of LSSID of format ESSID:LSSID:SSID
| QueryXDCSessionsAnd where ESSID is of format like
| Devices 2105.FA120 and LSSID is a 1 or 2
| byte hexadecial LSS number and
| SSID is a 1 or 2 byte hexadecimal
| SSID (empty string if undefined)
| Result uint32 Parameter Output of Result of the format specified in ESS
| QueryXDCSessionsAnd Attachment Specification, DSO
| Devices command, suborder x4C, each uint32
| represents 4 bytes of data

Appendix C. CIM Agent class information for the ESS API 229
| Table 99. IBMTSESS_AsyncPPRCService (continued)
| Property Type Qualifier or Parameter Description
| Return values — Return values of Description of return values:
| QueryXDCSessionsAnd
|| Devices
0 Success
| 1 Not Supported
| 5 Invalid input parameter
| 0x8010 Cannot retrieve NI Service
| 0x8011 Cannot connect to NI
| Services
| 0x8013 Cannot get NI
| AsyncPPRCService
| 0x8016 Cannot create
| NIESSID/NILSSID for Scope
| parameter
| 0x8030 Exception in executing
| QueryXDCSessionsAnd
| Devices
| 0x8080 Internal returned NULL in
| QueryXDCSessionsAnd
| Devices
| 0x9000 and above are internal return
| values
| QueryAsyncPPRCStatus uint32 Method Retrieves information about
| Asynchronous PPRC. The scope is for
| one whole ESS.
| SessionNumber uint16 Parameter of Session number in decimal (1-255)
| QueryAsyncPPRCStatus
| SessionType string Parameter of Session type in hexadecimal, for
| QueryAsyncPPRCStatus example, 0x40 for XDC session, 0x30
| for FlashCopy session, 0x20 for PPRC
| session, 0x10 for XRC session
| Scope string Parameter of LSSID of format ESSID:LSSID:SSID
| QueryAsyncPPRCStatus where ESSID is of format like
| 2105.FA120 and LSSID is a 1 or 2
| byte hexadecial LSS number and
| SSID is a 1 or 2 byte hexadecimal
| SSID (empty string if undefined). Any
| existing LSS of the ESS can be used.
| Result uint32 Parameter Output of Result of the format specified in ESS
| QueryAsyncPPRCStatus Attachment Specification, DSO
| command, suborder x51, each uint32
| represents 4 bytes of data

230 ESS API Reference

| Table 99. IBMTSESS_AsyncPPRCService (continued)
| Property Type Qualifier or Parameter Description
| Return values — Return values of Description of return values:
| QueryAsyncPPRCStatus
| 0 Success
| 1 Not Supported
| 5 Invalid input parameter
| 0x8010 Cannot retrieve NI Service
| 0x8011 Cannot connect to NI
| Services
| 0x8013 Cannot get NI
| AsyncPPRCService
| 0x8016 Cannot create
| NIESSID/NILSSID for Scope
| parameter
| 0x8030 Exception in executing
| QueryAsyncPPRCStatus
| 0x8080 Internal returned NULL in
| QueryAsyncPPRCStatus
| 0x9000 and above are internal return
| values
|
Related topics:
v “ESS class definition schemas”
v “CIM Agent communication concepts” on page 125
v Appendix A, “ESS API component definitions,” on page 123
v “CIM Agent Communication methods” on page 126
v “Error codes returned by the CIMOM” on page 137

ESS class definition schemas

This section illustrates the architecture for the CIM Agent. Individual functional views
show the components that are used for a specific function.

Individual functional schemas:

The specific functionality provided by the CIMOM permits configuration, discovery of

subsystems and devices (LUNs), LUN creation, LUN deletion, LUN masking and
LUN unmasking. Each of the following diagrams shows the class definitions that
apply to these functions. Figure 6 on page 232 shows the classes and their related
associations that represent the physical package to the ESS.

Appendix C. CIM Agent class information for the ESS API 231
Physical Package Instance Diagram

IBMTSESS_Product

+Name(Key): String
+IdentifyingNumber(Key): String
+Vendor: String
+Version: String

IBMTSESS_ProductPhysicalComponent

IBMTSESS_Chassis

+Tag(Key): String
+CreationClassName(Key): String
IBMTSESS_StorageSystem
+CreationClassName(Key): String
+Name(Key): String
+OtherIdentifyingInfo: Vector
IBMTSESS_ComputerSystemPackage +IdentifyingDescription: Vector
+model: String
+codeLevel: String
+cache: String
+nvs: String
+Dedicated: Vector

Figure 6. Physical package instance diagram

Figure 7 on page 233 shows the classes and their related associations that
represent the storage classes to the ESS.

232 ESS API Reference

Array Profile Instance Diagram

IBMTSESS_FcPort
IBMTSESS_SystemDevice

IBMTSESS_StorageSystem IBMTSESS_ProtocolController
IBMTSESS_SystemDevice

IBMTSESS_SystemDevice IBMTSESS_Volume

IBMTSESS_HostedStoragePool IBMTSESS_ElementSettingData

IBMTSESS_AllocatedFromStoragePool

IBMTSESS_StorageSetting
IBMTSESS_VolumeSpace

IBMTSESS_ElementCapabilities

IBMTSESS_StorageCapabilities

Figure 7. Array profile instance diagram

Figure 8 on page 234 shows the classes and their related associations that
represent the access, addressing information, or both, for a remote connection to
the ESS.

Appendix C. CIM Agent class information for the ESS API 233
Access Point Subprofile Instance Diagram

IBMTSESS_RemoteServiceAccessPoint

+SystemCreationClassName(Key): String
+SystemName(Key): String
+CreationClassName(Key): String
+Name(Key): String

IBMTSESS_HostedAccessPoint

IBMTSESS_StorageSystem
+CreationClassName(Key): String
+Name(Key): String
+OtherIdentifyingInfo: Vector
+IdentifyingDescription: Vector
+model: String
+codeLevel: String
+cache: String
+nvs: String
+Dedicated: Vector

Figure 8. Access point subprofile instance diagram

Figure 9 shows the classes and their related associations that represent the
aggregate elements to the ESS.

Extra Capacity Set Subprofile Instance Diagram

IBMTSESS_ExtraCapacitySet

+InstanceID(Key): String

IBMTSESS_StorageSystem IBMTSESS_ConcreteIdentityCapSet
+CreationClassName(Key): String
+Name(Key): String
+OtherIdentifyingInfo: Vector
+IdentifyingDescription: Vector
IBMTSESS_MemberOfCollection
+model: String
+codeLevel: String
+cache: String
+nvs: String
+Dedicated: Vector

Figure 9. Extra capacity set subprofile instance diagram

Figure 10 on page 235 shows the classes and their related associations that
represent the location of the disk group to the ESS.

234 ESS API Reference

Location Subprofile Instance Diagram

IBMTSESS_PhysicalPackage

IBMTSESS_PhysicalElementLocation

IBMTSESS_Location

Figure 10. Location subprofile instance diagram

Figure 11 shows the classes and their related associations that represent the
service control on the copy relationships to the ESS.

Copy Services Subprofile Instance Diagram

IBMTSESS_StorageSystem

IBMTSESS_HostedService IBMTSESS_StorageConfigurationService

+AttachReplica( )
+ModifySynchronization( )

IBMTSESS_StorageVolume IBMTSESS_StorageVolume
IBMTSESS_StorageSynchronized

Figure 11. Copy services subprofile instance diagram

Figure 12 on page 236 shows the classes and their related associations that
represent the pool manipulation to the ESS.

Appendix C. CIM Agent class information for the ESS API 235
Pool Manipulation, Capacity and Settings Subprofile Instance Diagram

IBMTSESS_StorageCapabilities IBMTSESS_StorageSetting

IBMTSESS_ElementCapabilities IBMTSESS_ElementSetting

IBMTSESS_StorageSystem IBMTSESS_VolumeSpace IBMTSESS_Volume

+CreationClassName(Key): String +SystemCreationClassName(Key): String
+InstanceID(Key): String
+Name(Key): String +SystemName(Key): String
+Redundancy: String
+OtherIdentifyingInfo: Vector +CreationClassName(Key): String
+cap: int
+IdentifyingDescription: Vector +DeviceID(Key): String
+free: int
+model: String +OtherIdentifyingInfo: Vector
+basedon: String
+codeLevel: String +Controlled: Boolean
+volumes: int
+cache: String
+lss: String
+nvs: String
+Status: String
+Dedicated: Vector
+SystemName: String
+GetSupportedSizes( )
+GetSupportedSizeRange( )

IBMTSESS_HostedStoragePool IBMTSESS_AllocatedFromStoragePool

IBMTSESS_StorageSystemToVolume

IBMTSESS_StorageConfigurationService
IBMTSESS_HostedService +CreateorModifyStoragePool( )
+DeleteStoragePool( )

Figure 12. Pool manipulation, capacity, and settings subprofile instance diagram

Figure 13 on page 237 shows the classes and their related associations that
represent the LUN Creation to the ESS.

236 ESS API Reference

LUN Creation Subprofile Instance Diagram

IBMTSESS_StorageCapabilities IBMTSESS_StorageSetting

IBMTSESS_ElementCapabilities IBMTSESS_ElementSetting

IBMTSESS_StorageSystem IBMTSESS_VolumeSpace IBMTSESS_Volume

+CreationClassName(Key): String +SystemCreationClassName(Key): String

+InstanceID(Key): String
+Name(Key): String +SystemName(Key): String
+Redundancy: String
+OtherIdentifyingInfo: Vector +CreationClassName(Key): String
+cap: int
+IdentifyingDescription: Vector +DeviceID(Key): String
+free: int
+model: String +OtherIdentifyingInfo: Vector
+basedon: String
+codeLevel: String +Controlled: Boolean
+volumes: int
+cache: String
+lss: String
+nvs: String
+Status: String
+Dedicated: Vector
+SystemName: String
+GetSupportedSizes( )
+GetSupportedSizeRange( )

IBMTSESS_HostedStoragePool IBMTSESS_AllocatedFromStoragePool

IBMTSESS_StorageSystemToVolume

IBMTSESS_StorageConfigurationService
IBMTSESS_HostedService +CreateorModifyElementFrom
+StoragePool( )

Figure 13. LUN creation subprofile instance diagram

Figure 14 on page 238 shows the classes and their related associations that
represent the LUN Connectivity to the ESS.

Appendix C. CIM Agent class information for the ESS API 237
LUN Mapping and Masking Subprofile Instance Diagram

IBMTSESS_HostedService

IBMTSESS_Storage HardwareID IBMTSESS_StorageHardwareIDManagementService

IBMTSESS_ConcreteDependency

IBMTSESS_PrivledgeManagementService

IBMTSESS_AuthorizedSubject

IBMTSESS_Privledge
IBMTSESS_AuthorizedTarget

IBMTSESS_ProtocolContollerFanPort IBMTSESS_AuthorizedTarget IBMTSESS_ProtocolContollerFanVent

IBMTSESS_FcPort IBMTSESS_ProtocolContoller IBMTSESS_Volume

IBMTSESS_StorageClientSetting

IBMTSESS_ElementSettingData

IBMTSESS_Controller
IBMTSESS_StorageSystem ConfigurationService
IBMTSESS_HostedService

IBMTSESS_ElementCapabilities

IBMTSESS_ProtocolContollerMaskingCapabilities

IBMTSESS_HostedService

Figure 14. LUN mapping and masking subprofile instance diagram

Figure 15 on page 239 shows the classes and their related associations that
represent the VolumeSpace specific statistics to the ESS.

238 ESS API Reference

Performance Extension

IBMTSESS_PerformanceServices
IBMTSESS_StorageSystem
IBMTSESS_HostedService +StartStatisticsCollection( )
+StopStatisticsCollection( )

Figure 15. Performance extension

Figure 16 shows the classes and their related associations that represent the
physical disk drive to the ESS.

Disk drive Subprofile Instance Diagram

IBMTSESS_Volume IBMTSESS_StorageSystem
+SystemCreationClassName(Key): String +CreationClassName(Key): String
+SystemName(Key): String +Name(Key): String
+CreationClassName(Key): String
+DeviceID(Key): String

IBMTSESS_MediaPresent IBMTSESS_SystemDevice

IBMTSESS_DiskDrive
+SystemCreationClassName(Key): String
+SystemName(Key): String
+CreationClassName(Key): String
+DeviceID(Key): String

IBMTSESS_Realizes

IBMTSESS_PhysicalPackage

+Tag(Key): String
+CreationClassName(Key): String

Figure 16. Disk drive subprofile instance diagram

Related topics:
v “ESS API class definitions” on page 147
v “CIM Agent communication concepts” on page 125
v Appendix A, “ESS API component definitions,” on page 123
v “CIM Agent Communication methods” on page 126
v “Error codes returned by the CIMOM” on page 137

Appendix C. CIM Agent class information for the ESS API 239
240 ESS API Reference
Appendix D. ESS API support for Microsoft Volume Shadow
Copy Service for Windows
This chapter includes an overview of ESS API support for Microsoft Volume
Shadow Copy Service along with an overview of the installation process, and
instructions for installing and reconfiguring Microsoft Volume Shadow Copy Service
on a Windows Server 2003 operating system. Instructions for uninstalling Microsoft
Volume Shadow Copy Service are also provided.

ESS API Support for Microsoft’s Volume Shadow Copy Service

Overview
Note: See the IBM TotalStorage ESS Interoperability Web site for the availability of
Microsoft Volume Shadow Copy Service.

http://www.ibm.com/storage/hardsoft/products/ess/supserver.htm

The ESS API support for Microsoft Volume Shadow Copy Service enables users to
quickly back up and restore large amounts of data on Windows Server 2003.
Microsoft Volume Shadow Copy Service coordinates with a provider and the
Enterprise Storage Server (ESS) to create a consistent shadow copy of a volume or
group of volumes at a point-in-time. Point-in-time shadow copies ensure
consistency for Microsoft Volume Shadow Copy Service-aware writers, and also
works with applications that do not support Microsoft Volume Shadow Copy Service
technology. The shadow copy can be created while the volume is mounted and files
are in use.

In order to accomplish this fast backup, a backup application initiates a shadow

copy backup. Microsoft Volume Shadow Copy Service then coordinates with the
Microsoft Volume Shadow Copy Service writers to briefly hold writes on the
databases, applications, or both. Next, Microsoft Volume Shadow Copy Service
flushes the file system buffers and asks a provider to initiate a FlashCopy of the
data. Once the FlashCopy is logically complete, Microsoft Volume Shadow Copy
Service allows writes to resume and notifies the requestor that the backup has
completed successfully. Currently, there are only requestors available to support
snapshots of basic disks.

The volumes are then mounted hidden and read-only, to be used when rapid
restore is necessary. Alternatively, the volumes can be mounted on a different host
and used for application testing or backup to tape.

You must install the IBM TotalStorage Common Information Model Agent (CIM
Agent), a middleware application that provides a CIM-compliant interface, before
installing Microsoft Volume Shadow Copy Service. The Microsoft Volume Shadow
Copy Service uses the CIM technology to manage proprietary devices as open
system devices through storage management applications.

Microsoft Volume Shadow Copy Service is supported on ESS Fxx and 800 models,
version 2.3.x.x, or later.

© Copyright IBM Corp. 2004 241

ESS API support for Microsoft Volume Shadow Copy Service
installation overview
This section provides an overview of the installation and configuration of Microsoft
Volume Shadow Copy Service on a Windows Server 2003 operating system. You
should have some knowledge of how to administer a Windows Server 2003
operating system before you install Microsoft Volume Shadow Copy Service. You
should also become familiar with the installation tasks and gather all of the
information you will need for installation ahead of time.

The following installation tasks are presented in the order in which they should be
performed:
1. Before you install Microsoft Volume Shadow Copy Service for Windows, check
the hardware and software requirements listed in “ESS API support for Microsoft
Volume Shadow Copy Service installation requirements.”
2. Install the prerequisite ESS CIM Agent software, as instructed in Chapter 4,
“ESS CIM Agent for Windows,” on page 59.
3. Run the InstallShield Wizard for Microsoft Volume Shadow Copy Service by
performing the instructions in “Installing ESS API support for Microsoft Volume
Shadow Copy Service on Windows” on page 243.
4. Verify the installation by performing the instructions in “Verifying ESS API
support for Microsoft Volume Shadow Copy Service Windows installation” on
page 252.
5. Create Free and Reserved Volume Pools in “Creating the VSS_FREE and
VSS_RESERVED pools” on page 252.
6. Reconfigure Microsoft Volume Shadow Copy Service by using the commands in
“ESS API support for Microsoft Volume Shadow Copy Service reconfiguration
commands” on page 253. Perform this optional task if you would like to change
the configuration that you established during installation.

ESS API support for Microsoft Volume Shadow Copy Service

installation requirements
Ensure that your system satisfies the following prerequisites for installing Microsoft
Volume Shadow Copy Service on a Windows Server 2003 operating system before
you start the installation.

You must install the ESS CIM Agent before you install Microsoft Volume Shadow
Copy Service. You can locate the CIM Agent on the same machine as Microsoft
Volume Shadow Copy Service or on a different machine.

Attention:Before you start the installation of the ESS CIM Agent, all prerequisite
software must be installed. The ESS CIM Agent installation program will check for
the existence of the ESS CLI. If the program does not detect the ESS CLI, the
installation of the ESS CIM Agent will not complete successfully.

Hardware
The following hardware is required:
v ESS Models 800 and Fxx, version 2.3.x.x or higher with FlashCopy Version 1 or
FlashCopy Version 2

242 ESS API Reference

 Note: If you are using Fxx models, at least one of the of the ESSs in the
environment must be a model 800. Do not attach more than one ESS to
your Microsoft Volume Shadow Copy Service machine.
v Systems capable of running Windows Server 2003. The following editions of
Windows Server 2003 are supported:
– Standard Edition
– Enterprise Edition, 32-bit version
– Datacenter Edition, 32-bit version
For details about system requirements, see
http://www.microsoft.com/windowsserver2003/evaluation/sysreqs/default.mspx
v Supported QLogic or Emulex Fibre Channel Host Bus Adapter (HBA) with
support for the SNIA HBA Application Programming Interface.

Note: You must define all host machine HBAs on the ESS Specialist. If you do
not, ESS API support for Microsoft Volume Shadow Copy Service might
fail upon shadow volume location or import.

Software
The following software is required:
v Windows Server 2003 operating system. The following editions of Windows
Server 2003 are supported:
– Standard Edition
– Enterprise Edition, 32-bit version
– Datacenter Edition, 32-bit version
v Common Information Model (CIM) Agent. The CIM Agent can be located on the
same machine as Microsoft Volume Shadow Copy Service or a different
machine. You can find this software on the IBM TotalStorage Enterprise Storage
Server (ESS) Application Programming Interface CD1- IBM TotalStorage CIM
Agent for ESS CD.
v Microsoft Volume Shadow Copy Service compliant backup software

Installing ESS API support for Microsoft Volume Shadow Copy Service
on Windows
This section includes the steps to install ESS API support for Microsoft Volume
Shadow Copy Service in your Windows system. You must satisfy all prerequisites
that are listed in “Installing the ESS CIM Agent on Windows in unattended (silent)
mode” on page 69 before you start the installation.

Steps:

Perform the following steps to install Microsoft Volume Shadow Copy Service:
1. Log on to your system as the local administrator.
2. Run the InstallShield Wizard by inserting the IBM TotalStorage Enterprise
Storage Server (ESS) Application Programming Interface - Microsoft Volume
Shadow Copy Service CD into the CD-ROM drive
3. Click Next to continue with the InstallShield Wizard.

Appendix D. ESS API support for Microsoft Volume Shadow Copy Service for Windows 243
 4. The License Agreement window opens. Select whether you accept the terms
of the license agreement and click Next. If you do not accept, you cannot
continue with the installation.

5. The Choose Destination Location Window opens. If you do not want to choose
the default destination location where setup will install the files, click Change.

244 ESS API Reference

Otherwise, click Next to choose the default destination location where the
setup will install the files.

If you clicked on Change, the Choose Folder window opens. Choose a

destination location where you want the setup to install the files and click OK.
Click Next in the Choose Destination Location Window.

Appendix D. ESS API support for Microsoft Volume Shadow Copy Service for Windows 245
 6. The Ready to Install the Program window opens. Click Install to begin the
installation. To cancel the install setup, click Cancel.

The Setup Status window opens. Click Cancel if you want to stop the setup.

7. The Edit Data window opens. In order to connect to Installation and

Configuration Automation Tool (ICAT), Microsoft Volume Shadow Copy Service

246 ESS API Reference

 must know some information about the server that ICAT is installed on. Type
the required ICAT 1.2 port, host, and user information and click Next.
Notes:
a. If these settings change after installation, you can use the
ibmvssconfig.exe tool to update Microsoft Volume Shadow Copy Service
with the new settings.
b. If you do not have the ICAT 1.2 port, host, or user information, contact your
ICAT administrator.

8. The Password window opens. Enter your ICAT 1.2 password and click Next.

Appendix D. ESS API support for Microsoft Volume Shadow Copy Service for Windows 247
 9. The Setup Type window opens. Select whether you want to use Secure
Sockets Layer (SSL) to connect to ICAT 1.2 and click Next.
Notes:
a. You can set the SSL using the ibmvssconfig.exe configuration tool.
b. If you are not sure whether to use SSL to connect to ICAT 1.2, contact
your ICAT administrator.

248 ESS API Reference

10. The Edit Data window opens. Type the location of the ICAT truststore file. This
truststore is generated during ICAT installation. You must copy this file to a
location accessible by Microsoft Volume Shadow Copy Service. Then type the
truststore password and click Next

Note: The default ICAT truststore password is “ibmstore”. If the ICAT

truststore password has been changed from the default and you do not
have this information, contact your ICAT administrator. You can change
the ICAT truststore password using the ibmvssconfig.exe configuration
tool.
.

Appendix D. ESS API support for Microsoft Volume Shadow Copy Service for Windows 249
 11. The Edit Data window opens. Type the ESS serial number and click Next.

12. The Setup Type window opens. Select the version of FlashCopy that is
installed on your machine and click Next.

250 ESS API Reference

 Note: This information can be found on the License Internal Code panel in the
ESS Specialist.

13. The InstallShield Wizard Complete window opens. Click Finish. The
InstallShield Wizard is complete.

14. The installation program might prompt you to reboot your system.

Appendix D. ESS API support for Microsoft Volume Shadow Copy Service for Windows 251
 Result:

If you are able to perform all of the installation tasks successfully, Microsoft Volume
Shadow Copy Service has been successfully installed on your Windows system.

Verifying ESS API support for Microsoft Volume Shadow Copy Service
Windows installation
This task verifies that Microsoft Volume Shadow Copy Service is installed correctly
on your Windows system.

Steps:

Perform the following steps to verify your Microsoft Volume Shadow Copy Service
installation:
1. Select Start -> All Programs -> Administrative Tools -> Services
2. Ensure that there is a service named IBM TotalStorage ESS Hardware Provider
for VSS (Short name: IBMVSS) and that the Status is Started and the Startup
Type is Automatic.

3. Open a command prompt window and type the following command to verify that
Microsoft Volume Shadow Copy Service is installed:

vssadmin list providers

If Microsoft Volume Shadow Copy Service is installed, IBMVssProv is listed as a
provider.

Result:

If you are able to perform all of the verification tasks successfully, Microsoft Volume
Shadow Copy Service has been successfully installed on your Windows system.

Creating the VSS_FREE and VSS_RESERVED pools

This task allows you to create the VSS_FREE and VSS_RESERVED pools.

252 ESS API Reference

 A provider uses a pre-defined ″free pool″ of volumes as potential FlashCopy
targets. Once the volumes are in use, Microsoft Volume Shadow Copy Service
places these volumes in the ″reserved pool.″ These pools can be created using
either the ESS Specialist or the ESS CLI.

Steps:

Perform the following steps using the IBM TotalStorage ESS Specialist to create the
VSS_FREE and VSS_RESERVED pools:
1. Create a virtual host on the ESS named ″VSS_FREE″, of type Microsoft
Windows, attached by Fibre Channel with a WWPN of 5000000000000000.
2. Create a virtual host on the ESS named ″VSS_RESERVED″, of type Microsoft
Windows, attached by Fibre Channel with a WWPN of 5000000000000001.
3. Create and assign free volumes to VSS_FREE.

Note: If you already have volumes created for VSS_FREE, you must assign
those volumes to VSS FREE.

Verifying ESS API support for Microsoft Volume Shadow Copy Service
Windows configuration
This task verifies that Microsoft Volume Shadow Copy Service is configured
correctly on your Windows system.

Steps:

After you have installed Microsoft Volume Shadow Copy Service and created the
VSS_FREE and VSS_RESERVED pools, perform the following steps to verify your
configuration:
1. Issue the following command:

ibmvssconfig listvols

All of the volumes on your ESS should be listed with the WWPNs they are
assigned to.
2. If the volumes are not listed, check the connectivity of your ESS CIM Agent.
Then, check your ESS API support for Microsoft Volume Shadow Copy Service
configuration. You can reconfigure using the commands that are listed in the
next section. The ESSService.log provides more detailed information on which
setting is incorrect. ESS API support for Microsoft Volume Shadow Copy
Service will not work if this command does not succeed.

Result:

If you are able to perform all of the verification tasks successfully, Microsoft Volume
Shadow Copy Service has been successfully configured on your Windows system.

ESS API support for Microsoft Volume Shadow Copy Service

reconfiguration commands
This section introduces the ESS VSS Provider reconfiguration commands and
provides examples of how to use the commands.

Commands:

Appendix D. ESS API support for Microsoft Volume Shadow Copy Service for Windows 253
 After installation, you can use several commands on the ibmvssconfig.exe tool to
change or correct parameters that you used to install the Microsoft Volume Shadow
Copy Service. To do this, you must use the utility ibmvssconfig.exe. You do not
have to set many of the settings because there are defaults provided for them in
Microsoft Volume Shadow Copy Service. Table 100 shows the commands you can
use for reconfiguration.

Note: If you do not know which settings to provide (for example, passwords or user
names) for the following commands, contact your system administrator.
Table 100. Microsoft Volume Shadow Copy Service reconfiguration commands
Command Description Example
ibmvssconfig Provides the current
showcfg settings.
ibmvssconfig listvols Lists the volumes ibmvssconfig listvols
that are currently in
ibmvssconfig listvols free
the freepool,
unassigned, or all ibmvssconfig listvols unassigned
volumes. By default, ibmvssconfig listvols all
without any
additional
parameters, this
command will list all
of the volumes.
ibmvssconfig listvols Lists the volumes ibmvssconfig listvols free
free that are currently in
the freepool,
volumes that are
unassigned, or both.
ibmvssconfig listvols Lists the volumes ibmvssconfig listvols unassigned
unassigned that are currently in
the freepool,
volumes that are
unassigned, or both.
ibmvssconfig add Adds a volume or ibmvssconfig add 12312345 32112345
volumes to the
freepool.
ibmvssconfig rem Removes a volume ibmvssconfig rem 512
or volumes from the
ibmvssconfig rem 51212345
freepool.
ibmvssconfig set Changes the ESS ibmvssconfig set targetESS 12345
targetESS <5-digit identification number,
ESS Id> usually seen in the
form of 2105.xxxxx.
Obtain this number
by telnetting to your
ESS.
ibmvssconfig set Sets the CIMOM ibmvssconfig set username johnny
username <CIMOM user name.
username>
ibmvssconfig set Sets the CIMOM ibmvssconfig set password mypassword
password <CIMOM user password.
password>

254 ESS API Reference

Table 100. Microsoft Volume Shadow Copy Service reconfiguration commands (continued)
Command Description Example
ibmvssconfig set Sets the CIMOM ibmvssconfig set trustpassword trustme
trustpassword trust password.
<trustpassword>
ibmvssconfig set Specifies the ibmvssconfig set truststore c:\truststore
truststore truststore file
<truststore location> location.
ibmvssconfig set Specifies whether to ibmvssconfig set usingSSL yes
usingSSL use Secure Socket
Layers to connect to
the CIMOM.
ibmvssconfig set Specifies the WWPN ibmvssconfig set vssFreeInitiator
vssFreeInitiator that designates the 5000000000000000
<WWPN> freepool. The default
value is
5000000000000000.
Modify this value
only if there is a host
already in your
environment with a
WWPN of
5000000000000000.
ibmvssconfig set Specifies the WWPN ibmvssconfig set vssFreeInitiator
vssReservedInitiator that designates the 5000000000000001
<WWPN> reservedpool. The
default value is
5000000000000001.
Modify this value
only if there is a host
already in your
environment with a
WWPN of
5000000000000001.
ibmvssconfig set Sets the FlaschCopy ibmvssconfig set FlashCopyVer 1
FlashCopyVer <1 | version available on
2> the ESS. The default
value is 1.
ibmvssconfig set Specifies the CIMOM ibmvssconfig set cimomPort 5989
cimomPort port number. The
<PORTNUM> default value is 5989.
ibmvssconfig set Sets the name of the ibmvssconfig set cimomHost icatserver
cimomHost <server ICAT server.
name>
ibmvssconfig set Specifies the ibmvssconfig set namespace \root\ibm
namespace namespace value
<Namespace> that CIMOM is using.
The default value is
\root\ibm.

Appendix D. ESS API support for Microsoft Volume Shadow Copy Service for Windows 255
Error codes returned by Microsoft Volume Shadow Copy Service
This section identifies the possible error codes that are returned by Microsoft
Volume Shadow Copy Service.

Return Error Codes:

Table 3 lists Microsoft Volume Shadow Copy Service error codes.

Note: These errors are logged in the Windows Event Monitor and in the Microsoft
Volume Shadow Copy Service log file located in the installation directory.
Table 101. Return error codes for Microsoft Volume Shadow Copy Service
Symbolic Name Code Definition
ERR_JVM 1000 JVM Creation failed.
ERR_CLASS_NOT_FOUND 1001 Class not found: %1.
ERR_MISSING_PARAMS 1002 Some required
parameters are missing.
ERR_METHOD_NOT_FOUND 1003 Method not found: %1.
ERR_REQUIRED_PARAM 1004 A missing parameter is
required. Use the
configuration utility to set
this parameter: %1.
ERR_RECOVERY_FILE_CREATION_FAILED 1600 The recovery file could
not be created.
ERR_ARELUNSSUPPORTED_IBMGETLUNINFO 1700 ibmGetLunInfo failed in
AreLunsSupported.
ERR_FILLLUNINFO_IBMGETLUNINFO 1800 ibmGetLunInfo failed in
FillLunInfo.
ERR_GET_TGT_CLEANUP 1900 Failed to delete the
following temp files: %1
ERR_LOG_SETUP 2500 Error initializing log.
ERR_CLEANUP_LOCATE 2501 Unable to search for
incomplete Shadow
Copies. Windows Error:
%1.
ERR_CLEANUP_READ 2502 Unable to read
incomplete Shadow
Copy Set information
from file: %1.
ERR_CLEANUP_SNAPSHOT 2503 Unable to cleanup
snapshot stored in file:
%1.
ERR_CLEANUP_FAILED 2504 Cleanup call failed with
error: %1.
ERR_CLEANUP_OPEN 2505 Unable to open file: %1.
ERR_CLEANUP_CREATE 2506 Unable to create file:
%1.
ERR_HBAAPI_LOAD 2507 HBA: Error loading hba
library: %1.

256 ESS API Reference

 Table 101. Return error codes for Microsoft Volume Shadow Copy Service (continued)
Symbolic Name Code Definition
ERR_ESSSERVICE_EXCEPTION 3000 ESSService: An
exception occurred.
Check the ESSService
log.
ERR_ESSSERVICE_LOGGING 3001 ESSService: Unable to
initialize logging.
ERR_ESSSERVICE_CONNECT 3002 ESSService: Unable to
connect to the ICAT.
Check your
configuration.
ERR_ESSSERVICE_SCS 3003 ESSService: Unable to
get the Storage
Configuration Service.
Check your
configuration.
ERR_ESSSERVICE_INTERNAL 3004 ESSService: An internal
error occurred with the
following information:
%1.
ERR_ESSSERVICE_FREE_CONTROLLER 3005 ESSService: Unable to
find the VSS_FREE
controller.
ERR_ESSSERVICE_RESERVED_CONTROLLER 3006 ESSService: Unable to
find the
VSS_RESERVED
controller. Check your
configuration.
ERR_ESSSERVICE_INSUFFICIENT_TARGETS 3007 Unable to find suitable
targets for all volumes.
ERR_ESSSERVICE_ASSIGN_FAILED 3008 ESSService: The assign
operation failed. Check
the ICAT log for details.
ERR_ESSSERVICE_WITHDRAW_FAILED 3009 ESSService: The
withdraw FlashCopy
operation failed. Check
the ICAT log for details.

Uninstalling ESS API support for Microsoft Volume Shadow Copy

Service on Windows
This section includes the steps to uninstall the ESS API support for Microsoft
Volume Shadow Copy Service in your Windows system.

Steps:

Perform the following steps to uninstall Microsoft Volume Shadow Copy Service:
1. Log on to your system as the local administrator.
2. Click Start -> Control Panel.

Appendix D. ESS API support for Microsoft Volume Shadow Copy Service for Windows 257
 3. The Control Panel window opens. Double-click on Add or Remove Programs
and then select IBM TotalStorage ESS API - Microsoft Volume Shadow Copy
Service. Click Remove to remove the program.
4. Select Yes when asked if you want to completely remove the selected
application and all of it components or click No to go back to the Add or
Remove Programs window.
5. The progress window quickly opens and closes.
6. The Finish window opens. Click Finish. The removal is now complete.

Result:

If you are able to perform all of the uninstallation tasks successfully, Microsoft
Volume Shadow Copy Service has been successfully uninstalled on your Windows
system.

258 ESS API Reference

Appendix E. Accessibility
Accessibility features help a user who has a physical disability, such as restricted
mobility or limited vision, to use software products successfully.

Features
These are the major accessibility features in the IBM TotalStorage Enterprise
Storage Server information:
1. You can use screen-reader software and a digital speech synthesizer to hear
what is displayed on the screen. IBM Home Page Reader version 3.0 has been
tested.
2. You can operate features using the keyboard instead of the mouse.

Navigating by keyboard
You can use keys or key combinations to perform operations and initiate menu
actions that can also be done through mouse actions. You can navigate the IBM
TotalStorage Enterprise Storage Server information from the keyboard by using the
shortcut keys for your browser or Home Page Reader. See your browser Help for a
list of shortcut keys that it supports. See the following Web site for a list of shortcut
keys supported by Home Page Reader:
http://www-306.ibm.com/able/solution_offerings/keyshort.html

Accessing the publications

You can find HTML versions of the IBM TotalStorage Enterprise Storage Server
information at the following Web site:
http://www.ehone.ibm.com/public/applications/publications/cgibin/pbi.cgi

You can access the information using IBM Home Page Reader 3.0.

© Copyright IBM Corp. 2004 259

260 ESS API Reference
Notices
This information was developed for products and services that are offered in the
U.S.A.

IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may be
used instead. However, it is the user’s responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications to cover subject matter that is
described in this document. The furnishing of this document does not give you any
license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106, Japan

The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law:
INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS
PUBLICATION ″AS IS″ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A
PARTICULAR PURPOSE. Some states do not allow disclaimer of express or
implied warranties in certain transactions; therefore, this statement may not apply to
you.

This information could include technical inaccuracies or typographical errors.

Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements and/or
changes in the product(s) and/or the program(s) described in this publication at any
time without notice.

Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those
Web sites. The materials at those Web sites are not part of the materials for this
IBM product and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way it believes
appropriate without incurring any obligation to you.

© Copyright IBM Corp. 2004 261

 Licensees of this program who wish to have information about it for the purpose of
enabling:
(i) the exchange of information between independently created programs and
other programs (including this one) and
(ii) the mutual use of the information which has been exchanged, should
contact:
IBM Corporation
Information Enabling Requests
Dept. DZWA
5600 Cottle Road
San Jose CA 95193-0001
U.S.A.

Such information may be available, subject to appropriate terms and conditions that
include in some cases, payment of a fee.

The licensed program described in this document and all licensed material available
for it are provided by IBM under terms of the IBM Customer Agreement, IBM
International Program License Agreement, or any equivalent agreement between
us.

Information concerning non-IBM products was obtained from the suppliers of those
products, their published announcements or other publicly available sources. IBM
has not tested those products and cannot confirm the accuracy of performance,
compatibility or any other claims related to non-IBM products. Questions on the
capabilities of non-IBM products should be addressed to the suppliers of those
products.

This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.

Trademarks
The following terms are trademarks of the International Business Machines
Corporation in the United States, or other countries, or both:
AIX
Enterprise Storage Server
IBM
TotalStorage

Lotus is a trademark of International Business Machines Corporation and Lotus

Development Corporation in the United States, or other countries, or both.

Pentium is a registered trademark of the Intel Corporation in the United States, or

other countries, or both.

Microsoft, Windows, and Windows 2000 are registered trademarks of Microsoft

Corporation.

Java and all Java-based trademarks and logos are trademarks or registered
trademarks of Sun Microsystems, Inc. in the United States and other countries.

262 ESS API Reference

 Other company, product, and service names may be trademarks or service marks
of others.

Java Compatibility logo

The Java Compatibility logo identifies products that incorporate a Java application
environment (JDK or JRE). These products pass the applicable, JavaSoft defined,
Java Compatibility test suite in order to enable execution of Java or Personal Java
(pJava) applications.

Notices 263
264 ESS API Reference
Glossary
The terms in this glossary are defined as they A
pertain to the Common Information Model for the
IBM TotalStorage Enterprise Storage Server. If you access.
do not find a term you are looking for, you can 1. To obtain the use of a computer resource.
refer to the IBM Dictionary of Computing Terms. A
2. In computer security, a specific type of interaction
link to the Web site for this reference is listed in
between a subject and an object that results in flow
the following paragraph. of information from one to the other.

This glossary might include terms and definitions access control list.
from: 1. In computer security, a collection of all access rights
v The American National Standard Dictionary for for one object.
Information Systems, ANSI X3.172–1990, 2. In computer security, a list associated with an object
copyright 1990 by the American National that identifies all the subjects that can access the
Standards Institute (ANSI), 11 West 42nd object and their access rights; for example, a list
Street, New York, New York 10036. associated with a file that identifies users who can
access the file and identifies their access rights to
v The IBM Glossary of Computing Terms, which that file.
is available online at the following Web site:
http://www.ibm.com/ibm/terminology/. active window. The window a user is currently
v The Information Technology Vocabulary interacting with.
developed by Subcommittee 1, Joint Technical address.
Committee 1, of the International Organization
1. A character or group of characters that identify a
for Standardization and the International
register, a particular part of storage, or some other
Electrotechnical Commission (ISO/IEC data source or destination.
JTC1/SC1).
2. To refer to a device or an item of data by its
address.
This glossary uses the following cross-reference
3. The location, identified by an address code, of a
forms:
specific section of the recording medium or storage.
See Refers the reader to one of two kinds of 4. A name, label, or number identifying a location in
related information: storage, a device in a system or network, or any
v A term that is the expanded form of an other data source.
abbreviation or acronym. This 5. In data communication, the unique code assigned to
expanded form of the term contains the each device or workstation connected to a network.
full definition.
advanced. Usually refers to the performance of
v A synonym or more preferred term functions not understood by the basic user.
See also advanced interactive executive (AIX). An operating
Refers the reader to one or more related system used in the RS/6000 computers. See also AIX
terms. Operating System.
Contrast with AIX. See advanced interactive executive.
Refers the reader to a term that has an
opposite or substantively different AIX Operating System. IBM’s implementation of the
meaning. UNIX operating system. The RISC 6000 computer,
among others, runs on the AIX operating system.
Numerics alert. A message or log that a storage facility
generates as the result of error event collection and
2105. The machine number for the IBM TotalStorage analysis. An alert indicates that you need to perform
Enterprise Storage Server (ESS). some service action.

alphanumeric. Pertaining to data that consist of any

letters between A through Z, and numbers between 0
through 9.

© Copyright IBM Corp. 2004 265

API. See application programming interface. availability. For a storage subsystem, the degree to
which a data set can be accessed when requested by a
American National Standard Code for Information user.
Interchange (ASCII). A coding scheme that is defined
by ANSI X3.4-1977. Programmers use it to represent
various alphabetic, numeric, and special symbols with a B
seven-bit code.
bit. Binary digit. The storage medium that you need to
American National Standards Institute (ANSI). An store a single binary digit.
organization consisting of producers, consumers, and
general interest groups, that establishes the procedures block. A group of consecutive bytes.
by which accredited organizations create and maintain
boot. To load an operating system or start the system.
voluntary industry standards in the United States.
browser. A Web client application for accessing text
ANSI. See American National Standards Institute.
and images. The Web browser uses an HTTP server
application programming interface (API). A software across a TCP/IP communication stream.
interface that enables applications to communicate with
button.
each other. An API is the set of programming language
constructs or statements that can be coded in an 1. A mechanism on a pointing device, such as a
application program to obtain the specific functions and mouse, used to request or initiate an action.
services provided by an underlying operating system or 2. A graphical device that identifies a choice.
service program. . 3. A graphical mechanism in a window that, when
selected, results in action; for example, a list button
applet. A Java program designed to be run within a
produces a list of choices.
client’s browser.
4. A word or picture on the screen that can be
applications. A collection of software components selected. Once selected and activated, a button
used to perform specific types of user oriented work on begins an action in the same manner that pressing
a computer. a key on the keyboard can begin an action.
5. An object that performs an action, e.g., button types
application management. The management of a
include Start, Go, Find, Next, Back, Cancel, Close.
collection of software components used to perform
specific types of user-oriented work on a computer. byte. An aggregation of eight bits. The storage
Application management can improve application medium that you require in order to store eight bits.
availability and performance, increases end-user
satisfaction and productivity, lowers IT costs by
streamlining problem isolation and resolution, and C
creates a tighter fit between IT and the business.
CA. See certification authority.
ASCII. See American National Standard Code for
Information Interchange. CD-ROM. High-capacity read-only memory in the form
of an optically read compact disc.
asset management. The organization and
arrangement of items, such as storage devices, into central processing unit (CPU). The part of a
useful and logical units. computer that includes the circuits that control the
interpretation and execution of instructions. A CPU is
association. A class that contains two references the circuitry and storage that executes instructions.
which define a relationship between two objects. Traditionally, the complete processing unit was often
regarded as the CPU, whereas today the CPU is often
authentication. In secure communications, a means a microchip. In either case, the centrality of a processor
of verifying the identity of a server or browser (client) or processing unit depends on the configuration of the
with whom you wish to communicate. A sender’s system or network in which it is used.
authenticity is demonstrated by the digital certificate that
is issued to the sender. certificate. In electronic commerce, a digital document
that binds an encryption key to the identity of the
authorized personnel. Personnel who are permitted certificate owner, so that the certificate owner can be
or given authority to communicate with or make use of authenticated. A certificate is issued by a certification
an object, resource, or function. authority (CA).
automated. The use of automatic procedures to certification authority (CA). In electronic commerce,
replace or simplify the actions an operator would take in a trusted third party or a designated internal authority
response to system or network events. who issues certificates.

266 ESS API Reference

CIM. See common information model. common information model (CIM). The common
information model (CIM) is an open approach to the
CIM Agent. An agent that interprets open-system data management of systems and networks. The CIM
as it is transferred between the API and a device or a provides a common conceptual framework applicable to
storage server. all areas of information management including systems,
applications, databases, networks, and devices.
CIMOM. See common information model object
manager. common information model object manager
(CIMOM). A common conceptual framework for data
class. The definition of an object within some management. Receives, validates, and authenticates
hierarchy. Classes can have methods and properties client application requests and then directs requests to
and be the target of an association. the appropriate functional component or to a device
provider.
CLI. See command-line interface.
component.
click. To press and release a button on a mouse or
other device without moving the pointer off the item of 1. Hardware or software that is part of a functional unit.
choice. 2. A functional part of an operating system.
3. A set of modules that performs a major function
client. (1) A function that requests services from a
within a system.
server, and makes them available to the user. (2) An
address space in MVS that is using TCP/IP services. (3) 4. The widget, gadget, or other graphical object that
A term used in an environment to identify a machine makes up an interactive user interface.
that uses the resources of the network.
configuration.
client application. A storage management API that 1. The manner in which the hardware and software of
initiates a request to a device or a data storage server an information processing system are organized and
such as an ESS. interconnected.
2. The physical and logical arrangement of devices
client authentication. The verification of a client in
and programs that make up a computing system.
secure communications whereby the identity of a server
or browser (client) with whom you wish to communicate 3. The devices and programs that make up a system,
is ascertained. A sender’s authenticity is demonstrated subsystem, or network.
by the digital certificate issued to the sender.
configuration management. The control of
client-server relationship. Any process that provides information necessary to identify both physical and
resources to other processes on a network is a server. logical information system resources and their
Any process that employs these resources is a client. A relationship to one another.
machine can run client processes and server processes
at the same time. configure. To define the logical and physical
configuration of the input/output (I/O) subsystem through
close. A choice or command that removes a window the user interface provided for this function on the
and all its associated windows from the screen. storage facility.

command. CPU. See central processing unit.

1. A control signal.
2. In a conceptual schema language, the order or D
trigger for an action or permissible action to take
place. daemon . A program that runs unattended to perform
a standard service. Some daemons are triggered
3. Loosely, a mathematical or logical operator.
automatically to perform their task; others operate
4. A statement used to request a function of the periodically.
system.
5. A request from a terminal for the performance of an default. Pertaining to an attribute, condition, value, or
operation or the execution of a particular program. option that is assumed when none is explicitly specified.

command-line interface (CLI). An interface provided Desktop Management Task Force (DMTF. An
by an operating system that defines a set of commands alliance of computer vendors that was convened to
and enables a user (or a script-like language) to issue define streamlined management of the diverse operating
these commands by typing text in response to the systems commonly found in an enterprise.
command prompt (for example, DOS commands or
UNIX shell commands). device.

Glossary 267
1. A mechanical, electrical, or electronic contrivance
with a specific purpose.
E
2. A storage server, such as the ESS, that is the final enable. To make functional.
destination of a client application request, and the
processor of the request. encryption. In secure communications, a means of
3. In the AIX operating system, a valuator, button, or scrambling data to prevent the data from being read by
the keyboard. Buttons have values of 0 or 1 (up or anyone other than the intended recipient. The sender
down); valuators return values in a range, and the uses a key to encrypt the message. The recipient uses
keyboard returns ASCII values. the decryption key.

device adapter (DA). A physical subunit of a storage Enterprise Storage Server. A disk storage system
controller that provides the ability to attach to one or that provides storage sharing for all major types of
more interfaces used to communicate with the servers.
associated storage devices.
error message. An indication that an error has been
device provider. A device-specific handler that detected.
receives client application requests that are destined for
ESS. See Enterprise Storage Server.
its device or storage server.
event.
digital certificate. A file used to identify the
authenticity of a person or organization. A certificate is 1. A representation of a change that occurs to a part.
made up of the following: The change enables other interested parts to
receive notification when something about the part
v The public key of the person who is being certified
changes. For example, a push button generates an
v The name and address of the person who is being event by signalling that it has been clicked, which
certified may cause another part to display a window.
v The digital signature of the certification authority 2. Any significant change in the state of a system
v The issue date resource, network resource, or network application.
v The expiration date An event can be generated for a problem, for the
resolution of a problem, or for the successful
digital signature. A unique mathematically computed completion of a task. Examples of events are: the
signature that ensures accountability. normal starting and stopping of a process, the
abnormal termination of a process, and the
disable. To make nonfunctional. malfunctioning of a server.
3. An occurrence of significance to a task or system,
disk drive. A diskette drive or a hard disk drive as
such as the completion or failure of an operation.
opposed to a CD-ROM or optical drive.
4. A data link control command and response passed
distinguished name. In secure communications, the between adjacent nodes that allows the two nodes
name and address of the person and organization to to exchange identification and other information
whom a certificate has been issued. necessary for operation over the data link.

distributed system. A system that is spread out event log. A file which lists all actions that have
across a network. occurred.

DMTF. See Desktop Management Task Force. extended binary-coded decimal interchange code
(EBCDIC). A coding scheme that was developed by
DNS. See Domain Name System. IBM, which you use to represent various alphabetic,
numeric, and special symbols with an 8 bit code.
domain.
1. That part of a computer network in which the data Extensible Markup Language (XML. A standard
processing resources are under common control. metalanguage for defining markup languages that was
2. In TCP/IP, the naming system used in hierarchical derived from and is a subset of SGML. XML omits the
networks. more complex and less-used parts of SGML and makes
it much easier to (a) write applications to handle
Domain Name System (DNS). In the Internet suite of document types, (b) author and manage structured
protocols, the distributed database system used to map information, and (c) transmit and share structured
domain names to IP addresses. information across diverse computing systems. The use
of XML does not require the robust applications and
processing that is necessary for SGML. XML is being
developed under the auspices of the World Wide Web
Consortium (W3C).

268 ESS API Reference

extrinsic method. A method defined by the schema GUI. See graphical user interface.
supported by the CIM Agent.
H
F
hard drive. A storage medium within a storage server
failed. A status reading indicating the inability of a used to maintain information that the storage server
functional unit to perform its required function. requires.

field. hdisk. An AIX term for storage space.

1. On a data medium or in storage, a specified area
help.
used for a particular class of data.
1. A standard push button or icon that provides
2. The smallest identifiable part of a record.
information about the item the cursor is on or about
3. An identifiable area on a screen. the entire dialog box.
file. A named set of records stored or processed as a 2. An action bar choice that has an associated
unit. pull-down. Its pull-down contains choices that can
be requested to invoke help actions.
File Transfer Protocol (FTP). An application protocol
used for transferring files to and from host computers. heterogeneous environment. A network where some
FTP requires a user ID, and a password to allow access or all of the computers have dissimilar architecture but
to files on a remote host system. nevertheless are able to communicate.

firewall. A protection against unauthorized connection homogeneous. Of the same or similar type. A
to a computer or a data storage system. The protection computer network in which all computers have the same
is usually in the form of software on a gateway server or similar architecture.
that grants access to users that meet authorization
host. The controlling or highest level in a data
criteria.
communication configuration. In TCP/IP, any system
firmware. that has at least one Internet address associated with it.
A host with multiple network interfaces may have
1. An ordered set of instructions and data stored in a
multiple Internet addresses associated with it.
way that is functionally independent of main storage.
Firmware is more efficient than software and is more host application software. Software application
adaptable to change than pure hardware circuitry. programs executed in the host computer.
2. Deprecated term for microcode.
host initiated. A program executed as a subtask at
FTP. See File Transfer Protocol. the request of the host system.

FTP site. An electronic repository of information using host name. In the Internet suite of protocols, the name
File Transfer Protocol (FTP) to transfer data to and from given to a computer. Sometimes, ″host name″ is used
servers. to mean fully qualified domain name; other times, it is
used to mean the most specific subname of a fully
function. qualified domain name. For example, if
1. A specific purpose of an entity, or its characteristic mycomputer.city.company.com is the fully qualified
action. domain name, either of the following may be considered
2. A system component or licensed program that can the host name:
be optionally installed in a user’s system. v mycomputer.city.company.com
v mycomputer
G host processor. A processor that controls all or part of
a user application network. In a network, the processing
GB. See gigabyte.
unit in which the data communication access method
gigabyte (GB). A gigabyte of storage is 109 bytes. A resides. See also “host system.”
gigabyte of memory is 230 bytes.
host system.
graphical user interface (GUI). A type of computer 1. A computer system that is connected to the ESS.
interface consisting of a visual metaphor of a real world The ESS supports both mainframe (S/390 or
scene, frequently a desktop. The GUI contains icons, zSeries) hosts as well as open-systems hosts.
representing actual objects, that the user can access System/390 or zSeries hosts are connected to the
and manipulate. Contrast with a command-line interface ESS through ESCON or FICON interfaces.
(CLI).

Glossary 269
 Open-system hosts are connected to the ESS by insert. To put a tape cartridge in the I/O station or to
SCSI or fibre-channel interfaces. automatically have the library move a cartridge from the
2. The data processing system to which a network is I/O station to a storage slot or drive.
connected and with which the system can
install. Set up for use or service. Adding a product,
communicate.
feature, or function system or device through a simple
3. The controlling or highest level system in a data change or through the addition of multiple components
communication configuration. or devices.
HTML. See hypertext markup language. instance.
HTTP. See Hypertext Transfer Protocol. 1. In Java programming, when you create a specific
variable of a particular class type, it is referred to as
hypertext markup language (HTML). An interpreted instantiating or creating an instance of that class
markup language used to create hypertext documents. 2. In Java programming, when you create a specific
Hypertext documents can include links to other related variable of a particular class type, it is referred to as
documents. HTML controls the format of text and instantiating or creating an instance of that class
position of form input areas, for example, as well as the
navigable links. interactive.
1. Pertaining to a program or system that alternately
Hypertext Transfer Protocol (HTTP). The primary
accepts input and then responds. An interactive
protocol in use on the Web.
system is conversational, that is, a continuous dialog
exists between user and system.
I 2. Pertaining to the exchange of information between a
user and a computer.
IBM product engineering (PE). IBM third-level service
support IBM engineers who have experience in interchange. The sending and receiving of data in
supporting a product, or who are knowledgeable about such a manner that the content of the data is not
the product. altered during transmission.

icon. interface.
1. A graphic symbol, displayed on a screen, that a user 1. A shared boundary between two functional units,
can point to with a device such as a mouse in order defined by functional characteristics, signal
to select a particular function or software application. characteristics, or other characteristics, as
2. A graphical representation of an object, consisting of appropriate. The concept includes the specification
an image, image background, and a label. of the connection of two devices having different
functions.
ID. See “identifier (ID).” 2. Hardware, software, or both, that links systems,
programs or devices.
identifier (ID). A unique name or address that
identifies things such as programs, devices, or systems. Internet. A wide area network that connects thousands
of disparate networks in industry, education,
initial program load (IPL). government, and research. The Internet network uses
1. The initialization procedure that causes an operating TCP/IP as the standard for transmitting information.
system to commence operation. Synonymous with
system restart, and system startup. Internet Explorer. The Web browser provided by
2. The process of loading system programs and Microsoft Corporation.
preparing a system to run jobs.
Internet Protocol (IP). A protocol used to route data
indication. A unique name or address that identifies from its source to its destination in the Internet
things such as programs, devices, or systems. computing network environment.

initialize. The formatting of a magnetic tape, except intranet. A collection of interconnected networks using
for the system files containing information on structure. Internet protocols, but with restricted access and not
All former contents of the tape are deleted. available to the public.

initiate. A network services request sent from a logical intrinsic method. A method that is supported by the
unit to a system services control point requesting that a CIM Agent itself.
session be established.
IP. See Internet Protocol.
initiator. A SCSI term for the part of a host computer
IP address. A group of four decimal numbers that
that communicates with its attached targets.
provides a unique address for the computer.

270 ESS API Reference

J managed object format (MOF). A method of
compilation and creation of data storage. The MOF
compiler stores information in the data repository.
JAR. See Java ARchive file.
MB. See megabyte.
Java ARchive (JAR) file. A collection of Java classes
and other files packaged into a single file. By using a megabyte (MB). A megabyte of storage is 1,000,000
Java ARchive file, the browser makes only one bytes. A megabyte of memory is 1,048,576 bytes.
connection to the server rather than several. By
reducing the number of files that the browser needs to Micro Channel architecture. The rules that define
load from the server, you can download and run your how subsystems and adapters use the Micro Channel
applet that much faster. Java ARchive files can also be bus in a computer. The architecture defines the services
compressed, making the overall file size smaller and that each subsystem can or must provide.
therefore faster to download.
method. An implementation of a function on a class.
Java. A programming language that enables
application developers to create object-oriented middleware. The term middleware is used to describe
programs that are very secure and portable across separate products that serve as the glue between two
different machine and operating system platforms. Java applications. It is, therefore, distinct from import and
is also dynamic enough to allow for easy expansion. export features that may be built into one of the
applications. Middleware connects two sides of an
Java applet. Java code that is compiled into a application and passes data between them.
compact and optimized program.
mid-range systems. A set of multi-use servers with
Java runtime environment (JRE). The underlying, hard disk capacity of 50 GB to 250 GB.
invisible system on your computer that runs applets the
browser passes to it. MOF. See managed object format.

JRE. See Java runtime environment. mount.

1. To place a data medium in a position to operate.
K 2. To make recording media accessible.
3. In AIX, to make a file system accessible.
KB. See kilobyte.

key ring. In secure communications, a file that N

contains public keys, private keys, trusted roots, and
certificates. namespace. A namespace defines the scope over
which a CIM schema applies. The only namespace
kilobyte (KB). A kilobyte of storage is 103 bytes. A supported by the CIM Agent is root/cimv2. A CIM
kilobyte of memory is 210 bytes. schema or version is loaded into a namespace when
that schema is compiled by the Managed Object Format
L (MOF) compiler. CIM operations always execute within
the context of a namespace. The namespace must be
LAN. See local area network. specified within the message that the client sends to the
CIM Agent.
link. The connection between two systems or files.
Netscape Navigator. The Web browser provided by
list box. A control that contains scrollable choices from Netscape Communications Corporation.
which a user can select one.
network.
local area network (LAN). A computer network 1. A configuration of data processing devices and
located on a user’s premises within a limited software connected for information interchange.
geographical area. 2. A group of nodes and the links interconnecting
them.
M network server. The server that controls network
mainframe. A computer, usually in a computer center, operations and management, provides access to files
with extensive capabilities and resources to which other and programs for all the workstations in a particular
computers may be connected so that they can share network.
facilities.

Glossary 271
next. A button or link that allows the user to move operator. A person or program responsible for
forward to the screen which follows the one they are managing functions controlled by a given piece of
currently viewing. software. The person who operates a device or keeps a
system running.
nonvolatile storage. Memory that stores active write
data to avoid data loss in the event of a power loss. operator intervention. A state requiring the operator
of the system or device to take action, either by
not installed. A status reading which indicates the acknowledging messages and initiating functions or
device is not present or cannot be initiated at this performing problem resolution.
location.
organizationally unique identifier (OUI). An identifier
NVS. See nonvolatile storage. that identifies an organization according to IEEE
standards.
O OUI. See organizationally unique identifier.
object. An object contains both data and code. The
principle feature of an object is that the data is kept P
privately inside the object structure. Any calculations on
that data are also private so it does not matter how that panel. The formatted display of information that
data is stored or how the computations are carried out. appears on a display screen.
It only matters that the object’s data and routines are
internally consistent and any access to the data in an parallel access volume (PAV). Created by
object always provides consistent results. associating multiple devices of a single control-unit
image with a single logical device. Up to 8 device
object name. An object name consists of a addresses can be assigned to a parallel access volume.
namespace path and a model path. The namespace
path provides access to the CIM implementation password. A unique string of characters known to a
managed by the CIM Agent. The model path provides computer system and to a user, who must specify the
navigation within the implementation. character string to gain access to a system and to the
information stored within it.
offline. The operating condition when the 3584 library
cannot interact with host systems. path. A statement that indicates where a file is stored
on a particular drive. The path consists of all the
online. The operating condition when host applications directories that must be opened to get to a particular
can interact with the 3584 library. file. The directory names are separated by the slash (/).

open system. A system whose characteristics comply platform. An ambiguous term that may refer to the
with standards made available throughout the industry, hardware, operating system, or a combination of the
and therefore can be connected to other systems that hardware and the operating system on which software
comply with the same standards. programs run.

open system hosts. platform-independent. Code which is

1. A computer system that is accessed by a user platform-independent can run on multiple combinations
working at a remote location. The term is typically of operating systems and hardware.
used when two computer systems are connected
program. A generic term for the software that controls
over a LAN or through a modem.
the operation of a host computer. Typically, the program
2. A computer connected to a TCP/IP network, is an operating system that allows sharing of the host
including the Internet. Each host has a unique IP resources between multiple tasks.
address.
property. A value used to characterize instances of a
operating system. The master computer control class.
program that translates user commands and allows
software applications to interact with the hardware. protocol. The set of rules that govern the operation of
functional units of a communication system. This allows
operation request message. An XML-encoded communication to take place. Protocols can determine
message that is sent to the CIMON by a client low-level details of machine-to-machine interfaces, such
application. as the order in which bits from a byte are sent. They
can also determine high-level exchanges between
operation response message. An XML-encoded
application programs, such as file transfer.
message that is sent to a client application by the
CIMON. provider. See device provider.

272 ESS API Reference

proxy server. A server that can retrieve documents 2. A functional unit that provides services to one or
from other servers for its clients. more clients over a network.
3. A computer that provides shared services to other
public access. Accessible by anyone who has
computers over a network; for example, a file server,
access. If you schedule a task to run and specify public
a print server, or a mail server.
access, all authorized users can view the results. if you
do not specify public access, only you have access to 4. A machine that provides resources to the network. It
the results. provides a network service, such as disk storage
and file transfer, or a program that uses such a
service.
Q
service location protocol (SLP). A directory service
qualifier. Characterizes other elements. A qualifier that a client application calls to locate the CIM Object
provides additional information about classes, Manager.
associations, indications, methods, method parameters,
instances, properties, or references. shared storage. Storage within a storage facility that
is configured such that multiple homogenous or
divergent hosts can concurrently access the storage.
R The storage has a uniform appearance to all hosts. The
host programs that access the storage must have a
RAM. See random access memory. common model for the information on a storage device.
You need to design the programs to handle the effects
random access memory. A temporary storage
of concurrent access.
location in which the central processing unit (CPU)
stores and executes its processes. sign on. A procedure to be followed at a terminal or
workstation to establish a link to a computer. (2) To
reference. Defines the role that an object plays in an
begin a session at a workstation.
association.
silent mode. A program that installs automatically due
register. To record or enroll.
to specific installation dependent custom information
required. A status reading which indicates the current entered by the user during an umbrella installation.
setting is mandatory and cannot be changed.
simple network management protocol (SNMP).
1. An SNMP Manager is part of a network
S administration software product, such as Tivoli TME
10 Netview.
SAN. See storage area network.
2. SNMP permits you to define management
schema. A group of classes defined to a single information base (MIB) extensions, or
namespace. Within the CIM Agent, the schemas that enterprise-specific MIBs. By loading a MIB file on a
are supported are the ones loaded through the manager station, you can monitor the MIB objects.
Managed Object Format (MOF) compiler. The SNMP Agent accesses MIB objects when a
request is received from an SNMP Manager.
screen. The physical surface of a display device upon 3. SNMP is a protocol designed to give a user the
which information is shown to a user. capability to remotely manage a computer network
by polling and setting terminal values and monitoring
Secure Sockets Layer (SSL). A protocol that provides network events.
secure communications on the Internet.
simple operation request. Operation request
select. messages that contain the <SIMPLEREQ> XML tag.
1. In Client Access for Windows, to highlight a choice
so that a subsequent action will use that choice. simple operation responses. Operation response
Selecting does not initiate the action. messages that contain the <SIMPLERSP> tag.
2. To choose a button on the display screen. SLP. See service location protocol.
3. To place the cursor on an object (name or
command) and press the Select (left) button on the SMIT. See “system management interface tool (SMIT)”
mouse or the Select key on the keyboard. on page 274.

server. software. All or part of the programs, procedures,

1. In a federated database system, a unit of rules, and associated documentation of a computer
information that identifies a data source to a processing system. Software is an intellectual creation
federated server. that is independent of the medium on which it is
recorded.

Glossary 273
status. The condition or state of hardware or software, 1. To end a process.
usually represented by a status code. 2. The process of ending a process, usually without
making any changes.
storage. A functional unit into which data or data
media can be placed, in which it can be retained and Transmission Control Protocol/Internet Protocol
from which it can be retrieved. (TCP/IP). A set of communication protocols that
support peer-to-peer connectivity functions for both local
storage administrator. A person in the data
and wide area networks.
processing center who is responsible for defining,
carrying out, and maintaining storage management tutorial. Teaches a user how to use the product.
policies. Tutorials generally allow the user to move through the
functions at their own pace than reference manuals and
storage area network (SAN). A high speed
usually contain less detail.
subnetwork of shared storage devices. A SAN’s
architecture makes all storage devices available to all
servers on a LAN or WAN. As more storage devices are U
added, they too will be accessible from any server in
the larger network. Since stored data does not reside UA. See user assistance.
directly on a network’s servers, server power is used for
applications, and network capacity is released to the user assistance (UA). This refers to the help files,
end user. where users go to find information to assist them in
operations or problem resolution.
storage device. A physical unit which provides a
mechanism to store data on a given medium such that it user ID. The unique string of characters that identifies
can be subsequently retrieved. any person or device (the User) that may issue or
receive commands and messages to or from the
storage management. The task of using storage, information processing system.
such as DASD, tape, or optical devices, to keep and
deliver data to applications.
V
storage management application. A software tool
used to manage storage resources. value.
1. A specific occurrence of an attribute.
storage resources. Data that needs to be managed.
2. A quantity assigned to a constant, a variable,
storage subsystem. A storage control and its parameter or a symbol.
attached storage devices.
verification. Authentication, certification, or proof. For
storage server. A unit that manages attached storage example, verification of sensitive data is frequently
devices and provides access to the storage or storage enforced by dual entry of all the data and a comparison
related functions for one or more attached hosts. of the results.

submenu. A menu related to and reached through a

main menu.
W
WAN. See wide area network.
subsystem identification (SSID). A number that
uniquely identifies a logical subsystem within a WBEM. See Web-based enterprise management.
computer installation.
Web. The World Wide Web. The network of HTTP
system management interface tool (SMIT). An servers that contain programs and files, such as
interface tool of the AIX operating system for installing, hypertext documents that contain links to other
maintaining, configuring, and diagnosing tasks. documents on HTTP servers.

T Web-based enterprise management (WBEM).

Web-based operations managed over HTTP.
TB. See terabyte.
wide area network (WAN). A network that provides
TCP/IP. See Transmission Control Protocol/Internet communication services to a geographic area larger
Protocol. than served by a local area network or a metropolitan
area network, and that may use or provide public
terabyte (TB). A unit of measure equal to 1012 bytes. communication facilities.

terminate, termination.

274 ESS API Reference

World Wide Web (WWW). A global network of servers
containing programs and files, accessible by the public.

WWW. See World Wide Web.

X, Y, Z
XML. See Extensible Markup Language.

Special Characters
* (an asterisk). This character is used to indicate all
valid values in a field. For example, an IP address of
204.146.18.* specifies all valid addresses attached to
204.146.18.

Glossary 275
276 ESS API Reference
Index
A CIM Agent (continued)
configuration on AIX 22
about this guide
configuration on Linux 47
notational conventions 88
configuration on Windows 72
accessibility 259
configuration programs 91
addess subcommand 101, 103
configuring for unsecure mode on AIX 25
adduser subcommand 94
configuring for unsecure mode on Linux 50
AIX
configuring for unsecure mode on Windows 75
CLI installation 7
functional groups 136
configuring CIM Agent 22
installation overview for AIX 7
configuring for unsecure mode 25
installation overview for Linux 33
installation
installation overview for Windows 59
graphical mode 10
installation requirements 5
unattended mode 19
installing CLI on AIX 7
installation overview 7
installing CLI on Linux 33
installing the CIM Agent in graphical mode 10
installing CLI on Windows 60
installing the CIM Agent in unattended mode 19
installing on AIX in graphical mode 10
mounting the CD 9
installing on AIX in unattended mode 19
removing the CIM Agent 27
installing on Linux in graphical mode 35
running the CIM Agent 25
installing on Linux in unattended mode 43
verifying installation 21
installing on Windows in graphical mode 61
AllocatedFromStoragePool class 177
installing on Windows in silent mode 69
anatomy of a command line 90
installing on Windows in unattended mode 69
association, ESS API 123
intrinsic and extrinsic communication methods 125
AssociatorNames method parameters 132
invoking 88
Associators method parameters 131
mounting the CD on AIX 9
AsyncPPRCService class 223, 224, 225, 226, 227,
overview 2, 6
228, 229, 230, 231
product overview 1
AuthorizedSubject class 179
quick reference for class definitions 141
AuthorizedTarget class 179
removing from AIX 27
removing from Linux 52
removing from Windows 80
C running on AIX 25
Chassis class 185 running on Linux 51
chess subcommand 105 security 6
chessserver subcommand 107 verifying connection to the ESS 76
chuser subcommand 95 verifying installation on AIX 21
CIM Agent verifying installation on Linux 47
class information 141 verifying installation on Windows 71
command descriptions 87 CIM API communication methods
communication concepts 125 AssociatorNames 132
communication methods 126 Associators 131
component CreateInstance 127
Access point subprofile instance diagram 233 DeleteInstance 127
Array profile instance diagram 232 EnumerateClasses 128
Copy services subprofile instance diagram 235 EnumerateClassNames 129
Disk drive subprofile instance diagram 239 EnumerateInstanceNames 130
Extra capacity set subprofile instance EnumerateInstances 129
diagram 234 EnumerateQualifiers 135
Location subprofile instance diagram 234 error codes 137
LUN creation subprofile instance diagram 236 ExecQuery 130
LUN mapping and masking subprofile instance GetClass 126
diagram 237 GetInstance 126
Performance extension 238 GetProperty 133
Physical package instance diagram 231 GetQualifier 134
Pool manipulation, capacity, and settings ModifyInstance 128
subprofile instance diagram 235 ReferenceNames 133
components 3 References 132

© Copyright IBM Corp. 2004 277

CIM API communication methods (continued) class definitions (continued)
SetProperty 134 IBMTSESS_Provider properties 212
SetQualifier 134 IBMTSESS_Realizes properties 193
CIM component definitions IBMTSESS_RemoteServiceAccessPoint
core classes 123 properties 187
namespace 123 IBMTSESS_RemoteSourceStorageSynchronized
object name 123 properties 219
CIM overview 4 IBMTSESS_RemoteTargetStorageSynchronized
CIMOM operations properties 220
client communication 125 IBMTSESS_RemoteVolume properties 219
instrinsic and extrinsic methods 125 IBMTSESS_StorageCapabilities properties 182
class definitions IBMTSESS_StorageClientSettingData
AuthorizedSubject properties 179 properties 206
AuthorizedTarget properties 179 IBMTSESS_StorageConfigurationService
ConcreteDependencyController properties 202 properties 157
ConcreteDependencyPrivilege properties 180 IBMTSESS_StorageExtent properties 207
ConcreteDependencyStorageHardwareID IBMTSESS_StorageProcessorCard properties 189
properties 180 IBMTSESS_StorageSetting properties 184
ControllerConfigurationService properties 193 IBMTSESS_StorageSynchronized properties 211
DeviceMaskingCapabilities properties 199 IBMTSESS_StorageSystem properties 147
ElementCapabilitesMasking properties 202 IBMTSESS_StorageSystemToController
ElementConformsToProfile properties 205 properties 178
ElementSettingData properties 181 IBMTSESS_StorageSystemToPort properties 177
HostedService4 properties 199 IBMTSESS_StorageSystemToVolume
IBMTSESS_AllocatedFromStoragePool properties 177
properties 177 IBMTSESS_SystemDevice properties 193
IBMTSESS_AsyncPPRCService properties 223, IBMTSESS_Volume properties 150
224, 225, 226, 227, 228, 229, 230, 231 IBMTSESS_VolumeSpace properties 148
IBMTSESS_Chassis properties 185 IBMTSESS_VolumeSpaceStatisticalData
IBMTSESS_Component properties 209 properties 217
IBMTSESS_ComputerSystemPackage IBMTSESS_VolumeSpaceStatistics properties 215
properties 186 IBMTSESS_VolumeStatisticalData properties 216
IBMTSESS_ComputerSystemPackageCard IBMTSESS_VolumeStatistics properties 213
properties 189 LunMaskPrivilegeService properties 171
IBMTSESS_ConcreteIdentityCapSet properties 187 Privilege properties 155
IBMTSESS_DiskDrive properties 190 ProtocolControllerForPort properties 178
IBMTSESS_ElementCapabilities properties 181 ProtocolControllerForUnit properties 178
IBMTSESS_EltCapabilitiesStgPool properties 211 RegisteredProfile properties 203
IBMTSESS_ExtraCapacitySet properties 186 SCSIProtocolController properties 154
IBMTSESS_FCPort properties 153 StorageHardwareID properties 156
IBMTSESS_HostedAccessPoint properties 189 StorageHardwareIDManagementService
IBMTSESS_HostedPrimordialStoragePool properties 174
properties 211 SubProfileExtendsProfile properties 204
IBMTSESS_HostedService properties 180 class information, CIM Agent 141
IBMTSESS_HostedService6 properties 219 class, ESS API 123
IBMTSESS_HostedStoragePool properties 181 command line string 90
IBMTSESS_InitiatorElementSettingData commands
properties 206 description 87
IBMTSESS_Location properties 205 example of a typical command line string 90
IBMTSESS_MediaPresentExtent properties 209 interactive mode 88
IBMTSESS_MemberOfCollection properties 190 mkcertificate 119
IBMTSESS_PerformanceStatisticsService operational 91, 115
properties 217 setdevice 100
IBMTSESS_PhysicalElementLocation setentry 98
properties 205 setoutput 99
IBMTSESS_PhysicalPackage properties 192 setuser 93
IBMTSESS_Pool2PrimordialPool 223 shell mode 88
IBMTSESS_PrimordialStoragePool properties 210 slpd 120
IBMTSESS_Product properties 176 startcimom 116
IBMTSESS_ProductPhysicalComponent stopcimom 117
properties 187 utility 118

278 ESS API Reference

commands (continued)
verifyconfig 121
F
FCPort class 153
comments, how to send xii
functional groups 136
Component class 209
ComputerSystemPackage class 186
ComputerSystemPackageCard class 189
ConcreteDependencyController class 202 G
ConcreteDependencyPrivilege class 180 GetClass method parameters 126
ConcreteDependencyStorageHardwareID class 180 GetInstance method parameters 126
ConcreteIdentityCapSet class 187 GetProperty method parameters 133
configuration GetQualifier method parameters 134
AIX 22 guidelines for invoking the CIM Agent 88
Linux 47
unsecure mode on AIX 25
unsecure mode on Linux 50 H
unsecure mode on Windows 75 HostedAccessPoint class 189
Windows 72 HostedPrimordialStoragePool class 211
ControllerConfigurationService class 193 HostedService class 180
core classes, CIM 123 HostedService4 class 199
CreateInstance method parameters 127, 128 HostedService6 class 219
HostedStoragePool class 181

D
DeleteInstance method parameters 127 I
DeleteQualifier, CIM API communication methods 135 IBMTSESS_ class definitions
DeviceMaskingCapabilities class 199 AllocatedFromStoragePool 177
disability 259 AsyncPPRCService 223, 224, 225, 226, 227, 228,
DiskDrive class 190 229, 230, 231
AuthorizedSubject 179
AuthorizedTarget 179
E Chassis 185
ElementCapabilitesMasking class 202 Component 209
ElementCapabilities class 181 ComputerSystemPackage 186
ElementConformsToProfile class 205 ComputerSystemPackageCard 189
elements, ESS API 123 ConcreteDependencyController 202
ElementSettingData class 181 ConcreteDependencyPrivilege 180
EltCapabilitiesStgPool class 211 ConcreteDependencyStorageHardwareID 180
emphasis 90 ConcreteIdentityCapSet 187
EnumerateClasses method parameters 128 ControllerConfigurationService 193
EnumerateClassNames method parameters 129 DeviceMaskingCapabilities 199
EnumerateInstanceNames method parameters 130 DiskDrive 190
EnumerateInstances method parameters 129 ElementCapabilitesMasking 202
EnumerateQualifiers, CIM API communication ElementCapabilities 181
methods 135 ElementConformsToProfile 205
error codes returned by the CIMOM 137 ElementSettingData 181
error codes returned by the ESS VSS Provider 256 EltCapabilitiesStgPool 211
ESS API ExtraCapacitySet 186
overview 1 FCPort 153
ESS API component definitions HostedAccessPoint 189
elements 123 HostedPrimordialStoragePool 211
ESS class definitions HostedService 180
individual functional schemas 231 HostedService2 181
quick reference 141 HostedService3 181
ESS VSS Provider HostedService4 199
error codes 256 HostedService6 219
installation requirements 242 HostedStoragePool 181
ExecQuery method parameters 130 InitiatorElementSettingData 206
ExtraCapacitySet class 186 Location 205
LunMaskPrivilegeService 171
MediaPresentExtent 209
MemberOfCollection 190

Index 279
IBMTSESS_ class definitions (continued) installation (continued)
PerformanceStatisticsService 217 unattended mode on Windows 69
PhysicalElementLocation 205 verifying on AIX 21
PhysicalPackage 192 verifying on Linux 47
Pool2PrimordialPool 223 verifying on Windows 71
PrimordialStoragePool 210 VSS Provider
Privilege 155 prerequisites 242
Product 176 Windows
ProductPhysicalComponent 187 prerequisites 5
ProtocolControllerForPort 178 invoking the CIM Agent 88
ProtocolControllerForUnit 178
Provider 212
Realizes 193 L
RegisteredProfile 203 Linux
RemoteServiceAccessPoint 187 CLI installation 33
RemoteSourceStorageSynchronized 219 configuring CIM Agent 47
RemoteTargetStorageSynchronized 220 configuring for unsecure mode 50
RemoteVolume 219 installation
SCSIProtocolController 154 graphical mode 36
StorageCapabilities 182 installation overview 33
StorageClientSettingData 206 installing the CIM Agent in graphical mode 35
StorageConfigurationService 157 installing the CIM Agent in unattended mode 43
StorageExtent 207 removing the CIM Agent 52
StorageHardwareID 156 running the CIM Agent 51
StorageHardwareIDManagementService 174 verifying installation 47
StorageProcessorCard 189 Location class 205
StorageSetting 184 lsess subcommand 109
StorageSynchronized 211 lsessserver subcommand 110
StorageSystem 147 lsuser subcommand 96
StorageSystemToController 178 LunMaskPrivilegeService class 171
StorageSystemToPort 177
StorageSystemToVolume 177
SubProfileExtendsProfile 204 M
SystemDevice 193 MediaPresentExtent class 209
Volume 150 MemberOfCollection class 190
VolumeSpace 148 method, ESS API 123
VolumeSpaceStatisticalData 217 mkcertificate command 119
VolumeSpaceStatistics 215 modifyconfig subcommand 122
VolumeStatisticalData 216 mounting the CD on AIX 9
VolumeStatistics 213
indication, ESS API 123
InitiatorElementSettingData class 206
installation
N
namespace, CIM 123
AIX
notational conventions
graphical mode 10
emphasis 90
unattended mode 19
special characters 90
CLI on AIX 7
CLI on Linux 33
CLI on Windows 60
graphical mode on AIX 10 O
graphical mode on Linux 35 object name, CIM 123
graphical mode on Windows 61 operational commands 91, 115
Linux
graphical mode 36
mounting the CD on AIX 9 P
overview for AIX 7 PerformanceStatisticsService class 217
overview for Linux 33 PhysicalElementLocation class 205
overview for Windows 59 PhysicalPackage class 192
silent mode on Windows 69 Pool2PrimordialPool class 223
unattended mode on AIX 19 prerequisites
unattended mode on Linux 43 VSS Provider 242

280 ESS API Reference

prerequisites (continued) StorageHardwareIDManagementService class 174
Windows 5 StorageProcessorCard class 189
PrimordialStoragePool class 210 StorageSetting class 184
Privilege class 155 StorageSynchronized class 211
Product class 176 StorageSystem class 147
ProductPhysicalComponent class 187 StorageSystemToController class 178
property, ESS API 123 StorageSystemToPort class 177
ProtocolControllerForPort class 178 StorageSystemToVolume class 177
ProtocolControllerForUnit class 178 subcommands
Provider class 212 addess 101, 103
adduser 94
chess 105
Q chessserver 107
qualifier, ESS API 123 chuser 95
quick reference table, class definitions 141 lsess 109
lsessserver 110
lsuser 96
R modifyconfig 122
Realizes class 193 rmess 111
reference, ESS API 123 rmessserver 112
ReferenceNames method parameters 133 rmuser 97
RegisteredProfile class 203 setentry 113
RemoteServiceAccessPoint class 187 setoutput 114
RemoteSourceStorageSynchronized class 219 setuser 93
RemoteTargetStorageSynchronized class 220 SubProfileExtendsProfile class 204
RemoteVolume class 219 SystemDevice class 193
removing the CIM Agent
AIX 27
Linux 52 U
removing the ESS CIM Agent unattended installation on Windows 69
Windows 80 utility commands 118
rmess subcommand 111
rmessserver subcommand 112
rmuser subcommand 97 V
running the CIM Agent verifyconfig command 121
on AIX 25 verifying connection to the ESS
on Linux 51 on Windows 76
verifying installation
AIX 21
S Linux 47
schema, ESS API 123 Windows 71
SCSIProtocolController class 154 Volume class 150
setdevice command 100 VolumeSpace class 148
setentry command 98 VolumeSpaceStatisticalData 217
setentry subcommand 113 VolumeSpaceStatistics class 215
setoutput command 99 VolumeStatisticalData class 216
setoutput subcommand 114 VolumeStatistics class 213
SetProperty method parameters 134 VSS Provider
SetQualifier method parameters 134 prerequisites 242
setuser command 93
setuser subcommand 93
silent installation on Windows 69 W
slpd command 120 Windows
special characters 90 CLI installation 60
startcimom command 116 configuring ESS CIM Agent 72
stopcimom command 117 configuring for unsecure mode 75
StorageCapabilities class 182 installation overview 59
StorageClientSettingData class 206 installing the ESS CIM Agent in graphical mode 61
StorageConfigurationService class 157 installing the ESS CIM Agent in silent mode 69
StorageExtent class 207 installing the ESS CIM Agent in unattended
StorageHardwareID class 156 mode 69

Index 281
Windows (continued)
prerequisites 5
removing the ESS CIM Agent 80
verifying connection to the ESS 76
verifying installation 71

282 ESS API Reference

Readers’ Comments — We’d Like to Hear from You
IBM TotalStorage Enterprise Storage Server
Application Programming Interface Reference

Publication No. GC35-0489-01

Overall, how satisfied are you with the information in this book?

Very Satisfied Satisfied Neutral Dissatisfied Very Dissatisfied

Overall satisfaction h h h h h

How satisfied are you that the information in this book is:

Very Satisfied Satisfied Neutral Dissatisfied Very Dissatisfied

Accurate h h h h h
Complete h h h h h
Easy to find h h h h h
Easy to understand h h h h h
Well organized h h h h h
Applicable to your tasks h h h h h

Please tell us how we can improve this book:

Thank you for your responses. May we contact you? h Yes h No

When you send comments to IBM, you grant IBM a nonexclusive right to use or distribute your comments in any
way it believes appropriate without incurring any obligation to you.

Name Address

Company or Organization

Phone No.
 ___________________________________________________________________________________________________
Readers’ Comments — We’d Like to Hear from You Cut or Fold
GC35-0489-01
 Along Line

_ _ _ _ _ _ _Fold
_ _ _and
_ _ _Tape
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Please
_ _ _ _ _do
_ _not
_ _ staple
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _Fold
_ _ _and
_ _ Tape
______

NO POSTAGE
NECESSARY
IF MAILED IN THE
UNITED STATES

BUSINESS REPLY MAIL

FIRST-CLASS MAIL PERMIT NO. 40 ARMONK, NEW YORK

POSTAGE WILL BE PAID BY ADDRESSEE

International Business Machines Corporation

Information Development
Department 61C
9000 South Rita Road
Tucson, AZ 85775-4401

_________________________________________________________________________________________
Fold and Tape Please do not staple Fold and Tape

Cut or Fold
GC35-0489-01 Along Line



Printed in USA

GC35-0489-01
Spine information:

IBM TotalStorage Enterprise

 Storage Server ESS API Reference