Vous êtes sur la page 1sur 313

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”
Note: Before using this information and the product it supports, read the information in “Notices”

Note:

Note: Before using this information and the product it supports, read the information in “Notices” on

Before using this information and the product it supports, read the information in “Notices” on page 261.

Before using this information and the product it supports, read the information in “Notices” on page

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 . . . . . . . . . . . . .

Contents

Tables .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

vii

Figures .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

ix

. Who should use this guide .

About this guide .

. Conventions used in this guide .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

xi

xi

xii

How to send your comments .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

xii

Related information

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

xii

. Other IBM publications .

ESS library

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

 

.

.

 

.

.

 

.

.

 

.

.

 

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

xiii

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

CIM Agent components

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

2

3

CIM concepts

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

4

ESS CIM Agent installation requirements .

.

Hardware

.

.

.

.

.

.

.

 

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

5

5

. Workstation space .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

5

Software .

. ESS CIM Agent installation methods

.

.

.

.

.

.

.

.

 

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

6

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

. Installing the CIM Agent on AIX in graphical mode .

Mounting the CD on AIX .

.

.

.

.

.

.

.

.

 

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

9

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

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

27

Removing the CIM Agent on AIX . Removing in graphical mode .

. Removing in unattended (silent) mode

.

.

 

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

28

32

Chapter 3. CIM Agent for Linux .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

33

. Installing the ESS CLI on Linux .

Installation overview for Linux

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

 

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

33

33

Installing the CIM Agent on Linux in graphical mode .

.

.

.

.

.

.

.

.

.

.

35

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

.

.

.

.

.

.

.

43

Verifying the CIM Agent installation on Linux .

.

.

.

.

.

.

.

.

.

.

.

.

.

47

. Configuring the CIM Agent to run in unsecure mode on Linux .

Configuring the CIM Agent on Linux .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

47

50

Verifying connection to the ESS .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

51

Removing the CIM Agent on Linux .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

52

. Removing in unattended (silent) mode

Removing in graphical mode .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

53

57

Chapter 4. ESS CIM Agent for Windows .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

59

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

59

Installation overview for Windows . Installing the ESS CLI for Windows

. Installing the ESS CIM Agent on Windows in graphical mode .

.

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

.

.

.

.

.

.

.

.

.

.

.

.

.

 

.

.

.

.

.

.

.

.

.

.

.

.

60

61

69

Verifying the ESS CIM Agent Windows installation .

.

.

.

.

.

.

.

.

.

.

.

71

. Configuring the ESS CIM Agent to run in unsecure mode .

Configuring the ESS CIM Agent for Windows .

.

.

.

.

Verifying connection to the ESS .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

72

75

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 .

. Operational commands

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

114

115

startcimom .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

116

stopcimom .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

117

Utility commands

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

118

mkcertificate

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

119

slpd

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

120

verifyconfig .

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

121

modifyconfig

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

.

122

Appendix A. ESS API component definitions

.

.

.

.

.

.

.

.

.

.

.

.

123

Appendix B. CIM Agent communication with the ESS API

.