tivoli kernel services command reference - ibmpublib.boulder.ibm.com/.../pdf/tks_12_commands.pdf ·...

Tivoli Kernel Services Command ReferenceVersion 1.2

Tivoli Kernel Services Command Reference

Copyright Notice

© Copyright IBM Corporation 2000, 2001 All rights reserved. May only be used pursuant to a Tivoli Systems Software License Agreement, an IBM Software LicenseAgreement, or Addendum for Tivoli Products to IBM Customer or License Agreement. No part of this publication may be reproduced, transmitted, transcribed, stored in aretrieval system, or translated into any computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise,without prior written permission of IBM Corporation. IBM Corporation grants you limited permission to make hardcopy or other reproductions of any machine-readabledocumentation for your own use, provided that each such reproduction shall carry the IBM Corporation copyright notice. No other rights under copyright are grantedwithout prior written permission of IBM Corporation. The document is not intended for production and is furnished “as is” without warranty of any kind. All warrantieson this document are hereby disclaimed, including the warranties of merchantability and fitness for a particular purpose.

U.S. Government Users Restricted Rights—Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corporation.

Trademarks

IBM, the IBM logo, Tivoli, the Tivoli logo, AIX, NetView, RS/6000, and TME are trademarks or registered trademarks of International Business Machines Corporation orTivoli Systems Inc. in the United States, other countries, or both.

Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and other countries.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.

Other company, product, and service names may be trademarks or service marks of others.

Notices

References in this publication to Tivoli Systems or IBM products, programs, or services do not imply that they will be available in all countries in which Tivoli Systemsor IBM operates. Any reference to these products, programs, or services is not intended to imply that only Tivoli Systems or IBM products, programs, or services can beused. Subject to valid intellectual property or other legally protectable right of Tivoli Systems or IBM, any functionally equivalent product, program, or service can beused instead of the referenced product, program, or service. The evaluation and verification of operation in conjunction with other products, except those expresslydesignated by Tivoli Systems or IBM, are the responsibility of the user. Tivoli Systems or IBM may have patents or pending patent applications covering subject matter inthis document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to the IBM Director ofLicensing, IBM Corporation, North Castle Drive, Armonk, New York 10504-1785, U.S.A. See also “Additional Notices” on page xvii.

Contents

Preface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiWho Should Read This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Prerequisite and Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

What This Document Contains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Conventions Used in This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Accessing Publications Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv

Ordering Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Providing Feedback about Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Contacting Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Additional Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviiOpenSSL License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Original SSLeay License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Apache and Apache Tomcat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii

Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1How This Book is Organized. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Command Line Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Case Sensitivity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Getting Help for Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Security Implications for wcmd Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

How to Create an Account Using wcmd Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Font and Code Page Requirements for CLI Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 2. Access Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9wcmd accmgr getComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

wcmd accmgr getService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

wcmd accmgr getServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

wcmd accmgr listServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

wcmd accmgr localAvail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

wcmd accmgr remoteAvail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

wcmd accmgr startComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

wcmd accmgr startService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

wcmd accmgr stopComponent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

wcmd accmgr stopService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

iii

Chapter 3. Authorization Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21wcmd azncache clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

wcmd azncache dump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

wcmd azncache getCapacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

wcmd azncache getParentID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

wcmd azncache getPrimaryParentID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

wcmd azncache keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

wcmd azncache listCacheChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

wcmd azncache tracePathToRoot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Chapter 4. Component Distribution Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31wcmd cds deploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

wcmd cds getInstallationDepot. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

wcmd cds install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

wcmd cds isAvailableOnID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

wcmd cds isInstalled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

wcmd cds listComponentVersions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

wcmd cds listDeploymentTargetOrbIDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

wcmd cds listDeploymentTargetOrbNames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

wcmd cds listInstalledComponents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

wcmd cds retract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

wcmd cds rollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

wcmd cds rollbackAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

wcmd cds uninstall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

wcmd cds upgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

wcmd cds upgradeAll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Chapter 5. Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53wcmd cfg children. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

wcmd cfg cleanup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

wcmd cfg clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

wcmd cfg contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

wcmd cfg get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

wcmd cfg getCoalesced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

wcmd cfg getCoalescing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

wcmd cfg getRaw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

iv Version 1.2

wcmd cfg importXML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

wcmd cfg keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

wcmd cfg listResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

wcmd cfg nodeExists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

wcmd cfg put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

wcmd cfg remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

wcmd cfg removeNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

wcmd cfg removeResource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

wcmd cfg whence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

wcmd cfg whenceCoalesced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Chapter 6. Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81wcmd comp backoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

wcmd comp compatVer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

wcmd comp component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

wcmd comp components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

wcmd comp install . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

wcmd comp listCompatibleVersions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

wcmd comp listURL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

wcmd comp listURLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

wcmd comp reqComp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

wcmd comp restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

wcmd comp saveState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

wcmd comp shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

wcmd comp start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

wcmd comp status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

wcmd comp stats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

wcmd comp stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

wcmd comp uninstall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

wcmd comp upgrade . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

wcmd comp version. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Chapter 7. Depot Component Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101wcmd dci listDiff. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

wcmd dci listInstalledComponents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

wcmd dci listInstalledComponentNames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

wcmd dci processQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

v

wcmd dci showQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Chapter 8. Directory Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107wcmd dir attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

wcmd dir getdbInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

wcmd dir ls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

wcmd dir maint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

wcmd dir mkdir. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

wcmd dir rename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

wcmd dir rmdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

wcmd dir setdbInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

wcmd dir showListeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Chapter 9. Thread Dumper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121wcmd dumper dump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

wcmd dumper locks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Chapter 10. Failover Agent Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127wcmd failoverAgent config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

wcmd failoverAgent disable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

wcmd failoverAgent enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

wcmd failoverAgent listMonitoredComponents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

Chapter 11. Gateway IP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133wcmd GatewayIPService finish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

wcmd GatewayIPService ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

wcmd GatewayIPService query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

wcmd GatewayIPService remove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137

wcmd GatewayIPService resolve . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

wcmd GatewayIPService resume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

wcmd GatewayIPService statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

wcmd GatewayIPService status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

wcmd GatewayIPService stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

wcmd GatewayIPService traceroute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Chapter 12. Gateway SNMP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145wcmd GatewaySNMPService finish . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

wcmd GatewaySNMPService getnextOid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

vi Version 1.2

wcmd GatewaySNMPService getOid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149

wcmd GatewaySNMPService oids . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

wcmd GatewaySNMPService query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

wcmd GatewaySNMPService remove. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152

wcmd GatewaySNMPService resume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

wcmd GatewaySNMPService setOid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154

wcmd GatewaySNMPService statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

wcmd GatewaySNMPService status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156

wcmd GatewaySNMPService stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

wcmd GatewaySNMPService traceSNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Chapter 13. Info Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161Namespaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

ORB Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Info Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

User-Friendly Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

wcmd info crtNamespace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

wcmd info crtOrb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165

wcmd info crtOrbset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166

wcmd info delNamespace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

wcmd info delOrb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168

wcmd info delOrbset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

wcmd info evalOrb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170

wcmd info evalOrbset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

wcmd info getName . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

wcmd info getNamespaceOf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

wcmd info getNamespaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174

wcmd info getOrbs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

wcmd info getOrbsetMembership. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

wcmd info getOrbsets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

wcmd info getProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

wcmd info getXURLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

wcmd info joinOrbset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

wcmd info leaveOrbset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

wcmd info nestOrbset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

vii

wcmd info refreshCache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

wcmd info setName. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

wcmd info setProperties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

wcmd info showListeners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

wcmd info unnestOrbset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Chapter 14. IpConfig Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197wcmd IpConfig addNAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

wcmd IpConfig addNodeEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

wcmd IpConfig createSecGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

wcmd IpConfig deleteSecGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

wcmd IpConfig dumpNAT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

wcmd IpConfig dumpNode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

wcmd IpConfig findValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

wcmd IpConfig listNATs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

wcmd IpConfig listSecGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

wcmd IpConfig removeNAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

wcmd IpConfig removeNodeEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Chapter 15. Java Console Launcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213jclauncher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214

Chapter 16. Local Component Installer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215wcmd lci checkDepots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216

wcmd lci listDeployedComponents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

wcmd lci listDeployedComponentNames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

wcmd lci listDiff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

wcmd lci processQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

wcmd lci showQueue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Chapter 17. Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223Logging CLI Syntax Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

wcmd log children. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

wcmd log dbTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

wcmd log filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227

wcmd log formatter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

wcmd log handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

wcmd log ls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

viii Version 1.2

wcmd log message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

wcmd log trace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Chapter 18. Messaging Service Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249wcmd mserv appendServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

wcmd mserv listPublishers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

wcmd mserv listSubscribers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

mserv maxSubscribersPerServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

wcmd mserv setServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

wcmd mserv statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Chapter 19. MessagingService Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257wcmd msm addServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

wcmd msm hierarchyTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

wcmd msm removeServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

wcmd msm status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Chapter 20. Network Endpoint Locator Service . . . . . . . . . . . . . . . . . . . . . . . . . 263wcmd NelService clearDefaultGateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 264

wcmd NelService clearGateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265

wcmd NelService listGateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266

wcmd NelService listNATs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

wcmd NelService resolveEndpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268

wcmd NelService setDefaultGateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269

wcmd NelService setGateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270

wcmd NelService status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272

Chapter 21. Object Request Broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273wcmd orb connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

wcmd orb odstat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

wcmd orb oid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277

wcmd orb recycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

wcmd orb shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

wcmd orb threads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280

Chapter 22. Serialized Persistence Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283wcmd per backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284

wcmd per delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285

ix

wcmd per restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286

wcmd per unlock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287

Chapter 23. Tivoli Presentation Services Management ComponentRepository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289

wcmd psmcr rebuildHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290

Chapter 24. Security Service Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291wcmd ssm crtInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292

wcmd ssm crtSubcontext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293

wcmd ssm delAllFrom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294

wcmd ssm delInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295

wcmd ssm delSubcontext. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296

wcmd ssm dump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

wcmd ssm importXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298

wcmd ssm listAllAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300

wcmd ssm listAllChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301

wcmd ssm listAllResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

wcmd ssm listAttributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

wcmd ssm listChildren . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304

wcmd ssm modifyAttributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

wcmd ssm renameInstance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306

Chapter 25. Service Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307wcmd svc ls BackUps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

wcmd svc ls DSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309

wcmd svc ls LSM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

wcmd svc ls Primary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

x Version 1.2

Preface

The Tivoli Kernel Services Command Reference provides descriptions of operator commandsthat are used to manipulate components and services in a Tivoli Kernel Services installation.

Who Should Read This DocumentThis document is intended for use by individuals who need to perform system administrationactivities for a Tivoli Kernel Services installation from a Command Line Interface (CLI).

Prerequisite and Related DocumentsTivoli Kernel Services provides the following related documentation:

¶ Planning for Tivoli Kernel Services

Explains how to plan for deploying Tivoli Kernel Services in your operatingenvironment.

¶ Installing Tivoli Kernel Services

Provides information about installing, deploying, and configuring Tivoli Kernel Services.

¶ Introducing Tivoli Kernel Services Administration

Provides information about administering Tivoli Kernel Services through the use of theTivoli Console.

¶ Tivoli Kernel Services Command Quick Reference Card

A quick reference showing a summary of the command line interface for Tivoli KernelServices.

¶ Troubleshooting Tivoli Kernel Services

Provides information about troubleshooting and maintaining the services, components,and databases that comprise Tivoli Kernel Services.

¶ Tivoli Kernel Services README

Provides late-breaking information, such as problems and workarounds and patchavailability.

¶ Guided Tour of the Tivoli Console

An HTML-based introduction to the Tivoli Console, the graphical user interface used toadminister Tivoli Kernel Services.

The documentation for Tivoli Kernel Services, with the exception of the integrated onlinehelp and the product README, is located in the tivolidocs subdirectory on both the TivoliKernel Services Installation CD-ROM and the Bootprint CD-ROM, in both HTML and PDFformats. The product README is located in the root directory of the Installation CD-ROM.

What This Document ContainsThe Tivoli Kernel Services Command Reference contains the following information:

¶ Introduction

Describes the general syntax and options applicable to any wcmd command. Thischapter also describes how the book is organized to help you locate information withinthis document.

xi

¶ Access Manager

Describes the CLI for the Tivoli Kernel Services Access Manager. Access Managercommands are used primarily to start and stop components and services

¶ Authorization Cache

Describes the CLI for the Tivoli Kernel Services Authorization Cache. The AuthorizationCache stores information in the Security Registry in a local cache to reduce access timeto security information.

¶ Component Distribution Service

Describes the CLI for the Tivoli Kernel Services Component Distribution Service. TheComponent Distribution Service is used to install and deploy components.

¶ Configuration

Describes the CLI for the Tivoli Kernel Services Configuration Service. TheConfiguration Service commands can be used to manage configuration data forcomponents and services, including those that provide their own configuration CLIs.

¶ Component

Describes the CLI for the Tivoli Kernel Services Component Manager. Componentcommands are low-level commands that can be used to manipulate components currentlyrunning on an ORB and are intended to be used when troubleshooting problems or whendeveloping components. In day-to-day operations, administrators should use AccessManager commands to manipulate components and services.

¶ Depot Component Installer

Describes the CLI for the Tivoli Kernel Services Depot Component Installer. DepotComponent Installer commands are used to display the components installed in an ORB.

¶ Directory Service

Describes the CLI for the Tivoli Kernel Services Directory Service. The DirectoryService provides naming and directory services for data and objects in a Tivoli KernelServices installation.

¶ Thread Dumper

Describes the CLI for the Tivoli Kernel Services Thread Dumper utility.

¶ Failover Agent Service

Describes the CLI for the Tivoli Kernel Services FailoverAgent Service. FailoverAgentcommands configure fault-tolerance parameters for components monitored by theFailover Service.

¶ Gateway IP Service

Describes the CLI for the Tivoli Kernel Services Gateway IP Service. The Gateway IPService commands provide the ability to perform IP/ICMP operations on IP systems in aTivoli Kernel Services installation.

¶ Gateway SNMP Service

Describes the CLI for the Tivoli Kernel Services Gateway SNMP Service. The GatewaySNMP Service commands provide the ability to perform SNMP operations on IPsystems and endpoints in a Tivoli Kernel Services installation.

¶ Info Service

Describes the CLI for the Tivoli Kernel Services Info Service. Info Service commandsare used to manipulate namespaces, ORBs, and ORB sets in an installation.

xii Version 1.2

¶ IpConfig Service

Describes the CLI for the Tivoli Kernel Services IP Configuration Service. IP ConfigService Commands manage SNMP configuration information for IP resources in aninstallation.

¶ Local Component Installer

Describes the CLI for the Tivoli Kernel Services Local Component Installer. LocalComponent Installer commands are used to display information about the componentsdeployed to or retracted from an ORB.

¶ Logging

Describes the CLI for the Tivoli Kernel Services Logging Utility. Logging commandsare used to configure and display information for message and trace loggers and thehandlers, formatters, and filters that process log records.

¶ MessagingService Manager

Describes the CLI for the Tivoli Kernel Services Messaging Service Manager.Messaging Service Manager commands are used to create configuration data formachines running MQSeries servers.

¶ Network Endpoint Locator Service

Describes the CLI for the Tivoli Kernel Services Network Endpoint Locator Service.The Network Endpoint Locator Service is used by applications to determine whichgateway server should be used to access an endpoint.

¶ Object Request Broker

Describes the CLI for the Tivoli Kernel Services ORB. ORB commands manage ORBsin an installation, including shutting them down, or recycling (a shutdown and restart)them.

¶ Serialized Persistence Service

Describes the CLI for the Tivoli Kernel Services Serialized Persistence Service. TheSerialized Persistence Service commands manage objects stored in the SerializedPersistence Service database.

¶ Tivoli Presentation Services Management Component Repository

Describes the CLI for the Presentation Services Management Component Repository.

¶ Security Service Manager

Describes the CLI for the Tivoli Kernel Services Security Service Manager. SecurityService Manager commands are used to manage objects in the Security Registry.

¶ Service Manager

Describes the CLI for the Tivoli Kernel Services Service Manager. Service Managercommands display the services running on an ORB and the advertised services that areavailable though a Distributed Service Manager.

Conventions Used in This DocumentThe document uses several typeface conventions for special terms and actions. Thesetypeface conventions have the following meaning:

Bold Commands, keywords, file names, authorization roles, URLs, or otherinformation that you must use literally appear like this, in bold. Names ofwindows, dialogs, and other controls also appear like this, in bold.

xiii

Italics Variables and values that you must provide appear like this, in italics. Wordsand phrases that are emphasized also appear like this, in italics.

Monospace Code examples, output, system messages, XML tags, and Java® class,method, and interface names appear like this, in a monospace font.

This document uses both UNIX® and Windows NT® convention for specifying environmentvariables and for directory notation. When entering commands, use the syntax appropriatefor the platform you are using.

Note: When using the bash shell on a Windows NT system, you can use the UNIXconventions.

In addition to the typeface conventions described above, this document uses the followingnotation to define command syntax:

[ ] Brackets identify optional arguments. Arguments not enclosed in brackets arerequired.

... Ellipses indicate you can specify multiple values for the previous argument.Unless otherwise specified, a space is used to separate the arguments.

| Vertical bars, or pipe characters, separate mutually exclusive arguments.

{ } Braces surround mutually exclusive arguments when one of the arguments isrequired. Mutually exclusive arguments that are optional are enclosed inbrackets ([ ]).

See “Command Line Syntax” on page 2 for additional conventions regarding commandsyntax and “Case Sensitivity” on page 5 for type case requirements for Tivoli KernelServices commands.

Accessing Publications OnlineThe Tivoli Customer Support Web site (http://www.tivoli.com/support/) offers a guide tosupport services (the Customer Support Handbook); frequently asked questions (FAQs); andtechnical information, including release notes, user’s guides, redbooks, and white papers.You can access Tivoli publications online at http://www.tivoli.com/support/documents/. Thedocumentation for some products is available in PDF and HTML formats. Translateddocuments are also available for some products.

To access most of the documentation, you need an ID and a password. To obtain an ID foruse on the support Web site, go to http://www.tivoli.com/support/getting/.

Resellers should refer to http://www.tivoli.com/support/smb/index.html for more informationabout obtaining Tivoli technical documentation and support.

Business Partners should refer to “Ordering Publications” on page xv for more informationabout obtaining Tivoli technical documentation.

xiv Version 1.2

Ordering PublicationsOrder Tivoli publications online athttp://www.tivoli.com/support/Prodman/html/pub_order.html or by calling one of thefollowing telephone numbers:

¶ U.S. customers: (800) 879-2755

¶ Canadian customers: (800) 426-4968

Providing Feedback about PublicationsWe are very interested in hearing about your experience with Tivoli products anddocumentation, and we welcome your suggestions for improvements. If you have commentsor suggestions about our products and documentation, contact us in one of the followingways:

¶ Send e-mail to [email protected].

¶ Fill out our customer feedback survey at http://www.tivoli.com/support/survey/.

Contacting Customer SupportThe Tivoli Customer Support Handbook at http://www.tivoli.com/support/handbook/ providesinformation about all aspects of Tivoli Customer Support, including the following:

¶ Registration and eligibility.

¶ How to contact support, depending on the severity of your problem.

¶ Telephone numbers and e-mail addresses, depending on the country you are in.

¶ What information you should gather before contacting support.

xv

xvi Version 1.2

Additional Notices

OpenSSL LicenseCopyright (c) 1998-2000 The OpenSSL Project. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, arepermitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list ofconditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list ofconditions and the following disclaimer in the documentation and/or other materialsprovided with the distribution.

3. All advertising materials mentioning features or use of this software must display thefollowing acknowledgment: ″This product includes software developed by the OpenSSLProject for use in the OpenSSL Toolkit. (http://www.openssl.org/)″.

4. The names ″OpenSSL Toolkit″ and ″OpenSSL Project″ must not be used to endorse orpromote products derived from this software without prior written permission. Forwritten permission, please contact [email protected].

5. Products derived from this software may not be called ″OpenSSL″ nor may ″OpenSSL″appear in their names without prior written permission of the OpenSSL Project.

6. Redistributions of any form whatsoever must retain the following acknowledgment:″This product includes software developed by the OpenSSL Project for use in theOpenSSL Toolkit (http://www.openssl.org/)″.

THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT vvAS IS’’ AND ANYEXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THEIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR APARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSLPROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS ORSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER INCONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OROTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVENIF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This product includes cryptographic software written by Eric Young ([email protected]).This product includes software written by Tim Hudson ([email protected]).

Original SSLeay LicenseCopyright (C) 1995-1998 Eric Young ([email protected]) All rights reserved.

This package is an SSL implementation written by Eric Young ([email protected]). Theimplementation was written so as to conform with Netscape’s SSL.

xvii

This library is free for commercial and non-commercial use as long as the followingconditions are adhered to. The following conditions apply to all code found in thisdistribution, be it the RC4, RSA, lhash, DES, etc., code; not just the SSL code. The SSLdocumentation included with this distribution is covered by the same copyright terms exceptthat the holder is Tim Hudson ([email protected]).

Copyright remains Eric Young’s, and as such any Copyright notices in the code are not to beremoved. If this package is used in a product, Eric Young should be given attribution as theauthor of the parts of the library used. This can be in the form of a textual message atprogram startup or in documentation (online or textual) provided with the package.

Redistribution and use in source and binary forms, with or without modification, arepermitted provided that the following conditions are met:

1. Redistributions of source code must retain the copyright notice, this list of conditions andthe following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list ofconditions and the following disclaimer in the documentation and/or other materialsprovided with the distribution.

3. All advertising materials mentioning features or use of this software must display thefollowing acknowledgement: ″This product includes cryptographic software written byEric Young ([email protected]).″ The word ’cryptographic’ can be left out if theroutines from the library being used are not cryptographic related:

4. If you include any Windows -specific code (or a derivative thereof) from the appsdirectory (application code) you must include an acknowledgement: ″This productincludes software written by Tim Hudson ([email protected])″.

THIS SOFTWARE IS PROVIDED BY ERIC YOUNG vvAS IS’’ AND ANY EXPRESS ORIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULARPURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR ORCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITEDTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANYTHEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THEUSE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCHDAMAGE.

The licence and distribution terms for any publicly available version or derivative of thiscode cannot be changed. i.e. this code cannot simply be copied and put under anotherdistribution licence [including the GNU Public Licence.]

Apache and Apache TomcatThis product includes software developed by The Apache Group for use in the ApacheHTTP Server project (http://www.apache.org/).

This product includes software developed by Greg Stein <[email protected]> for use in themod_dav module for Apache (http://www.webdav.org/mod_dav/).

xviii Version 1.2

This product includes software derived from software developed by Henry Spencer.

This product includes software derived from the RSA Data Security, Inc. MD5Message-Digest Algorithm.

Portions of certain components of the Program are copyrighted by MERANT, 1991-1999.

xix

xx Version 1.2

Introduction

Tivoli Kernel Services commands enable you to perform system operations from a commandline interface (CLI) instead of using the Tivoli Console. This is useful when you don’t haveaccess to a graphical display, such as when executing commands over a dial-up connection,or when creating scripts that submit commands.

This chapter describes the organization of the information in this book, explains theCommand Line Interface (CLI) and syntax for Tivoli Kernel Services commands, andexplains how to create user accounts using the CLI.

How This Book is OrganizedThe commands in this document are presented alphabetically, by bundle name. In thiscontext, a bundle is a software object that implements the behavior of commands for a givencomponent. Table 1 shows the bundle names associated with the various components. In thetable, components and services are listed alphabetically. The corresponding bundle name isshown in the right-most column.

Table 1. Mapping Components and Services to Bundle NamesComponent/Service Commands Bundle Name

Access Manager Commands accmgr

Authorization Cache azncache

Component Distribution Service Commands cds

Component Service Commands comp

Configuration Service Commands cfg

Depot Component Installer dci

Directory Service Commands dir

Failover Service Commands failoverAgent

Gateway IP Service Commands gatewayIPService

Gateway SNMP Service Commands gatewaySNMPService

Info Service Commands info

IP Configuration Service Commands ipConfig

Local Component Installer Commands lci

Logging Service Commands log

Messaging Service Component mserv

Messaging Service Manager msm

Network Endpoint Locator Service Commands nelService

Object Request Broker Commands orb

1

1

1.In

trod

uctio

n

Table 1. Mapping Components and Services to Bundle Names (continued)Component/Service Commands Bundle Name

Presentation Services Management ComponentRepository

psmcr

Security Service Manager Commands ssm

Serialized Persistence Service per

Service Manager svc

Thread Dumper Utility Commands dumper

Command Line SyntaxRefer to “Conventions Used in This Document” on page xiii for a description of theconventions used to illustrate commands.

All Tivoli Kernel Services commands begin with the constant wcmd. The wcmd constant isfollowed by a bundle name and bundle-specific commands. For example:

wcmd [–options] bundle_name command [command_args]

where:

–optionsMay be zero or more of the following options:

–h Displays help for wcmd commands

–i Send the command to an Object Request Broker (ORB) forprocessing. If this flag is omitted, the command is processed by thelocal ORB. The local ORB, or current ORB, is the ORBenvironment with which the CLI console is currently in session. Thisis the ORB environment established by the most recent run of thesetupEnv.sh script (Unix) or setupEnv.bat file (NT).

The following forms can be used to designate an ORB. Each form isexplained in paragraphs that follow.wcmd -i orb_oidwcmd -i orb_namewcmd -i Orb/orb_namewcmd -i namespace_name/Orb/orb_name}

-i orb_oid

orb_oid is a unique object ID, in hexadecimal, that identifies anORB. orb_oid’s are of type long and have the following form:3.orb_oid.1.namespace_id.

The integer 3 is a constant that indicates the next field contains anORB OID. The integer 1 is a constant that indicates the next fieldcontains a namespace ID. An example command using orb_oidsyntax is shown below. In this example, ORB 7 in namespace 6 isidentified as the ORB to process the command:wcmd –i 3.7.1.6 log test

2 Version 1.2

–i Orb/orb_name

Orb/ is a constant that indicates the text to the right of the slash is afriendly name for an ORB. All ORBs are uniquely identified by theirorb_oid. However, a user-friendly name can be assigned to an ORBto make it easier to refer to them. These friendly names may bethings such as a company name, a department name, the name of thegeographic area in which an ORB is installed, and so on. ORBnames are to orb_oids as DNS names are to IP addresses. A samplecommand using an ORB name is shown below. If this command wasentered at the console of an ORB named Raleigh, the –iOrb/Austin entries would cause the log test command to be runin the ORB named Austin:wcmd –i Orb/Austin log test

This notation can be used to identify ORBs that exist in the samenamespace as the ORB from which the command is issued. If thetargeted ORB exists in a different namespace, you must identify theORB using its OID or by using the namespace syntax shown below.

–i orb_name

orb_name can also be specified without the Orb/ constant. Forexample, wcmd –i Orb/Austin log test could also be entered aswcmd –i Austin log test. This notation can be used to identifyORBs that exist in the same namespace as the ORB from which thecommand is issued. If the targeted ORB exists in a differentnamespace, you must identify the ORB using its orb_oid or by usingthe namespace syntax shown below.

–i namespace_name/Orb/orb_name

namespace_name is the friendly name of a namespace and orb_nameis the friendly name of an ORB. This method of identifying an ORBprovides a friendly means to specify a fully-qualified ORB name.The following example shows a fully-qualified path to an ORB usingfriendly names. In this example, the ORB named London resides inthe UK namespace:wcmd –i UK/Orb/London log test

–k Print a stack trace on caught exceptions.

–o port_numberport_number indicates the number of the port used to connect to thelocal ORB. The default port number is 9990. A non-default value isspecified either by using the –o option or by setting the environmentvariable named TMOSCLI_PORT. The –o option overrides a valueset by the environment variable.

–u user_name The –u option is used to perform remote administration functions. Ifincluded, the user_name specified will be used to authenticate theuser in the remote node. A prompt is displayed to enter the passwordassociated with user_name if the –f option is not specified.

3

1.In

trod

uctio

n

–f The –f option indicates the password is to be read from a file. Forexample,wcmd -u username -f pwlist

obtains the password for the user from a file named pwlist. Usethis with discretion because there is no security on the filecontaining the password.

–z The –z option displays the version number of the wcmd CLI.

bundle_nameRefers to the name registered for the CLI bundle. See Table 1 for a list of bundlenames. The service or component associated with the bundle must be started in theORB that is to process the command. The ORB to process a command is determinedby the presence or absence of the wcmd –i option, which is described above.

commandIdentifies a command in the CLI bundle.

command_argsSpecifies what is to be passed as arguments to the CLI bundle.

Note: Many Tivoli Kernel Services commands either allow or require an argumentthat identifies the namespace, ORB set, or ORB the command is to affect.The syntax used to specify these identifiers can be any of the formats shownabove in the list of wcmd –i options. When a namespace, ORB set, or ORBis specified on the command line as an argument after the bundle name, thename is specified as shown above, but without the –i flag. The examplesbelow use the wcmd info getProperties command to illustrate the waynamespaces, ORB sets, and ORBs are identified in command arguments. If anunqualified name is entered as an argument, it is assumed to be the name of anamespace. Qualify ORB set and ORB names by prefacing the name with theconstant Orbset/ or Orb/, respectively. When commands target objects in thesame namespace, the namespace name is optional.

To get the properties of any info object using a numeric OID to identify theobject, use the following format. Numeric object IDs are unique within aTivoli Kernel Services installation; using a numeric OID on a commandobviates the need for any additional qualifiers.

wcmd info getProperties oid

To get the properties of a namespace using the namespace’s name to identifythe object representing the namespace, use the following command.

wcmd info getProperties namespace

To get the properties of an ORB set, use the following command.

wcmd info getProperties [namespace/]Orbset/orbset_name

To get the properties of an ORB, use the following command.

wcmd info getProperties [namespace/]Orb/orb_name

4 Version 1.2

Case SensitivityTivoli Kernel Services commands are generally not case sensitive. Commands in thisdocument are shown in camelBack notation to make them easier to read. However, youshould be able to enter the command using any combination of upper and lowercase letters.key=value pairs, the names of services and components, and path and file names are anexception to the ″any case″ convention. Service and component name; key names, and theirassociated values; and directory path and file names entered on operator commands representthe names of data stored within Tivoli Kernel Services directories and databases. Because ofthis, these entries must reflect the letter case of the objects as they are stored in theappropriate directories and databases. Operator commands are provided to display a list ofservice and component names, keys, values, and directories used in your Tivoli KernelServices installation. For example, in the following command, all syntax to the right of thecommand name localAvail is case sensitive because the name of the failover agent serviceis stored as failoverAgent and the key named interval is defined in the configurationdata in lowercase.wcmd accmgr localAvail -s failoverAgent -p interval=600

Similarly, in the following command, the path specified (/com/tivoli/util/logging/message)must be in the same case it as it is stored in the configuration service.wcmd cfg children /com/tivoli/util/logging/message

Getting Help for CommandsHelp text is available for Tivoli Kernel Services commands and can be displayed using anyof the following methods:

¶ wcmd bundle_name [help | list | usage]

These options display general usage information for commands in the bundle. Forexample, to display general help for the Access Manager command bundle, use any ofthe following commands:

v wcmd accmgr help

v wcmd accmgr list

v wcmd accmgr usage

Help for individual commands within a bundle can be displayed using the following syntax:

¶ wcmd [–options] bundle_name command –help

For example, to get help for the Access Manager getService command, use the followingsyntax:

v wcmd accmgr getservice –h

Note: Not all of the Tivoli Kernel Services command interfaces support all three forms ofonline help (list, usage, –h[elp]). If one form of online help doesn’t work for abundle, try one of the other forms.

Return CodesTivoli Kernel Services command return the following codes when commands are processedand executed. Script writers can use these return codes to control the operation of commandscripts. The codes shown below are common to all components and services. Exceptions tothese shared codes, if any, are documented on the individual pages describing a command.

5

1.In

trod

uctio

n

ReturnCode

Description

0 OK. The command completed without error. No operator action is required.

1 Usage. A syntax error was detected when the command input was parsed. Verify thesyntax and retry the command.

2 Not found. A component or service with the specified properties or version was notfound. The error could be due to a typographical error. Verify the syntax and spellingof all arguments and retry the command. If the target is still not found, this indicatesthe object with the desired attributes is not installed.

3 Security Failure. The administrator or account issuing the command is not authorizedto use it.

4 Command exception. An error occurred within the command line interface code. Retrythe command. If the condition persists, contact your Tivoli support analyst.

5 The command failed.

Security Implications for wcmd CommandsThe person issuing a wcmd command must be identified in the security registry of TivoliKernel Services and must be authorized to perform the tasks requested.

Tivoli Kernel Services identifies the wcmd user in one of two ways:

¶ Explicitly, by using the value specified in the –u user_name option on the wcmd itself.

¶ Implicitly, by checking the security registry for an account mapping to the fully-qualifiedhost name and user ID of the user issuing the wcmd command if the –u option is notused.

If the user is not defined in the security registry, or is defined in the registry but lacks theproper authority to perform the requested function, the command fails.

Tivoli Kernel Services ships with the following set of default user IDs and passwords.

User ID Default Password

superadmin password

sysadmin password

installer password

You can choose to always include the –u option on the wcmd commands, or you can definean account in the security registry that maps to the user ID and fully-qualified host namefrom which you will issue wcmd commands. This can be defined using the Tivoli Consoleor with a series of wcmd commands. To create accounts using the Tivoli Console, seeIntroducing Tivoli Kernel Services Administration.

How to Create an Account Using wcmd CommandsThe ssm command bundle is used to create an account for a given user ID and host name.You will need the proper authority to initially issue these commands. The examples belowuse superadmin to illustrate this.

The first step is to create a new user in the security registry with the appropriate authority todo the tasks required. This is done with the wcmd ssm crtInstance command:

6 Version 1.2

wcmd -u superadmin ssm crtInstance -p "<path/user name>" -oc "Person"staticRole="<any role you wish to specify>"sn=<surname> isEnabled=true

The second step is to create an account for the host operating system, either an NTAccountor a UNIXAccount, mapping the user ID and host name to the user created in the securityregistry. This is also done with the wcmd ssm crtInstance command:wcmd -u superadmin ssm crtInstance -p <path/userid>

-oc NTAccount|UNIXAccountsignOnTarget=system/services/signOnTargets/KernelServiceprincipal="<path/user name>" host=<hostname>

For instance, to give the following user access to issue wcmd commands:

host system Windows 2000

host user ID cjones

hostname bigcheese.someplace.com

Tivoli Kernel Services user name Charlie Jones

role System Administrator

First, issue the following command, all on one line, to create a user called Charlie Jones inthe security registry with the role of system administrator:wcmd -u superadmin ssm crtInstance -p "system/administrators/Charlie Jones"

-oc "Person" staticRole="system/roles/System Administrator" sn=JonesisEnabled=true

Second, issue the following command, all on one line, to create an account mapping user IDcjones on host bigcheese.someplace.com to the Tivoli Kernel Services user name ofCharlie Jones:wcmd -u superadmin ssm crtInstance -p system/accounts/cjones -oc "NTAccount"

signOnTarget=system/services/signOnTargets/KernelServiceprincipal="system/administrators/Charlie Jones"host=bigcheese.someplace.com

Note: Hostname requirements

In most cases, the name specified for ″host″ on the wcmd ssm crtInstance commandshould be the fully-qualified host name. To determine what should be specified forhost in your configuration, use the following commands to obtain a list of host namesfor the current ORB. (The list may contain more than one name if it is a multi-homedmachine.)

The wcmd info getOrbs command shown below returns the numeric OID for thecurrent ORB. Record the numeric OID and use it as the argument for the nextcommand: wcmd info getProperties.wcmd -u superadmin info getOrbs -oid3.c882dd192c19559e.1.6ac3aabc63f1a6b5 (bigcheeze.someplace.com_9990)

Use the following command and supply the numeric OID of the ORB obtained fromthe previous command as an argument. The output from this command will displaythe host name to use on the ″host″ argument to the ssm crtInstance command.wcmd -u superadmin info getProperties 3.c882dd192c19559e.1.6ac3aabc63f1a6b5jvmInfo = J2RE 1.2.2 IBM build cn122-20000915 (JIT enabled: jitc)osname = Windows 2000port = 9990

7

1.In

trod

uctio

n

priIPAddr = 116.85.149.90modTime = 973628092069createTime = 973031499977priHostName = bigcheeze.someplace.comoid = 3.c882dd192c19559e.1.6ac3aabc63f1a6b5hostNames = bigcheeze.someplace.com <<<< use this hostnameosarch = x86type = serverosver = 5.0name = bigcheeze.someplace.com_9990componentFullVersion = 5.1.0-200010301829region = DefaultRegionipAddrs = 116.85.149.90

Once this is done, wcmd commands can be issued on this machine without explicitlyspecifying the –u option on each command.

Font and Code Page Requirements for CLI SessionsEuropean-language versions of Windows that use accented characters need a code pagedefined and a true type font associated with any command prompt windows beforecommand output can be correctly displayed.

Open a command prompt window and perform the following steps.

1. Change the font property for the window from Raster Fonts to Lucida Console.

2. Set the active code page to 1252 by entering chcp 1252.

Note: The font change can be made persistent if it is applied by entering cmd.exe in theStart→Run dialog box if you select the option to Save properties for futurewindows with same title when you apply the font properties. However, the activecode page will revert back to the default code page for the operating system when theserver is restarted and the command to change the code page (chcp 1252) will need to be run in a command prompt window after each restart.

8 Version 1.2

Access Manager

Access manager commands enable administrators to start, stop, and display informationabout Tivoli Kernel Services components and services. Most commands return informationonly if the component or service specified on the command line is installed and running inan ORB. Access manager commands use the bundle name accmgr.

Note: See “Conventions Used in This Document” on page xiii for a description of thesyntax requirements and notations used in this document.

2

9

2.A

ccessM

anag

er

wcmd accmgr getComponentDisplays components installed and running in the local ORB.

Syntaxwcmd accmgr getComponent [-c name] [-v version]

DescriptionThe wcmd accmgr getComponent command returns a list of components installed andrunning on the local ORB. You can get all components, get a component by name, or get acomponent by name and version number.

Options-c name

Specifies a component name. If a component name is not specified, the commandreturns a list of all components installed and running in the local ORB.

-v versionSpecifies a component version number. If a version is not specified, the system willdecide which version to return.

AuthorizationNo authorization required.

ExamplesTo display information about the timesync component running on the local ORB, use thefollowing syntax. If the component is installed and running, the command returns the nameand version of the component:wcmd accmgr getComponent -c timesyncComponent timesync version 5.1.1-200010242301

See Alsowcmd accmgr stopComponent

accmgr getComponent

10 Version 1.2

wcmd accmgr getServiceDisplays a service that matches specified criteria.

Syntaxwcmd accmgr getService {[–i orb_oid] | [–p key=value]... –s name [–v version]}

DescriptionThe wcmd accmgr getService command displays a running service that matches the criteriaspecified on the command. You can target a service based on its name, version, andproperties.

Options–i orb_oid

Identifies an ORB using the syntax described in “Command Line Syntax” on page 2.This option returns services matching the specified criteria if that service is runningon the ORB identified by orb_oid. Do not use -i orb_oid if you specify -p.

–p key=valueSpecifies the properties the service must possess. Multiple properties can bespecified by prefacing each property key=value pair with a -p flag, and separatingeach property field with spaces. See Examples.

–s nameSpecifies the name of a service; required.

–v versionSpecifies a version of the service identified by name.

AuthorizationRequires retrieve_service access to system/services/serviceManager.

Examples1. To retrieve a service by name, use the following syntax:

wcmd accmgr getService -s name

For example, to retrieve information about the slash service, use the following syntax. Ifthe service is installed and running, the command returns the version and name of theservice.wcmd accmgr getService -s slashslash version 5.1.0-200011122241

2. To retrieve a service by name and properties, use the following syntax:wcmd accmgr getService -s service_name -p color=blue -p speed=fast

3. To retrieve a service by name, version, and ORB name, use the following syntax:wcmd accmgr getService -s name -v version -n orb_name

See Alsowcmd accmgr listServices, wcmd accmgr getServices

accmgr getService

11

2.A

ccessM

anag

er

wcmd accmgr getServicesDisplays services running in any ORB that match the specified criteria.

Syntaxwcmd accmgr getServices –s name [–p key=value]... [-v version]

DescriptionThe wcmd accmgr getServices command returns a list of services running in any ORB thatmatch the specified criteria. You can target services based on their names, versions, orproperties.

Options–p key=value

Specifies the properties the service must possess. Multiple properties can bespecified by beginning each key=value pair with a -p flag and separating eachproperty field with spaces.

–s nameSpecifies the name of a service.

–v versionSpecifies a version of the service identified by name.


ExamplesTo display information about the ComponentDistributionService, use the following syntax:wcmd accmgr getServices -s ComponentDistributionServiceComponentDistributionService version 5.1.0-200011122241

See Alsowcmd accmgr getServices, wcmd accmgr listServices

accmgr getServices

12 Version 1.2

wcmd accmgr listServicesDisplay a list of services installed in an ORB.

Syntaxwcmd accmgr listServices [-i orb_oid]

DescriptionThe wcmd accmgr listService command returns a list of services installed, but notnecessarily started, in an ORB.

Options–i orb_oid

Identifies an ORB using the syntax described in “Command Line Syntax” on page 2.If omitted, the command returns a list of services installed in the local ORB.


Exampleswcmd accmgr listServicesdsm version 5.1.1-200011122241SDSRemoteService version 5.1.0-200011122241slash version 5.1.0-200011122241CliService version 5.1.0-200011122241DomainBuilder version 5.1.0-200011072259AuthenticationService version 5.1.0-200011122241ComponentDistributionService version 5.1.0-200011122241RemoteAuthenticationService version 5.1.0-200011122241NetSecurityService version 5.1.0-200011122241logging version 5.1.1-200011122241MetaTes version 5.1.1-200011122241dirservice version 5.1.0-200011122241SecurityDirectoryService version 5.1.0-200011122241PndScheduler version 5.1.0-200011122241SecurityCacheService version 5.1.0-200011122241

See Alsowcmd accmgr startService, wcmd accmgr stopService

accmgr listServices

13

2.A

ccessM

anag

er

wcmd accmgr localAvailDetermines if a service is available on the local ORB.

Syntaxwcmd accmgr localAvail -s name {[-i orb_oid] | [-p key=value...]} [-v version]

DescriptionThe wcmd accmgr localAvail command determines if a service is installed and running onan ORB. The command outputs true if the service is installed and running and false if itisn’t.

Options–i orb_oid

Identifies an ORB to be examined. Use the syntax described in “Command LineSyntax” on page 2. If omitted, the running services in the local ORB are examined.Do not use -i orb_oid if you specify -p.

–p key=valueSpecifies the properties the service must possess. Multiple properties can bespecified by beginning each key=value pair with a -p flag, and separating eachproperty field with spaces.

-s nameSpecifies the name of the service.

-v versionSpecifies a version of the service identified by name. If a version is not specified,the system returns true if any version of the named service is available.


ExamplesTo determine if the Failover service is available in the local ORB and has an key definingthe time interval between component queries set to 600 seconds, use the following syntax:wcmd accmgr localAvail -s failoverAgent -p interval=600TRUE

The command returns FALSE if the specified service is not installed and running:wcmd accmgr localAvail -s timesyncFALSE

See Alsowcmd accmgr remoteAvail

accmgr localAvail

14 Version 1.2

wcmd accmgr remoteAvailDetermines if a service is available in a remote ORB.

Syntaxwcmd accmgr remoteAvail -i orb_oid -s name [-p key=value...] [-v version]

DescriptionDetermines if a service is installed and running in a remote ORB. The command outputstrue if the service is installed and running and false if it isn’t.

Options–i orb_oid

Identifies an ORB to be examined. Use the syntax described in “Command LineSyntax” on page 2. If omitted, the running services in the local ORB are examined.Do not use -i orb_oid if you specify -p.

–p key=valueSpecifies the properties the service must possess. Multiple properties can bespecified by beginning each key=value pair with a -p flag, and separating eachproperty field with spaces.

-s nameSpecifies the name of the service.

-v versionSpecifies a version of the service identified by name. If a version is not specified,the system returns true if any version of the named service is available.


Examples1. To determine if any version of the slash service is installed an running in a remote ORB,

use the following syntax:wcmd accmgr remoteAvail -s slashTRUE

2. To determine if a specific version of the slash service is installed and running on aremote ORB, use the following syntax:wcmd accmgr remoteAvail -s slash -v 5.1.5FALSE

See Alsowcmd accmgr localAvail

accmgr remoteAvail

15

2.A

ccessM

anag

er

wcmd accmgr startComponentStarts the specified component.

Syntaxwcmd accmgr startComponent -c name [-v version]

DescriptionThe wcmd accmgr startComponent command starts the specified component.

Options-c name

Specifies the name of the component to be started.

-v versionSpecifies the version of the component to be started. If version is omitted, thesystem decides which version to start.

AuthorizationRequires write access to system/services/ComponentManager.

ExamplesTo start the timesync component, without specifying a specific version, use the followingsyntax:wcmd accmgr startComponent -c timesyncStart has been called on component timesync version null

See Alsowcmd accmgr stopComponent, wcmd accmgr startService,

accmgr startComponent

16 Version 1.2

wcmd accmgr startServiceStarts the specified service.

Syntaxwcmd accmgr startService -s name [-v version]

DescriptionThe wcmd accmgr startService command starts the specified service.

Options-s name

Specifies the name of the service to be started.

-v versionSpecifies the version of the service to be started. If version is omitted, the systemwill decide which one to start.


ExamplesTo start version 5.1.0 of the Network Security Service, use the following syntax:wcmd accmgr startService -s NetSecurityService -v 5.1.0Start has been called on service NetSecurityService version 5.1.0

See Alsowcmd accmgr stopService, wcmd accmgr startComponent,

accmgr startService

17

2.A

ccessM

anag

er

wcmd accmgr stopComponentStops the specified component.

Syntaxwcmd accmgr stopComponent -c name [-v version] [–f]

DescriptionThe wcmd accmgr stopComponent command stops the specified component.

Options-c name

Specifies the name of the component to be stopped.

–f Forces the component to shut down. Use this with caution because most componentsare designed to ordinarily reject a stopComponent command while they are not idle.Data loss and significant disruption may occur.

-v versionSpecifies the version of the component to be stopped. If version is omitted, thesystem will decide which one to stop.


ExamplesTo stop version 5.1.1 of the the timesync component, use the following syntax:wcmd accmgr stopComponent -c timesync -v 5.1.1Stop has been called on component timesync version 5.1.1

See Alsowcmd accmgr startComponent, wcmd accmgr stopService

accmgr stopComponent

18 Version 1.2

wcmd accmgr stopServiceStops the specified service.

Syntaxwcmd accmgr stopService -s name [-v version]

DescriptionThe wcmd accmgr stopService command stops the specified service.

Options-s name

Specifies the name of the service to be stopped.

-v versionSpecifies the version of the service to be stopped. If version is omitted, the systemdecides which one to stop.


ExamplesTo stop version 5.1.0 of the Network Security Service, use the following syntax:wcmd accmgr stopService -s NetSecurityService -v 5.1.0Stop has been called on service NetSecurityService version 5.1.0

See Alsowcmd accmgr startService, wcmd accmgr stopComponent

accmgr stopService

19

2.A

ccessM

anag

er

accmgr stopService

20 Version 1.2

Authorization Cache

Tivoli Kernel Services security evaluates authorization requests at each of the ORBs in theinstallation. These authorization requests require information that is stored in the securityregistry. To improve the performance of the authorization process, the number of trips madeto the security registry is reduced by caching the authorization information at each of theORBs throughout the Tivoli Kernel Services installation. The Authorization Cache (AZNcache) can be configured into a hierarchy in which the security registry is the root of thecache hierarchy. The default installation for Tivoli Kernel Services configures each of theAZN caches to connect to the Installation Depot where the security registry resides. This canbe modified using configuration parameters to build a n-tierd hierarchy of cachedauthorization information.

When the authorization cache is configured as n-tiered hierarchy, it uses configurationparameters like PRIMARY_PARENT and BACKUP_PARENT to connect to its parentcache. The cache first tries to connect to its primary parent, and if it can not, it tries toconnect to its backup parent. Other configurable parameters for the cache include aCAPACITY key, which indicates how many entries the cache can hold. A capacity of 0indicates there are no limits on the number of cached entries.

AZN cache commands perform diagnostic operations on the authorization cache, determinehow the AZN caches are connected, and clear a cache. All Authorization cache commandshave the bundle name azncache. All azncache commands, by default, operate on the cache inthe local ORB. To target a cache on another ORB, provide the identity of the remote ORBusing the syntax described under the wcmd command’s –i option. See “Command LineSyntax” on page 2.


3

21

3.A

uth

orizatio

nC

ache

wcmd azncache clearClears all data from the cache.

Syntaxwcmd azncache clear

DescriptionThe wcmd azncache clear command removes all data from the authorization cache.Subsequent authorization request will go to their parent cache for authorization information.Clearing the cache should not be necessary in day-to-day operations because changes toauthorization information in the security registry will clear stale data from the caches.

OptionsNone.

AuthorizationRequires referent access right=execute on system/services/security/wcmds.

Exampleswcmd azncache clearCache is cleared!!!

azncache clear

22 Version 1.2

wcmd azncache dumpReturns the identity of all authorization objects in the cache, along with their values.

Syntaxwcmd azncache dump

DescriptionThe wcmd azncache dump command displays all authorization objects in the cache andtheir values.

OptionsNone.


ExamplesThe following shows output from this command.wcmd azncache dumpDataMap:{PATHNAME: system/services/orb=roleToRBM({1103=1, 599=0})artoRBM({QUERY={0, 1}, CONTROL={0, 1}}),AZN_MBA_DEF: system/services/security/MBADefs/com/tivoli/core/failover/server/FailoverService=Methods of Class:com.tivoli.core.failover.server.FailoverService resTypeName=FailoverpathName=system/services/security/MBADefs/com/tivoli/core/failover/server/FailoverServiceftComponentFailed(com.tivoli.core.failover.server.FTMessage) ==> executeftComponentStarted(com.tivoli.core.failover.server.FTMessage) ==> executegetAllMonitoredObjects() ==> readgetSecurityIdentity() ==> readshutdownFTObject(java.util.Hashtable) ==> executestartedFTObject(java.util.Hashtable) ==> execute,PATHNAME: system/services/serviceManager=roleToRBM({1103=1, 1087=2, 599=0})artoRBM({UPDATE_SERVICE={0, 1}, RETRIEVE_SERVICE={0, 1, 2}}),PATHNAME: system/services/signOnTargets/KernelService=roleToRBM({1103=2,599=0, 595=1}) artoRBM({INSTALL={0, 1, 2}}),PATHNAME: system/services/directory=roleToRBM({1103=1, 1087=4, 599=0, 756=2,753=3}) artoRBM({WRITE={0, 1, 2, 3}, READ={0, 1, 2, 3, 4}, PRIVILEDGED={2},CFGINTODIRECTORY={2, 3}}),PATHNAME: system/services/ComponentManager=roleToRBM({1103=1,599=0})artoRBM({WRITE={0, 1}, READ={0, 1}}),PATHNAME: system/services/security/wcmds=roleToRBM({740=0}) artoRBM({EXECUTE={0}}),PATHNAME: system/services/config=roleToRBM({1103=1, 1087=2, 599=0}) artoRBM({WRITE={0, 1, 2},READ={0, 1, 2}})}AgeList(latest to oldest):[PATHNAME: system/services/security/wcmds,AZN_MBA_DEF: system/services/security/MBADefs/com/tivoli/core/failover/server/FailoverService,PATHNAME: system/services/config,PATHNAME: system/services/serviceManager,PATHNAME: system/services/ComponentManager,PATHNAME: system/services/directory,PATHNAME: system/services/signOnTargets/KernelService,PATHNAME: system/services/orb]

See Alsowcmd azncache keys

azncache dump

23

3.A

uth

orizatio

nC

ache

wcmd azncache getCapacityReturns the capacity of the cache.

Syntaxwcmd azncache getCapacity

DescriptionThe wcmd azncache getCapacity command returns the number of entries allowed in thecache. If the command returns zero (0), there are no limits on the size of the cache. Thecache’s capacity can be set using the wcmd cfg put command.

OptionsNone.

AuthorizationNo authorization is required.

Exampleswcmd azncache getCapacityCapacity of the cache is: 1,000

azncache getCapacity

24 Version 1.2

wcmd azncache getParentIDReturns the OID of the ORB containing the hierarchical parent cache to the authorizationcache in the current ORB.

Syntaxwcmd azncache getParentID

DescriptionThe wcmd azncache getParentID command returns the ORB OID of the actual parentcache, primary or backup, being used by the cache in the current ORB.

OptionsNone.


Exampleswcmd azncache getParentIDOrb ID of the parent cache is:3.becc915e28e03578.1.ddef13a74060b12d

See Alsowcmd azncache getPrimaryParentID

azncache getParentID

25

3.A

uth

orizatio

nC

ache

wcmd azncache getPrimaryParentIDReturns the ID of the ORB configured as the the primary parent for the current ORB’sauthorization cache.

Syntaxwcmd azncache getPrimaryParentID

DescriptionThe wcmd azncache getPrimaryParentID command returns the cache configured as theprimary parent. The actual, or hierarchical, parent may be different than the primary parent.

OptionsNone.


Exampleswcmd azncache getPrimaryParentIDOrb ID of the primary parent cache is:3.becc915e28e03578.1.ddef13a74060b12d

See Alsowcmd azncache getParentID

azncache getPrimaryParentID

26 Version 1.2

wcmd azncache keysReturns the identity of all authorization objects in the cache, without values.

Syntaxwcmd azncache keys

DescriptionThe wcmd azncache keys command displays the identity of all authorization objects in thecache. The command returns either object identifiers or the pathname of the object in thecache.

OptionsNone.


Exampleswcmd azncache keys[PATHNAME: system/services/orb,AZN_MBA_DEF:system/services/security/MBADefs/com/tivoli/core/failover/server/FailoverService,PATHNAME:system/services/serviceManager,PATHNAME: system/services/directory,PATHNAME: system/services/ComponentManager,AZN_MBA_DEF:system/services/security/MBADefs/com/tivoli/core/failover/agent/FailoverAgent,PATHNAME: system/services/ComponentManagerInternal,PATHNAME:system/services/config]

See Alsowcmd azncache dump

azncache keys

27

3.A

uth

orizatio

nC

ache

wcmd azncache listCacheChildrenReturns the ID of the ORB or ORBs containing the current ORB’s child authorization cache.

Syntaxwcmd azncache listCacheChildren

DescriptionThe wcmd azncache listCacheChildren command returns the ORB OID of this cache’schildren.

OptionsNone.


ExamplesThe following output shows the cache in the local ORB has one child cache:wcmd azncache listCacheChildrenCache, 3.becc915e28e03578.1.ddef13a74060b12d, has 1 children. The children IDsare:

3.7dfbdddbcf585dc2.1.ddef13a74060b12d

Cache, 3.7dfbdddbcf585dc2.1.ddef13a74060b12d, has no children.

See Alsowcmd azncache tracePathToRoot

azncache listCacheChildren

28 Version 1.2

wcmd azncache tracePathToRootReturns the ORB OIDs of all ORBs in the authorization cache hierarchy, between thecurrent ORB and the ORB containing the root cache.

Syntaxwcmd azncache tracePathToRoot

DescriptionThe wcmd azncache tracePathToRoot command displays the ORB OIDs between thiscache and the root cache. The root cache is connected to the SecurityDirectoryService whichin turn talks to the security registry. This command makes calls up the hierarchy of cachesand can be used to determine if calls can be made all the way back to the root.

OptionsNone.


ExamplesThe following shows the output of this command. In this example, the current ORB isidentified by the OID of 3.7dfbdddbcf585dc2.1.ddef13a74060b12d. The bottom-most ORBshown in the output is the ORB containing the root cache.wcmd azncache tracepathtorootFollowing is a list of cache connected to the cache, 3.7dfbdddbcf585dc2.1.ddef13a74060b12d,with the bottom most orb being the last connected.

Cache Orb ID is:3.7dfbdddbcf585dc2.1.ddef13a74060b12dCache Orb ID is:3.becc915e28e03578.1.ddef13a74060b12d

See Alsowcmd azncache listCacheChildren

azncache tracePathToRoot

29

3.A

uth

orizatio

nC

ache

azncache tracePathToRoot

30 Version 1.2

Component Distribution Service

The Component Distribution Service (CDS) commands install and deploy components in aTivoli Kernel Services installation. CDS commands have the bundle name cds.

Note: Most cds commands accept the names of components and ORBs or ORB sets asarguments. ORBs and ORB sets can also be identified by their hexadecimalidentifiers. Component names, ORB names, and ORB set names are case sensitive.Commands entered with incorrect capitalization of a component name may simplyreturn a blank line with no error indication. Incorrectly capitalized ORB or ORB setnames will produce an error indication stating: No CLI server found for ORBorb_name.

Component names are generally expressed as versioned component names having the form:name@version. Version 5.1.0 of the LocalComponentInstaller, for example, would bespecified on the command line as: [email protected].

ORB and ORB set names or identifiers can take any of the forms shown for ORBs andORB sets as outlined in the descriptions of syntax for ORBs and ORB sets in“Configuration” in the discussion of resources.

The term installation depot refers to a repository of Tivoli Kernel Services software andapplications that can be deployed (distributed) to any ORB in the Tivoli Kernel Servicesinstallation. The term component depot refers to a repository of Tivoli Kernel Servicessoftware and applications specific to the ORBs served by a component depot. A componentdepot downloads the jar files needed by the ORBs it serves from a Tivoli Kernel Servicesinstallation depot. Once in a component depot, component distribution services commandscan be used to determine prerequisites, display characteristics, and deploy components toORBs serviced by the component depot.

CDS commands can take some time to complete. Commands related to installation,deployment, and upgrade and rollback operations display messages indicating the operation’sprogress. These messages are listed in the table below.

Message Meaning

Action aborted. Check log for details. The action was aborted due to some error. Theerror is described in the log.

4

31

4.C

om

po

nen

tD

istribu

tion

Service

Message Meaning

X of Y tasks complete Where Y is the total number of tasks required tocomplete the action and X is the number of taskscompleted so far. The total number of tasks mayincrease as they are identified. This usuallyoccurs as prerequisite components are identified.The total number is not known when thecommand commences since a component has tobe at least partially installed to know itsprerequisites.

Action completed. The operation completed successfully.

The Component Distribution Service normally runs on an installation depot. If you need todeploy a component from an ORB that does not have the Component Distribution Servicerunning on it, use the wcmd –i option to specify the name or OID of the installation depot.See “Command Line Syntax” on page 2 for a description of the –i flag.


32 Version 1.2

wcmd cds deployMakes a component available to run on a specific ORB or ORB set.

Syntaxwcmd cds deploy name@version {orb | orbset}

DescriptionThe wcmd cds deploy command is used to deploy a specific version of a component to aparticular ORB or ORB set. Once deployed, the component can be run on the ORB or ORBset.

Optionsname@version

Specifies the name and version of the component to be deployed, expressedas componentName@versionLevel.

orb Specifies the name or hexadecimal OID of an ORB using any of thesyntaxes shown in the description of “resource” on page 55.

orbset Specifies the name or hexadecimal OID of an ORB set using any of thesyntaxes shown in the description of “resource” on page 55.

NotesThis command provides a progress indication in the form X of Y tasks completed.Component actions happen in two parts: synchronous and asynchronous. Progress isindicated only for the synchronous part. This is where the goals for the system are calculatedand set. The second part involves different parts of the system independently noticing thechange in their goals and attempting to meet those goals. In a large enough system there willalways be some necessary system that is down, just removed, or just added. In this case, nocomponent action will ever fully complete the asynchronous portion of a component action.As such, progress indication of the asynchronous portion does not have the usual meaning.

Another definition for when a deployment is complete is when the versioned componentactually begins running on an ORB. A runAutomatically flag can be set to start thecomponent after it is deployed. The best way to confirm that a component is running is totry to use it. If the component is not “runAutomatically”, attempt to run the versionedcomponent’s basicTest method.

AuthorizationRequires install access to system/services/signOnTargets/KernelService

Examples1. To deploy Version 5.1.0 of a component named LocalComponentInstaller on ORB

3.aceb384066ef9239.1.c46b9bf74dd9327e, use the following syntax:wcmd cds deploy [email protected] 3.aceb384066ef9239.1.c46b9bf74dd9327e

2. To deploy Version 5.1.12 of a component named SnmpData on an ORB set having anOID of 2.d3b096df447cef5f.1.2c27b7076f1e5965, use the following syntax:wcmd cds deploy [email protected] 2.d3b096df447cef5f.1.2c27b7076f1e5965

3. To deploy a component from an installation depot to another ORB from the currentORB, use the following syntax. In this example, assume the command is entered on the

cds deploy

33

4.C

om

po

nen

tD

istribu

tion

Service

console of an ORB named raleigh.tivoli.com. The logging component, version 5.1.1, isbeing deployed from an installation depot ORB (id.tivoli.com) to an ORB namedaustin.tivoli.com:wcmd -i Orb/id.tivoli.com cds deploy [email protected] Orb/austin.tivoli.com

1 of 4 tasks complete2 of 4 tasks complete3 of 4 tasks complete4 of 4 tasks completeAction completed.

The syntax shown above could also be used to deploy a component from an installationdepot to an ORB set by changing Orb/ to Orbset/, and specifying the name of an ORBset instead of the austin.tivioli.com ORB.

See Alsowcmd cds retract, wcmd cds install

cds deploy

34 Version 1.2

wcmd cds getInstallationDepotDisplays the ORB set OID of the installation depot.

Syntaxwcmd cds getInstallationDepot

DescriptionThe wcmd cds getInstallationDepot command is used to determine the hexadecimal OID ofthe installation depot ORB set. The command returns the OID to use when deploying acomponent to the installation depot ORB set.

OptionsNone.


Examples1. To display the hexadecimal OID of the installation depot of the current ORB, use the

following syntax:wcmd cds getInstallationDepot

2.6e818042d890606.1.d504b638474c9c91

2. To display the hexadecimal OID of the installation depot of a different ORB, use thefollowing shown below. In this example, assume the command is entered from theconsole on the console of an ORB named raleigh.tivoli.com. The command returns thehexadecimal OID of the installation depot used by the ORB named austin.dev.tivoli.com:wcmd -i Orb/austin.dev.tivoli.com_9990 cds getInstallationDepot

2.7c82b61740ee4697.1.738333927ee26b47

See Alsowcmd cds deploy

cds getInstallationDepot

35

4.C

om

po

nen

tD

istribu

tion

Service

wcmd cds installInstalls a component in the Tivoli Kernel Services installation. Installing a component makesthe installation aware of the component and is a prerequisite action before deploying thecomponent to an ORB or ORB set.

Syntaxwcmd cds install name@version rootSourceURL

DescriptionThe wcmd cds install command is used to install a component in a Tivoli Kernel Servicesinstallation. The component source can be a file system, for example, a CD, or the URL of aweb server that offers component files for distribution to end users. Once installed, thecomponent can deployed (using the wcmd cds deploy command) to ORBs and ORB sets inthe installation.

Optionsname@version

Specifies the name and version of the component, expressed ascomponentName@versionLevel.

rootSourceURL

Specifies the root URL (directory) under which the component .jar file isfound. This directory must contain a .toc file with entries in the formcomponentName@versionLevel=jar_file relative path. The URL can be oftype file: (file:///D:/tks/componentsToInstall/[email protected]) or type http(http://w3.tivoli.com/tks/Components/[email protected]).

CAUTION:Do not install components from the system temp directory. If you do, thecomponent jar files will be deleted and the installation will not complete.


NotesThis command provides a progress indication in the form X of Y tasks completed.Component actions happen in two parts: synchronous and asynchronous. Progress isindicated only for the synchronous part. This is where the goals for the system are calculatedand set. The second part involves different parts of the system independently noticing thechange in their goals and attempting to meet those goals. In a large enough system there willalways be some necessary system that is down, just removed, or just added. In this case, nocomponent action will ever fully complete the asynchronous portion of a component action.As such, progress indication of the asynchronous portion does not have the usual meaning.

Examples1. To install Version 5.1.1 of the SnmpData component found in the

componentserver.customer.com/Repository subdirectory, use the following syntax:wcmd cds install [email protected]://www.componentserver.customer.com/Repository

2. To install Version 5.1.0 of the LocalComponentInstaller component found in the Web file/usr/local/component, use the following syntax:

cds install

36 Version 1.2

wcmd cds install [email protected] file:/usr/local/components

3. To install Version 5.1.0 of the DomainBuilder component in a specified subdirectory, usethe following syntax:wcmd cds install [email protected] file:c:/Tivoli/components

See Alsowcmd cds install, wcmd cds isInstalled, wcmd cds uninstall

cds install

37

4.C

om

po

nen

tD

istribu

tion

Service

wcmd cds isAvailableOnIDThis command is intended for debugging purposes and should not be needed for day-to-dayoperations. The command shows whether the component named on the command line isinstalled on the Installation Depot. A component must be installed on the Installation Depotbefore it can be deployed to and run on an ORB or ORB set. If the command returns TRUE,the asynchronous part of the installation of the component is complete.

Syntaxwcmd cds isAvailableOnID name@version

DescriptionThe wcmd cds isAvailableOnID command is used to determine if the named componenthas been installed to the installation depot. This command returns a either TRUE, indicatingthe component has been installed, or FALSE, indicating it has not been installed. If thecommand returns FALSE, it is not necessarily an error; the component might not have beendistributed to the Installation Depot yet; retry the command.

Optionsname@version



NotesTo determine if a component installation is complete, issue a wcmd cds isInstalled commandnaming a component, then issue this command, specifying the component name. Bothcommands should return TRUE if the component has been successfully downloaded to theInstallation Depot and is ready for deployment.


cds isAvailableOnID

38 Version 1.2

wcmd cds isInstalledDisplays whether the specified component has been installed on the Installation Depot.

Syntaxwcmd cds isInstalled name@version

DescriptionThe wcmd cds isInstalled command is used to determine if the named component has beeninstalled on the installation depot. This command returns TRUE, indicating the componenthas been installed, or FALSE, indicating it has not been installed.

Optionsname@version



NotesTo determine if a component installation is complete, issue this command, naming acomponent, the issue a wcmd cds isAvailableOnID command that specifies the componentname. Both commands should return TRUE if the component has been successfullydownloaded to the Installation Depot and is ready for deployment.

See Alsowcmd cds install, wcmd cds isAvailableOnID

cds isInstalled

39

4.C

om

po

nen

tD

istribu

tion

Service

wcmd cds listComponentVersionsDisplays the versions of a component that are installed on the Installation Depot.

Syntaxwcmd cds listComponentVersions [–i] component_name

DescriptionThe wcmd cds listComponentVersions lists the versions of a component installed on theInstallation Depot.

Options–i Causes the output to be in a single line with each name separated by a semicolon.

component_nameSpecifies the name of a component, without the @version information.


See Alsowcmd cds listInstalledComponents

cds listComponentVersions

40 Version 1.2

wcmd cds listDeploymentTargetOrbIDsDisplays the hexadecimal ORB identifiers of the ORBs to which the specified componentcan be deployed.

Syntaxwcmd cds listDeploymentTargetOrbIDs [–i] name@version

DescriptionThe wcmd cds listDeploymentTargetOrbIDs command returns the hexadecimal ORBidentifiers of the ORBs to which the specified component can be deployed.

Options–i Causes the output to be in a single line with each name separated by a

semicolon.

name@versionSpecifies the name and version of a component, expressed ascomponentName@versionLevel.


See Alsowcmd cds listDeploymentTargetOrbNames

cds listDeploymentTargetOrbIDs

41

4.C

om

po

nen

tD

istribu

tion

Service

wcmd cds listDeploymentTargetOrbNamesDisplays the names of the ORBs to which the specified component can be deployed.

Syntaxwcmd cds listDeploymentTargetOrbNames [–i] name@version

DescriptionThe wcmd cds listDeploymentTargetOrbNames returns the names of the ORBs to whichthe specified component can be deployed.

Options–i Causes the output to be in a single line with each name separated by a

semicolon.

name@versionSpecifies the name and version of a component, expressed ascomponentName@versionLevel.


See Alsowcmd cds listDeploymentTargetOrbIDs

cds listDeploymentTargetOrbNames

42 Version 1.2

wcmd cds listInstalledComponentsDisplays the names of components, regardless of version, that are installed on theInstallation Depot.

Syntaxwcmd cds listInstalledComponents [–i]

DescriptionThe wcmd cds listInstalledComponents command displays a list of components that areinstalled on the Installation Depot.

Options–i Causes the output to be in a single line with each name separated by a semicolon.


cds listInstalledComponents

43

4.C

om

po

nen

tD

istribu

tion

Service

wcmd cds retractReverses a deploy operation.

Syntaxwcmd cds retract name@version {orb | orbset}

DescriptionThe wcmd cds retract command is used to undo a deploy operation. The ORB or ORB settargeted by this command will no longer be able to run the named component.

Optionsname@version

Specifies the name and version of the component to be retracted, expressedas componentName@versionLevel.




Examples1. To retract version 5.1.0 of the Local Component Installer from an ORB having an OID

of 3.aceb384066ef9239.1.c46b9bf74dd9327e, use the following syntax:wcmd cds retract [email protected] 3.aceb384066ef9239.1.c46b9bf74dd9327e

2. To retract version 5.1.1 of the SnmpData component from an ORB set having an OID of2.d3b096df447cef5f.1.2c27b7076f1e5965, use the following syntax:wcmd cds retract [email protected] 2.d3b096df447cef5f.1.2c27b7076f1e5965


cds retract

44 Version 1.2

wcmd cds rollbackReverses an upgrade operation.

Syntaxwcmd cds rollback name@version {orb | orbset}

DescriptionThe wcmd cds rollback command is used to undo an upgrade operation (See “wcmd cdsupgrade” on page 49). The upgraded component is restored to its previous version.

Optionsname@version

Specifies the name and version of the component to be deployed, expressedas componentName@versionLevel.




NotesThis command provides a progress indication in the form X of Y tasks completed.Component actions happen in two parts: synchronous and asynchronous. Progress isindicated only for the synchronous part. This is where the goals for the system are calculatedand set. The second part involves different parts of the system independently noticing thechange in their goals and attempting to meet those goals. In a large installation there willinevitably be some necessary system that is down, just removed, or just added. In this case,no component action will ever fully complete the asynchronous portion of a componentaction. As such, progress indication of the asynchronous portion does not have the usualmeaning.

See Alsowcmd cds upgrade

cds rollback

45

4.C

om

po

nen

tD

istribu

tion

Service

wcmd cds rollbackAllReverses one or more component upgrades on all ORBs and ORB sets or on selected ORBsand ORB sets in an installation.

Syntaxwcmd cds rollbackAll name@version... [resource...]

DescriptionThe wcmd cds rollbackAll command is used to undo an upgrade operation for one or moreversioned components on one or more ORBs or ORB sets. The versioned componentsspecified on the command are rolled back to the version previously installed.

Optionsname@version

Specifies the name and version of the component to be rolled back,expressed as componentName@versionLevel. To rollback several versionedcomponents, separate each versioned component name with a semicolon (;).

resource Specifies the name or hexadecimal OID of an ORB using any of thesyntaxes shown in the description of “resource” on page 55. To rollbackversioned components on more than one resource, separated each resourcewith a semicolon (;).



Examples1. To rollback an upgraded versioned component from all ORBs and ORB sets in an

installation, use the following syntax. The component is restored to its pre-upgradedversion:wcmd rollbackall [email protected]

2. To rollback two, upgraded, versioned components from all ORBs and ORB sets in aninstallation, use the following syntax. The components are restored to their pre-upgradedversions:wcmd rollbackall [email protected];[email protected]

3. To rollback an upgraded versioned component from a single ORB named Austin andfrom all ORBs in the ORB set named Texas, use the following syntax. The component isrestored to its pre-upgraded version only on the resources specified:wcmd rollbackall [email protected] Orb/Austin;Orbset/Texas

cds rollbackAll

46 Version 1.2

4. To rollback several upgraded versioned components from a multiple ORBs and ORBsets, use the following syntax. The component is restored to its pre-upgraded versiononly on the resources specified:wcmd [email protected];[email protected];[email protected]/Austin;Orbset/Texas;3.f61d1c4c96591645.1.435c8c855dbeed03

See Alsowcmd cds upgradeAll

cds rollbackAll

47

4.C

om

po

nen

tD

istribu

tion

Service

wcmd cds uninstallRemoves a component from the Installation Depot. Makes a previously installed componentunavailable to the Tivoli Kernel Services installation. The component can not be deployeduntil it is re-installed.

Syntaxwcmd cds uninstall name@version

DescriptionThe wcmd cds uninstall command is used to uninstall a component from the installationdepot. This command removes the named component from the depot and cleans upconfiguration data for the component, if necessary.

Optionsname@version



Examples1. To uninstall version 5.1.0 of the Local Component Installer from the current ORB, use

the following syntax:wcmd cds uninstall [email protected]

2. To uninstall version 5.1.1 of the SnmpData component from an ORB having an OID of3.aceb384066ef9239.1.c46b9bf74dd9327e, use the following syntax:wcmd cds uninstall [email protected] 3.aceb384066ef9239.1.c46b9bf74dd9327e

See Alsowcmd cds install, wcmd cds isInstalled

cds uninstall

48 Version 1.2

wcmd cds upgradeUpgrades a component to a new version.

Syntaxwcmd cds upgrade {old_name} {new_name} {orb | orbset}

DescriptionThe wcmd cds upgrade command upgrades the named component to a new version. Thecommand specifies the ORB or ORB set containing the old version and specifies the versionto which the component is to be upgraded.

Optionsold_name Specifies the name and version of the component to be upgraded, expressed

as componentName@versionLevel.

new_name Specifies the name and new version of the component, expressed ascomponentName@versionLevel.





See Alsowcmd cds rollback

cds upgrade

49

4.C

om

po

nen

tD

istribu

tion

Service

wcmd cds upgradeAllUpgrades one or more versioned components on all ORBs and ORB sets or on selectedORBs and ORB sets in an installation.

Syntaxwcmd cds upgradeAll name@version... [resource...]

DescriptionThe wcmd cds upgradeAll command is used to upgrade one or more versioned componentson one or more ORBs or ORB sets. Versions of a component that are at a lower versionthan the version supplied on the command are upgraded to the specified version.

Optionsname@version

Specifies the name and version of the component to be upgraded, expressedas componentName@versionLevel. To upgrade several versionedcomponents, separate each versioned component name with a semicolon (;).If a resource is not specified, all ORBs and ORB sets in the installation areexamined for an older version of the component specified and the olderversion is upgraded to the version specified on the command.

resource Specifies the name or hexadecimal OID of an ORB or ORB set using any ofthe syntaxes shown in the description of “resource” on page 55. To upgradeversioned components on more than one resource, separated each resourcewith a semicolon (;). If omitted, the versioned components specified areupdated throughout the entire installation.



Examples1. To upgrade a versioned component on all ORBs and ORB sets in an installation, use the

following syntax:wcmd upgradeAll [email protected]

2. To upgrade two versioned components on all ORBs and ORB sets in an installation, usethe following syntax:wcmd upgradeAll [email protected];[email protected]

3. To upgrade versioned component on a single ORB named Austin and on all ORBs in theORB set named Texas, use the following syntax:wcmd upgradeAll [email protected] Orb/Austin;Orbset/Texas

cds upgradeAll

50 Version 1.2

4. To upgrade several upgraded versioned components on multiple ORBs and ORB sets,use the following syntax:wcmd [email protected];[email protected];[email protected]/Austin;Orbset/Texas;3.f61d1c4c96591645.1.435c8c855dbeed03

See Alsowcmd cds rollbackAll

cds upgradeAll

51

4.C

om

po

nen

tD

istribu

tion

Service

cds upgradeAll

52 Version 1.2

Configuration

Configuration information in a Tivoli Kernel Services installation can be manipulated usingthe Configuration command set. These commands all begin with wcmd cfg and are used toedit or display configuration information for a Tivoli Kernel Services component, subsystem,or service.

Note: Unless otherwise specified, all configuration commands return coalesced data. That is,data shown for a particular ORB includes data defined for the ORB sets to which theORB belongs and data shown for a ORB set includes data defined for the ORB setsin which it is nested.

Configuration information in Tivoli Kernel Services is internally represented in a hierarchicalfashion, similar to a directory tree. Each subsystem and service is defined in a branch of thetree.

For example, configuration information for the Tivoli Kernel Services logging subsystem isdefined in the subtree called /com/tivoli/util/logging. Child branches under the loggingsubtree define the various logging objects, such as the message and trace loggers andhandlers and formatters used in an ORB. Message loggers, for example, are defined in/com/tivoli/util/logging/message and trace loggers are defined in/com/tivoli/util/logging/trace. The configuration settings for a particular logging object aredefined as key=value pairs on a preference node in the appropriate subtree. For example, thesettings for a message logger named myLogger would be specified by key=value pairs in the/com/tivoli/util/logging/message/myLogger preference node.

To understand some of the configuration commands it is important that you understand theconcept of coalescing, as used in the context of these commands.

ORBs that share common characteristics can be grouped into an ORB set. Using ORB setscan reduce the time and effort required to make changes to the configuration settings formany ORBs. An ORB set is a logical container that can be configured using ORB-likeattributes and values. Attributes and values specified for the ORB set are propagated to allmember ORBs, but only if the member ORBs do not already contain a matching attributehaving a different value. The term coalescing refers to the process in which member ORBsacquire configuration settings from an ORB set.

ORB sets can also be nested within other ORB sets to provide even greater control overconfiguration activities. Attributes and values specified for the parent ORB set are coalescedto all nested ORB sets, but only if a the nested sets do not already contain a matchingattribute having a different value.

5

53

5.C

on

figu

ration

The general rule governing just how attributes and values are coalesced is fairlystraightforward for simple ORB and ORB set relationships. The general rule is: the valueassigned to an attribute in the lowest object in the ORB set–ORB hierarchy determines theattribute setting for the object. That is, an attribute setting defined for an ORB overrides thesetting for that attribute if the attribute is specified in the configuration settings for the ORBset. However, when ORB sets are nested in more than one parent, or when an ORB is amember of more than one ORB set, the coalescing process is not as straightforward. Forexample, assume the following ORBs and ORB sets contain an attribute that specifies thenumber times a process will be retried if it is not successful. The timeout attribute is set asshown below in the respective ORBs and ORB sets.

Object Timeout Setting Notes

ORB A timeout=10 ORB A is a member of both ORB set 1 andORB set 4.

ORB B timeout= is not specifiedfor this ORB.

ORB B is a member of ORB set 1.

ORB C timeout= is not specifiedfor this ORB.

ORB C is a member of ORB set 2.

ORB D timeout= is not specifiedfor this ORB.

ORB D is a member of both ORB set 1 andORB set 4.

ORB set 1 timeout=1 ORB A, ORB B, and ORB D are members.ORB set 1 is nested in ORB set 3.

ORB set 2 timeout= is not specifiedfor this ORB set.

ORB C is a member. ORB set 2 is nested inORB set 3.

ORB set 3 timeout=5000 ORB set 1 and ORB set 2 are nestedmembers.

ORB set 4 timeout=20000 ORB A and ORB D are members

The timeout attribute has several potential values.

For ORB A, the potential values are timeout=10 (its own), timeout=1 (since it belongs toORB set 1), timeout=5000 (since it belongs to ORB set 1 and ORB set 1 is nested in ORBset 3), and timeout=20000 (since it belongs to ORB set 4). Since 10 is defined specificallyfor ORB A, and ORB A is the lowest object in the hierarchy, timeout=10 will be used forORB A.

For ORB B, the potential values are timeout=1 (since ORB B belongs to ORB set 1) andtimeout=5000 (since ORB B belongs to ORB set 1 and ORB set 1 is nested in ORB set 3).Since ORB set 1 is nested as a child object within ORB set 3, ORB set 1 is the lowestobject in that relationship so timeout=1 from ORB set 1 will be used.

For ORB C, the only potential value is timeout=5000 (since ORB C belongs to ORB set 2,and ORB set 2 is nested in ORB set 3). Ordinarily, the value for the timeout attribute wouldbe determined by the settings for ORB C, the lowest object in the hierarchy. However ORBC does not contain a setting for timeout=. ORB set 2, the next level in the hierarchy alsodoes not specify a value for timeout= so the value specified for ORB set 3 will be used.

For ORB D, the potential values for the timeout attribute are timeout=1 (since it belongs toORB set 1), timeout=5000 (since it belongs to ORB set 1 and ORB set 1 is nested in ORBset 3) and timeout=20000 (since it belongs to ORB set 4). Because timeout= is not specified

54 Version 1.2

for ORB D, the value will be determined by another setting in a higher-level object. SinceORB set 1 is a child object nested within ORB set 3, ORB set 1’s timeout=1 would be usedinstead of timeout=5000 from ORB Set 3. However, ORB set 1 and ORB set 4 are peers inthe object hierarchy so it isn’t obvious which ORB set will determine the timeout= settingfor ORB D. In cases like this, coalescing priority algorithms determine which ORB setdetermines the value for the timeout attribute. The wcmd cfg getCoalescing command can beused to expose the ORB set having the highest priority. The ORB set listed first in theoutput has the highest priority. See “wcmd cfg getCoalescing” on page 66 for a decription ofhow to use the command on any ORB or ORB set.

Notes:Two unique ORB sets exist in a Tivoli Kernel Services installation: .allorbs and .orbdefaults.

1. The .allorbs ORB set is an ORB set that specifies configuration information you wish toapply to all ORBs in a Tivoli Kernel Services installation. Administrator-created ORBsets, like ORB set 1 through ORB set 4 used in the example above, have precedenceover the .allorbs ORB set, in terms of coalescing keys and values. That is, if a key iscontained in .allorbs and in a customer-created ORB set, the setting in the customer ORBset overrides the .allorbs setting.

2. The .orbdefaults ORB set is an ORB set that contains default configuration data for allcomponents installed by the Component Distribution Service. The configuration data inthis ORB set should ordinarily never be directly modified by end users. The .orbdefaultsORB set has the lowest coalescing priority of any other ORB set. If a key=value pair iscontained in both .orbdefaults and .allorbs, the settings in .allorbs take precedence.Similarly, if a key=value pair is contained in a customer-created ORB set and in.orbdefaults, the settings in the customer-created ORB set take precedence.

When entering configuration commands, you specify the following types of information:

resourceTivoli Kernel Services installations can be divided into namespaces to provide forunique naming conventions, much like DNS namespaces are used to keep IPhostnames unique. ORBs that share common properties can be grouped together toform an ORB set. Operations that set or display configuration data can be performedusing the wcmd cfg command set. Operations can be performed on to individualORBs, ORB sets, or to all ORBs in a namespace. When entering configurationservice commands, the target of an operation; that is, an ORB set or an individualORB, is identified in the “resource” argument on the command line using any of theconventions described below. If a resource is not specified, the command acts on theconfiguration information for the local ORB. The local ORB is the ORB to whichyou are currently logged in.

Generally, changes to configuration settings take effect immediately, but the actualtime required for a change to occur is dependent on many factors, including thenumber of ORBs or ORB sets affected, their availability, and so on.

Resources can be identified using:

.allorbs A literal that indicates the action is to be performedon all ORBs in this Tivoli Kernel Servicesinstallation.

.orbdefaults A literal that indicates the action is to affect thedefault configuration data for all ComponentDistribution Service-installed components.

55

5.C

on

figu

ration

Note: Customers should ordinarily never specify.orbdefaults as a resource on any TivoliKernel Services command.

3.orb_oid.1.namespace_id A literal and positional notation in which 3. indicatesthe next field contains an ORB OID and .1. indicatesthe next field contains a namespace ID. For example,if a valid ORB OID is CDFFF and a validnamespace ID is 6, the following could be entered totarget the ORB for a command’s action:3.CDFFF.1.6.

Note: The ORB and namespace IDs shown herehave been simplified to provide clearexamples. ORB OIDs, in reality, will actuallyappear as much longer hexadecimal numbers.The following is an example of an actualORB OID from a test system:3.f61d1c4c96591645.1.435c8c855dbeed03

2.orbset_id.1.namespace_id A literal and positional notation in which 2. indicatesthe next field contains an ORB set ID and .1.indicates the next field indicates a namespace ID.For example, if a valid ORB set ID is DEFFF and avalid namespace ID is 8, the following could beentered to target the ORB for a command’s action:2.DEFFF.1.8

Orbset/orbset_name Where orbset_name is the name assigned to an ORBset. A command using this notation causes an actionto be performed on all ORBs belonging to the set ofORBs identified by name. A name is assigned to anORB set using “wcmd info crtOrbset” on page 166and can be changed using “wcmd info setName” onpage 188.

Orb/orb_name Where orb_name is the name assigned to an ORB. Acommand using this notation causes an action to beperformed on the named ORB. A name is assignedto an ORB using “wcmd info crtOrb” on page 165and can be changed using “wcmd info setName” onpage 188.

Note: If you do not preface an ORB or ORB set name with either Orb/ or Orbset/,the configuration service will parse the name you provide first as an ORBname, and then as an ORB set name. For example, if you enter wcmd cfgAustin children /com/tivol/util/logging/message, the commandattempts to find an ORB named Austin and display the children of thespecified preference node. If an ORB having the name Austin does not exist,the command attempts to find an ORB set having that name. To avoidambiguity, and possibly undesired results, Tivoli recommends that you prefacean ORB or ORB set name with the appropriate constant.

56 Version 1.2

In addition to resources, configuration commands also accept or require the followinginformation:

pathname Specifies the name of the configuration, or preference, nodethat you wish to display or edit. Some commands acceptmultiple path names. Separate pathnames with spaces.

key Specifies the name of the key within the node that you wishto edit or display. Some commands accept multiple keynames. Separate key names with spaces. On the appropriatecommands, keys can be edited using a key=value notation.

On commands that accept one or more keys or key=value pairs as arguments, only a singlepathname can be entered.


57

5.C

on

figu

ration

wcmd cfg childrenDisplays the names of the children of a given preference node.

Syntaxwcmd cfg children [resource] pathname [pathname...]

DescriptionThe wcmd cfg children command returns the names of preference nodes immediately belowthe parent node specified on this command. If a node has no child nodes, only the nodespecified by pathname is returned. Preference nodes can be displayed for the local ORB, aremote ORB, or for an ORB set.

Optionspathname Identifies the full name of one or more preference nodes. Separate multiple

paths with spaces.resource Identifies the ORB or ORB set for which a list of child nodes will be

displayed. If resource is omitted, the local ORB is assumed. See “resource”on page 55 for the notation used to specify an ORB or ORB set.


Examples1. The following example displays the children of the Logging subsystem’s message logger

preference node for the local ORB:wcmd cfg children /com/tivoli/util/logging/message

Output from this command includes the names of the preference nodes immediatelybeneath the /com/tivoli/utils/logging/message node. In this example, the output includesthe names of any message loggers associated with various components. The right-mostentries on each output line are the message logger names.wcmd cfg children /com/tivol/util/logging/message/com/tivoli/util/logging/message:/com/tivoli/util/logging/message/FailoverMessageLogger/com/tivoli/util/logging/message/tesMessageLogger/com/tivoli/util/logging/message/sm.Message/com/tivoli/util/logging/message/directory/com/tivoli/util/logging/message/SSMMessageLogger/com/tivoli/util/logging/message/ComponentInstallerLog/com/tivoli/util/logging/message/NetPolicy/com/tivoli/util/logging/message/ipop/com/tivoli/util/logging/message/NetworkSecurityLogger/com/tivoli/util/logging/message/ChatSampleServiceLog/com/tivoli/util/logging/message/NetPolicyParser/com/tivoli/util/logging/message/sm/com/tivoli/util/logging/message/ChatClientLog/com/tivoli/util/logging/message/DepotInstallerLog/com/tivoli/util/logging/message/FishSampleServiceLog/com/tivoli/util/logging/message/cli/com/tivoli/util/logging/message/cfg/com/tivoli/util/logging/message/log/com/tivoli/util/logging/message/LocalInstallerLog/com/tivoli/util/logging/message/sec/com/tivoli/util/logging/message/orb

2. To determine the children of the message logger node in a remote ORB, named austin inthis example, enter the following command:

cfg children

58 Version 1.2

wcmd cfg children orb.austin /com/tivoli/util/logging/message

If a node has no children, only the name of the node is returned. If only the name of thenode is returned, you can determine that the austin ORB Logging subsystem does notprovide configuration information for any message loggers.

3. The following example displays the the children of the Logging subsystem’s messagelogger preference node for all ORBs using the .allorbs argument:wcmd cfg children .allorbs /com/tivoli/util/logging/message

Sample output resembles that shown in example 1.

See Alsowcmd cfg put, wcmd cfg nodeExists, wcmd cfg removeNode

cfg children

59

5.C

on

figu

ration

wcmd cfg cleanupLocates, displays, and optionally removes configuration data that is not used by any installedcomponent.

Syntaxwcmd cfg cleanup [–remove] [resource...]

DescriptionThe wcmd cfg cleanup command locates, displays and optionally removes configurationdata that is not used by any installed component. The deleted information is not recoverable.

Options–remove Specifies the unused configuration data will be deleted. Configuration data

deleted by this command is not recoverable.resource Indicates one or more ORBs and or ORB sets to be examined for unused

configuration data. Separate multiple resources with spaces. If a resource isnot specified, the command examines configuration data for all ORBs andORB sets in the installation. See “resource” on page 55 for the notation usedto specify an ORB or ORB set.

AuthorizationNo special authorization is required to identify unused configuration data. Requires writeaccess to the system/services/config subtree to remove unused configuration data.

NotesThis command makes heavy use of the Tivoli Kernel Services directory and may take aconsiderable amount of time to complete. For best results, execute this command on an ORBthat is near the Tivoli Kernel Services slash service. Consider running the command withoutthe –r remove option first to verify that no necessary data will be deleted. Data removed bythis command is not recoverable.

Examples1.

The following command examines all configuration data in the Tivoli Kernel Servicesinstallation and produces a list of the unused data. No data is removed, but the operationmay take some time to complete.wcmd cfg cleanup

2.

The following command examines all configuration data for the specified ORB and ORBset and lists and removes unused data.wcmd cfg cleanup -remove Orb/orb.domain.com_9990 2.456.1.13579

See Alsowcmd cfg remove, wcmd cfg removeNode, wcmd cfg removeResource

cfg cleanup

60 Version 1.2

wcmd cfg clearRemoves all keys and values from the specified preference node and flushes the node.

Syntaxwcmd cfg clear [resource] pathname [pathname...]

DescriptionThe wcmd cfg clear command removes all of the preferences in the node identified bypathname and flushes the node. (Flushing assures configuration settings changed in RAMare also changed in persistent configuration storage). This command only affects the keys inthe specified node; keys in children of the specified node are not affected.

This command affects only keys and values defined explicitly for the specified, or assumed,resource. Keys and values from coalesced nodes are unaffected by this command. To removea coalesced key and value, specify the resource that defines the key and value on thiscommand. Use the wcmd cfg whence command to determine which resource defines aparticular key and value. If a key=value pair deleted by this command was obscuring akey=value pair coalesced from another resource, this command causes the coalesced pair tobecome visible in the output of commands like wcmd cfg contents.

Optionspathname Is the full name of a preference node to be cleared. Separate multiple paths

with spaces.resource Identifies the ORB or ORB set from which the keys will be cleared. If

resource is omitted, the local ORB is assumed. See “resource” on page 55for the notation used to specify an ORB or ORB set.

AuthorizationRequires write access to the system/services/config subtree to perform this operation.

ExamplesThe following examples show a series of commands that create, display, and clear a node.

Set the key=value pair for attribute x to 5 in the /example node.wcmd cfg put /example x=5

Verify that the key was set.wcmd cfg contents /example/example:x=5

Clear the entire node.wcmd cfg clear /example

Verify that the node was cleared. If the cfg contents command returns only the node name,that indicates the cfg clear command was successful.wcmd cfg contents /example/example:

See Alsowcmd cfg put, wcmd cfg remove, wcmd cfg removeNode

cfg clear

61

5.C

on

figu

ration

wcmd cfg contentsDisplays all the keys and values in the specified preference nodes.

Syntaxwcmd cfg contents [resource] pathname [pathname...]

DescriptionThe wcmd cfg contents command returns the configuration keys and values in the specifiedpreference nodes.

Optionspathname Specifies the full name of one or more preference nodes. Separate multiple

paths with spaces.resource Identifies the ORB or ORB set for which configuration keys will be

displayed. If resource is omitted, the local ORB is assumed. See “resource”on page 55 for the notation used to specify an ORB or ORB set.


ExamplesTo retrieve the key=attribute settings for the node defining trace loggers in an ORB, enterthe following command:wcmd cfg contents /com/tivoli/util/logging/trace

The command outputs the keys and values defined in the trace node. The sample outputbelow, shows a possible output for this command. The key named client has no associatedvalue so only the key is displayed./com/tivoli/util/logging/trace:handlerNames=trcFilefilterNames=trcFilterclassName=com.tivoli.core.logging.TraceLoggerisLogging=falseclient=

See Alsowcmd cfg put, wcmd cfg keys, wcmd cfg put

cfg contents

62 Version 1.2

wcmd cfg getRetrieves the values of the specified keys and displays both the keys and their respectivevalues.

Syntaxwcmd cfg get [resource] pathname key [key...]

DescriptionThe wcmd cfg get command retrieves the values of the specified keys and display both thekeys and their respective values. This command is similar to the cfg contents command, butcfg get only returns the specified keys and values, not the entire contents of a given node.

Optionskey Specify one or more keys within the node specified by pathname. Separate

multiple keys with spaces.pathname Specify the full name of a preference node.resource Identifies the ORB or ORB set from which keys and values will be returned.

If resource is omitted, the local ORB is assumed. See “resource” on page 55for the notation used to specify an ORB or ORB set.


ExamplesDisplay the setting of the isLogging and filternames attributes for a trace logger.wcmd cfg get /com/tivoli/util/logging/trace isLogging filterNames/com/tivoli/util/logging/trace:isLogging=falsefilterNames=trcFilter

See Alsowcmd cfg contents, wcmd cfg getCoalesced, wcmd cfg getRaw, wcmd cfg keys, wcmdcfg put, wcmd cfg remove, wcmd cfg whence

cfg get

63

5.C

on

figu

ration

wcmd cfg getCoalesced

Returns the values that a key may acquire from an ORB set if the key’s value is coalesced.

Syntaxwcmd cfg getCoalesced [resource] pathname key [key...]

DescriptionThe wcmd cfg getCoalesced command returns the coalesced values of the specified keys. Acoalesced value is that value that will be applied to an ORB or ORB set if the ORB or ORBset does not specifically override it. This command returns information that answers thequestion, ″If this ORB or ORB set did not specifically define a value for a particular key,what value would it inherit from the ORB sets to which it belongs?″

Optionskey Identifies a key or keys within a preference node. Separate multiple key

names with spaces.pathname Specifies the full name of a preference node.resource Identifies the ORB or ORB set for which a list of keys and coalesced values

will be returned. If resource is omitted, the local ORB is assumed. See“resource” on page 55 for the notation used to specify an ORB or ORB set.


ExamplesThe following sequence of commands illustrates the use of the cfg getCoalesced command.

The command below sets a key named x in a node called /example in the local ORB. Thecommand changes the value of x from whatever it was, if it existed at all, to x=enabled inthe configuration settings for the local ORB.wcmd cfg put /example x=enabled

The next command sets /example/x=disabled in the .allorbs configuration data. This is thevalue of /example/x that will be coalesced by all ORBs and ORBsets that do not explicitlydefine that node and key in their own configuration settings.wcmd cfg put .allorbs /example x=disabled

The next command confirms the local ORB’s configuration data for /example/x is set tox=enabled.wcmd cfg get /example x/example:

x=enabled

Use cfg getCoalesced to determine the value /example/x would have if it was notspecifically defined in the local ORB.wcmd cfg getcoalesced /example x/example:

x=disabled

Use cfg whenceCoalesced to determine the ORB or ORB set from which the local ORBwould coalesce the setting of key x, if x was not specifically defined in the local ORB.

cfg getCoalesced

64 Version 1.2

wcmd cfg whencecoalesced /example x/example:

x: .allorbs

See Alsowcmd cfg get, wcmd cfg getCoalescing, wcmd cfg whenceCoalesced,

cfg getCoalesced

65

5.C

on

figu

ration

wcmd cfg getCoalescingReturns an ordered, or prioritized, list of ORBs or ORB sets from which coalesced valuesmay be acquired.

Syntaxwcmd cfg getCoalescing resource [resource...]

DescriptionThe wcmd cfg getCoalescing command shows the ORBs and ORB sets from whichinformation will be coalesced to generate the configuration data for a particular ORB orORB set. The list produced by this command shows the order in which ORBs or ORB setswill be considered. This command can be used to answer the question, ″In what order willother ORBs and ORB sets be considered when determining possible coalesced values forthis ORB or ORB set?″

Optionsresource Identifies the ORBs or ORB sets for which an ordered list of coalescing

sources will be displayed. To specify multiple ORBS or ORB sets, separatethe resources with spaces. See “resource” on page 55 for the notation used tospecify an ORB or ORB set.


Examples1. Display the ORBs and ORB sets from which ORB 3.1.1.1 inherits attributes. The output

shown here indicates ORB 3.1.1.1 inherits attributes from settings in .allorbs and.orbdefaults.wcmd cfg getcoalescing 3.1.1.1

3.1.1.1:3.1.1.1.allorbs.orbdefaults

2. Display coalescing information for the .allorbs ORB set. The output indicates the .allorbsORB set gets coalesced values from .allorbs and .orbdefaults.wcmd cfg getcoalescing .allorbs.allorbs:

.allorbs

.orbdefaults

3.

The following creates a new ORB and a new ORB set, joins the ORB to the ORB setand then illustrates how getCoalescing shows the ORB set’s data will be applied to theORB.wcmd info crtOrb orbxdeadbeef/Orb/orbxwcmd info crtOrbset orbsetadeadbeef/Orbset/orbsetawcmd info joinOrbset orbseta orbxdeadbeef/Orb/orbx now member of deadbeef/Orbset/orbsetawcmd cfg getcoalescing orb.orbxorb.orbx:3.17.1.12.41.1.1.allorbs

cfg getCoalescing

66 Version 1.2

.orbdefaultswcmd info getName 3.17.1.1orbxwcmd info getName 2.41.1.1orbseta

See Alsowcmd cfg getCoalesced, wcmd cfg whence, wcmd cfg whenceCoalesced, wcmd infojoinOrbset, wcmd info leaveOrbset, wcmd info nestOrbset, wcmd info unnestOrbset

cfg getCoalescing

67

5.C

on

figu

ration

wcmd cfg getRawReturns raw values of the specified keys.

Syntaxwcmd cfg getRaw [resource] pathname key [key...]

DescriptionThe wcmd cfg getRaw command retrieves the raw values of the specified keys and displaysboth the keys and their raw values. A key’s raw value is the unexpanded metadata containedin the key=value pair. Examples include system properties, such as $HOSTNAME and$ORBBASEDIR.

Optionskey Is one or more keys within the specified preference node. Separate multiple

keys with spaces.pathname Is the full name of a preference node.resource Identifies the ORB or ORB set for which raw values will be returned. If



ExamplesThe following shows how metadata is set and displayed in both expanded and raw form.

In the /example node, set attribute x to the system property $HOSTNAME and set attributey to $ORBBASEDIR.wcmd cfg put /example x=\$HOSTNAME y=\$ORBBASEDIR

Display the expanded version of the system properties. A resource has not been specified sothe command returns the settings for the local ORB.wcmd cfg get /example x y/example:x=localhosty=c:\tivoli_kernel_services\installation_directory

Display the raw data for x and y.wcmd cfg getraw /example x y/example:x=$HOSTNAMEy=$ORBBASEDIR

See Alsowcmd cfg get

cfg getRaw

68 Version 1.2

wcmd cfg importXMLImports configuration data from an XML file.

Syntaxwcmd cfg importXML [resource] xml_url [xml_url...]

DescriptionThe wcmd cfg importXML command imports configuration data from one or more XMLfiles.

OptionsSpecifies the URL at which the XML is located. The XML must contain only configurationdata that conforms to the configuration data DTD. The URL can be of type file(file:///C:/tks/xml/myConfigurationData.xml) or type http(http://w3.tivoli.com/tks/xml/myConfigurationData.xml).resource Identifies an ORB or ORB set with which the imported configuration data

will be associated. If resource is omitted, the current ORB is assumed. See“resource” on page 55 for the notation used to specify an ORB or ORB set.

xml_url Specifies the URL at which the XML is located. The XML must containonly configuration data that conforms to the Tivoli Kernel Servicesconfiguration data DTD. The URL can be of type file(file:///C:/tks/xml/myConfigurationData.xml) or type http(http://w3.tivoli.com/tks/xml/myConfigurationData.xml). Separate multipleURLs with spaces.


NotesThis command imports configuration data from the specified URL. The imported data isassociated with the specified ORB or ORB set, or the ORB to which this command is issuedif no ORB or ORB set is specified. This command should not be used to importconfiguration data into .orbdefaults.

Examples1. The following command imports configuration data from a local file and associates it

with an ORB named myorb.wcmd cfg importXML Orb/myorb file:///c:/work/configdata.xml

2. Do not use this command to import configuration data into the ORB set that definesinstallation-wide default configuration data (.orbdefaults). For example, do not use thiscommand to perform the following:wcmd cfg importXML .orbdefaults file:///c:/work/configdata.xml

See Alsowcmd cfg put

cfg importXML

69

5.C

on

figu

ration

wcmd cfg keysDisplays the names of the keys present in the specified preference nodes.

Syntaxwcmd cfg keys [resource] pathname [pathname...]

DescriptionThe wcmd cfg keys command displays the names of the keys present in the specifiedpreference nodes. To obtain a list both the keys and values for a preferences node, see“wcmd cfg contents” on page 62.

Optionspathname Is the full name of one or more preference nodes. Separate multiple paths

with spaces.resource Identifies the ORB or ORB set for which a list of keys will be returned. If



Examples1. The following shows the output from a cfg keys command that specifies the preference

node for Tivoli Kernel Services message loggers. This command output simply indicatesthe presence of keys defining the configuration of a message logger; use wcmd cfgcontents to display the values associated with the keys.wcmd cfg keys /com/tivoli/util/logging/message/com/tivoli/util/logging/message:handlerNamesfilterNamesclassNameisLogging

See Alsowcmd cfg contents, wcmd cfg get, wcmd cfg put

cfg keys

70 Version 1.2

wcmd cfg listResourcesLists all ORBs and ORB sets that have preference nodes associated with them.

Syntaxwcmd cfg listResources

DescriptionThe wcmd cfg listResources command lists all ORBs and ORB sets that have preferencenodes associated with them. If an ORB or ORB set does not appear in the output from thiscommand, that indicates there are no preference nodes specifically defined for that ORB orORB set. However, the ORB or ORB set may acquire coalesced properties from other ORBsets.

OptionsNone


Examples1. The following shows sample output from this command.

wcmd cfg listresources.allorbs

3.4.1.13.3.1.13.2.1.13.1.1.13.0.1.1

See Alsowcmd cfg put, wcmd cfg removeResource

cfg listResources

71

5.C

on

figu

ration

wcmd cfg nodeExistsIndicates whether the specified preference node exists.

Syntaxwcmd cfg nodeExists [resource] pathname [pathname...]

DescriptionThe wcmd cfg nodeExists command indicates whether the specified preference nodes existin the specified ORB or ORB set.

Optionspathname Specify the full name of one or more preference nodes. Separate multiple

paths with spaces.resource Identifies an ORB or ORB set. If resource is omitted, the local ORB is

assumed. See “resource” on page 55 for the notation used to specify an ORBor ORB set.


NotesIf a particular preferences node exists for an ORB set, that preferences node also exists forevery ORB or ORB set that is a member of the ORB set. For example, if orb1 is a memberof an ORB set in which a /com/tivoli/gadget node exists, a wcmd cfg nodeExists commandrun on orb1 will confirm the existence of the gadget node, even though it doesn’t actuallyexist in orb1’s configuration settings.

Examples1. The following shows a nodeExists command targeting the /com preference node. The

output for an affirmative response is also shown. A resource is not specified so thisexample runs on the local ORB.wcmd cfg nodeexists /com/com exists

2. The following shows possible output from a nodeExists command on an undefined anduncoalesced node.wcmd cfg nodeexists /not_there/not_there does not exist

See Alsowcmd cfg children, wcmd cfg put, wcmd cfg removeNode

cfg nodeExists

72 Version 1.2

wcmd cfg putSets the specified keys and values and flushes the node.

Syntaxwcmd cfg put [resource] pathname key=value [key=value...]

DescriptionThe wcmd cfg put command sets the specified keys and values and flushes the preferencenode. (Flushing assures configuration settings changed in RAM are also changed inpersistent configuration storage). If the resource, node, and key specified did not alreadyexist, the cfg put command creates them.

Optionskey=value Specify one or more key and value pairs. Multiple keys and values can be

specified by separating each pair with a space character. For example,/com/tivoli/widgets key1=x key2=y key3=z.

pathname Specify the full name of a preference node.resource Identifies the ORB or ORB set in which a key will be set. If resource is

omitted, the local ORB is assumed. See “resource” on page 55 for thenotation used to specify an ORB or ORB set.

NotesThe wcmd cfg put command can only accept up to 147 bytes of data as arguments. Thislimitation applies to arguments only, such as path names, path separators, class names, andso on; the 147 byte limit does not include the wcmd command prefix, the bundle name, orother constant arguments. The restriction is imposed to prevent users from creating pathnames that may not be compatible with the operating system’s filesystem namingrequirements.


Examples1. By default, trace logging is turned off. The default trace logger is named managerTrace.

To enable the default logger in an ORB, enter the following command:wcmd cfg put /com/tivoli/util/logging/trace/log/managerTrace isLogging=true

2. The following shows the syntax to add multiple keys.wcmd cfg put /full/name/of/path key1=true key2=false

See Alsowcmd cfg get, wcmd cfg nodeExists, wcmd cfg remove, wcmd cfg removeNode, wcmdcfg removeResource

cfg put

73

5.C

on

figu

ration

wcmd cfg removeRemoves the specified keys and flushes the node.

Syntaxwcmd cfg remove [resource] pathname key [key...]

DescriptionThe wcmd cfg remove command removes the specified keys and flushes the preferencenode. (Flushing assures configuration settings changed in RAM is also changed in persistentconfiguration storage).

This command affects only keys and values defined explicitly for the specified, or assumed,resource. Keys and values from coalesced nodes are not affected by this command. Toremove a coalesced key and value, specify the resource that defines the key and value onthis command. Use the wcmd cfg whence command to determine which resource defines aparticular key and value. If a key=value pair deleted by this command was obscuring akey=value pair coalesced from another resource, this command causes the coalesced pair tobecome visible.

Optionskey Is a key or keys within the specified preference node. Separate multiple keys

with spaces.pathname Is the full name of a preference node.resource Identifies the ORB or ORB set from which a key will be removed. If



ExamplesTo remove a all handlers associated with a message logger group named topo, enter thefollowing command:wcmd cfg remove /com/tivoli/util/logging/topo/handlerNames

See Alsowcmd cfg clear, wcmd cfg get, wcmd cfg getCoalesced, wcmd cfg put

cfg remove

74 Version 1.2

wcmd cfg removeNodeRemoves and flushes the specified preference node and descendants.

Syntaxwcmd cfg removeNode [resource] pathname [pathname...]

DescriptionThe wcmd cfg removeNode command removes the specified preference node anddescendants and flushes them. (Flushing assures configuration settings changed in RAM arealso changed in persistent configuration storage).

Optionspathname Is the full names of one or more preference nodes to be removed. Separate

multiple paths with spaces.resource Identifies the ORB or ORB set from which a node will be removed. If

resource is omitted, the current ORB is assumed. See “resource” on page 55for the notation used to specify an ORB or ORB set.


NotesIf the specified resource specified belongs to an ORB set that contains a preference nodehaving the same name as that specified on the pathname argument, the wcmd cfgnodeExists command will report that the preference node still exists, even after it has beenremoved from a member of the ORB set. For example, if ORB1 is a member of an ORB setnamed LoggingORBs and both ORB1 and LoggingORBs contain a preference node for/com/tivoli/util, issuing wcmd cfg removenode ORB1 /com/tivoli/util will remove thenode and all descendants from ORB1. Because of the way the coalescing algorithms work,executing wcmd cfg ORB1 nodeexists /com/tivoli/util will return a message thatindicates that the node exists in ORB1.

Examples1. The following command removes all configuration settings for a logging group named

topo.wcmd cfg removenode /com/tivoli/util/logging/message/topo

See Alsowcmd cfg clear, wcmd cfg removeResource

cfg removeNode

75

5.C

on

figu

ration

wcmd cfg removeResourceRemoves all preference nodes associated with the specified resource.

Syntaxwcmd cfg removeResource resource [resource...]

DescriptionThe wcmd cfg removeResource command removes all preference nodes associated with thespecified ORB or ORB set. The deleted information is not recoverable.

Optionsresource Identifies one or more ORBs or ORB sets for which all configuration

information will be deleted. Separate multiple resources with spaces. See“resource” on page 55 for the notation used to specify an ORB or ORB set.


NotesUse caution when using this command as the information removed by this command inunrecoverable. ORBs must be stopped before removing them using this command. Whenremoving an ORB set, stop all ORBs that are members of the ORB set before removing theORB set.

ExamplesThe following command removes configuration preferences for an ORB, which is identifiedby its OID.wcmd cfg removeresource 3.f61d1c4c96591645.1.435c8c855dbeed03

See Alsowcmd cfg listResources, wcmd cfg removeNode, wcmd orb shutdown

cfg removeResource

76 Version 1.2

wcmd cfg whenceReturns name of the ORB or ORB set from which a key’s value is acquired.

Syntaxwcmd cfg whence [resource] pathname key [key...]

DescriptionThe wcmd cfg whence command displays the ORB or ORB set from which the specifiedkeys received their values.

Optionskey Is the key whose associated resource is to be returned. Separate multiple

keys with spaces.pathname Is the full name of a preference node.resource Identifies an ORB or ORB set. If resource is omitted, the current ORB is



Examples1. The following command sequence illustrates how a key can be acquired from different

ORB sets and how to use the cfg whence command to determine which ORB set akey’s value is acquired.wcmd cfg put /example x=thisorbwcmd cfg put .allorbs /example x=.allorbswcmd cfg get /example x/example:x=thisorb

wcmd cfg whence /example x/example:x: 3.1.1.1

wcmd cfg remove /example xwcmd cfg get /example x/example:x=.allorbs

wcmd cfg whence /example x/example:x: .allorbs

See Alsowcmd cfg get, wcmd cfg getCoalescing, wcmd cfg whenceCoalesced

cfg whence

77

5.C

on

figu

ration

wcmd cfg whenceCoalescedReturns the ORB or ORB set from which a key’s value is coalesced.

Syntaxwcmd cfg whenceCoalesced [resource] pathname key [key...]

DescriptionThe wcmd cfg whenceCoalesced command displays the ORB or ORB set from which thespecified keys get coalesced values. This command returns information that answers thequestion, ″If this ORB or ORB set did not specifically define a value for a particular key,which ORB set would it acquire a value from?″

This is different from wcmd cfg getCoalesced in that cfg whenceCoalesced returns thename of the ORB or ORB set from which a key’s value is coalesced and cfg getCoalescedreturns the value a key acquired from an ORB or ORB set.

Optionskey Is a key or keys within a preference node. Separate multiple key names with

spaces.pathname Is the full name of a preference node.resource Identifies an ORB or ORB set. If resource is omitted, the current ORB is



Examples1. The following command sequence sets keys in an ORB and in an ORB set and depicts

the effect of the wcmd cfg getCoalesced and wcmd cfg whenceCoalesced commands asthe keys are removed from their respective resources.

The sequence below sets x=disabled in the local ORB, and x=enabled in the ORB setnamed .allorbs.wcmd cfg put /example x=disabledwcmd cfg put .allorbs /example x=enabled

The cfg get command returns the value of x as defined in the local ORB.wcmd cfg get /example x/example:x=disabled

The following sequence returns the value of x that would be inherited if it was notdefined in the local ORB. The output indicates the coalesced value would be acquiredfrom the .allorbs ORB set.wcmd cfg getcoalesced /example x/example:x=enabled

The sequence below returns the name of the ORB from which x receives its currentvalue. The ORB OID of the local ORB (3.1.1.1) is returned.wcmd cfg whence /example x/example:x: 3.1.1.1

cfg whenceCoalesced

78 Version 1.2

The following sequence returns the identity of the ORB set from which x would inherit avalue if it was not already specified in the local ORB. If not defined in the local ORB, xwould inherit a value from the .allorbs ORB set.wcmd cfg whencecoalesced /example x/example:x: .allorbs

The command below removes x from the local ORB, ORB 3.1.1.1wcmd cfg remove /example x

The whence and whenceCoalesced commands return the same ORB set name. This is theORB set from which x will inherit a value, now that x has been removed from the localORB.wcmd cfg whence /example x/example:x: .allorbs

wcmd cfg whencecoalesced /example x/example:x: .allorbs

See Alsowcmd cfg getCoalesced, wcmd cfg getCoalescing, wcmd cfg whence

cfg whenceCoalesced

79

5.C

on

figu

ration

cfg whenceCoalesced

80 Version 1.2

Component

Component commands are a set of low-level comands that can be used to manipulatecomponents currently running on an ORB and are intended to be used when troubleshootingproblems or when developing components. In day-to-day operations, administrators shoulduse commands in the access manager (see “Access Manager” on page 9) and componentdistribution service (see “Component Distribution Service” on page 31) command sets tomanipulate components. All component commands use the bundle name comp.

Component commands fall into two general categories of commands: commands that canchange (set) a component’s state and commands that simply display (get) information abouta component. The set commands include, for example, the commands to install, backoff,restore, start, stop, remove and shutdown a component. The get commands include benignoperations like check status, display component information, check compatibility, and so on.

The get commands are used to retrieve information about an ORB’s current state. Thesecommands can be useful when getting information for problem diagnosis or load balancing.

The set commands should ordinarily not be used by system administrators in day-to-dayactivities as mis-use of these commands can easily get an ORB into an inconsistent state.Any modifications made with these commands apply only to the current running state of theORB and are not persisted if the ORB is restarted. In general, you should use the commandsin the Component Distribution Service bundle (wcmd cds) and Access Manager bundle(wcmd accmgr) to make persistent modifications to a component and use the component(wcmd comp) commands to make non-persistent changes.


6

81

6.C

om

po

nen

t

wcmd comp backoffUndoes an installation of a specified component and version.

Syntaxwcmd comp backoff component_name version

DescriptionThe wcmd comp backoff command reverses the an installation of a specified componentand version, restoring component to the previous version. This command only applies toupgrades performed during the current life of the ORB; once an upgrade has been removedwith this command, no history of the upgrade is stored. This command is intended fortesting environments. In production environments, administrators should use the wcmd cdsupgrade and wcmd cds rollback commands to perform this function.

Optionscomponent_name

Specifies the name of the component currently running on the ORB.

version Specifies the version of the component currently running on the ORB.

AuthorizationRequires write access to system/services/ComponentManager and read access tosystem/services/directory.

Examples1. To backoff the 5.1.4 upgrade for the SnmpService to its previous version, use the

following syntax:wcmd comp backoff SnmpService 5.1.4

comp backoff

82 Version 1.2

wcmd comp compatVerDisplays the compatibility of two versions of a component.

Syntaxwcmd comp compatVer [component_name] [version_x] [version_y]

DescriptionThe wcmd comp compatVer command returns an indication of compatibility between twoversions of a component.


Specify the name of the component.

version_x Specify the first version level used in the compatibility determination.

version_y Specify the next version level used in the compatibility determination.

AuthorizationRequires read access to system/services/directory.

Examples1. wcmd comp compatVer log 1 2

Component log version 1 is compatible with version 22. wcmd comp compatVer log 1 5

Component log version 1 is NOT compatible with version 5

See Alsowcmd comp listCompatibleVersions

comp compatVer

83

6.C

om

po

nen

t

wcmd comp componentReturns information describing a specified component.

Syntaxwcmd comp component component_name [version] [–v]

DescriptionThe wcmd comp command returns information describing a specified component.

Options–v Displays verbose, or more detailed, information describing the component.

component_nameSpecifies the component name.

version Specifies the component version. This is optional. If there is more than oneversion of the same component running on the same ORB, then the firstcomponent in the hash table will be used.

AuthorizationRequires read access to system/services/ComponentManagerInternal andsystem/services/directory.

comp component

84 Version 1.2

wcmd comp componentsReturns a list of all components that are running or installed on the current ORB.

Syntaxwcmd comp components [–v]

DescriptionReturns a list of all components that are running or installed on the current ORB. Thisincludes all top level components administrators normally see in the Tivoli Console and allof the other components they use to perform their work.

Options–v Displays verbose, or more detailed, information describing the components.


Examples1. wcmd comp components -v

comp components

85

6.C

om

po

nen

t

wcmd comp installInstalls a component on an ORB.

Syntaxwcmd comp install component_name version [ path]

DescriptionThe wcmd comp install command installs a component on the ORB. The commandperforms the initial tasks required to actually load the component into the ORB includingfinding the jar files, downloading them from an HTTP daemon, loading them into a localcache (the first time), creating a classLoader to load the component, initializing the classpathfor the classloader, loading the class, and creating an instance of the class. This commanddoes not complete the initialization of the component, and the component is not available foruse by other components. Administrators should generally use the wcmd cds install, wcmdcds deploy, and wcmd accmgr startComponent commands to install, deploy, and startcomponents.


Specify the name of the component to be installed.

version Specify the version of the component to be installed.

path Identifies the URL resource where the component can be loaded from.


See Alsowcmd comp uninstall, wcmd cds deploy, wcmd cds install

comp install

86 Version 1.2

wcmd comp listCompatibleVersionsReturns a list of compatible versions for a given component.

Syntaxwcmd comp listCompatibleVersions component_name version [true | false]

DescriptionThe wcmd comp listCompatibleVersions command displays the versions of a componentthat are compatible with each other.


Specifies the name of the component.

version Specifies the version of the component.

true Indicates undeployed components are to be filtered from the output.

false Indicates undeployed components are not to be filtered from the output. If aBoolean is not specified, the default is false.


ExamplesThe following shows a sample command that lists the versions of a hypothetical componentnamed MyComponent that are compatible with version 5.1.1 of MyComponent:wcmd comp listCompatibleVersions MyComponent 5.1.1Compatible versions:1.02.1.02.1.1

comp listCompatibleVersions

87

6.C

om

po

nen

t

wcmd comp listURLReturns the list of URLs being used by a component class loader.

Syntaxwcmd comp listURL component_name [version]

DescriptionThe wcmd comp listURL command displays a list of the URLs that have been added to theclassloader used to load a specific component. This command is intended to be used toisolate problems in the componentization of code and is not intended for day-to-dayoperations. The command lists all of the URLs for the component. The list will not includeany of the URLs that are loaded by other components. The interface and data componentsthat other components use are loaded in a different classloader and can be listed using thewcmd comp listURLs command.


Specifies the component name.

version Specifies the component version. This is optional. If there is more than oneversion of the same component running on the same ORB, then the firstcomponent in the hash will be used.


Exampleswcmd listURL SnmpServicefile:d:/millennium/1029/install/orb.1/cd/[email protected]

comp listURL

88 Version 1.2

wcmd comp listURLsProvides a list of all of the URLs loaded into the classloader that are used to load interfaces,data, and components common to all components.

Syntaxwcmd comp listURLs

DescriptionThe wcmd comp listURLs command provides a list of all of the URLs loaded into theclassloader that are used to load interfaces, data, and components common to allcomponents.

OptionsNone


Exampleswcmd comp listURLsURLs in main loader are :

file:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/external/log/2.0.2/log.jarfile:d:/millennium/1029/install/orb.1/boot/external/sslite/1.0.0/sslite.zipfile:d:/millennium/1029/install/orb.1/boot/external/sun-jndi/1.2.0/jndi.jarfile:d:/millennium/1029/install/orb.1/boot/external/tmd/1.0.0/mm_tmd.jarfile:d:/millennium/1029/install/orb.1/boot/external/voyager/3.1.2/voyager.jar.. (output edited for brevity).file:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/cd/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/boot/[email protected]:d:/millennium/1029/install/orb.1/cd/[email protected]:d:/millennium/1029/install/orb.1/cd/[email protected]:d:/millennium/1029/install/orb.1/cd/[email protected]:d:/millennium/1029/install/orb.1/cd/[email protected]

comp listURLs

89

6.C

om

po

nen

t

wcmd comp reqCompReturns the requisite component, or components, for the specified component.

Syntaxwcmd comp reqComp component_name [version]

DescriptionReturns the requisite component, or components, for the specified component.



version Specifies the component version. This is optional. If there is more than oneversion of the same component running on the same ORB, then the firstcomponent in the hash will be used.


Exampleswcmd comp reqComp cm 5.1.3Requisite components of cm version 5.1.3:

cmInterface version 5.1.3SecurityInterface version 5.1.0ilsm version 5.1.1

wcmd comp reqComp cm -vRequisite components of cm version null:Name = cmInterface, version = 5.1.3, ProviderClassName = null, PreviousVersion =null, PotentialVersion = null, CodeBase = null, RunState = NOT RunningName = SecurityInterface, version = 5.1.0, ProviderClassName = null, PreviousVersion = null, PotentialVersion = null, CodeBase = null, RunState = NOT RunningName = ilsm, version = 5.1.1, ProviderClassName = null, PreviousVersion = null,PotentialVersion = null, CodeBase = null, RunState = NOT Running

comp reqComp

90 Version 1.2

wcmd comp restoreRestores a named component and reloads any persistent data it may have stored. (See wcmdcomp saveState)

Syntaxwcmd comp restore component_name [version]

DescriptionThe wcmd comp restore command restores a named component and reloads any persistentdata it may have stored.



version Specifies the component version. This is optional. However, to restore aspecific version, you will need to specify a version value.


comp restore

91

6.C

om

po

nen

t

wcmd comp saveStateSaves the state of the specified component.

Syntaxwcmd comp saveState component_name [version]

DescriptionThe wcmd comp saveState command causes the specified component to save any state datait wants to have available when it is restarted. The state data is used to restore thecomponent when a wcmd comp restore command is issued.



version Specifies the component version. This is optional. However, to save the stateof a specific component version, you will need to specify a version value.


See Alsowcmd comp restore

comp saveState

92 Version 1.2

wcmd comp shutdownShuts down a running component on the current ORB.

Syntaxwcmd comp shutdown component_name [version]

DescriptionThe wcmd comp shutdown command shuts down a running component on the currentORB. The component is still installed, and can be reactivated without a new instance beingcreated using the wcmd comp start command. Components shutdown and started usingwcmd comp commands may not be left in a stable state after several starts and shutdowns.Tivoli recommends using the wcmd accmgr stopComponent and wcmd accmgrstartComponent commands to start and stop components instead of this or the wcmd compstart command.



version Specifies the component version. This is optional. However, to shut down aspecific version of a running component, you will need to specify a versionvalue.


Examples1. wcmd comp shutdown MyService 1.1.0

stop method has been called on component MyService version 1.1.0

See Alsowcmd accmgr stopComponent, wcmd accmgr startComponent, wcmd comp stop

comp shutdown

93

6.C

om

po

nen

t

wcmd comp startStarts the specified component.

Syntaxwcmd comp start component_name [version]

DescriptionThe wcmd comp start command starts a component that was previously installed.Generally, components should be started using the wcmd accmgr startComponentcommand.



version Specifies the component version. This is optional. However, to start aspecific version of a component, you will need to specify a version value.


Exampleswcmd comp start SnmpService 5.1.1startup has been called for SnmpService version 5.1.1.

See Alsowcmd comp install, wcmd comp stop, wcmd accmgr startComponent

comp start

94 Version 1.2

wcmd comp statusDisplay component status.

Syntaxwcmd comp status component_name [version]

DescriptionThe wcmd comp status command returns the status of the specified component.



version Specifies the version of the component for which status is desired. version isoptional, but recommended. If more than one version of component_name isrunning in the ORB and version is omitted, status will be displayed for thefirst component in the ORB’s hash table.


Exampleswcmd comp status cm 5.1.3cm version 5.1.3 has status:Status: installStatus=Installed, runStatus=Running

See Alsowcmd comp compatVer

comp start

95

6.C

om

po

nen

t

wcmd comp statsDisplay statistics for a component. These statistics include a high level indication of thehealth of the component indicated as its load on a 0-100 scale (where 100 is fully loaded).There is also a copy of the status of the object included.

Syntaxwcmd comp stats component_name [version]

DescriptionThe wcmd comp stats command displays statistics for a component. The statistics include ahigh-level indication of the overall state (running or stopped) and health of a component.Health is indicated using a scale from 0 to 100 to indicate the amount of load on thecomponent, where 100 is fully loaded, or operating at capacity.



version Specifies the version of the component for which statistics are desired.version is optional, but recommended. If more than one version ofcomponent_name is running in the ORB and version is omitted, statisticswill be displayed for the first component in the ORB’s hash table.


ExamplesThe following shows the syntax and output from this command when requesting statistcisfor a hypothetical component named cm:wcmd comp stats cmcm version null has statistic:Statistics: {Load=10, Status=Status: installStatus=Installed,runStatus=Running}

See Alsowcmd comp status

comp start

96 Version 1.2

wcmd comp stopStops a running component on the current ORB.

Syntaxwcmd comp stop component_name [version]

DescriptionThe wcmd comp stop command stops a component.



version Specifies the component version. This is optional. However, to stop aspecific version of a running component, you will need to specify a versionvalue.


See Alsowcmd comp shutdown, wcmd accmgr stopComponent

comp stop

97

6.C

om

po

nen

t

wcmd comp uninstallStops, uninstalls, and removes a component from the current ORB.

Syntaxwcmd comp uninstall component_name [version]

DescriptionThe wcmd comp uninstall command stops, uninstalls, and removes a component from thecurrent ORB.



version Specifies the component version. This is optional. If there is more than oneversion of the same component running on the same ORB, then the firstcomponent will be uninstalled.


See Alsowcmd comp install, wcmd cds uninstall

comp uninstall

98 Version 1.2

wcmd comp upgradePerforms a non-persistent upgrades of a component.

Syntaxwcmd comp upgrade component_name version new_version [path]

DescriptionThe wcmd comp upgrade command upgrades a component to a new version. However, anupgrade performed using this command is not persisted. If the orb is restarted, the oldversion of the component will be reloaded and restarted. To make a persistent upgrade thatsurvives ORB restarts, use the wcmd cds upgrade command.



version Specifies the component version. This is optional. If there is more than oneversion of the same component running on the same ORB, then the firstcomponent will be upgraded.

new_version Specifies the new component version.

path Where the new component code is located. For example,file:/mycode/newcode.jar. To have the ComponentManager derive the correctclasspath from the component’s definition in the XML combined with theinformation describing the appropriate component depot for this orb, do notinclude a path.


See Alsowcmd cds upgrade

comp upgrade

99

6.C

om

po

nen

t

wcmd comp versionReturns the version number for the specified component, or components.

Syntaxwcmd comp version component_name...

DescriptionA component can have more than one version running at the same time. This commandreturns all the versions of the component that are currently running on the local ORB.


Specifies the component name. You can specify multiple component_namevalues.


comp version

100 Version 1.2

Depot Component Installer

Depot Component Installer commands (wcmd dci commands) are used to perform problemdiagnosis and verifying which components are installed on or uninstalled from from aparticular ORB. All wcmd dci commands work only on the current ORB, the ORB to whichyou are currently logged in. The current ORB must have the Depot Component Installerinstalled on it to use these commands.

Installing and uninstalling components are typically performed using the wcmd cdscommands and those commands are described in “Component Distribution Service” onpage 31. The commands in this chapter, Depot Component Installer are used to verify anddiagnose functions initiated via the wcmd cds install and wcmd cds uninstall commands.


7

101

7.D

epo

tC

om

po

nen

tIn

staller

wcmd dci listDiffReturns the names of components that need to be installed on or uninstalled from the currentORB.

Syntaxwcmd dci listDiff

DescriptionThe wcmd dci listDiff command displays the names of components that need to be installedto or uninstalled from the current ORB.

OptionsNone


See Alsowcmd lci listDiff, wcmd dci listInstalledComponents

dci listDiff

102 Version 1.2

wcmd dci listInstalledComponentsReturns the names and version number of all components installed in the current ORB.

Syntaxwcmd dci listInstalledComponents

DescriptionThe wcmd dci listInstalledComponents command displays the names and revision levels ofall components that have been installed in the current ORB.

OptionsNone


ExamplesTo display a list of installed components, use the following command. The output shownhere has been edited for brevity.wcmd dci [email protected]@[email protected]@[email protected]@5.1.0CliService@5.1.0ComponentDistributionSerComponentDistributionSerComponentInstaller@[email protected]

See Alsowcmd dci listInstalledComponentNames, wcmd lci listDeployedComponents

dci listInstalledComponents

103

7.D

epo

tC

om

po

nen

tIn

staller

wcmd dci listInstalledComponentNamesReturns the names of all components installed in the current ORB.

Syntaxwcmd dci listInstalledComponentNames

DescriptionThe wcmd dci listInstalledComponentNames command displays the names of allcomponents that have been installed in the current ORB.

OptionsNone


ExamplesTo display a list of installed component names, use the following command. The outputshown here has been edited for brevity.wcmd dci listInstalledComponentNamesAZNEngineActionObjectsAuthenticationClienAuthenticationServiChatSampleClientChatSampleClientIntChatSampleInterfaceChatSampleServiceCliInterfaceCliNlsCliService..zurich-correlator

See Alsowcmd dci listInstalledComponents, wcmd lci listDeployedComponentNames

dci listInstalledComponentNames

104 Version 1.2

wcmd dci processQueueCause the events in the Depot Component Installer queue to be immediately processed.

Syntaxwcmd dci processQueue

DescriptionIn large Tivoli Kernel Services installations, wcmd cds commands used to install or uninstallcomponents may be queued for processing by the Depot Component Installer. The wcmd dciprocessQueue command causes the event in the queue to be immediately processed.

OptionsNone


ExamplesThe following example shows example output when tasks are in the queue and thiscommand is issued.wcmd dci processqueueThe queued actions are being processed.Queue processing complete.

See Alsowcmd dci showQueue

dci processQueue

105

7.D

epo

tC

om

po

nen

tIn

staller

wcmd dci showQueueReturns a list of install and uninstall actions currently queued for processing by the DepotComponent Installer.

Syntaxwcmd dci showQueue

DescriptionIn large Tivoli Kernel Services installations, wcmd cds commands used to install or uninstallcomponents may be queued for processing by the Depot Component Installer. The wcmd dcishowQueue returns a list of actions currently queued for processing by the DepotComponent Installer.

OptionsNone


ExamplesThe following example assumes the queue contains a task to uninstall a component namedDummyService1, at version level 5.1.1.wcmd dci showqueueUninstall queued for component [email protected]

See Alsowcmd cds deploy, wcmd cds retract

dci showQueue

106 Version 1.2

Directory Service

The Tivoli Kernel Services Directory Service provides object-oriented naming and directoryservices for data and Java objects in the Tivoli Kernel Services distributed system. TheDirectory Service provides containers in which applications can store data.

The directory commands allow users to manage the directory service and examine or modifythe data and objects in the directory.

Serveral other command groups such as wcmd info, wcmd cfg and wcmd log displayinformation that is stored in the Tivoli Kernel Service directory but they only displayinformation related to their own specific function. For example, the wcmd info commandsdisplay information stored in the directory that is related to namespaces, ORB sets, andORBs and the wcmd cfg commands display information stored in the directory that isrelated to configuration data The wcmd dir (directory) commands show and modify thecontents of any entry in the directory regardless of the service that happened to write thedata into the directory. Additionally, wcmd dir commands are the only commands thatprovide maintenance activities for the Tivoli Kernel Services Directory Service and theentities stored in the directory.

To use the wcmd dir commands, it is helpful to understand concepts and terms as they applyto the Directory Service.

Contexts and ObjectsA directory context is an object that acts as a container to hold other objects at acertain level in the directory. Tivoli Kernel Services directory contexts areconceptually similar to a filesystem node like / (root) and other subordinate nodes,such as /namespace1. Directory contexts can contain objects and data.

All ORB sets, for example, could be stored in the directory in a subcontext called/ORBsets. If your installation contains multiple namespaces, all ORB sets in theUSA namespace could be stored in a context named /namespaces/USA/ORBsets.

A special context, called the slash context, or global context, provides and maintainsdirectory services across session boundaries for an entire Tivoli Kernel Servicesinstallation. The slash context is accessed by ORBs and objects performinginter-ORB communications to look up remote ORBs, components, or servicesneeded to perform an action. The global context is a persistent directory stored in adatastore in your Tivoli Kernel Services installation. It is accessible using aURL-like notation to specify the datastore and target objects in the global context.

Another special context is the local ORB context. This directory context is RAMresident in any given ORB and contains directory information for all componentsand services running in the ORB. The local ORB context is the top-level context in

8

107

8.D

irectory

Service

an ORB. References to objects that are made using relative path notation areresolved using the local ORB directory context.

Depending on the complexity of your Tivoli Kernel Services installation, there maybe one or more of these datastores containing contexts and objects defining yourTivoli Kernel Services installation. There will always be one local context per ORB.

AttributesAttributes define the characteristics of contexts and objects in local and globaldirectory. Attributes are assigned to an object using a key=value notation such ascolor=red, or className=com.tivoli.core.logging. Directory commands can be usedto manipulate attributes of objects in the local and global directories.


108 Version 1.2

wcmd dir attributeAdds, removes, or replaces attributes on a context or object.

Syntaxwcmd dir attribute add key=value path_name

wcmd dir attribute remove key path_name

wcmd dir attribute replace key=value path_name

DescriptionThe wcmd dir attribute command adds, modifies, or removes attributes stored in thepersistent context of the directory. Attributes are identified by key=value notation, where keyis the name of the attribute and value is the value assigned to the named key. The commandonly works on attributes and cannot be used to add, remove, or replace an object or context.This command is valid only for the persistent context and errors are returned if a relativepath, which is a local context reference, is supplied to the command.

Optionsadd key=value Adds the attribute key and associated value to the object or context.

remove key Removes the attribute identified by key from the object or context.

replace key=valueReplaces the value of an existing attribute of an object or context.

path_name Specifies the location of the object, in the Directory Service, for the attributethat is being changed or removed. The path_name can be the name of anobject or a context, but the path_name must already exist in the persistentdirectory for the command to succeed.

AuthorizationRequires read and write access to system/services/directory.

Examples1. The following example adds a color attribute and a value of blue to the object

/myContext/myObject.wcmd dir attribute add color=blue /myContext/myObject

2. The following example replaces the color attribute of the object /myContext/myObjectwith a new value of red.wcmd dir attribute replace color=red /myContext/myObject

3. The following example removes the color attribute from the object/myContext/myObject.wcmd dir attribute remove color /myContext/myObject

See Alsowcmd dir ls-a

dir attribute

109

8.D

irectory

Service

wcmd dir getdbInfoDisplays configuration settings for the datastores used by the directory, logging, and securityaudit services.

Syntaxwcmd dir getdbInfo

DescriptionThe wcmd dir getdbInfo displays configuration settings for the datastores used by thedirectory, logging, and security audit services. The command returns a numbered list ofdatastores. Enter the number that corresponds to the datastore of interest. The commanddisplays the configuration information for the datastore. Information for the SecurityRegistry and Presentation Services can be displayed by entering option 5 (Other datastore).You will be prompted for a vault file name appropriate for the datastore. To displayinformation for the Security Registry datastore, enter tmdvault1 as the vault name. Todisplay information for the Presentation Services datastore, enter psvault as the vault name.

AuthorizationRequires privileged access to system/services/directory.

Examples1. The following sequence displays the configuration data for the Logging Service database,

which is accessible by entering option 3:wcmd dir getdbinfo1 Directory Slash service primary datastore2 Directory Slash service backup datastore3 Logging Service datastore4 Security Audit Logging datastore5 Other datastores3DBURL=jdbc:dastdo://abatra1.dev.tivoli.com:8001/loggingDBUSER=db2adminDBPASS=db2adminDBDRIVER=com.tivoli.das.jdbc.daDriverDBPORT=8001DBDATASOURCE=logging

See Alsowcmd dir setdbInfo

dir getdbinfo

110 Version 1.2

wcmd dir lsLists the contents of a directory context.

Syntaxwcmd dir ls [–a] [–e] [–l] [path_name]

DescriptionThe wcmd dir ls command lists the contents of a single context in either the local orpersistent context of the directory. This command is only valid for listing the contents ofcontexts and an error is returned if the user attempts to list objects. The command lists thecontents of one context at a time and does not display contexts that may be nested below thepath named on the command.

Options–a Lists the attributes of a directory object. The command returns an exception

if this flag is specified and path_name is a context.

–e Lists the environment associated with non-Tivoli contexts, for example,LDAP. Contexts created by installing Tivoli Kernel Services software do notuse environments so the -e flag has no effect on default contexts.

The –e option is not supported by any of the default contexts. This option isprovided only for additional third party contexts, such as LDAP, that may beplugged into the directory.

–l Adds additional detail. The output includes three columns: the object name,the name of the class that implements the object, and the result of callingtoString() on the object. If the object does not implement toString(), thethird column contains the Java representation of the class, an at (@) sign,and the address of the object in RAM.

path_name The location in the directory of the context or object to be listed. Specify arelative path to list the contents of a local context. Specify a fully-qualifiedpath when using the –a option to list the context from the global context.See examples, below.


Examples1. The following example lists the contents of the top-level context of the local ORB

directory.wcmd dir lsORBLogMgrAccessManager

2. The following example lists the contents of the local ORB directory, including objectdetails.wcmd dir ls -l

ORB Orb_IProxy__Proxycom.tivoli.core.orb.Orb@906b9c4a

LogMgr RemoteHashtableContext

dir ls

111

8.D

irectory

Service

com.tivoli.core.directory.spi.RemoteHashtableContext@ab2e1c40AccessManager ComponentManager_IProxy__Proxy

com.tivoli.core.component.ComponentManager@88529c4f

3. The following example list the contents of the top-level context of the global directory.wcmd dir ls /19884ac308eaef73

4. The following example lists the attributes of an object found in the global directory:wcmd dir ls -a /19884ac308eaef73/Orb/7c0192fb000e0dbdmodTime: 974308618373name: dhcp28-185.dev.tivoli.com_9990osname: Windows NTport: 9990oid: 3.7c0192fb000e0dbd.1.19884ac308eaef73priIPAddr: 146.84.28.185hostNames: dhcp28-185.dev.tivoli.comipAddrs: 146.84.28.185osarch: x86type: serverregion: DefaultRegionjvmInfo: J2RE 1.2.2 IBM build cn122-20000915 (JIT enabled: jitc)createTime: 973532002334osver: 4.0priHostName: dhcp28-185.dev.tivoli.comcomponentFullVersion: 5.1.0-200011052047Orbsets

5. The following example lists the active logging elements in an ORB by listing the logmanager context.wcmd dir ls LogMgrDistributedLogMgr

See Alsowcmd dir attribute, wcmd dir mkdir, wcmd dir rename, wcmd dir rmdir

dir ls

112 Version 1.2

wcmd dir maintSwitches the mode of the slash service between read-only and normal modes; establishesand re-establishes connections to a datastore. The eventCompatibility method enables ordisables the display of directory events received by the current ORB.

Syntaxwcmd dir maint

wcmd dir maint {readOnly | normal}

wcmd dir maint reconnect {primary | secondary}

wcmd dir maint eventCompatibility {on | off}

wcmd dir maint displayEvents {on | off}

DescriptionThe wcmd dir maint command can be used to switch the slash service between read-onlyand normal modes. The slash service is the portion of the Directory Service that enablesglobal look ups of any object in the Tivoli Kernel Services installation. Entering thecommand without options displays the current mode of the slash service. In read-only mode,the slash service only supports read operations and changes to the persistent data are notallowed. Normal mode supports both read and write requests and is the mode that should beenabled for normal operations. Normal is the default mode when the slash service is started.

The wcmd dir maint command can also be used to re-establish the connection to theprimary or secondary data store.

Optionsnormal

Sets the slash service to enable read and write operations.

readOnlySets the slash service to read-only mode.

reconnect primaryDisconnects from the current datastore and establishes new connections to theprimary datastore.

reconnect secondaryDisconnects from the current datastore and establishes new connections to thesecondary datastore.

eventCompatibility onEnables publishing of both old and new style directory events. With eventcompatibility turned on, Tivoli Kernel Services 1.1.0 ORBs can receiveDirEventMessage2 topics events published by version 1.2, or higher, of the slashservice ([email protected]).

Note: This argument is only available on ORBs that are running the slash service atversion 1.2.0, or higher ([email protected]).

dir maint

113

8.D

irectory

Service

eventCompatibility offDisables publishing of the Tivoli Kernel Services DirEventMessage topics. If anORB is restarted, event compatiblity is automatically re-enabled.

Note: This argument is only available on ORBs that are running the slash service atversion 1.2.0 ([email protected]). The DirEventMaster, which is only available withTivoli Kernel Service 1.2 (or higher) and [email protected] (or higher), supportspublishing of event messages for two topics:

¶ DirEventMessage, a topic available in Tivoli Kernel Services 1.1.0, and

¶ DirEventMessage2, a topic only available with Tivoli Kernel Services1.2.0 (or later). Do not turn event compatibility off if your installationcontains any ORBs running Tivoli Kernel Services 1.1.0. (The publisherfor DirEventMessage2 cannot be disabled.

displayEvents onLogs all directory events received by the current ORB in the default log message logfile (messagex.log)

displayEvents offStops all directory events received by the current ORB from being logged in thedefault message log file (messagex.log).

AuthorizationRequires read and privileged access to system/services/directory.

NotesThe wcmd dir maint command may only be issued on ORBs that have a slash servicerunning. To determine if a slash service is running, use the wcmd svc ls LSM command. Ifthe slash service is running, slash 5.1.0 (or other version) will appear in the list ofservices returned by the command.

Examples1. The following example displays the current mode the slash service is in.

wcmd dir maintThe slash service is running in normal mode

2. The following example puts the slash service into read-only mode. There is no outputfrom this command.wcmd dir maint readOnly

3. The following example puts the slash service back into normal mode. There is no outputfrom this command.wcmd dir maint normal

4. The following example disconnects the slash service from the current datastore andconnects to the secondary datastore. There is no output from this command.wcmd dir maint reconnect secondary

5. The following example enables the display of directory events.wcmd dir maint eventCompatibility on

dir maint

114 Version 1.2

wcmd dir mkdirCreates a subcontext in the local or persistent directory context. The newly createdsubcontext is of the same type as its parent. That is, a subcontext created on a global contextwill be global and a subcontext created on a local context will be local.

Syntaxwcmd dir mkdir [–r] path_name

DescriptionThe wcmd dir mkdir command creates a new subcontext, in either the local ORB contextor the global directory context. The path specified with the command determines if the newcontext is created in the context of the local ORB or in the global context. A fully-qualifiedURL to the global context creates the subcontext in the persistent directory. A relative pathcreates a local ORB context. An error is returned if the path supplied with the commandalready exists in the directory. It is possible to create local and persistent contexts with thesame name.

Options–r Indicates that all contexts specified in the path will be recursively created, if

they don’t already exist. For example, wcmd dir mkdir -r a/b/c is equivalentto the NT or Unix sequence of mkdir a, chdir a, mkdir b, chdir b, mkdir c.

path_name Is the context name to be created. The newly created context will be of thesame type as its parent. If the path is specified using a relative path name,the subcontext is created in the local directory context. If the path namespecified is a URL to the persistent datastore, the subcontext is created in thepersistent directory context. See Examples.


NotesWhen specifying the –r option, any contexts that do not exist will be created automaticallyusing the same context type as its parent.

Examples1. The following examples make a set of subcontexts, some of which may already exist.

For example, if you enter the following command, contexts a, b, and c are created:wcmd dir mkdir -r a/b/c

If the next command issued is:wcmd dir mkdir -r a/b/c/d

the only subcontext added is d.

2. The following example makes a set of subdirectories in the slash context.wcmd dir mkdir -r /none/of/these/exist/yet

3. The following example makes a single local directory.wcmd dir mkdir singledir

See Alsowcmd dir rmdir

dir mkdir

115

8.D

irectory

Service

wcmd dir renameRenames a directory context or object within the same parent.

Syntaxwcmd dir rename old_name new_name

DescriptionThe wcmd dir rename command can be used to change the text identifier associated with acontext in the local or persistent sections of the Tivoli Kernel Services directory. Renamescan only be done within the same parent context. A large number of objects may need to bemanipulated by the directory in order to accomplish the requested command; therefore, usecaution when issuing this command.

Optionsold_name Specifies the fully-qualified path to the object or context that is to be

renamed.

new_name Specifies the fully-qualified path to the new name of the object or context.


NotesObjects or contexts can only be renamed inside the same parent context; that is, contexts andobjects inside a context may only be renamed to something else inside the same parentcontext. There is currently no way to move objects from one context to another through thecommand line interface.

ExamplesThe following example renames myContext/Object-1 to myContext/Object-2.wcmd dir rename myContext/Object-1 myContext/Object-2

dir rename

116 Version 1.2

wcmd dir rmdirRemoves a context or object from the directory.

Syntaxwcmd dir rmdir path_name

DescriptionThe wcmd dir rmdir command removes an object or context (subcontext) in the directory.Currently, the directory allows non-empty contexts to be removed; all subcontextssubordinate to the target are are also deleted. The command operates on the local ORB (theORB on which the command is executed) or on the persistent context. After the command isissued, it is irrevocable.

By default, a context cannot have more than 350 children, including objects and subcontexts.

Optionspath_name Specifies the name of the context or object to delete. To remove objects

from the global context, specify the URL to the persistent datastore and thepathname of the subcontext to be deleted. To delete a local subcontext orobject, identify the context or object using a relative path name.


Examples1. The following example removes the /myobj context.

wcmd dir rmdir /myobj

2. The following example removes the Object-24 object from the /myContext/UnNeededcontext.wcmd dir rmdir /myContext/UnNeeded/Object-24

See Alsowcmd dir mkdir

dir rmdir

117

8.D

irectory

Service

wcmd dir setdbInfoSpecifies the locations of databases used by the directory service, logging service, and thesecurity audit logging service.

Syntaxwcmd dir setdbInfo

DescriptionThe wcmd dir setdbInfo command establishes the locations of databases used by thedirectory service, logging service, and the security audit logging service. This is aninteractive command that displays a series of choices, depending on the type of database.This command is only needed to change the default configuration settings pertaining to thedatabase servers used by the directory service, security audit service, or the logging serviceafter your ORB is installed.

The following shows the selections available when the command is entered:wcmd dir setdbinfo

1 Directory Slash service primary datastore2 Directory Slash service backup datastore3 Logging Service datastore4 Security Audit Logging datastore5 Other datastores

Enter 1 to set configuration information for the primary datastore for the Directory Slashcontext.

Enter 2 to set configuration information for the backup datastore for the Directory Slashcontext.

Enter 3 to set configuration information for the datastore for the Logging Service. Thisdatastore uses the default logging vault file named loggingVault.

Enter 4 to set configuration information for the Select Security Audit datastore. Thisdatastore uses the default security audit vault file named secAuditVault.

Enter 5 to set configuration information for any other datastore. Enter the name of yourvault file when prompted.

After selecting the type of datastore, answer the remaining prompts:

1. Enter the fully-qualified name of the Tivoli DAS server when prompted for the databaseserver.

2. Specify the port number to use if it is not the default of 8001, otherwise just press Enter.

3. Set the database alias to the name of the database, in this example logging.

4. Enter your DB2 user ID and password. Press Enter to use the default of db2admin.Confirm that you are using the default database driver, com.tivoli.das.jdbc.daDriver, andpress Enter.

If you created a general logging database (Other datastores option), you must map the vaultfile to the specific log handler. (This mapping occurs automatically for the logging service

dir setdbinfo

118 Version 1.2

database and the security audit database.) Map the vault file to the log handler by issuing thefollowing command, all on one line. replace the italicized names with the names of your logdatabase handler and vault file:wcmd log handler databaseHandlerName -set vault=vaultFileName

Use the wcmd dir getdbInfo command to verify the configuration settings you just entered.

AuthorizationRequires privileged access to system/services/directory.

See Alsowcmd dir getdbInfo

dir setdbinfo

119

8.D

irectory

Service

wcmd dir showListenersDisplays all the event listeners that are currently monitoring the directory.

Syntaxwcmd dir showListeners

DescriptionThe wcmd dir showListeners command lists all the event listeners that are currentlymonitoring the directory on a particular ORB.

The output of the wcmd dir showListeners command is in four columns: the target slashcontext that the listener is waiting for changes on, the scope type, the type of listener, andthe object that is the listener. See example.

The scope type can be one of the following:

Subtree ScopeWhich indicates the listener is interested in events concerning objects in thesubtree of the object named by the target, including the object named by thetarget.

One Level ScopeWhich indicates the listener is interested in events concerning objects in thecontext named by the target, excluding the context named by the target.

Object Scope Which indicates the listener is interested in events concerning the objectnamed by the target.

The type of listener can be one or both of the following:

N Indicates the listener is interested in directory events related to adding and removingobjects and contexts.

O Indicates the listener is interested in directory events related to objects and contextsbeing changed, such as when attributes on an object are added.

AuthorizationRequires read and privileged access to system/services/directory.

ExamplesThe following shows an abbreviated example of output from this command. The firstcolumn in the output is the path in the global directory for which the listener has expressedan interest. Column 2 is the type of listener (Subtree Scope, One-level Scope, or ObjectScope). Column 3 is the letter N or O, or both for NamespaceChangeListener and/orObjectChangeListener. Column 4 shows the result of calling toString() on the object that isthe listener.wcmd dir showlisteners/79e2cd064ea610bc/cfg Subtree Scope N,O com.tivoli.core.configuration.CachingEventDirContext.../ Subtree Scope N,O com.tivoli.core.orb.info.InfoService...

wcmd dir showlisteners

dir showlisteners

120 Version 1.2

Thread Dumper

The thread dumper command initiates a full thread dump from an ORB. This is a diagnosticcommand intended for support personnel and is not used in day-to-day operations.


9

121

9.T

hread

Du

mp

er

wcmd dumper dumpInitiates a full thread dump from an ORB.

Syntaxwcmd dumper dump [–f file_name] [–orb]

DescriptionThe wcmd dumper dump command initiates a full thread dump from an ORB. This is adiagnostic command intended for support personnel and is not used in day-to-day operations.

If no options are specified, a thread dump from wcmd sends its output to the stderr for thewcmd process and to a file named ThreadDump.txt. The name of the file can be changedwith the –f option. The –orb option is an alternative form that does not send the output tothe wcmd stderr and does not save the contents to a file. Instead, it only puts the threaddump output to the ORB’s stderr. The ORB’s stderr is directed differently according to howLOCK was used. If LOCK was launched as a service or daemon, the stderr is captured inthe stderr.txt file. If LOCK was launched interactively, the stderr is the same as whateverprocess launched it, which would normally be the console window.

Options–f file_name Specifies the name of the file in which the thread dump is saved. The named

file is saved in the local ORB’s directory. The dump is also written to thewcmd stderr.

-orb Indicates the the thead dump is only written to the ORB’s stderr and not tothe wcmd window.


Examples1. The following shows output from a wcmd dumper command:

Full thread dump Classic VM (JDK-1.2.2_006, native threads):"CLI stream copier" (TID:0x1847300, sys_thread_t:0xb21280,

state:CW, native ID:0x262) prio=5at java.lang.Object.wait(Native Method)at java.lang.Object.wait(Object.java:424)at com.tivoli.core.cli.MpxInputStream.read(MpxInputStream.java:99)at com.tivoli.core.cli.StreamCopier.run(StreamCopier.java:58)

"Thread-641" (TID:0x184b3d0, sys_thread_t:0xb217e0,state:R, native ID:0x265) prio=5at com.tivoli.core.cli.NamedPipeServer.read0(Native Method)at com.tivoli.core.cli.NamedPipeServer.access$1(NamedPipeServer.java:165)at com.tivoli.core.cli.NamedPipeServer$SvrInputStream.read(NamedPipeServer.java:202)at com.tivoli.core.cli.StreamDemuxer.run(StreamDemuxer.java:73)at java.lang.Thread.run(Thread.java:479)

"LocalCLI Handler" (TID:0x1877468, sys_thread_t:0xb21600,state:R, native ID:0x255) prio=5at com.tivoli.core.cli.ThreadDumper.dump1(Native Method)at com.tivoli.core.cli.ThreadDumper.dump(ThreadDumper.java:74)at java.lang.reflect.Method.invoke(Native Method)at com.tivoli.core.cli.CliService.execute(CliService.java:327)at com.tivoli.core.cli.CmdHandler.invokeCmd(CmdHandler.java:349)at com.tivoli.core.cli.CmdHandler.getCtlData(CmdHandler.java:231)at com.tivoli.core.cli.CmdHandler.run(CmdHandler.java:154)

dumper dump

122 Version 1.2

at java.lang.Thread.run(Thread.java:479)"Graceful death" (TID:0x1849090, sys_thread_t:0xb1e6a0,

state:CW, native ID:0x25f) prio=5at java.lang.Object.wait(Native Method)at java.lang.Object.wait(Object.java:424)at com.tivoli.util.lock.Lock.acquire2(Lock.java:434)at com.tivoli.util.lock.Lock.acquire(Lock.java:329)at com.tivoli.util.lock.Lock.acquire(Lock.java:327)at com.tivoli.util.lock.Lock.acquireExclusive(Lock.java:185)at com.tivoli.util.configuration.impl.PreferencesLock.acquire(PreferencesLock.java:49)at com.tivoli.util.configuration.impl.BasePreferences.child(BasePreferences.java:436)at com.tivoli.util.configuration.impl.BasePreferences.child(BasePreferences.java:480)

.

. (Output omitted for brevity)

.Waiting to be notified:

"event-sender-thread" (0x96fce0)java.lang.Object@18E2FC8/1A1FAE0: <unowned>

Waiting to be notified:"config-datastore-ready-handler" (0x960cc0)java.net.DatagramPacket@18A53C8/1C735B0:

owner "Listener" (0xab26f0) 1 entryjava.lang.Object@1928700/1A1FE08: <unowned>

Waiting to be notified:"switched-prefs-flusher" (0x964dd0)java.lang.Object@1922F70/1A3ECB8: <unowned>

Waiting to be notified:"com.ibm.logging.MultiFileHandler:" (0x977340)

com.tivoli.core.component.ComponentManager$DispatchThread@18CA5E0/1B6C720: <unowned>Waiting to be notified:

"Component Event Dispatcher" (0xa083e0)com.objectspace.lib.timer.TimerGroup@1894C68/1C25588: <unowned>

Waiting to be notified:"Thread-3" (0xa6d180)com.objectspace.lib.timer.TimerGroup@1678368/1D90010: <unowned>

Waiting to be notified:"Thread-237" (0xac8d30)java.lang.Object@19216C8/1A66090: <unowned>

Waiting to be notified:"com.tivoli.util.logging.ConsoleHandler:" (0x971f30)java.lang.ref.ReferenceQueue$Lock@18F9338/192ED60: <unowned>

Waiting to be notified:"Finalizer" (0x822f80)java.lang.Object@191D948/19E86F8: <unowned>

Waiting to be notified:"com.ibm.logging.FileHandler:bootFile" (0x936490)java.net.PlainSocketImpl@18BE788/1AD8A90:

owner "tcp://gering:9990 Server"(0x9c89f0) 1 entry

java.lang.ref.Reference$Lock@18F93C0/192E890: <unowned>Waiting to be notified:

"Reference Handler" (0x821820)java.lang.Object@184B4F0/3436580: <unowned>

Waiting to be notified:"CLI stream copier" (0xb21280)java.net.PlainDatagramSocketImpl@18A92B8/1C70418:

owner "Listener" (0xab26f0) 1 entrycom.tivoli.core.mmcd.LocalComponentActionQueue@1647050/1EDD4E0:

dumper dump

123

9.T

hread

Du

mp

er

owner "LocalComponentActions" (0xb1a5d0) 1 entryjava.net.MulticastSocket@18A92B0/1C70400:

owner "Listener" (0xab26f0) 1 entryjava.lang.Object@1835340/1C4E340: <unowned>

Waiting to be notified:"TimerService" (0xab08c0)

Registered Monitor Dump:JDWP Command Queue Lock: <unowned>

Waiting to be notified:"JDWP Transport Listener: dt_shmem" (0x839f00)JDWP Event Helper Completion Monitor: <unowned>JDWP Event Helper Queue Monitor: <unowned>

Waiting to be notified:"JDWP Event Helper Thread" (0x839870)JDWP Event Handler Lock: <unowned>JDWP Transport Send Monitor: <unowned>JDWP Transport Listener Monitor: <unowned>JDWP Initialization Monitor: <unowned>JDWP Invocation Lock: <unowned>JDWP Step Handler Lock: <unowned>JDWP Thread Lock: <unowned>JDWP Reference Table Monitor: <unowned>JDWP Alloc Lock: <unowned>utf8 hash table: <unowned>JNI pinning lock: <unowned>JNI global reference lock: <unowned>BinClass lock: <unowned>Class linking lock: <unowned>System class loader lock: <unowned>Code rewrite lock: <unowned>Heap lock: <unowned>Monitor cache lock: owner "Signal dispatcher" (0x8202b0) 1 entryThread queue lock: owner "Signal dispatcher" (0x8202b0) 1 entry

Waiting to be notified:"Thread-241" (0xb1c5c0)Monitor registry: owner "Signal dispatcher" (0x8202b0) 1 entry

dumper dump

124 Version 1.2

wcmd dumper locksAugments information returned by the wcmd dumper dump command.

Syntaxwcmd dumper locks

DescriptionThe wcmd dumper locks command takes no options. Output is always to the stdout of thewcmd process, which is normally the console. The locks associated with this command areprogrammatic and unique to Tivoli Kernel Services. A thread dump (wcmd dumper dump)includes information about ″monitors″ which perform a similar function as the softwarelocks: they are used to synchronize threads and serialize access toJava objects. The states ofthe software locks may be needed in addition to the thread dump information to completelydiagnose deadlock conditions. This is a diagnostic command intended for support personneland is not used in day-to-day operations.

OptionsNone.


Examples1. The following shows output from a wcmd dumper locks command:

wcmd dumper locksname: locallogmgr; synch:java.lang.Object@edaab8e2;

member of: [name: tkscore; synch:java.lang.Object@edfeb8e2]name: preferences; synch:java.lang.Object@84eab8e0;

member of: [name: tkscore;synch:java.lang.Object@edfeb8e2]

dumper locks

125

9.T

hread

Du

mp

er

dumper locks

126 Version 1.2

Failover Agent Service

The Failover Agent service monitors selected components by periodically polling them forstatus. If a component does not respond to a poll or if the component reports an error, theFailover Agent service makes a single attempt to restart the component. If the restart fails, amessage notifies the Administrator of the failure.

Failover agent commands configure the interval between successive polls and enable ordisable the Failover Agent service.


10

127

10.F

ailover

Ag

ent

Service

wcmd failoverAgent configConfigures the time between Failover Agent polls of a component.

Syntaxwcmd failoverAgent config –c name [–v version] [–i seconds]

DescriptionThe wcmd failoverAgent config command configures the monitoring interval for acomponent. The Failover Agent service can periodically poll selected components todetermine their status. The monitoring interval is the time period between these polls. If acomponent does not respond to a poll, or if the component reports an error, the FailoverAgent service makes a single attempt to restart it. If the restart fails, a message notifies theAdministrator of the failure.

Setting the polling interval for a component is a persistent action, but you can issue thiscommand multiple times if you need to change the polling interval.

Options–c name

Specifies the name of the component for which the polling interval is being defined.

–i secondsSpecifies the time interval, in seconds, between polls.

–v versionSpecifies the version of the component for which the time interval is being defined.If the version parameter is not included in a command, the command will be appliedto any one of the components installed with the name specified.

AuthorizationRequires execute right on system/services/Failover.

Examples1. To configure the Failover Agent service to monitor version 5.1.0 of the

SDSRemoteService every 60 seconds, use the following command:wcmd failoverAgent config -c SDSRemoteService -v 5.1.0 -i 60

failoverAgent config

128 Version 1.2

wcmd failoverAgent disableDisables Failover Agent monitoring of component.

Syntaxwcmd failoverAgent disable –c name [–v version]

DescriptionThe wcmd failoverAgent disable stops Failover Agent monitoring of a component. If theORB has already been started, the Failover Agent service on that ORB must be restarted toenable monitoring of the component.

Options–c name

Specifies the name of the component the Failover Agent will no longer monitor.

–v versionSpecifies the version of the component. If the version parameter is not included in acommand, the command will be applied to any one of the components installed withthe name specified.


Examples1. To disable Failover Agent monitoring of version 5.1.0 of the SDSRemoteService, use the

following syntax:wcmd failoverAgent disable -c SDSRemoteService -v 5.1.0

failoverAgent disable

129

10.F

ailover

Ag

ent

Service

wcmd failoverAgent enableEnables failover monitoring for a component.

Syntaxwcmd failoverAgent enable –c name [–v version]

DescriptionThe wcmd failoverAgent enable enables failover monitoring of a component. If the ORBhas already been started, the Failover Agent service must be restarted to enable monitoringof the component. The Failover Agent can only monitor components in the same ORB as theFailover Agent.

Options–c name

Specifies the name of the component to be monitored by the Failover Agent service.

–v versionSpecifies the version of the component to be monitored. If the version parameter isnot included in a command, the command will be applied to any one of thecomponents installed with the name specified.


Examples1. To enable Failover Agent monitoring of version 5.1.0 of the SDSRemoteService, use the

following syntax:wcmd failoverAgent enable -c SDSRemoteService -v 5.1.0

failoverAgent enable

130 Version 1.2

wcmd failoverAgent listMonitoredComponentsDisplays a list of components monitored by the Failover Agent service.

Syntaxwcmd failoverAgent listMonitoredComponents

DescriptionThe wcmd failoverAgent listMonitoredComponents command displays a list ofcomponents monitored by the Failover Agent service.

OptionsNone.

AuthorizationRequires read right on system/services/Failover.

failoverAgent listMonitoredComponents

131

10.F

ailover

Ag

ent

Service

failoverAgent listMonitoredComponents

132 Version 1.2

Gateway IP Service

The Gateway IP service commands provide the ability to ping IP systems, requesttraceroutes, display statistics about Gateways, and other, miscellaneous managementoperations on IP Gateways. Gateway IP service commands use the GatewayIPService bundlename.

The Network Endpoint Locator Service (NELS) must be started before Gateway IP servicecommands can be used. To start NELS, enter the following command: wcmd accmgrstartService -s NelService

The Gateway IP service must be started before these commands can be used. To start theGateway IP service, enter the following command: wcmd accmgr startService -sGatewayIPService

Services must be installed and deployed to an ORB or ORB set before they can be started orused. See Component Distribution Service for descriptions of the commands available todetermine if a component has been installed (wcmd cds isInstalled), deploy a service(wcmd cds deploy), or determine which versions of a component are available on aninstallation depot (wcmd cds listInstalledComponents).


11

133

11.G

ateway

IPS

ervice

wcmd GatewayIPService finishStops the Gateway IP service after all queued requests are processed.

Syntaxwcmd GatewayIPService finish

DescriptionThe wcmd GatewayIPService finish command stops the Gateway IP service from acceptingnew requests and then stops the service after all queued requests are processed.

OptionsNone

AuthorizationRequires access execute right on the Gateway IP service (or on the global Gatewayresource) and authority to use the wcmd accmgr stopService command.

See Alsowcmd GatewayIPService stop, wcmd GatewayIPService query, wcmdGatewayIPService resume, wcmd GatewayIPService remove

GatewayIPService finish

134 Version 1.2

wcmd GatewayIPService pingPings the specified IP address.

Syntaxwcmd GatewayIPService ping target_address[:nat]

wcmd GatewayIPService ping source_address[:nat] target_address[:nat]

DescriptionThe wcmd GatewayIPService ping command issues a ping to the target address.

When only a target address is supplied, the ping is generated from an IP Gateway that isconfigured for that endpoint.

When a source and target address are specified, the ping is generated by the IP Gateway atthe address specified by source_address.

Optionsnat Specifies the integer ID or name of a private IP network containing the source or

target address. This option is only used when the installation contains separate IPnamespaces. Separate nat from the IP address with a colon (:).

target_addressThe IP address of the device to be pinged.

source_addressThe IP address of the Gateway that will ping the target. If the address supplied isnot a Gateway, the ping request is refused.

AuthorizationRequires execute right on the NEL service servicing this Gateway (or on the global NELservice) and execute right on the Gateway IP service (or on the global Gateway resource)and deviceExe right on the device secuity group associated with the endpoint.

Exampleswcmd GatewayIPService ping 146.84.29.110==========================================================Status: 0.Source : lturn3/146.84.29.114Destination : cjohnson.dev.tivoli.com/146.84.29.110Time : 0.0 ms==========================================================

See Alsowcmd GatewayIPService traceroute

GatewayIPService ping

135

11.G

ateway

IPS

ervice

wcmd GatewayIPService queryShows the current state of the dispatch queue or the state of the dispatcher.

Syntaxwcmd GatewayIPService query {dispatch | queue}

DescriptionThe wcmd GatewayIPService query command displays the current state of the dispatchqueue or the state of the dispatcher.

Optionsdispatch

Displays the state of the dispatcher, either active (running) or stopped. Also displaysthe requests being dispatched. Requests are indexed by request ID.

queue Displays the state of the queue, either active (running) or stopped. Also displays therequests in the queue. Requests are indexed by request ID.

AuthorizationRequires read right on the Gateway IP service or on the global Gateway resource.

Examples1. The following shows example output from a wcmd GatewayIPService query dispatch

command. The output shows the requests being dispatched:wcmd GatewayIPService query dispatchDispatcher Status: active.--------------------------------76: traceroute 146.84.28.4577: ping 9.67.43.60, 9.67.43.61, 9.67.43.62, 9.67.43.6378: traceroute 146.84.34.32

2. The following shows example output from a wcmd GatewayIPService query queuecommand. The output shows the requests that are in the queue, waiting to be dispatched:wcmd GatewayIPService query queueQueue Status: active.--------------------------------79: traceroute 146.84.28.4580: ping 9.67.43.60, 9.67.43.61, 9.67.43.62

See Alsowcmd GatewayIPService stop, wcmd GatewayIPService resume, wcmdGatewayIPService remove, wcmd GatewayIPService finish

GatewayIPService query

136 Version 1.2

wcmd GatewayIPService removeRemoves a request from the Gateway IP service dispatch queue.

Syntaxwcmd GatewayIPService remove request_id

DescriptionThe wcmd GatewayIPService remove command removes a request from the Gateway IPservice dispatch queue. A request is an action to be performed on a target. A ping request,for example, is initiated using the wcmd GatewayIPService ping command. To obtain a listof the requests in the queue, and their associated IDs, use the wcmd GatewayIPServicequery command with the queue argument.

Optionsrequest_id

The ID of the request to remove from the queue.

AuthorizationRequires execute right on the Gateway IP service or on the global Gateway resource.

Examples1. The following command removes the request having a request ID of 79:

wcmd GatewayIPService remove 79

See Alsowcmd GatewayIPService stop, wcmd GatewayIPService query, wcmdGatewayIPService resume, wcmd GatewayIPService finish

GatewayIPService remove

137

11.G

ateway

IPS

ervice

wcmd GatewayIPService resolveResolves an IP address within a private network.

Syntaxwcmd GatewayIPService resolve ip_address[:nat]

DescriptionThe wcmd GatewayIPService resolve command resolves an IP address within a privatenetwork.

Optionsnat Specifies the integer ID or name of a private IP network containing the IP address.

This option is only used when the installation contains separate IP namespaces.Separate nat from the IP address with a colon (:).

ip_addressSpecifies the IP address of the device to be resolved.

AuthorizationRequires execute right on the NEL service servicing this Gateway (or on the global NELservice) and execute right on the Gateway IP service (or on the global Gateway resource)and deviceExe right on the device security group associated with the endpoint to be resolved(or on the global Devices resource).

Examples1. The following shows sample output from the GatewayIPService resolve command that

targets an address in a private network.wcmd gatewayipservice resolve 164.84.29.202:Plaza1-FourthFloorStatus: 0Time :0.0 msHops :0Info :146.84.29.202

GatewayIPService resolve

138 Version 1.2

wcmd GatewayIPService resume

Resumes acceptance or dispatching of new requests.

Syntaxwcmd GatewayIPService resume {accept | dispatch}

DescriptionThe wcmd GatewayIPService resume command reverses the wcmd GatewayIPServicestop accept or wcmd GatewayIPService stop dispatch command. The Gateway IP serviceresumes accepting or dispatching requests.

Optionsaccept Resumes acceptance of requests.

dispatchResumes dispatching of requests.

AuthorizationRequires execute right on the Gateway IP service (or on the global Gateway resource).

See Alsowcmd GatewayIPService stop, wcmd GatewayIPService query, wcmdGatewayIPService remove, wcmd GatewayIPService finish

GatewayIPService resume

139

11.G

ateway

IPS

ervice

wcmd GatewayIPService statisticsReturns statistics for an IP Gateway.

Syntaxwcmd GatewayIPService statistics

DescriptionThe wcmd GatewayIPService statistics command displays statistics for an IP Gateway.

OptionsNone.

AuthorizationRequires read right on the Gateway IP service (or on the global Gateway resource).

ExamplesThe following shows the output from this command:wcmd gatewayipservice statisticsIGATEWAYPACKETS :4IPACKETSQUEUED :2IPACKETSINPROCESS: 0

See Alsowcmd GatewayIPService status

GatewayIPService statistics

140 Version 1.2

wcmd GatewayIPService statusReturns the status of the IP Gateway service.

Syntaxwcmd GatewayIPService status

DescriptionThe wcmd GatewayIPService status command displays the status, running or not running,of the IP Gateway service.

OptionsNone.

AuthorizationRequires read right on the Gateway IP service (or on the global Gateway resource).

Examples1. The following shows output of the GatewayIPService status command when the service

is running. If the service is stopped, the output displays NOT RUNNING.wcmd GatewayIPService statusGatewayIPService state: RUNNING

See Alsowcmd GatewayIPService statistics

GatewayIPService status

141

11.G

ateway

IPS

ervice

wcmd GatewayIPService stopImmediately stops the Gateway IP service, stops acceptance of new requests, or stopsdispatching of queued requests, depending on the options specified.

Syntaxwcmd GatewayIPService stop [accept | dispatch]

DescriptionThe wcmd GatewayIPService stop command either stops the Gateway IP service, stopsacceptance of new requests, or stops dispatching of requests, depending on the optionspecified. If one of the optional arguments is not specified, the command stops the GatewayIP service.

Optionsaccept Stops acceptance of new requests.

dispatchStops requests from being dispatched.

AuthorizationRequires read and execute rights on the Gateway IP service (or on the global Gatewayresource) and authority to use the wcmd accmgr stopService command.

ExamplesThe command below stops the Gateway IP service. There is no output from the command.wcmd GatewayIPService stop

See Alsowcmd GatewayIPService resume, wcmd GatewayIPService query, wcmdGatewayIPService remove, wcmd GatewayIPService finish

GatewayIPService stop

142 Version 1.2

wcmd GatewayIPService tracerouteRequests a traceroute to an IP device.

Syntaxwcmd GatewayIPService traceroute target_address[:nat]

wcmd GatewayIPService traceroute source_address[:nat] target_address[:nat]

DescriptionThe wcmd GatewayIPService traceroute requests a traceroute operation to be performedon the target address.

When only a target address is supplied, the traceroute is generated from an IP Gateway thatis configured for that endpoint.

When a source and target address are specified, the traceroute is generated by the Gatewayat the source address and the traceroute is performed between the source and targetaddresses.

Optionsnat Specifies the integer ID or name of a private IP network containing the source or


target_addressThe IP address of the target device.

source_addressThe IP address of the Gateway that will generate the traceroute to the target. If theaddress supplied is not a Gateway, the traceroute request is refused.

AuthorizationRequires execute right on the NEL service servicing this Gateway (or on the global NELservice) and execute right on the target GatewayIP service (or on the global Gatewayresource) and deviceExe right on the device secuity group associated with the source andtarget addresses (or on the global Devices resource).

See Alsowcmd GatewayIPService ping

GatewayIPService traceroute

143

11.G

ateway

IPS

ervice

GatewayIPService traceroute

144 Version 1.2

Gateway SNMP Service

The Gateway SNMP service commands provide the ability to manipulate ManagementInformation Base (MIB) data in IP endpoints. Gateway SNMP service commands use theGatewaySNMPService bundle name.

The Gateway SNMP and NELS services must be started before these Gateway SNMPcommands can be used. To start the NELS service, enter the following command:wcmd accmgr startservice -s NelService

To start the Gateway SNMP service, enter the following command:wcmd accmgr startService -s GatewaySNMPService



12

145

12.G

ateway

SN

MP

Service

wcmd GatewaySNMPService finishStops the Gateway SNMP service after all queued requests are processed.

Syntaxwcmd GatewaySNMPService finish

DescriptionThe wcmd GatewaySNMPService finish command stops the Gateway SNMP service fromaccepting new requests and then stops the service after all queued requests are processed.

OptionsNone

AuthorizationRequires execute right on the targeted Gateway SNMP service (or on the global Gatewayresource) and authority to use the wcmd accmgr stopService command.

See Alsowcmd GatewaySNMPService stop, wcmd GatewaySNMPService query, wcmdGatewaySNMPService resume, wcmd GatewaySNMPService remove

GatewaySNMPService finish

146 Version 1.2

wcmd GatewaySNMPService getnextOidReturns the value of the next OID in a device’s MIB.

Syntaxwcmd GatewaySNMPService getnextOid ip_address[:nat] oid [community_name]

DescriptionThe wcmd GatewaySNMPService getnextOid command identifies a target device by its IPaddress. The command also accepts a numeric MIB object ID (OID) that acts as a seededOID, or a starting place in the MIB, and the command returns the value of the next OID inthe MIB. This command can be used in conjunction with the wcmd GatewaySNMPServicegetOid command to step through a display of OIDs in a device’s MIB without requiringprior knowledge of the MIB’s OID hierarchy.

Optionscommunity_name

Specifies a community name needed to read data from the MIB in the machineidentified by ip_address.

ip_addressSpecifies the dotted-decimal form of the IP address of the device targeted by thiscommand.

nat Specifies the integer ID or name of a private IP network containing the IP address.This option is only used when the installation contains separate IP namespaces.Separate nat from the IP address with a colon (:).

oid Specifies the numeric OID of a MIB-defined OID. This OID acts as a seededidentifier and the command returns the value of the next OID defined in the MIB.

AuthorizationRequires execute right on the NEL service servicing this gateway (or on the global NELservice) and execute right on the target Gateway SNMP service (or on the global Gatewayresource) and both deviceExe and deviceRead rights on the device security group associatedwith the targeted endpoint (or on the global Devices resource).

Examples1. The following command displays the contents of the OID that follows OID

1.2.6.1.2.1.1.4.0 in the MIB of an IP resource at 146.84.26.96.wcmd gatewaysnmpservice getnextoid 146.84.26.96 1.2.6.1.2.1.1.4.0

OID: 1.3.6.1.2.1.1.1.0Data: IBM PowerPC Personal ComputerMachine Type: 0x0807004c Processor id: 006451F54C00Base Operating System Runtime AIX version: 04.03.0003.0000TCP/IP Client Support version: 04.03.0003.0000Status: 0

The code displayed for Status: can have any of the following values:

0 SUCCESS

2 FAILURE_SECURITY

3 PDU_ERROR

5 NO_RESULT_YET

GatewaySNMPService getnextOid

147

12.G

ateway

SN

MP

Service

See Alsowcmd GatewaySNMPService getOid

GatewaySNMPService getnextOid

148 Version 1.2

wcmd GatewaySNMPService getOidReturns the value of the specified OID.

Syntaxwcmd GatewaySNMPService getOid ip_address[:nat] oid [community_name]

DescriptionThe wcmd GatewaySNMPService getOid command identifies a target device by its IPaddress and returns the value of a MIB-defined OID. This command can be used inconjunction with the wcmd GatewaySNMPService getnextOid command to step through adisplay of OIDs in a device’s MIB.

Optionscommunity_name

Specifies a community name needed to read data from the MIB in the machineidentified by ip_address.

ip_addressSpecifies the dotted-decimal form of the IP address of the device targeted by thiscommand.


oid Specifies the numeric OID of a MIB-defined OID. The command returns the valueof the OID specified here.

AuthorizationRequires execute right on the NEL service servicing this gateway (or on the global NELservice) and execute right on the target Gateway SNMP service (or on the global Gatewayresource) and both deviceExe and deviceRead rights on the device security group associatedwith the targeted endpoint (or on the global Devices resource).

Examples1. To display the data for OID 1.3.6.1.2.1.1.4.0 on a system at IP address 10.69.2.201, use

the following syntax:wcmd GatewaySNMPService getOid 10.69.2.201 1.3.6.1.2.1.1.4.0OID: 1.3.6.1.2.1.1.4.0Data: [email protected]: 0

See Alsowcmd GatewaySNMPService getnextOid

GatewaySNMPService getOid

149

12.G

ateway

SN

MP

Service

wcmd GatewaySNMPService oidsReturns example OID values.

Syntaxwcmd GatewaySNMPService oids

DescriptionThe wcmd GatewaySNMPService oids command returns example OID values that could beused in other GatewaySNMPService commands. The command does not perform an actionon any object managed by the Gateway SNMP service; instead, it is a form of quickreference for OID values. It might be useful to use this command before running a wcmdGatewaySNMPService setOid command to obtain a list of common OID values. Manydevices have other device-OIDs; this command does not display all possible OIDs for alldevices.

OptionsNone.


Examples1. wcmd GatewaySNMPService oids

Sample list of MIB II OidsSysContact : 1.3.6.1.2.1.1.4.0SysName : 1.3.6.1.2.1.1.5.0SysLocation : 1.3.6.1.2.1.1.6.0

See Alsowcmd GatewaySNMPService setOid

GatewaySNMPService oids

150 Version 1.2

wcmd GatewaySNMPService queryShows the current state of the dispatch queue or the state of the dispatcher.

Syntaxwcmd GatewaySNMPService query {dispatch | queue}

DescriptionThe wcmd GatewaySNMPService query command displays the current state of thedispatch queue or the state of the dispatcher.

Optionsdispatch

Displays the state of the dispatcher, either active (running) or stopped. Also displaysthe requests being dispatched. Requests are indexed by request ID.

queue Displays the state of the queue, either active (running) or stopped. Also displays therequests in the queue. Requests are indexed by request ID.

AuthorizationRequires read right on the targeted Gateway SNMP service (or on the global Gatewayresource).

Examples1. The following shows example output from a wcmd GatewaySNMPService query

dispatch command. The output shows the requests being dispatched:wcmd GatewaySNMPService query dispatchDispatcher Status: active.--------------------------------61: set 1.3.6.1.2.1.1.4.0, data: administrator, on IP(s): 146.84.28.4562: get 1.3.6.1.2.1.1.5.0, on IP(s): 146.84.28.4763: getnext 1.3.6.1.2.1.1.6.0, on IP(s): 146.84.28.50

2. The following shows example output from a wcmd GatewaySNMPService query queuecommand. The output shows the requests that are in the queue, waiting to be dispatched:wcmd GatewaySNMPService query queueQueue Status: active.--------------------------------66: set 1.3.6.1.2.1.1.4.0, data: abc, on IP(s): 146.84.28.3267: get 1.3.6.1.2.1.1.5.0, on IP(s): 146.84.28.4768: getnext 1.3.6.1.2.1.1.6.0, on IP(s):146.84.28.50

See Alsowcmd GatewaySNMPService stop, wcmd GatewaySNMPService resume, wcmdGatewaySNMPService remove, wcmd GatewaySNMPService finish

GatewaySNMPService query

151

12.G

ateway

SN

MP

Service

wcmd GatewaySNMPService removeRemoves a request from the Gateway SNMP service dispatch queue.

Syntaxwcmd GatewaySNMPService remove request_id

DescriptionThe wcmd GatewaySNMPService remove command removes a request from the GatewaySNMP service dispatch queue. A request is an action to be performed on a target. A wcmdGatewaySNMPService getOid command, for example, initiates a request to obtain an OIDfrom a MIB. To obtain a list of the requests in the queue, and their associated IDs, use thewcmd GatewaySNMPService query command with the queue argument.

Optionsrequest_id

The ID of the request to remove from the queue.

AuthorizationRequires execute right on the targeted Gateway SNMP service (or on the global Gatewayresource).

Examples1. The following command removes the request having a request ID of 79:

wcmd GatewaySNMPService remove 79

See Alsowcmd GatewaySNMPService stop, wcmd GatewaySNMPService query, wcmdGatewaySNMPService resume, wcmd GatewaySNMPService finish

GatewaySNMPService remove

152 Version 1.2

wcmd GatewaySNMPService resume

Resumes acceptance or dispatching of new requests.

Syntaxwcmd GatewaySNMPService resume {accept | dispatch}

DescriptionThe wcmd GatewaySNMPService resume command reverses the wcmdGatewaySNMPService stop command. The Gateway SNMP service resumes accepting ordipatching requests.

Optionsaccept Resumes acceptance of requests.

dispatchResumes dispatching of requests.

AuthorizationRequires execute right on the targeted Gateway SNMP service (or on the global Gatewayresource).

See Alsowcmd GatewaySNMPService stop, wcmd GatewaySNMPService query, wcmdGatewaySNMPService remove, wcmd GatewaySNMPService finish

GatewaySNMPService resume

153

12.G

ateway

SN

MP

Service

wcmd GatewaySNMPService setOidSets a new value for the specified OID in the MIB of a device.

Syntaxwcmd GatewaySNMPService setOid ip_address[:nat] oid data [community_name]

DescriptionThe wcmd GatewaySNMPService setOid command writes a new value for an OID in theMIB within the SNMP device.

Optionsip_address

Specifies the IP address of the device containing the MIB in which the new OIDvalue will be written.


oid The MIB OID to contain the data.

data The data to be written to the OID in the MIB.

community_nameSpecifies a community name needed to write data to the MIB in the machineidentified by ip_address. The name specified here overrides the community nameestablished using the wcmd IpConfig addNodeEntry command.

AuthorizationRequires execute right on the NEL service servicing this Gateway (or on the global NELservice) and execute right on the target Gateway SNMP service (or on the global Gatewayresource) and both, deviceExe and deviceWrite rights on the device security groupassociated with the targeted endpoint (or on the global Devices resource).

Examples1. To set the value of OID 1.3.6.1.2.1.1.6.0 to ″The Simulation Lab″ on the systems at IP

address 10.69.2.201, use the following syntax:wcmd gatewaysnmpservice setoid 10.69.2.201 1.3.6.1.2.1.1.6.0 "The Simulation Lab"

See Alsowcmd GatewaySNMPService oids

GatewaySNMPService setOid

154 Version 1.2

wcmd GatewaySNMPService statisticsReturns statistics for an SNMP Gateway.

Syntaxwcmd GatewaySNMPService statistics

DescriptionThe wcmd GatewaySNMPService statistics command displays activity statistics for anSNMP Gateway.

OptionsNone.


Examples1. wcmd gatewaysnmpservice statistics

IGATEWAYPACKETS : 6IPACKETSQUEUED : 0IPACKETSINPROCESS : 0

GatewaySNMPService statistics

155

12.G

ateway

SN

MP

Service

wcmd GatewaySNMPService statusReturns the status of the SNMP Gateway service.

Syntaxwcmd GatewaySNMPService status

DescriptionThe wcmd GatewaySNMPService status command displays the status, running or notrunning, of the SNMP Gateway service.

OptionsNone.


Examples1. The following shows output of the GatewaySNMPService status command when the

service is running. If the service is stopped, the output displays NOT RUNNING.wcmd GatewaySNMPService statusGatewaySNMPService state: RUNNING

See Alsowcmd GatewaySNMPService statistics

GatewaySNMPService status

156 Version 1.2

wcmd GatewaySNMPService stopImmediately stops the Gateway SNMP service, stops acceptance of new requests, or stopsdispatching of queued requests, depending on the options specified.

Syntaxwcmd GatewaySNMPService stop [accept | dispatch]

DescriptionThe wcmd GatewaySNMPService stop command either stops the Gateway SNMP service,stops acceptance of new requests, or stops dispatching of requests, depending on the optionspecified. If one of the optional arguments is not specified, the command stops the GatewaySNMP service.

Optionsaccept Stops acceptance of new requests.

dispatchStops requests from being dispatched.

AuthorizationRequires read and execute rights on the targeted Gateway SNMP service (or on the globalGateway resource) and authority to use the wcmd accmgr stopService command.

See Alsowcmd GatewaySNMPService resume, wcmd GatewaySNMPService query, wcmdGatewaySNMPService remove, wcmd GatewaySNMPService finish

GatewaySNMPService stop

157

12.G

ateway

SN

MP

Service

wcmd GatewaySNMPService traceSNMPStarts or stops a trace of SNMP activities.

Syntaxwcmd GatewaySNMPService traceSNMP {0 | 1}

DescriptionThe wcmd GatewaySNMPService traceSNMP command starts or stops the tracing ofSNMP commands dispatched by the Gateway SNMP service and the responses receivedfrom the endpoints targeted by the commands.

Options0 Turns SNMP tracing off.

1 Turns SNMP tracing on.

AuthorizationRequires write access to the system/services/config subtree.

ExamplesThe following shows the output of a session trace generated by the the wcmdGatewaySNMPService traceSNMP command. This example shows trace output of a consolesession in which an operator issued the following commands:

¶Turn tracing on:wcmd GatewaySNMPService tracesnmp 1

¶Check the setting of an OID:wcmd GatewaySNMPService getOid 146.84.28.47 1.3.6.1.2.1.1.4.0

¶Change the OID’s setting to contain SuperUserwcmd GatewaySNMPService setOid 146.84.28.47 1.3.6.1.2.1.1.4.0 SuperUser

¶Get the OID again to confirm the change took place:wcmd GatewaySNMPService getOid 146.84.28.47 1.3.6.1.2.1.1.4.0

¶Turn tracing offwcmd GatewaySNMPService tracesnmp 0

The trace output from the above sequence resembles the following sample. Each commandcontains an SNMP Gateway dispatch thread, showing the command that was sent to theendpoint, and an SNMP receive thread, showing the response from the endpoint.*** Starting trace at Mon Oct 30 15:56:00 CST 2000SnmpSessionFactory: starting a sessionSnmpSessionFactory: starting a session -- V1==> Sent request to 146.84.28.47 at Mon Oct 30 15:56:14 CST 2000, by Thread[GatewayDispatch,5,main]Message : version=0 communityString=public

errorStatus=Success errorIndex=0 operation=GET requestId=3 correlator=0(

1.3.6.1.2.1.1.4.0Null)

GatewaySNMPService traceSNMP

158 Version 1.2

<== Response from 146.84.28.47 received at Mon Oct 30 15:56:14 CST 2000, by Thread[SnmpReceive,5,main]Message : version=0 communityString=public

errorStatus=Success errorIndex=0 operation=RESPONSE requestId=3 correlator=0(

1.3.6.1.2.1.1.4.0:Administrator)SnmpSessionFactory: starting a sessionSnmpSessionFactory: starting a session -- V1==> Sent request to 146.84.28.47 at Mon Oct 30 15:56:32 CST 2000, by Thread[GatewayDispatch,5,main]Message : version=0 communityString=public

errorStatus=Success errorIndex=0 operation=SET requestId=4 correlator=0(

1.3.6.1.2.1.1.4.0:SuperUser)<== Response from 146.84.28.47 received at Mon Oct 30 15:56:32 CST 2000, by Thread[SnmpReceive,5,main]Message : version=0 communityString=public


1.3.6.1.2.1.1.4.0:SuperUser)SnmpSessionFactory: starting a sessionSnmpSessionFactory: starting a session -- V1==> Sent request to 146.84.28.47 at Mon Oct 30 15:56:38 CST 2000, by Thread[GatewayDispatch,5,main]Message : version=0 communityString=public

errorStatus=Success errorIndex=0 operation=GET requestId=5 correlator=0(

1.3.6.1.2.1.1.4.0Null)<== Response from 146.84.28.47 received at Mon Oct 30 15:56:38 CST 2000, by Thread[SnmpReceive,5,main]Message : version=0 communityString=public


1.3.6.1.2.1.1.4.0:SuperUser)*** Stopping trace at Mon Oct 30 15:56:43 CST 2000


159

12.G

ateway

SN

MP

Service


160 Version 1.2

Info Service

Info Service commands (wcmd info) are used to manage namespaces, ORB sets, and ORBsin a Tivoli Kernel Services installation. A Tivoli Kernel Services installation is the set of allORBs within the distributed system that can communicate with each other. An installationcan be divided into namespaces so that the distributed system can be more easily managed;however, there can only be one Tivoli Kernel Services installation. If two installations aremerged, then one installation is the result. In other words, no operational divisions ordistinctions are attributed to an installation. Instead, the main organizing structure in TivoliKernel Services is the namespace.

NamespacesNamespaces serve as the main organizing construct in Tivoli Kernel Services. Namespacesform flat, non-overlapping structures within the distributed system. The primary purpose of anamespace is to form an identification scope for the objects that exist within it. Objects aretied to a namespace through the creation of an object ID (OID) reference that serves as apersistable, activatable reference for that object. When this occurs, the object becomesassociated with the namespace for the remainder of its lifetime.

For example, ORBs are assigned to one and only one namespace. Once assigned to anamespace, an ORB remains in that namespace forever. Changing the space in which anORB belongs effectively changes the identify of the ORB itself. In fact, the object identifier(OID) of the ORB is actually stored in its keystore and is the identity the ORB assumeswhen it starts up. Generally, namespaces are allocated to match enterprise boundaries, butthe division is arbitrary. For most environments, a single namespace will suffice. However, ifyou are a Service Provider and manage several external customer sites, separate namespaces(one per customer) will be more natural and provide additional security because namespacesprovide built-in security boundaries.

ORB SetsORBs that share common configuration settings can be grouped into an ORB set. UsingORB sets can reduce the time and effort required to make changes to many ORBs becauseconfiguration settings applied to the ORB set affect all ORBs that are members of the set.

For example, suppose a service needs to run on a selected subset of ORBs. Configurationdata written to a specific resource supporting the service is linked to an ORB set thatrepresents the set of all ORBs where the service should run. Any ORB that joins the ORBset will automatically receive the specialized configuration data.

13

161

13.In

foS

ervice

ORB sets can be nested within other ORB sets to provide even more granular control overconfiguration activities. Configuration changes to the parent ORB set affect all ORB setsnested within the parent. See Configuration for additional information about how attributesare colasesced from ORB sets.

DomainsIn a Tivoli Kernel Services environment, you will typically have logical groupings ofmachines. These logical groupings of machines contain the same (or almost the same)components and perform the same functions (security, for example) in their physical regions.These logical groups are called domains and they are implemented using ORB sets. In TivoliKernel Services, a domain is an organizational division of the distributed system that isbased on groups and hierarchies of components in subsystems. Several different domains canexist within an installation and domains can nest within other domains or overlap with otherdomains.

Info ObjectsThe InfoService uses a directory as a storage facility. The InfoService also serves as acontrol point for cross-mounting namespace DirContext instances in separate physicaldirectories. All namespaces, ORB sets, and ORBs are stored by their ID, rather than by theirname, in the directory as objects called info objects. wcmd info commands are used tocreate and destroy these info objects. Figure 1 shows the hierachy of info objects in thedirectory.

wcmd info commands are provide to perform the following functions:

¶ Create namespaces, ORB sets, and ORBs

¶ Destroy namespaces, ORB sets, and ORBs

¶ Cause ORBs to become members of an ORB set

¶ Cause ORBs to leave an ORB set and no longer be a member of that ORB set

¶ Nest ORB sets within other ORB sets

Slash Context

Orb

<OrbID#1>

Orbsets

<JoinedOrbsetID#1> <JoinedOrbsetID#2>

<Namespace ID>

Orbset

<OrbsetID#1>

<MemberOrbID#1> <MemberOrbID#2>

<ParentOrbset#1> <ParentOrbset#2> ChildOrbset#1> ChildOrbset#2>

Parents Children

Figure 1. Info Objects

162 Version 1.2

¶ List all ORBs in an ORB set

User-Friendly NamesWhen an info object like a namespace, ORB set, or ORB is created, it is assigned a lengthy,hexadecimal OID. This long hexadecimal number ensures each object has a unique IDwithin the Tivoli Kernel Services installation. This hexadecimal OID would be verycumbersome if it was the only way to identify objects. To make it easier to refer to objects,you can specify a user-friendly name that is associated with objects, as you create them, thathas some meaning to you within the context of the Tivoli Kernel Services installation andyour organization. When the object is created, the system software allocates a uniquehexadecimal OID for the object and binds the name you specify to the hex OID. An ORB,for example, may have a name that represents the geographic or organizational locationwhere the server is located; names like atlanta or marketing can be used. The names yousupply on wcmd info commands can be of any length and can contain any alphanumericcharacters. If you include a space in an object’s name, however, you’ll need to enclose theobject’s name in double quotes each time you enter the object name on a command. Also,object names are currently case-sensitive, so if you don’t want to use the shift key to enterthem, use only lowercase text when assigning names.

Note: Within the command descriptions in this chapter, the term name refers to theuser-friendly name of an info object and the term OID, or oid, refers to thehexadecimal number associated with the name of an ORB, ORB set, or namespace.Some commands support a -oid option that, if specified, will cause the output from acommand to reflect the numeric OID of the info object targeted by the command. Ifthe -oid option is omitted, commands return the fully-qualified user-friendly namefor the targeted object.


163

13.In

foS

ervice

wcmd info crtNamespaceCreates a namespace in a Tivoli Kernel Services installation.

Syntaxwcmd info crtNamespace [-oid] namespace

DescriptionThe wcmd info crtNamespace command creates a namespace within a Tivoli KernelServices installation.

Options-oid Indicates the command output returns the hexadecimal OID of the info object

targeted by this command.

namespaceSpecify a name for the namespace.

AuthorizationRequires the control access right on the system/services/orb resource.

Examples1. The following command creates a namespace called USA. This command returns the

name of the newly-created namespace.wcmd info crtNamespace USAUSA created

2. The following shows sample output when the -oid option is used.wcmd info crtNamespace -oid USA1.bd7ebc03ec308b9e (USA) created

See Alsowcmd info delNamespace, wcmd info getNamespaces

info crtNamespace

164 Version 1.2

wcmd info crtOrbCreates an ORB within a namespace.

Syntaxwcmd info crtOrb [-oid] [namespace] orb

DescriptionThe wcmd info crtOrb command creates an ORB info object within a namespace.

Options-oid Indicates the command output returns the hexadecimal OID of the info

object targeted by this command.

namespace Specify the name or OID of the namespace in which the ORB is to becreated. The namespace must already exist. If omitted, the currentnamespace is assumed.

orb Specify the name of the ORB that is to be created in the namespace.


Examples1. The following creates an ORB named Austin in the existing USA namespace.

wcmd info crtOrb USA AustinUSA/Orb/Austin created

2. The following sample shows the output when the -oid option is used.wcmd info crtOrb -oid USA Austin3.aceb384066ef9239.1.c46b9bf74dd9327e (Austin) created

See Alsowcmd info delOrb, wcmd info evalOrb, wcmd info getOrbs

info crtOrb

165

13.In

foS

ervice

wcmd info crtOrbsetCreates an ORB set in an existing namespace.

Syntaxwcmd info crtOrbset [-oid] [namespace] orbset

DescriptionThe wcmd info crtOrbset command creates an ORB set in a namespace.

Options-oid Indicates the command output returns the hexadecimal OID of the info

object targeted by this command.

namespace Specify the name or OID of the namespace in which the ORB set is to becreated. The namespace must already exist. If omitted, the currentnamespace is assumed.

orbset Specify the name of the ORB set that is to be created in the namespace.


Examples1. The following command creates an ORB set named Texas in the USA namespace.

wcmd info crtOrbset USA TexasUSA/ORBset/Texas created

2. The following sample shows output if the -oid option is used.wcmd info crtOrbset -oid USA Texas2.6fcf9d02ccc67677.1.bd7ebc03ec308b9e (Texas) created

See Alsowcmd info crtOrbset

info crtOrbset

166 Version 1.2

wcmd info delNamespaceRemoves an empty namespace from an installation.

Syntaxwcmd info delNamespace namespace

DescriptionThe wcmd info delNamespace command deletes an empty namespace from a Tivoli KernelServices installation. All ORB sets and ORBs in the namespace must be removed before thenamespace can be deleted. Command output confirming the deletion contains only the OIDof the deleted namespace because this command removes the namespace name from theTivoli Kernel Services installation.

Optionsnamespace Specifies the name or OID of the namespace to be deleted.


Examples1. The following command deletes the USA namespace.

wcmd info delNamespace USA1.bd7ebc03ec308b9e destroyed

See Alsowcmd info delOrb, wcmd info delOrbset

info delNamespace

167

13.In

foS

ervice

wcmd info delOrbRemoves an ORB from an installation.

SyntaxTo delete an ORB in the current namespace use either of the following:

wcmd info delOrb orb [/force]

wcmd info delOrb Orb/orb [/force]

To delete an ORB in another namespace:

wcmd info delOrb namespace/Orb/orb [/force]

DescriptionThe wcmd info delOrb command deletes an ORB from an installation. If the named ORBis a member of an ORB set, it must be removed from the ORB set before it can be deleted.See “wcmd info leaveOrbset” on page 184.

Options/force Removes the ORB, even if it is a member of an ORB set. Specifying this optional

argument causes the same action as running an wcmd info leaveOrbset commandbefore performing this wcmd info delOrb operation (see “wcmd info leaveOrbset” onpage 184).

namespaceSpecify the name or OID of the namespace in which the ORB resides.

orb Specify the name or OID of the ORB you wish to remove. Command outputconfirming the deletion contains only the OID of the deleted ORB because thiscommand removes the ORB name from the Tivoli Kernel Services installation.


Examples1. The following command, issued from a console in the Europe namespace, deletes an

ORB named Austin in the USA namespace.wcmd info delOrb USA/Orb/Austin3.2e484142b54fe6ca.1.99a1ab54dff5028 destroyed

2. The following command deletes an ORB in the current namespace.wcmd info delOrb Austin3.2e484142b54fe6ca.1.99a1ab54dff5028 destroyed

See Alsowcmd info crtOrb, wcmd info leaveOrbset

info delOrb

168 Version 1.2

wcmd info delOrbsetRemoves an empty ORB set from an installation.

SyntaxTo delete an ORB set in the current namespace use either of the following:

wcmd info delOrbset orbset

wcmd info delOrbset /Orbset/orbset

To delete an ORB set in another namespace:

wcmd info delOrbset namespace/Orbset/orbset

DescriptionThe wcmd info delOrbset command deletes an empty ORB set from an installation. Beforean ORB set can be deleted, all members of the set must be removed from, or be unnestedfrom, the ORB set. This can be accomplished using the in different ways. See “wcmd infodelOrb” on page 168, “wcmd info leaveOrbset” on page 184, and “wcmd info unnestOrbset”on page 194.

Optionsnamespace

Specify the name or OID of the namespace containing the ORB set to be deleted. Ifomitted, the current namespace is assumed.

orbset Specify the name or OID of the ORB set you wish to remove. Command outputconfirming the deletion displays the OID of the deleted ORB set because thiscommand removes the ORB set name from the Tivoli Kernel Services installation.


Examples1. The following command, issued from the Europe namespace deletes the ORB set named

Texas from the USA namespace.wcmd info delOrbset USA/Orbset/Texas2.577d4f28e2a6df39.1.99a1ab54dff5028 destroyed

2. The following command deletes an ORB set from the local namespace.wcmd info delOrbset Texas2.28a95abdff7960b6.1.c46b9bf74dd9327e destroyed

See Alsowcmd info crtOrbset, wcmd info leaveOrbset, wcmd info unnestOrbset

info delOrbset

169

13.In

foS

ervice

wcmd info evalOrbLists the ORB sets to which the specified ORB belongs.

SyntaxTo evaluate an ORB in the current namespace, use either of the following:

wcmd info evalOrb [-oid] orb

wcmd info evalOrb [-oid] Orb/orb

To evaluate an ORB in another namespace, use the following:

wcmd info evalOrb [-oid] namespace/Orb/orb

DescriptionThe wcmd info evalOrb command displays a lists of the ORB sets to which the specifiedORB belongs. This process is referred to as evaluating an ORB.



namespaceSpecify the name or OID of the namespace in which the ORB resides. If omitted,the current namespace is assumed.

orb Specify the name or OID of the ORB to be evaluated.

AuthorizationRequires the query access right on the system/services/orb resource.

Examples1. The following shows sample output from an evaluation of an example ORB named

Austin. The command was issued from a console in the USA namespace. The outputfrom this example shows the Austin ORB is a member of an ORB set named Texas inthe namespace named USA.wcmd info evalOrb AustinUSA/Orbset/Texas

See Also

info evalOrb

170 Version 1.2

wcmd info evalOrbsetLists the ORBs that are members of the specified ORB set.

SyntaxTo evaluate an ORB set in the current namespace, use either of the following:

wcmd info evalOrbset [-oid] orbset

wcmd info evalOrbset [-oid] Orbset/orbset

To evaluate an ORB set in another namespace, use the following:

wcmd info evalOrbset [-oid] namespace/Orbset/orbset

DescriptionThe wcmd info evalOrbset command displays a list of ORBs that are members of thespecified ORB set. This process is referred to as evaluating an ORB set. This command onlydisplays ORBs that are members of an ORB set. To obtain a listing of the ORB sets and theORBs that may be members of an ORB set, see “wcmd info getOrbsetMembership” onpage 177.



namespaceSpecify the name or OID of the namespace in which the ORB set resides. Ifomitted, the current namespace is assumed.

orbset Specify the name or OID of ORB set to be evaluated.


Examples1. The following example shows output from an evaluation of an ORB set named Texas in

the current namespace (myorbs). The output shows the ORB set contains two ORBs,Austin and Dallas.wcmd info evalorbset Texasmyorbs/Orb/Austinmyorbs/Orb/Dallas

2. The following example shows the output obtained if the -oid option is used.wcmd info evalorbset -oid Texas3.7010d1883ebabcbf.1.c46b9bf74dd9327e (Austin)3.9990d1883eb39ebf.1.d88578f74dd9327e (Dallas)

See Alsowcmd info evalOrb

info evalOrbset

171

13.In

foS

ervice

wcmd info getNameShows the user-friendly name associated with an OID.

Syntaxwcmd info getName oid

DescriptionThe wcmd info getName command displays the user-friendly name associated with an OID.

Optionsoid Specify the object identifier (OID) to be resolved. This can be the OID of any info

object: a namespace OID, an ORB set OID, or an ORB OID.


Examples1. The following returns the name of an OID.

wcmd info getname 3.d1dc76f8225ae4c8.1.c46b9bf74dd9327eAustin

To determine the name of the namespace, enter another info getname command andsupply the namespace ID portion of the OID. In this example, the namespace portion ofthe OID is the string 1.c46b9bf74dd9327e.wcmd info getname 1.c46b9bf74dd9327eUSA

See Alsowcmd info setName

info getName

172 Version 1.2

wcmd info getNamespaceOfReturns the namespace of the specified ORB or ORB set OID.

Syntaxwcmd info getNamespaceOf [-oid] oid

DescriptionThe wcmd info getNamespaceOf command displays the user-friendly name of thenamespace in which an ORB or ORB set resides.

Options-oid Indicates the command output is to include the hexadecimal OID and name of the

namespace in which the ORB or ORB set resides.

oid Specifies an entire, hexadecimal OID of an ORB or ORB set.


Examples1. The following shows sample input and output from this command. The sample shows

that the ORB named Austin (OID=3.d25ce6ce543f32e2.1.99a1ab54dff5028) and the ORBset named Texas (OID=2.7b7ca1e157f9d9ff.1.99a1ab54dff5028) both reside in thenamespace called USA.wcmd info getNamespaceOf 3.d25ce6ce543f32e2.1.99a1ab54dff5028USAwcmd info getNamespaceOf 2.7b7ca1e157f9d9ff.1.99a1ab54dff5028USA

2. The following shows sample input and output from this command when the -oid optionis specified. The sample shows the the name and OID of the namespace in which anORB set resides. In this example, the ORB set having the hexadecimal OID of2.9f0cf9bfcd3f2aad.1.b6ed8549b1ae2753 is shown as residing in the tivoli(1.b6ed8549b1ae2753) namespace.wcmd info getNamespaceOf -oid 2.9f0cf9bfcd3f2aad.1.b6ed8549b1ae27531.b6ed8549b1ae2753 (tivoli)

wcmd info getNamespaceOf

173

13.In

foS

ervice

wcmd info getNamespacesLists all namespaces in an installation.

Syntaxwcmd info getNamespaces [-oid]

DescriptionThe wcmd info getNamespace command returns the names of all namespaces that exist in aTivoli Kernel Services installation.




Examples1. The following shows output from this command. The output indicates the existence of

two namespaces in the sample installation: USA and Europe.wcmd info getNamespacesUSAEurope

See Alsowcmd info getOrbs, wcmd info getOrbsets

info getNamespaces

174 Version 1.2

wcmd info getOrbsLists the ORBs in a namespace. A command option can limit the list to contain only theORBs that have a specified attribute.

Syntaxwcmd info getOrbs [-oid]

wcmd info getOrbs [-oid] namespace

wcmd info getOrbs [-oid] key=value...

wcmd info getOrbs [-oid] namespace key=value...

DescriptionThe wcmd info getOrbs command returns a list of ORBs in a namespace. If enteredwithout any arguments, other than -oid, the command returns a list of ORBs in the currentnamespace.



namespaceSpecify the name or OID of a namespace. If omitted, the current namespace isassumed. If namespace is the only argument specified, a list of all ORBs in thespecified namespace is returned.

key=value...Specifies a key and value the ORB must possess to be included in the list of ORBsreturned by this command. If preceded by a namespace, only the ORBs possessingthe key=value pairs in the designated namespace are returned. Separate multiple keyvalue pairs by spaces.

The following keys are available for ORBs.

Keys Definition

type The type of ORB. Valid types are type=server, type=endpoint, type=console.

name The ORB’s name.

hostNames The hostnames of the machine on which the ORB runs.

priHostName On multi-home machines, priHostName specifies the primary hostname of themulti-home machine. Specifying this key allows you to search ORBs running on aspecific host by the primary hostname. On single-host machines, hostName andpriHostName are the same name.

port The port number associated with the ORB.

osname The operating system type of the machine on which the ORB is installed.

osver The version of the operating system under which the ORB runs.

osarch The architecture of the machine on which the ORB runs.

The table below summarizes the settings available for the supported platforms.

Note: When specifying any of the keys below, the key=value string must be enclosed indouble quotes (″ ″) if the string contains spaces, and the attribute name must be

info getOrbs

175

13.In

foS

ervice

entered exactly as shown. The Windows keys, for example, must be specified as″osname=Windows NT″. Key=value pairs without spaces can be quoted, but thequotation marks are not required. For example, the operating system version for AIXcan be specified as osver=4.3 or ″osver=4.3″.

OS osname osarch osver

AIX AIX ppc 4.3

Sun Solaris SunOS sparc 5.7

Windows NT Server V4 Windows NT x86 4.0

Windows NTWorkstation V4

Windows NT x86 4.0

Windows 2000Advanced Server

Windows NT x86 5.0

Windows 2000 Server Windows NT x86 5.0

Windows 2000Professional

Windows NT x86 5.0


Examples1. The following command displays all ORBs in the current namespace.

wcmd info getOrbsUSA/Orb/AustinUSA/Orb/Dallas

2. The following command displays all ORBs in a namespace called Europe.wcmd info getOrbs EuropeEurope/Orb/ZurichEurope/Orb/Paris

3. The following command displays all ORBs in the USA namespace that are on serversrunning Solaris 5.3.wcmd info getOrbs USA osname=Solaris osver=5.3USA/Orb/AustinUSA/Orb/Dallas

4. The following shows the effect of the -oid option on the output. The sample requeststhe names of all ORBs in the USA namespace that have wantnot.dev.tivoli.com astheir primary host.wcmd info getorbs -oid USA priHostName=wantnot.dev.tivoli.com3.dfcc17e46739963c.1.c46b9bf74dd9327e (Austin)3.d1dc76f8225ae4c8.1.c46b9bf74dd9327e (Dallas)

See Alsowcmd info getOrbsets

info getOrbs

176 Version 1.2

wcmd info getOrbsetMembershipReturns a list of all ORBs and ORB sets that are members of the ORB set specified on thecommand.

SyntaxTo target an ORB set in the current namespace, use either of the following:

wcmd info getOrbsetMembership [-oid] orbset

wcmd info getOrbsetMembership [-oid] Orbset/orbset

To target an ORB set in another namespace, use the following:

wcmd info getOrbsetMembership [-oid] namespace/Orbset/orbset

DescriptionThe wcmd info getOrbsetMembership command returns a list all ORBs and ORB sets thatare members of the ORB set specified on the command. To obtain a list of only the ORBsthat are members of an ORB set, see “wcmd info evalOrbset” on page 171.

Options-oid Indicates the command output returns the hexadecimal OID of the info objects


namespaceSpecify the name or OID of the namespace in which orbset exists. If omitted, thecurrent namespace is assumed.

orbset Specifies the name or OID of an ORB set.


Examples1. The following shows sample output from this command. In this example, assume the

ORB set named orbsetA is comprised of orbset1, orbset2, and ORB_Y. The commandreturns ORB set membership information for orbsetA in the current namespace (USA).wcmd info getOrbsetMembership orbsetAUSA/orbset/orbset1USA/orbset/orbset2USA/orb/ORB_Y

See Alsowcmd info evalOrbset

info getOrbsetMembership

177

13.In

foS

ervice

wcmd info getOrbsetsReturns a list of ORB sets in a namespace. A command option can limit the list to containonly the ORB sets that have a specified attribute.

Syntaxwcmd info getOrbsets [-oid]

wcmd info getOrbsets [-oid] namespace

wcmd info getOrbsets [-oid] key=value...

wcmd info getOrbsets [-oid] namespace key=value...

DescriptionThe wcmd info getOrbs command returns a list of ORB sets in a namespace. If enteredwithout any arguments, other than -oid, the command returns a list of ORB sets in thecurrent namespace.



namespaceSpecify the name or OID of a namespace. If omitted, the current namespace isassumed. If namespace is the only argument specified, a list of all ORB sets in thespecified namespace is returned.

key=value...Specifies a key and value the ORBset must possess to be included in the list ofORB sets returned by this command. If preceded by a namespace, only the ORBsets possessing the key=value pairs in the designated namespace are returned.Separate multiple key value pairs by spaces.

The following keys are available for ORB sets.

Keys Definition

name The ORB set’s name.


Examples1. The following command displays all ORB sets in the current namespace (USA).

wcmd info getOrbsetsUSA/Orbset/TexasUSA/Orbset/Georgia

2. The following command displays all ORB sets in a namespace called Europe.wcmd info getOrbs EuropeEurope/Orbset/EnglandEurope/Orbset/France

3. The following command displays all ORB sets in the USA namespace that were createdat a specific time.

info getOrbsets

178 Version 1.2

wcmd info getorbsets USA createTime=968790380841USA/Orbset/Texas

4. The following shows the effect of the -oid option on the output.wcmd info getorbsets -oid USA createTime=9687903808412.2899ff5c170b8bcc.1.c46b9bf74dd9327e (Texas)

See Alsowcmd info getOrbs

info getOrbsets

179

13.In

foS

ervice

wcmd info getPropertiesReturns all properties, including the name, for a given namespace, ORB set, or ORB.

SyntaxTo get the properties of an object identified by its OID, use the following command.

wcmd info getProperties oid

To get the properties of a namespace, use the following command.

wcmd info getProperties namespace

To get the properties of an ORB set, use the following command.

wcmd info getProperties [namespace/]Orbset/orbset_name

To get the properties of an ORB, use the following command.

wcmd info getProperties [namespace/]Orb/orb_name

DescriptionThe wcmd info getProperties command displays all properties associated with a given infoobject: a namespace, an ORB set, or an ORB. The syntax for this command is unlike otherwcmd info commands. Except when specifying a namespace OID, object names must bedelimited using forward slashes (/).

Optionsnamespace/

Specifies a name or OID of the namespace for which properties will be displayed.Unqualified names are assumed to be namespace names.

Orbset/Indicates the name following this is the name of the ORB set for which propertieswill be displayed. If the higher-level namespace qualifier is omitted, the propertiesof orbset_name in the current namespace are displayed.

Orb/ Indicates the name following this is the name of the ORB for which properties willbe displayed. If the higher-level namespace qualifier is omitted, the properties oforb_name in the current namespace are displayed.

oid Specifies the hexadecimal object ID of the namespace, ORB set, or ORB for whichproperties will be displayed. Because an OID is unique in a Tivoli Kernel Servicesinstallation, no other qualifiers are used.


Examples1. To display the properties of a namespace, enter the following command, substituting the

name of the namespace for name.wcmd info getProperties name

2. To display the properties of an ORB set, substitute the name of the ORB set for name.wcmd info getProperties Orbset/name

info getProperties

180 Version 1.2

3. To display the properties of an ORB, substitute the name of the ORB for name.wcmd info getProperties Orb/name

The list of returned properties varies with the object type. The following shows sampleoutput from an ORB.wcmd info getProperties Orb/orb1jvmInfo = build Solaris_JDK_1.2.2_05, native threads, sunwjitosname = SunOSport = 8134priIPAddr = 10.69.2.18modTime = 968707468987createTime = 968389815385priHostName = ynot.dev.tivoli.comoid = 3.d1dc76f8225ae4c8.1.c46b9bf74dd9327ehostNames = ynot.dev.tivoli.comosarch = sparcosver = 5.7name = orb1componentFullVersion = 5.1.0-200009051549ipAddrs = 10.69.2.18

See Alsowcmd info setProperties

info getProperties

181

13.In

foS

ervice

wcmd info getXURLsReturns a list of extended URLs (XURLs) of an ORB.

SyntaxTo obtain the extended URLs of an ORB in the current namespace, use either of thefollowing:

wcmd info getXURLs orb

wcmd info getXURLs [Orb/]orb

To target an ORB in another namespace, use the following:

wcmd info getXURLs namespace/Orb/orb

DescriptionThe wcmd info getXURLs command displays the extended URLs of the ORB identified onthe command line. An extended URL includes the qualified name of the server and port onwhich the ORB is running.

Optionsnamespace

Specify the name or OID of the namespace in which orb resides. If omitted, thecurrent namespace is assumed.

orb Specifies the name or OID of the ORB for which the list of XURLs will bedisplayed.


Examples1. The following command shows the extended URL of an ORB. To obtain a list of ORBs,

use the wcmd info getOrbs command.wcmd info getXurls Austin//wantnot.dev.tivoli.com:8135/

See Alsowcmd info getOrbs

info getXURLs

182 Version 1.2

wcmd info joinOrbsetAdds an ORB to an ORB set.

SyntaxTo add an ORB in the current namespace to an ORB set in the current namespace, use thefollowing:

wcmd info joinOrbset orbset orb

To add an ORB in the current namespace to an ORB set in another namespace, use thefollowing:

wcmd info joinorbset namespace/Orbset/orbset orb

To add an ORB in another namespace to an ORB set, also in another namespace, use thefollowing:

wcmd info joinorbset namespace/Orbset/orbset namespace/Orb/orb

DescriptionThe wcmd info joinOrbset command adds an existing ORB to an existing ORB set.



namespaceSpecify the name or OID of the namespace in which the ORB set resides.

orbset Specify the name or OID of the ORB set the object specified by orb is to join.

orb Specifies the OID or name of the ORB to add to the ORB set identified by orbset.


Examples1. The following example shows an ORB named Austin being added to an ORB set called

Texas.wcmd info joinorbset Texas Austinmyorbs/Orb/Austin now member of myorbs/Orbset/Texas

See Alsowcmd info leaveOrbset, wcmd info unnestOrbset

info joinOrbset

183

13.In

foS

ervice

wcmd info leaveOrbsetRemoves an ORB from an ORB set.

SyntaxTo remove an ORB in the current namespace from an ORB set in the current namespace,use the following:

wcmd info leaveOrbset orbset orb

To remove an ORB in the current namespace from an ORB set in another namespace, usethe following:

wcmd info leaveOrbset namespace/Orbset/orbset orb

To remove an ORB in another namespace from an ORB set, also in another namespace, usethe following:

wcmd info leaveOrbset namespace/Orbset/orbset namespace/Orb/orb

DescriptionThe wcmd info leaveOrbset command removes an ORB from an ORB set.



namespaceSpecify the name or OID of the namespace in which the ORB set resides. Ifomitted, the current namespace is assumed.

orbset Specifies the name or OID of the ORB set from which the object specified by orbwill be removed.

orb Specifies the name or OID of the ORB to remove from the ORB set identified byorbset.


Examples1. The following example shows an ORB named Austin being removed from an ORB set

called Texas.wcmd info leaveorbset Texas Austinmyorbs/Orb/Austin no longer a member of myorbs/Orbset/Texas

See Alsowcmd info joinOrbset, wcmd info unnestOrbset

info leaveOrbset

184 Version 1.2

wcmd info nestOrbsetNests one ORB set within another.

SyntaxTo nest an ORB set within another ORB set when both ORB sets are in the samenamespace, use either of the following:

wcmd info nestOrbset [-oid] parent child

wcmd info nestOrbset [-oid] Orbset/parent child

To nest an ORB set in the current namespace within an ORB set in another namespace, useeither of the following:

wcmd info nestOrbset [-oid] namespace/Orbset/parent child

wcmd info nestOrbset [-oid] namespace/Orbset/parent Orbset/child

To nest an ORB set in another namespace within an ORB set in that same namespace, usethe following:

wcmd info nestOrbset [-oid] namespace/Orbset/parent namespace/Orbset/child

DescriptionThe wcmd info nestOrbset command enables ORB sets to be nested within another ORBset. Changes made to the settings of the parent ORB set affect all ORB sets that are nestedwithin the parent.



namespaceSpecify the name or OID of the namespace in which the parent and child ORB setsreside. If omitted, the current namespace is assumed.

parent Specify the name or OID of the parent ORB set.

child Specify the name or OID of the child ORB set to be nested under the parent.


NotesCircular nesting is not allowed. For example, you cannot perform the following operation.wcmd info nestorbset orbset1 orbset2wcmd info nestorbset orbset2 orbset1

Examples1. Assume the following command was entered from a console in the same namespace as

the ORB sets that are being nested. The command nests the ORB set named Nevadawithin the ORB set named Colorado.wcmd info nestorbset Colorado NevadaUSA/Orbset/Nevada now nested in USA/Orbset Colorado

info nestOrbset

185

13.In

foS

ervice

2. Assume the following command was entered from a console in the USA namespace. Thecommand nests an ORB set named Texas within an ORB set that exists in the Europenamespace. The parent ORB set in this example is named France and the child ORB setis named Texas. The output from the command confirms the action.wcmd info nestorbset Europe/Orbset/France USA/Orbset/TexasUSA/Orbset/Texas now nested in Europe/Orbset/France

3. Assume the following command was entered from a console in the USA namespace. Thecommand nests two ORB sets, both of which exist in a namespace called Europe. In thisexample, the ORB set named Spain is the parent and the ORB set named France is thechild.wcmd info nestorbset Europe/Orbset/Spain Europe/Orbset/FranceEurope/Orbset/France now nested in Europe/Orbset/Spain

See Alsowcmd info joinOrbset, wcmd info unnestOrbset

info nestOrbset

186 Version 1.2

wcmd info refreshCacheRefreshes the InfoService cache with information from the global directory context.

Syntaxwcmd info refreshCache

DescriptionThe wcmd info refreshCache command synchronizes locally cached directory informationwith the global directory context. This command is not needed for day-to-day operations butmight be useful if you suspect the local directory context is out of sync with the globaldirectory context.

OptionsNone.


info refreshCache

187

13.In

foS

ervice

wcmd info setNameSets or changes the name of an Info Object.

SyntaxTo set or change the name of a namespace, use either of the following commands.

wcmd info setName namespace_oid new_name

wcmd info setName old_name new_name

To set or change the name of an ORB set, use either of the following commands.

wcmd info setName ORBset_oid new_name

wcmd info setName [namespace/]Orbset/old_name new_name

To set or change the name of an ORB, use either of the following commands.

wcmd info setName ORB_oid new_name

wcmd info setName [namespace/]Orb/old_name new_name

DescriptionThe wcmd info setName command assigns a name to an info object. This command can beused to change the name of a namespace, ORB set, or ORB.

Optionsnamespace_oid

Specifies the hexadecimal OID of the namespace to which the new_name will beassigned.

ORBset_oidSpecifies the hexadecimal OID of the ORB set to which the new_name will beassigned.

ORB_oidSpecifies the hexadecimal OID of the ORB to which the new_name will be assigned.

namespaceSpecifies the name of the namespace in which the targeted ORB set or ORB resides.If omitted, the current namespace is assumed.

old_nameSpecifies the name of the namespace, ORB set,or ORB to be changed by thiscommand. If an unqualified name is specified, it is assumed to be the name of anamespace. To set the names of ORBs and ORB sets, include the appropriate pathconstants.

new_nameSpecifies the new name of a namespace, ORB set, or ORB.


info setName

188 Version 1.2

Examples1. The following command sequence shows a sample command sequence in which the OID

for an ORB in the current namespace is determined. Once the OID is obtained, it can beused to change the user-friendly name of the ORB. The -oid option on the getorbscommand displays the OIDs for all ORBs in the namespace.wcmd info getorbs -oid3.d1dc76f8225ae4c8.1.c46b9bf74dd9327e (orb1)3.dfcc17e46739963c.1.c46b9bf74dd9327e (orb10)3.c0973e8e53dd8d7e.1.c46b9bf74dd9327e (test)

Use wcmd info setname to change the ORB named test to Production in the currentnamespace.wcmd info setname 3.c0973e8e53dd8d7e.1.c46b9bf74dd9327e Production3.c0973e8e53dd8d7e.1.c46b9bf74dd9327e name changed to Production

If you want to verify the change has occurred, redisplay all ORBs again using wcmdinfo getorbs.wcmd info getorbsmyorbs/Orb/orb1myorbs/Orb/orb10myorbs/Orb/Production

The same sequence could also be performed using the names of the objects, instead ofthe numeric OIDs:wcmd info getorbsorb1orb10testwcmd info setname Orb/test Production3.c0973e8e53dd8d7e.1.c46b9bf74dd9327e name changed to Production

2. The following shows a sample sequence for changing the name of a namespace. Thissequence changes the namespace named Yippie to the name Yahoo. The sample showsthe command using a namespace name, instead of a namespace OID.wcmd info getnamespaces -oid1.c46b9bf74dd9327e (myorbs)1.99a1ab54dff5028 (yourorbs)1.6aa1acf7b65f05ff (Yipee)wcmd info setname Yippie Yahoo1.6aa1acf7b65f05ff name changed to Yahoowcmd info getnamespacesmyorbstorbsYahoo

3.

The following sequence of commands creates a USA namespace and an ORB namedorb1 within that space. The name of the ORB is then changed from orb1 to ORB1.

Create the USA namespace:wcmd info crtnamespace USAusa

Create an orb named orb1 in the USA namespace:wcmd info crtorb USA orb1usa/Orb/orb1

Show the ORBs in the USA namespace:

info setName

189

13.In

foS

ervice

wcmd info getorbs usausa/Orb/orb1

Change the name of orb1 to ORB1:wcmd info setname USA/Orb/orb1 ORB13.7a8ebaa774230dd1.1.6d7d3c9a31071448 name changed to ORB1

Redisplay the ORBs in the USA namespace:wcmd info getorbs USAUSA/Orb/ORB1

See Alsowcmd info getNamespaces, wcmd info getOrbs, wcmd info getOrbsets

info setName

190 Version 1.2

wcmd info setPropertiesSets or changes properties for a namespace, ORB set, or ORB.

SyntaxTo set properties using an OID.

wcmd info setProperties oid key=value [key=value]...

To set or change the name of a namespace, use the following command.

wcmd info setProperties namespace key=value [key=value]...

To set or change the name of an ORB set, use the following command.

wcmd info setProperties [namespace/]Orbset/orbset_name key=value [key=value]...

To set or change the name of an ORB, use the following command.

wcmd info setProperties [namespace/]Orb/orb_name key=value [key=value]...

DescriptionThe wcmd info setProperties command sets or changes properties associated with any infoobject. Properties having to do with the object’s identity or creation cannot be changed. Forexample, you cannot change the name, OID, createTime, and modTime properties of anORB. To display a list of properties for an object see “wcmd info getProperties” onpage 180.

Optionsoid Specifies the hexadecimal object ID of the namespace, ORB set, or ORB for which

properties are being set.

namespaceSpecifies the name of a namespace for which properties are being set. If passed aspart of a qualified name, specifies the name of the namespace in which an ORB orORB set resides.

orbset_nameSpecify the name of the ORB set. If the higher-level namespace qualifier is omitted,properties are set for the named ORB set in the current namespace.

orb_nameSpecifies the name of an ORB. If the higher-level namespace qualifier is omitted,properties are set for the named ORB in the current namespace.

key=valueSpecifies the name of a property key and the value associated with the key.


Examples1. The following sets the osname property for the test ORB in the current namespace.

wcmd info setProperties Orb/test osname=SunOS

info setProperties

191

13.In

foS

ervice

2. Assume the following command was entered from a console in the USA namespace. Thecommand sets the osname property of an ORB named Paris in the Europe namespace.wcmd info setProperties Europe/Orb/Paris osname=SunOS

See Alsowcmd info getProperties, wcmd info setName

info setProperties

192 Version 1.2

wcmd info showListenersShows event listeners that are monitoring the info service.

Syntaxwcmd info showListeners

DescriptionThe wcmd info showListeners command displays all event listeners that are currentlymonitoring the info service on a given ORB.

OptionsNone.


ExamplesTo display the info service listeners in the current ORB, use the following syntax:wcmd info showlistenerscom.tivoli.core.configuration.OrbResourceHandler$2@9cb59b6c

info showListeners

193

13.In

foS

ervice

wcmd info unnestOrbsetRemoves a nested child ORB set from a parent ORB set.

SyntaxTo unnest an ORB set from another ORB set when both ORB sets are in the currentnamespace, use either of the following:

wcmd info unnestOrbset [-oid] parent child

wcmd info unnestOrbset [-oid] Orbset/parent child

To unnest an ORB set in the current namespace from an ORB set in another namespace, useeither of the following:

wcmd info unnestOrbset [-oid] namespace/Orbset/parent child

wcmd info unnestOrbset [-oid] namespace/Orbset/parent Orbset/child

To unnest an ORB set in another namespace from an ORB set in that same namespace, usethe following:

wcmd info unnestOrbset [-oid] namespace/Orbset/parent namespace/Orbset/child

DescriptionThe wcmd info unnestOrbset command removes a nested ORB set from a parent ORB set.Settings in the parent ORB will no longer affect ORBs in the unnested ORB set.

Optionsparent Specifies the name or OID of the parent ORB set.

child Specifies the name or OID of the child ORB set that will be unnested from theparent.


Examples1. Assume the following command was entered from a console in the same namespace as

the ORB sets that are being unnested. The command removes the ORB set namedNevada from the ORB set named Colorado.wcmd info unnestorbset Colorado NevadaUSA/Orbset/Nevada now unnested from USA/Orbset Colorado

2. Assume the following command was entered from a console in the USA namespace. Thecommand unnests an ORB set named Texas from an ORB set that exists in the Europenamespace. The parent ORB set in this example is named France and the child ORB setis named Texas. The output from the command confirms the action.wcmd info unnestorbset Europe/Orbset/France USA/Orbset/TexasUSA/Orbset/Texas now unnested from Europe/Orbset/France

3. Assume the following command was entered from a console in the USA namespace. Thecommand removes an ORB set from its parent. Both the parent and child ORB sets existin a namespace called Europe. In this example, the ORB set named Spain is the parentand the ORB set named France is the child.

info unnestOrbset

194 Version 1.2

wcmd info unnestorbset Europe/Orbset/Spain Europe/Orbset/FranceEurope/Orbset/France now unnested from Europe/Orbset/Spain

See Alsowcmd info nestOrbset

info unnestOrbset

195

13.In

foS

ervice

info unnestOrbset

196 Version 1.2

IpConfig Service

The IpConfig service is used to create and modify SNMP configuration information for IPresources in a Tivoli Kernel Services installation. SNMP configuration information can beapplied to individual IP systems or to groups of IP systems and includes such things as aresource’s read and write SNMP community names, SNMP port number, retry counters andtimeout thresholds. Configuration information can be created or changed for a singleresource, a group of resources, or for an entire subnet.

The IpConfig service can also create security device groups in the Tivoli Kernel Servicessecurity registry. When an IP system or IP group is a member of a security device group,administrators can control which users are allowed to send ICMP or SNMP requests to IPsystems in the security device group. Users attempting to access systems that are membersof a security device group must be successfully authenticated before access is allowed.

The IpConfig service can also be used by large or organizationally-complex installations touse Network Address Translation (NAT) functions supplied by Tivoli Kernel Services. NATfunctions allow you to partition the installation into private IP network namespaces to ensurea unique destination for data sent to an IP address that may exist in more than one IPnetwork namespace. IpConfig commands are used to create and destroy the private IPnetwork namespaces within the directory service. These NAT namespaces are represented byORB sets in the installation.

The IpConfig component must be started before these commands can be used. To start theIpConfig component using the Tivoli Kernel Services access manager CLI, enter thefollowing command:wcmd accmgr startService -s IpConfigImpl

The IpConfig CLI is also enabled when the Network Endpoint Locator service or theGateway SNMP service is started. To start NELS, enter the following command:wcmd accmgr startService -s NelService

To start the Gateway SNMP service, enter the following command:wcmd accmgr startService -s GatewaySNMPService


14

197

14.Ip

Co

nfig

Service

wcmd IpConfig addNATCreates a configuration preferences node for a NAT, or private namespace, for IP addresses.

Syntaxwcmd IpConfig addNAT nat

DescriptionThe wcmd IpConfig addNAT command creates a private IP namespace for IP addresses inthe Tivoli Kernel Services installation. Network Address Translation (NAT) namespacesensure each device in an installation has a unique destination address, even if the installationcontains several IP address namespaces that contain identical IP addresses. Each NATnamespace must contain at least one SNMP and IP Gateway to perform address translationfor devices within the NAT. The address of the correct destination for a packet is uniquelyidentified when the NAT name is appended to the IP address of the intended target.

Optionsnat Specifies a unique name of a NAT namespace as an unquoted string. The name must

contain contiguous characters with no spaces, colons, or semicolons and must notstart with an integer. NAT names are case sensitive.

AuthorizationRequires access right=write to the system/services/config subtree to perform this operation.

ExamplesThe following command could be used to create a private IP network namespace calledDivision1.wcmd ipconfig addnat Division1

There is no output from commands that have successfully added a NAT.

See Alsowcmd IpConfig listNATs, wcmd IpConfig removeNAT

IpConfig addNAT

198 Version 1.2

wcmd IpConfig addNodeEntryCreates or modifies configuration data for an IP address or range of IP addresses.

Syntaxwcmd IpConfig addNodeEntry ip_address[:nat] key=value

DescriptionThe wcmd IpConfig addNodeEntry command adds or modifies configuration data for anIP address or address range. If the data already exists, the keys and values supplied on thecommand line replace the current settings.

Optionsip_address

Specifies the IP address of one or more devices for which configuration data will becreated or modified.

To specify an individual system address, provide a complete IP address such as147.84.25.12.

To specify a group of systems, you can specify a range of addresses using a hyphen(-) or an asterisk (*) as a metacharacter representing all addresses, but only in thelast octet specified in the address. For example, to specify a group of systemscomprised of the addresses from 147.84.25.12 through 147.84.25.72, use thefollowing syntax to specify that range, and add a key=value pair for the node:wcmd ipconfig addnodeentry 147.84.25.12-72 key=value

To add or change configuration data for an entire subnet, place an asterisk in thehost address portion of the IP address, for example, wcmd ipconfig addentry147.84.25.* key=value.

Because range and metacharacter notation is only supported in the last octet that isspecified in an address, wcmd ipconfig addNodeEntry *.*.*.* foo=bar is notvalid notation; however, wcmd ipconfig addNodeEntry * foo=bar is validnotation.

Similarly, wcmd ipconfig addNodeEntry 1.2.3-45.6 foo=bar is not validnotation for a range; however wcmd ipconfig addNodeEntry 1.2.3-45 foo=bar isvalid.

Note: See “wcmd IpConfig findValue” on page 206 for a description of how range(-) and metacharacter (*) notation affects finding values set with thiscommand. Node values set using range notation take precedence over nodevalues set using metacharacter notation. This allows Tivoli Kernel Servicesadministrators to use metacharacter notation to set a key for many devicesand then override some of the device settings using range notation. Do notdefine node entries with overlapping ranges and different key values. SeeExamples


key=valueSpecifies one of the key=value pairs in the table below. To set multiple attributes,

IpConfig addNodeEntry

199

14.Ip

Co

nfig

Service

re-enter this command with the next key=value pair.

key value

backupAddrs Specifies the alternate IP addresses that can manage the targetdevice. Specify a string representing a hostname or an IP addressusing dotted decimal notation. There is no default. Not supportedin R1.

customerName Specifies the name of the organization that controls the device.This could be, for example, a person’s name, a company name,or a department name. This can be any string. There is nodefault.

deviceSecurityGroup Specifies the name of the security registry device security groupwith which this device, or group of devices, is associated. Thiscan be any device security group in the security registry. There isno default.

port Specifies the port on the device through which SNMPcommunications take place. The default port is port 161. Portnumbers are specified as integers and can be in the range of 1<port> 65536 (for portability)

readCommName Specifies the community name for SNMP GET and GETNEXToperations. The default readCommName is public. Thecommunity name can be any string.

retries Specifies the number of times an SNMP request will be retriedbefore the request fails. Must be an integer in the range 0≤retries≤ 5. The default is 3.

timeout Specifies the time, in milliseconds, to wait before an SNMPrequest times out. Must be an integer in the range 500 ≤timeout≤5000. The default is 1000.

writeCommName Specifies the community name for SNMP SET operations. Thedefault writeCommName is public. The community name can beany string.


Examples1. To add a node entry that sets the number of SNMP retries to 2 for all devices having an

address beginning with 1.2.3, enter the following command:wcmd ipConfig addNodeEntry 1.2.3.* retries=2

Node entries containing retries=2 are created for all devices from 1.2.3.0 to 1.2.3.255.The node created in the configuration service by this command is /1/2/3/*.

2. To override the SNMP retry value set in the previous example for only those devices inthe range of addresses between 1.2.3.0 and 1.2.3.10, enter the following command:wcmd ipConfig addNodeEntry 1.2.3.0-10 retries=5

The node created by this command in the configuration service is /1/2/3/0-10.

3. Do not define overlapping ranges that contain different key values. The followingcommand sequence creates a key for retries=2 for a system at 1.2.3.4 in one range and a


200 Version 1.2

key for retries=5 for the same device in another range. Avoid this overlapping andcontradictory setting because the results returned by wcmd IpConfig findValuecommand will be inconclusive.wcmd ipConfig addNodeEntry 1.2.3.0-4 retries=2wcmd ipConfig addNodeEntry 1.2.3.4-8 retries=5

See Alsowcmd IpConfig dumpNode, wcmd IpConfig removeNodeEntry


201

14.Ip

Co

nfig

Service

wcmd IpConfig createSecGroupCreates a device security group resource in the security registry.

Syntaxwcmd IpConfig createSecGroup group_name group_owner

DescriptionThe wcmd IpConfig createSecGroup command creates a device security group resource inthe Tivoli Kernel Services security registry and associates an owner with the group. Theowner attribute indicates the organization that controls or owns the physical devicesassociated with the device group. The object is created in the security registry undersystem/services/gateway/devices. To associate a device or group of devices with a devicesecurity group, use the wcmd IpConfig addNodeEntry command.

A device security group is an object in the security registry that represents one or moredevices that may be accessed by end users through the Network Endpoint Locator service,Gateway IP service, or Gateway SNMP service. When end users attempt to access a devicethat belongs to a device security group, authorization checks are performed usinginformation in the security registry to ensure the user has the appropriate role and accessrights before the user is allowed to perform an action on a secured device.

Any device that is not associated with a device security group cannot be accessed throughthe Network Endpoint Locator service, the Gateway IP service, or the Gateway SNMPservice. (An exception is that any user logged on using the SuperDeviceAdmin role canmanipulate devices whether they belong to a device security group, or not.)

The IpConfig interface can only create, delete, and list device security group objects. Toview all attributes or modify an attribute of a device security group object, you must useSecurity Service Manager (SSM) commands. Use wcmd ssm listAllAttributes to view theattributes of the device group object. Use wcmd ssm modifyAttributes to modify theattributes of an object.

Note: Modifying or deleting an existing device security group object might affect access tonetwork devices.

Optionsgroup_name

Specifies the name of the device security group.

group_ownerSpecifies the name of the organization that manages the devices in the devicesecurity group.

AuthorizationRequires access right=add to the system/services/gateway/devices subcontext in the securityregistry.

See Alsowcmd IpConfig deleteSecGroup, wcmd IpConfig listSecGroups, wcmd ssmlistAllAttributes, wcmd ssm modifyAttributes

IpConfig createSecGroup

202 Version 1.2

wcmd IpConfig deleteSecGroupRemoves a device security group resource from the security registry.

Syntaxwcmd IpConfig deleteSecGroup group_name

DescriptionDeletes a device security group resource in the Tivoli Kernel Services security registry. See“wcmd IpConfig createSecGroup” on page 202 for a description of device security groups.


Note: Deleting an existing device security group object might affect access to networkdevices. Never delete the default device security group object(system/services/gateway/devices/Devices) from the security registry.

Optionsgroup_name

Specifies the name of the device security group to be deleted from the securityregistry.

AuthorizationRequires object access right=del on the item being deleted from the security registry.

See Alsowcmd IpConfig createSecGroup, wcmd IpConfig listSecGroups

IpConfig deleteSecGroup

203

14.Ip

Co

nfig

Service

wcmd IpConfig dumpNATDisplays configuration data associated with devices in the specified NAT namespace.

Syntaxwcmd IpConfig dumpNAT [nat] [–detail]

DescriptionDisplays the configuration data associated with devices in the specified NAT namespace. If aNAT namespace is not specified, the command returns configuration data for all IP addressesnot associated with a NAT.

Optionsnat Specifies the integer ID or name of a private IP network. This option is only used

when the installation contains separate IP namespaces.

-detail Indicates the output should contain preferences nodes and the keys and values inthem. If omitted, the output includes only the names of the preferences nodes thatdefine an IP address in a NAT namespace.

AuthorizationRequires access right=read to the system/services/config subtree to perform this operation.

See Alsowcmd IpConfig listNATs

IpConfig dumpNAT

204 Version 1.2

wcmd IpConfig dumpNodeDisplays configuration data associated with an IP address.

Syntaxwcmd IpConfig dumpNode ip_address[:nat]

DescriptionDisplays configuration data associated with the device identified by its IP address.

Optionsip_address

Specifies the IP address of one or more devices for which configuration data will bedisplayed.


To specify a group of systems, you can specify a range of addresses using a hyphen(-) or an asterisk (*) as a metacharacter for all addresses in the octet, but only in thelast octet specified in the address. For example, to display configuration data for allsystems in the range of addresses from 147.84.25.12 through 147.84.25.72, use thefollowing syntax to specify that range, and add a key=value pair for the node:wcmd ipconfig dumpnode 147.84.25.12-72

To display configuration data for an entire subnet, place an asterisk in the hostaddress portion of the IP address, for example, wcmd ipconfig dumpnode147.84.25.*.

Because range and metacharacter notation is only supported in the last octetspecified in an address, wcmd ipconfig dumpnode *.*.*.* is not valid notation;however, wcmd ipconfig dumpnode * is valid.

Similarly, wcmd ipconfig dumpnode 1.2.3-45.6 is not valid notation for a range;however wcmd ipconfig dumpnode 1.2.3-45 is valid.

Note: Using * and - notation can consume significant resources.



See Alsowcmd IpConfig addNodeEntry, wcmd IpConfig removeNodeEntry

IpConfig dumpNode

205

14.Ip

Co

nfig

Service

wcmd IpConfig findValueDisplays the value of a configuration key for an IP address.

Syntaxwcmd IpConfig findValue ip_address[:nat] key

DescriptionThe wcmd IpConfig findValue command finds and displays the value of a configurationkey for a specific IP address. If a value does not exist for the specified key in theconfiguration settings for the specified address, the command returns NULL. If thekey=value pair that is the target of this command was originally set for a range of addressesusing the wcmd IpConfig addNodeEntry command, this command uses algorithms tolocate the key and value using the most-specific match. Searches are performed in thefollowing order and stop when a matching key is found:

1. Search the preferences node of an unambigous ip address (e.g. 1.1.1.1). The searchterminates when the value is found in the node for this IP address.

2. Search preferences nodes for a range of IP addresses (e.g. 1.1.1.1-10). If more than onerange includes the address (for example, there is a range of addresses that includes1.1.1.1-10 and another range that includes 1.1.1.1-20) the search examines thepreferences node for each range but the results that are displayed depend on which nodethe configuration service returns first; the results are non-deterministic.

3. Search nodes that match addresses created by metacharacter notation on the wcmdIpConfig addNodeEntry that created the node for this address (1.1.1.*).

4. Search the nodes closest to the metacharacter range (1.1.1)

5. Search nodes as they get farther from the metacharacter range (first search 1.1 andfinally 1).

The table below shows an example of the search order for targets that are increasinglyambiguous.

Address Nodes SearchOrder

Notes

1.1.1.1 1 Search for target and key that matches all of the ip_address.

1.1.1.1-10 2 Search for target and key that matches most of the ip_addressand if multiple ranges contain the target, search all ranges

1.1.1.* 3 Search for addresses and key in all addresses possible using ametacharacter range specification on the next highest order ofaddresses.

1.1.1 4

1.1.1-5 5

1.1 A search not attempted on for addresses in this node.

1 A search not attempted on for addresses in this node.

Optionsip_address

Specifies the address of an IP device.

nat Specifies the integer ID or name of a private IP network containing the source or

IpConfig findValue

206 Version 1.2


key Specifies the configuration key to be removed. See the wcmd IpConfigaddNodeEntry command for a list of valid key names.


Examples1. The following command returns the value of the SNMP retries= key for the system at IP

address 1.2.3.4:wcmd ipconfig findvalue 1.2.3.4 retries5

2. The following shows output displayed if the specified key does not exist in theconfiguration data for an address. In this example, the key name nokey does not exist inthe configuation data for the system at IP address 1.2.3.4. The command returns NULL toindicate the key could not be found.wcmd ipconfig findvalue 1.2.3.4 nokeyNULL

See Alsowcmd IpConfig dumpNode

IpConfig findValue

207

14.Ip

Co

nfig

Service

wcmd IpConfig listNATsDisplays the names of private network namespaces (NATs) in the installation.

Syntaxwcmd IpConfig listNATs

DescriptionThe wcmd IpConfig listNATs command returns a list of the private IP network namespaces,or NATs, in the Tivoli Kernel Services installation.

OptionsNone


ExamplesThe following command sequence shows the creation of a NAT and the output of theIpConfig listNATs command confirming that the newly created NAT exists.wcmd ipconfig addnat Division1wcmd ipconfig listnatsDivision1

See Alsowcmd IpConfig addNAT, wcmd IpConfig dumpNAT, wcmd IpConfig removeNAT

IpConfig listNATs

208 Version 1.2

wcmd IpConfig listSecGroupsDisplays device security group resources defined in the security registry.

Syntaxwcmd IpConfig listSecGroup

DescriptionThe wcmd IpConfig listSecGroups command displays device security group resourcesdefined in the Tivoli Kernel Services security registry. See “wcmd IpConfig createSecGroup”on page 202 for a description of device security groups.


OptionsNone.

AuthorizationRequires object access right=view on the system/services/gateway/devices subcontext in thesecurity registry.

See Alsowcmd IpConfig createSecGroup, wcmd IpConfig deleteSecGroup

IpConfig listSecGroups

209

14.Ip

Co

nfig

Service

wcmd IpConfig removeNATDeletes all configuration data for the specified NAT from the configuration service.

Syntaxwcmd IpConfig removeNAT nat

DescriptionThe wcmd IpConfig removeNAT command removes all configuration data associated with aprivate IP network namespace, or NAT, from the configuration service.

Optionsnat Specifies the integer ID or name of a private IP network. This option is only used

when the installation contains separate IP namespaces.


See Alsowcmd IpConfig addNAT, wcmd IpConfig dumpNAT, wcmd IpConfig listNATs

IpConfig removeNAT

210 Version 1.2

wcmd IpConfig removeNodeEntryRemoves configuration data for an IP address or range of addresses.

Syntaxwcmd IpConfig removeNodeEntry ip_address[:nat] key

DescriptionThe wcmd IpConfig removeNodeEntry command removes configuration data for an IPaddress or address range. If configuration data for the specified node does not exist, noaction is performed.

Optionsip_address

Specifies the IP address of one or more devices for which configuration data will beremoved.


To specify a group of systems, you can specify a range of addresses using a hyphen(-) or an asterisk (*) as a metacharacter for all addresses in the octet, but only in thelast octet specified in the address. For example, to display configuration data for allsystems in the range of addresses from 147.84.25.12 through 147.84.25.72, use thefollowing syntax to specify that range, and add a key=value pair for the node:wcmd ipconfig removenodeentry 147.84.25.12-72 key=value

To display configuration data for an entire subnet, place an asterisk in the hostaddress portion of the IP address. For example, wcmd ipconfig removenodeentry147.84.25.*

Because range and metacharacter notation is only supported in the last octetspecified in an address, wcmd ipconfig removenodeentry *.*.*.* is not validnotation; however, wcmd ipconfig removenodeentry * is valid.

Similarly, wcmd ipconfig removenodeentry 1.2.3-45.6 is not valid notation for arange; however wcmd ipconfig removenodeentry 1.2.3-45 is valid.

Note:Use - and * with caution. Once entries for a node have been removed with thiscommand, there is no way to recover that information.


key Specifies one of the keys in the table below. Configuration data associated with thenamed key is removed.

key value

backupAddrs Specifies the alternate IP addresses that can manage the targetdevice. Specify a string representing a hostname or an IP addressusing dotted decimal notation. There is no default. Not supportedin R1.

IpConfig removeNodeEntry

211

14.Ip

Co

nfig

Service

key value

customerName Specifies the name of the organization that controls the device.This could be, for example, a person’s name, a company name,or a department name. This can be any string. There is nodefault.

deviceSecurityGroup Specifies the name of the security registry device security groupwith which this device, or group of devices, is associated. Thiscan be any device security group in the security registry. There isno default.

port Specifies the port on the device through which SNMPcommunications take place. The default port is port 161. Portnumbers are specified as integers and can be in the range of 1<port> 65536 (for portability)

readCommName Specifies the community name for SNMP GET and GETNEXToperations. The default readCommName is public. Thecommunity name can be any string.

retries Specifies the number of times an SNMP request will be retriedbefore the request fails. Must be an integer in the range 0≤retries≤ 5. The default is 3.

timeout Specifies the time, in milliseconds, to wait before an SNMPrequest times out. Must be an integer in the range 500 ≤timeout≤5000. The default is 1000.

writeCommName Specifies the community name for SNMP SET operations. Thedefault writeCommName is public. The community name can beany string.


See Alsowcmd IpConfig addNodeEntry, wcmd IpConfig dumpNode, wcmd IpConfig findValue

IpConfig removeNodeEntry

212 Version 1.2

Java Console Launcher

This command line interface provides a means to start the Java version of the TivoliConsole.

15

213

15.Java

Co

nso

leL

aun

cher

jclauncherStarts the Java version of the Tivoli Console.

Syntaxwcmd jclauncher launchJC [-u username] [-p password] [-s]

DescriptionThe wcmd jclauncher launchJC command starts the Java version of the Tivoli Console.When the command is processed, a signon window is displayed on the screen when silentmode is not used. On Unix systems, the DISPLAY environment variable in theLOCKCfg.properties file must be set to DISPLAY=hostname:0.0 on ORBs that are to run aTivoli Console; hostname must be the fully-qualified hostname of the local (or remote)system on which the Tivoli Console will be displayed.

Options-u username Specifies the name of a user (account) authorized to execute this command.

If omitted, the signon window appears when the console is started. Usersmust provide a user (account) name on the signon screen before consoleoperations can take place.

-p password Specifies the password associated with username. If omitted, the signonscreen appears when the console is started. Users must provide a passwordon the signon screen before console operations can take place.

-s Indicates silent mode of operation. Silent mode is typically used whenexecuting this command from a script and starts the console withoutdisplaying the signon screen, provided that username and password areprovided on the command line.

AuthorizationRequires superadmin authorization.

jclauncher

214 Version 1.2

Local Component Installer

Local Component Installer commands (wcmd lci commands) are used to perform problemdiagnosis and verifying which components are deployed to or retracted from a particularORB. All wcmd lci commands work only on the current ORB, the ORB to which you arecurrently logged in.

Deploying and retracting components are typically performed using the wcmd cdscommands and those commands are described in “Component Distribution Service” onpage 31. The commands in this chapter, Local Component Installer are used to verify anddiagnose functions initiated via the wcmd cds deploy and wcmd cds retract commands.


16

215

16.L

ocal

Co

mp

on

ent

Installer

wcmd lci checkDepotsDisplays components deployed to the current ORB that are not available on a depot used bythe current ORB.

Syntaxwcmd lci checkDepots

DescriptionThis is a diagnostic command that is not used in day-to-day operations. The wcmd lcicheckDepots command displays components deployed to the current ORB that are notavailable on a depot used by the current ORB. This command may be useful in situationswhere a server containing an ORB has been moved to a new location. When moved, anORB may receive deployed software from a different depot than it did previously. Thiscommand can help you determine what software needs to be deployable from the new depotused by this ORB.

OptionsNone


See Alsowcmd lci listDeployedComponentNames, wcmd dci listInstalledComponents

lci checkDepots

216 Version 1.2

wcmd lci listDeployedComponents

Returns the names and version number of all components deployed to the current ORB.

Syntaxwcmd lci listDeployedComponents

DescriptionThe wcmd lci listDeployedComponents command displays a list of all components, byname and version, that have been deployed to the current ORB.

OptionsNone


See Alsowcmd lci listDeployedComponentNames, wcmd dci listInstalledComponents

lci listDeployedComponents

217

16.L

ocal

Co

mp

on

ent

Installer

wcmd lci listDeployedComponentNamesReturns the names of all components deployed to the current ORB.

Syntaxwcmd lci listDeployedComponentNames

DescriptionThe wcmd lci listDeployedComponentNames command displays a list of all componentsthat have been deployed to the current ORB. Component names are displayed withoutversion numbers.

OptionsNone


See Alsowcmd lci listDeployedComponents, wcmd dci listInstalledComponents

lci listDeployedComponentNames

218 Version 1.2

wcmd lci listDiffReturns the names of components that need to be deployed to or retracted from the currentORB.

Syntaxwcmd lci listDiff

DescriptionThe wcmd lci listDiff command displays the names of components that need to be deployedto or retracted from the current ORB.

OptionsNone


See Alsowcmd dci listDiff, wcmd lci listDeployedComponents

lci listDiff

219

16.L

ocal

Co

mp

on

ent

Installer

wcmd lci processQueueCause the events in the Local Component Installer queue to be immediately processed.

Syntaxwcmd lci processQueue

DescriptionIn large Tivoli Kernel Services installations, wcmd cds commands used to deploy or retractcomponents may be queued for processing by the Local Component Installer. The wcmd lciprocessQueue command causes the event in the queue to be immediately processed.

OptionsNone


See Alsowcmd lci showQueue

lci processQueue

220 Version 1.2

wcmd lci showQueueReturns a list of deploy and retract actions currently queued for processing by the LocalComponent Installer.

Syntaxwcmd lci showQueue

DescriptionIn large Tivoli Kernel Services installations, wcmd cds commands used to deploy or retractcomponents may be queued for processing by the Local Component Installer. The wcmd lcishowQueue returns a list of actions currently queued for processing by the LocalComponent Installer.

OptionsNone


See Alsowcmd cds deploy, wcmd cds retract

lci showQueue

221

16.L

ocal

Co

mp

on

ent

Installer

lci showQueue

222 Version 1.2

Logging

Logging commands display or change properties of logging objects. A logging object is afilter, a logger, a handler, or a formatter. Logging commands use the following syntax for alloperations:

wcmd log object [–r resource] {[–g group_name] | [object_name]}{–keys | –get key | –set key=value} | –contents

where:

object Indicates the type of logging object targeted by the command. The name specified inthis field must match the name of preferences node immediately subordinate to thelogging configuration root directory, which is /com/tivoli/util/logging. Choose fromone of the following required selections:

message Indicates this command manipulates the properties of a messagelogger.

trace Indicates this command manipulates the properties of a trace logger.

filter Indicates this command manipulates the properties of a filter.

handler Indicates this command manipulates the properties of a handler.

formatter Indicates this command manipulates the properties of a formatter.

–r resourceOptional. Specifies the name of an ORB or ORB set to process the command. If thecommand is to be processed by the ORB that the administrator is currently loggedon to, omit this flag and the resource name. A resource can be identified using anyof the resource specifications shown on page 55 of this document. Refer also to“Logging CLI Syntax Examples” on page 224 for examples.

–g group_nameOptional. Specifies the name of a group of logging objects. Commands issued to agroup affect properties for all objects in the group.

object_nameMandatory in most cases. See individual commands for exceptions. Specifies thename of the logging object targeted by this command. Property changes are appliedto the logger, filter, formatter, or handler named here.

To specify a single member of a logging group, preface the object name with thename of the group containing the object. Delimit the group name from the objectname with a period (.) or a forward slash (/). For example, given a group named testand a logger named msgLogger, the object name entered for this parameter could bespecified as either test.msgLogger or test/msgLogger.

17

223

17.L

og

gin

g

–keys Displays a list of properties for the named logging object.

–get keyRetrieves information for a single key for the named logging object.

–set key=valueSets a new property for the named logging object.

–contentsDisplays a list of key=value pairs for the logger, formatter, or handler identified byobject_name.

Note: The logging command line interface is only used when using the distributed logmanager. If using a local log manager, logging elements can only be manipulateddirectly by the component via methods in the IBM Logging Toolkit for Java. Thistoolkit is distributed with Tivoli Kernel Services software.

Logging CLI Syntax ExamplesThe following examples are provided to illustrate the use of logging syntax. These examplesuse two arbitrary ORB names: Austin, and Raleigh. Assume the administrator entering thecommands is logged on to the ORB named Austin.

1. The following syntax does not specify a –r resource option so the command instructs theAustin ORB to attach the Austin ORB’s console handler to the Austin ORB’s loggernamed msgLogger. Output from the Austin ORB’s msgLogger is directed to the AustinORB’s console.wcmd log message msgLogger –set handlerNames=console

2. The following syntax does not specify a –r resource option so the command instructs theAustin ORB to attach the Raleigh ORB’s console handler to the Austin ORB’s loggernamed msgLogger. Output from the Austin ORB’s logger is directed to the RaleighORB’s console.wcmd log message msgLogger –set handlerNames=Raleigh/console

Note: The syntax shown above prefixes the handler name with an ORB name. Thisnotation is an option only available on wcmd log message and wcmd log tracecommands and is only allowed when the specified key is handlerNames.

3. The following syntax does specify a –r resource option so the command instructs theRaleigh ORB to change the Raleigh ORB’s configuration to attach the Austin ORB’sconsole handler to the Raleigh ORB’s msgLogger. Output from the Raleigh ORB’smsgLogger is directed to the Austin ORB’s console.wcmd log message –r Raleigh msgLogger –set handlerNames=Austin/console


224 Version 1.2

wcmd log children

Returns a recursive list of objects subordinate to the specified preferences node.

Syntaxwcmd log children –p path [–f]

DescriptionThe wcmd log children command produces a recursive listing of logging objects that arechildren of a given preferences node.

Options–p path

Specifies the fully qualified name of a preferences node. Typically, logging objectsreside in the parent node labeled /com/tivoli/util/logging. Subordinate to that nodeare child nodes for formatters, handlers, message loggers, trace loggers, and filters.

–f Optional. Specifies the full path to each child object will be included in the output.

AuthorizationRequires logRead rights for the node.

ExamplesTo display the children of the /com/tivoli/util/logging/handler node, use the following syntax:wcmd log children -p /com/tivoli/util/logging/handler -f

/com/tivoli/util/logging/handler/logServerHandler/com/tivoli/util/logging/handler/SerialGlobalMsgHandler/com/tivoli/util/logging/handler/1234/com/tivoli/util/logging/handler/ConsoleMsgHandler/com/tivoli/util/logging/handler/SerialGlobalTraceHandler/com/tivoli/util/logging/handler/console/com/tivoli/util/logging/handler/RasPfSerialTraceHandler/com/tivoli/util/logging/handler/FWPConsoleErrMsgHandler/com/tivoli/util/logging/handler/RasPfMFileTraceHandler/com/tivoli/util/logging/handler/log/com/tivoli/util/logging/handler/logFile/com/tivoli/util/logging/handler/msgFile/com/tivoli/util/logging/handler/serialMsgFile/com/tivoli/util/logging/handler/sec/com/tivoli/util/logging/handler/trcFile/com/tivoli/util/logging/handler/MFileGlobalMsgHandler/com/tivoli/util/logging/handler/serialTrcFile/com/tivoli/util/logging/handler/ConsoleTraceHandler/com/tivoli/util/logging/handler/MFileGlobalTraceHandler/com/tivoli/util/logging/handler/log/dbReader/com/tivoli/util/logging/handler/log/dbHandler/com/tivoli/util/logging/handler/log/dbDelete/com/tivoli/util/logging/handler/sec/auditDatabase

log children

225

17.L

og

gin

g

wcmd log dbTest

Tests the connection to the database used by the specified database handler.

Syntaxwcmd log dbTest –l databaseHandlerName [–p]

DescriptionThe wcmd log dbTest command tests the connection to the logging database for thedatabase handler named on the command.

Options–l databaseHandlerName

Specifies name of the handler for which the connection will be tested.

–p Optional. Specifies that a stack trace is to be displayed on the console.


ExamplesTo test the connection to the database servcied by the database delete handler in the groupnamed log (log.dbDelete), use the following syntax:wcmd log dbtest -l log.dbDeleteFNGLG0211I A connection with the logging database has been successfully established.

log dbTest

226 Version 1.2

wcmd log filter

Manipulates properties of logging filters in an ORB or ORB set.

Syntaxwcmd log filter [–r resource] {[–g group_name] | [filter_name]}{–keys | –get key | –set key=value} | –contents

DescriptionThe wcmd log filter command defines or displays properties of filters within an ORB orORB set.

Options–r resource

Optional. Specifies the name of an ORB or ORB set. Commands that include anORB or ORB set name are processed by the named resource, if that resource iscurrently running. Commands not containing a –r option are processed by the ORBfrom which they were issued.

–g group_nameOptional. Specifies the name of the group to which the filter is applied.

filter_nameSpecifies the name of the filter targeted by this command. filter_name is the filterfor which properties are to be set or displayed.

CAUTION:If filter_name is omitted and the –set key=value option is specified, thiscommand will affect the filters for the default loggers. All components andapplications using the default loggers will be affected.

–keys Returns a listing of all keys associated with filter_name.

–get keyReturns a listing of the current setting for the attribute defined by key.

–set key=valueSets a new mask for a filter.

Three filters are provided with the IBM Logging Toolkit for Java. The followingfilters can be associated with a logger or handler:

AnyMaskFilterProcesses log records if any mask bits match. This is the default filter for allloggers and handlers.

AllMaskFilterProcesses log records only if they contain all mask bits.

ExcludeMaskFilterExcludes records having no matching mask bits. By default this filters logrecords having TYPE_NONE.

Table 2 on page 228 shows the mask types for message events. The default filter,AnyMaskFilter, includes all of these message masks. Table 3 on page 228 shows the

log filter

227

17.L

og

gin

g

possible trace mask settings and indicates which trace types are included in theAnyMaskFilter, which is the default filter for trace records.

–contentsDisplays a list of key=value pairs for the filter identified by filter_name.

AuthorizationAll wcmd log commands using –set require logConfigure rights onsystem/services/Logging. All wcmd log commands using –get, –keys, or –contents requirelogRead rights to that same context.

Examples1. By default, the AnyMaskFilter is applied to loggers and handlers. For trace loggers, the

default mask is set to TYPE_DEFAULT_TRACE. Table 3 shows the log records in theTYPE_DEFAULT_TRACE mask. Notice that the default trace mask filters out tracerecords of, for example, TYPE_PERF. If you want to add performance trace records tothe trace logs and continue to log the default record types, enter the following command:

wcmd log filter trcFilter –set "mask=TYPE_DEFAULT_TRACE TYPE_PERF"

Alternatively, the trace logger and its handlers could be configured to use theAllMaskFilter, which would enable all trace record types, including TYPE_PERF, to beprocessed.

Context

Table 2. Message MasksMessage Mask Types Description

TYPE_INFOor

TYPE_INFORMATION

Indicates conditions worthy of noting but that do not require a user to takeany precautions or to perform an action.

TYPE_WARNorTYPE_WARNING

Indicates a condition has been detected that users should be aware of, but auser action is not necessarily required. For example, a warning message mayindicate some aspect of a program did not perform as intended, but defaultswere applied so the program could continue to operate. The program’s outputshould be examined for validity.

TYPE_ERR or TYPE_ERROR Indicates a serious event has occurred, such as a component failed to write adatabase entry.

TYPE_FATAL Indicates a serious event has occurred. Errors of this type generally requirean ORB to be restarted or indicate that a component has shut down becauseattempts to recover from an error have failed.

Table 3. Trace MasksTrace Type Included in

AnyMaskFilter?

Description

TYPE_ALL No Specifies a mask that includes all possible types.

TYPE_API Yes Specifies the method is an entry point for this product,component, or package.

TYPE_CALLBACK Yes Defines a callback method trace point. Callbacks are typicallyused in listener classes, which have registered with another objectto be notified when a specific record occurs.

log filter

228 Version 1.2

Table 3. Trace Masks (continued)Trace Type Included in

AnyMaskFilter?

Description

TYPE_DEFAULT_TRACE Yes Defines the default trace types. All trace records in this set areautomatically included in the AnyMaskFilter.TYPE_APITYPE_CALLBACKTYPE_ENTRYTYPE_EXITTYPE_ERROR_EXCTYPE_MISC_DATATYPE_OBJ_CREATETYPE_OBJ_DELETETYPE_PRIVATETYPE_PUBLICTYPE_STATICTYPE_SVC.

TYPE_ENTRY Yes Defines method entry trace points.

TYPE_ERROR_EXC Yes Defines an error or exception condition trace point.

TYPE_EXIT Yes Defines method exit trace points.

TYPE_LEVEL1 No Defines a low-level trace point that provides very few details.

TYPE_LEVEL2 No Defines a medium-detail trace point that provides more detail thanTYPE_LEVEL1.

TYPE_LEVEL3 No Defines a high-detail trace point that provides the greatest amountof detail, compared to TYPE_LEVEL1 or TYPE_LEVEL2.

TYPE_MISC_DATA Yes Defines a miscellaneous data trace point.

TYPE_NONE No Specifies a null record type that will not pass through a filter; thatis, this record type is not logged.

TYPE_OBJ_CREATE Yes Defines an object creation, or constructor, trace point.

TYPE_OBJ_DELETE Yes Defines an object deletion, or destructor, trace point.

TYPE_PERF No Defines a performance-monitoring trace point.

TYPE_PRIVATE Yes Defines a private method trace point.

TYPE_PUBLIC Yes Defines a public method trace point.

TYPE_STATIC Yes Defines a static method trace point.

TYPE_SVC Yes Defines a service code trace point.

log filter

229

17.L

og

gin

g

wcmd log formatter

Manipulates properties of Logging formatters in an ORB or ORB set.

Syntaxwcmd log formatter [–r resource] {[–g group_name] | [formatter_name]}{–keys | –get key | –set key=value} | –contents

DescriptionThe wcmd log formatter command defines or displays properties of formatters within anORB or ORB set.



–g group_nameOptional. Specifies the name of the group to which the formatter belongs.

formatter_nameSpecifies the name of the formatter targeted by this command. formatter_name is theformatter for which properties are to be set or displayed.

CAUTION:If formatter_name is omitted and the –set key=value option is specified, thiscommand will affect the formatters for the default loggers. All components andapplications using the default loggers will be affected.

–keys Returns a listing of all keys associated with logger_name.


–set key=valueSets a new property for the formatter. The complete list of formatter properties isdescribed in Table 4 on page 231.

–contentsDisplays a list of key=value pairs for the formatter identified by formatter_name.


Examples1. The default formatters do not pass the name of the log server in their formatted output.

To enable output of the logServer field in the log records, enter the following commands:wcmd log formatter minimal –set logServer=true

wcmd log formatter maximal –set logServer=true

log formatter

230 Version 1.2

ContextTable 4 shows the generic properties that can be set for formatters. In this table, the columnlabeled User Configurable? indicates whether this property can be set using wcmd logcommands which include the –set option.

Table 4. Formatter KeysFormatter Keys/Values

Key

Use

rC

onfi

gura

ble? Value Description

className No string Mandatory. Fully qualified name of the class file instantiated tocreate this formatter.

Use:

com.tivoli.util.logging.TraceFormatter

or

com.tivoli.util.logging.MessageFormatter

dateFormat Yes string Optional. Specifies the pattern used by the SimpleDateFormat classwhen formatting a date. Defaults to yyyy.mm.dd.

description Yes string Optional. Provides a description of the formatter, for example, whereand how it is used. Defaults to an empty string. Quotation marksaround the descriptive string are optional.

group No Do not use Supported by the IBM Logging Toolkit for Java but not used byTivoli Kernel Services’ formatters.

name Yes string Optional entry. Specifies the name used by applications to retrievethe formatter. A name can also be specified when the formatter isinstantiated using the className property (see className, below).

separator Yes string Optional. Specifies the string used to separate fields in formattedoutput. Defaults to a single blank.

timeFormat Yes string Optional. Indicates the pattern used by the SimpleDateFormat classwhen formatting a time. Defaults to hh:mm:SS.ssss.

Additional Trace Formatter Keys

logClass Yes Boolean

Default:true

Optional, but defaults to true. Identifies the name of the class thatlogged the trace record.

logDate Yes Boolean

Default:true

Optional, but defaults to true. Indicates the date the trace record waslogged.

logLoggerName Yes Boolean

Default:true

Optional, but defaults to true. Identifies the name of the logger thatcaptured the trace point.

log formatter

231

17.L

og

gin

g

Table 4. Formatter Keys (continued)Formatter Keys/Values

Key

Use

rC

onfi

gura


logMethod Yes Boolean

Default:true

Optional, but defaults to true. Indicates the name of the method intrace logger output.

logPrincipal Yes Boolean

Default:true

Optional, but defaults to true. Specifies the role name (principal) ofthe person using the component/application when the message wasissued.

logServer Yes Boolean

Default:true

Optional, but defaults to true. Indicates the name of the log serverin trace record output.

logThread Yes Boolean

Default:true

Optional, but defaults to true. Indicates the thread ID in trace loggeroutput.

Additional Message Formatter Keys

logClass Yes Boolean

Default:false

Optional, but defaults to false. Indicates the name of the class thatlogged the message record.

logComponent Yes Boolean

Default:false

Optional, but defaults to false. Indicates the name of the componentin message record output.

logDate Yes Boolean

Default:false

Optional, but defaults to false. Indicates the date the message recordwas logged.

logMethod Yes Boolean

Default:false

Optional, but defaults to false. Indicates the name of the method inmessage logger output.

logOrg Yes Boolean

Default:false

Optional, but defaults to false. Indicates the name of theorganization in message record output.

logProduct Yes Boolean

Default:false

Optional, but defaults to false. Indicates the name of the product inmessage record output.

log formatter

232 Version 1.2

Table 4. Formatter Keys (continued)Formatter Keys/Values

Key

Use

rC

onfi

gura


logServer Yes Boolean

Default:false

Optional, but defaults to false. Indicates the name of the log serverin message record output.

log formatter

233

17.L

og

gin

g

wcmd log handler

Manipulates properties of Logging handlers in an ORB or ORB set.

Syntaxwcmd log handler [–r resource] {[–g group_name] | [handler_name]}{–keys | –get key | –set key=value} | –contents

DescriptionThe wcmd log handler command defines or displays properties of handlers within an ORBor ORB set.



–g group_nameOptional. Specifies the name of the group to which the handler belongs.

handler_nameSpecifies the name of the handler targeted by this command. handler_name is thehandler for which properties are to be set or displayed.

CAUTION:If handler_name is omitted and the –set key=value option is specified, thiscommand will affect the handlers for the default loggers. All components andapplications using the default loggers will be affected.

–keys Returns a listing of all keys associated with handler_name.


–set key=valueSets a new property for a handler.The complete list of handler properties is describedin Table 5 on page 235.

–contentsDisplays a list of key=value pairs for the handler identified by handler_name.


Examples1. To increase the batchThreshold value for the default database handler from its default

setting of 50 log records to 100 log records, enter the following command:wcmd log handler dbHandler –set batchThreshold=100

2. The default console handler uses a formatter named minimal. The minimal formattershows only the timestamp and message text on the console. A formatter named maximal

log handler

234 Version 1.2

is defined in the default configuation settings. The maximal formatter displays additionalfields from a log record. To attach the maximal formatter to the default console handler,enter the following command:

wcmd log handler console –set formatterNames=maximal

ContextTable 5 shows the generic properties that can be set for handlers. Tables 6 through 11 listspecific properties for each of the handler types. In these tables, the column labeled UserConfigurable? indicates whether this property can be set using wcmd log commands whichinclude the –set option.

Table 5. Handler KeysHandler Keys/Values

Key

Use

rC

onfi

gura


backupCapacity Yes integer

Default:50000

Specifies the maximun number of logrecords the handler will hold in itsbackup file. See isBackupEnabled.

className No com.tivoli.util.logging.ConsoleHandlercom.tivoli.core.logging.DatabaseHandlercom.ibm.logging.FileHandlercom.ibm.logging.ConsoleHandlercom.ibm.logging.ErrorHandlercom.ibm.logging.MultiFileHandlercom.ibm.logging.SerialFileHandler

Specifies the fully qualified name of theclass file instantiated to create thishandler.

description No string

Default:empty string

Optional. Specifies a description of howand where this handler is used.

filterNames Yes string

Default for trace loggers:trcFilter

Default for message loggers:msgFilter

Optional. Specifies a blank delimited listof filters attached to the logger. Thedefault filters support the maskssupported bycom.ibm.logging.AnyMaskFilter. SeeTable 2 and Table 3 for a list of messageand trace masks, respectively, supportedby the default filters.

formatterNames Yes string


Delimited list of formatter names for thishandler. Delimit names with blank,comma, or tab. If a handler that requiresa formatter is not associated with aformatter, messages will not be printed.

group Do notuse

Do not use Not supported

log handler

235

17.L

og

gin

g

Table 5. Handler Keys (continued)Handler Keys/Values

Key

Use

rC

onfi

gura


isBackupEnabled No Boolean

Default:false

Specifies the backup mode of thehandler. false indicates backup is off.true indicates backup is enabled.

If backup is enabled, the handlerserializes log records to a file if thehandler’s output device is not available.

If backup is disabled, the handler simplyretries sending the record up to thenumber of times specified bymaxRetries.

isCircular Yes Boolean

Default:none

Use only if isSync=true. Indicateswhether the logging queue for thishandler is circular. If true and the queuefills, the next log record replaces theoldest log record.

isLogging Yes Boolean

Default:true

Indicates the state (on or off) of thehandler. If true, the handler is enabled(on). If false, the handler is disabled(off).

maxRetries Yes integer

Default:5

The number of times a handler will retrya failed write.

name No string


Names the handler. Applications canretrieve (get) the handler by name.

objectType No Do not use Supported by the IBM Logging Toolkitfor Java but not used in Tivoli KernelServices Logging.

queueCapacity Yes integer

Default:10000

Specifies the number of log records thishandler can queue.

retryInterval Yes integer

Default:5000 ms

Specifies the number of milliseconds thishandler will wait before retrying a failedwrite.

log handler

236 Version 1.2

Table 6. File Handler KeysFile Handler Keys/Values

Key

Use

rC

onfi

gura


encoding Yes string

Default:no encoding

Specifies the encoding applied (for example UTF-8) to messagesprocessed by this handler.

fileName Yes string Specifies the name of the log file. Separate path entries by a slash (/)or backslash (\). Either slash will be converted to platformrequirements.

Table 7. Multifile Handler KeysMultifile Handler Keys/Values

Key

Use

rC

onfi

gura


maxFiles Yes integer

Default:3

Specifies the number of log files this handler can use.

maxFileSize Yes integer

Default:512 KB

Specifies the maximum size (in KB) of each log file.

Table 8. Server Handler KeysServerHandler Keys/Values

Key

Use

rC

onfi

gura


bulkRecordsSize Yes integer

Default:10

Specifies the number of records sent to the loggingserver when the timeoutPeriod expires.

reopenThreshold Yes Integer

Default:500 ms

Indicates the delay, in milliseconds, between attemptsto connect to the server.

log handler

237

17.L

og

gin

g

Table 8. Server Handler Keys (continued)ServerHandler Keys/Values

Key

Use

rC

onfi

gura


timeoutPeriod Yes integer

Default:10000 ms

Specifies the time, in milliseconds, to wait beforesending the events, even if bulkRecordsSize has notbeen reached.

Table 9. Database Handler KeysDatabaseHandler Keys/Values

Key

Use

rC

onfi

gura


batchThreshold Yes integer

Default:50

Specifies the number of messages to queue before sendingthem to the database.

The driver must support batch updates to use this option.

country Yes string Default: defaultlocale

Country used to store default translation of message text inthe database. This key is not displayed using any of thefollowing commands:

¶ wcmd log handler log.dbHandler -contents

¶ wcmd log handler log.dbReader -contents

¶ wcmd log handler log.dbDelete -contents

driver Yes string

Default:COM.ibm.db2.jdbc.net.DB2Driver

Specifies the name of driver class

language Yes stringDefault:default locale

Language used when storing message text in the database.This key is not displayed using any of the followingcommands:

¶ wcmd log handler log.dbHandler -contents

¶ wcmd log handler log.dbReader -contents

¶ wcmd log handler log.dbDelete -contents

password Yes stringDefault:none

Specifies the database password for username

vault Yes stringDefault:loggingVault

Vault file containing database connection information.

log handler

238 Version 1.2

Table 9. Database Handler Keys (continued)DatabaseHandler Keys/Values

Key

Use

rC

onfi

gura


url Yes string

Default:none

Specifies the URL of the database this handler will use. URLhas the form: url = protocol:subprotocol:connectString

where:

protocol = jdbc

subprotcol = db2 or oracle:oci8 or oracle:thin

connectString = //hostName:dbName or @hostName:dbName

db2 example:

jdbc:db2://cat.tivoli.com/logging

Oracle example:

jdbc:oracle:oci8:@cat.tivoli.com:logging

username Yes string

Default:none

Specifies the user name of the database user.

Table 10. Database Reader KeysDatabase Reader Keys/Values

Key

Use

rC

onfi

gura


fetchSize Yes Integer

Default:100

Specifies the number of rows to retrieve on eachiteration from the database.

query Yes String

Default:SELECT * FROM FNG_LOGDATA

Specifies the SQL query that will be used toretrieve the logs from the database.

log handler

239

17.L

og

gin

g

Table 11. Database Delete KeysDatabase Delete Keys/Values

Key

Use

rC

onfi

gura


purgeErrLogsAfter Yes Integer

Default:7

Indicates all TYPE_ERR records older than ‘x’ days should bedeleted when the next delete operation is performed.

Integer must be in the range of –1 to 365, where:

–1=do not delete TYPE_ERR records.

0=delete all TYPE_ERR records.

purgeFatalLogsAfter Yes Integer

Default:10

Indicates all TYPE_FATAL records older than ‘x’ days should bedeleted when the next delete operation is performed.


–1=do not delete TYPE_FATAL records.

0=delete all TYPE_FATAL records.

purgeInfoLogsAfter Yes Integer

Default:3

Indicates all TYPE_INFO records older than ‘x’ days should bedeleted when the next delete operation is performed.


–1=do not delete TYPE_INFO records.

0=delete all TYPE_INFO records.

purgeWarnLogsAfter Yes Integer

Default:5

Indicates all TYPE_WARN records older than ‘x’ days should bedeleted when the next delete operation is performed.


–1=do not delete TYPE_WARN records.

0=delete all TYPE_WARN records.

wakeupTime Yes Integer

Default:7

Specifies the number of days the delete utility waits for beforeperforming a delete. The valid ranges is 0 to 24 days, where 0disables the delete operation.

log handler

240 Version 1.2

wcmd log ls

Displays summary information about Logging objects within the local ORB.

Syntaxwcmd log ls [–filter | –formatter | –handler | –message | –trace | –all | –help]

DescriptionThe wcmd log ls command displays a information about Logging objects in the local ORB.The information displayed includes whether an object is enabled or disabled, the number ofmessages, trace events, or exceptions a logger has recorded, the handler associated with theobject, and so on. Mutually-exclusive options can restrict the output from this command toinclude Logging objects of a specified type. If no options are specified, information about allLogging objects is displayed.

Options–filter Restricts the output from this command is to include only filter information.

–formatterRestricts the output from this command is to include only formatter information.

–handlerRestricts the output from this command is to include only handler information.

–messageRestricts the output from this command is to include only message loggerinformation.

–trace Restricts the output from this command is to include only trace logger information.

–all Causes information for all Logging objects to be displayed. If no options arespecified, –all is assumed.

–help Displays help information for using this command.


ExamplesThe following is a sample of output from this command. In this example, no options werespecified so information about all types of Logging objects is displayed. This sample hasbeen edited for brevity.wcmd log lsMessageLogger : sec.auditLogger enabled, async, con,1 msgs, 0 exceptionsMessageLogger : directory.msglogger enabled, async, con,0 msgs, 0 exceptionsMessageLogger : orb.msgLogger enabled, async, con,14 msgs, 0 exceptionsMessageLogger : orb.componentManager enabled, async, con,32 msgs, 0 exceptionsMessageLogger : log.msgLogger enabled, async, con,1 msgs, 0 exceptions

The number of Message Loggers on this orb is 5

TraceLogger: log.securityTrace disabled, async, con,0 traces, 0 excepts, 0 dataTraceLogger: orb.componentManager disabled, async, con,

log ls

241

17.L

og

gin

g

0 traces, 0 excepts, 0 dataTraceLogger: log.managerTrace disabled, async, con,0 traces, 0 excepts, 0 dataTraceLogger: directory.conntrace disabled, async, con,0 traces, 0 excepts, 0 data

The number of Trace Loggers on this orb is 4

com.ibm.logging.FileHandler@12cecf5f : bootFilecom.ibm.logging.MultiFileHandler@685e4f56 : gizmo.dev.tivoli.com/msgFileConsoleHandler : gizmo.dev.tivoli.com/console open,

51 queued msgs, 0 sync msgs : gizmo.dev.tivoli.com/consolecom.ibm.logging.MultiFileHandler@88774f51 : gizmo.dev.tivoli.com/trcFileTraceFormatter : maximalMessageFormatter : minimalcom.ibm.logging.AnyMaskFilter@49404f56 : msgFiltercom.ibm.logging.AnyMaskFilter@fc784f51 : trcFiltercom.ibm.logging.AnyMaskFilter@1885cf53 : sec.auditFilter

log ls

242 Version 1.2

wcmd log message

Manipulates properties of message loggers in an ORB or ORB set.

Syntaxwcmd log message [–r resource] {[–g group_name] | [logger_name]}{–keys | –get key | –set key=value} | –contents

DescriptionThe wcmd log message command defines or displays properties of message loggers withinan ORB or ORB set.



–g group_nameOptional. Specifies the name of the group to which the message logger belongs.

logger_nameOptional. Specifies the name of the message logger targeted by this command.

CAUTION:If logger_name is omitted and the –set key=value option is specified, thiscommand will affect the default message logger. All messages from allcomponents and applications using the default message logger will be affected.



–set key=valueSets a new property for a message logger. The complete list of message loggerproperties is described in Table 12 on page 244. If the key=value string containsspaces, enclose the key=value string in double quotes. See “Logging CLI SyntaxExamples” on page 224 for information about when and how you can prefix a key’svalue with an ORB name to attach a remote handler to a logger.

–contentsDisplays a list of key=value pairs for the logger identified by logger_name.


ExamplesIn the example below, assume the following:

consoleis the name of a console handler.

log message

243

17.L

og

gin

g

msgFileis the name of a file handler.

Austinis an ORB containing a grouped message logger named log.msgLogger.

Raleighis an ORB in another machine

1. The example below shows how to attach a handler to a logger in the same ORB. Fromthe Austin console, use the following command:wcmd log message log.msgLogger –set handlerNames=console

2. The example below shows how to attach a handler to a logger from a remote ORB. (See“Logging CLI Syntax Examples” on page 224 for information about when and how youcan prefix a key’s value with an ORB name to attach a remote handler to a logger.)From the Raleigh console use the following command:wcmd log message –r Austin log.msgLogger –set handlerNames=Austin/console

3. The example below shows how to change group properties. From the Austin console,assign handlers to the loggers in the log group using the following command:wcmd log message –g log –set "handlerNames=console msgFile"

Note: Quotes surround key=value pairs that contain spaces.

ContextTable 12 shows the properties that can be set for a message or trace logger. The columnlabeled User Configurable? indicates whether this property can be set using wcmd logcommands which include the –set option.

Table 12. Logger KeysLogger Keys/Values

Key

Use

rC

onfi

gura


className No com.ibm.logging.MessageLoggerorcom.ibm.logging.TraceLogger

Required. Specifies the fully qualifiedname of the class file instantiated tocreate the logger.

client Yes string

Default:an empty string

Optional. Specifies the name of the clientfor which the message event was created;for example, a user name or IP hostname.

component No string


Optional. Specifies the name of thecomponent within the product to whichthis logger belongs.

description No string


Optional. Specifies a description of howand where this logger is used.

log message

244 Version 1.2

Table 12. Logger Keys (continued)Logger Keys/Values

Key

Use

rC

onfi

gura


group Do not use Do not use Supported by the IBM Logging Toolkitfor Java but not used by Tivoli KernelServices’ loggers.

handlerNames Yes string Optional. Specifies a blank delimited listof the names of handlers associated withthis logger instance. If omitted, messagesare not logged or processed by a handler.

isLogging Yes Boolean

Default:true for message loggersfalse for trace loggers

Optional. Specifies the logging state.true indicates logging is enabled. falseindicates logging is disabled.

isSync Yes Boolean

Default:false

Optional. Specifies the logger’s mode.true indicates the logger is insynchronous log mode. false indicatesthe logger is in asychronous log mode.Asynchronous mode allows messages tobe logged and queued for processing bythe handler and formatter. Synchronousmode suspends the thread until themessage is written to the specifieddestination.

messageFile Yes a path to the message file Optional for messages logged using msg()and text() methods but required formessages logged using message()methods, which is the preferredtechnique. Specifies the fully qualifiedname of the file containing message textassociated with message keys.

This key is only applicable to messageloggers and is not used when defining atrace logger.

name No string


Optional. Specifies a names for thelogger. Applications can retrieve thelogger by name.

objectType No do not use Supported by the IBM Logging Toolkitfor Java but not used in Tivoli KernelServices Logging.

organization Yes string


Optional. Specifies the name of theorganization that created this logger. Forexample, a company name.

log message

245

17.L

og

gin

g

Table 12. Logger Keys (continued)Logger Keys/Values

Key

Use

rC

onfi

gura


product Yes string


Optional. Specifies the name of theproduct to which this logger belongs.

server Do not use Do not use Do not use. Used by Tivoli KernelServices to hold the orbId.

suppressedKeys Yes string


Optional. Specifies a blank delimited listof the names of message keys which willbe ignored by the logger.

filterNames Yes string

Default for trace loggers:trcFilter

Default for message loggers:msgFilter

Optional. Specifies a blank delimited listof filters attached to the logger. Thedefault filters support the maskssupported bycom.ibm.logging.AnyMaskFilter. SeeTable 2 and Table 3 for a list of messageand trace masks, respectively, supportedby the default filters.

recordClasses No string

Default:com.ibm.logging.LogRecord

Optional. Specifies a blank delimited listof record classes supported by the logger.The record classes are queried todetermine the values associated withrecord types.

log message

246 Version 1.2

wcmd log trace

Manipulates properties of trace loggers in an ORB or ORB set.

Syntaxwcmd log trace [–r resource] {[–g group_name] | [logger_name]}{–keys | –get key | –set key=value} | –contents

DescriptionThe wcmd log trace command defines or displays properties of trace loggers within anORB or ORB set.



–g group_nameOptional. Specifies the name of the group to which the trace logger belongs.

logger_nameOptional. Specifies the name of the trace logger targeted by this command.

CAUTION:If logger_name is omitted and the –set key=value option is specified, thiscommand will affect the default trace logger. All messages from all componentsand applications using the default trace logger will be affected.



–set key=valueSets a new property for a trace logger. The complete list of trace logger properties isdescribed in Table 12 on page 244. See “Logging CLI Syntax Examples” onpage 224 for information about when and how you can prefix a key’s value with anORB name to attach a remote handler to a logger.

–contentsDisplays a list of key=value pairs for the logger identified by logger_name.


ExamplesBy default, trace loggers are disabled. Two trace loggers are provided in the defaultconfiguration: an ungrouped trace logger having the name trace, and a grouped loggernamed log.managerTrace. To enable the default trace loggers, enter the followingcommands:wcmd log trace trace –set isLogging=true

log trace

247

17.L

og

gin

g

wcmd log trace log.managerTrace –set isLogging=true

To ensure the handlers attached to these loggers are also enabled, use the wcmd log handlercommand.

log trace

248 Version 1.2

Messaging Service Component

Messaging Service Component commands display statistics about the Messaging Service, listsubscribers and publishers of events, set limits for the number of subscribers each MQSeriesserver will accomodate, and add MQSeries servers to the list of servers available toMessaging Service clients in an ORB, for load balancing.

18

249

18.M

essagin

gS

erviceC

om

po

nen

t

wcmd mserv appendServerAppends (adds) an MQSeries server to the list of MQSeries servers that the messagingservice client in an ORB can use.

Syntaxwcmd mserv appendServer server_name[:port]

DescriptionThe wcmd mserv appendServer command adds an existing MQSeries server to the list ofservers a messaging client in the current ORB can use. Appending new MQSeries servers tothe local client list can be performed to distribute the load on the messaging service overadditional MQSeries servers.

Optionsserver_name Specifies the machine name of an existing MQSeries server.

port Specify the port on which the MQSeries server specified by server_namewill listen for requests. The default port for MQSeries servers is port 1414.This argument is optional and is not necessary if you did not change theserver’s port number when the MQSeries server was installed.

AuthorizationRequires examine access to application/TES/01/MetaTes and write access tosystem/services/config.

Examples1. The following command appends an existing MQSeries server to the list of servers the

accessible to the messaging client in the current ORB.wcmd mserv appendserver mq8.tivoli.com

The server, mq8.tivoli.com, must already exist.

mserv appendServer

250 Version 1.2

wcmd mserv listPublishersReturns a list of publishers using the messaging service client in the current ORB.

Syntaxwcmd mserv listPublishers [–s]

DescriptionThe wcmd mserv listPublishers command displays a list of event publishers using themessaging service in the current ORB.

Options–s Displays statistics for each publisher. Statistics must be enabled before

statistics can be displayed in the output from this command.


Examples1. The following command lists the publishers in the current ORB without the statistics (-s)

option.wcmd mserv listPublishers

Publishers for ORBFailover: com.Tivoli.core.failover.common.FTMessage____Total Number Of Publishers: 1

2. The following command lists the publishers in the current ORB and displays statisticsfor each publisher.wcmd mserv listPublishers –s

Publishers for ORBFailover: com.Tivoli.core.failover.common.FTMessageStatistics: EnabledTime Interval: 60 secondsAverage Message Size: 186Largest Message Size: 234Number Of Messages Sent: 10____Total Number of Publishers: 1

See Alsowcmd mserv statistics

mserv listPublishers

251

18.M

essagin

gS

erviceC

om

po

nen

t

wcmd mserv listSubscribersReturns a list of subscribers using the messaging service client in the current ORB.

Syntaxwcmd mserv listSubscribers [–s]

DescriptionThe wcmd mserv listSubscribers command displays a list of subscribers to the messagingservice in the current ORB.

Options–s Displays statistics for each subscriber. Statistics must be enabled before

statistics can be displayed in the output from this command.


Examples1. The following command lists the subsribers in the current ORB without the statistics (-s)

option.wcmd mserv listSubscribers

Subscribers for ORBDirectory: com.Tivoli.core.directory.spi.DirEventMessage____Total Number Of Subscribers: 1

2. The following command lists the subscribers in the current ORB and displays statisticsfor each subscriber.wcmd mserv listSubscribers –s

Subscribers for ORBDirectory: com.Tivoli.core.directory.spi.DirEventMessageTopic: "DIRMASTER"Filter: "target LIKE '/2f17299c44714767/ResourceBundles%'

OR ( action = 'OBJECT_REMOVED'AND ( target = '/2f17299c44714767' ))"target="/2f17299c44714767/ResourceBundles"scope=One-Level Scopelistener=com.tivoli.core.component.ResourceBundleClassLoader@88822903clientContext=DirWrapperContext(/2f17299c44714767/ResourceBundles)

Statistics: EnabledTime Interval: 60 secondsAverage Message Size: 186Largest Message Size: 234Number Of Messages: 10____Total Number of Subscribers: 1

See Alsowcmd mserv statistics

mserv listSubscribers

252 Version 1.2

mserv maxSubscribersPerServerSets the number of subscribers allowed on any single MQSeries server.

Syntaxwcmd mserv maxSubscribersPerServer [number]

DescriptionThe wcmd mserv maxSubscribersPerServer command sets the maximum number ofsubscribers for any single MQSeries server.

Optionsnumber The maximum number of subscribers. The default is 150 subscribers. Setting

the number of subscribers to more than 150 may cause the MQSeries serversto become unstable.


maxSubscribersPerServer

253

18.M

essagin

gS

erviceC

om

po

nen

t

wcmd mserv setServerSets the machine name and port number of the MQSeries server used by the messagingservice client in the current ORB.

Syntaxwcmd mserv setServer server_name[:port]

DescriptionThe wcmd mserv maxSubscribersPerServer command sets the maximum number ofsubscribers for any single MQSeries server.

Optionsserver_name Specifies the machine name of an existing MQSeries server.

port Specify the port on which the MQSeries server specified by server_namewill listen for requests. The default port for MQSeries servers is port 1414.This argument is optional and is not necessary if you did not change theserver’s port number when the MQSeries server was installed.


mserv setServer

254 Version 1.2

wcmd mserv statisticsStarts and stops statistics collection for the messaging service client in the current ORB.

Syntaxwcmd mserv statistics {start | stop} [interval]

DescriptionThe wcmd mserv statistics command starts and stops statistics collection or the messagingservice client in the current ORB. Enabling statistics collection can consume considerableresources.

Optionsstart Enable statistics collection.

stop Disable statistics collection.

interval The period of time for which statistics will be collected; specified only inconjunction with a wcmd mserv statistics start command. The defaultinterval is 60 seconds.


See Alsowcmd mserv listPublishers, wcmd mserv listSubscribers

mserv statistics

255

18.M

essagin

gS

erviceC

om

po

nen

t

mserv statistics

256 Version 1.2

MessagingService Manager

Messaging Service Manager (MSM) commands are used to configure machines runningMQSeries servers. Many of the msm commands require you to specify the name of amachine running MQSeries server software. The names specified for these machines must bethe DNS name of one of the machines where an MQSeries server was installed. Theseservers are designated in the External Services option when the Installation Depotsoftware is installed.


19

257

19.M

essagin

gS

erviceM

anag

er

wcmd msm addServerAdds an MQSeries server.

Syntaxwcmd msm addServer child_host[:port] [parent_host[:port]]

DescriptionThe wcmd msm addServer command sets configuration information for an MQSeriesserver. This command must be run from a Tivoli Kernel Services Installation Depot. Executethe command as many times as needed to create multiple servers.

Optionschild_host

Specify the machine name of a child MQSeries server. See parent_host descriptionfor additional information.

parent_hostSpecifies the machine name of a parent MQSeries server. If a parent_host is notspecified, the server identified by child_host is added as a child of the rootMQSeries server. (The root MQSeries server is specified when the installation depotis installed and you are prompted for the name of the MQSeries Server; it is notinitially configured using this command.) If parent_host is specified, the child_hostspecified becomes a child server to the specified parent_host.

port Specify the port on which the MQSeries server will listen for requests. The defaultport for MQSeries servers is port 1414. This argument is optional and is notnecessary if you did not change the server’s port number when the server wasinstalled.

AuthorizationRequires write access to system/services/MSM/01/MSManager.

Examples1. The following command adds an MQSeries server as a child of the root server

wcmd msm addserver mq2.tivoli.com

2. The following command adds a child server to a parent server named mq2.tivoli.com.wcmd msm addserver mq3.tivoli.com mq2.tivoli.com

3. The following command adds a child server named mq2.tivoli.com to the root server andconfigures the child to use a non-default port:wcmd msm addserver mq2.tivoli.com:1415

See Alsowcmd msm removeServer

msm addserver

258 Version 1.2

wcmd msm hierarchyTestTests communications between the root MQSeries server and all child servers.

Syntaxwcmd msm hierarchyTest

DescriptionThe wcmd msm hierarchyTest command tests communications between the root MQSeriesserver and all the child MQSeries server nodes. The command creates a publisher on theroot MQSeries server, creates subscribers on all the children under the root server, and thenpublishes a message to the root server and all child nodes.

OptionsNone.


Examples1. The following illustrates sample output from a hierarchy test:

wcmd msm testhierarchy

Starting Connection Test:Parent Node: parent.dev.Tivoli.com------ Delivery: PASSED

Child Node: child1.dev.Tivoli.com------ Delivery: PASSED

Child Node: child2.dev.Tivoli.com------ Delivery: PASSED

Child Node: child3.dev.Tivoli.com------- Delivery: PASSED

Ending Connection Test.

msm hierarchyTest

259

19.M

essagin

gS

erviceM

anag

er

wcmd msm removeServerDeletes configuration information for a MQSeries server.

Syntaxwcmd msm removeServer host_name[:port]

DescriptionThe wcmd msm removeServer command deletes configuration information for anMQSeries server. This command must be run from a Tivoli Kernel Services InstallationDepot. The root MQSeries server can only be removed after any child servers are removed.

Optionshost_name

Specify the name of the server to be deleted. The name specified must be the DNSname of one of the servers added in the Externel Services prompt when theInstallation Depot was installed.

port Specify the port on which the MQSeries server will listen for requests. The defaultport for MQSeries servers is port 1414. This argument is optional and is notnecessary if you did not change the server’s port number when the server wasinstalled.


Examples1. The following command deletes the configuration data for a MQSeries server named

mq2.tivoli.com. This server was not installed on the default port so the port number fromwhich the server will be removed is specified on the command line.wcmd msm removeserver mq2.tivoli.com:1415

See Alsowcmd msm addServer

msm removeServer

260 Version 1.2

wcmd msm statusDisplays status of MQSeries servers.

Syntaxwcmd msm status

DescriptionThe wcmd msm status command displays status of MQSeries servers. The commandreturns the name of the installation depot where the Messaging Service Manager component,which monitors MQSeries servers, is running. It also displays the names of servers acting asroot server, parent servers and child servers. This command must be executed from theinstallation depot.

OptionsNone


Exampleswcmd msm statusRemote manager running id.megacorp.com_9990

rootqm.tivoli.com:1414 connected monitored by id.tivoli.com_9990mq2.tivoli.com:1414 connected monitored by id.tivoli.com_9990

See Alsowcmd msm addServer, wcmd msm removeServer

msm status

261

19.M

essagin

gS

erviceM

anag

er

msm status

262 Version 1.2

Network Endpoint Locator Service

The Network Endpoint Locator (NEL) service is used by Tivoli Kernel Services gatewayapplications. The NEL service is used by gateway API classes called action objects, whichare typically SNMP and IP requests. The action objects are instantiated in gatewayapplications. The NEL sevice performs lookups on behalf of the gateway application to helpthe application locate a gateway of the correct type (SNMP or IP) and addressing range, toperform the actions requested by the application on an endpoint.

Before the NEL commands can be used, the NEL service must be started. To start the NELservice, enter the following command:wcmd accmgr startservice -s NelService



20

263

20.N

etwo

rkE

nd

po

int

Lo

cator

Service

wcmd NelService clearDefaultGatewayClears (unsets) the default gateway server for a particular gateway service protocol.

Syntaxwcmd NelService clearDefaultGateway {SNMP | IP} [.allorbs | resource]

DescriptionThe wcmd NelService clearDefaultGateway command removes configuration informationfor a default Gateway server that was previously set using a wcmd NelServicesetDefaultGateway command.

OptionsSNMP Indicates the default gateway SNMP service will be cleared.

IP Indicates the default gateway IP service will be cleared.

.allorbs Indicates the configuration data defining the default gateway for the IP orSNMP gateway will be cleared from all ORBs in the installation. If .allorbsis omitted and another resource is not specified, the command defaults to.allorbs.

resource Specifies an individual ORB or ORB set. Configuration data defining thedefault IP or SNMP gateway will only be cleard from this ORB or ORB setand not from .allorbs. The resource can be specified using any of thesyntaxes supported by the configuration service. See “resource” on page 55for valid syntax.

AuthorizationRequires write access to the target NEL service or the global NELS resource as well aswrite access to the system/services/config resource.

Examples1. The following command clears the default gateway IP service configuration settings from

all ORBs in the installation. The command is followed by a confirmation message.wcmd NelService clearDefaultGateway IP .allorbsThe DefaultGatewayIP configuration was removed

2. The following command clears the the default gateway SNMP service configurationsettings from a specific ORB set.wcmd NelService clearDefaultGateway SNMP Orbset/TexasThe DefaultGatewaySNMP configuration was removed

See Alsowcmd NelService setDefaultGateway, wcmd NelService listGateway

NelService clearDefaultGateway

264 Version 1.2

wcmd NelService clearGatewayUnsets (clears) the scope of the specified gateway service.

Syntaxwcmd NelService clearGateway {SNMP | IP} orb [.allorbs | resource]

DescriptionThe wcmd NelService clearGateway command removes configuration data defining agateway’s scope that was previously set using a wcmd NelService setGateway command.

OptionsSNMP Indicates the scope information for the gateway SNMP service on the

designated ORB will be cleared.

IP Indicates the scope information for the gateway IP service on the designatedORB will be cleared.

orb Identifies the ORB name or ORB object identifier of the gateway for whichthe scope is being cleared.

.allorbs Indicates the configuration data defining the gateway’s scope will beremoved from all ORBs in the installation. If .allorbs is omitted and anotherresource is not specified, the command defaults to .allorbs.

resource Specifies an individual ORB or ORB set. Configuration data defining thescope of the IP or SNMP gateway running on the orb named above will onlybe removed from this ORB or ORB set and not from .allorbs. The resourcecan be specified using any of the syntaxes supported by the configurationservice. See “resource” on page 55 for valid syntax.


Examples1. The following command clears all scope information previously defined (using wcmd

NelService setGateway) for the gateway IP service running on the ORB namedaustin.dev.tivoli.com_9990. A resource is not specified so the default .allorbs applies andscope data for the austin ORB is removed from all orbs in the installation.wcmd NelService clearGateway IP austin.dev.tivoli.com_9990

The GatewayIP austin.dev.tivoli.com_9990 configuration was removed

See Alsowcmd NelService clearDefaultGateway, wcmd NelService setGateway

NelService clearGateway

265

20.N

etwo

rkE

nd

po

int

Lo

cator

Service

wcmd NelService listGatewayReturns the configuration data for a gateway.

Syntaxwcmd NelService listGateway{SNMP | IP}

DescriptionThe wcmd NelService listGateway command displays configuration information for thegateway type specified on the command line.

OptionsSNMP Indicates the output from this command should only contain configuration

information for SNMP gateways.

IP Indicates the output from this command should only contain configurationinformation for IP gateways.

AuthorizationRequires read access to the target NEL service or the global NELS resource.

Examples1. To display the configuration for IP gateways, use the following syntax:

wcmd NelService listGateway IP* * * * * * * * * * * * * * * * * * * * * * * *Current ip default gateway: Not defined.Gateway 1

ORB/Oid : lturner2.dev.tivoli.com_9990Subnet Address : 146.84.29.109Subnet Mask : 255.255.0.0Nat id : 0

Gateway 2ORB/Oid : lturner2.dev.tivoli.com_9991Subnet Address : 146.84.30.120Subnet Mask : 255.255.0.0Nat id : 0

* * * * * * * * * * * * * * * * * * * * * * * *

2. To display configuration information for SNMP gateways, use the following syntax:wcmd NelService listGateway SNMP* * * * * * * * * * * * * * * * * * * * * * * *Current SNMP default gateway: lturner2.dev.tivoli.com_9990



* * * * * * * * * * * * * * * * * * * * * * * *

See Alsowcmd NelService resolveEndpoint

NelService listGateway

266 Version 1.2

wcmd NelService listNATsDisplays the names of private network namespaces (NATs) in the installation.

Syntaxwcmd NelService listNATs

DescriptionThe wcmd NelService listNATs command returns a list of the private IP networknamespaces, or NATs, in the Tivoli Kernel Services installation.

OptionsNone

AuthorizationRequires read access to the system/services/config subtree.

NelService listNATs

267

20.N

etwo

rkE

nd

po

int

Lo

cator

Service

wcmd NelService resolveEndpointResolves an endpoint using configuration data.

Syntaxwcmd NelService resolveEndpoint {SNMP | IP} ip_address[:nat]

DescriptionThe wcmd NelService resolveEndpoint command causes the Network Endpoint LocatorService to resolve the endpoint address provided on the command line, using the currentconfiguration data. The type of endpoint must be specified. Output from the command isdisplayed on the console.

OptionsSNMP Specifies the endpoint is an SNMP endpoint.

IP Specifies the endpoint is an IP endpoint.

ip_address Specify the IP address of the endpoint to be resolved.

nat Specifies the integer ID or name of a private IP network containing the IPaddress. This option is only used when the installation contains separate IPnamespaces. Separate nat from the IP address with a colon (:).

AuthorizationRequires execute access to the target NEL service or the global NELS resource.

Examples1. wcmd NelService resolveEndpoint IP 146.84.29.114

* * * * * * * * * * * * * * * * * * * * * * * *Contents of resolved endpoint:IP Address: 146.84.29.114SubMask: 0.0.0.0Action Object Type: 4Private Network Id: 0NEL Status: 32Protocol: 0Security Group: Not definedService: Not definedGateway Route: lturn3.dev.tivoli.com_9990

Note: If the Gateway that services the endpoint is not found or not running, the GatewayRoute: line in the output will show the words Not Defined.

See Alsowcmd NelService listGateway

NelService resolveEndpoint

268 Version 1.2

wcmd NelService setDefaultGatewaySets the default gateway server for a particular gateway service protocol.

Syntaxwcmd NelService setDefaultGateway {SNMP | IP} orb [.allorbs | resource]

DescriptionThe wcmd NelService setDefaultGateway command specifies which ORB is hosting thedefault gateway service for a particular gateway service protocol (IP or SNMP). The defaultgateway service is used to perform operations on endpoints that are not explicitly within thescope of any other gateway server.

OptionsSNMP Specifies the GatewaySNMPService on the ORB identified by orb will act

as the default gateway service for SNMP requests directed to endpoints thatare not within another gateway server’s scope.

IP Specifies the GatewayIPService on the ORB identified by orb will act as thedefault gateway service for IP requests directed to endpoints that are notwithin another gateway server’s scope.

orb Identifies the ORB name or ORB object identifier of the ORB hosting thedefault GatewayIPService or GatewaySNMPService.

.allorbs Indicates the configuration settings defining the default gateway for the IP orSNMP gateway will be set in all ORBs in the installation. If .allorbs isomitted and another resource is not specified, the command defaults to.allorbs.

resource Specifies an individual ORB or ORB. Configuration data defining the defaultIP or SNMP gateway will only be set in this ORB or ORB set and not in.allorbs. The resource can be specified using any of the syntaxes supportedby the configuration service. See “resource” on page 55 for valid syntax.


Examples1. The following command sets the gateway IP service running on the ORB named

austin.dev.tivoli.com_9990 as the default gateway IP service. A resource is not specifiedso all orbs in the installation are configured to use the austin ORB as the default IPgateway service to perform operations on endpoints that are not explicitly defined inanother gateway’s scope.wcmd NelService setDefaultGateway IP austin.dev.tivoli.com_9990The DefaultGatewayIP was set to austin.dev.tivoli.com_9990

2. The following syntax sets the gateway SNMP service running on the ORB having anOID of 3.56f26e56c73e41cf.1.59611c956c0398fd as the default gateway SNMP service:wcmd NelService setDefaultGateway SNMP 3.56f26e56c73e41cf.1.59611c956c0398fdThe DefaultGatewaySNMP was set to 3.56f26e56c73e41cf.1.59611c956c0398fd

See Alsowcmd NelService clearDefaultGateway, wcmd NelService listGateway

NelService setDefaultGateway

269

20.N

etwo

rkE

nd

po

int

Lo

cator

Service

wcmd NelService setGatewaySets the scope of the specified gateway service.

Syntaxwcmd NelService setGateway {SNMP | IP} orb scope [.allorbs | resource]

DescriptionThe wcmd NelService setGateway command sets the scope of the specified gatewayservice type on the named ORB. A gateway’s scope is the set of endpoint addresses forwhich the gateway service will process IP or SNMP requests. IP and SNMP requestsaddressed to endpoint addresses that are not within a gateway’s defined scope are processedby the default gateway service defined for the request type. That is, IP requests sent todevices not identified within the scope of a gateway IP service are processed by the defaultgateway IP service and SNMP requests sent to devices not identified within the scope of agateway SNMP service are processed by the default gateway SNMP service.

If this command is entered more than once, the new scope information replaces anypreviously defined scope information.

OptionsSNMP Specifies the gateway on the named ORB is an SNMP gateway.

IP Specifies the gateway on the named ORB is an IP gateway.

orb Identifies the ORB name or ORB object identifier of the IP or SNMPgateway for which the scope is being set.

scope Specifies the scope of addresses for which this gateway service will processrequests. Scope is specified as a one or more colon-delimited strings thatcontains the IP address, subnet mask, and private network namespace (NAT)for one or more devices. If more than one colon-delimited string is specified,the colon-delimited strings are delimited by semicolons (See Examples).

¶ The IP address specifies the device’s IP address in dotted-decimalnotation.

¶ The subnet mask must also be specified in dotted-decimal notationderived from the binary form of a well-formed mask, which is a seriesof contiguous 1s followed by a series of contiguous 0s. For example,11111111 11111111 00000000 00000000 is a well-formed binary subnetmask that translates to the dotted decimal form of 255.255.0.0. 111111111110111 00000000 (255.255.239.0) is not well-formed.

¶ The NAT specifies the numeric identifier of a private networknamespace created using the IpConfig addNat command (See “wcmdIpConfig addNAT” on page 198.)

The IP address is ANDed with the subnet mask to provide a scope ofaddresses within the specified NAT.

.allorbs Indicates the configuration data defining the gateway’s scope will be addedto all ORBs in the installation. If .allorbs is omitted and another resource isnot specified, the command defaults to .allorbs.

resource Specifies an individual ORB or ORB set. Configuration data defining thescope of the IP or SNMP gateway running on the orb named above will only

NelService setGateway

270 Version 1.2

be set in this ORB or ORB set and not in .allorbs. The resource can bespecified using any of the syntaxes supported by the configuration service.See “resource” on page 55 for valid syntax.


Examples1. The following command sets scope of the gateway IP service running on the ORB

named austin.dev.tivoli.com_9990 to include all IP endpoints within the 255.255.255.0subnet attached to the router at 142.81.10.150 in NAT 1. A resource is not specified soall orbs in the installation are updated with configuration data indicating the scope ofaddresses handled by the gateway IP service on the austin ORB.

wcmd NelService setGateway IPaustin.dev.tivoli.com_9990 142.81.10.150:255.255.255.0:1

The GatewayIP austin.dev.tivoli.com_9990 was configured successfully

2. The following syntax sets the scope of the gateway SNMP service running on the ORBnamed devsys3.tivoli.com_9990 to include all SNMP endpoints within:

¶ the 255.255.255.0 subnet attached to the router at 142.81.10.150 in NAT 0, and

¶ the 255.255.128.0 subnet attached to the router at 10.62.155.18 in NAT 2.

wcmd NelService setGateway SNMPdevsys3.tivoli.com_9990142.81.10.150:255.255.255.0:0;10.62.155.18:255.255.128.0:2

Note the semicolon (;) between the colon-delimited strings.

The command displays a message indicating success or failure of the scope definition:The GatewaySNMP devsys3.tivoli.com_9990 was configured successfully

See Alsowcmd NelService listGateway, wcmd NelService setDefaultGateway, wcmd IpConfigaddNAT, wcmd IpConfig listNATs

NelService setGateway

271

20.N

etwo

rkE

nd

po

int

Lo

cator

Service

wcmd NelService statusReturns the status of the Network Endpoint Locator service.

Syntaxwcmd NelService status

DescriptionThe wcmd NelService status command displays the status of the Network Endpoint Locatorservice.

OptionsNone.

AuthorizationRequires read access to the target NEL service or the global NELS resource.

Exampleswcmd NelService status.NEL state:- RUNNING

NelService status

272 Version 1.2

Object Request Broker

Object Request Broker (ORB) commands are used to manage ORBs in the Tivoli KernelServices installation. ORB commands can be used to display ORB configuration data relatedto ORB connections, display thread and method information, and shutdown or recycle anORB. All ORB commands have the bundle name orb.


21

273

21.O

bject

Req

uest

Bro

ker

wcmd orb connectionsLists open connections in an ORB.

Syntaxwcmd orb connections

DescriptionThe wcmd orb connections command displays current connection management statistics foran ORB. The information displayed contains the number of server connections that are open,the number of client connections that are open, the number of client connections that are idleand the time they have been idle, and so on. The default installation behavior is that thereare no limits on these settings. To set limits for ORB connections, use the configurationservice commands (see “wcmd cfg put” on page 73) and specify/com/tivoli/core/orb/voyager/connection as the pathname. Setting a value of -1 placesno limit on the number of connections.

The table below shows the keys that can be set to impose limits on ORB connections

Key Description

clientIdleTime Maximum time, in ms, a client-side connection will wait before closing.

maxClientConnections Maximum number of of client-side connections allowed.

maxClientIdleConnections Maximum number of idle connections allowed.

maxLiveConnections Maximum number of live (active+idle) connections allowed.

maxServerConnections Maximum number of server-side connections allowed.

serverIdleTime Maximum time in ms a server-side connection will wait before closing.

OptionsNone

AuthorizationRequires query access to system/services/orb.

Examples1. By default, there are no limits on any of the keys. If you have not set limits, the default

output will display as follows:wcmd orb connectionsPolicy Name: Connection ManagementCasePolicy( NO_LIMITS )

2. If limits have been set, the output displays the current settings:wcmd orb connectionsPolicy Name: Connection ManagementCasePolicy( serverIdle=5000 )

See Alsowcmd orb threads

orb connections

274 Version 1.2

wcmd orb odstatDisplays recent remote method calls.

Syntaxwcmd orb odstat

DescriptionThe wcmd orb odstat command displays a list of the method invocations on the ORB. Bydefault, the following fields are displayed:

¶ Method ID

¶ Parent ID

¶ Time Dispatched

¶ Duration

¶ Method Type (Synchronous/Asynchronous)

¶ Exit Status. Exit status may contan any of the following characters: . e E ?. A period(.) indicates a normal exit occurred. A lowercase e indicates an exception exit. Anuppercase E indicates ORB exception exit. A question mark (?) indicates the method isstill running.

¶ Method Description. The method description includes the method name, number ofagurments, and the arguments invoked.

¶ Class Name

The fields in the output can be configured using the keys shown below. To set a key, see“wcmd cfg put” on page 73. The node containing odstat keys is: /com/tivoli/core/orb.

Key Type Description

odstat.argsWidth int The width, in characters, reserved for each argument.

odstat.logDepth int The maximum number of entries in the odstat log.

odstat.logFullClass bool If true, the full classname is logged. If false, the basename islogged.

odstat.maxArgs int The maximum number of args displayed for each entry

odstat.maxArgSize int The width, in characters, reserved for each argument

odstat.methodWidth int The width, in characters, reserved for method name

odstat.principalWidth int The width in characters reserved for principal

To set the maximum number of log entries, for example, to 10, use the following command:wcmd cfg put /com/tivoli/core/orb odstat.logDepth=10

OptionsNone


Exampleswcmd orb odstatActive Entries...0 0 15:04:05 - S ? OrbStartup<none> com.tivoli.core.orb.Orb

orb odstat

275

21.O

bject

Req

uest

Bro

ker

Completed Entries...5103 5024 15:45:05 40m S . getAttributes[4](...)com.tivoli.tmd.SDSRemoteService_IProxy5106 5105 15:45:05 40m S . getAttributes[4](...)com.tivoli.tmd.server.SecurityDirectoryService_IProxy5105 5024 15:45:05 40m S . getAttributes[4](...)com.tivoli.tmd.SDSRemoteService_IProxy5024 0 15:45:02 2 S . authenticate[1](...)com.tivoli.core.security.acn.server.AuthenticationService_IProxy5107 0 15:45:05 0m S . lookup [1](...)com.tivoli.core.directory.OrbInitialContext_IProxy5108 0 15:45:05 0m S . getComponent[2](...)com.tivoli.core.component.ComponentManager_IProxy5109 0 15:45:05 0m S . put [2](...)com.tivoli.core.security.common.SCRefreshClock_IProxy5111 5110 15:45:05 0m S . get [2](...)com.tivoli.core.security.cache.SecurityCache_IProxy5110 0 15:45:05 0m S . isAuthorized[3](...)com.tivoli.core.security.azn.AZNEngine_IProxy

See Alsowcmd orb threads

orb odstat

276 Version 1.2

wcmd orb oidDisplays the object ID of a running ORB.

Syntaxwcmd orb oid

DescriptionThe wcmd orb oid command prints both the formatted and unformatted object ID of arunning ORB. By default, the object ID of the current, or local, ORB is displayed. wcmdbundle options (see “Command Line Syntax” on page 2) can be used to target a remoteORB.

OptionsNone specific to this command. See “Command Line Syntax” on page 2 for optionssupported by the wcmd bundle.


Examples1. The following shows the output of this command.

wcmd orb oidFormatted: "USA/Orb/orb1"Unformatted: "3.d1dc76f8225ae4c8.1.c46b9bf74dd9327e"

2. To display the object ID of an ORB, other than the one to which you are logged on,specify a wcmd bundle option to target the remote ORB. For example, the followingcommand displays the object ID of a remote ORB named Raleigh:wcmd -i Orb/Raleigh orb oid

orb oid

277

21.O

bject

Req

uest

Bro

ker

wcmd orb recycleStops and restarts an ORB.

Syntaxwcmd orb recycle [–message msg_text] [–force] [–usage]

DescriptionThe wcmd orb recycle command stops and then restarts an ORB. An optional message canbe sent to any administrators logged into the ORB. Without additional flags, the commandrestarts the local ORB. To recycle a remote ORB, use the wcmd -i option to specify theOID or name of the ORB to be restarted. See “Command Line Syntax” on page 2 for adescription of the -i option.

Options–message msg_text

Specifies the contents of a text message to be sent to all administrators logged intothe ORB. The message can be of any length and, if longer than a single word, mustbe enclosed in double quotes. On Unix machines, shell escape characters must bethemselves escaped by preceding them with a backslash (\). See examples for NTand Unix uses of this command.

–force Forces an ORB shut down. Use this with caution because most components aredesigned to ordinarily reject a stopComponent command while they are not idle.Data loss and significant disruption may occur.

–usageDisplays usage information for this command.

AuthorizationRequires control access to system/services/orb.

Examples1. The following command would stop and restart the local ORB. The message text is

optional.wcmd orb recycle ORB10 "coming down now!"

2. Assume the following command is entered on the console of an ORB named Raleigh.The command restarts the ORB named Austin and sends a message to the administratorslogged into the Austin ORB, informing them the ORB is being restarted, and by whom.wcmd -i Austin orb recycle "Austin ORB being restarted by Raleigh Admin!"

On a Unix machine, the exclamation point must be escaped to prevent it from beinginterpreted, as shown below.wcmd -i Austin orb recycle "Austin ORB being restarted by Raleigh Admin\!"

See Alsowcmd orb shutdown

orb recycle

278 Version 1.2

wcmd orb shutdownShuts down an ORB.

Syntaxwcmd orb shutdown [–m[essage]] message_text [–f[orce]] [–usage]

DescriptionThe wcmd orb shutdown command stops an ORB. An optional message can be sent to anyadministrators logged in to the ORB.

Options–m[essage]

Indicates a message is to be sent to administrators. This flag can be abbreviated as–m or be spelled out as –message.

message_textSpecify the text of the message to be sent to administrators.

–f[orce]Forces the component to shut down. Use this with caution because most componentsare designed to ordinarily reject a stopComponent command while they are not idle.Data loss and significant disruption may occur. This flag can be abbreviated as –f orbe spelled out as –force.

–usageDisplays usage information for this command.

AuthorizationRequires control access to system/services/orb.

Examples1. To force an immediate ORB shutdown, use the following syntax:

wcmd orb shutdown -message "Need to shutdown" -force

See Alsowcmd orb recycle

orb shutdown

279

21.O

bject

Req

uest

Bro

ker

wcmd orb threadsDisplays all threads active in the ORB.

Syntaxwcmd orb threads

DescriptionThe wcmd orb threads command displays a list of all threads and thread groups that are inthe system. It also prints out the statistics for the ORB managed thread pool.

OptionsNone


Examples1. wcmd orb threads

Thread Group: system Max Priority: 10Thread: Signal dispatcher Priority: 5 DaemonThread: Reference Handler Priority: 10 DaemonThread: Finalizer Priority: 8 DaemonThread Group: main Max Priority: 10Thread: com.ibm.logging.FileHandler:bootFile Priority: 5 DaemonThread: timer-thread-0 Priority: 2 DaemonThread: config-datastore-ready-handler Priority: 2 DaemonThread: switched-prefs-flusher Priority: 2 DaemonThread: event-sender-thread Priority: 2 DaemonThread: com.tivoli.util.logging.ConsoleHandler: Priority: 2 DaemonThread: com.ibm.logging.MultiFileHandler: Priority: 2 DaemonThread: com.ibm.logging.MultiFileHandler: Priority: 2 DaemonThread: com.tivoli.core.logging.DatabaseDelete: Priority: 2 DaemonThread: com.tivoli.core.logging.DatabaseReader: Priority: 2 DaemonThread: TimerService Priority: 2 DaemonThread: ssl://adamani:9990 Server Priority: 5Thread: proxy finalizer Priority: 2 DaemonThread: Component Event Dispatcher Priority: 5 DaemonThread: Thread-3 Priority: 2 DaemonThread: Thread-6 Priority: 2 DaemonThread: Thread-7 Priority: 5 DaemonThread: Thread-10 Priority: 5 DaemonThread: Thread-11 Priority: 5 DaemonThread: Listener Priority: 5 DaemonThread: Responder Priority: 5Thread: CLI listener on port 9990 Priority: 5Thread: LocalCLI Handler Priority: 5 DaemonThread: DIREVENTMASTER Priority: 5 DaemonThread: Checking isAlive on NetSecurityService Priority: 5 DaemonThread: ReusableThread-Idle Priority: 5 DaemonThread: ReusableThread-Idle Priority: 5 DaemonThread: Thread-2893 Priority: 5 DaemonThread: Clock Priority: 5 DaemonThread: com.ibm.distman.voyagerx.security.ssl.sslite_SSLite_

CA_EventHandler Priority: 10 DaemonThread: com.tivoli.util.logging.ConsoleHandler: Priority: 5 DaemonThread: com.ibm.logging.MultiFileHandler: Priority: 5 DaemonThread: com.tivoli.util.logging.SerialFileHandlerReader:

Priority: 5 DaemonThread: com.tivoli.util.logging.ConsoleHandler: Priority: 5 DaemonThread: com.tivoli.util.logging.SerialFileHandlerReader:

Priority: 5 DaemonThread: com.ibm.logging.MultiFileHandler: Priority: 5 Daemon

orb threads

280 Version 1.2

Thread: NetSecurityClient Priority: 5Thread: Checking isAlive on FailoverAgent Priority: 5 DaemonThread: Thread-3721 Priority: 5 DaemonThread: LocalComponentActions Priority: 5Thread: LCI Priority: 5 DaemonThread: timescan Priority: 5Thread: Thread-7500 Priority: 5Thread: Thread-7562 Priority: 5Thread: Thread-7563 Priority: 5Thread: Thread-7636 Priority: 5Thread: LocalComponentActions Priority: 5Thread: DepotComponentInst Priority: 5 DaemonThread: timesync Priority: 5Thread: Thread-8122 Priority: 5Thread: ReusableThread-Idle Priority: 5 DaemonThread: ReusableThread-Idle Priority: 5 DaemonThread: Thread-8770 Priority: 5Thread: Thread-9210 Priority: 5 DaemonThread: CLI stream copier Priority: 5 DaemonThread Group: thread pool Max Priority: 10Thread: SslConnection(ssl://146.84.28.118:2365->ssl://adamani.dev.tivoli.com:8001) Priority: 2 DaemonThread: SslConnection(ssl://146.84.28.118:2366->ssl://146.84.28.118:8001) Priority: 2 DaemonThread: ReusableThread-3 Priority: 5 DaemonThread: ReusableThread-4 Priority: 5 DaemonThread: ReusableThread-5 Priority: 5 DaemonThread: ReusableThread-6 Priority: 5 DaemonThread: Thread-2561 Priority: 5 DaemonThread: Agent Monitor Verifier Priority: 5 DaemonThread: ReusableThread-9 Priority: 5 DaemonThread Group: TestCacheThreads Max Priority: 10Thread Group: TestCacheThreads Max Priority: 10Thread Group: SeedGenerator ThreadGroup Max Priority: 10Thread: SeedGenerator Thread Priority: 1 DaemonThread Group: thread pool Max Priority: 10Thread: SslConnection(ssl://146.84.28.118:2365->ssl://adamani.dev.tivoli.com:8001) Priority: 2 DaemonThread: SslConnection(ssl://146.84.28.118:2366->ssl://146.84.28.118:8001) Priority: 2 DaemonThread: ReusableThread-3 Priority: 5 DaemonThread: ReusableThread-4 Priority: 5 DaemonThread: ReusableThread-5 Priority: 5 DaemonThread: ReusableThread-6 Priority: 5 DaemonThread: Thread-2561 Priority: 5 DaemonThread: Agent Monitor Verifier Priority: 5 DaemonThread: ReusableThread-9 Priority: 5 DaemonThread Group: TestCacheThreads Max Priority: 10Thread Group: TestCacheThreads Max Priority: 10

ORB-managed Thread PoolTotal Threads: 5Active Threads: 1, Idle Threads: 4

ORB: 1 Total ThreadsThread: LocalCLI Handler Priority: 5Dispatched: 10/30/00 12:20:30.823 Daemon Daemon

See Alsowcmd orb odstat

orb threads

281

21.O

bject

Req

uest

Bro

ker

orb threads

282 Version 1.2

Serialized Persistence Service

The Serialized Persistence Service provides persistent storage for objects on an ORB’s localdisk. The service is useful for storing objects that require high-speed access from a localdatastore. It is a light-weight service; it does not provide replication of persisted objects toother ORB’s and does not support transactions or rely on network connections. Objectsstored by the Serialized Persistence Service are bound to object IDs (OIDs) that can beactivated by any ORB in the Tivoli Kernel Services installation.

The Serialized Persistence Service commands use the per bundle name. The SerializedPersistence Service must be deployed before these commands can be used. Once deployed,the Serialized Persistence Service will start automatically. The service name to use whendeploying Serialized Persistence Service is ″SerializedPersistenceService″ See “wcmd cdsdeploy” on page 33 for the syntax used to to deploy a service. wcmd per commands cannotbe used on an ORB that is not running the Serialized Peristence Service.


22

283

22.S

erializedP

ersistence

Service

wcmd per backupMakes a copy of a Serialized Persistence Service database, a Synch Serialized Persistencemap, or a Serialized Persistence map.

Syntaxwcmd per backup –db source_db_name target_db_name

wcmd per backup –map source_map_name target_map_name

wcmd per backup –help

DescriptionThe wcmd per backup command makes a copy of a Serialized Persistence Servicedatabase, a Synch Serialized Persistence map, or a Serialized Persistence map, so that thebackup can later be restored with the wcmd per restore command. The backup will bemade on the local disk of the ORB that is running the Serialized Persistence Service.

Options–db source_db_name target_db_name

Indicates the backup being performed is a database backup. source_db_name andtarget_db_name are the names of the database to be backed up and the name of thebackup database, respectively. The source_db_name must match the name of anexisting database. target_db_name can be any name you choose.

–map source_map_name target_map_nameIndicates the backup being performed is a Serialized Persistence map or SyncSerialized Persistence map backup. source_map_name and target_map_name are thenames of the map being backed up and the name of the backup map, respectively.source_map_name must match the name of an existing map. target_db_name can beany name you choose.

–help Displays help text for this command.

AuthorizationRequires write access to system/services/SerializedPersistence.

Examples1. To make a backup of a Serialized Persistence Service database named gatewayDB and

name the resulting backup bakGateway, use the following syntax:wcmd per backup –db gatewayDB bakGateway

2. To make a backup of a Serialized Persistence map named ipInfoMap and name theresulting backup firstIPSet, use the following syntax:wcmd per backup –map ipInfoMap firstIPSet

See Alsowcmd per restore

per backup

284 Version 1.2

wcmd per deleteDeletes a Serialized Persistence Service database, a Synch Serialized Persistence map, or aSerialized Persistence map.

Syntaxwcmd per delete –db database_name

wcmd per delete –map map_name

wcmd per delete –help

DescriptionThe wcmd per delete command deletes a Serialized Persistence Service database, aSynchSerialized Persistence map, or a Serialized Persistence map. The databases or mapsmay have been created programatically by method calls from an application or by wcmdper backup commands.

Options–db database_name

Deletes the database identified by database_name.

–map map_nameDeletes the database map identified by map_name



Examples1. To delete a Serialized Persistence Service database named bakGateway, use the following

syntax:wcmd per delete –db bakGateway

2. To delete a Serialized Persistence database map named firstIPSet, use the followingsyntax:wcmd per delete –map firstIPSet

See Alsowcmd per backup

per delete

285

22.S

erializedP

ersistence

Service

wcmd per restoreRestores a Serialized Persistence Service database or database map.

Syntaxwcmd per restore –db database_name

wcmd per restore –map map_name

wcmd per restore –help

DescriptionThe wcmd per restore command restores a Serialized Persistence Service database ordatabase map from a backup created by the wcmd per backup command.

Options–db database_name

Restores the database identified by database_name.

–map map_nameRestores the Synch Serialized Persistence map or Serialized Persistence mapidentified by map_name



Examples1. To restore the database named gatewayDB from a backup copy named bakGateway, use

the syntax shown below. This example presumes the backup was previously created by awcmd per backup commandwcmd per restore –db bakGateway

2. To restore a database map from a backup copy named firstIPSet use the syntax shownbelow. This example presumes the backup map was previously created by a wcmd perbackup command.wcmd per restore –map firstIPSet

See Alsowcmd per backup

per restore

286 Version 1.2

wcmd per unlockDeletes Serialized Persistence Service lock files.

Syntaxwcmd per unlock lock_file

wcmd per unlock -help

DescriptionThe wcmd per unlock command removes file locks (temporary files on disk that indicate aparticular database or map is in use) from the local disk.

The Serialized Persistence Service uses file locks during some operations to preventmultiple, concurrent users from modifying the same Serialized Persistence Service files. If aJVM containing an ORB running the Serialized Persistence Service crashes, the file locksmay not be properly cleaned up by the Serialized Persistence Service. This command can beused to explicitly unlock (delete) the lock files so another component can use the previouslylocked database or map. Use this command with caution; issue it only when you are sureanother thread is not using the locked database or map.

There are two ways to clear a Serialized Persistence Service lock file. The easiest way is toallow the stale lock timer to expire for a particular lock file, at which point the SerializedPersistence Service will automatically delete the lock file. The stale lock timer timeout is setin the /com/tivoli/core/ds/persistence/TIMEOUT.FOR.STALE.LOCKFILES preferences node.The default for the timer is 30 seconds. The second way to clear a lock file is to unlock itusing this per unlock command.

There is no command available to display locked files. However, log messages created aftera JVM crash will indicate which files are locked.

Optionslock_file

Specifies the the full path to the lock file to be deleted. Obtain this pathinginformation from the log file that was generated after the JVM crashed.



Examples1. To clear a lock file for a database or map, review the log files to discover the pathname

of the lock files. For example, a log file might contain an entry similar to the followingtext:Trying to acquire lock file <lock_file>. Thelock file has not been accessed in <unaccessed_seconds>seconds. If the file remains unchanged for <seconds_left>seconds, it will be deleted automatically.

To clear the lock file shown in this example, wait for the lock file to be deletedautomatically when the TIMEOUT.FOR.STALE.LOCKFILES timer expires (default is 30seconds). Or, delete the lock file immediately using the following command:wcmd per unlock /usr/local/TKSInstallDir/orb.1/.ds_service_dir/gatewayDB.readWriteLock

per unlock

287

22.S

erializedP

ersistence

Service

per unlock

288 Version 1.2

Tivoli Presentation Services ManagementComponent Repository

The Tivoli Presentation Services Management Component Repository (PSMCR) is a database that stores Tivoli Presentation Services information, including keys that effect thebuilding of online help for help-enabled components.

23

289

23.P

SM

CR

wcmd psmcr rebuildHelpRebuilds online help for all Tivoli Presentation Services-enabled components, that is, thosecomponents that contain a package.mcr file in the root of the component’s jar file.

Syntaxwcmd psmcr rebuildHelp

DescriptionThe wcmd psmcr rebuildHelp command can be used to build or rebuild online help forTivoli Presentation Services-enabled components. This command can only be issued to aninstallation depot ORB. By default, online help, for help-enabled components, isautomatically built as each component is installed on an installation depot. If you areinstalling numerous components and wish to defer building the help information until allcomponents have been installed, disable building of help by using the wcmd cfg putcommand to set helpBuild=false (wcmd cfg put /com/tivoli/pf/mcr helpBuild=false).Once the components have been installed, set helpBuild=true and then build the onlinehelp using this psmcr rebuildHelp command.

NotesOnline help is automatically built as help-enabled components are installed on an installationdepot if helpBuild=true or if the key is not specified.

OptionsNone.

AuthorizationRequires superadmin authorization.

psmcr rebuildHelp

290 Version 1.2

Security Service Manager

The security registry is a repository that stores users (accounts and principals) and securedresources, data, and roles. When users log in using one of their accounts, a security contextis created which contains the roles associated with the user. A role determines what actions auser can perform on a resource. Because data about users and secured resources is sensitive,it is maintained in the security registry, which is a datastore separate from the generalconfiguration data created by the configuration service or directory service. To modifyobjects in the security registry, authorization is required on the object that is being modified.

Before using these commands, you need to understand how security can be implemented ina Tivoli Kernel Services installation. For information about the ways security can be appliedto resources, refer to the Planning for Tivoli Kernel Services document and read the“Planning Security” chapter.

Security registry commands begin with the characters wcmd ssm. To use the wcmd ssmcommands, it is helpful to understand concepts and terms as they apply to the securityregistry.


24

291

24.S

ecurity

Service

Man

ager

https://widow.dev.tivoli.com/groups/Millennium/docs/plan/html/tks1tfrm.htm

wcmd ssm crtInstanceAdds an instance of a security object with any of the attribute values contained in thedatabase.

Syntaxwcmd ssm crtInstance {–c context –n name | –p pathname} –oc objClass_name[key=value] ...

DescriptionThe wcmd ssm crtInstance command adds an instance of an object with any number ofattribute values.

Optionskey=value

Defines attributes (keys) and values to be associated with the instance. Separatemultiple key=value pairs with spaces.

–c contextSpecifies the context value you want to associate with the instance.

–n nameProvides a name for the instance.

–oc objClass_name

Specifies any instantiable object class name.

–p pathnameSpecifies the path to the instance.

AuthorizationRequires object access right=add on the target context in the security registry. Also requiresreferent access right=execute on system/services/security/wcmds.

Object access rights define access to the instance in the security registry. Referent accessrights define access to the actual item the object represents.

ExamplesThe following example assumes the context and subcontext have previously been created. Tocreate an instance of John Doe using the object class name Person with two attributes, usethe following syntax:wcmd ssm crtInstance -c Tivoli/RTP/Bldg501 -n "John Doe"-oc Person sn=John homePhone=555-1212

See Alsowcmd ssm delInstance, wcmd ssm renameInstance, wcmd ssm crtSubcontext

ssm crtInstance

292 Version 1.2

wcmd ssm crtSubcontextCreates a new instance of an organizational unit.

Syntaxwcmd ssm crtSubcontext –c context –sc subcontext

DescriptionThe wcmd ssm crtSubcontext command creates a new instance of an organizational unitwith optional attributes.

Options–c context

Specifies the context with which the subcontext will be associated.

–sc subcontextSpecifies the subcontext value you want to associate with the context.

AuthorizationRequires object access right=add on the parent context in the security registry. Also requiresreferent access right=execute on system/services/security/wcmds.


ExamplesTo create a new subcontext ″D105″ under context ″Tivoli/RTP/Bldg501″, use the followingsyntax:wcmd ssm crtSubcontext -c Tivoli/RTP/Bldg501 -sc D105

See Alsowcmd ssm delSubcontext

ssm crtSubcontext

293

24.S

ecurity

Service

Man

ager

wcmd ssm delAllFromDelete all instances of an object from the security registry.

Syntaxwcmd ssm delAllFrom {–c context –sc subcontext | –p pathname}

DescriptionThe wcmd ssm delAllFrom command deletes all instances of an object from the securityregistry.

Options–c context

Specifies the context value you want to de;ete.

–p pathnameIdentifies the path to the location of the instance to be deleted. If –p is specified, donot specify –c and –sc.

–sc subcontextThe subcontext value you want to delete.

AuthorizationRequires object access right=del on all items being deleted from the security registry. Alsorequires referent access right=execute on system/services/security/wcmds.


ExamplesTo delete all the instances under subcontext D105, including the subcontext itself, use thefollowing syntax:wcmd ssm delAllFrom -c Tivoli/RTP/Bldg501 -sc D105

See Alsowcmd ssm delInstance

ssm delAllFrom

294 Version 1.2

wcmd ssm delInstanceRemoves a single instance of an object from the security registry.

Syntaxwcmd ssm delInstance {–c context –n name | –p pathname}

DescriptionThe wcmd ssm delInstance command removes a single instance of an object.

Options–c context

Specifies the context value you want to associate with the instance.

–n nameSpecifies the name of the instance.

–p pathnameSpecifies the pathname to the location of the instance. If –p is specified, do notspecify –c and –n.

AuthorizationRequires object access right=del on item being deleted from the security registry. Alsorequires referent access right=execute on system/services/security/wcmds.


ExamplesTo delete a single instance for an object named John Doe, use the following syntax:wcmd ssm delInstance -c Tivoli/RTP/Bldg501 -n "John Doe"

See Alsowcmd ssm crtInstance, wcmd ssm renameInstance

ssm delInstance

295

24.S

ecurity

Service

Man

ager

wcmd ssm delSubcontextDeletes a subcontext from the security registry. This subcontext must be empty before it canbe deleted.

Syntaxwcmd ssm delSubcontext –c context –sc subcontext

DescriptionThe wcmd ssm delSubcontext command creates a new instance of an organizational unitwith optional attributes.

Options–c context


–sc subcontextSpecifies subcontext value you want to associate with the instance.

AuthorizationRequires object access right=del on the subcontext being deleted from the security registry.Also requires referent access right=execute on system/services/security/wcmds.


ExamplesTo delete an existing subcontext, D105, use the following syntax:wcmd ssm delSubcontext -c Tivoli/RTP/Bldg501 -sc D105

See Alsowcmd ssm crtSubcontext

ssm delSubcontext

296 Version 1.2

wcmd ssm dumpLists attributes of resources in the security registry.

Syntaxwcmd ssm dump [–p pathname]

DescriptionThe wcmd ssm dump command displays the attributes of resources in the security registry.All attributes for all resources are displayed, unless an optional pathname is provided on thecommand line.

Options–p pathname

Specifies location of the registry context to serve as the starting place for theattribute display. If not specified, attributes for all resources in the registry aredisplayed.

AuthorizationRequires object access right=view on the branches of the tree you wish to view in thesecurity registry. Also requires referent access right=execute onsystem/services/security/wcmds.


ExamplesTo list all the resources and its attributes for the context Tivoli/RTP/Bldg501/D, use thefollowing syntax. The output shows the resources found in the context:wcmd ssm dump -p Tivoli/RTP/Bldg501/DList of resources found:Tivoli/RTP/Bldg501/D/CharlieTivoli/RTP/Bldg501/D/Ranjan

Attributes for Tivoli/RTP/Bldg501/D/Charlie are:createDateTime = 2000-11-03-00.38.41.452sn = CharlieobjectClass = PERSONmail = [email protected] = Charlie BrownisActiveMember = TRUElastModDateTime = 2000-11-03-00.38.42.544timeLastEnabled = 2000-11-03-00.38.41.452cn = CharlieisActiveTarget = TRUEisEnabled = true

Attributes for Tivoli/RTP/Bldg501/D/Ranjan are:createDateTime = 2000-11-03-00.38.47.491sn = RanjanobjectClass = PERSONmail = [email protected] = Ranjan FumerisActiveMember = TRUElastModDateTime = 2000-11-03-00.38.47.952timeLastEnabled = 2000-11-03-00.38.47.491cn = RanjanisActiveTarget = TRUEisEnabled = true

ssm dump

297

24.S

ecurity

Service

Man

ager

wcmd ssm importXMLImports security definitions from an XML or a jar file.

Syntaxwcmd ssm importXML [dir directory] xml_file...

wcmd ssm importXML jar jar_file xml_file

DescriptionThe wcmd ssm importXML command imports security definitions from XML files.

Optionsdir directory

Specifies the directory containing one or more XML files. The dir option allows youto use relative paths to import the XML files. See examples, below.

xml_fileSpecifies one or more names of XML files containing the security definitions. If thedir option is not specified, XML file locations must be fully qualified. To importdefinitions from multiple files, separate the paths to the files with spaces. Seeexamples.

jar jar_file xml_fileSpecifies the name of the jar file and the name of the XML file within the jar filefrom which the security definitions will be imported.

AuthorizationRequires object access right=add, mod, or del (depending on operators specified in theXML file) on target items in the security registry. Also requires referent access right=executeon system/services/security/wcmds.


Examples1. To import security definitions from an XML file named MySecDefs.xml, use the

following syntax:wcmd ssm importxml \myDirectory\com\tivoli\core\security\MySecDefs.xml

2. To import security definitions from a file named MySecDefs.xml, and that file iscontained in a jar file, use the following syntax:wcmd ssm importxml jar \myDirectory\MyComponent.jar com.tivoli.core.security.MySecDefs.xml

3. Assume the XML files are stored in the following directory locations: \a\1.xml, \a\2.xml,and \a\b\3.xml. To import these definitions without the dir option, you must specify thequalified path to the files as follows:wcmd ssm importxml \a\1.xml \a\2.xml \a\b\3.xml

To import these definitions using the dir option, you can set the import directory to \aand import the files in that directory using only the file names. The file in \a\b wouldneed to be accesed by its relative path as follows:wcmd ssm importxml dir \a 1.xml 2.xml b\3.xml

ssm importxml

298 Version 1.2

A similar import could be performed by setting \a\b as the import directory andspecifying a relative path to the files in \a.wcmd ssm importxml dir \a\b ..\1.xml ..\2.xml 3.xml

ssm importxml

299

24.S

ecurity

Service

Man

ager

wcmd ssm listAllAttributesList all attributes and values in the security registry.

Syntaxwcmd ssm listAllAttributes {–c context –n name | –p pathname}

DescriptionThe wcmd ssm listAllAttributes command lists all attributes and their values of givenobject to stdout.

Options–c context




AuthorizationRequires object access right=view on target items in the security registry.

ExamplesTo list all attributes of the instance named John Doe, use the following syntax:wcmd ssm listAllAttributes -p "Tivoli/RTP/Bldg501/John Doe"

See Alsowcmd ssm listAttributes

ssm listAllAttributes

300 Version 1.2

wcmd ssm listAllChildrenList all children of the specified context.

Syntaxwcmd ssm listAllChildren {–c context –sc subcontext | –p pathname}

DescriptionThe wcmd ssm listAllChildren command lists all children of the specified context.

Options–c context


–p pathnameSpecifies the pathname to the location of the instance. If –p is specified, do notspecify –c and –sc.

–sc subcontextSpecifies the subcontext value you want to associate with the instance.

AuthorizationRequires object access right=view on the branches of the tree you wish to view, in thesecurity registry.

ExamplesTo list all children of the context named Tivoli/RT, use the following syntax:wcmd ssm listAllChildren -p Tivoli/RTP

See Alsowcmd ssm listChildren

ssm listAllChildren

301

24.S

ecurity

Service

Man

ager

wcmd ssm listAllResourcesDisplays all resources that belong to the named class.

Syntaxwcmd ssm listAllResources {-oc objClass_name | key=value}

wcmd ssm listAllResources -f filter

DescriptionThis command displays all resources that belong to the object class specified on thecommand. An optional filter flag displays only the resources that match the specified filtercriteria.

Optionsfilter Specifies an RFC 2254 (1558) compliant string. The filter definitions are restricted

to a proper subset of that specified by RFC 2254 (1558) allowing only outer OR’s (|)and inner ANDs (&). For example:

(cn=Babs Jensen)(ou=univ*of*tex*)(sn=*son)(&(objectClass=Person) (cn=Babs J*))(|(&(objectClass=Person) (cn=Babs J*)) (&(objectClass=Person) (sn=Jensen)))

key=valueSpecifies a key=value pair you want to associate with an instance.

objClass_name

Specifies any instantiable object class name.

AuthorizationRequires object access right=view for all objects starting at the root of the security registry.


Exampleswcmd ssm listAllResources -oc applicationwcmd ssm listAllResources -f (objectClass=application)wcmd ssm listAllResources -oc Persondescription="part time employee"

ssm listAllResources

302 Version 1.2

wcmd ssm listAttributesLists one or more attributes and their values of given object to standard output.

Syntaxwcmd ssm listAttributes {–c context –n name | –p pathname} key [key ]...

DescriptionThe wcmd ssm listAttributes command lists the specified attributes and values of givenobject to stdout.

Optionskey Specifies the key to be listed. You must specify at least one key. To specify mulitple

keys, separate the pairs with spaces.




AuthorizationRequires object access right=view on target items in the security registry.

ExamplesTo list specific attributes of the instance named John Doe, use the following syntax. Thecommand below lists the surname and home phone number.wcmd ssm listAttributes -p "Tivoli/RTP/Bldg501/John Doe" sn homePhone

See Alsowcmd ssm listAllAttributes

ssm listAttributes

303

24.S

ecurity

Service

Man

ager

wcmd ssm listChildrenList the immediate children of the specified context.

Syntaxwcmd ssm listChildren {–c context –sc subcontext | –p pathname}

DescriptionThe wcmd ssm listChildren command lists the immediate children of the specified context.

Options–c context


–sc subcontextSpecifies the subcontext value you want to associate with the instance.

–p pathnameSpecifies the pathname to the location of the instance. If –p is specified, do notspecify –c and –sc.

AuthorizationRequires object access right=view on the parent object for which children are being viewed.

ExamplesTo list the immediate children of the context named Tivoli/RTP, use the following syntax:wcmd ssm listChildren -p Tivoli/RTP

See Alsowcmd ssm listAllChildren

ssm listChildren

304 Version 1.2

wcmd ssm modifyAttributesModify an attribute or attributes of an existing instance of an object.

Syntaxwcmd ssm modifyAttributes {–c context –n name | –p pathname} –op {add | remove |replace} key=value [key=value] ...

DescriptionThe wcmd ssm modifyAttributes command modifies an attribute or attributes of an existinginstance of an object.

Optionskey=value

Specifies the key=value pair to be modified. You must specify at least onekey=value pair. To specify mulitple key=values, separate the pairs with spaces.




–op Indicates the operation to be performed on the instance.

add Adds an attribute to the instance.

removeRemoves an attribute from the instance.

replaceReplaces the value of an existing attribute.

AuthorizationRequires object access right=add, mod, or del (depending on operation type specified) ontarget items in the Security Registry. Also requires referent access right=execute onsystem/services/security/wcmds.

ExamplesTo modify two attributes of an existing instance named John Doe, use the following syntaxand specify the attributes appropriate for your installation:wcmd ssm modifyAttributes -p "Tivoli/RTP/Bldg501/John Doe"-op add fax=555-2121 givenName=John

See Alsowcmd ssm listAttributes

ssm modifyAttributes

305

24.S

ecurity

Service

Man

ager

wcmd ssm renameInstanceRenames an existing instance of an object.

Syntaxwcmd ssm renameInstance –c context –oldname old_name –newname new_name

DescriptionThe wcmd ssm renameInstance command renames an existing instance of an object.

Options–c context


–oldname old_nameSpecifies the existing name of the instance.

–newname new_nameSpecifies the new name of the instance.

AuthorizationRequires object access right=mod on the item being modified in the security registry. Alsorequires referent access right=execute on system/services/security/wcmds.


ExamplesTo rename the existing instance of John Doe to a new name of Superman, use the followingsyntax:wcmd ssm renameInstance -c Tivoli/RTP/Bldg501 -oldname "John Doe"-newname Superman

See Alsowcmd ssm crtInstance, wcmd ssm delInstance

ssm renInstance

306 Version 1.2

Service Manager

The Tivoli Kernel Services Service Manager (SM) provides access to services toclient-server or peer-to-peer entities on a network. Its main function is to manage theservices to enable clients to access services in a standard way.

Service Manager commands enable administrators to display a list of services running onORBs in the Tivoli Kernel Services installation.

The wcmd command provides flags that allow you to retrieve information about services inan ORB other than the ORB from which the command is issued. The wcmd –i flag is usedto specify an ORB by its ORB identifier or name while the -o flag specifies the port onwhich the ORB is running on . These flags cause the command to be routed to, and beexecuted by, the ORB indicated by the wcmd command’s -i (orb) and -o (port_number)options. See “Command Line Syntax” on page 2 for a complete description of the ways youcan designate a specific ORB.

To send the wcmd svc ls lsm command to an ORB, using the ORB’s oid, enter the followingcommand:wcmd -i 3.7.1.6 svc ls lsm

To send the wcmd svc ls dsm command to the ORB named Raleigh on port 9990, enter thefollowing command:wcmd -i Orb/Raleigh -o 9990 svc ls dsm


25

307

25.S

erviceM

anag

er

wcmd svc ls BackUpsDisplays the list of DSMs configured as back up DSMs for an LSM.

Syntaxwcmd svc ls BackUps

DescriptionThe wcmd svc ls BackUps command returns a list of back up DSMs for the LSM in theORB from which the command was issued.

OptionsNone.


ExamplesThe example below shows the back up DSMs for the LSM in the current ORB.wcmd svc ls BackUps[Backups: ] //xchen.dev.tivoli.com:9990, //megalon.dev.tivoli.com:8765

See Alsowcmd svc ls Primary

wcmd svc ls BackUps

308 Version 1.2

wcmd svc ls DSMDisplays a list of advertised services available through the Distributed Service Manager(DSM) to which an ORB is connected.

Syntaxwcmd svc ls DSM

DescriptionThe wcmd svc ls DSM command returns a list of advertised services available through theDistributed Service Manager to which the specified ORB is connected.

OptionsNone. However, the wcmd -i flag (see “Command Line Syntax” on page 2) can be added todisplay advertised services available on the DSM of a remote ORB.


ExamplesThe following shows an example of output from this command. In this example, assume thecommand was entered at the console connected to an ORB named Austin. The samplecommand includes a –i option and the name of another ORB, the Raleigh ORB. The outputfrom this example would be the list of services available on the DSM responsible formanaging advertised services running in the Raleigh ORB. If the –i option was omitted, theservices available on the DSM servicing the local ORB would be returned. The order of theoutput fields are: service name, service version, and build level. The build level follows thehyphen after the version number.wcmd -i Orb/Raleigh svc ls DSMFailoverService 5.1.0-200008101309dirservice 5.1.0-200008101309SecurityCacheService 5.1.0-200008101309AuthenticationService 5.1.0-200008101309golfserver 5.1.1-200008101309RemoteAuthenticationService 5.1.0-200008101309logging 5.1.1-200008101309ComponentDistributionService 5.1.0-200008101309MetaTes 5.1.1-200008101309PndScheduler 5.1.0-200008101309

See Alsowcmd svc ls LSM

wcmd svc ls DSM

309

25.S

erviceM

anag

er

wcmd svc ls LSMDisplays a list of services running on an ORB.

Syntaxwcmd svc ls LSM

DescriptionThe wcmd svc ls LSM command returns a list of services running on a specific ORB.

OptionsNone. However, the wcmd -i flag (see “Command Line Syntax” on page 2) can be added todisplay services running on a remote ORB.


ExamplesThe following shows an example of output from this command. In this example, assume thecommand was entered at the console connected to an ORB named Austin. The samplecommand includes a -i option and the name of another ORB, the Raleigh ORB. The outputfrom this example would be the list of services running in the Raleigh ORB. If the -i optionwas omitted, a list of service running in the local ORB would be returned. The order of theoutput fields are: service name, service version, and build level. The build level follows thehyphen after the version number.wcmd -i Orb/Raleigh svc ls LSMdsm 5.1.1-200008101309slash 5.1.0-200008101309CliService 5.1.0-200008101309FailoverAgent 5.1.0-200008101309AuthenticationService 5.1.0-200008101309ComponentDistributionService 5.1.0-200008101309golfserver 5.1.1-200008101309RemoteAuthenticationService 5.1.0-200008101309logging 5.1.1-200008101309FailoverService 5.1.0-200008101309MetaTes 5.1.1-200008101309dirservice 5.1.0-200008101309PndScheduler 5.1.0-200008101309SecurityCacheService 5.1.0-200008101309

See Alsowcmd svc ls DSM

wcmd svc ls LSM

310 Version 1.2

wcmd svc ls PrimaryDisplays the DSM to which the current LSM is connected.

Syntaxwcmd svc ls Primary

DescriptionThe wcmd svc ls Primary displays the DSM to which the current LSM is connected. It alsolists the connection information stored in the configuration service.

OptionsNone.


ExamplesThe command below illustrates how this command can be used to display the DSM towhich the LSM in the local ORB is connected. In this example, the current connection is notthe primary connection defined in the configuration service. The configured primary DSM inthis example is the machine named fbarilla.dev.tivoli.com, which is why it is shown as theexpected connection. In this example, that primary is down and the output shows the LSM isconnected to the back up DSM named xchen.dev.tivoli.com.wcmd svc ls Primary[Current connection:] //xchen.dev.tivoli.com:9990[Expected connection:] //fbarilla.dev.tivoli.com:9990

See Alsowcmd svc ls BackUps

wcmd svc ls Primary

311

25.S

erviceM

anag

er

wcmd svc ls Primary

312 Version 1.2

Printed in the United States of Americaon recycled paper containing 10%recovered post-consumer fiber.