Version 6 Release 3

IBM Systems

IBM Systems Director Commands ReferenceVersion 6 Release 3

��

IBM Systems

IBM Systems Director Commands ReferenceVersion 6 Release 3

��

NoteBefore using this information and the product it supports, read the information in “Notices” onpage 571.

© Copyright IBM Corporation 1999, 2015.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

About this publication . . . . . . . . vConventions and terminology . . . . . . . . vHow to read syntax diagrams . . . . . . . . vPublications and related information . . . . . . viWeb resources . . . . . . . . . . . . . viiiHow to send your comments . . . . . . . . . x

Chapter 1. smcli - Systems managementcommand-line interface . . . . . . . . 1Language specifications for smcli commands . . . 6Port configuration for smcli . . . . . . . . . 6CLILEGACY environment variable . . . . . . . 7Administration commands. . . . . . . . . . 7

activatemgrs command . . . . . . . . . . 7deactivatemgrs command . . . . . . . . . 9lsmgrs command . . . . . . . . . . . 10lsbundle command . . . . . . . . . . . 11lscandidateserver command . . . . . . . . 12backupcfg command . . . . . . . . . . 14resetcfg command . . . . . . . . . . . 16restorecfg command . . . . . . . . . . 19

Configuration plans and templates commands. . . 22Configuration plan commands . . . . . . . 22Configuration template commands . . . . . 28

Discovery and inventory commands . . . . . . 35collectinv command . . . . . . . . . . 36discover command . . . . . . . . . . . 41lsinv command . . . . . . . . . . . . 44cmpptfs command . . . . . . . . . . . 49

Event and event automation plan commands . . . 51Event action commands . . . . . . . . . 51Event automation plan commands. . . . . . 68Event filter commands. . . . . . . . . . 90Event log and event action history commands 102

Group commands . . . . . . . . . . . . 121chgp command. . . . . . . . . . . . 122lsgp command . . . . . . . . . . . . 127mkgp command . . . . . . . . . . . 133rmgp command . . . . . . . . . . . 138

Process monitor commands. . . . . . . . . 140lsps command . . . . . . . . . . . . 140mkpmtask command . . . . . . . . . . 144rmpmtask command . . . . . . . . . . 146

Remote access commands . . . . . . . . . 148dconsole command . . . . . . . . . . 148dsh command . . . . . . . . . . . . 152

Resource monitor commands . . . . . . . . 156Resource monitor commands . . . . . . . 156Resource-monitor recording commands. . . . 164Resource-monitor threshold commands. . . . 181

Security commands . . . . . . . . . . . 201authusergp command . . . . . . . . . 201cfgaccess command . . . . . . . . . . 202cfgappcred command. . . . . . . . . . 207cfgcertpolicy command . . . . . . . . . 209

cfgcred command . . . . . . . . . . . 210cfgpwdpolicy command . . . . . . . . . 213chaudit command . . . . . . . . . . . 215chcred command . . . . . . . . . . . 217chrole command . . . . . . . . . . . 220chuser command . . . . . . . . . . . 223chusergp command . . . . . . . . . . 226deletecertCRL command. . . . . . . . . 228exportcert command . . . . . . . . . . 229importcert command . . . . . . . . . . 231importcertCRL command . . . . . . . . 233lsaudit command . . . . . . . . . . . 234lsauditlogs command. . . . . . . . . . 235lscert command . . . . . . . . . . . 237lscred command . . . . . . . . . . . 239lsperm command . . . . . . . . . . . 240lsrole command . . . . . . . . . . . 244lsuser command . . . . . . . . . . . 248lsusergp command . . . . . . . . . . 251mkrole command . . . . . . . . . . . 254revokecert command . . . . . . . . . . 256rmauditlogs command . . . . . . . . . 258rmcert command . . . . . . . . . . . 260rmcred command . . . . . . . . . . . 261rmrole command . . . . . . . . . . . 263rmusergp command . . . . . . . . . . 265unrevokecert command . . . . . . . . . 267

Status commands . . . . . . . . . . . . 269chled command . . . . . . . . . . . 269lsled command . . . . . . . . . . . . 273lsstatus command . . . . . . . . . . . 277

Storage commands . . . . . . . . . . . 282Storage-configuration settings . . . . . . . 282lsnspool command . . . . . . . . . . 285lsstpool command . . . . . . . . . . . 288lsstvol command . . . . . . . . . . . 290lsdatasource command . . . . . . . . . 292mkdatasource command. . . . . . . . . 294mkstvol command. . . . . . . . . . . 297rmdatasource command . . . . . . . . . 300rmstvol command . . . . . . . . . . . 302rmstfrompool command . . . . . . . . . 303increasetimeout command . . . . . . . . 304Network storage hosts commands . . . . . 305Network storage path commands. . . . . . 313Network storage systems commands . . . . 331Network storage volumes commands . . . . 336

System commands. . . . . . . . . . . . 351accesssys command . . . . . . . . . . 353chsys command . . . . . . . . . . . 357lssys command . . . . . . . . . . . . 362pingsys command . . . . . . . . . . . 368printDMData command . . . . . . . . . 372revokeaccesssys command . . . . . . . . 373rmsys command . . . . . . . . . . . 377rpower command . . . . . . . . . . . 381

© Copyright IBM Corp. 1999, 2015 iii

||||||||||||||||||

||||||||||

||

||

||

Tasks and scheduled jobs commands . . . . . 385lsjob command . . . . . . . . . . . . 386lsjobhistory command . . . . . . . . . 392lstask command . . . . . . . . . . . 395rmjob command . . . . . . . . . . . 403rmjobhistory command . . . . . . . . . 405runjob command . . . . . . . . . . . 407runtask command . . . . . . . . . . . 411

Update commands . . . . . . . . . . . 415checkupd command . . . . . . . . . . 416cleanupd command . . . . . . . . . . 420importupd command. . . . . . . . . . 423installneeded command . . . . . . . . . 426installupd command . . . . . . . . . . 432lsupd command . . . . . . . . . . . 438lsver command . . . . . . . . . . . . 444uninstallupd command . . . . . . . . . 445

Web interface commands . . . . . . . . . 450chgloginmsg command . . . . . . . . . 450endSession command. . . . . . . . . . 452importextlps command . . . . . . . . . 454listextlps command . . . . . . . . . . 455removeextlps command . . . . . . . . . 457

smcli appliance commands . . . . . . . . . 458configureHA command . . . . . . . . . 458failover command . . . . . . . . . . . 462removeHA command. . . . . . . . . . 463

Chapter 2. Management server andagent commands. . . . . . . . . . 465agentreg command . . . . . . . . . . . 465cfgdbcmd command . . . . . . . . . . . 467cfguserreg command . . . . . . . . . . . 472changePassword tool . . . . . . . . . . . 476cimsubscribe command . . . . . . . . . . 477configAgtMgr command . . . . . . . . . 482dirinstall.server command . . . . . . . . . 485diruninstall command . . . . . . . . . . 488genuid command . . . . . . . . . . . . 489lsagent.agent command . . . . . . . . . . 490logcollector command . . . . . . . . . . 490reset_diragent_keys command . . . . . . . . 492paservices utility . . . . . . . . . . . . 493securityCryptoMode command . . . . . . . 494slptool command . . . . . . . . . . . . 495smdb command . . . . . . . . . . . . 497smdbcli command . . . . . . . . . . . . 498smexport command . . . . . . . . . . . 499smimport command . . . . . . . . . . . 501smreset command . . . . . . . . . . . . 503

smrestore command . . . . . . . . . . . 504smsave command . . . . . . . . . . . . 508smstart command . . . . . . . . . . . . 512smstatus command . . . . . . . . . . . 513smstop command . . . . . . . . . . . . 514Supported IBM Director version 5.20 commands 515

Chapter 3. Appliance commands . . . 517backup command . . . . . . . . . . . . 517cfgkbd command . . . . . . . . . . . . 519chagentregpasswd command . . . . . . . . 520chconfig command . . . . . . . . . . . 521chipsec command . . . . . . . . . . . . 522chkmedia command . . . . . . . . . . . 524chnetcfg command . . . . . . . . . . . 525chrmpasswd command . . . . . . . . . . 531chtoolkitpasswd command . . . . . . . . . 532cpwin command . . . . . . . . . . . . 533lsconfig command . . . . . . . . . . . . 534lsipsec command . . . . . . . . . . . . 535lsldap command . . . . . . . . . . . . 536lslogon command . . . . . . . . . . . . 537lsmediadev command . . . . . . . . . . 539lsnetcfg command . . . . . . . . . . . . 541mkauthkeys command . . . . . . . . . . 542mkcert command . . . . . . . . . . . . 543pesh command . . . . . . . . . . . . . 546restore command . . . . . . . . . . . . 547rmloginmsg command . . . . . . . . . . 549rnvi command . . . . . . . . . . . . . 550sendfile command . . . . . . . . . . . . 551setloginmsg command . . . . . . . . . . 552smha command . . . . . . . . . . . . 554smhastatus command . . . . . . . . . . 556smshutdown command . . . . . . . . . . 557termtask command . . . . . . . . . . . 558updcert command . . . . . . . . . . . . 559

Appendix. Discontinued commands 565Discontinued dircli commands . . . . . . . 565Discontinued dircmd commands . . . . . . . 567Discontinued management-server and agentcommands . . . . . . . . . . . . . . 570

Notices . . . . . . . . . . . . . . 571Trademarks . . . . . . . . . . . . . . 573Privacy policy considerations . . . . . . . . 574

Glossary . . . . . . . . . . . . . 575

iv IBM Systems Director Commands Reference

||

About this publication

This book provides reference information for commands available in IBM® SystemsDirector 6.3.5. These commands fall into two broad categories:v Commands used to configure, start, or stop IBM Systems Director. These

commands are entered directly on the command line when the action should beperformed.

v Commands used to perform IBM Systems Director tasks. These commands areimplemented using the IBM Systems Director command-line interface, smcli.

Conventions and terminology

These notices are designed to highlight key information:

Note: These notices provide important tips, guidance, or advice.

Important: These notices provide information or advice that might help you avoidinconvenient or difficult situations.

Attention: These notices indicate possible damage to programs, devices, or data.An attention notice appears before the instruction or situation in which damagecan occur.

How to read syntax diagramsReview the conventions used in syntax diagrams to understand the commanddescriptions.

Syntax diagrams consists of options, option arguments, and operands.

Optionsoptions indicate input that affects the behavior of the base command (forexample, -l specifies long output) or required input that you can specify indifferent ways (for example, you can target objects using either -n name OR-N groupname OR -ac objectclass). Options consist of either a hyphen andsingle letter (for example, -h) or two hyphens and multiple letters (forexample, --help). The single letter format is the short form of the multipleletter format, and the two formats are functionally interchangeable whenissuing a command.

Option argumentsSome options are followed by one or more option arguments that specify avalue for the option. For example, with -file file_name, file_namespecifies the name of the file on or with which to take action.

OperandsOperands are parameters at the end of a command that specify requireduser input.

Syntax diagrams adhere to the following conventions:v Options and operands that are enclosed in brackets ([]) are optional. Do not

include these brackets in the command.

© Copyright IBM Corp. 1999, 2015 v

v Options and operands that are enclosed in braces ({}) are required. Do notinclude these braces in the command.

v Options and operands that are not enclosed in either brackets or braces arerequired.

v Operands and option arguments that are italicized must be replaced with actualvalues. You must specify an actual value for the operand and option argument.Otherwise, you will receive an error when you issue the command.

v The names of options are case sensitive and must be typed exactly as shown.v Options preceded by two dashes (--) must be specified in their entirety.v A pipe (|) character signifies that you can or must, depending on the enclosing

characters, choose one option or the other. For example, [a | b] indicates thatyou can choose either a or b, but not both. Similarly, {a | b} indicates that youmust choose either a or b.

v An ellipsis (...) signifies that you can repeat the operand and option argumenton the command line.

v A dash (-) represents standard output.

Publications and related informationYou can view the same content in the Information Center as PDF documents. Toview a PDF file, you need Adobe Acrobat Reader, which can be downloaded forfree from the Adobe Web site at http://get.adobe.com/reader/.

Information centers and topic collectionsv IBM Systems

http://publib.boulder.ibm.com/eserver/View the IBM Systems information center landing page, which providesintegrated information for multiple IBM Systems products.

v IBM Systems Directorpublib.boulder.ibm.com/infocenter/director/pubs/index.jspUpdated periodically, the IBM Systems Director topic collection contains themost up-to-date documentation available for IBM Systems Director.

v IBM Systems Director plug-inshttp://publib.boulder.ibm.com/infocenter/director/pubs/topic/extensions/extensionparent.htmlView the IBM Systems information center for information about how to installand use plug-ins that extend the functionality of IBM Systems Director.

v IBM Systems Director Upward Integration Modules (UIMs)publib.boulder.ibm.com/infocenter/systems/topic/uims/fqs0_main.htmlRead the IBM Systems Director Upward Integration Modules (UIM) topiccollection to learn about how to install and use upward integration modules andmanagement packs that enable non-IBM workgroup and enterprise-managementproducts to interpret and display data that is provided by Common Agent andPlatform Agent.

v IBM Systems Director API Licensinghttp://publib.boulder.ibm.com/infocenter/director/devsdk/index.jspView the license information regarding use of IBM Systems Director APIs andtheir associated documentation. Fill out the form to request API access. Afteryour information is reviewed, you will be contacted with additional informationregarding access to and use of the APIs.

vi IBM Systems Director Commands Reference

http://get.adobe.com/reader/

http://publib.boulder.ibm.com/eserver/

http://publib.boulder.ibm.com/infocenter/director/pubs/index.jsp

http://publib.boulder.ibm.com/infocenter/director/pubs/topic/extensions/extensionparent.html

http://publib.boulder.ibm.com/infocenter/director/pubs/topic/extensions/extensionparent.html

http://publib.boulder.ibm.com/infocenter/director/devsdk/index.jsp

Publications

Release Notes® 6.3.6Provides an easy reference to planning, install and troubleshootinginformation for IBM Systems Director

IBM Systems Director Planning GuideProvides planning information, including hardware requirements forrunning IBM Systems Director components, supported IBM SystemsDirector hardware, operating systems, databases, and workgroup andenterprise systems-management software.

PDF files for installing IBM Systems Director ServerProvides detailed instructions to prepare for, install, and configure the IBMSystems Director Server.

PDF files for installing IBM Systems Director agentsProvides detailed instructions to prepare for and install IBM SystemsDirector agents on your managed systems, as well as, prepare for agentlessmanaged systems.

PDF files for upgrading and migrating IBM Systems Director ServerProvides detailed instructions to upgrade and migrate the IBM SystemsDirector Server.

PDF files for upgrading and migrating IBM Systems Director agentsProvides detailed instructions to upgrade and migrate IBM SystemsDirector agents.

IBM Systems Director Systems Management GuideProvides detailed instructions for using the Web interface and managingsystems and resources in your environment.

IBM Systems Director Troubleshooting GuideProvides information about problems and how to solve them, andstrategies for troubleshooting common problems.

IBM Systems Director Events ReferenceIBM Systems Director Events ReferenceProvides information about IBM Systems Director events, including theevent type, description, severity, and extended details.

IBM Systems Director Commands ReferenceIBM Systems Director Commands ReferenceProvides detailed information about the systems managementcommand-line interface (smcli) commands, and other commands that canbe run directly from the command line, including configuring the database,and starting and stopping IBM Systems Director.

White papers and briefsv IBM Systems Director

ftp://ftp.software.ibm.com/common/ssi/rep_wh/n/XBW03006USEN/XBW03006USEN.PDFThis paper provides a detailed overview of the changes in IBM Systems DirectorV6.1, including the new Web interface, security features, operating systemagents, integrated plug-ins and additional plug-ins that can be separatelyinstalled.

v Value Proposition for IBM Systems Director

ftp://ftp.software.ibm.com/common/ssi/rep_wh/n/XBW03007USEN/XBW03007USEN.PDF

About this publication vii

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.main.helps.doc/dir_relnotesPDF.pdf

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.main.helps.doc/frn0_bk_planning_guide.pdf

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.install.helps.doc/fqm0_t_installing_pdfs.html

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.install.helps.doc/fqm0_t_installing_agents_pdfs.html

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.upgrade.helps.doc/fqm0_t_print_pdf.html

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.upgrade.helps.doc/fqm0_t_print_agent_pdf.html

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.main.helps.doc/fqr0_bk_systm_mgmt.pdf

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.main.helps.doc/frq0_bk_troubleshoot.pdf

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.main.helps.doc/fqo0_bk_events_ref.pdf

http://pic.dhe.ibm.com/infocenter/director/pubs/topic/com.ibm.director.main.helps.doc/frp0_bk_commands.pdf





This paper describes the challenges of operational management for enterpriseserver installations and the value provided IBM Systems Director.

v Performance Tuning and Scaling Guide for IBM Systems Director 6.3

Hardware requirements for running IBM Systems Director ServerProvides information about how to plan, implement, configure, and use an IBMSystems Director Server to manage a large configuration with optimalperformance. The Performance Tuning and Scaling Guide also containsinformation about the following topics:– Running IBM Systems Director plug-ins, such as IBM Systems Director Active

Energy Manager® and IBM Scalable Systems Manager– Integration with Tivoli® products– Implementing high availability

IBM Redbooks® publications

www.ibm.com/redbooks/

You can also search this Web page for documents that focus on IBM SystemsDirector and specific IBM hardware; such documents often containsystems-management material. The following book is available for IBM SystemsDirector V6.1:

Implementing IBM Systems Director 6.1

Tip: Be sure to note the date of publication and to determine the version of IBMSystems Director software to which the Redbooks publication refers.

Further information

See Searching knowledge bases for more resources for further information aboutIBM Systems Director.

Web resourcesListed here are the websites and information center topics that relate to IBMSystems Director.

Websitesv IBM Systems Director

www.ibm.com/systems/management/director/View the IBM Systems Director website on ibm.com® which provides links todownloads and documentation for all currently supported versions of IBMSystems Director.

v IBM Systems Director Downloadswww.ibm.com/systems/management/director/downloads/View the IBM Systems Director Downloads website on ibm.com which provideslinks to download code IBM Systems Director, IBM Systems Director plug-ins,and IBM Systems Director upward integration modules.

v IBM Systems Director Documentation and Resourceswww.ibm.com/systems/management/director/resources/View the IBM Systems Director Documentation and Resources website onibm.com which provides links to product documentation, Redbooks, redpapers,

viii IBM Systems Director Commands Reference

http://publib.boulder.ibm.com/infocenter/director/pubs/topic/com.ibm.director.plan.helps.doc/fqm0_r_hardware_requirements_for_running_ibm_systems_director_server.html

http://www.ibm.com/redbooks/

http://www.redbooks.ibm.com/redbooks/pdfs/sg247694.pdf

http://publib.boulder.ibm.com/infocenter/director/pubs/topic/com.ibm.director.tbs.helps.doc/fqm0_ts_searching_kbs.html

http://www.ibm.com/systems/management/director/

http://www.ibm.com/systems/management/director/downloads/

http://www.ibm.com/systems/management/director/resources/

white papers, and learning modules that are related to IBM Systems Director,IBM Systems Director plug-ins, and IBM Systems Director upward integrationmodules.

v IBM Systems Director Upward Integrationwww.ibm.com/systems/software/director/downloads/integration.htmlView the IBM Systems Director Upward Integration website on ibm.com whichprovides more information about IBM Systems Director upward integrationmodules that are created by IBM and other companies. IBM Systems DirectorUIMs enable third-party workgroup and enterprise systems-managementproducts to interpret and display data that is provided by IBM Systems DirectorPlatform Agent managed system.

v IBM Systems Director Best Practices Wikihttps://www.ibm.com/developerworks/mydeveloperworks/wikis/home?lang=en#/wiki/W3e8d1c956c32_416f_a604_4633cd375569/page/Best%20PracticesView updated documentation and best practices for IBM Systems Director onvarious systems.

v IBM Serverswww.ibm.com/servers/View the IBM Servers website to learn about IBM Systems server and storageproducts.

v IBM ServerProvenwww.ibm.com/servers/eserver/serverproven/compat/us/View the IBM ServerProven website to learn about hardware compatibility ofIBM System x and BladeCenter systems with IBM applications and middleware,including IBM Systems Director.

Forumsv IBM Systems Director Forum (System x, System z®, Power Systems™)

www.ibm.com/developerworks/forums/forum.jspa?forumID=759View the IBM Systems Director Forum website on ibm.com to discussproduct-related issues that pertain to IBM Systems Director, IBM SystemsDirector UIMs, and IBM Systems Director extensions. This website includes alink for obtaining the forum by using a Rich Site Summary (RSS) feed.

v View the IBM Systems Director 6.x IBM Systems Director Software DevelopmentKit (SDK) information.– IBM Systems Director SDK V 612– IBM Systems Director SDK V 62x– IBM Systems Director SDK V 63x

v IBM Systems Forumswww.ibm.com/developerworks/forums/dw_esforums.jspView the IBM Systems Forums website on ibm.com to learn about variousforums that are available to discuss technology-related and product-relatedissues that pertain to IBM Systems hardware and software products. Thiswebsite includes a link for obtaining the forum by using a Rich Site Summary(RSS) feed.

About this publication ix

||

|

|

|

http://www.ibm.com/systems/software/director/downloads/integration.html

https://www.ibm.com/developerworks/mydeveloperworks/wikis/home?lang=en#/wiki/W3e8d1c956c32_416f_a604_4633cd375569/page/Best%20Practices



http://www.ibm.com/servers/

http://www.ibm.com/servers/eserver/serverproven/compat/us/

http://www.ibm.com/developerworks/forums/forum.jspa?forumID=759

dirsdk612.zip

dirsdk62x.zip

dirsdk63x.zip

http://www.ibm.com/developerworks/forums/dw_esforums.jsp

How to send your commentsYour feedback is important in helping to provide the most accurate and highestquality information.

If you have any comments about this book or any other IBM Systems Directorpublication, go to the IBM Systems Director information center Web site atpublib.boulder.ibm.com/infocenter/director/pubs/index.jsp. There you will findthe feedback page where you can enter and submit comments.

x IBM Systems Director Commands Reference

http://publib.boulder.ibm.com/infocenter/director/pubs/index.jsp

Chapter 1. smcli - Systems management command-lineinterface

The systems management command-line interface (smcli) is a utility that you canuse to perform system management tasks from the command line. Using smcli,you can specify options that are not associated with any command.

Syntax

smcli [-h | -? | --help]

smcli [-c] [-prompt] [-user user_name] [-pw password] command_string

smcli -d

Description

Prerequisite: Management servers running Windows XP, Windows 2000, orWindows 2003 require msvcr80.dll to run smcli. You can obtain the dynamic linklibrary (DLL) by installing vcredist_x86.exe. For information about downloadingand installing this file, see https://www.microsoft.com/downloads.

Running smcli commands

You can run smcli commands locally from the management server or remotely byaccessing the management server using a remote-access utility, such as Secure Shell(SSH) or Telnet.

To run smcli commands, navigate to the install_root\bin directory, where install_rootis the root directory of your IBM Systems Director installation. Note that this pathuses the backslash (\) to delimit the directory; depending on the system that youare using, you might be required to enter the path using the forward slash (/).

You can execute up to 20 concurrent smcli or dircli threads simultaneously. The 20concurrent threads are executed in the sequence in which you issue them as 20independent commands. Obtaining a thread for final execution is dependent on theavailability and priority of the thread.

By default, only five commands can run concurrently. In order to set the value toallow more than five commands to be run concurrently, you must increase themax.cli.threads value. Complete the following steps:1. Edit the following file:

<director_install>/lwi/conf/overrides/USMIKernel.properties

where <director_install> is the IBM Systems Director installation directory.2. Append the following line to the end of the file:

max.cli.threads=20

The max.cli.threads value can be any value up to 20.3. Restart the IBM Systems Director Server.

Notes:

© Copyright IBM Corp. 1999, 2015 1

https://www.microsoft.com/downloads

v Ensure that logging is set to capture sufficient data for future debugging.v Thread scheduling is handled in the thread pool and is based on the assigned

priority of the thread.v With the exception of CSM, you must manually execute concurrent commands

that require the completion of or data from previously-launched threads. Thiswill ensure that the first command completes execution before the commandthat depends on it starts execution.

v To initialize the commands, a security check is done at the launch of eachcommand.

v If you ran multiple CLI commands with success in the past, your sequencingmight be modified.

v Authorization for each thread is not passed from one thread to another. Theauthorization of the command execution is done at the initial level, so there isno security check at the pool level. The role-based access levels that are definedfor each type of user are passed along when a user executes a command.

If the management server runs on AIX® or Linux and you do not specify the-prompt, -user, and -pw options, specifying smcli is optional. If you do specify oneor more of those options, you must also specify smcli. If the management serverruns on Windows, specifying smcli is required.

Note: In previous releases of IBM Systems Director, the CLI was called dircli. Thedircli command is supported in this release for compatibility with earlierversions. You can run all smcli commands using dircli.

Using the latest smcli commands is recommended; however, dircli commands aresupported in this release for compatibility with IBM Director version 5.20 andearlier. To use a dircli command with the same name as an smcli command, youmust define the CLILEGACY environment variable and set it to a value of 1.

smcli command authentication

IBM Systems Director can authenticate and authorize command requests usingserver or Windows Active Directory. You can specify user credentials (user nameand password) for authentication and authorization every time that you run acommand. However, if you do not specify user credentials, then IBM SystemsDirector checks to ensure that the user ID executing the command has the properauthorization. You can specify the user credentials in one of these ways:v Include the user credentials with the command using the -user and -pw options.v Set up a prompt, using the -prompt option or the CLIPROMPT environment

variable.v Create a persistent copy of the user name and encrypted password, using the

smcli -c command. After the user name and password are saved, the savedcredentials are used each time you run a command; you do not need to specifyuser credentials with the smcli commands until you delete the persistent copy,using the smcli -d command.

If you do not specify the -prompt, -user, and -pw options, IBM Systems Directoruses the value of the CLIPROMPT environment variable (if set) to determinewhether to prompt for the user name and password. You can set this variable totrue (prompt) or false (no prompt).

If the CLIPROMPT environment variable is not set or is set to false, and you donot specify the -prompt, -user, and -pw options with the command, IBM Systems

2 IBM Systems Director Commands Reference

Director checks to determine if a persistent copy of the user name and encryptedpassword were created previously with the -c option. If a persistent user nameand password were created previously, IBM Systems Director uses thesecredentials. If none of these options were used, IBM Systems Director CLI uses theoperating system to acquire the user ID, then performs the authorization check toensure that the user is authorized to perform the command.

Important:

v The password is protected from being displayed only when you are promptedfor the password or when IBM Systems Director uses the persistent copy of theencrypted password. When you specify the password using the -pw option, thecharacters for the password are displayed as plain text.

v When you specify user credentials from the command line using the -user and-pw options, there is a fraction of a second during which the command(including the user name and password) can be seen by listing the processes onthe system.

smcli logging

To enable logging for and allow for future debugging of smcli, you must set theSMCLI_DEBUG environment variable. The environment variable can be set to anyvalue, although the following examples show a value of “1”.v Example of setting the SMCLI_DEBUG environment variable in Windows:

set SMCLI_DEBUG=1

v Example of setting the SMCLI_DEBUG environment variable in Linux:export SMCLI_DEBUG=1

When logging is enabled, the logs are placed in the following location, whereDirector_root_directory is the name of the root directory:Director_root_directory/log/smcli.log

Only one level of logging is supported.

Note: The log setting applies only to the smcli client program, and not to theactual command that is being run.

To disable logging for smcli, you must remove the setting of the SMCLI_DEBUGenvironment variable.v Example of removing the setting of the SMCLI_DEBUG environment variable in

Windows:set SMCLI_DEBUG=

or remove the environment variable.v Example of removing the setting of the SMCLI_DEBUG environment variable in

Linux:unset SMCLI_DEBUG

Operands

None

Chapter 1. smcli 3

Flags

-c Creates a copy of the specified user name and password. The password in thecopy is encrypted.

If the CLIPROMPT environment variable is not set or is set to false, and youdo not specify the -prompt, -user, and -pw options with the command, IBMSystems Director checks to determine if a persistent copy of the user name andencrypted password were created previously with the -c option. If a persistentuser name and password were created previously, IBM Systems Director usesthese credentials. If none of these options were used, IBM Systems DirectorCLI uses the operating system to acquire the user ID, then performs theauthorization check to ensure that the user is authorized to perform thecommand.

If you do not specify the -user or -pw options, IBM Systems Director promptsyou for the user name or password.

Tips:

v After you create a persistent copy of the user name and password, you nolonger have to provide the user name and password for subsequent smclicommands.

v If you specify this option, you must also specify a valid command.

-d Deletes the persistent copy of the user name and encrypted password.

Important: For security reasons, you should always run the smcli -dcommand when you finish using the CLI.

-h | -?Displays the syntax and a brief description of smcli.

Tips:

v If you specify additional options, the options are ignored.v If you want to display the syntax and brief description of a specific

command, specify the command name before the -h | -? option.

--helpDisplays detailed information about smcli, including the syntax, a descriptionof smcli, a description of the options and operands, error codes, and examples.

Tips:

v If you specify additional options, the options are ignored.v If you want to display the detailed information about a specific command,

specify the command name before the --help option.v (AIX and Linux only) You can also display detailed help in the form of man

pages using the man command_name command.

-promptPrompts you for a user name and password.

Tips:

v This option protects the display of the password. When you are promptedfor the password, no characters are displayed.

v Specifying the -prompt option overrides all other mechanisms for prompting,including the CLIPROMPT environment variable.


v If you specify this option with the -user and -pw options, the -prompt optionis ignored.

-pw passwordSpecifies the password for the user name.

Important: The password is displayed as plain text when you specify the -pwoption. Using this option could cause a security exposure.

Tip: If you specify this option without the -prompt or -user options, you willbe prompted for the user name.

-user user_nameSpecifies a valid user name.

Tip: If you specify this option without the -prompt or -pw options, you will beprompted for the password.

command_stringRuns the specified command and options.

Exit status

The following codes are returned by this command.v 0: The operation completed.v 1: A usage error occurred.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you

are not authorized to perform the action.v 8: The exit code is out of range (0 to 255).v 29: The specified locale is not valid or not supported.v 10: A file-processing error occurred.v 125: An internal error occurred.

Examples1. Create a user session

This example illustrates how to create a user session that uses the persistentcopy of the user name and password. The PROMPT environment variable is setto yes, so the user is prompted for the password.smcli -c -user Admin1password:

Tip: No characters are displayed when you type the password.2. Authenticate using the specified user name and password

This example illustrates how to list the IBM Systems Director users using thespecified user name and password for authentication.smcli -user Admin1 -pw passw0rd lsuser

mysystem\Admin1mysystem\Admin2

3. Authenticate by prompting for user name and passwordThis example illustrates how to list the IBM Systems Director users and promptfor the user name and password to use for authentication.

Chapter 1. smcli 5

smcli -prompt lsuseruser: Admin1password:

mysystem\Admin1mysystem\Admin2

4. Display help for the smcli commandThis example displays help for the smcli command. The information displayedis the same as the content of this topic.smcli -?

5. Create a credentials fileThis example illustrates how to create a copy of the user name and encryptedpassword that can be used to authorize the user when running future smclicommands. The PROMPT environment variable is set to yes, so the user isprompted for the password. This example also lists all smcli commands andbundles.smcli -c -user Administrator lsbundlepassword:

6. Delete the credentials fileThis example illustrates how to delete the credentials file.smcli -d

Language specifications for smcli commandsIBM Systems Director uses operating-system language settings for smclicommands.

Prior to IBM Systems Director 6.3, the -L | --lang option and the DIR_LANGenvironment variable could be used to specify the language for commands thatrun in smcli. The -L | --lang option and the DIR_LANG environment variable areno longer available. Use of the -L | --lang option will result in a usage error. Ifthe DIR_LANG environment variable is set, it will be ignored.

Although the -L | --lang option and the DIR_LANG environment variable are nolonger available, you can specify the language by retrieving language informationfrom the operating system language settings. The operating system languagesettings are applied in the following order:v For Windows, the language is specified using the Regional and Language

Options setting.v For AIX and Linux, the values of these variables are used in the following order:

– LC_ALL– LANG– LC_LANG

Tips:

v For messages returned by the smcli command itself, the language is taken fromthe System language setting for Windows and or the LANG variable for AIXand Linux.

Port configuration for smcliBy default, smcli uses port 2044 to communicate with the IBM Systems DirectorServer. You can optionally configure the port.


To configure the port, create in the home directory on the management server a filenamed smcliconfig.prop with the necessary level of access protection. This filecontains the port attribute, using the following format:port=port_number

Create smcliconfig.prop in the appropriate home directory location for youroperating system:v On Windows, create smcliconfig.prop in My Documents.v On AIX or Linux, create smcliconfig.prop in /root/.

CLILEGACY environment variableYou must set the CLILEGACY environment variable to run the IBM Directorversion 5.20 dircli commands from smcli.

Using the latest smcli commands is recommended; however, dircli commands aresupported in this release for compatibility with IBM Director version 5.20 andearlier. To use a dircli command with the same name as an smcli command, youmust define the CLILEGACY environment variable and set it to a value of 1.

Tips:

v Setting the CLILEGACY environment variable to 1 is useful if you have scriptsmust run commands using the dircli syntax.

v The smcli command syntax is displayed when you use the help options (-?, -h,or --help) even when the CLILEGACY environment variable to 1. Forinformation about the dircli commands, see the commands reference in theIBM Director version 5.20 information center at publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_table_toc.html.

If you do not define CLILEGACY or if you set it to a value of 0, the currentcommand syntax is used.

Administration commandsThe smcli administration commands perform administrative operations on IBMSystems Director Network Control, including changing the server nonstopwatchdog configuration, listing advanced managers, listing smcli commands andbundles, activating advanced managers, and deactivating advanced managers.

smcli commands

The following smcli administration commands are available:

activatemgrs commandUse the activatemgrs to activate an advanced manager that is currentlydeactivated.

Syntax

smcli activatemgrs [-h] [-?] [-- help]

For information about the options listed above that are specific to smcli, entersmcli -?.

smcli activatemgrs advanced_manager_name

Chapter 1. smcli 7

|

||||

|

|

|

||

|

|

||

|

http://publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_table_toc.html

http://publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_table_toc.html

Description

The activatemgrs command allows a user to activate an advanced manager that iscurrently in the deactivated state. You can change an advanced manager at anytime from the deactivated state to the activated state or the reverse.

Note: Both activation and deactivation of advanced managers will require a restartof IBM Systems Director Server.

Deactivated managers do not use any memory or CPU resources and can thereforeimprove the overall server performance. It is recommended to keep as muchunused function as possible in the deactivated state for the best performance.

Operands

The activatemgrs command uses the name, in the format in which it is returnedby the lsmgrs command, of one or more advanced managers as operands.

Attention: If the name of the advanced manager has one or more spaces in it,you must enclose the name in quotation marks.

Flags

Note: The -L | --lang option and the DIR_LANG environment variable are nolonger available. Use of the -L | --lang option will result in a usage error. If theDIR_LANG environment variable is set, it will be ignored.

-h | -?Displays the syntax and a brief description of the command.

Tip: If you specify additional options other than -h | -? | --help, the optionsare ignored.

--helpDisplays detailed information about the command, including the syntax, adescription of the command, a description of the options and operands, errorcodes, and examples.

Tips:

v If you specify additional options other than -h | -? | --help, the options areignored.

v (AIX and Linux only) You can also display detailed help in the form of manpages using the man command_name command.

Exit status

The following codes are returned by this command.v 0: Initiated the activation operation.v 1: A usage error occurred.v 2: The command or bundle was not valid.v 3: The user did not have permission to execute command.v 61: The specified advanced manager name is not valid.v 62: The operation did not initiate because the advanced manager is active.

Examples1. Activate an advanced manager


|

|||

||

|||

|

||

||

|

|||

||

||

||||

|

||

||

|

|||||||

|

|

This example illustrates how to activate the IBM Systems Director ActiveEnergy Manager® advanced manager after using the lsmgrs command todetermine that its name is Active Energy Manager.smcli activatemgrs “Active Energy Manager”

After issuing the command, restart IBM Systems Director Server.

deactivatemgrs commandUse the deactivatemgrs to deactivate an advanced manager that is currentlyactivated.

Syntax

smcli deactivatemgrs [-h] [-?] [-- help]


Description

The deactivatemgrs command allows a user to deactivate an advanced managerwhich is currently in the activate state. Users can change an advanced manager atany time from the deactivated state to the activated state or the reverse.

Deactivated managers don't use any memory or CPU resource and can improvethe overall server performance. It is recommended to keep as much unusedfunction in the deactivate state for the best performance.

Note: Both activation and deactivation of advanced managers will require a restartof the IBM Systems Director.

Operands

One or more advanced managers where advanced_manager_name is the name of theadvanced manager as the name provided for IBM Systems Director NetworkControl or IBM Systems Director Active Energy Manager® that is returned by thelsmgrs command

Flags





Tips:

Chapter 1. smcli 9

|||

|

|

|

||

|

|

||

|

|||

|||

||

|

||||

|

|||

||

||

||||

|



Exit status

The following codes are returned by this command.v 0: Initiated the deactivation operation.v 1: A usage error occurred.v 2: The command or bundle was not valid.v 3: The user did not have permission to execute command.v 61: The specified advanced manager name is not valid.v 62: The operation did not initiate because the advanced manager is deactivated.

Examples1. To deactivate one or more advanced managers:

smcli deactivatemgrs advanced_manager_name

lsmgrs commandUse the lsmgrs to list the advanced managers that can be activated and deactivatedalong with the current state of the manager.

Syntax

smcli lsmgrs [-h] [-?] [-- help]


smcli lsmgrs

Description

The lsmgrs command lists the advanced managers that support activation anddeactivation, along with the current state of the advanced manager. You canchange an advanced manager at any time from the deactivated state to theactivated state or the reverse.

Operands

None.

Flags





||

||

|

|||||||

|

|

|

|

||

|

|

||

|

|

||||

|

|

|

|||

||

||


Tips:



Exit status

The following codes are returned by this command.v 0: Listed the advanced managers.v 1: A usage error occurred.v 2: The command or bundle was not valid.v 3: The user did not have permission to execute command.

Examples1. List all available advanced managers and their activation states

This example illustrates how to list all advanced managers, along with theiractivation states, that are available for activation or deactivation.smcli lsmgrs

lsbundle commandUse the lsbundle command to list the smcli commands and bundles.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsbundle options


smcli lsbundle [-h | -? | --help]

Description

The lsbundle command lists the bundles and commands currently defined in IBMSystems Director. Use this command to determine which functions are availablefrom the command line.

Each line of the output displays the name of a bundle and command belonging tothe bundle, separated by a slash:bundleName/commandName

IBM Systems Director commands that are available in this release are listed first,followed by a blank line. The bundles commands listed after the blank line aresupported commands that were introduced in IBM Director version 5.20 or earlier.

Operands

None.

Chapter 1. smcli 11

||||

|

||

||

|

|||||

|

|

||

|

|

|

|

|

||

|

|

|||

||

|

|||

|

|

Flags





Tips:



-v | --verboseWrites verbose messages to standard output.

If this option is not specified, this command suppresses noncritical messages.

Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.

Example1. List the smcli commands

This command illustrates how to list all the bundles and commands defined forsmcli.smcli lsbundle

lscandidateserver commandUse the lscandidateserver command to list virtual servers, which can be used tocreate a new workload.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lscandidateserveroptions


smcli lscandidateserver [-h | -? | --help]


|

|||

||

||

||||

|

||

||

||

|

|

|||||||

|

|

||

|

|

||

|

||

||

|

smcli lscandidateserver [-v] [-o] [-s virtualserver] [-H {true | false}][-g syspool_id]

Description

The lscandidateserver command displays virtual servers that can be used tocreate a new workload.

Operands

None.

Flags





Tips:





-g | --syspoolid syspool_idSpecifies the unique ID (OID) of the targeted server system pool.

Required if -H | --resiliency is specified.

-o | --oidDisplays the unique ID (OID) of the Virtual Server returned by this operation(optional).

-s | --serverVirtual server ID. One server ID supported (optional).

H | --resiliency {true | false}Specifies whether the target should have high availability (optional).

Exit status

The following codes are returned by this command.v 0: The operation completed.v 1: A usage error occurred.

Chapter 1. smcli 13

||

|

||

|

|

|

|||

||

||

||||

|

||

||

||

|

||

|

|||

||

||

|

|||

v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you

are not authorized to perform the action.v 9: The locale used was not valid.v 69: An invalid workload criteria was fetched.v 96: An input/output error occurred.v 125: An error occurred when retrieving the TaskService

Example1. This example illustrates how to show a list of all compatible virtual servers that

can be used to create a new workload.smcli lscandidateserver -s 1234 -H false

backupcfg command

Use the backupcfg command to retrieve the CLI configuration from the ChassisManagement Module (CMM) or Integrated Management Module (IMM).

Syntax

smcli backupcfg [-h | -? | --help]


smcli backupcfg [-v] { -n systemName | -o oid | -i ipaddress [-m]}

Description

The backupcfg command creates a backup of the current settings on the systemand displays them in the CLI/Properties format

Operands

None.

Flags





Tips:



|||||||

|

||

|

|

||

|

|

||

|

|

||

|

|

|

|||

||

||

||||

|

||


-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Targets one or more systems, specified by IP address or host name.

The list can be a mixture of IP addresses and host names, separated by acomma.

ip_addressThe IP address of the system.

Tips:

v You can enter lssys -A IP_address to list the IP address of eachdiscovered system.

v You can use either the IPv4 or IPv6 format to specify the IP address.

host_nameEither the host name or the host name and Domain Name System (DNS)suffix of the system. If the host name contains spaces, enclose it inquotation marks. If it contains a comma, prefix the comma with abackslash (\).

Tips:

v You can enter lssys -A HostName to list the host name of eachdiscovered system.

v The host names are not locale specific.v A given IP address or host name might resolve multiple systems. For

example, both the OperatingSystem and Server instance of a particularsystem will have the same host name. Use system Object ID (option -n)to target a system uniquely.

-m | {multi}Displays configuration properties that are not specific to the device, forexample the IP address.

-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Targets one or more systems specified by name or ID.

The list can be a mixture of system names and IDs, separated by a comma andcontaining no blank spaces.

If the -n option is not specified, then a customized event action that starts anoninteractive task on the system on which the event occurred is created. If the-n option is specified, then a customized event action that starts anoninteractive task on a specified system is created.

system_oidThe unique ID of the system, specified as a hexadecimal value prefixedwith 0x (for example, 0x37) or a decimal value (for example, 123).

Tip: Use the lssys -o command to list all system IDs.

system_nameThe name of the system. If the system name contains a comma, prefix thecomma with a backslash (\).

Tips:

Chapter 1. smcli 15

||

||

||

||

|

||

|

|||||

|

||

|

||||

|||

||

||

||||

|||

|

|||

|

v The system names might not be unique. This command acts on allsystems with the specified name. Use the -v | --verbose option togenerate a message when this command targets multiple systems withthe same name. To target a particular system that has a name that is notunique, identify the system by specifying its unique, hexadecimal ID, oruse additional target options to refine the selection.

v Use the lssys command without any options to list all system names.v The system names are not locale specific.

-o | --oid

Displays the unique IDs associated with the targeted systems in addition toother information.

IDs are displayed as hexadecimal values, prefixed with 0x (for example, 0x3e).

Tips:

v This option cannot be used with the -p | --pipe option.v You can combine this option with the -l | --long and -A | --attribute

options.



Exit status


are not authorized to perform the action.v 8: Invalid command.v 20: Device not found.v 27: Invalid parameter.v 29: Invalid or unsupported locale.v 51: The operation failed.v 120: Internal development error which should not happen.

Example

Retrieve the CLI configuration from the CMM or IMM.

This example illustrates how to request the CLI configuration from the CMM orIMM. BSOMACKENZIE is the system name. Add a greater than sign and file name atthe end to save the information to a file.smcli backupcfg -n BSOMACKENZIE > backupconfig.txt

resetcfg commandUse the resetcfg command to reset the Chassis Management Module (CMM) andIntegrated Management Module (IMM) to the default settings.

Syntax

smcli resetcfg [-h | -? | --help]


||||||

|

|

|

||

|

|

|

||

||

|

|

||||||||||||

|

|

|||

|

|

||

|

|


smcli resetcfg [-v] { -n systemName | -o oid | -i ipaddress}

Description

None

Operands

None

Flags





Tips:






Tips:




Tips:

Chapter 1. smcli 17

||

|

|

|

|

|

|

|||

||

||

||||

|

||

||

||

||

||

|

||

|

|||||

|










Tips:



-o | --oid



Tips:


options.




||

|

||||

||

||

||||

|||

|

|||

|

||||||

|

|

|

||

|

|

|

||

||

|

Exit status


are not authorized to perform the action.v 51: The operation failed.

Example

Reset the CMM and IMM to the default settings

This example illustrates how to reset the CMM and IMM to the default settings.BSOMACKENZIE is the system name.smcli resetcfg –n BSOMACKENZIE

The following message will be displayed: "Are you sure you want to reset theconfiguration to the default values?" Type 1 for yes or 0 (zero) for no.

restorecfg commandUse the restorecfg command to restore or apply CLI configuration to the ChassisManagement Module (CMM) or Integrated Management Module (IMM).

Syntax

smcli restorecfg [-h | -? | --help]


smcli restorecfg [-v] { -n systemName | -o oid | -i ipaddress} {-fbackupconfig_file_name}

Description

None

Operands

None

Flags


-f | --file {file_name | -}Retrieves data either from the input file file_name or from input piped fromanother command.

To retrieve input piped from another command, specify a hyphen (-) instead ofa file name (for example, smcli cmd1 | smcli cmd2 -f -). To retrieve inputfrom a file, specify the full path. If the path contains spaces, enclose it inquotation marks.

Chapter 1. smcli 19

|

|||||||

|

|

||

|

||

|

||

|

|

||

||

|

|

|

|

|

|||

|||

||||




Tips:






Tips:




Tips:








||

||

||||

|

||

||

||

||

||

|

||

|

|||||

|

||

|

||||

||

||

||||




Tips:



-o | --oid



Tips:


options.



Exit status


are not authorized to perform the action.v 51: The operation failed.

Example

Restore the CLI configuration to the CMM or IMM

This example illustrates how to restore or apply CLI configuration to the ChassisManagement Module (CMM) or Integrated Management Module (IMM). TheBSOMACKENZIE is the system name.smcli restorecfg –n BSOMACKENZIE -f bacupconfig.txt

The following message will be displayed: "Are you sure you want to restore theconfiguration on the selected device?" Type 1 for yes or 0 (zero) for no.

Chapter 1. smcli 21

|||

|

|||

|

||||||

|

|

|

||

|

|

|

||

||

|

|

|||||||

|

|

|||

|

||

Configuration plans and templates commandsUse the configuration commands to manage configuration plans and templates forsuch systems as chassis, servers, and network-storage systems.

Note: The related commands from IBM Director version 5.20 are not supported inthis release.

smcli commands

The following smcli configuration plan and template command groups areavailable.

Configuration plan commandsThe smcli configuration plan recording commands create, delete, and listconfiguration plans.

smcli commands

The following smcli configuration plan commands are available:

lscfgplan commandUse the lscfgplan command to list configuration plans for systems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lscfgplan options


smcli lscfgplan [-h | -? | --help]

smcli lscfgplan [-v] [-d symbol] [-T plan_list]

Description

This command lists configuration information in XML format. If a configurationplan is targeted, this command lists information about the configuration plan. If noplan is targeted, this command lists all the configuration plans on the system.

Operands

This command has no operands.

Flags


-d | --delimiter symbol

Specifies the character or set of characters that separates output data, wheresymbol is a string of one or more characters.


By default, this command separates individual data sets (for example, the datareturned for a specific object) with a line break. When you specify the -d |--delimiter option, the line break is replaced by the specified characters.




Tips:



-T | --tasks {task_oid | task_id_string | task_title}[,{task_oid |task_id_string | task_title}...]

Lists information for one or more configuration plans (which are tasks),specified by title, unique ID or ID string. The list can be a mixture of titles, IDsand ID strings, separated by a comma. The list is delimited by the end-of-linecharacter when it is read from a file.

task_oidThe unique ID of the task, specified as a hexadecimal value prefixed with0x (for example, 0x37).

Tip: You can use the lstask -o -r command to list all task IDs that arevalid for the targeted system.

task_id_stringThe unique ID string of the task, prefixed with a percent sign (%) (forexample, %ServerCfgTask). If the string ID contains a comma, prefix thecomma with a backslash (\).

Tip: You can use the lstask -I command to list all task ID strings that arevalid for the targeted system.

task_titleThe title of the task. The task title must be fully qualified with the parenttask (for example, grandparent_task_title/parent_task_title/task_title). If thetask name contains a comma, prefix the comma with a backslash (\).Enclose the task title in quotation marks if it contains a space character.

Tips:

v Task names might not be unique. This command acts on all tasks withthe specified name. Use the -v | --verbose option to generate a messagewhen this command targets multiple tasks with the same name. Totarget a task that has a name that is not unique, identify the task byspecifying its unique, hexadecimal task ID, or use additional targetoptions to refine the selection.

Chapter 1. smcli 23

v Locale-specific task names might not exist for every noninteractive task.The name specified must match the locale being used by the commandline interface.

v Use the lstask -r command to list all tasks that are valid for thetargeted system.



Exit status

The following table lists the codes returned by this command.v 0: The operation completed.v 1: A usage error occurred.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you

are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 50: This operation failed on some targets.v 51: The operation failed on all targets, but for different reasons.v 53: A specified task was not a valid configuration plan.v 54: Configuration settings were not found for a targeted system.v 55: Configuration settings are not registered with configuration manager.v 56: Configuration manager failed to connect to the device.v 57: Configuration manager lost connection to the device.

Examples1. List information about multiple configuration plans

This example illustrates how to list information for configuration plans withtask IDs 0x37 and 0x61

smcli lscfgplan -T 0x37,0x61

2. Export plan configuration information in an XML fileThis example illustrates how to export configuration information for the plannamed configplan to a file named plan.xml.smcli lscfgplan -T configplan > plan.xml

mkcfgplan commandUse the mkcfgplan command to create a configuration plan for a system. Thiscommand acquires the configuration information only from an XML input file.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkcfgplan options


smcli mkcfgplan [-h | -? | --help]

smcli mkcfgplan [-v] {-f file_list}

smcli mkcfgplan [-v] {-P plan_name} [-D description] [-A attribute_list]{-f file_list}


Description

After you create a configuration plan, you can run it on system, such as a IBMBladeCenter chassis, Flex System Enterprise Chassis, server, or network-storagesystem, using the runtask command. Use the lstask command to obtain the taskIDs of the configuration plans.

Operands

There are no operands.

Flags


-A | --attribute key=valueSets the value of the specified configuration-plan attribute, where key is theattribute key.

You can specify any of the following attribute key:

Key Data type Description

AutomaticDeploy boolean A flag that identifies whether to automaticallyapply the plan on a system. Possible values aretrue (automatically apply) and false (do notautomatically apply).

-D | --descriptionSpecifies a description for the plan being created.

Tip: If the description contains spaces or commas, enclose it in quotationmarks.

-f | --file file_name[,{file_name}...]Receives configuration data from one or more specified XML files, separatedby a comma.

If you specify the -P | --plan option, this is a list of configuration-templateXML files. If you do not include the -P | --plan option, this is a list ofconfiguration-plan XML files.

The input data in each template or plan XML file must be a set of XML tags inthe format required by IBM Systems Director configuration manager. The file isvalidated for structural correctness before the content is imported. It isvalidated for semantic correctness when the plan is applied.

Tips:

v You can export a configuration plan to a file using the lscfgplan commandand modify the configuration data for use in this command.

v You can export a configuration template to a file using the lscfgtmplcommand and modify the configuration data for use in this command.


Chapter 1. smcli 25



Tips:



-P | --plan plan_nameSpecifies the name of the plan being created.

Tip: If the plan name contains spaces or commas, enclose it in quotationmarks.



Exit status


are not authorized to perform the action.v 10: The file was not found.v 29: The specified locale is not valid or not supported.v 50: This operation failed on some targets.v 51: The operation failed on all targets, but for different reasons.v 52: The command failed with details.

Examples1. Create and run a configuration plan

This example illustrates how to create a configuration plan named configplanthat includes two templates defined in files template1.xml and template2.xml.smcli mkcfgplan -P configplan -f template1.xml,template2.xmlsmcli runtask -N chassis configplan

2. Create multiple configuration plansThis example illustrates how to create two configuration plans from input filesplan1.xml and plan2.xml, both located in the current directory.smcli mkcfgplan -f plan1.xml,plan2.xml

rmcfgplan commandUse the rmcfgplan command to delete configuration plans.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmcfgplan options



smcli rmcfgplan [-h | -? | --help]

smcli rmcfgplan [-v] {-T plan_list}

Description

Operands

None

Flags





Tips:




Deletes one or more configuration plans (tasks), specified by title, unique ID orID string. The list can be a mixture of titles, IDs and ID strings, separated by acomma. The list is delimited by the end-of-line character when read from a file.





Chapter 1. smcli 27


Tips:






Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 50: This operation failed on some targets.v 51: The operation failed on all targets, but for different reasons.v 53: A specified task was not a valid configuration plan.

Examples1. Remove a configuration plan using a task string ID

This example illustrates how to remove the configuration plan associated withthe task string ID profileTask

smcli rmcfgplan -T %profileTask

2. Remove configuration plans using task IDsThis example illustrates how to remove the configuration plans associated withthe task IDs 0x54 and 0x79.smcli rmcfgplan -T 0x54,0x79

Configuration template commandsThe smcli configuration template commands create, delete, and list configurationtemplates.

smcli commands

The following smcli configuration template commands are available:


lscfgtmpl commandUse the lscfgtmpl command to list configuration templates for systems in XMLformat.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lscfgtmpl options


smcli lscfgtmpl [-h | -? | --help]

smcli lscfgtmpl [-v] [-d symbol] [-T task_list]

smcli lscfgtmpl [-v] [-d symbol] {-w query | -n system_list}

Description

This command lists name and information about configuration templates in XMLformat. If no template is targeted, this command lists all the configurationtemplates on the system.

Operands

This command has no operands.

Flags




By default, this command separates individual data sets (for example, the datareturned for a specific object) with a line break. When you specify the -d |--delimiter option, the line break is replaced by the specified characters.




Tips:



Chapter 1. smcli 29







Tips:




Lists information for one or more configuration templates (tasks), specified bytitle, unique ID or ID string. The list can be a mixture of titles, IDs and IDstrings, separated by a comma. The list is delimited by the end-of-linecharacter when read from a file.







Tips:






-w | --where "query"Targets one or more systems based on system attributes specified by query.

The query operand is a string, enclosed in quotation marks, that defines asimple SELECT query using the following format:"attribute_key=value [{AND | OR} attribute_key=value...]"

where attribute_key can be any valid attribute, and value is the value of theattribute. The value must match the expected type for the associated attribute.For example, if the attribute is of type integer, an integer must be specified.

Tips:

v Use logical operators AND or OR to combine attributes.v Use parentheses to create nested logical constructs.v The query operand must be enclosed in quotation marks. Do not use double

quotation marks in the query.v If the value contains spaces, enclose it in single quotation marks.v Only system attributes can be specified. Use the lssys -l command to list

the available system attributes.

Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 50: This operation failed on some targets.v 51: The operation failed on all targets, but for different reasons.v 53: A specified task was not a valid configuration plan.v 54: Configuration settings were not found for a targeted system.v 55: Configuration settings are not registered with configuration manager.v 56: Configuration manager failed to connect to the device.v 57: Configuration manager lost connection to the device.

Chapter 1. smcli 31

Examples1. List information about multiple configuration templates

This example illustrates how to list information for configuration templateswith task IDs 0x37 and 0x61

smcli lscfgtmlp -T 0x37,0x61

2. List configuration information in a template XML fileThis example illustrates how to list current configuration information for thesystem with IP address 192.168.1.100.smcli lscfgplan -w MO.ipaddr=192.168.1.100

mkcfgtmpl commandUse the mkcfgtmpl command to create a configuration template for a system. Thiscommand acquires the configuration-template information only from an XML inputfile.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkcfgtmpl options


smcli mkcfgtmpl [-h | -? | --help]

smcli mkcfgtmpl [-v] {-f file_list}

Description

After you create a configuration template, you can run it on a system, such as aIBM BladeCenter chassis, Flex System Enterprise Chassis, server, ornetwork-storage system, using the runtask command. Use the lstask command toobtain the task IDs of the configuration templates.

Operands


Flags


-f | --file file_name[,{file_name}...]Receives configuration data from one or more specified XML files, separatedby a comma. This is a list of configuration-template XML files.

The input data in each configuration-template XML file must contain a set ofXML tags in the format required by IBM Systems Director configurationmanager. The file is validated for structural correctness before the content isimported. It is validated for semantic correctness when the plan is applied.

Tip: You can export a configuration template to a file using the lscfgtmplcommand and modify the configuration data for use in this command.





Tips:





Exit status


are not authorized to perform the action.v 10: The file was not found.v 29: The specified locale is not valid or not supported.v 50: This operation failed on some targets.v 51: The operation failed on all targets, but for different reasons.v 52: The command failed with details.v 58: A template with the specified name and subtype already exists.v 61: The input XML is not valid.v 125: An internal error occurred.

Examples1. Create and run a configuration template

This example illustrates how to create a configuration template using the datastored in the chassis_template.xml file. It then obtains the task ID for thetemplate with ID0x45, and runs the template on all systems in the chassisgroup.smcli mkcfgtmpl -f chassis_template.xmlsmcli runtask -N chassis_template 0x45

2. Create multiple configuration templatesThis example illustrates how to create two configuration templates from inputfiles template1.xml and template2.xml, both located in the current directory.smcli mkcfgtmpl -f template1.xml,template2.xml

rmcfgtmpl commandUse the rmcfgtmpl command to delete configuration templates.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmcfgtmpl options

Chapter 1. smcli 33


smcli rmcfgtmpl [-h | -? | --help]

smcli rmcfgtmpl [-v] {-T template_list}

Description

Operands

None

Flags





Tips:




Deletes one or more configuration templates (tasks), specified by title, uniqueID or ID string. The list can be a mixture of titles, IDs and ID strings,separated by a comma. The list is delimited by the end-of-line character whenread from a file.







Tips:






Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 50: This operation failed on some targets.v 51: The operation failed on all targets, but for different reasons.v 53: A specified task was not a valid configuration plan.

Examples1. Remove a configuration template using a task string ID

This example illustrates how to remove the configuration template associatedwith the task string ID templateTask

smcli rmcfgtmpl -T %templateTask

2. Remove configuration templates using task IDsThis example illustrates how to remove the configuration templates associatedwith the task IDs 0x54 and 0x79.smcli rmcfgtmpl -T 0x54,0x79

Discovery and inventory commandsUse the commands in this section to discover systems and collect inventory withthe command-line interface (CLI).

The following function is not available through the CLI. Use the IBM SystemsDirector Web interface instead.v Create, modify, delete, list, import, or export discovery profiles

Chapter 1. smcli 35

|

||

|||

v Create, modify, delete, list, import, or export custom queriesv Create, modify, delete, list, import, or export inventory monitorsv Activate or deactivate inventory monitorsv List, add, or remove entries from the inventory resource dictionary

dircli commands

Using the new smcli discovery and inventory commands is recommended;however, the dircli discovery and inventory commands listed in the followingtable are supported in this release for compatibility with IBM Director version 5.20.Note that not all command options are supported in this release. For informationabout the dircli commands, see the commands reference in the IBM Directorversion 5.20 information center at publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_managed_object_commands.html.

Important:

v You must enter the dircli commands in lower case.v To use a dircli command with the same name as an smcli command, you must

define the CLILEGACY environment variable and set it to a value of 1.

Table 1. Supported dircli commands

dircli commandDescription and supportedsyntax Equivalent smcli command

discover Discovers systems

Syntax:

discover -t system_type

discover

lsinv Lists the inventory of asystem

Syntax:

lsinv [-l] [-etable[.column]]

lsinv {-V} [-etable[.column]] [-ddelimiter] [-tsystem_type] [-w query |-f file_name | -Ngroup_list | [-n]system_list]

lsinv

smcli commands

The following smcli discovery commands are available:

collectinv commandUse the collectinv command to collect data about hardware and softwareresources that are currently installed on specified systems and to update thedatabase.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] collectinv options


||||

|

|||||||

|

|

||

||

||||

||

|

|

|

|||

|

||

|||||||

|

|

|

|

|

|||

|

|

http://publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_managed_object_commands.html



smcli collectinv [-h | -? | --help]

smcli collectinv [-v] [-W seconds] -p { "All Inventory" | profile_list} [-tsystem_type] [-f file_name | -w query | -i ip_address_list | -N group_list| [-n] system_list]

Description

The collectinv command collects inventory for the targeted systems. You can usethe lsinv command to view the collected inventory.

Important: Do not run the collectinv command immediately after executing theaccessys command successfully. Wait for a few minutes and then run thecollectinv command.

Operands

This command optionally uses a system list as an operand. The list can optionallybe preceded by the -n | --names option.

Flags




The input data is the list of discovery profile names and IDs, separated bycommas or line breaks.




Tips:



Chapter 1. smcli 37

||

|

|||

|

||

|||

|

||

|

|||

|||

||||

||

||

||

||||

|

||

||




Tips:




Tips:










Tips:


v Use the lssys command without any options to list all system names.


||

||

||

|

||

|

|||||

|

||

|

||||

||

||

||||

|||

|

|||

|

||||||

|

v The system names are not locale specific.

-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Targets all systems in one or more specified groups that are identified by nameor ID.

The list can be a mixture of group names and IDs, separated by a comma.

Tips:

v If the same systems are members of more than one group, they are targetedonly once.

v To target all systems, specify the “All Systems” group.

group_oidThe unique ID of the group, specified as a hexadecimal value prefixedwith 0x (for example, 0x3e7).

Tip: Use the lsgp -o command to list all group IDs.

group_nameThe name of the group. If the group name contains spaces, enclose it inquotation marks. If it contains a comma, prefix the comma with abackslash (\) and enclose the name in quotation marks.

Tips:

v Group names are unique.v Use the lsgp command without any options to list all group names.v The group names are not locale specific.

-p | --profile {"All Inventory" | { profile_name}[,profile_name...]}Discovers inventory for systems associated with one or more inventory profilesthat are specified by name and separated by a comma.

Tips:

v You can create inventory profiles using the IBM Systems Director Webinterface. You cannot create, modify, or delete profiles from the commandline interface.

v You can get a list of profile names from the IBM Systems Director Webinterface.

v To discover inventory for systems associated with all inventory profiles,specify "All Inventory".

"All Inventory"All inventory profiles.

profile_nameThe name of the inventory profile. If the inventory profile name contains acomma, prefix the comma with a backslash (\).

Tips:

v Inventory profile names might not be unique. This command acts on allinventory profiles with the specified name. Use the -v | --verbose optionto generate a message when this command targets multiple inventoryprofiles with the same name. To target an inventory profile that has aname that is not unique, identify the inventory profile by specifying itsunique, hexadecimal group ID, or use additional target options to refinethe selection.

Chapter 1. smcli 39

|

|||

|

|

||

|

|||

|

||||

|

|

|

|

|||

|

|||

||

||

||

|||

|

|||||||

v The inventory profiles names are not locale specific.

-t | --type system_type

Narrows the specified targeted systems to all systems of the specified type.

The system types are organized in a hierarchy in which child subtypes extendparent types. When you specify a parent type (for example, Platforms), itschildren (in this case, PhysicalPlatforms) are also targeted.

Tips:

v This options is not a targeting option by itself. It must be used with anothertargeting option, such as -n | --names or -i | --ipaddress.

v You can use this option in conjunction with other targeting options;however, this targeting option acts before all other targeting options.

v Use the lssys -T command to obtain a list of valid system types.v The system types are not locale specific.






Tips:




-W | --wait seconds

Displays the results of the command after waiting the specified number ofseconds, regardless of whether or not the task has been completed.

Possible values for seconds are:v -1: Waits indefinitely for the task to finish before exiting and displaying the

results. This value is the default if this option is not specified.v 0: Exits immediately, and the task continues to run in the background. Use

the lsjob or lsjobhistory command to check the status.v 1 or greater: Exits after the specified number of seconds. If the task is

completed before the specified wait period, this command displays theresults. If the task is not completed before the specified wait period, thecommand exits and the task continues to run in the background. Use thelsjob or lsjobhistory command to check the status.


|

|

|

|||

|

||

||

|

|

||

|

||

||

|

|||

|

|

|

||

|

||

|

||

|

||

||

|||||

Exit status


are not authorized to perform the action.v 20: A system was not foundv 21: A group was not found.v 29: The specified locale is not valid or not supported.v 51: Collect inventory process not supported.v 52: Collect inventory process not started.v 53: Collect inventory process is in progress.v 54: Collect inventory process failed.v 55: Collect inventory process not applicable.v 56: Collect inventory process completed with error.v 57: Collect inventory process is not authorized to run.v 58: Collect inventory process have communication error.v 59: Collect inventory process not available.v 60: A table was not found.v 61: A column was not found.v 62: The database is inactive.v 63: Collect inventory process is cancelled.v 64: Collect inventory process is not supported.v 126: Inventory collection wait time expired.v 127: Inventory collection wait time out.

Examples1. Collect inventory based on a profile ID

This example illustrates how to collect inventory based on the discovery profilenamed profile_1.smcli collectinv -p profile_1

STATUS: COMPLETED

discover commandUse the discover command to discover resources on networks that are connectedto the management server.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] discover options


smcli discover [-h | -? | --help]

smcli discover [-v] [-W seconds] {-i ip_address_list | -H hostname_list}[-t resource_type]| -p {all | profile_list}

Description

Important: The syntax or output for this command has changed since IBMDirector version 5.20. You can use the IBM Director version 5.20 command syntax

Chapter 1. smcli 41

|

|||||||||||||||||||||||||

|

|

||

|||

|

||

|

|

||

|

||

|

||

and output by setting the CLILEGACY environment variable to 1. For moreinformation about these commands, see the commands reference in the IBMDirector version 5.20 information center at publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_managed_object_commands.html.

The discover command discovers resources on networks that are connected to themanagement server. The IP address, host name, or profile ID is the necessaryoperand for discovery. When a resource type is specified, discovery is filteredbased on that type.

If you do not specify the -i | --ipaddress or -p | --profile option, thiscommand discovers resources using all available profiles.

Operands

None.

Flags




-H | --hostname hostname [, hostname, ...]Discovers one or more systems with the specified host names. The list mustcontain individual host names separated by a comma.

Host names must meet the following requirements:v The characters must consist of only alphanumeric characters, periods (.), and

dashes (-).v The first character must be an alphanumeric character.v The last character cannot be a period (.) or dash (-).v The length must not exceed 63 characters.


Tips:



-i | --ipaddress {ip_address_list_range}Discovers one or more systems with the specified IP addresses. Specify the IPaddresses as a comma-separated list or as a range of addresses (from highest tolowest) separated by a hyphen. You can specify the list of IP addresses in IPv4format, IPv6 format, or both. You must specify the range of IP addresses onlyin IPv4 format.


||||

||||

||

|

|

|

|||

||

||

|||

|

||

|

|

|

||||

|

||

||

||||||



-p | --profile {all | { profile_name}[,profile_name...]}Discovers the systems associated with one or more discovery profiles that arespecified by name and separated by a comma.

Tips:

v You can create discovery profiles using the IBM Systems Director Webinterface. You cannot create, modify or delete profiles from the commandline interface.


v To discover systems associated with all discovery profiles, specify all.v This option cannot be used with the -i | --ipaddress option.

allAll discovery profiles.

profile_nameThe name of the discovery profile. If the discovery profile name contains acomma, prefix the comma with a backslash (\).

Tips:

v Discovery-profile names might not be unique. This command acts on alldiscovery profiles with the specified name. Use the -v | --verbose optionto generate a message when this command targets multiple discoveryprofiles with the same name. To target a discovery profile that has aname that is not unique, identify the discovery profile by specifying itsunique, hexadecimal group ID, or use additional target options to refinethe selection.

v The discovery profiles names are not locale specific.

-t | --type system_typeDiscovers one or more systems of the specified type.


Tips:


v Use the lssys -I command to obtain a list of valid system types.



-W | --wait seconds




the lsjob or lsjobhistory command to check the status.

Chapter 1. smcli 43

|||

|

|||

||

|

|

||

|||

|

|||||||

|

||

|||

|

||

|

||

|

|

||

|

||

||

v 1 or greater: Exits after the specified number of seconds. If the task iscompleted before the specified wait period, this command displays theresults. If the task is not completed before the specified wait period, thecommand exits and the task continues to run in the background. Use thelsjob or lsjobhistory command to check the status.

Exit status


are not authorized to perform the action.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 50: The specified system type does not support discovery.v 126: The task did not complete before the specified wait time. The command is

still running in the background.v 127: The command timed out.

Examples1. Discover resources by IP address

This command illustrates how to discover all resources with IP addresses2002:0:0:0:10:10:18:17 and 10.10.18.173, and within the IP address range10.10.18.0 - 10.10.18.100.smcli discover -i “2002:0:0:0:10:10:18:17”, 10.10.18.173,10.10.18.0-10.10.18.100

2. Discover resources by host nameThis command illustrates how to discover all resources with host namesumeet.kumar.com.smcli discover -H sumeet.kumar.com

3. Discover resources associated with all profilesThis command illustrates how to discover all resources that are associated withall profiles.smcli discover -p all

lsinv commandUse the lsinv command to list inventory data for systems or groups.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsinv options


smcli lsinv [-h | -? | --help]

smcli lsinv [-v] [-e inventory] [-l]

smcli lsinv [-v] [-d symbol] [-e inventory_type] [-l | -F {xml|csv}] [-tsystem_type] [-f file_name | -w query | -i ip_address_list | -N group_list| [-n] system_list]


|||||

|

||||||||||||

|

|

|||

||

|

||

|

|

||

|

|

|

|

|

||

|

|

|||

Description

The lsinv command lists the inventory information on a system or group.

Important: The syntax or output for this command has changed since IBMDirector version 5.20. You can use the IBM Director version 5.20 command syntaxand output by setting the CLILEGACY environment variable to 1. For moreinformation about these commands, see the commands reference in the IBMDirector version 5.20 information center at publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_managed_object_commands.html.

If no options are specified, this command lists all inventory resource types.

Important: The -V | --values option used in IBM Director version 5.20 is nolonger supported by this command.

Operands

This command uses a system list as an operand. The list can optionally bepreceded by the -n | --names option.

Flags


-d | --delimiter symbolSpecifies one or more characters that separate data sets. The default is theend-of-line character.

Tip: This option is ignored if the -l | --long option is also specified.

-e | --entry inventory_typeDisplays information about the specified inventory type associated with thetargeted systems.

Tip:

v If this option is specified without a targeted system, this command lists theattributes for that inventory type.

v If this option is specified with a targeted system, this command lists theattributes and values for that inventory type.



The input data is the list of system names and IDs, separated by commas orline breaks.

-F | --format {xml | csv}Displays the output in the specified format, either XML or CSV. The output canbe used as input to other commands or processed by scripts.

Chapter 1. smcli 45

|

|

||||||

|

||

|

||

|

|||

|||

|

|||

|

||

||

|||

||||

||

|||



The CSV output separates data using the delimiter specified by the -d |--delimiter option.

Tips:

v In the <System> tag, the name, ipaddress and oid fields are empty if you donot specify a system.

v Multiple <Value> tags are listed if an attribute has more than one value (forexample, an attribute with a data type of stringarray).




Tips:






Tips:




Tips:





||

|

||

||

||

||

||||

|

||

||

||

||

||

|

||

|

|||||

|

||

|

||||

-l | --longLists the display name and value type of all inventory data that is associatedwith the targeted systems.

If you do not specify a system, this option lists the display name and valuetype for all inventory data for all systems.

If you do not specify this -l | --long option, this command lists the attributeand attribute values for the targeted systems.







Tips:





Tips:





group_nameThe name of the group. If the group name contains spaces, enclose it in

Chapter 1. smcli 47

|||

||

||

||

||

||||

|||

|

|||

|

||||||

|

|

|||

|

|

||

|

|||

|

||

quotation marks. If it contains a comma, prefix the comma with abackslash (\) and enclose the name in quotation marks.

Tips:





Tips:









Tips:




Exit status


are not authorized to perform the action.


||

|

|

|

|

|

|

|||

|

||

||

|

|

||

|

||

||

|

|||

|

|

|

||

|

||

|

||||||

v 20: A specified system is not valid.v 21: A specified system group is not valid.v 29: The specified locale is not valid or not supported.v 60: A table was not found.v 61: A column was not found.v 62: The database is inactive.

Examples1. List all attributes for all system types

This example illustrates how to list all attributes for all inventory types.smcli lsinv

2. List detailed attribute information for a specific system typeThis example illustrates how to list the display name and value type for allServer inventory types attributes.smcli lsinv -l -e "Server"

3. Display all inventory information for a systemThis example illustrates how to display all inventory information for the systemnamed node1.smcli lsinv -n node1

4. Display specific inventory information for a systemThis example illustrates how to display Server inventory information for thesystem named node1.smcli lsinv -n node1 -e "Server"

5. Display inventory information in XML formatThis example illustrates how to display inventory information for the systemnamed System1 in XML format.smcli lsinv -F xml -n System1

cmpptfs commandUse the cmpptfs command to compare the PTFs installed on two IBM i managedsystems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] cmpptfs options


smcli cmpptfs [-h | -? | --help]

smcli cmpptfs -s source_system_name -t target_system_name [-p product_list]

Description

The cmpptfs command compares the PTFs installed on two specific IBM i managedsystems. The comparison result is displayed in the standard output device of theprogram. For example, you can use this command to determine if any importantPTFs are missing on a specific IBM i managed system by comparing the list ofinstalled PTFs on your system against another list from a model system.

Inventory for both the source and target systems must be collected before usingthis command.

Chapter 1. smcli 49

||||||

|

|

|

|

|

||

|

|

||

|

|

||

|

|

||

|

|

||

|

|

||

|

|

|

|||||

||

Operands

None.

Flags




-p | --product product_id[,product_id...]Specifies the product ID for one or more products. Compare multiple productsby specifying more than one product ID using a comma-separated list.

-s | --source source_system_nameSpecifies the name of the source system on which the PTFs to be compared areinstalled. For system names containing spaces, enclose the name withinquotation marks.

-t | --targettarget_system_nameSpecifies the name of the target system on which the PTFs to be compared toare installed. For system names containing spaces, enclose the name withinquotation marks.



Exit status


are not authorized to perform the action.v 20: A system was not foundv 21: A group was not found.v 32: The versions of two systems were not the same.v 81: An internal acquisition error occurred.

Examples1. Compare the PTFs for all products

This example illustrates how to compare the PTFs for all the products installedon theIBM i managed systems named os1 and os2.smcli cmpptfs –s os1 -t os2

2. Compare the PTFs for specified productsThis example illustrates how to compare the PTFs for the two products namedproduct1 and product2 that installed on the IBM i managed systems named os1and os2.smcli cmpptfs –s os1 –t os2 –p product1,product2


|

|

|

|||

||

||

|||

||||

||||

||

|

|

||||||||||

|

|

||

|

|

|||

|

Event and event automation plan commandsUse the automation commands to managed automation plans, event filters, eventactions, event logs, and events.

The following function is not available through the command-line interface. Usethe IBM Systems Director Web interface instead.v Clearing eventsv Ignoring events

dircli and dircmd commands

Several dircli and dircmd commands were previously available for event andevent automation plan task processing to provide compatibility with IBM Directorversion 5.20, but they are now discontinued. See the “event/command_name”commands in the “Discontinued dircli commands” or “Discontinued dircmdcommands” topic for further information about the commands and their currentsmcli command alternatives.

smcli commands

The following smcli automation command groups are available.

Event action commandsThe smcli event action commands list, create, delete, and test event actions.

smcli commands

The following smcli event action commands are available:

lsevtact commandUse the lsevtact command to display information about available event actions orevent-action types, or to export one or more event actions to an XML file.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsevtact options


smcli lsevtact {-h | -? | --help}

smcli lsevtact [-v] {-F format} {-f file_name | [-x] action_list}{export_file}

smcli lsevtact [-v] [-o | -p] [-l] [-f file_name | -T | -t action_type |[-x] action_list]

Description

If no actions are specified, this command lists all available event actions. If nodisplay options are specified, this command lists only the event-action name.

Chapter 1. smcli 51

|

Operands

This command uses a list of event actions as an operand. If you specify the -Foption, this operand is required to specify the export file; otherwise, the operand isoptional. You can optionally precede the list with the -x option.

Flags





Tips:





The input data is the list of event actions. This list can be a mixture ofevent-action names and IDs, separated by a comma or end-of-line character.

-F | --format {xml}Generates the output in the specified format of XML.

Tips:

v You can export the action information by redirecting the output to a file. Youcan then use the file as input to other commands or to process using scripts.

v If you specify this option, you must also specify one or more event actions.v If you specify this option, you can only specify the -f or -x options.v If you specify this option, you must also specify export_file in the operand,

where export_file is the name and full path of the file.

Note: If XML is specified, the XML schema file EventActions6.3.xsd is alsocreated (if it does not already exist) in the directory where the XML file iscreated. The created XML file will reference this schema file.

-l | --longDisplays detailed information about the job.


This option returns these attributes for each job:v Namev Typev Descriptionv Details for the targeted event actionv Used by event-automation plan

-o | --oid


Tip: This option cannot be used with the -p | --pipe option.

-p | --pipe

Displays only the unique IDs for the targeted systems instead of the name.

Tip: This option cannot be used with the -o | -oid option.

-t | --type action_typeTargets all actions of the specified type, identified by name or ID.

Tips:


v Use the lsevtact -T command to obtain a list of valid action types.

-T | -listtypesDisplays the action types in addition to other information.



-x | --action action_oid[,action_oid2,...] | action_name[,action_name2...]Targets one or more event actions, specified by name or ID.

This list can be a mixture of event-action names and IDs, separated by acomma.

action_oidThe unique ID of the event-action, specified as a hexadecimal valueprefixed with 0x (for example, 0x37).

Tip: You can use the lsevtact -o command to list the event-action IDs.

action_nameThe name of the event-action. If the name contains a comma, prefix thecomma with a backslash (\).

Tips:

v If the name contains a comma, prefix the comma with a backslash (\).v If the name contains a space, enclose the name in quotation marks.v The event-action name can be locale specific. The name specified must

match the locale being used by the command line interface.v You can use the lsevtact command without any options to list the

event-action names.

Chapter 1. smcli 53

action_oidThe unique ID of the event action, specified as a hexadecimal valueprefixed with 0x (for example, 0x37).


action_nameThe name of the event action.

Tips:

v If the name contains a space, enclose the name in quotation marks.v The event-action name can be locale specific. The name specified must


event-action names.

Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified event-action name or ID is not valid.v 61: A file with the specified export file name already exists.v 62: The location of the specified export file name is not writable.v 63: The specified export file name is not readable.v 66: The specified file is missing the required path.

Examples1. List the all event actions in detailed format and the action ID

This example illustrates how to list the all event actions in detailed format,including the action ID.smcli lsevtact -lo

Name: Add to the Event Log, ID: 0x10Description:Type: Add to the Event Log, ID: 0x10History: activatedTestable: TrueLanguage: EnglishTime Zone:Used by plan: MyPlan

Name: Page Admin on duty when server fails, ID: 0x17Description: Page Admin on duty when server failsType: Send a Numeric Page, ID: 0x11History: deactivatedTestable: TrueLanguage: EnglishTime Zone: America/New_York - Eastern Standard Time - ESTSerial Port Device Name: COM1Pager Number (dial digits): 1-800-345-5555Numerical Message: 999Modem Initialization String:


Used by plan:

Name: Page Admin on duty when server is offline, ID: 0x19Description: Page Admin on duty when server is offlineType: Send a Numeric Page, ID: 0x11History: deactivatedTestable: TrueLanguage: EnglishTime Zone: America/New_York - Eastern Standard Time - EST SerialPort Device Name: COM3Pager Number (dial digits): 1-333-333-3333Numerical Message: 888Modem Initialization String: Modem-ATUsed by plan: ServerFailedPlan

2. List the all event-action types and IDsThis example illustrates how to list the names and IDs of all event-actionstypes.smcli lsevtact -To

Add to the event log, 0x10Send a numeric page, 0x11Send an alphanumeric page (via TAP), 0x12Start a program on the server, 0x14Start a program on a system, 0x15Start a task on the system that generated the event, 0x16Send an e-mail to a mobile phone, 0x17Start a program on the system that generated the event, 0x18Modify and event and sent it, 0x19Send an e-mail (Internet SMTP), 0x1aSet an event system variable, 0x1bLog to textual log file, 0x1c.

3. List all event actions for specific action typeThis example illustrates how to list all event actions of type Send an e-mail(Internet SMTP).smcli lsevtact -t "Send an e-mail (Internet SMTP)"

E-mail Admin on dutyE-mail department on backup

4. Export event actions as XMLThis example illustrates how to export two event actions with IDs 0x21 and0x22 in XML format into a file named C:\export\actions\Actions.xml.smcli lsevtact -F xml 0x21,0x22 C:\export\actions\Actions.xml

Note: The XML schema file EventActions6.3.xsd is also created (if it does notalready exist) in the directory where the XML file is created. The created XMLfile will reference this schema file. Also, the export file name must specify thefull file path.The following code is an example of output in the Actions.xml file:

<?xml version="1.0" encoding="UTF-8" ?><EventActionsxmlns="http://www.ibm.com/director/automation/event/action/6.3"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.ibm.com/director/automation/event/action/6.3

EventAction6.3.xsd">

<EventAction id="33"><Name>test-email</Name><SendEmailMobilePhoneActionType

className="com.tivoli.twg.itech.MobileEmailAlert"name="Send an e-mail to a mobile phone"><SendEmailMobilePhoneParameters>

<SendToEmailAddress>[email protected]</SendToEmailAddress><ReplyToEmailAddress>[email protected]</ReplyToEmailAddress>

Chapter 1. smcli 55

<EmailSmtpServer>dcertpmail.raleigh.ibm.com</EmailSmtpServer><EmailSmtpServerPort>25</EmailSmtpServerPort><SubjectOfMessage>&date &system</SubjectOfMessage><BodyOfMessage>&text</BodyOfMessage>

</SendEmailMobilePhoneParameters></SendEmailMobilePhoneActionType><History>Not saved</History><Language>ENGLISH</Language><Timezone>America/New_York</Timezone>

</EventAction><EventAction id="34">

<Name>log-to-file</Name><LogToLogFileActionType

className="com.tivoli.twg.alertmgr.TWGTextLogEventHandler"name="Log to a log file"><LogToLogFileParameters>

<LogFileName>EAP-log.txt</LogFileName><MaximumLogSize>1024</MaximumLogSize>

</LogToLogFileParameters></LogToLogFileActionType><History>Not saved</History><Language>ENGLISH</Language><Timezone>America/New_York</Timezone>

</EventAction></EventActions>

mkevtact commandUse the mkevtact command to import one or more event actions.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkevtact options


smcli mkevtact {-h | -? | --help}

smcli mkevtact [-v] [-C] {import_file}

Description

None

Operands

This command uses an import file name as an operand. The import_file is the nameand full path of the file that contains data for one or more event actions to beimported.

The imported file must contain event actions that are in the XML file format. Thefile can be an XML file that was previously exported using the lsevtact command.

Note: The XML schema file EventAction6.3.xsd is also needed in the directorywhere the XML file is located. The plans XML file will reference this schema filefor validation.

Flags



-C | --checkChecks the specified XML file and tests the importation of the event actions.The importation will not actually take place.




Tips:





Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 60: The specified import file is not in a valid format.v 64: The specified import file does not have read permission.v 65: The specified import file is of an unsupported version.v 66: The specified file is missing the required path.v 70: The processing of the specified import file resulted in errors or warnings.

Examples1. Validate the event actions in an XML file

This example illustrates how to validate event actions in an XML file namedC:\automation\action\MySavedActions.xml.smcli mkevtact -C C:\automation\action\MySavedActions.xmlDNZEAP1080I: (Informational) The specifed XML file does not contain any errors or warnings.

2. Create event actions by importing an XML fileThis example illustrates how to create event actions by importing an XML filenamed C:\automation\action\MySavedActions.xml.smcli mkevtact C:\automation\action\MySavedActions.xml

mkevtactemail commandUse the mkevtactemail command to create a customized event action that sends ane-mail over the Internet (SMTP) or to a mobile phone.

Chapter 1. smcli 57

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkevtactemailoptions


smcli mkevtactemail {-h | -? | --help}

smcli mkevtactemail [-v] {-P | -I} [-D description] [-p port] [-s subject][-m message] {action_name send_to_address reply_to_address smtp_server}

Description

Note: When event actions are created, the action history is inactive. To list actionhistory, you must first activate the history using the evtacthist command.

Operands

This command uses an event-action name, sent-to address, reply-to address, andSMTP server as operands.

action_nameCreates an event action with the specified name. This name must be unique.

send_to_addressSpecifies the e-mail address or addresses to which the notification is to be sent.More than one email address can be specified by using a comma separated list.

reply_to_addressSpecifies the e-mail address to which the person being notified can reply.

smtp_serverSpecifies the SMTP server to use.

Flags


-D | --description {description}Specifies a description of the event action. If the description contains specialcharacters (such as a space or comma) enclose it in quotes.

-I | --internetSends an Internet (SMTP) e-mail.




Tips:




-m | --messageSpecifies the message of the e-mail.

-p | --portSpecifies the SMTP port number. The default port is 25.

-P | --mobilephoneSends an e-mail to a mobile phone

-s | --subjectSpecifies the subject of the e-mail



Exit status


are not authorized to perform the action.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: An event-automation plan already exists with the specified name.v 51: The specified e-mail address form is not valid.

Examples1. Create an Internet e-mail event action

This example illustrates how to create an event action named E-Mail admin thatsends an Internet (SMTP) e-mail. The subject of the e-mail is Server down, andthere is no message. The e-mail is to be sent to [email protected]. The reply-toaddress is also [email protected]. The SMTP server is smtp.my.com.smcli mkevtactemail -I -s "Server down" "E-Mail admin" [email protected] [email protected]

2. Create a mobile-phone e-mail event actionThis example illustrates how to create a event action named E-Mail adminmobile phone that sends an e-mail to a mobile phone. The subject of the e-mailis Server down, and there is no message. The e-mail is sent to a customer at555-225-5555, and the reply-to address is [email protected]. The SMTP server issmtp.my.com.smcli mkevtactemail -P -s "Server down" "E-Mail admin mobile phone"[email protected] [email protected] smtp.my.com

mkevtactstpgm commandUse the mkevtactstpgm command to create a customized event action that starts aprogram.

Chapter 1. smcli 59

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkevtactstpgmoptions


smcli mkevtactstpgm {-h | -? | --help}

smcli mkevtactstpgm [-v] {-s | -e | -i ip_address [-p protocol]} [-Ddescription] {action_name program path}

Description

This command creates an customized event action that starts a program on themanagement server, a specific system, or the system on which the event occurred.

Operands

This command uses an event-action name, program name, and program path asoperands.

action_nameCreates an event action with the specified name. This name must be unique.

programSpecifies the name of the executable file to run.

pathSpecifies the full path where the executable file is located.

Flags


-D | --description {description}Specifies a description of the event action. If the description contains specialcharacters (such as a space or comma) enclose it in double quotation marks.

-e | --eventsystemStarts the program on the system on which the event occurred.




Tips:




-i | --ipaddress {ip_address | host_name}Starts the program on the system, specified by IP address or host name.


Tips:




Tips:




-p | --protocol [c | i | n | t]Specifies the communication protocol. You can specify one of these values:v c - CAS (Common Agent Services)v i - IPX (Internet packet exchange)v n - NETBIOSv t - TCP/IP (Transmission Control Protocol/Internet Protocol); This is the

default protocol.

-s | --serverStarts the program on the management server running IBM Systems DirectorServer.



Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 50: An event-automation plan already exists with the specified name.

Chapter 1. smcli 61

Examples1. Create an event action that starts a program on the management server

This example illustrates how to create an event action named Run Backup thatstarts the c:\backup\backup.exe program on the management server on whichIBM Systems Director Server runs.smcli mkevtactstpgm -s "Run Backup" backup.exe C:\backup\

2. Create an event action that starts a program on a remote systemThis example illustrates how to create an event action named Reboot systemthat starts the c:\reboot.exe program on a remote system with host namesystem1.ibm.com.smcli mkevtactstpgm -i system1.ibm.com -p t "Reboot system" reboot.exe C:\

mkevtactsttask commandUse the mkevtactsttask command to create a customized event action that starts anoninteractive task.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkevtactsttaskoptions


smcli mkevtactsttask {-h | -? | --help}

smcli mkevtactsttask [-v] [-D description] {-T task} {action_name}

Description

This command creates a customized event action that starts a noninteractive taskon either the system on which the event occurred or another specified system.

Operands

This command uses a unique event-action name as an operand. This operandcreates an event action with the specified name.

Flags


-D | --description {description}Specifies a description of the event action. If the description contains specialcharacters (such as a space or comma), enclose it in quotes.





Tips:



-T | --task {task_oid | task_id_string | task_title}Runs the task, specified by title, unique ID or ID string.



task_id_stringThe unique ID string of the task, prefixed with a percent sign (%) (forexample, %ServerCfgTask).


task_titleThe title of the task. The task title must be fully qualified with the parenttask (for example, grandparent_task_title/parent_task_title/task_title). Enclosethe task title in quotation marks if it contains a space character.

Tips:






Exit status

The following codes are returned by this command.v 0: The operation completed.v 1: A usage error occurred.v 2: The command or bundle was not found.

Chapter 1. smcli 63

v 3: The command was not performed because either authentication failed or youare not authorized to perform the action.

v 29: The specified locale is not valid or not supported.v 50: An event-automation plan already exists with the specified name.v 51: The task name or ID is not unique or valid.v 52: The task or subtask is interactive.

Examples1. Create an event action that starts a task on the system on which the event

occurredThis example illustrates how to create an event action named Discover thatruns the Run Discovery task on the system on which the event occurred.smcli mkevtactsttask -T "Discover" "Run Discovery"

2. Create an event action that starts a task on the system on a specified systemThis example illustrates how to create an event action named Discover thatruns the Run Discovery task on the system on specified system "MySystem".smcli mkevtactsttask -n MySystem -T "Discover" "Run Discovery"

rmevtact commandUse the rmevtact command to remove customized event actions.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmevtact options


smcli rmevtact {-h | -? | --help}

smcli rmevtact [-v] [-C] {-f file_name | [-x] action_list}

Description

None

Operands

This command uses a list of actions as an operand. You can optionally precede thelist with the -x | --actions option.

Flags


-C | --confirmConfirms the removal of an event action that is used by an event-automationplan.

Tip: This is equivalent to forced removal.




The input data must contain one or more event actions to be removed,specified by name or ID. This list can be a mixture of event-action names andIDs, separated by a comma.




Tips:





-x | --action action_oid[,action_oid2,...] | action_name[,action_name2...]Removes one or more event actions, specified by name or ID. This list can be amixture of event-action names and IDs, separated by a comma.




Tips:



event-action names.

Exit status


Chapter 1. smcli 65


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified event-action name or ID is not valid.v 52: A specified event action was not found.v 53: A specified action is used by an event automation plan.

Examples1. Remove an event action

This example illustrates how to remove an event action named E-mail admin.smcli rmevtact "E-Mail admin"

2. Remove multiple event actionsThis example illustrates how to remove event actions with IDs 0x1d, 0x2f, and0x1a.smcli rmevtact 0x1d,0x2f,0x1a

testevtact commandUse the testevtact command to test customized event actions.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] testevtact options


smcli testevtact {-h | -? | --help}

smcli testevtact [-v] {-f file_name | [-x] action_list}

Description

This command verifies that the targeted customized event action was previouslycreated.

This command only launches the event action. The return status is the actionlaunch status.

Note: The actual action completion status is available in the event action historylog only if the history is activated for the action. Use the lsevtacthist commandto activate the history.

Operands

This command uses a list of event actions as an operand. You can optionallyprecede the list with the -x | --action option.

Flags






Tips:





The input data is the list of event actions. This list can be a mixture ofevent-action names and IDs, separated by a comma or end-of-line character.








Tips:



event-action names.

Chapter 1. smcli 67




Tips:



event-action names.

Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified event-action name or ID is not valid.v 70: The event-action failed to launch.

Examples1. Test multiple event actions

This example illustrates how to test event actions with name E-Mail admin andID 0x34.smcli testevtact "E-Mail admin",0x34

Event automation plan commandsThe smcli event automation plan commands create, delete, modify, and list eventautomation plans.

smcli commands

The following smcli event automation plan commands are available:

chevtautopln commandUse the chevtautopln command to change an existing event-automation plan.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chevtautopln options


smcli chevtautopln {-h | -? | --help}


smcli chevtautopln [-v] [-e event_filter] [-D description] [-m new_name][-p action_list | -r action_list] plan

Description

None.

Operands

This command uses an event-automation plan ID or name as an operand.

The event-automation plan ID (plan_oid) or name (plan_name) identifies the planbeing modified.

plan_oidThe unique ID of the event-action plan, specified as a hexadecimal valueprefixed with 0x (for example, 0x3e).

Tip: You can use the lsevtautopln -o command to list event-action plan IDvalues.

plan_nameThe name of the event-action plan.

Tips:

v If the event-action plan name contains spaces or commas, enclose it inquotation marks. If the name contains a comma, prefix the comma with abackslash (\).

v The event-action plan name can be locale specific. The name specified mustmatch the locale being used by the command line interface.

v You can use the lsevtautopln command without any options to listevent-action plan names.

Flags


-D | --description {description_string}Add or replaces the description of the event-automation plan. If the descriptioncontains spaces, enclose it in double-quotation marks.

-e | --eventfilter {filter_oid | filter_name}Replaces the existing event filters with the specified filter, identified by nameor ID, in the event-automation plan.

filter_oidThe unique ID of the event filter, specified as a hexadecimal value prefixedwith 0x (for example, 0x37).

Tip: You can use the lsevtfltr -o command to list the event-filter IDs.

filter_nameThe name of the event filter. If the name contains a comma, prefix thecomma with a backslash (\).

Tips:

Chapter 1. smcli 69

v Event-filter names might not be unique. This command acts on all eventfilters with the specified name. Use the -v | --verbose option to generatea message when this command targets multiple event filters with thesame name. To target an event filter that has a name that is not unique,identify the event filter by specifying its unique, hexadecimal ID, or useadditional target options to refine the selection.

v The event-filter name can be locale specific. The name specified mustmatch the locale being used by the command line interface.

v You can use the lsevtfltr command without any options to list theevent-filter names.




Tips:



-m | --move {new_name}Renames the event-automation plan to the specified new name.

-p | --addaction {action_name | action_oid}[, {action_name |action_oid}...]

Adds one or more event actions, specified by name or ID, to theevent-automation plan. This list can be a mixture of event-action names andIDs, separated by a comma.




Tips:



event-action names.


-r | --removeaction {action_oid | action_name}[, {action_oid |action_name}...]

Removes one or more event actions, specified by name or ID, from theevent-automation plan. This list can be a mixture of event-action names andIDs, separated by a comma.

See -a | -addaction for a description of the action_oid and action_namearguments.



Exit status


are not authorized to perform the action.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified event-automation plan name or ID is not valid.v 51: The specified event filter name or ID was not found.v 52: The specified action list contains an action name or id that was not found.v 53: A specified action was not found in the specified plan.v 54: A specified action is already in the specified plan.v 55: Removing the specified action will result in a plan that contains no action,

which is not allowed. A plan must have at least one action.

Examples1. Change the description and replace the event filter for an event-automation

planThis example illustrates how to change the description to Check for onlyminor events, and replaces the event filter to MinorEvents for theevent-automation plan named MyEventPlan.smcli chevtautopln -D "Check for only minor events" -e MinorEvents MyEventPlan

2. Add multiple actions to an event-automation plan using action IDsThis example illustrates how to add actions with IDs 0x50 and 0x70 to theevent-automation plan named MyEventPlan.smcli chevtautopln -p 0x50,0x70 MyEventPlan

3. Remove multiple actions from an event-automation plan using the action nameand IDThis example illustrates how to remove an action named Run RecoveryApplication and an action with ID 0x55 from the event-automation plan withID 0x7f.smcli chevtautopln -r "Run Recovery Application",0x55 0x7f

evtautopln commandUse the evtautopln command to apply one or more systems and groups to orremove one or more systems and groups from one or more event-automationplans. You can also activate or deactivate an event-automation plan.

Chapter 1. smcli 71

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] evtautopln options


smcli evtautopln {-h | -? | --help}

smcli evtautopln [-v] [-D | -A] {-f file_name | [-P] plan_list}

smcli evtautopln [-v] {[-p] | -r} {-N group_list} {-f file_name | [-P]plan_list}

smcli evtautopln [-v] {[-p] | -r} [-N group_list] {-t system_type | -wquery | -i ip_address_list | -n system_list} {-f file_name | [-P]plan_list}

Description

If you do not specify the -p | --apply or -r | --remove option, theevent-automation plan is applied by default.

Operands

This command uses an event-automation plan list as an operand. You canoptionally precede the list with the -P | --plan option.

Flags


-A | -activateActivates the specified event-automation plan.

Tips:

v This option cannot be used with the -D | --deactivate, -p | --apply, and-r | --remove options.

v If you specify this option and the targeted plans are active, this command isconsidered successful and will return exit status 0.

-D | --deactivateDeactivates the specified event-automation plan.

Tips:

v This option cannot be used with the -A | -activate, -p | --apply, and -r |--remove options.

v If you specify this option and the targeted plans are already inactive, thiscommand is considered successful and will return exit status 0.




The input data is the list of event-automation plans to be deleted. This list canbe a mixture of plan names and IDs, separated by a comma or end-of-linecharacter.




Tips:






Tips:




Tips:





Chapter 1. smcli 73






Tips:





Tips:






Tips:


-p | --applyApplies the one or more specified systems and groups to the targetedevent-automation plans.


Tip: This option cannot be used with the -A | -activate, -D | -deactivate,and -r | --remove options.

-P | --plan {plan_oid | plan_name}[,{plan_oid | plan_name}...]Targets one or more event-automation plans, specified by name or ID. This listcan be a mixture of plan names and ID, separated by a comma.


Tip: You can use the lsevtautopln -o command to list event-action planID values.


Tips:

v If the event-action plan name contains spaces or commas, enclose it inquotation marks. If the name contains a comma, prefix the comma witha backslash (\).

v The event-action plan name can be locale specific. The name specifiedmust match the locale being used by the command line interface.


-r | --removeRemoves the specified event-automation plan from one or more specifiedsystems and groups.

Tip: This option cannot be used with the -p | --apply, -A | -activate, -D |-deactivate options.




Tips:








Chapter 1. smcli 75


Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified event-automation plan name or ID is not valid.

Examples1. Apply an event-automation plan to multiple systems identified by host name

This example illustrates how to apply the event-automation plan named LogEvents to all systems with running Windows XP Professional Edition v5.1.smcli evtautopln -w "OSType=67 AND OSVersion=5.1" "Log Events"

2. Apply an event-automation plan to multiple systems identified by IDThis example illustrates how to apply the event-automation plan with ID 0xfeto systems with IDs 0x52 and 0x34.smcli evtautopln -pn 0x52,0x34 0xfe

3. Remove multiple groups of systems from an event-automation planThis example illustrates how to remove the event-automation plan named LogEvents from systems with host names server1.ibm.com and server2.ibm.com.smcli evtautopln -ri server1.ibm.com,server2.ibm.com "Log Events"

4. Disable an event-automation planThis example illustrates how to disable the event-automation plan namedMyNewPlan.smcli evtautopln -D MyNewPlan

lsevtautopln commandUse the lsevtautopln command to list information about event-automation plans.You can also export one or more event-automation plans to a file.


Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsevtautopln options


smcli lsevtautopln {-h | -? | --help}

smcli lsevtautopln [-v] [-o | -p ] [-l] [-f file_name | -x action | -eevent_filter | [-P] plan_list

smcli lsevtautopln [-v] {-F format} {-f file_name | [-P] plan_list}{export_file}

Description

If no event-automation plans are specified, this command targets all plans. If nodisplay options are specified, this command lists the names of all targetedevent-automation plans.

Operands

This command uses a list of event-automation plans as an operand. If you specifythe -F option, this operand is required; otherwise, the operand is optional. You canoptionally precede the list with the -P option.

This command also uses the name and full path of the export file in which the oneor more event-automation plans are to be exported. This operand is required if youspecify the -F option.

Flags


-e | --eventfilter {filter_oid | filter_name}Lists the event-automation plans that contain the event filter, specified byname or ID.




Tips:


Chapter 1. smcli 77





The input data is the list of event-automation plans. This list can be a mixtureof names and IDs, separated by a comma or end-of-line character.

-F | --format {html | xml}Generates the output in the specified format, either HTML or XML.

Tips:

v You can export the plan information by redirecting the output to a file. Youcan then use the file as input to other commands or to process using scripts.

v If you specify this option, you must also specify one or moreevent-automation plans.

v If you specify this option, you cannot specify the -l | --long, -o | --oid,and -p | --pipe options.

v If you specify this option, you must also specify export_file in the operand,where export_file is the name and full path of the file.

Note: If XML is specified, the XML schema file EventPlan6.3.xsd is also created(if it does not already exist) in the directory where the XML file is created. Thecreated XML file will reference this schema file.




Tips:



-l | --longDisplays detailed information about each event-automation plan.

This option returns these attributes for each plan:v Plan namev Statusv Event filters


v Actionsv Systemsv Time rangev Description

-o | -oidDisplays the unique IDs associated with the targeted event-automation plans.IDs are displayed as hexadecimal values, prefixed with 0x (for example, 0x3e).


-p | --pipeDisplays the unique IDs for the targeted event-automation plans instead of theplan name. IDs are displayed as hexadecimal values, prefixed with 0x (forexample, 0x35).

Tips:

v When used alone, this option enables the output to be piped to other smclicommands.

v This option cannot be used with the -o | --oid options.

-P | --plan {plan_oid | plan_name}[,{plan_oid | plan_name}...]Changes one or more event-automation plans, specified by name or ID.

This list can be a mixture of plan names and IDs separated by commas.




Tips:






-x | --action {action_oid | action_name}Lists the event-automation plans that contain the event action, specified byname or ID.



Chapter 1. smcli 79


Tips:



event-action names.

Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified event-automation plan name or ID is not valid.v 61: A file with the specified export file name already exists.v 62: The location of the specified export file name is not writable.v 63: The specified export file name is not readable.v 66: The specified file is missing the required path.

Examples1. List names of all event-automation plans

This example illustrates how to list the names of all event-automation plans.smcli lsevtautopln

RestartPrintSpoolerLog EventsCPUSecurityPlan

2. List names and ID of all event-automation plansThis example illustrates how to list only the names and IDs of allevent-automation plans.smcli lsevtautopln -o

RestartPrintSpooler, 0x10Log Events, 0x26CPU, 0x70SecurityPlan, 0x90

3. Display detailed information about multiple event-automation plans using planIDsThis example illustrates how to display detailed information for two plans withplan IDs 0x26 and 0x70.smcli lsevtautopln -l 0x26,0x70

Name: Log eventsDescription: Send all events to EventLogStatus: activeEvent Filter: All Event.Time Ranges:


ContinuousActions:

Log EventsTargets:

Group name: All systems

Name: CPUDescription: Check for >90% usageStatus: inactiveEvent Filter: CPU usage > 90%Time Ranges:

ContinuousActions:

Email AdminTargets:

System Name: System1System Name: System2

4. Display detailed information about an event-automation planThis example illustrates how to display detailed information and the plan IDfor the plan named RestartPrintSpooler.smcli lsevtautopln -lo RestartPrintSpooler

Name: RestartPrintSpooler, ID: 0x11Description: Reset printer spooler.Status: activeEvent Filter: Printer Error, ID: 0x21Time Ranges:

Day and time [0] = Sunday 1:30 AM - 10:00 AMActions:

Reset Spooler, ID: 0x33Email admin, ID: 0x43

Targets:System Name: system1.abc.com, ID: 0x5eGroup Name: PublicSystems, ID: 0x56d

5. List the event-automation plans that contains an event actionThis example illustrates how to list the event-automation plans that contain theevent action named Log to Event Log.smcli lsevtautopln -x "Log to Event Log"

Log EventsSecurityPlan

6. List the plans that contains an event filterThis example illustrates how to list the event-automation plans that contain theevent filter named Critical Events.smcli lsevtautopln -e "Critical Events"

MemoryAlertNotifyCPUAlertNotify

7. Export an event-automation plan as XMLThis example illustrates how to export one event-automation plan with ID 0x21in XML format into a file named C:\export\autoplan\Plans.xml.smcli lsevtautopln -F xml 0x21 C:\export\autoplan\Plan.xml

Note: The XML schema file EventPlan6.3.xsd is also created (if it does notalready exist) in the directory where the XML file is created. The created XMLfile will reference this schema file. Also, the export file name must specify thefull file path.The following code is an example of output in the Plan.xml file:

Chapter 1. smcli 81

<?xml version="1.0" encoding="UTF-8" ?><EventPlans xmlns="http://www.ibm.com/director/automation/event/plan/6.3"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.ibm.com/director/automation/event/plan/6.3 EventPlan6.3.xsd"><EventPlan id="33"><Name>P1</Name><Description>P1-desc</Description><Status>Active</Status><Targets><Target id="7151"><ManagedEndpoint><Name>automgr3</Name><IpAddress>9.3.148.92</IpAddress>

</ManagedEndpoint></Target><Target id="1082"><Group>All Storage Systems</Group>

</Target></Targets><EventFilter id="31">

<Name>p1-fltr</Name><Description>plan1</Description><FilterType>Simple</FilterType><EventTypes><EventType><ComponentCategories><ComponentCategory>IBMSystemsDirectorProgram</ComponentCategory>

</ComponentCategories><ComponentType>Updates</ComponentType><ConditionTypes><ConditionType><Condition>UpdateOperationState</Condition><ConditionValue>DownloadUpdatesFailed</ConditionValue>

</ConditionType></ConditionTypes>

</EventType></EventTypes>

</EventFilter><EventActions><EventAction id="39"><Name>Start a program</Name><StartProgramOnManagementServerActionType className="com.tivoli.twg.alertmgr.LocalCommand"name="Start a program on the management server"<StartProgramOnManagementServerParameters><ProgramFileName>MyScript</ProgramFileName>

</StartProgramOnManagementServerParameters></StartProgramOnManagementServerActionType><History>Not saved</History><Language>ENGLISH</Language><Timezone>America/Chicago</Timezone>

</EventAction></EventActions>

</EventPlan></EventPlans>

mkevtautopln commandUse the mkevtautopln command to create a new event-automation plan or importone or more existing event-automation plans.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkevtautopln options


smcli mkevtautopln {-h | -? | --help}

smcli mkevtautopln [-v] [-C] {import_file}

smcli mkevtautopln [-v] {-e event_filter} {-x action_list} {-N group_list}[-D description] plan_name


smcli mkevtautopln [-v] {-e event_filter} {-x action_list} [-N group_list]{-t system_type | -w query | -i ip_address_list | -n system_list} [-Ddescription] plan_name

Description

None

Operands

This command uses a event-automation plan name or import file name as anoperand.

The plan_name creates an event-automation plan with the specified name.

Tips:

v If the event-action plan name contains spaces or commas, enclose it in quotationmarks. If the name contains a comma, prefix the comma with a backslash (\).

v The event-action plan name can be locale specific. The name specified mustmatch the locale being used by the command line interface.

v You can use the lsevtautopln command without any options to list event-actionplan names.

The import_file is the name and full path of the file that contains data for one ormore event-automation plans to be imported. The imported file must containevent-automation plans that are in the XML file format. The file can be an XML filethat was previously exported using the lsevtautopln command.

Note: The XML schema file EventPlan6.2.xsd is also needed in the directory wherethe XML file is located. The plans XML file will reference this schema file forvalidation

Flags


-C | --checkChecks the specified XML file and tests the importation of theevent-automation plans. The importation will not actually take place.

-D | --description {description_string}Specifies a description of the event-automation plan. If the description containsspecial characters (such as a space or comma) enclose it in quotes.

-e | --eventfilter {filter_oid | filter_name}Targets the event filter, specified by name or ID.




Chapter 1. smcli 83

Tips:







Tips:






Tips:




Tips:


v The host names are not locale specific.


v A given IP address or host name might resolve multiple systems. Forexample, both the OperatingSystem and Server instance of a particularsystem will have the same host name. Use system Object ID (option -n)to target a system uniquely.







Tips:





Tips:






Tips:

Chapter 1. smcli 85





Tips:









Tips:










Tips:



event-action names.




Tips:



event-action names.

Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: An event-automation plan already exists with the specified name.v 51: The specified event filter name or ID was not found.v 52: The specified action list contains an action name or id that was not found.v 55: The specified event filter cannot be reused in another plan.v 60: The specified import file is not in a valid format.v 64: The specified import file does not have read permission.v 65: The specified import file is of an unsupported version.v 66: The specified file is missing the required path.v 70: The processing of the specified import file resulted in errors or warnings.

Examples1. Create an event-automation plan

Chapter 1. smcli 87

This example illustrates how to create an event-automation plan namedMyNewPlan, with event filter ID 0x20, event actions 0x55 and 0x70, anddescription My New Plan. The new plan is applied to all systems in group1.smcli mkevtautopln -e 0x20 -x 0x55,0x70 -N group1 -D "My New Plan" MyNewPlan

2. Validate the event-automation plans in an XML file.This example illustrates how to validate event-automation plans in an XML filenamed C:\automation\plan\MySavedPlan.xml.smcli mkevtautopln -C C:\automation\plan\MySavedPlan.xmlDNZEAP1080I: (Informational) The specifed XML file does not contain any errors or warnings.

3. Create an event-automation plan by importing an XML fileThis example illustrates how to create an event-automation plan by importingan XML file named C:\automation\plan\MySavedPlan.xml.smcli mkevtautopln C:\automation\plan\MySavedPlan.xml

rmevtautopln commandUse the rmevtautopln command to delete one or more event-automation plans.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmevtautopln options


smcli rmevtautopln {-h | -? | --help}

smcli rmevtautopln [-v] {-f file_name | [-P]plan_list}

Description

Event filters that were created when the event automation plan was created usingthe wizard and have the name plan_name-Filter are also deleted. Default filters andother custom filters are not deleted.

Operands

This command uses a list of event-automation plans as an operand. You canoptionally precede the list with the -P | --plans option.

Flags




The input data is the list of event-automation plans to be deleted. This list canbe a mixture of plan names and IDs, separated by a comma or end-of-linecharacter.





Tips:



-P | --plan {plan_oid | plan_name}[,{plan_oid | plan_name}...]Changes one or more event-automation plans, specified by name or ID.

This list can be a mixture of plan names and IDs separated by commas.




Tips:






Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified event-automation plan name or ID is not valid.

Chapter 1. smcli 89

Examples1. Remove an event-automation plan

This example illustrates how to remove an event-automation plan with ID 0x2f.smcli rmevtautoplan 0x2f

2. Remove multiple event-automation plansThis example illustrates how to remove three event-automation plans with ID0x26 and names Plan A and Plan B.smcli rmevtautoplan "Plan A","Plan B",0x26

Event filter commandsThe smcli event filter commands list event types and filter and remove eventfilters.

smcli commands

The following smcli event filter commands are available:

lsevtfltr commandUse the lsevtfltr command to display information about the event filters. If youdo not specify any display options, this command lists the names of all eventfilters.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsevtfltr options


smcli lsevtfltr {-h | -? | --help}

smcli lsevtfltr [-v] {-F format}{-f file_name | [-e] filter_list}{export_file}

smcli lsevtfltr [-v] [-o | -p] [-l | -t] [-f file_name | [-e] filter_list

Description

If no options are specified, this command lists all event-filter names.

If no event filters are specified, this command lists all available event filters. If nodisplay options are specified, this command lists only the event-filter name.

Operands

This command uses a list of event filters as an operand. If you specify the -Foption, this operand is required to specify the export file; otherwise, the operand isoptional. You can optionally precede the list with the -e option.

Flags



-e | --eventfilter {filter_oid | filter_name}[,{filter_oid |filter_name}...]

Targets one or more event filters, specified by name or ID. This list can be amixture of names and IDs, separated by a comma.




Tips:






The input data is the list of event filters. This list can be a mixture of namesand IDs, separated by a comma or end-of-line character.

-F | --format {xml}Generates the output in the specified format of XML.

Tips:

v You can export the filter information by redirecting the output to a file. Youcan then use the file as input to other commands or to process using scripts.

v If you specify this option, you must also specify one or more event filters.v If you specify this option, you can only specify the -e or -f options.v If you specify this option, you must also specify export_file in the operand,

where export_file is the name and full path of the file.

Note: If XML is specified, the XML schema file EventFilter6.3.xsd is alsocreated (if it does not already exist) in the directory where the XML file iscreated. The created XML file will reference this schema file.


Chapter 1. smcli 91



Tips:



-l | --longDisplays detailed information about the event filter.

This option returns these attributes for each event filter:v Name: Name of the event filterv Description: Description of the event filterv Type: The filter type. These are the possible filter types:

– Simple: General-purpose filter– Exclusion: Filter to activate a group of events and then exclude a

subgroup of the events– Duplication: Filter to ignore duplicate events– Recurring: Filter to activate an event after it meets the filter criteria more

than once within a specified time rangev Text: Event filter criteriav Text Case: Flag indicating whether the event filter must match exactly,

including the case, with the text of the incoming event. Possible values are:– Sensitive: Case sensitive.– Insensitive: Not case sensitive

v Text Type: Type of text filtering. These are the possible text types:– Any word: The filter is matched if any of the specified words can be

present in the incoming event.– All words: The filter is matched if all of the specified words must be

present in the incoming event.– Exact phrase: The filter is matched if the specified text matches exactly

with text of the incoming event.v Default: Flag indicating whether the event filter is the default. Values are

true (default) and false (not default)v Read-only: Flag indicating whether the event filter is read-only. Values are

true (read-only) and false (editable)v Time Ranges: Day and time ranges as a filter criterion. Specifying a day and

time range in a filter controls the time that actions are run and, therefore,not run.

v Event Category: The mode of the event. Possible categories are:– Alert: A problem has occurred.– Resolution: A problem has been resolved and is no longer a problem.

v Event Severity: The severity level of the event, which identifies potentiallyurgent problems requiring immediate attention. Possible severities are:


– Fatal: The source of the event has already caused the program to fail andshould be resolved before the program is restarted.

– Critical: The source of the event might cause program failure and shouldbe resolved immediately.

– Minor: The application that issued the event has assigned a severity levelindicating that the source of the event should not cause immediateprogram failure, but should be resolved.

– Warning: The source of the event might not be problematic but warrantsinvestigation.

– Informational: The event was generated only for informational purposes.Most events of this severity do not indicate potential problems; however,offline events are categorized as informational, and these events mightindicate potential problems.

– Unknown: The application that generated the event did not assign aseverity level.

v Event Sender: The system that sent the event to IBM Systems DirectorServer. For example, SNMP events list the IP address of the trap source.Because most events are generated by IBM Systems Director Server, this fieldusually contains the name of the management server.

v Server Zone: Time zone that applies to this filtering criterion. This is thetime zone in which the management server is located.

v Event Types: Event types on which to filter.v Excluded Event Types: The event types that are excluded from the filter.v Frequency Interval: The interval of time that begins when an event meets the

filtering criteria.v Frequency Count: The number of times that an event must meet the criteria

within the specified frequency interval before associated actions can betriggered.

v Extended Details: The extended detail ID, value, and operator.v Variables: The variable ID, value, and operator.v Use by Automation Plan: Event-automation plans that use the filter.

-o | -oidDisplays the unique IDs associated with the targeted event filter in addition toother information. IDs are displayed as hexadecimal values, prefixed with 0x(for example, 0x3e).


-p | --pipeDisplays only the unique IDs for the targeted event filter instead of the filtername. IDs are displayed as hexadecimal values, prefixed with 0x (for example,0x35).

Tips:



-t | --typedetailsDisplays the event-type details of the event filter, in addition to otherinformation.

Chapter 1. smcli 93



Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: The specified event-filter name or ID is not valid.v 61: A file with the specified export file name already exists.v 62: The location of the specified export file name is not writable.v 63: The specified export file name is not readable.v 66: The specified file is missing the required path.

Examples1. List all event-filter names

This example illustrates how to list the names of all event filters.smcli lsevtfltr

Critical EventsMinor EventsWarning Events

2. List all event-filter names and IDsThis example illustrates how to list the names of all event filters.smcli lsevtfltr -o

Critical Events, 0x19Minor Events, 0x2eWarning Events, 0x34

3. List detailed information about an event filterThis example illustrates how to list detailed information about the event filterwith ID 0x1e.smcli lsevtfltr -l 0x1e

Name: My FilterDescription: My Filter DescriptionType: SimpleText: This is a sample textText Case: insensitive TestText Type: all wordsDefault: falseRead Only: falseTime Ranges:

Day and time [0] = Sunday 1:30 AM - 10:00 AMCategory:alertSeverity: critical, fatalSender: director.server.abc.comServer Zone: America/New_YorkEvent Types:

Managed Resource.Managed System Resource.Logical Resource.System.Managed Resource.Managed System Resource.Logical Resource.Service Access Point.

Extended Details:Threshold Name equal to CPU


Threshold Name equal to (Case Sensitive) FanThreshold Name not equal to Memory UsageThreshold Name not equal to (Case Sensitive) Memory UsageMonitor Resource equal to CPUMonitor Resource equal to (Case Sensitive) FanMonitor Resource not equal to Memory UsageMonitor Resource not equal to (Case Sensitive) Memory Usage

Variables:ServerRebootedState equal to PowerOffServerRebootedState equal to (Case Sensitive) PowerOnFan equal to PowerOffFan equal to (Case Sensitive) PowerOn

Used by plan: MyPlan

4. List detailed event-type information about an event filterThis example illustrates how to list detailed event-type information for theevent filter with name plan1-Filter.smcli lsevtfltr -t plan1-Filter

Name: plan1-FilterEvent Type (0):Component Categories: Managed Resource.Managed System Resource.Logical

Resource.System.Computer System.Component Categories Key:

ManagedElement.ManagedSystemElement.LogicalElement.System.ComputerSystem.Component Type: RAID Controller Key: RAIDController

Event Type (1):Component Categories: Managed Resource.Managed

System Resource.Logical Resource.Logical Device.Storage Extent.Component Categories Key:

ManagedElement.ManagedSystemElement.LogicalElement.LogicalDevice.StorageExtent.Component Type: Storage Volume Key: StorageVolume

5. Export event filters as XMLThis example illustrates how to export two event filters with IDs 0x21 and 0x22in XML format into a file named C:\export\filters\Filters.xml.smcli lsevtfltr -F xml 0x21,0x22 C:\export\filters\Filters.xml

Note: The XML schema file EventFilter6.3.xsd is also created (if it does notalready exist) in the directory where the XML file is created. The created XMLfile will reference this schema file. Also, the export file name must specify thefull file path.The following code is an example of output in the Filters.xml file:<?xml version="1.0" encoding="UTF-8" ?>

<EventFiltersxmlns="http://www.ibm.com/director/automation/event/filter/6.3"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.ibm.com/director/automation/event/filter/6.3 EventFilter6.3.xsd"><EventFilter id="33">

<Name>MyFilter</Name><FilterType>Simple</FilterType><EventTypes>

<EventType><ComponentCategories><ComponentCategory>ManagedElement</ComponentCategory></ComponentCategories>

</EventType></EventTypes>

</EventFilter><EventFilter id="34">

<Name>My Update Filter</Name><FilterType>Threshold</FilterType><EventTypes>

<EventType><ComponentCategories>

<ComponentCategory>IBMSystemsDirectorProgram</ComponentCategory></ComponentCategories><ComponentType>Updates</ComponentType><ConditionTypes>

<ConditionType><Condition>UpdateOperationState</Condition><ConditionValue>NewUpdatesFound</ConditionValue>

</ConditionType></ConditionTypes>

</EventType></EventTypes><Frequency>

Chapter 1. smcli 95

<FrequencyCount>1</FrequencyCount><FrequencyInterval>

<Interval>0</Interval><Unit>Second</Unit>

</FrequencyInterval></Frequency><ExtendedDetails>

<ExtendedDetail><Keyword>UninstallFailedEventTypeDetailID</Keyword><DetailsString>

<Operator>equal to</Operator><Value>f</Value>

</DetailsString></ExtendedDetail>

</ExtendedDetails></EventFilter></EventFilters>

lsevttype commandUse the lsevttype command to list event types.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsevttype options


smcli lsevttype {-h | -? | --help}

smcli lsevttype [-v] [-l] [-k key_prefix | -N name_prefix]

Description

The event types are shown in the following format:component_category[.component_category].component_type.[component_instance]

Operands

None

Flags





Tips:




-k | --keyprefix key_prefixLists event types that have the specified key prefix. The key prefix can containkeys for the component categories, a key for the component type, and a keyfor the component instance of the event type. The key_prefix value has thefollowing format:component_category_key[.component_category_key].[component_type_key].[component_instance_key]

-l | --longDisplays detailed information about each event type, including the componentcategories, component type, component instance, family, qualifiers anddescription.

-N | --nameprefix name_prefixLists event types that have the specified name prefix. The name prefix cancontain names for the component categories, a name for the component type,and a name for the component instance of the event type. The name_prefixvalue has the following format:component_category_name[.component_category_name].[component_type_name].[component_instance_name]



Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.

Examples1. List all event types

This example illustrates how to list all events types in IBM Systems Director.smcli lsevttype

Device.Processor.1Devices.MediaAccessDevice.CDROMDrive.1Systems.OperatingSystem.Unix.Linux.1

2. List detailed information about all event typesThis example illustrates how to list detailed information about all events types.smcli lsevttype -l

Device.Processor.1Component Category (0): DeviceComponent Type: ProcessorComponent Instance: 1Family: DirectorQualifier (0): DeviceQualifier (1): ProcessorDescription: device processor

3. List event types that have the specified name prefixThis example illustrates how to list event types with names that begin with“Managed Resource.Managed System Resource.Physical Resource”

Chapter 1. smcli 97

smcli lsevttype -N "Managed Resource.Managed System Resource.Physical Resource"

Managed Resource.Managed System Resource.Physical Resource.Physical Component.Chip.Physical Memory.Managed Resource.Managed System Resource.Physical Resource.Physical Connector.Slot.Managed Resource.Managed System Resource.Physical Resource.Physical Package.Card.Managed Resource.Managed System Resource.Physical Resource.Physical Package.Physical Frame.Chassis.

4. List event types that have the specified key prefixThis example illustrates how to list detailed information about event types thathave component keys that begin with“ManagedElement.ManagedSystemElement.PhysicalElement.PhysicalPackage.PhysicalFrame”.smcli lsevttype -l -k ManagedElement.ManagedSystemElement.PhysicalElement.PhysicalPackage.PhysicalFrame

Managed Resource.Managed System Resource.Physical Resource.Physical Package.Physical Frame.Chassis.Component Category (0): Managed ResourceComponent Category (1): Managed System ResourceComponent Category (2): Physical ResourceComponent Category (3): Physical PackageComponent Category (4): Physical FrameComponent Type: ChassisComponent Instance:Component Keys: ManagedElement.ManagedSystemElement.PhysicalElement.PhysicalPackage.PhysicalFrame.Chassisclass: com.ibm.usmi.kernel.events.eventtype.BasicEventTypeFamily:Condition Type (0): Operational Condition

Condition Value (0): Configuration ErrorCondition Value Mode (0): -1Condition Value Severity (0): -1Condition Value (1): TemperatureCondition Value Mode (1): -1Condition Value Severity (1): -1Condition Value (2): Bus Communication FailureCondition Value Mode (2): -1Condition Value Severity (2): -1

Condition Type (0): keys: OperationalCondition: ConfigError.Temperature.CommBus.

Condition Type (1): Open Fabric ManagerCondition Value (0): DeactivatedCondition Value Mode (0): -1Condition Value Severity (0): -1

Condition Type (1): keys: BOFM: Disabled.Description:

mkevtfltr commandUse the mkevtfltr command to import one or more event filters.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkevtfltr options


smcli mkevtfltr {-h | -? | --help}

smcli mkevtfltr [-v] [-C] {import_file}

Description

None

Operands

This command uses an import file name as an operand. The import_file is the nameand full path of the file that contains data for one or more event filters to beimported.

The imported file must contain event filters that are in the XML file format. Thefile can be an XML file that was previously exported using the lsevtfltrcommand.


Note: The XML schema file EventFilter6.2.xsd is also needed in the directorywhere the XML file is located. The plans XML file will reference this schema filefor validation.

Flags


-C | --checkChecks the specified XML file and tests the importation of the event filters. Theimportation will not actually take place.




Tips:





Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 60: The specified import file is not in a valid format.v 64: The specified import file does not have read permission.v 65: The specified import file is of an unsupported version.v 66: The specified file is missing the required path.v 70: The processing of the specified import file resulted in errors or warnings.

Examples1. Validate the event filters in an XML file

This example illustrates how to validate event filters in an XML file namedC:\automation\filter\MySavedFilters.xml.smcli mkevtfltr -C C:\automation\filter\MySavedFilters.xmlDNZEAP1080I: (Informational) The specifed XML file does not contain any errors or warnings.

Chapter 1. smcli 99

2. Create event filters by importing an XML fileThis example illustrates how to create event filters by importing an XML filenamed C:\automation\filter\MySavedFilters.xml.smcli mkevtfltr C:\automation\filter\MySavedFilters.xml

rmevtfltr commandUse the rmevtfltr command to remove event filters.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmevtfltr options


smcli rmevtfltr {-h | -? | --help}

smcli rmevtfltr [-v] [-C] {-f file_name | [-e] filter_list}

Description

None.

Operands

This command uses a list of event filters as an operand. You can optionallyprecede the list with the -e | --eventfilter option.

Flags


-C | --confirmConfirms the removal of event actions that are used by an event-action plan.

Tip: This is equivalent to a forced removal.

-e | -eventfilter {filter_oid |filter_name[filter_oid, | filter_name...]}Targets one or more event filters, specified by name or ID. This list can be amixture of event filter names and ID, separated by a comma.




Tips:

v Event-filter names might not be unique. This command acts on all eventfilters with the specified name. Use the -v | --verbose option to generatea message when this command targets multiple event filters with thesame name. To target an event filter that has a name that is not unique,


identify the event filter by specifying its unique, hexadecimal ID, or useadditional target options to refine the selection.





The input data is the list of event filters to remove. This list can be a mixtureof names and IDs, separated by a comma or end-of-line character.




Tips:





Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: The specified event-filter name or ID is not valid.v 52: A specified event filter cannot be removed.v 53: A specified event filter is used by the event automation plan.

Examples1. Remove an event filter using the filter name

Chapter 1. smcli 101

This example illustrates how to remove an event filter named My CriticalEvents.smcli rmevtfltr "My Critical Events"

2. Remove multiple event filters using the filter IDThis example illustrates how to remove event filters with IDs 0x70, 0x78, and0x79.smcli rmevtfltr 0x70,0x78,0x79

Event log and event action history commandsUse the smcli event commands to generate events and manage the Event log andevent action history, including listing and removing entries.

smcli commands

The following smcli event log and event action history commands are available:

evtacthist commandUse the evtacthist command to manage the event-action history, includingactivating or deactivating the history collection and clearing the log.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] evtacthist options


smcli evtacthist {-h | -? | --help}

smcli evtacthist [-v] {-c entry_list}

smcli evtacthist [-v] {-A | -D | -C} {-f file_name | [-x] action_list}

Description

You must specify the action you want to perform:v -A: Activate the collection of datav -D: Deactivate the collection of datav -C: Clear all the history logsv -c: Clear one or more history logs

Operands

This command uses an action list as an operand. You can optionally precede thelist with the -x | --action option.

Flags


-A | --activateActivates the collection of data about performed event actions.

Note: This option cannot be used with any other options.


-c | --clear {entry_oid}[,entry_oid...]Clears one or more log entries associated with the specified action in theaction-history log. List one or more entry IDs, separated by a comma. The ID isa hexadecimal value prefixed with 0x (for example, 0x37).

Note: You can use the lsevtacthist command to list the log-entry IDs.

-C | --clearallClears all log entries in the action-history log.

-D | --deactivateDeactivates the collection of data about performed event actions.

Note: This option cannot be used with the any other options.



The input data is the list of event actions. This list can be a mixture of namesand IDs, separated by a command or end-of-line character.




Tips:





-x | --action action_oid[,action_oid2,...] | action_name[,action_name2...]Targets one or more event actions, specified by name or ID, to be activated,deactivated or cleared in the log. This list can be a mixture of names and IDs,separated by a comma.





Tips:



event-action names.

Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified event-action name or ID is not valid.v 60: The specified entry ID in the action-history log was not found.

Examples1. Activate the collection of event actions

This example illustrates how to enable the collection of event actions namedE-Mail Admin and with ID 0x26.smcli evtacthist -A "E-Mail Admin",0x26

2. Deactivate an event actionThis example illustrates how to disable an event action with ID 0x26.smcli evtacthist -D 0x26

3. Clear all entries in action-history log for a specific actionThis example illustrates how to clear entries in the action-history log associatedwith an action named E-Mail Admin.smcli evtacthist -C "E-Mail Admin"

4. Clear entries in the action-history for multiple actionsThis example illustrates how to clear entries in the action-history log associatedwith entries IDs 0x11 and 0x013.smcli evtacthist -c 0x11,0x13

evtlog commandUse the evtlog command to manage the size of the event log.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] evtlog options



smcli evtlog {-h | -? | --help}

smcli evtlog [-v] {-m | -M count | -s}

Description

When the maximum size is reached, the oldest entries are no longer stored.

If you set the maximum size to a value smaller than the current size, the oldestentries are no longer stored.

Operands

This command optionally uses a system list as an operand. You can optionallyprecede the list with the -n | --names option.

Flags





Tips:



-m | --maxsizeLists the current setting for the maximum size of event log. The size is definedby the number of entries in the log.

-M | --setmaxsize countChanges the maximum number of log entries to the specified number.

-s | --size countDisplays the current size (number of log entries) of the event log.



Exit status




are not authorized to perform the action.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.

Examples1. List the current maximum size of the event log

This example illustrates how to list the current maximum size of the event log.smcli evtlog -m

2. Set the maximum size of the event logThis example illustrates how to set the maximum size of the event log to 1000entries.smcli evtlog -M 1000

genevent commandUse the genevent command to send a custom event to the event router on themanagement server for testing purposes.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] genevent options


smcli genevent [-h | -? | --help]

smcli genevent [/text:event_description] [/compcat:category_list][/comptype:component_type] {[/compinstance:component_instance] [/mode:mode][/sev:severity] [condtype:condition_type] [/condvalue:condition_value][/MEID:system_oid]}

Description

The genevent command is useful for triggering event automation plans on themanagement server when it is not convenient to do so with agent-initiatedactivities. For example, you can simulate a fan event on the management server toverify that an event automation plan correctly triggers without having to cause anactual fan failure.

Operands

None

Flags

/compcat:category_listSpecifies the system-component category for the event definition. Thecomponent category, type and instance define the total event type.

Tip:

v Use the lsevttype -l command to list the system-component categories.v For existing event filters, use the lsevtfltr -t command to get the

corresponding component category key to use with this option.


/condtype:condition_typeSpecifies the type of condition that triggered the event.

Tip:

v Use the lsevttype -l command to list the condition types.v For existing event filters, use the lsevtfltr -t command to get the

corresponding component type key to use with this option.

/text:event_descriptionSpecifies a text description for the event. If the description contains spaces,enclose it in quotation marks.




Tips:



/compinstance:component_instanceSpecifies the instance (index) of the system-component type when multipleinstances of that type exists on a system (for example, if the system has morethan one fan).

Tip:

v Use the lsevttype -l command to list the system-component instance.v For existing event filters, use the lsevtfltr -t command to get the

corresponding component instance key to use with this option.

/meid:system_oidTargets a system specified by OID.



/mode:{alert | resolution}Specifies the mode of the event. Possible values are:v Alert: A problem has occurred.v Resolution: A problem has been resolved and is no longer a problem.

/comptype:component_typeSpecifies the type of system component that is the focus of the event (forexample, a disk or fan).

Tip:


v Use the lsevttype -l command to list the system-component types.v For existing event filters, use the lsevtfltr -t command to get the

corresponding component type key to use with this option.

/sev:{0 | 1 | 2 | 3 | 4 | 5}Specifies the severity level for the event. Possible values are:v 0: Fatal. The source of the event has already caused the program to fail and

should be resolved before the program is restarted.v 1: Critical. The source of the event might cause program failure and should

be resolved immediately.v 2: Minor. The application that issued the event has assigned a severity level

indicating that the source of the event should not cause immediate programfailure, but should be resolved.

v 3: Warning. The source of the event might not be problematic but warrantsinvestigation.

v 4: Harmless. The event was generated only for informational purposes. Mostevents of this severity do not indicate potential problems.

v 5: Unknown. The application that generated the event did not assign aseverity level; however, these events might indicate potential problems.

/condvalue:condition_valueSpecifies the value that triggered the event.

Exit status


are not authorized to perform the action.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.v 125: The event router is not started.

Examples1. Generate an event

This example illustrates how to simulate a processor failure on the systemnamed system1. The MEID must be the OID of the MEP. The OID must be anumber and not a hexadecimal value.smcli genevent /text:"device processor event" /compcat:Device /comptype:Processor

/compinstance:1 /MEID:15188

Note: Use the lsmeps command to find the OID of the MEP. The OID of theMEP can be found below the resource name of the simulated event.

lsevtacthist commandUse the lsevtacthist command to display entries in the event-action history logthat are associated with a specific event action or system.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsevtacthist options



smcli lsevtacthist {-h | -? | --help}

smcli lsevtacthist [-v] {-i ipaddress | -n system | [-x] action}

Description

Each log entry contains the following data:v Action Name and ID - The name and unique identifier for the event action.v History - The history status, which indicates whether the history is activated or

deactivated. Possible values are active and inactive.v Log ID - The unique identifier for the log entry.v Date: The date and time on which the event was generated.v Action Launch Status - Event action launch status, which indicates whether the

action is launched successfully. Possible values are successful and failed.v Event Type: The type of event that was generated. The event types are

categorized by hardware, device, or software.v Event Category: The mode of the event. Possible categories are:

– Alert: A problem has occurred.– Resolution: A problem has been resolved and is no longer a problem.

v Event Severity: The severity level of the event, which identifies potentiallyurgent problems requiring immediate attention. Possible severities are:– Fatal: The source of the event has already caused the program to fail and

should be resolved before the program is restarted.– Critical: The source of the event might cause program failure and should be

resolved immediately.– Minor: The application that issued the event has assigned a severity level

indicating that the source of the event should not cause immediate programfailure, but should be resolved.



– Unknown: The application that generated the event did not assign a severitylevel.

v Event Sender: The system that sent the event to IBM Systems Director Server.For example, SNMP events list the IP address of the trap source. Because mostevents are generated by IBM Systems Director Server, this field usually containsthe name of the management server.

v Resource Name: Target system on which the event occurred.v Action Completion Status - Event action completion status, which indicates

whether the action is run successfully. Possible values are successful, failed,and not performed.The not performed status is specific to three event actions: modify an event andsend it, start a program on a system, and start a task on a specified system. Ifyou do not configure any modifications to make to an incoming event, the eventis not resent and the event action status is considered not performed. For thelatter two events, if the specified system cannot be found when the event actionis invoked, then the action cannot be performed.

v Action Completion Date - The date and time when the event action completed.

Operands

This command uses an event action name or ID as an operand. You can optionallyprecede the name or ID with the -x | --action option.


Flags





Tips:



-i | --ipaddress {ip_address | host_name}Targets a system, specified by IP address or host name.

Tip: You can use the IPv6 format to specify the IP address.


Tips:




Tips:




-n | --names {system_oid | system_name}Targets the event-action-history entries of the specified system, identified byname or ID.





Tips:





-a | --action {action_name | action_oid}Targets an event action, specified by name or ID.




Tips:



event-action names.

Exit status

The following codes are returned by this commandv 0: The operation completed.v 1: A usage error occurred.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you

are not authorized to perform the action.v 20: A specified system is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified event-action name or ID is not valid.

Examples1. List the action history of an action


This example illustrates how to list the event-action-history entries for theaction named "Add to the event log".smcli lsevtacthist "Add to the event log"

Action Name: Add to the Event Log, ID: 0x10History: activated

Log ID: 0x10, Date: Wed Mar 21 18:27:12 EDT 2007Action Launch Status: SuccessfulEvent Type: family.usms.zero.one.twoEvent Category: AlertEvent Severity: CriticalEvent Sender: serverResource Name: MySystem, ID: 0x17Action Completion Status: Successful, Date: Wed Mar 21 18:27:12 EDT 2007

Log ID: 0x11, Date: Wed Mar 21 18:28:57 EDT 2007Action Launch Status: SuccessfulEvent Type: family.usms.zero.one.twoEvent Category: AlertEvent Severity: CriticalEvent Sender: serverResource Name: MySystem, ID: 0x17Action Completion Status: Successful, Date: Wed Mar 21 18:28:57 EDT 2007

2. List the action history of a systemThis example illustrates how to list the event-action-history entries for thesystem with ID 0x56.smcli lsevtacthist -n 0x56

Action Name: Run application to switch to backup Fan, ID: 0x66History: activated

Log ID: 0x10, Date: Wed Mar 31 18:27:12 EDT 2007Action Launch Status: SuccessfulEvent Type: family.usms.fan.overheat.Event Category: AlertEvent Severity: CriticalEvent Sender: serverResource Name: System1, ID: 0x56Action Completion Status: Successful, Date: Wed Mar 31 18:27:15 EDT 2007

Action Name: eMail admin, ID: 0x98History: enabled

Log ID: 0x10, Date: Wed Mar 21 18:27:12 EDT 2007Action Launch Status: SuccessfulEvent Type: family.usms.server.offline.Event Category: AlertEvent Severity: WarningEvent Sender: serverResource Name: System1, ID: 0x56Action Completion Status: Successful, Date: Wed Mar 21 18:27:22 EDT 2007

lsevtlog commandUse the lsevtlog command to list the contents of the event log (the events thathave occurred).

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsevtlog options



smcli lsevtlog {-h | -? | --help}

smcli lsevtlog [-v] [-e event_filter] [-T hours] [-o | -p | -s ] [-l] [-tsystem_type | -f file_name | -w query | -i ip_address_list -E entry_list |[-n] system_list]

Description

If no options are specified, this command lists all events that have occurred in thepast 24 hours.

If no system is specified, this command lists information about all events that havebeen recorded on the management server, including the date and time of the event,event text, source of the event, event type (which contains information about thecomponent category, component type, component instance, condition type, andcondition value), event severity, and event category.

If the -s | --summary option is specified, this command displays a summary ofevent types that have occurred and on which system they occurred.

If the -l | --long or -s | --summary option is not specified, this commanddisplays summarized information by default.

Operands

This command uses a system list as an operand. You can optionally precede the listwith the -n | --names option.

Flags


-e | --eventfilter {filter_oid | filter_name}Lists the log entries that match the event filter, specified by name or ID.




Tips:





-E | --eventlog {entry_oid}[,{entry_oid }...]Lists one or more event-log entries, identified by their unique IDs, separatedby commas.

Tips:

v The unique ID of the event-log entry must be specified as a hexadecimalvalue prefixed with 0x (for example, 0x37).

v You can use the -o option to list the event-log entry IDs.



The input data is the list of system. This list can be a mixture of names andIDs, separated by a comma or end-of-line character.

Tip: You can use the lsevtlog -p with other options to get the desiredlong-entry IDs and pipe them into another command. For example, to removelog entries with informational events:smcli lsevtlog -e "Informational Events" -p | smcli rmevtlog -f -




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Display the events that have occurred on the specified systems, specified by IPaddress or host name. The list can be a mixture of IP addresses and hostnames, separated by a comma.


Tips:





Tips:




-l | --longDisplays detailed information about the event log.

This option returns these attributes for each event log entry:v Date: The date and time on which the event was generated.v Resource Name: Target system on which the event occurred.v Event Type: The type of event that was generated. The event types are

categorized by hardware, device, or software.v Component Category: The system-component category for the event

definition. The component category, type and instance define the total eventtype.

v Component Type: The type of system component that is the focus of theevent (for example, a disk or fan).

v Component Instance: The index of the system-component type whenmultiple instances of that type exists in on a system, for example, if thesystem has more than one fan.

v Event Category: The mode of the event. Possible categories are:– Alert: A problem has occurred.– Resolution: A problem has been resolved and is no longer a problem.


should be resolved before the program is restarted.– Critical: The source of the event might cause program failure and should

be resolved immediately.– Minor: The application that issued the event has assigned a severity level

indicating that the source of the event should not cause immediateprogram failure, but should be resolved.




v Event Sender: The system that sent the event to IBM Systems DirectorServer. For example, SNMP events list the IP address of the trap source.Because most events are generated by IBM Systems Director Server, this fieldusually contains the name of the management server.


v Family: The equivalent IBM Director version 5.20 component category forthe event definition. The family plus the qualifiers define the total eventtype.

v Qualifiers: The equivalent IBM Director version 5.20 qualifiers for the eventdefinition. The family plus the qualifiers define the total event type.

v Text: The cause of the event. In some cases, such as SNMP traps, not text isavailable.

v Condition Type: The type of condition that triggered the event.v Condition Value: The value that triggered the event.v Details: Additional information about the event. This information varies

depending on the type of event that occurred.

-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Display the events that have occurred on the specified systems, identified byname or ID. The list can be a mixture of system names and ID, separated by acomma.




Tips:



-o | -oidDisplays the unique IDs associated with the event-log entries in addition toother information. IDs are displayed as hexadecimal values, prefixed with 0x(for example, 0x3e).


-p | --pipeDisplays the unique IDs for the event-log entries instead of the name. IDs aredisplayed as hexadecimal values, prefixed with 0x (for example, 0x35).

Tip:



-s | --summaryDisplays summarized information about the event log, including:v Resource Name: Target system on which the event occurred.


v Event Type: The type of event that was generated. The event types arecategorized by hardware, device, or software.


should be resolved before the program is restarted.– Critical: The source of the event might cause program failure and should

be resolved immediately.– Minor: The application that issued the event has assigned a severity level

indicating that the source of the event should not cause immediateprogram failure, but should be resolved.







Tips:




-T | --time hoursLists the events that have occurred within the number of hours specified.

Tip: The number specified must be a nonnegative integer. Decimals andfractions are not supported.







Tips:




Exit status


are not authorized to perform the action.v 20: A specified system is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: The specified event-filter name or ID is not valid.v 51: The specified time is not valid.v 60: The specified event-log ID is not valid.

Examples1. List all fatal events that occurred in the previous 8 hours

This example illustrates how to list all fatal events that occurred in the previous8 hours.smcli lsevtlog -e "Critical Events" -T 8

8/21/07 5:07 PM, CPU usage critical, CS192.168.0.101(0x6A),Director.usms.cpu.usage, Critical-Alert8/21/07 6:08 PM, Memory usage critical, CS192.168.0.101(0x6A),Director.usms.memory.usage, Critical-Alert8/21/07 7:08 PM, Memory usage critical, CS9.56.145.171(0x68),Director.usms.memory.usage, Critical-Alert8/21/07 7:28 PM, CPU usage critical, WEBSRV1(0x69), Director.usms.cpu.usage,Critical-Alert8/21/07 8:08 PM, Memory usage critical, WEBSRV1(0x69),Director.usms.memory.usage, Critical-Alert

2. List all event types that have been recordedThis example illustrates how to list all events that have been recorded in theevent log in the past 24 hours.smcli lsevtlog -o

8/21/07 5:07 PM, CPU usage warning, CS192.168.0.101(0x6A),Director.usms.cpu.usage, Warning-Alert, 0x208/21/07 6:08 PM, Memory usage critical, CS192.168.0.101(0x6A),Director.usms.memory.usage, Critical-Alert, 0x228/21/07 7:08 PM, Memory usage critical, CS9.56.145.171(0x68),Director.usms.memory.usage, Critical-Alert, 0x238/21/07 7:28 PM, CPU usage warning, WEBSRV1(0x69),Director.usms.cpu.usage, Warning-Alert, 0x248/21/07 8:08 PM, System: WEBSRV1 is offline, WEBSRV1(0x69),Director.usms.topology.offline, Harmless-Alert , 0x258/21/07 9:08 PM, Memory usage critical, CS9.56.145.171(0x68),Director.usms.memory.usage, Critical-Alert, 0x268/21/07 9:28 PM, CPU usage warning, WEBSRV1(0x69),


Director.usms.cpu.usage, Warning-Alert, 0x278/21/07 10:08 PM, Memory usage critical, WEBSRV1(0x69),Director.usms.memory.usage, Critical-Alert, 0x28

3. List detailed information about all events that occurred on a system within thelast hourThis example illustrates how to list detailed information about all events thatoccurred within the last hour on the system with ID 0x32f.smcli lsevtlog -olT 1 0x32f

8/21/07 5:07 PM, User ’MySystemme’ () logged off server from’xxxxx.mycompany.com’, MySystem(0x32f), Director.Console.User.Logoff,Informational-Alert, ID: 0x20Event Type:Director.Console.User.LogoffComponent Category (0):Director.ConsoleComponent Category (1):UserComponent Type: LogoffComponent Instance:Family: DirectorQualifier (0): ConsoleQualifier (1): UserQualifier (2): Logoff Date:8/21/0707 4:20:55 PM ESTText: User ’MySystemme’ () logged off server from ’xxxxx.mycompany.com’System: MySystem, ID:0x32fSeverity: InformationalCategory: AlertSender: MySystemCondition Type: User activeCondition Value: falseDetails:

8/21/07 5:07 PM, Monitor ’CPU’ High Warning: ’CPU Utilization’ has beenabove or equal to 80 for 0:05:00. Value reported is 100, nMySystem(0x32f),Director.CPUMonitors.Utilization, Warning-Alert, ID: 0x40Event Type:Director.CPUMonitors.UtilizationComponent Category (0):DirectorComponent Category (1):CPUMonitorComponent Type: UtilizationComponent Instance:Family: DirectorQualifier (0): CPUMonitorsQualifier (1): UtilizationDate: December 14, 2006 4:04:56 PM ESTEText: Monitor ’CPU’ High Warning: ’CPU Utilization’ has been aboveor equal to 80 for 0:05:00. Value reported is 100System: MySystem, ID:0x23fSeverity: WarningCategory: AlertSender: MySystemCondition Type: Utilization AlertCondition Value: 80Details:

CPU Utilization=90.

4. List summarized information about all events that occurred within the last 24hoursThis example illustrates how to list summarized information about all eventsthat occurred within the last 24 hours.smcli lsevtlog -s

System1Warning:Director.Director Agent.CPU Monitors.CPU Utilization.High Warning: 3

Informational:Director.Topology.Offline: 5


Director.Topology.Online: 8

System2Informational:Director.Topology.Offline: 3Director.Topology.Online: 8

rmevtlog commandUse the rmevtlog command to remove entries from the event log.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmevtlog options


smcli rmevtlog {-h | -? | --help}

smcli rmevtlog [-v] {-a | -f file_name | [-e] entry_list}

Description

None

Operands

This command uses a list of even-log entry IDs as an operand. You can optionallyprecede the list with the -e | --eventlog option.

Flags


-a | --allClears all entries in the event log.

-e | --eventlog {entry_oid}[,{entry_oid}...]Clears one or more event-log entries, identified by their unique IDs, separatedby commas.

Tips:

v The unique ID of the event-log entry must be specified as a hexadecimalvalue prefixed with 0x (for example, 0x37).

v You can use the lsevtlog command to list the event-log entry IDs.



The input data is the list of event-log entry IDs, separated by a comma orend-of-line character.





Tips:



-T | --time hoursLists the events that have occurred within the number of hours specified.



Exit status


are not authorized to perform the action.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: The specified event-log entry ID is not valid.

Examples1. Remove multiple event-log entries

This example illustrates how to remove entries with IDs 0x13 and 0x14 fromthe event log.smcli rmevtlog -e 0x13,0x14

2. Remove a event-log entries based on specific criteriaThis example illustrates how to remove all entries for events that occurred inthe last 3 hours from the event log.smcli lsevtlog -T 3 -p | smcli rmevtlog -f -

3. Clear the event logThis example illustrates how to remove all entries in the event log.smcli rmevtlog -a

Group commandsUse the commands in this section to work with IBM Systems Director systemgroups.


dircli commands

Using the new smcli group commands is recommended; however, the dircligroup commands listed in the following table are supported in this release forcompatibility with IBM Director version 5.20. Note that not all command optionsare supported in this release. For information about the dircli commands, see thecommands reference in the IBM Director version 5.20 information center atpublib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_managed_object_commands.html.

Important:

v The dircli commands must be entered in lower case.v To use a dircli command with the same name as an smcli command, you must



dircli command Description and supported syntax Equivalent smcli command

chgp Changes group attributes

Syntax:

chgp {-e member_list group | -r member_list group |-m new_group_name group | -f file_name}

chgp

lsgp Lists group attributes information

Syntax:

lsgp [-d delimiter] [-o | -p] [-A attribute_list[-s] | -F | -l] [-f file_name | -n system_list |[-N] group_list]

lsgp

mkgp Creates a dynamic or static group

Syntax:

mkgp {-f file_name}

mkgp [-T task_list | -D group_criteria | -nsystem_list | -N group_list]new_group_name

mkgp

rmgp Deletes a group

Syntax:

mkmo [-f file_name | -N group_list

rmgp

smcli commands

The following smcli group commands are available:

chgp commandUse the chgp command to modify groups, including changing membership,modifying attributes, and processing change-specification files.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chgp options





smcli chgp [-h | -? | --help]

smcli chgp [-v] {-f file_name}

smcli chgp [-v] {-e extend_list | -r remove_list | -m new_name |-D "new_criteria"} {group_name | group_oid}

Description

Important: The syntax or output for this command has changed since IBMDirector version 5.20. You can use the IBM Director version 5.20 command syntaxand output by setting the CLILEGACY environment variable to 1. For moreinformation about these commands, see the commands reference in the IBMDirector version 5.20 information center at publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_managed_object_group_commands.html.

Operands

This command uses a group name or ID as an operand. This operand is required ifyou do not specify a group-definition file using the -f | --file option.

The group name (group_name) or ID (group_oid) identifies the group beingmodified.

group_oidThe unique ID of the group, specified as a hexadecimal value prefixed with 0x(for example, 0x3e7).


group_nameThe name of the group. If the group name contains spaces, enclose it inquotation marks. If it contains a comma, prefix the comma with a backslash (\)and enclose the name in quotation marks.

Tips:


Flags


-D | --dynamic "group_criteria"Changes the criteria of a dynamic group to the specified criteria.

The group_criteria statement uses the form of one or more inventory-valuecomparison statements joined by Boolean operators. Use parentheses to specifythe order of comparison operations and to combine logical operations.You can specify these comparison operators:


http://publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_managed_object_group_commands.html



v =v ==v !=v >v <v >=v <=

You can specify these Boolean operators:AND to indicate that all group criteria are metOR to indicate that any of the group criteria are met

Tip: Use the lsinv command with no options to list the inventory values thatcan be used for comparison.

-e | --extend {group_member}[,{group_member}... ]Adds one or more resources (including systems, groups, updates, or tasks) asmembers of the group.

The group members can be specified by name, ID, or ID string. This list can bea mixture of names, IDs, and ID strings, separated by a comma.




Tips:






Tips:








Tips:




update_oidSpecifies the unique ID of an update, specified as a hexadecimal valueprefixed with 0x (for example, 0x37).

Tip: Use the lsupd -o command to list all update IDs.

update_fix_idSpecifies the unique fix ID of an update (for example, SF99001G-47).

Tip: Use lsupd -A DisplayName,UpdateId to list the current fix IDs.



The input data is the list of groups to modify. There can be one groupdefinition per line. Each group definition in the input file must be separated bya line break. The group definition must use one of these formats, depending onthe type of group being created:


{group_name|group_oid}:criteria:"group_criteria"{group_name|group_oid}:extend:{member_oid|member_name}[,{member_oid|member_name}...]{group_name|group_oid}:remove:{member_oid|member_name}[,{member_oid|member_name}...]{group_name|group_oid}:move:new_name

For a description of the arguments, see the -D | --dynamic, -e | --extend, -m| --move, and -r | --remove options.




Tips:



-m | --move new_group_name {group_oid | group_name}Renames the group specified by group_oid or group_name to a new namespecified by new_group_name.




Tips:


-r | --remove {group_member}[,group_member}...]Removes one or more resources (including systems, groups, updates or tasks),specified by name, ID, or ID string, from the group.

For a description of the arguments, see the -e | --extend option.



Exit status

The following codes are returned by this command.v 0: The operation completed.


v 1: A usage error occurred.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you

are not authorized to perform the action.v 23: A specified resource (for example, a system, group, update or task) is not

valid.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 50: A specified group is read-only.v 52: The inventory criteria for the dynamic group were not valid.

Examples1. Remove a system from a group

This example illustrates how to remove a single system named WebServer1from the static group named WebSystems.smcli chgp -r WebServer1 WebSystems

2. Rename a groupThis example illustrates how to rename RemoteGroup to RemoteTaskGroup.smcli chgp -m RemoteTaskGroup RemoteGroup

3. Change criteria of a dynamic groupThis example illustrates how to set the criteria for group dynamicgroup1 to allservers that have a license.smcli chgp -D "Server.HasLicense == ’true’" dynamicgroup1

4. Use an input file to modify several groupsThis example illustrates how to modify four groups using the data contained inthe file c:\temp\modify_groups.txt.smcli chgp -f c:\temp\modify_groups.txt

The modify_groups.txt file contains the following text:group1:extend:system_1,system_20x300A:extend:group_1,group_2group2:remove:system_1,system_5group3:criteria:"Server.HasLicense == ’false’"OldName:move:NewName

5. Add tasks and groups to an existing groupThis example illustrates how to add a task named RemoteControl and groupnamed ServerGroup to the static group named RemoteGroup.smcli chgp -e "RemoteControl","ServerGroup" RemoteGroup

lsgp commandUse the lsgp command to list the groups that are currently defined in IBM SystemsDirector.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsgp options


smcli lsgp [-h | -? | --help]


smcli lsgp [-v] [-d delimiter] [-o | -p] [-A attribute_list [-s] | -F | -l][-m member_type] [-f file_name | -i ip_address_list | -n system_list | [-N]group_list]

Description


If no groups are specified using the command line option or operand, then thelsgp command lists all defined groups. If no display options are specified, thenonly the group name is displayed.

Note: The group attribute description and value strings are available only inEnglish. They are not locale specific.

Operands

This command uses a list of groups as an operand. The list can optionally bepreceded by the -N | --groups option.

Flags


-A | --attribute key[,key ... ]Displays values for one or more specified attributes, where key is the attributekey.

Tips:v Separate the keys with commas.v The attributes and attribute values are not locale specific.v You can use the lssys -l command to list all attributes associated with the

targeted groups.

You can specify any of the following keys.


DisplayName string Name of the group.

Description string Descriptive information about the group.

ObjectType string Type of resource. For example, the value is Groupfor group resources.

ReadOnly boolean Flag identifying whether the group is read-only.Valid values are true (read-only) or false (can beedited).

Hidden boolean Flag identifying whether the group is hiddenfrom the user. Valid values are true (not visible tothe user) or false (visible to the user).






Temporary boolean Flag identifying whether the group is temporary.Valid values are true (temporary) or false(persistent).

Dynamic boolean Flag identifying whether the group is a dynamicgroup (based on a criteria). Valid values are true(dynamic group) or false (static group).

Root boolean Flag identifying whether the group is a rootgroup. Valid values are true (root group) or false(not a root group).

ParentCount integer Number of parents that the specified group has.

GroupMembers string Members of the group.

Definition string For dynamic groups, this value is a list of criteriafor the targeted group. For static groups, thisvalue is a list of all systems that belong to thegroup, which is the same as the GroupMembersattribute.



Tip: If the delimiter contains spaces, enclose it in quotation marks.

The behavior of this option depends on the use of other options in thecommand, as shown below.v If you specify this option without the -A | --attribute option, this command

separates data fields in a record by a comma followed by a space. Datarecords are separated by the specified delimiter symbol.

v If you specify this option with the -A | --attribute option, this commandseparates data fields in a record by the specified delimiter symbol. Datarecords are separated by a line break.

v If you specify this option with the -F | --format or -l | --long option, thedelimiter option is ignored.



The input data is the list of groups to be listed. Specify the groups using eithergroup names or group IDs, separated by commas or line breaks.

-F | --formatDisplays the output in a format suitable for redirecting into a group-definitionfile, which can be used as input to the mkgp -f command. You can use thisoption to save the definition of one or more groups so they can be restored ata later time.

The file format isname:type:definition


Where:

name The group name.

type The type of group. Valid values are dynamic or static.

definitionFor static groups, this value is a list of all systems that belong to thegroup. For dynamic groups, this value is criteria for the targetedgroup.




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Targets one or more groups that contain the specified systems, identified by IPaddress or host name. This list can be a mixture of IP addresses and hostnames, separated by a comma.


Tips:




Tips:




-l | --longDisplays detailed information about the listed groups, including all of thegroup attributes.


For a list and description of these attributes, see the -A | --attribute option.

Tips:

v The attributes and attribute values are only in English. They are not localespecific.

v Using this option does not display hidden properties. To display hiddenattributes, use the lsgp -A command.

-m | --membertype member_typeFilters the groups based on the specified member type.

Tip: Use the lsgp -l command to list all member types in the existing groups.

-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Targets one or more groups that contain the specified systems, identified byname or ID. The list can be a mixture of system names and IDs, separated by acomma.




Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Targets one or more specified groups, identified name or ID. The list can be amixture of group names and IDs, separated by a comma.




Tips:



Tip: To display the group unique ID, use the lsgp -o command.

-o | --oid

Displays the unique IDs associated with the targeted groups in addition toother information. IDs are displayed as hexadecimal values, prefixed with 0x(for example, 0x3e).

Tips: Tips:v This option cannot be used with the -p | --pipe option.v You can combine this option with the -l | --long and -A | --attribute

options.

-p | --pipe

Displays only the unique IDs for the targeted groups instead of the name. IDsare displayed as hexadecimal values, prefixed with 0x (for example, 0x37).

Tips:


v This option cannot be used with the -o | --oid options.v You can combine this option with the -l | --long and -A | --attribute

options.

-s | --sortSorts the output by the first specified attribute.

Tip: If you specify this option, you must also specify the -A | --attributeoption. Otherwise, this option is ignored.



Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.

Examples1. List the names of all groups

This example illustrates how to list the names of all IBM Systems Directorgroups.smcli lsgp

2. List the names and IDs of all groups


This example illustrates how to list the names and IDs of all system groupsdefined in IBM Systems Director.smcli lsgp -o

3. List the attributes for groups specified by nameThis example illustrates how to list the all attributes for the Racks with Membersand MyRackGroup groups.smcli lsgp -l -N “Racks with Members”,MyRackGroup

4. List the attributes for groups specified in a fileThis example illustrates how to list the all attributes of system groups in the/tmp/groups file.smcli lsgp -lf /tmp/groups

5. List the groups to which a system belongsThis example illustrates how to list the groups to which the system mySystembelongs.smcli lsgp -n mySystem

6. List the groups that contain systems with specific IP addressesThis example illustrates how to list the union of groups that contain systemwith IP address 9.182.149.115 and 9.182.149.134.smcli lsgp -i 9.182.149.115, 9.182.149.134

7. List members of a groupThis example illustrates how to lists the members of group MyRackGroup.smcli lsgp -N MyRackGroup -A GroupMembers

mkgp commandUse the mkgp command to create static and dynamic groups.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkgp options


smcli mkgp [-h | -? | --help]

smcli mkgp [-v] [-m member_type] [-d description] {-f file_name | {-smember_list | -D "criteria" {-r resource_type}} new_group_name

Description


Static groups are comprised of a specific set of resources, such as systems, othergroups, tasks, and updates. Dynamic groups are comprised of resources that matchspecific criteria. Resources can be members of one or more groups.





By default, you can delete and rename groups that are created using mkgpcommand. The IsDeleteable and IsRenameable group attributes are set to true.After the group is created, you cannot change these attributes.

The following options are supported only for compatibility with IBM Directorversion 5.20 and earlier. Using these option is not recommended.v -n | --names system_listv -N | --groups group_listv -T | --tasks task_list

Operands

This command uses a new group name as an operand. The new_group_namespecifies the name of the group being created. This operand is required if you donot specify a group-definition file using the -f | --file option.

Tips:v Group names must be unique.v Group names are not locale specific.

Flags


-d | --description "description"Specifies descriptive text for the group that is created. If the descriptioncontains spaces, enclose the description in quotation marks.

-D | --dynamic "group_criteria"Creates a dynamic group that is comprised of systems, groups or tasks thatmatch the specified criteria.

The group_criteria statement uses the form of one or more inventory-valuecomparison statements joined by Boolean operators. Use parentheses to specifythe order of comparison operations and to combine logical operations.

You can specify these comparison operators:v =v ==v !=v >v <v >=v <=

You can specify these Boolean operators:AND to indicate that all group criteria are metOR to indicate that any of the group criteria are met

Tips:

v Use the lsinv command with no options to list the inventory values that canbe used for comparison.

v If you specify this option, you must also specify the -r | --resourcetypeoption.




The input data is the list of group members or criteria. There can be one groupdefinition per line. Each group definition in the input file must be separated bya line break. The group definition must use one of these formats, depending onthe type of group being created:new_group_name:static:{system_oid|system_name}[,{system_oid|system_name}...]:member_type

new_group_name:dynamic:"group_criteria":member_type:resource_type

where the operands are as follows:

member_typeThe type of members in the group. This operand is optional for both staticand dynamic group types.

resource_typeThe type of resource for the criteria that is used to create a dynamic group.This operand should be used only with option -D.

Tips:

v For a description of the operands, see the -D | --dynamic and -s | --staticoptions.

v For static groups, specifying the member type is optional.v For dynamic groups, specifying the member type is optional. Specifying the

resource type is required.




Tips:



-m | --membertype member_typeFilters the groups based on the specified member type.

Tip: Use the lsgp -l command to list all member types in the existing groups.

-r | --resourcetype resource_typeSpecifies the type of resource to use for the criteria for creating dynamicgroups.


Tip: You must specify this option when you create dynamic groups using the-D | --dynamic option.

You can specify one of these resource types:v Systemv ComputerSystemv OperatingSystemv Groupv SoftwareModulev SoftwarePatch

-s | --static {group_member}[,{group_member}...]

Creates a static group comprised of one or more resources (such as systems,groups, tasks, or updates). This list can be a mixture of names or ID separatedby a comma.

The group_member can be any of these names and IDs:




Tips:






Tips:








Tips:










Exit status


are not authorized to perform the action.v 10: The file was not found.v 23: A specified resource (for example, a system, group, update or task) is not

valid.v 25: A number-formatting error occurred.


v 29: The specified locale is not valid or not supported.v 50: The format of the specified group-definition is not valid.v 51: No valid group definitions were specified.v 52: The inventory criteria for the dynamic group were not valid.

Examples1. Create a static group of systems specified by ID

This example illustrates how to create a static group (NewGroup) that containstwo systems.smcli mkgp -s node1,node2 NewGroup

2. Create a static group of tasks specified by nameThis example illustrates how to create a static group named CIM that supportsthe CIM Browser task.smcli mkgp -s "CIM Browser" CIM

3. Create an dynamic group of updatesThis example illustrates how to create a dynamic update group, namedupdategrp, of all critical updates on systems.smcli mkgp -D "SoftwarePatch.Severity=0" -r Systemupdategrp

4. Create multiple groups using a file for inputThis example illustrates how to use data in the c:\temp\MyNewGroup.txt file tocreate two groups, one static and one dynamic.smcli mkgp -f c:\temp\MyNewGroup.txt

The c:\temp\MyNewGroup.txt file contains the following definitions:group1:static: me_1,me_2,me_3group2:dynamic:" Server.HasLicense ==’true’ OR System.Name ==’mysystem’"::System

5. Create a dynamic groupThis example illustrates how to create a dynamic group using a criteria list.smcli mkgp -D "(HasLicense==’true’) OR (Name==’mypc’)"-r System dynamicgp1

rmgp commandUse the rmgp command to delete one or more system groups.

Note: You cannot delete groups that have been predefined by IBM SystemsDirector. These predefined groups have the IsDeleteable attribute set to false. Youcan use the lsgp -A IsDeleteable command to list the predefined groups.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmgp options


smcli rmgp [-h | -? | --help]

smcli rmgp [-v] {-f file_name | [-N] group_list}

Description

Important: The syntax or output for this command has changed since IBMDirector version 5.20. You can use the IBM Director version 5.20 command syntax


and output by setting the CLILEGACY environment variable to 1. For moreinformation about these commands, see the commands reference in the IBMDirector version 5.20 information center at publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_managed_object_group_commands.html.

Operands

This command uses a list of groups as an operand. The list can optionally bepreceded by the -N | --groups option.

Flags




The input data is the list of groups to be deleted. This list can be a mixture ofgroup names and IDs, separated by commas or line breaks.




Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Targets one or more specified groups, identified name or ID. The list can be amixture of group names and IDs, separated by a comma.









Tips:


Tip: To display the group unique ID, use the lsgp -o command.



Exit status


are not authorized to perform the action.v 10: The file was not found.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 52: A group cannot be deleted.

Examples1. Delete multiple groups using the group name

This example illustrates how to delete the two groups named ID systems andTest systems.smcli rmgp "ID systems","Test systems"

2. Delete a group using a definition fileThis example illustrates how to use the data in the c:\temp\MyOldGroup.txt fileto delete several groups.smcli rmgp -f c:\temp\MyOldGroup.txt

The c:\temp\MyOldGroup.txt file contains the following names."ID systems","Test systems"

Process monitor commandsUse the commands in this section to manage processes and process monitors.

smcli commands

The following smcli process monitor commands are available:

lsps commandUse the lsps command to list the processes that are available on the specifiedsystem.


Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsps options


smcli lsps [-h | -? | --help]

smcli lsps [-v] {-T process_type} {-i ip_address | -n system} [-Aattribute_list | -l] [-f file_name | [-p] process_list

Description

Processes are specific to particular process type. This command takes a processtype and system name as required options to list specific types of processes.

If you do not specify a display option (-l | --long or -A | --attribute), thiscommand lists all processes of the specified type.

Operands

This command uses a list of processes as an operand. The list can optionally bepreceded by the -p | --process option.

Flags


-A | --attribute key[,key ... ]Displays values for one or more specified process attributes, where key is theattribute key. The keys are separated with commas.

You can specify the following attribute keys, depending on the specifiedprocess type:


Name string Name of the application, service, or device-service

ProcessID long (Applications only) Process identifier of theapplication

User string (Applications only) Name of the user running theapplication

ThreadCount integer (Applications only) Application thread count

Priority integer (Applications only) Application priority

MemoryUsage long (Applications only) Application memory usage

CPUTime string (Applications only) Processor time

Monitored boolean (Applications only) Flag indicating whether theprocess is monitored. Possible values are true ifthe process is monitored and false if the processis not monitored.

ServiceStatus string (Services and device services only) Status of theservice or device service

Description string (Services only) Description of the service




The input data is the list of processes names, separated by commas or linebreaks.




Tips:



-i | --ipaddress {ip_address | host_name}Lists processes that are available on a system, specified by IP address or hostname.


Tips:




Tips:





-l | --longDisplays detailed information about the targeted processes or targeted processtype. If a process type is targeted, information is displayed for all processes ofthat type.

See the -A | --attribute option for a list of attributes that are displayed. Thelist is different for each process type.

-n | --names {resource_oid | resource_name}Lists processes that are available on a system, specified by name or ID.




Tips:



-p | --process {process_name}[,{-process_name}...]Targets one or more process names, separated by a comma.

Possible values are:v Applicationsv Servicesv DeviceServices

Tips:

v If the processes name contains a space, enclose it in double quotation marks.v Use lsps command with -p | --process and n | --names options to list all

process names specific to particular process-type.

-T | --processtype {process_type}Targets one or more processes of the specified type. You can specify one ofthese types:v Applications: Program applications, which might be interactivev Services: IBM Systems Director services on systemsv DeviceServices: Noninteractive programs with which high-level applications

can perform various functions (for example, I/O drivers running on asystem as support programs for application suites that performword-processing, database, and print functions).




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 50: The specified process type is not valid.v 51: The specified application is not valid.v 52: The specified service is not valid.v 53: The specified device service is not valid.

Examples1. List all applications running on a system

This example illustrates how to list all application processes running on thesystem named system_1.smcli lsps -T Applications -n system_1

2. List detailed information about multiple processesThis example illustrates how to list detailed information about the serviceprocesses listed in the c:\services.txt file and running on the system namedsystem_1.smcli lsps -l -T Services -f c:\services.txt -n system_1

mkpmtask commandUse the mkpmtask command to create a new process-monitor task.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkpmtask options


smcli mkpmtask [-h | -? | --help]

smcli mkpmtask [-v] {-f file_name}

smcli mkpmtask [-v] {-P path [+S | +s] [+E | +e] [+F | +f seconds]}...{task}

Description

This command creates a process-monitor task, but does not start monitoring thespecified process on a system. Use the runtask command to start monitoring aprocess.


Operands

This command uses a process-monitor task as an operand. This command creates aprocess-monitor task with the specified name.

Flags


+E | +eSpecifies that the process-monitor task is to generate an event when it ends.



The input data is the list of process-monitor tasks to create, separated by a linebreak. Specify the data using this format:task_name:"path" [+S | +s] [+E | +e] [+F | +f seconds]

+F | +f secondsSpecifies that the process-monitor task is to generate an event if it does notstart correctly or if it fails after the specified number of seconds.




Tips:



-P | --path pathSpecifies the fully-qualified path and executable file name of the applicationthat you want to monitor.

+S | +sSpecifies that the process-monitor task is to generate an event when it starts.




Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.

Examples1. Create a process-monitor task using an input file

This example illustrates how to create a process-monitor task using an inputfile named tasks.txt.smcli mkpmtask -f tasks.txt

The tasks.txt file might contain this output:"Notepad monitor1":"c:\windows\notepad.exe"+S+F5"Notepad monitor2":"c:\winnt\notepad.exe"

2. Create a process-monitor taskThis example illustrates how to create a process-monitor task named Notepadmonitor that monitors the application located in c:\winnt\notepad.exe andgenerates an event when the monitor is started and if it fails after 5 seconds.Then, it verifies that the task has been created using the lstask command.smcli mkpmtask -P "c:\winnt\notepad.exe" +S +F 5 "Notepad monitor"smcli lstask -l "Notepad monitor"

3. Run a process-monitor taskThis example illustrates how to start the process-monitor task named Notepadmonitor.smcli runtask -n system_1 "Notepad monitor"

rmpmtask commandUse the rmpmtask command to delete a process-monitor task.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmpmtask options


smcli rmpmtask [-h | -? | --help]

smcli rmpmtask [-v] {-f file_name | [-T] task_list}

Description

None

Operands

This command uses a list of process-monitor tasks as an operand. The list canoptionally be preceded by the -T | --tasks option.


Flags




The input data is the list of process-monitor tasks to be deleted, separated by acomma or line break.




Tips:




Removes one or more process-monitor tasks, specified by title, unique ID or IDstring. The list can be a mixture of titles, IDs and ID strings, separated by acomma. The list is delimited by the end-of-line character when read from a file.





task_titleThe title of the task. The task title must be fully qualified with the parenttask (for example, grandparent_task_title/parent_task_title/task_title). If the


task name contains a comma, prefix the comma with a backslash (\).Enclose the task title in quotation marks if it contains a space character.

Tips:






Exit status


are not authorized to perform the action.v 10: The file was not found.v 22: A specified task is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.

Examples1. Remove a process-monitor task

This example illustrates how to remove a process-monitor task named Notepadmonitor from all systems to which it has been applied.smcli rmpmtask -T "Notepad monitor"

Remote access commandsUse the commands in this section to work with remote systems.

smcli commands

The following smcli commands are available for remote access:

dconsole commandUse the dconsole command to run a remote serial console from the IBM SystemsDirector Server CLI with the purpose of opening the serial console to IBM Power®

managed systems. This command runs on IBM Systems Director Server for AIXV6.1 TL03 or later.


Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] dconsole options


smcli dconsole [-h | -? | --help]

smcli dconsole {-n system_name | -i ipaddress | -N nodegroup_name} [-c |--close ] [-o | --force] [-l | --log] [-r | --read] [-v | --verbose]

Description

The dconsole command opens a console window to one or more PowerArchitecture® blade serverPower Systems compute node or Power Systems virtualserver systems. Each window provides access to the system's serial console,accessed out-of-band. Since the console is displayed in a separate xterm window,the DISPLAY environment variable needs to be set prior to invoking the smclidconsole command.

Specify targets as a comma separated list of individual systems or as a commaseparated list of groups. You can list individual systems using their names, objectIDs, or TCP/IP addresses or host names. Groups are listed using their names. If agroup is listed, the command is executed on all members of that group.

Note: If you run the dconsole command using the IBM Systems Director Webinterface, ensure that the dsm.core file set installed. The server installation does notcheck if dsm.core is installed, but these functions only work if it is. dsm.core isavailable on the product media for AIX 6.1 TL03 or later, and all levels of AIX 7.1.

Flags


-c | --closeForces an existing virtual terminal session to be closed before opening a newsession. This flag is used when another remote system (such as an HMC oranother AIX server running dconsole) has a remote session open to the samemanaged system, causing the system's virtual terminal session to beunavailable.



--helpDisplays detailed information about the command, including the syntax, adescription of the command, and a description of the options and operands,error codes, and examples.

Tips:



v (AIX only) You can also display detailed help in the form of man pagesusing the man command_name command.




Tips:




Tips:




-l | --logEnables console logging (no logging if omitted).

By default, the console logs are written to the /var/ibm/sysmgt/dsm/log/console directory. The location and subdirectory can be changed by overriding"Log_File_Location" and "dconsole_log_File_Subdirectory."

-N | --groups {group_name}[,{group_name}...]Targets all systems in one or more specified groups that are identified byname.

Tips:




Tips:




The list can be a mixture of system names and IDs, separated by a comma.


system_oidThe unique ID of the system, specified as a hexadecimal value prefixedwith 0x (for example, 0x37).



Tips:



-o | --forceForces a new session to be opened as a read-write session. By default, thecommand opens the first session to a specified server as read-write and openssubsequent sessions as read-only. This flag forces the new session to beread-write, and any existing read-write session are changed to read-only.

-r | --readOpens a console as read-only.



Exit status


are not authorized to perform the action.v 200: The command execution failed. The exit value is increased by 1 for each

successive failed attempt to start the console or target that is not valid.

Examples1. Open a remote console to specific managed servers

This command illustrates how to open a remote serial console to managedservers Server1 and Server2.


smcli dconsole –n Server1DisplayName,Server2DisplayName

2. Open a remote console to all managed servers in a groupThis command illustrates how to open a remote serial console to all managedservers in the "AIX/Linux Virtual Servers" group.smcli dconsole –N "AIX/Linux Virtual Servers"

dsh commandUse the dsh command to run Distributed Shell from the IBM Systems DirectorServer CLI with the purpose of running commands on remote systems. Thiscommand applies to IBM Systems Director Server for AIX only.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] dsh options


smcli dsh {-h | -? | --help}

smcli dsh {-n system_name | -i ipaddress | -N nodegroup_name} [-O |--fanout fanout_value] [-m | --format {c|g}] [-o | --output output_path][-l | --log log_file] [-c | --no-locale] [-r | --report report_path] [-e |--report-name report-name] [-Q] [-S csh|ksh] [-M | --timeout seconds] [-v][-V] [-z] command_list

Description

The dsh command runs commands concurrently on remote targets. It issues aremote shell command for each specified target and returns the output from alltargets. The output is formatted so that you can easily manage the commandresults from all targets.

Specify targets as a comma separated list of individual systems or as a commaseparated list of groups. You can list individual systems using their names, objectIDs, or TCP/IP addresses or host names. Groups are listed using their names. If agroup is listed, the command is executed on all members of that group.

Flags


-c | --no-localeSpecifies to not send locale information to the target machine.

-e | --report-nameSpecifies the name to use when generating the report. If not specified, thename defaults to Unspecified. This flag can only be used with the --report flag.





Tips:


v (AIX only) You can also display detailed help in the form of man pagesusing the man command_name command.




Tips:




Tips:




-l | --logEnables logging to the specified log_file. Output is appended to the file eachtime the smcli dsh command runs.

-m | --format c|gSpecifies an output formatting option for system information. One of either thec or g flags must be specified. Without --format, the smcli dsh command willdisplay the output from each managed system as soon as it arrives. Each lineof the output is preceded with the managed system name, OID, or hostname.With --format, the smcli dsh command will wait for all the output from eachmanaged system to arrive before displaying it. The output is displayed asfollows:

c Compresses the output. Collapses identical output from more than onemanaged system so that it is displayed only once.

g Groups the output from each managed system together.


-M | --timeoutSpecifies the time, in seconds, to wait for the output from any commandcurrently running on a remote managed system. If no output is available fromany managed system in the specified timeout, smcli dsh displays an error andterminates the command for the remote managed system that failed torespond. If timeout is not specified, smcli dsh waits indefinitely to continueprocessing output from all remote managed systems.

-N | --groups {group_name}[,{group_name}...]Targets all systems in one or more specified groups that are identified byname.

Tips:




Tips:








Tips:




-O | --fanoutSpecifies a maximum number of target systems on which to run the commandin parallel. Serial execution can be specified by indicating a fanout value of 1.If --fanout is not specified, a default value of 16 is used.

-o | --outputCopies the standard output to output_path/target_name.output and thestandard error to output_path/target_name.error. Output continues to be sentto the standard output and standard error. Use the -Q flag to suppressstandard output and standard error. When used together with the--report-name option, the output is placed into the directory specified by--report-name.

Note: The dsh command sends the dsh request to the server. The output filesand folders are then created by a daemon thread within the IBM SystemsDirector Server Java™ process. Thus, the UID of the IBM Systems DirectorServer Java process (generally the root) is the owner of the output files andfolders created by this option.

-Q | --silentSpecifies silent mode. No remote command output is written to standardoutput or standard error.

-r | --reportEnables report generation and specifies the path to the directory where reportsare saved.

-S | --syntax csh | kshSpecifies the shell syntax to be used. The default flag is ksh.



-V | --versionDisplay DSH command version information.

-z | --exit-statusDisplays exit status of the last remotely run command on each managedsystem. If the command issued on the remote system is run in the background,the exit status is not displayed.

command_list "command[;command;...]"Specifies a list of commands to execute on the remote managed system.Quotation marks around the command are required to ensure that allcommands in the list are executed remotely and that any special characters areinterpreted correctly on the remote managed system.

Exit status

The smcli dsh command exit code is 0 if the command runs without errors and allremote shell commands finished with exit codes of 0. If internal smcli dsh errorsoccur or if the remote shell commands do not complete successfully, the smcli dshcommand exit value is greater than 0. The following codes are returned by thiscommand.v 0: The operation completed.v 1: A usage error occurred.v 2: The command or bundle was not found.



v 200: The command execution failed. The exit value is increased by 1 for eachsuccessive instance of an unsuccessful remote command instance or target that isnot valid.

Examples1. Run a command on managed systems

This example illustrates how to run the date command on managed systemsNode1 and Node2.smcli dsh –n Node1DisplayName,Node2DisplayName "date"

2. Display users on all systems in a groupThis example illustrates how to display the number of users on all managedsystems in the "All Operating Systems" group.smcli dsh –N "All Operating Systems" "who | wc –l"

Resource monitor commandsUse the commands in this section to monitor resources.


smcli commands

The following smcli resource monitor command groups are available.

Resource monitor commandsUse the commands in this section to list and run resource monitors.

smcli commands

The following smcli resource-monitor commands are available:

lsresmon commandUse the lsresmon command to list resource monitors that are available formonitoring systems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsresmon options


smcli lsresmon [-h | -? | --help]

smcli lsresmon [-v] [-l] [-T target_level] [-s order] [-f file_name | -mmonitors_list] {-i ip_address | -n system}

Description

If you do not specify a resource monitor, this command lists all first-level,second-level, and third-level resource monitors by default.


If you do specify a monitor, this command lists the monitor and its submonitorsup to the third level. If you specify a submonitor, this command lists only thesubmonitor and its lower-level submonitors up to the third level.

To change the level of monitors to list, specify the -T | --targetlevel option.

Operands

This command optionally uses a list of resource monitors and a system asoperands. The resource-monitors list can optionally be preceded by the -m |--monitor option.

Flags




The input data must contain the names of one or more valid resourcemonitors, separated by commas or end-of-line characters (for example, [CommonAgent][CPU Monitors],[Common Agent][Disk Monitors]\ or [CommonAgent][CPU Monitors]\ \n [Common Agent][Disk Monitors]\).




Tips:



-i | --ipaddress {ip_address | host_name}

Displays all resource monitors for the system specified by IP address or hostname.


Tips:





Tips:




-l | --longDisplays detailed information about the specified resource monitors and allsubmonitors.

-m | --monitors {monitor_name}[,{monitor_name}...]Lists information about one or more specified monitors and correspondingsubmonitors.

Resource monitors are made up of levels, for example [Common Agent][CPUMonitors][Process Count]. You can specify any top-level resource monitors(for example, [Common Agent]) or lower-level submonitors (for example,[Common Agent][CPU Monitors][Process Count]). If you specify a top-levelmonitor, all lower-level submonitors are also targeted.

Tips:

v You can use the lsresmon command to list resource-monitor names.v The monitor name can be locale specific. The name specified must match the

locale being used by the command line interface.

-n | --names {system_oid | system_name}

Displays all resource monitors for the system, specified by name or ID.




Tips:

v The system names might not be unique. This command acts on allsystems with the specified name. Use the -v | --verbose option togenerate a message when this command targets multiple systems withthe same name. To target a particular system that has a name that is not


unique, identify the system by specifying its unique, hexadecimal ID, oruse additional target options to refine the selection.


-s | --sort {a | d}Sorts the resource monitor names in ascending (a) or descending (d) order.

-T | --targetlevel levelLists the resource monitors and submonitors up to the specified target level.

You must specify the level as a whole number from 1 ton , for example:v 1: First level (for example, [Common Agent])v 2: Second level (for example, [Common Agent][CPU Monitors])v 3: Third level (for example, [Common Agent][CPU Monitors][CPU

Utilization])



Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified resource monitor is not valid.

Examples1. List top-level resource monitors

This example illustrates how to list the top-level resource monitors. Allsystem-defined and user-defined monitors are listed.

Tip: The indented items are the data nodes. The items that are not indented arethe monitor paths.smcli lsresmon -n SYSTEM_A

system1[Common Agent][Windows Performance Monitors]

[Browser][PSched Pipe][System]

[Common Agent][FILE Monitors][C:]

[Common Agent][Windows Device Monitors][Fastfat][ViaIde]

[Common Agent][CPU Monitors][CPU Utilization]


[CPU "0" Utilization][CPU "1" Utilization][Process Count]

...

2. List details of multiple resource monitorsThis example illustrates how to list detailed information about processormonitors and disk monitors.smcli lsresmon -m "[Common Agent][CPU Monitors],[Common Agent][DISK Monitors]" -n SYSTEM_A

system1[Common Agent][CPU Monitors]

[Common Agent][CPU Monitors][CPU Utilization][Common Agent][CPU Monitors][CPU "0" Utilization][Common Agent][CPU Monitors][CPU "1" Utilization][Common Agent][CPU Monitors][Process Count]

[Common Agent][DISK Monitors][Common Agent][DISK Monitors][DISK 0 : Work Load][Common Agent][DISK Monitors][DRIVE C: % Space Used][Common Agent][DISK Monitors][DRIVE C: Space Remaining][Common Agent][DISK Monitors][DRIVE C: Space Used]

3. List resource monitors up to a specific levelThis example illustrates how to list all first, second, third, and fourth-levelresource monitors.smcli lsresmon -T 4 -n SYSTEM_A

4. List specific resource monitors up to a specific levelThis example illustrates how to list all first, second, third, and fourth-level CPUmonitors and disk monitors.smcli lsresmon -m "[Common Agent][CPU Monitors],[Common Agent][DISK Monitors]" -T 4 -n SYSTEM_A

runresmon commandUse the runresmon command to start monitoring one or more resources on systemsand display the monitored values.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] runresmon options


smcli runresmon [-h | -? | --help]

smcli runresmon [-v] [-s order] {-f file_name | -m monitor_list} [ -tsystem_type] {-w query | -i ip_address_list | -N group_list | [-n]system_list}

Description

When a resource monitor is started, this command displays a message thatmonitoring has started and displays the current values. The resource monitorcollects and displays values approximately every 30 seconds until you cancel thecommand. The time might vary based on your platform.

When you cancel this command, monitoring stops. To stop monitoring, typeCtrl+C from the command line session on which this command is running.


Operands

This command uses a list of resource-monitors and targeted system as requiredoperands.

Flags




The input data must contain one or more resource-monitor names, separatedby commas or line breaks.




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Displays resource-monitoring values for one or more systems, specified by IPaddresses or host names. This list can be a mixture of IP addresses and hostnames, separated by a comma.


Tips:





Tips:




-m | --monitors {monitor_name}[,{monitor_name}...]Runs one or more resource monitors.

Resource monitors are made up of levels. The lowest-level submonitor (forexample, [Process Count]) is called the monitor data. Higher-level monitors(for example, [Common Agent] and [Common Agent][CPU Monitors]), are calledmonitor paths. You must specify the full monitor path and data with thiscommand (for example, [Common Agent][CPU Monitors][Process Count]).

Tips:



-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Displays resource-monitoring values for one or more systems, specified byname or ID. This list can be a mixture of names or IDs, separated by a comma.




Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Displays resource-monitoring values for all systems in one or more groups,specified by name or ID. This list can be a mixture of names or IDs, separatedby a comma.

Tips:







Tips:


-s | --sort {a | d}Sorts the resource monitor names in ascending (a) or descending (d) order.

-t | --type system_typeDisplays resource-monitoring values for all systems of the specified type.


Tips:






-w | --where "query"Displays resource-monitoring values for one or more systems based on systemattributes specified by query.



Tips:


quotation marks in the query.v If the value contains spaces, enclose it in single quotation marks.


v Only system attributes can be specified. Use the lssys -l command to listthe available system attributes.

Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 50: A specified resource monitor is not valid.

Examples1. Run multiple resource monitors on multiple systems

This example illustrates how to run CPU-utilization monitors and disk-usagemonitors on systems named system1 and system2.smcli runresmon -m "[Common Agent][CPU Monitors][CPU Utilization],[Common Agent][DISK Monitors][DRIVE C: Space Used]" -n system1,system2

system1:[Common Agent][CPU Monitors][CPU Utilization]: 80%[Common Agent][DISK Monitors][DRIVE C: Space Used](MB): 500

system2:[Common Agent][CPU Monitors][CPU Utilization]: 60%[Common Agent][DISK Monitors][DRIVE C: Space Used](MB): 5000

Resource-monitor recording commandsThe smcli resource-monitor recording commands record, delete, stop, and listresource-monitor recordings.

smcli commands

The following smcli resource-monitor recording commands are available:

lsresmonrec commandUse the lsresmonrec command to list information about previously configuredresource-monitor recordings.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsresmonrec options


smcli lsresmonrec [-h | -? | --help]

smcli lsresmonrec [-v] [-l] [-V] [-S time] [-t system_type] [-w query | -iip_address_list | -N group_list | -n system_list] [-m monitor] [[-r]recording_list


smcli lsresmonrec [-v] [{-F format} {[-r] record_name}]

Description

If a recording name is not specified, this command lists information about allrecordings.

You can view the recorded values using the -V | --view option. You can viewdetails of each recording using the -l | --long option. If you do not specify adisplay option, only record names are listed.

Operands

This command optionally uses a list of recording names as an operand. The listcan optionally be preceded by the -r | --record option.

Tip: If you specify the -F | --format option, you must specify the -r | --recordoption.

Flags


-F | --format {csv | txt | html | xml}Lists recording information in the specified format.




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Displays all recordings for one or more systems, specified by IP address orhost name. The list can be a mixture of IP addresses and host names, separatedby a comma.


Tips:





Tips:




-l | --longDisplays detailed information about the specified recording.

Tip: This option does not display the recorded values. To display recordedvalues, use the -V | --view option.

This option lists these attributes for each recording:v System name: The name of the system on which the recording was made.v Record name: The name of the recording. This name might not be unique.v Attribute: The attribute of the recording.v Start time: The time when the recording was startedv Stop time: The time when the recording was stopped.v Duration: The amount of time in which the recording was completed.

-m | --monitors {monitor_name}Targets the recording that is associated with the specified resource monitor.


Tips:



-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Displays all recordings for one or more systems, specified by name or ID. Thelist can be a mixture of system names and IDs, separated by a comma.




Tips:




-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Displays all recordings for all systems in one ore more specified groups,identified by name or ID. The list can be a mixture of system group names andIDs, separated by a comma.

Tips:






Tips:


-r | --record {recording_name}[,{recording_name}...]

Targets one or more specified recordings, separated by a comma.

Tip:

v If you specify the -V | --view option, you can specify only one recordingname because the output might be very long.

v The recording name is unique for a system or group.v Use lsresmonrec command with no options to list all recording names.v The system names are not locale specific.

-S | --start timeLists recording with that started at the specified time, using the formatyyyy-mm-dd:hh:mm:ss, where:v yyyy: 4-digit yearv mm: Full name of the monthv dd: 2-digit dayv hh: 2-digit hourv mm: 2-digit minutesv ss: 2-digit seconds


-t | --type system_typeDisplays all recordings for all systems of the specified type.


Tips:






-V | --viewDisplays recording values for the specified recordings.

-w | --where "query"Displays all recordings for one or more systems based on system attributesspecified by query.



Tips:




Exit status


are not authorized to perform the action.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified resource monitor is not valid.


v 53: A recording could not be found.

Examples1. List all recording on a system

This example illustrates how to list all the recordings that have been done onthe system name system1.smcli lsresmonrec -n system1

CPUUtilization

2. List detailed information about a recordingThis example illustrates how to list detailed information about the recordingnamed CPUUtilization.smcli lsresmonrec -l -r CPUUtilization

System name = system1Record name = CPUUtilizationAttribute = CPUUtilizationStart time = November 10, 2007 1:04:59 PMStop time = November 10, 2007 1:14:58 PMDuration = 10 minute(s)

3. List recorded valuesThis example illustrates how to lists recorded values of the recording namedCPUUtilization.smcli lsresmonrec -V CPUUtilization

System name = system1Record name = CPUUtilizationAttribute = CPUUtilizationStart time = November 10, 2007 1:04:59 PMStop time = November 10, 2007 1:14:58 PMSampling Rate = 5000 msecs

Recorded valuesDate Time DataNovember 10, 2006 1:05:02 PM 20.6November 10, 2006 1:05:07 PM 19.3November 10, 2006 1:05:12 PM 19.3...November 10, 2006 1:14:57 PM 18.4

4. Export recording a in XML formatThis example illustrates how to export recorded values of the recording namedCPUUtilization into a file named CPUUtilization.xml.smcli lsresmonrec -F xml -r CPUUtilization > CPUUtilization.xml

mkresmonrec commandUse the mkresmonrec command to record resource-monitor values.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkresmonrec options


smcli mkresmonrec [-h | -? | --help]


smcli mkresmonrec [-v] {-d duration} {-m monitor_list} [-t system_type] {-wquery | -i ip_address_list | -N group_list | -n system_list} {[-r]new_record_name}

Description

Values are recorded at a frequency of approximately every 30 seconds. The actualfrequency is determined by the metrics metadata.

Operands

his command uses the name of the new resource-monitor recording as an operand.The recording can optionally be preceded by the -r | --record option.

Flags


-d | --duration durationStops recording after the specified number of minutes.




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Records resource monitors on one or more systems, specified by IP address orhost name. The list can be a mixture of IP addresses and host names, separatedby a comma.


Tips:





Tips:




-m | --monitors {monitor_name}[,{monitor_name}...]Records value for one or more specified resource monitors, separated by acomma.

Resource monitors are made up of levels, for example [Common Agent][CPUMonitors][Process Count]. [Common Agent] is a top-level resource monitors,and [Common Agent][CPU Monitors][Process Count] is a lower-levelsubmonitor. For this command, you must specify a submonitor.

Tips:



-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Records resource monitors on one or more systems, specified by name or ID.The list can be a mixture of system names and IDs, separated by a comma.




Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Records resource monitors on all systems in one ore more specified groups,identified by name or ID. The list can be a mixture of system group names andIDs, separated by a comma.

Tips:







Tips:


-r | --record record_nameCreate the new resource-monitor recording with the specified name.

-t | --type system_typeRecords resource monitors on all systems of the specified type.


Tips:






-w | --where "query"Records resource monitors on one or more systems based on system attributesspecified by query.



Tips:





Exit status


are not authorized to perform the action.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified resource monitor is not valid.

Examples1. Create a new recording

This example illustrates how to record the CPU Utilization resource monitor onthe system named system1 for 10 minutes, and names the recording NewRecord.smcli mkresmonrec -d 10 -m "[Common Agent][CPU Monitor][CPU Utilization]"-r "NewRecord" -n system1

rmresmonrec commandUse the rmresmonrec command to delete one or more resource-monitor recordings.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmresmonrec options


smcli rmresmonrec [-h | -? | --help]

smcli rmresmonrec [-v] [-c] [-S time] [-t system_type] {-w query | -iip_address_list | -N group_list | -n system_list] [-m monitor] {[-r]recording_list}

Description

None

Operands

This command uses a resource-monitor recording list as an operand. The resourcemonitor list can optionally be preceded by the -r | --record option.

Flags



-c | --confirmPrompts for confirmation to proceed if multiple resource-monitor recordingsare targeted.

Tips:

v If this option is not specified and multiple resource-monitor recordings aretargeted, this command proceeds without prompting.

v If this option is specified and only one resource-monitor recording istargeted, this command proceeds without prompting.




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Deletes recordings for one or more systems, specified by IP address or hostname. The list can be a mixture of IP addresses and host names, separated by acomma.


Tips:




Tips:







Tips:



-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Deletes recordings for one or more systems, specified by name or ID. The listcan be a mixture of system names and IDs, separated by a comma.




Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Deletes recordings for all systems in one ore more specified groups, identifiedby name or ID. The list can be a mixture of system group names and IDs,separated by a comma.

Tips:






Tips:

v Group names are unique.


v Use the lsgp command without any options to list all group names.v The group names are not locale specific.



If the recording name contains a comma, prefix the comma with a backslash(\).

Tips:

v The recording name is unique for a combination of system and monitor.v Use lsresmonrec command with no options to list all recording names.v The system names are not locale specific.

-S | --start timeDeletes recordings that were started at the specified time, using the formatyyyy-mm-dd:hh:mm:ss, where:v yyyy: 4-digit yearv mm: Full name of the monthv dd: 2-digit dayv hh: 2-digit hourv mm: 2-digit minutesv ss: 2-digit seconds

-t | --type system_typeDeletes recordings for all systems of the specified type.


Tips:






-w | --where "query"Deletes recordings for one or more systems based on system attributesspecified by query.



Tips:

v Use logical operators AND or OR to combine attributes.


v Use parentheses to create nested logical constructs.v The query operand must be enclosed in quotation marks. Do not use double



Exit status


are not authorized to perform the action.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified resource monitor is not valid.v 53: A recording could not be found.

Examples1. Remove a resource-monitor recording

This example illustrates how to remove two resource-monitor recording bothnamed ProcessCountRecording.smcli rmresmonrec -c -r ProcessCountRecordingWarning: Multiple thresholds are resolved. Do you want to continue (y/n): y

stopresmonrec commandUse the stopresmonrec command to stop recording resource-monitor values.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] stopresmonrecoptions


smcli stopresmonrec [-h | -? | --help]

smcli stopresmonrec [-v] [-c] [-m monitor] [-S time] [-t system_type] {-wquery | -i ip_address_list | -N group_list | -n system_list] {[-r]recording_list}

Description

None.

Operands

This command uses a list of recording names as an operand. The list canoptionally be preceded by the -r | --record option.


Flags


-c | --confirmPrompts for confirmation to proceed if multiple resource-monitor recordingsare targeted.

Tips:

v If this option is not specified and multiple resource-monitor recordings aretargeted, this command proceeds without prompting.

v If this option is specified and only one resource-monitor recording istargeted, this command proceeds without prompting.




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Stops recording values for one or more systems, specified by IP address or hostname. The list can be a mixture of IP addresses and host names, separated by acomma.


Tips:




Tips:






Resource monitors are made up of levels, for example [Common Agent][CPUMonitors][Process Count]. You can specify any top-level resource monitors(for example, [Common Agent]) or lower-level submonitors (for example,[Common Agent][CPU Monitors][Process Count]). If you specify a top-levelmonitor, all lower-level submonitors are also targeted.

Tips:



-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Stops recording values for one or more systems, specified by name or ID. Thelist can be a mixture of system names and IDs, separated by a comma.




Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Stops recording values for all systems in one ore more specified groups,identified by name or ID. The list can be a mixture of system group names andIDs, separated by a comma.

Tips:







Tips:




If the recording name contains a comma, prefix the comma with a backslash(\).

Tips:

v The recording name is unique for a combination of system and monitor.v Use lsresmonrec command with no options to list all recording names.v The system names are not locale specific.

-S | --start timeStops recording that were started at the specified time, using the formatyyy-mm-dd:hh:mm:ss, where:v yyyy - 4-digit yearv mm - Full name of the monthv dd - 2-digit dayv hh - 2-digit hourv mm - 2-digit minutesv ss - 2-digit seconds

-t | --type system_typeStops recording values for all systems of the specified type.


Tips:






-w | --where "query"Stops recording values for one or more systems based on system attributesspecified by query.

The query operand is a string, enclosed in quotation marks, that defines asimple SELECT query using the following format:


"attribute_key=value [{AND | OR} attribute_key=value...]"


Tips:




Exit status


are not authorized to perform the action.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 29: The specified locale is not valid or not supported.v 50: A specified resource monitor is not valid.v 53: A recording could not be found.

Examples1. Stop recording a resource monitor

This example illustrates how to stop the recording named CPURecordingrunning.smcli stoptresmonrec -r CPURecording

Resource-monitor threshold commandsThe smcli resource-monitor thresholds commands create, delete, modify, and listresource-monitor thresholds.

smcli commands

The following smcli resource-monitor threshold commands are available:

Note: You must use the user interface to manage thresholds for advancedmanagers. You cannot use smcli commands.

chresmonthresh commandUse the chresmonthresh command to change the settings of one or more resourcemonitor thresholds. You can also use this command to activate or deactivatethresholds using this command.


Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chresmonthreshoptions


smcli chresmonthresh [-h | -? | --help]

smcli chresmonthresh [-v] [-c] [-A | -D] [-S settings_list] [-tsystem_type] {-w query | -i ip_address_list | -N group_list | -nsystem_list} [-m monitor] {[-T] threshold_list}

Description

Using this command, you can change the property that activates or deactivates thespecified resource-monitor thresholds and also change the alert settings.

You must specify both the threshold name and resource monitor to uniquelyidentify the resource-monitor threshold. The threshold name by itself might not beunique.

Operands

This command uses a resource-monitor threshold name and system as operands.The resource-monitor threshold name can optionally be preceded by the -T |--threshold option.

Flags


-A | --activateActivates the targeted resource-monitor thresholds.

-c | --confirmPrompts for confirmation to proceed if multiple resource-monitor thresholdsare targeted.

Tips:

v If this option is not specified and multiple resource-monitor thresholds aretargeted, this command proceeds without prompting.

v If this option is specified and only one resource-monitor threshold istargeted, this command proceeds without prompting.

-D | --deactivateDeactivates the targeted resource-monitor thresholds.





Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Changes the threshold properties on one ore more systems, specified by IPaddress or host name. The list can be a mixture of IP addresses and hostnames, separated by a comma.


Tips:




Tips:




-m | --monitors {monitor_name}Changes the threshold associated with the specified resource-monitor.


Tips:



-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Changes the threshold properties on one or more systems, specified by nameor ID. The list can be a mixture of system names and IDs, separated by acomma.





Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Changes the threshold properties on all systems in one ore more specifiedgroups, identified by name or ID. The list can be a mixture of system groupnames and IDs, separated by a comma.

Tips:






Tips:


-S | --settings "alert_type=setting"[,"alert_type=setting"... ]

Sets values for one or more specified attributes, where alert_type is the type ofalert (event) to be generated and setting is the setting value.

Tips:

v The alert-type and setting pairs are enclosed in double quotation marks andseparated by a comma.

v The attributes and attribute values are not locale specific.



Alert type Setting

Name The group name.

HighError Generates an error when the threshold reaches or exceeds thespecified value. The value of HighError must always be greater thanthe value of HighWarning.

HighWarning Generates a warning when the threshold reaches or exceeds thespecified value. The value of HighWarning must always be less thanthe value of HighError and greater than the value of LowWarning.

LowWarning Generates a warning when the threshold reaches or falls below thespecified value. The value of LowWarning must always be less thanthe value of HighWarning and greater than the value of LowError.

LowError Generates an error when the threshold reaches or falls below thespecified value. The value of LowError must always be less than thevalue of LowWarning.

ErrorStrings Generates an error when the threshold matches the specified valuestring.

WarningStrings Generates a warning when the threshold matches the specifiedvalue string.

NormalStrings Generates a normal event when the threshold matches the specifiedvalue string.

-t | --type system_typeChanges the threshold properties on all systems of the specified type.


Tips:




-T | --threshold {threshold_name}[,{threshold_name}...]Targets one or more thresholds names, separated by a comma.

Tips:

v The threshold names might not be unique. This command acts on allthresholds with the specified name. Use the -v | --verbose option togenerate a message when this command targets multiple thresholds with thesame name. To target a threshold that has a name that is not unique, identifythe threshold by specifying its unique, hexadecimal ID, or use additionaltarget options to refine the selection.

v The threshold names are not locale specific.v Use the lsresmonthresh command with no options to obtain a list of valid

system threshold names.




-w | --where "query"Changes the threshold properties on one or more systems based on systemattributes specified by query.



Tips:




Exit status


are not authorized to perform the action.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 50: A specified resource monitor is not valid.v 51: The specified threshold is not valid.

Examples1. Change multiple resource-monitor threshold settings

This example illustrates how to change the resource-monitor threshold namedCPUThreshold on the system named system1 for the CPU utilization monitor.The threshold generates a warning when the CPU utilization reaches or exceeds50% and generates an error when the CPU utilization reaches or exceeds 80%.smcli chresmonthresh -m "[Common Agent][CPU Monitors][CPU Utilization]"-n system1 -S "HighWarning=50","HighError=80" -T "CPUThreshold"

2. Activate a resource-monitor thresholdThis example illustrates how to activate the threshold named CPUThreshold ona system named system1.smcli chresmonthresh -Am "[Common Agent][CPU Monitors][CPU Utilization]"-n system1 -T CPUThreshold

3. Activate a resource-monitor threshold on multiple systemsThis example illustrates how to activate the resource-monitor threshold namedCPUThreshold on systems named system1 and system2 for the CPU utilizationmonitor. The command prompts you to continue.


smcli chresmonthresh -c -A -m "[Common Agent][CPU Monitors][CPU Utilization]"-n system1,system2 -T "CPUThreshold"Warning : Multiple thresholds resolved, do you want to continue (y/n) : y

4. Deactivate a resource-monitor thresholdThis example illustrates how to deactivate the threshold named DiskThresholdon a system named system1.smcli chresmonthresh -D -m "[Common Agent][Disk Monitors][DRIVE C: % Space Used]"-n system1 DiskThreshold

lsresmonthresh commandUse the lsresmonthresh command to list the resource-monitor thresholds.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsresmonthreshoptions


smcli lsresmonthresh [-h | -? | --help]

smcli lsresmonthresh [-v] [-l] [-t system_type] [-f file_name | -m monitor][-w query | -i ip_address_list | -N group_list | -n system_list] [[-T]threshold_list]

Description

If you specify one or more systems, this command lists the resource-monitorthresholds that are currently active on those systems.

If no options are specified, this command lists all the available resource-monitorthresholds that have been created.

Operands

This command optionally uses a list of resource-monitor thresholds as an operand.The list can optionally be preceded by the -T | --threshold option.

Flags




The input data must contain the names of one or more valid resourcemonitors, separated by commas or end-of-line characters.





Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Lists information about resource-monitor thresholds that have been set on oneor more systems, specified by IP addresses or host names. This list can be amixture of IP addresses and host names, separated by a comma.


Tips:




Tips:




-l | --longDisplays detailed information about each resource-monitor threshold.

This option displays these attributes for each resource-monitor threshold:v Name: Name of the resource-monitor thresholdv IsActive: Flag indicating whether the threshold is activated. Possible values

are true (active) or false (not active).v Type: Threshold type. Possible values are individual (set on specific

systems) or group (set on system groups).v Target: The name of the system or group to which the threshold is applied.v Attribute: Attribute for which the threshold is applied.v Description: Threshold descriptionv Generate warning: The circumstance in which a warning is generated.


v Generate error: The circumstance in which an error is generated.

-m | --monitors monitor_nameDisplays threshold information about the specified resource monitor.


Tips:



-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Lists information about resource-monitor thresholds that have been set on oneor more systems, specified by name or ID. This list can be a mixture of namesor IDs, separated by a comma.




Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Lists information about resource-monitor thresholds that have been set on allsystems in one or more specified groups, identified by name or ID. This listcan be a mixture of names or IDs, separated by a comma.

Tips:







Tips:


-t | --type system_typeLists information about resource-monitor thresholds that have been set on allsystems of the specified type.


Tips:





Tips:

v The threshold names might not be unique. This command acts on allthresholds with the specified name. Use the -v | --verbose option togenerate a message when this command targets multiple thresholds with thesame name. To target a threshold that has a name that is not unique, identifythe threshold by specifying its unique, hexadecimal ID, or use additionaltarget options to refine the selection.





-w | --where "query"Lists information about resource-monitor thresholds that have been set on oneor more systems based on system attributes specified by query.




Tips:




Exit status


are not authorized to perform the action.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 51: The specified threshold is not valid.

Examples1. List resource-monitor thresholds set on a system

This example illustrates how to list resource-monitor thresholds that are set onthe system named system1.smcli lsresmonthresh -n system1

MyCPUUtilization

2. List detailed information about a resource-monitor thresholdThis example illustrates how to list detailed information about resource-monitorthreshold named MyCPUUtilization that is associated with the [CommonAgent][CPU Monitors][CPU Utilization] monitor that runs on the systemnamed system1.smcli lsresmonthresh -l -m [Common Agent][CPU Monitors][CPU Utilization]-n system1 -T MyCPUUtilization

Name: MyCPUUtilizationIsActive: TrueType: IndividualTarget: system1Attribute: CPUUtilizationDescription: Threshold on CPU UtilizationGenerate warning: If CPU Utilization goes above 70% or goes below 10%Generate error: If CPU Utilization goes above 90% or goes below 5%HighWarning: 50

3. Export a resource-monitor threshold as a planThis example illustrates how to create an XML file named mythreshold.xmlwith details of the resource-monitor threshold named mythreshold.smcli lsresmonthresh -F xml -T mythreshold > mythreshold.xml

mkresmonthresh commandUse the mkresmonthresh command to create a new resource-monitor threshold for asystem or group.


Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkresmonthreshoptions


smcli mkresmonthresh [-h | -? | --help]

smcli mkresmonthresh [-v] -D {-m monitor} {-S settings_list} [ -tsystem_type] {-w query | -i ip_address_list | -N group_list | -nsystem_list} -r {-T threshold} -q

Description

You can create a resource-monitor threshold for an individual system or group.

If you do not specify the name of an XML file, you must specify the name of aresource monitor and one or more systems or groups.

Important: After you create the resource-monitor threshold, you must activate itusing the chresmonthresh -A command.

Operands

This command uses the name of a resource monitor and one or more systems orgroups as operands.

This command creates a resource-monitor threshold with the name specified bythreshold.

Flags


-m | --monitors {monitor_name}Creates the threshold for the specified resource monitor.


Tips:







Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Sets the resource-monitor threshold on one or more systems, specified by IPaddresses or host names. This list can be a mixture of IP addresses and hostnames, separated by a comma.


Tips:




Tips:




-D | --minDurationSpecifies the time in seconds that the threshold condition must continuouslyexist before an event is generated. The default value is 0.

-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Sets the resource-monitor threshold on one or more systems, specified by nameor ID. This list can be a mixture of names or IDs, separated by a comma.




Tips:




-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Sets the resource-monitor threshold on all systems in one or more specifiedgroups, identified by name or ID. This list can be a mixture of names or IDs,separated by a comma.

Tips:






Tips:


-q | --maxQueuedEventsSpecifies the event queue depth for this threshold. Value must be a positiveinteger. The default value is 0.

-r | --resendDelaySpecify the time in seconds between the generations of events for thisthreshold. The default value is 300 seconds.

-S | --settings "alert_type=setting"[,"alert_type=setting"... ]

Sets values for one or more specified attributes, where alert_type is the type ofalert (event) to be generated and setting is the setting value.

Tips:

v The alert-type and setting pairs are enclosed in double quotation marks andseparated by a comma.

v The attributes and attribute values are not locale specific.


Alert type Setting

Name The group name.


Alert type Setting

HighError Generates an error when the threshold reaches or exceeds thespecified value. The value of HighError must always be greater thanthe value of HighWarning.

HighWarning Generates a warning when the threshold reaches or exceeds thespecified value. The value of HighWarning must always be less thanthe value of HighError and greater than the value of LowWarning.

LowWarning Generates a warning when the threshold reaches or falls below thespecified value. The value of LowWarning must always be less thanthe value of HighWarning and greater than the value of LowError.

LowError Generates an error when the threshold reaches or falls below thespecified value. The value of LowError must always be less than thevalue of LowWarning.

ErrorStrings Generates an error when the threshold matches the specified valuestring.

WarningStrings Generates a warning when the threshold matches the specifiedvalue string.

NormalStrings Generates a normal event when the threshold matches the specifiedvalue string.

-t | --type system_typeSets the resource-monitor threshold on all systems of the specified type.


Tips:




-T | --threshold {threshold_name}Creates a resource-monitor threshold with the specified name.

Tip:

v The threshold names are not required to be unique.v The threshold names are not locale specific.



-w | --where "query"Sets the resource-monitor threshold on one or more systems based on systemattributes specified by query.




Tips:




Exit status


are not authorized to perform the action.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 50: A specified resource monitor is not valid.

Examples1. Create a threshold

This example illustrates how to create a resource-monitor threshold namedCPUThreshold on the system named system1 for the CPU utilization monitor.The threshold generates a warning when the CPU utilization reaches or exceeds50% and generates an error when the CPU utilization reaches or exceeds 80%.smcli mkresmonthresh -m "[Common Agent][CPU Monitors][CPU Utilization]"-n system1 -S "HighWarning=50","HighError=80" -T "CPUThreshold"

rmresmonthresh commandUse the rmresmonthresh command to remove one or more resource-monitorthresholds.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmresmonthreshoptions


smcli rmresmonthresh [-h | -? | --help]

smcli rmresmonthresh [-v] [-c] [-t system_type] [-w query | -iip_address_list | -N group_list | -n system_list} [-m monitor] {[-T]threshold_list}


Description

None.

Operands

This command uses a one or more resource-monitor thresholds and systems asoperands. The resource monitor threshold can optionally be preceded by the -T |--threshold option.

Flags


-c | --confirmPrompts for confirmation to proceed if multiple resource-monitor thresholdsare targeted.

Tips:

v If this option is not specified and multiple resource-monitor thresholds aretargeted, this command proceeds without prompting.

v If this option is specified and only one resource-monitor threshold istargeted, this command proceeds without prompting.



The input data is the list of resource-monitor thresholds to be removed,separated by a comma.




Tips:




-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Removes the resource-monitor thresholds from one or more systems, specifiedby IP addresses or host names. This list can be a mixture of IP addresses andhost names, separated by a comma.


Tips:




Tips:




-m | --monitors {monitor_name}Removes the targeted threshold that is associated with the specified resourcemonitor.


Tips:



-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Removes the resource-monitor threshold from one or more systems, specifiedby name or ID. This list can be a mixture of names or IDs, separated by acomma.




Tips:




-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Removes the resource-monitor threshold from all systems in one or morespecified groups, identified by name or ID. This list can be a mixture of namesor IDs, separated by a comma.

Tips:






Tips:


-t | --type system_typeRemoves the resource-monitor threshold from all systems of the specified type.


Tips:





Tips:

v The threshold names might not be unique. This command acts on allthresholds with the specified name. Use the -v | --verbose option to


generate a message when this command targets multiple thresholds with thesame name. To target a threshold that has a name that is not unique, identifythe threshold by specifying its unique, hexadecimal ID, or use additionaltarget options to refine the selection.





-w | --where "query"Removes the resource-monitor threshold from one or more systems based onsystem attributes specified by query.



Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: A specified resource monitor is not valid.v 51: The specified threshold is not valid.

Examples1. Remove a resource-monitor threshold

This example illustrates how to remove the resource-monitor thresholdMyCPUUtilization from the system named system1.smcli rmresmonthresh -T MyCPUUtilization -m "[Common Agent][CPU Monitors][CPU Utilization]" -n system1


Security commandsUse the commands in this section to manage security certificates andauthorizations for users and user-groups for IBM Systems Director.


smcli commands

The following smcli security commands are available:

authusergp commandUse the authusergp command to authorize an existing user group in an externaluser registry to access the IBM Systems Director Server.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] authusergp options


smcli authusergp [-h | -? | --help]

smcli authusergp [-v] { -f file_name | [-U] user_group_list}

Description

By default, all the operating-system user groups are authorized for access. Theauthorization of all groups that are not explicitly specified is removed when yourun this command. You must explicitly authorize operating-system user groups ifyou run this command.

Values that are specified for the authusergp command are encrypted and storeduntil the group authorization is removed.

Tip: You can use the lsusergp command to list user groups that are authorized toaccess IBM Systems Director Server.

Operands

This command uses a user-group list as an operand. The list can optionally bepreceded by the -U | --usergroup option.

Flags





The input data must contain one or more user groups. This list can be amixture of names and ID, separated by commas or line breaks.




Tips:



[-g] user_group_name[,user_group_name...]Targets one or more operating-system user groups, specified by name.

The list is delimited by the end-of-line character when read from a file.



Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 51: The specified user group is not valid.

Examples1. Authorize multiple user groups

This example illustrates how to authorize the user groups namedAdministrator and Guests.smcli authusergp Administrators,Guests

cfgaccess commandUse the cfgaccess command to configure access for systems managed by IBMSystems Director.


|

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] cfgaccess options


smcli cfgaccess [-h | -? | --help]

smcli cfgaccess [-S Director_user] -W Director_user_password {-r rsap | -iip_address_list | -n system_list | -N group_list} -c cred_type -P password-U username | {-K RSAKeyLocation [-A alias] -f file}

smcli cfgaccess [-S Director_user] -W Director_user_password {-r rsap | -iip_address_list | -n system_list | -N group_list} -c cred_type -C community-V version -f file

smcli cfgaccess [-S Director_user] -W Director_user_password {-r rsap | -iip_address_list | -n system_list | -N group_list} -c cred_type -Eauthpassword -O authprotocol -R prvpwd -T prvprotocol -p profilename -Xcontextname -I contextengID -V version -f file

Description

The cfgaccess command enables you to configure access according to the providedcredential type for the provided remote service access point (rsap).

Note: The following limitations apply to this command:v Currently, only IPv4 addresses are supported.v The following table contains the managed server port numbers that are

supported for remote service access points of each credential type:

Credential type Supported port numbers

PASSWORD, RSA 22

X509 5989, 15989

SNMPv1, SNMPv3 161

v If a managed server has dual IP addresses, the -n and -N options might notfunction correctly.

Flags


-c | --credtype PASSWORD | RSA | SNMPv1 | SNMPv3 | X509Specifies the type of credentials on which to take action. Each credential type iscase-sensitive and has additional options:

PASSWORD -U username -P password

RSA -U username -K RSAKeyLocation -P password

SNMPv1 -U username -C community -V version

SNMPv3 -U username -E authpassword -O authprotocol -R prvpwd -Tprvprotocol -N profilename -X contextname -I contextengID -V version


authprotocol0 = NONE

1 = MD5

2 = SHA

prvprotocol1 = DES

2 = AES

X509 -U username -K RSAKeyLocation -P password -A alias

-file fileTargets resources passwords specified in a file or the standard input pipe. Thefile must be one of the following:v The fully qualified name of the input filev Specify a hyphen (-) instead of a file name. The data is read from the

standard input pipe.

Each of the items in the input file must be separated line breaks:srcpwd=<password of Director user>trgpwd=<target password in case of PASSWORD or RSA or X509 type of credential>privpwd=<privacy password in case of SNMP3 type of credential>

Execute the below command to encrypt the passwords:$director_install/lwi/bin/lwiencoder.sh -filename samplepwdtest -standard.

Use the encrypted file sample_pwd_test as the input for the -f option file.




Tips:






Tips:





Tips:










Tips:



-p | --profile {all | { profile_name}[,profile_name...]}Discovers the systems associated with one or more discovery profiles that arespecified by name and separated by a comma.

Tips:

v You can create discovery profiles using the IBM Systems Director Webinterface. You cannot create, modify or delete profiles from the commandline interface.



v To discover systems associated with all discovery profiles, specify all.v This option cannot be used with the -i | --ipaddress option.

allAll discovery profiles.

profile_nameThe name of the discovery profile. If the discovery profile name contains acomma, prefix the comma with a backslash (\).

Tips:

v Discovery-profile names might not be unique. This command acts on alldiscovery profiles with the specified name. Use the -v | --verbose optionto generate a message when this command targets multiple discoveryprofiles with the same name. To target a discovery profile that has aname that is not unique, identify the discovery profile by specifying itsunique, hexadecimal group ID, or use additional target options to refinethe selection.

v The discovery profiles names are not locale specific.

-r | --rsap rsapSpecifies a remote service access point on which to take action.

Tip: To determine the remote service access point, you can use the lsinvcommand with the -e option for the RemoteServiceAccessPoint inventory type.For example, specify smcli lsinv -e RemoteServiceAccessPoint -nsystem_name, where system_name is the name of the host system. Then, in theoutput, look for the value that corresponds toRemoteServiceAccessPoint.AccessInfo.

-S | --diruser Director_userSpecifies an IBM Systems Director user on which to take action. Only userswith a role of SMAdministrator are allowed to issue a command with thisoption.

-W | --dirpaswd Director_user_passwordSpecifies the password of the IBM Systems Director user for the purpose ofidentity creation.

Exit status


are not authorized to perform the action.v 27: A specified attribute is not valid.

Examples1. Configure access for the PASSWORD credential type

This example illustrates how to configure access for a remote service accesspoint with the PASSWORD credential type. In this example:

adminpwd is the Director_user_password


https://9.126.88.222:22/ is the rsap

root is the user_name

rootpwd is the passwordsmcli cfgaccess -W adminpwd -r https://9.126.88.222:22/ -c PASSWORD -U root-P rootpwd

2. Configure access for the X509 credential type for another user (from a user witha role of SMAdministrator)This example illustrates how to configure access for X509 credentials foranother user from a user with SMAdministrator authority. In this example:

testuser is the Director_user

testuserpwd is the Director_user_password

https://9.126.88.222:22/ is the rsap


C:\key.txt is the ras_key_location

rootpwd is the password

test is the aliassmcli cfgaccess -S testuser -W testuserpwd -r https://9.126.88.222:22/ -c X509-U root -K C:\key.txt -P rootpwd -A test

cfgappcred commandUse the cfgappcred command to change the password that IBM Systems Directoruses to access particular associated applications.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] cfgappcred options


smcli cfgappcred [-h | -? | --help]

smcli cfgappcred [-v] [-a application_name] [-o old_password] [-pnew_password][-f filename]

Description

The cfgappcred command changes the password that IBM Systems Directorassociates with a target application.

Attention: If you use the cfgappcred command to change the Keystore orTruststore password, you must also update the password in the Web containerproperties. See “Updating the Web container properties” for more information.

Flags


-a | --application Keystore | TruststoreSpecifies, by type, the application on which to take action. The followingvalues are possible:


KeystoreSpecifies to change the password for the associated Keystore.

TruststoreSpecifies to change the password for the associated Truststore.

-f | --fileSpecifies the file name with the old and new password of the targetapplication. The file must contain the following:v The fully qualified name of the input file.v A dash (-) is added at the beginning of the line. The data is read from the

standard input pipe. You must separate the items in the input file with linebreaks.

v Use the following procedure to create a file:1. Enter old password of the target application in the oldpwd field.2. Enter new password of the target application in the newpwd field.3. Run the following command to encrypt the passwords:

$director_install/lwi/bin/lwiencoder.sh/bat -filenamesamplepwdtest -standard

4. Use the encrypted file samplepwdtest as input to the -f option.




Tips:



-o | --opasswd old_passwordSpecifies the old password of the target application. If this option is notspecified, you will be prompted for the value.

-p|--password new_passwordSpecifies the new password of the target application. If this option is notspecified, you will be prompted for the value.



Exit status




v 10: The file was not found.v 29: The specified locale is not valid or not supported.v 57: The password is not modifiable.

Examples1. Change the password of a Keystore.

This example illustrates how to change the password of a Keystore from“oldpass1” to “newpass1”.smcli cfgappcred -a Keystore -o oldpass1 -p newpass1

2. Use a file to change the password of a Keystore.This example illustrates how to change the password of a Keystore by using afile.smcli cfgappcred -a Keystore -f /root/passwd.txt

cfgcertpolicy commandUse the cfgcertpolicy command to view or configure the trust managementcertificate policy that IBM Systems Director uses.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] cfgcertpolicy options


smcli cfgcertpolicy [-h | -? | --help]

smcli cfgcertpolicy [-v] [-i] [-e]

Description

The cfgcertpolicy command sets the trust management certificate policy to eitherimplicit or explicit. If you specify neither option when running the cfgcertpolicycommand, the current trust management certificate policy is just displayed.

Note: The ability to set the trust management certificate policy applies to onlycertain components and managed system types. Therefore, exercise caution whenassuming that communication with the management server is secure after settingthe policy.

Flags


-e | --explicitSets the certificate policy to explicit and provides instructions for furthermanaging keys and certificates in the keystore and truststore.





Tips:



-i | --implicitSets the certificate policy to implicit and provides instructions for furthermanaging keys and certificates in the keystore and truststore.



Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 56: The certificate trust policy is not modifiable.

Examples1. Display the current trust management certificate policy

This example illustrates how to display the current trust management certificatepolicysmcli cfgcertpolicy

2. Set the current trust management certificate policy to “implicit”This example illustrates how to set the current trust management certificatepolicy to “implicit”.smcli cfgcertpolicy -i

3. Set the current trust management certificate policy to “explicit”This example illustrates how to set the current trust management certificatepolicy to “explicit”.smcli cfgcertpolicy -e

cfgcred commandUse the cfgcred command to configure credentials for systems managed by IBMSystems Director.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] cfgcred options



smcli cfgcred [-h | -? | --help]

smcli cfgcred [-S Director_user] {-W Director_user_password} {-r rsap} {-ccred_type} { -f file} {-U username} {[-K RSAKeyLocation [-A alias]] -Ppassword} | {-C community -V version} | {-E authpassword -O authprotocol -Rprvpwd -T prvprotocol -N profilename -X contextname -I contextengID -Vversion}}

Description

The cfgcred command enables you to configure credentials for systems managedby IBM Systems Director.

Flags








1 = MD5

2 = SHA

prvprotocol1 = DES

2 = AES





Tips:


|







-f | --file

Passes the passwords of resources through a file. file must contain one of thefollowing:v The fully qualified name of the input file.v A dash (-).

Data is read from the standard input pipe. Items in the input file must beseparated by line breaks.v Complete the following steps to pass passwords through a file:1. Use the following to create a file:

v srcpwd = password of IBM Systems Director user.v trgpwd = target password in case of PASSWORD or RSA or X509 type of

credential.v privpwd = privacy password in case of SNMP3 type of credential.v authpwd = authentication password in case of SNMP3 type of credential.

2. Run the following command to encrypt the passwords:v $director_install/lwi/bin/lwiencoder.sh/bat -filename

samplepwdtest -standard

3. Use the encrypted file samplepwdtest as input to -f option.


Exit status



|

||

|

|

||

|

|

|

||

|

|

|

||

|


v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.

Examples1. Configure credentials for the PASSWORD credential type

This example illustrates how to create PASSWORD credentials for a remoteservice access point using the PASSWORD credential type. In this example:

adminpwd is the Director_user_password

https://9.126.88.222:22/ is the rsap


rootpwd is the passwordsmcli cfgcred -W adminpwd -r https://9.126.88.222:22/ -c PASSWORD -U root-P rootpwd

2. Configure credentials for the PASSWORD credential type by passing passwordsthrough fileThis example illustrates how to configure credentials for the PASSWORDcredential type by passing passwords through files. In this example:

https://9.126.88.222:22/ is the rsap


pwdfile is the file with the encrypted passwordssmcli cfgcred -r https://9.126.88.222:22 -c PASSWORD -U root -f pwdfile

3. Configure credentials for the X509 credential type for another user (from a userwith a role of SMAdministrator)This example illustrates how to create X509 credentials for another user from auser with SMAdministrator authority. In this example:

testuser is the Director_user

testuserpwd is the Director_user_password

https://9.126.88.222:22/ is the rsap


C:\key.txt is the ras_key_location

rootpwd is the password

test is the aliassmcli cfgcred -S testuser -W testuserpwd -r https://9.126.88.222:22/ -c X509-U root -K C:\key.txt -P rootpwd -A test

cfgpwdpolicy commandUse the cfgpwdpolicy command to manage the password policies of the keystoreand truststore passwords.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] cfgpwdpolicy options


smcli cfgpwdpolicy [-h | -? | --help]

smcli cfgpwdpolicy [-v] [-e | -d] [-c] [-n] [-l] [-a algorithm]


||

||

|

|

|

|

||

Description

The cfgpwdpolicy command manages various attributes of the keystore andtruststore passwords . If you specify no options when running the cfgpwdpolicycommand, the current password policy is just displayed.

Flags


-a | --algorithm aes | aes_sha2 | custom | xorSpecifies the algorithm to use when encrypting passwords.

-c | --allowcharConfigure the password validation rule to check that the password generatedor used contains alphabetic characters.

-d | --disableSpecifies to disable the password policy used by user management in IBMSystems Director.

-e | --enableSpecifies to enable the password policy used by user management in IBMSystems Director.




Tips:



-l | --lengthSpecifies the minimum password length.

-n | --allownumConfigure the password validation rule to check that the password generatedor used contains numeric characters.



Exit status



||

|

|


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 59: The password policy is not modifiable.

Examples1. Display the current password policy

This example illustrates how to display the current password policysmcli cfgpwdpolicy

2. Disable a password policyThis example illustrates how to disable a password policy.smcli cfgpwdpolicy -d

3. Set password character and length rulesThis example illustrates how to set rules that specify that a password cancontain alphabetic and numeric characters and must not exceed a length ofeight characters.smcli cfgpwdpolicy -l 8 -c -n

chaudit command

Use the chaudit command to modify audit settings and also to configure a rsyslogserver to store audit events sent from IBM Systems Director.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chaudit options


smcli chaudit [-h | -? | --help]

smcli chaudit [-e | -d] [-r | [[-a category_name] [-x category_name] [-mmaxnoofrecs] [-s enable [-u | -t] -p port { [-c cert ] [-l selfcert]}]]

Description

The chaudit command changes current audit settings, restores the default values,and modifies the list of audit categories. At least one option is required. Use thecommand to configure a local or remote rsyslog server to receive audit events fromIBM Systems Director.

Flags


-a category_name [, category_name...]Specifies the categories to be added to the list of enabled audit categories. Eachcategory_name is separated by a comma.


||

||

||||

-dSpecifies to disable auditing globally.

-eSpecifies to enable auditing globally.




Tips:



-m Specifies the maximum number of audit records that will be stored in IBMSystems Director internal persistence store.

-r Specifies to restore audit settings to their default values.

-s Specifies whether to add or remove the syslog server as the audit log persister.If the syslog server is remote, ensure that the syslog server is started with -roption so that the syslog server can accept remote logs. This option requiresenable | disable to be passed as values.

-u Specifies the selected protocol for audit log forwards as UDP.

-t Specifies the selected protocol for audit log forwards as TCP.

-i Specifies the IP address or host name of the syslog server. The address must bea valid IPv4 or IPv6 address. The ip option is required if the s option isspecified as enabled. Specify either the hostname or the hostname and DomainName System (DNS) as suffix of the system.

-p Specifies the port where the syslog server is listening. The default port is 514.

-c Specifies the qualified path and file name of a certificate from a certificateauthority.

-k Specifies the qualified path and file name of the private key of IBM SystemsDirector.

-l Specifies the qualified path and file name of certificate of the syslog server.

-x category_name [, category_name...]Specifies the categories to be removed from the list of enabled audit categories.Each category is separated by a comma.

Exit status



|||

|||||

||

||

|||||

||

|||

|||

||


v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.

Examples1. Enable auditing

This example illustrates how to enable auditing.smcli chaudit -e

2. Add audit categories to the list of audit categoriesThis example illustrates how to add the audit categories FileRead andRemoteAccess to the list of enabled audit categories.smcli chaudit -a FileRead,RemoteAccess

3. Remove audit categories from the list of audit categoriesThis example illustrates how to remove FileWrite and Security from the list ofenabled audit categories.smcli chaudit -x FileWrite,Security

4. Restore default audit settingsThis example illustrates how to restore all audit settings to the default values.smcli chaudit -r

5. Send logs through TLSThis example illustrates how to configure IBM Systems Director to send logsthrough TLS.smcli chaudit -s enable -t -i 9.19.189.106 -c /opt/isd/cert.pem-k / opt/isd/srv-key.pem -l /opt/isd/srv-cert.pem

6. Configure maximum records that can be storedThis example illustrates how to configure maximum number of records thatcan be stored inIBM Systems Director persistence store.smcli chaudit -m 1000

7. Configure a rsyslog server to receive audit log forwards by using UDPThis example illustrates how to configure a rsyslog server to receive audit logforwards by using UDP.smcli chaudit -s enable -u -i 9.124.56.34

8. Configure a rsyslog server to receive audit log forwards by using TCPThis example illustrates how to configure a rsyslog server to receive audit logforwards by using TCP.smcli chaudit -s enable -t -i 9.124.56.34

9. Configure a rsyslog server to receive audit log forwards by using TLSThis example illustrates how to configure a rsyslog server to receive audit logforwards by using TLS.smcli chaudit -s enable -t -i 9.124.56.34 -c ca.pem -l srv-crt.pem

10. Disable the rsyslog configurationThis example illustrates how to disable the rsyslog configuration.smcli chaudit -s disable

chcred commandUse the chcred command to change credentials for systems managed by IBMSystems Director.


|

||

|

|

||

|

|

||

|

|

|

|

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chcred options


smcli chcred [-h | -? | --help]

smcli chcred {-t target_identity_ID} {-c cred_type} {-f file} {{-Ppassword {-K RSAKeyLocation [-A alias]]} | {-C community -V version} | {-Eauthpassword -O authprotocol -R prvpwd -T prvprotocol -N profilename -Xcontextname -I contextengID -V version}}

Description

The chcred command enables you to change existing credentials for systemsmanaged by IBM Systems Director.

Flags








1 = MD5

2 = SHA

prvprotocol1 = DES

2 = AES






|

Tips:



-t target_identity_IDConfigure credentials for a specified target identity ID.

-f | --file

Passes the passwords of resources through a file. file must contain one of thefollowing:v The fully qualified name of the input file.v A dash (-).

Data is read from the standard input pipe. Items in the input file must beseparated by line breaks.v Complete the following steps to pass passwords through a file:1. Use the following to create a file:

v srcpwd = password of IBM Systems Director user.v trgpwd = target password in case of PASSWORD or RSA or X509 type of

credential.v privpwd = privacy password in case of SNMP3 type of credential.v authpwd = authentication password in case of SNMP3 type of credential.

2. Run the following command to encrypt the passwords:v $director_install/lwi/bin/lwiencoder.sh/bat -filename

samplepwdtest -standard

3. Use the encrypted file samplepwdtest as input to -f option.

Exit status


are not authorized to perform the action.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.

Examples1. Change credentials for the PASSWORD credential type fir the specified system

This example illustrates how to change PASSWORD credentials for a system. Inthis example, 5A4066582C563AFF9976F80C54C0931D is the target_identity_ID, rootis the user_name, and newpwd is the password.smcli chcred -t 5A4066582C563AFF9976F80C54C0931D -c PASSWORD -U root -P newpwd

2. Change credentials for the PASSWORD credential type by passing passwordsthrough fileThis example illustrates how to change PASSWORD credentials for a systemthrough a file. In this example, C is the target_identity_ID, root is the user_name,and pwdfile contains the password in encrypted format.smcli chcred -t 5A4066582C563AFF9976F80C54C0931D -c PASSWORD -f pwdfile


|

||

|

|

||

|

|

|

||

|

|

|

||

|

||

|||

|

3. Change the key location for X509 credentials for a specified systemThis example illustrates how to change the key location for X509 credentials fora system. In this example, DD6A3F6008553876A883E40F5363B8BA is thetarget_identity_ID and C:\newloc\key.txt is the ras_key_location.smcli chcred -t DD6A3F6008553876A883E40F5363B8BA -c X509 -K C:\newloc\key.txt

chrole commandUse the chrole command to change the properties of a role.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chrole options


smcli chrole [-h | -? | --help]

smcli chrole {-f file_name}

smcli chrole [-v] [-e extend_list | -r remove_list | -A attribute_list]{role}

Description

You can use this command to add or remove permissions from a role. You can alsouse this command to change the name, description and default role.

Operands

This command uses a role name or ID as an operand. It is required if you do notspecify a role-definition file using the -f | --file option.

The role name (role_name) or ID (role_oid) identifies the role being modified.

role_oidThe unique ID of an IBM Systems Director role, specified as a hexadecimalvalue prefixed with 0x (for example, 0x7b).

Tip: Use lsrole -o to list the current role IDs.

role_nameThe name of a role. If the name contains a comma, prefix the comma with abackslash (\). If the member name contains space characters, enclose it inquotation marks.

Tips:

v Use lsrole -A Description to list all the descriptions.v The role names are not locale specific.

Flags



-A | --attribute {key=value}[,key=value...]Changes the value of one or more specified attributes, where key is theattribute key. The keys are separated by a comma.

Tip:

v Separate the keys with commas.v The attributes and attribute values are not locale specific.v You can use the lssys -llsuser -l command to list all attributes associated

with the targeted systems.

You can specify any of the following attribute keys:


Description string Description of the role.

Default boolean Flag indicating whether the role is the default. Possiblevalues are true if the role is the default role and falseif the role is not the default.

-e | --extend {permission_oid | permission_name} [, {permission_oid |permission_name }...]

Adds one or more valid permissions to the role. This list can be a mixture ofnames and IDs, separated by commas.

permission_id_stringSpecifies the unique ID string of the permission.

Tips:

v Use the lsperm -I command without any options to list all permissionnames and IDs.

v The permission ID string must be preceded with the % character.

permission_nameSpecifies the name of the permission. Enclose the permission name inquotation marks if it contains a space character.

Tips:

v Use the lsperm -A Description command to list the current permissionnames and their descriptions or use the lsperm command to list all thecurrent permission names.

v The permissions names are not locale specific.



The input data must contain one or more records which are separated bycommas or line breaks. Each record in the input data specifies the role name orID, the action to take, and a list of required information for that action usingone of these following formats:role:extend:permission_listrole:remove:permission_listrole:modifyAttribute: key=value,key=value...





Tips:



-r | --remove {permission_oid | permission_name} [, {permission_oid |permission_name }...]

Removes one or more permissions, specified by name or ID, from the role. Thislist can contain a mixture of permission IDs and name, separated by a comma.



Tips:




Tips:





Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.


v 29: The specified locale is not valid or not supported.v 52: A specified role was not found.v 53: The specified role name already exists.v 54: A specified permission was not found.

Examples1. Add a new permission to a role

This command illustrates how to add the permission engine.serverFileAccessto the role dbAdmin.smcli chrole -e %engine.serverFileAccess dbAdmin

2. Remove a new permission to a roleThis command illustrates how to remove the permissionengine.serverFileAccess to the role dbAdmin.smcli chrole -r %engine.serverFileAccess dbAdmin

chuser commandUse the chuser command to modify the properties of a user.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chuser options


smcli chuser [-h | -? | --help]

smcli chuser [-v] -f file | -u user_name [-m lock | unlock | reset] [-erole_list] [-r role_list] [-d description] [-A attribute_list]

Description

Use the chuser command to modify the attributes and access settings for a user,add or remove roles for a user. When adding roles for a user, you can specify thegroup list attribute to indicate on which groups the role is valid.

Important: This smcli chuser command is not the same as the chusr command forAIX and UNIX operating systems.

Operands

This command uses a user name or ID as an operand. The operand is required ifyou do not use the -f option to specify a user definition file.

Flags

Notes:

v The -L | --lang option and the DIR_LANG environment variable are no longeravailable. Use of the -L | --lang option will result in a usage error. If theDIR_LANG environment variable is set, it will be ignored.

-A | --attributeattribute=attribute_value[,attribute2=attribute2_value,...]

Specifies a list of attributes as a comma separated list.


Tips:

v If an attribute requires more than one attribute value, enclose such valueswithin quotes and separated by commas. For example, -Aattr1="val1,val2",attr2=val3.

v The attributes and attribute values are not locale specific.v You can use the smcli lsuser -l -v command to list all applicable user

properties and associated descriptive information.

-d | --desc "description"Specifies the description of the user. If the description contains spaces, encloseit in quotation marks.

Note: The -d option is deprecated in this release. Use the -A option instead.

-e | --extend role_name[,role2_name,...]Adds roles to the specified user. The list is a semicolon or comma separatedlist of role names or role object IDs (OIDs), optionally followed by targetgroups which is also a semicolon separated list. If a the semicolon is used toseparate multiple roles or multiple groups, prefix the semicolon with abackslash (\).

-f | --file fileSpecifies a standard input pipe or a file that contains a list of users to target.Specify either the fully qualified name of the input file or a dash (-) to indicatethat the data is read from the standard input pipe. If specifying a file, ensurethat each item in the file is separated by a line break and follows the followingformat:user:operation:list

where:v user is the user name or user OIDv operation is one of the following items:

– attribute

– extend

– remove

v list is a list of key value pairs or roles, depending on the specifiedoperation:– When the operation is attribute, list is a comma separated list of key

value pairs.– When the operation is extend or remove, list is a list of roles. You can

optionally follow the role list with a group list and separate the two listswith a colon ( : ).

When the selected operation is extend or remove, list must be a list of roles.Optionally, follow the role list with a resource group list. Separate the two listswith a comma.

When the selected operation is attribute, list must a comma-separated list ofkey value pairs. Examples:v Assign SMAdministrator role with access to the Operating Systems resource

group to the usergrouptest.test:extend:SMAdministrator;Operating Systems

v Assign SMMonitor role with access to the Operating Systems resource groupand the SMUser role with access to thePower Systems resource group to theusergroup test.


test:extend:SMMonitor;Operating Systems,SMUser;Power Systems




Tips:



-m | --modify lock | unlock | resetModifies the user account to either lock or unlock it from accessing theconsole, or resets the number of failed login attempts.

-r | --remove role_name[,role2_name,...]Removes roles from the specified user. The list is a semicolon or commaseparated list of role names or role object IDs (OIDs).

-u | --user user_nameSpecifies the user to modify.



Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 50: A specified user is not valid.v 52: A specified role was not found.v 60: A specified attribute is read-only.

Examples1. Add a role to a user

This example illustrates how to add the SMAdministrator role to user user1.smcli chuser -u user1 -e SMAdministrator

2. Add a role to multiple users and groupsThis example illustrates how to add role role2 to user2 and apply that role togroup1 and group2.


smcli chuser -e role2:group1;group2 -u user2

3. Remove a role from a userThis example illustrates how to remove the SMAdministrator role from useruser2.smcli chuser -u user2 -r SMAdministrator

chusergp commandUse the chusergp command to change attributes and access privileges for a usergroup.

Syntax

smcli chusergp [-h | --help]


smcli chusergp [-v] -f filename

smcli chusergp [-v] {-g usergroup} {[-e extend_rolelist ] [-r role_list ][-d description]}

Description

You can use this command to add or remove roles from a user group. Whenadding the roles to a user group, you can specify a system group list to identifythe systems on which the role is valid.

You can also use this command to change the description and full nameof the usergroup.

Operands

This command uses a user group as an operand. The user_group operand specifiesthe user group to be changed.

Tip: You can use the lsusergp command without any options to list all usergroups.

Flags


-d | --desc "description"Specifies the description of the user group. If the description contains spaces,enclose it in quotation marks.

Note: The -d option is deprecated in this release. Use the -A option instead.

-e | --extend listSpecifies the roles to be added.

-f | --file file_nameThe definition for modifying user groups is given in a file or standard inputpipe.


Targets user groups in a file or the standard input pipe.

The file must be one of the following:v The fully qualified name of the input file.v Specify a hyphen (-) instead of a file name. The data is read from the


Items in the input file must be separated by line breaks.The file must be in the following format:usergroup:operation:list

v usergroup: The user group name or user group OID.v operation: Choose extend, remove, or attributev list: The list of roles

When the selected operation is extend or remove, list must be a list of roles.Optionally, follow the role list with a resource group list. Separate the two listswith a comma.When the selected operation is attribute, list must a comma-separated list ofkey value pairs. Examples:v Assign SMAdministrator role with access to the Operating Systems resource

group to the usergrouptest.test:extend:SMAdministrator;Operating Systems

v Assign SMMonitor role with access to the Operating Systems resource groupand the SMUser role with access to thePower Systems resource group to theusergroup test.

test:extend:SMMonitor;Operating Systems,SMUser;Power Systems

-g | --groupSpecifies the user group name.




Tips:



-r | --remove listRemoves one or more roles, specified by name or ID, from the user group. Thislist can contain a mixture of role IDs and name, separated by a comma.





Exit status

The following codes are returned by this command.v 0: The command was successful.v 1: A usage error occurred.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you

are not authorized to perform the action.v 10: The file was not found.v 21: A specified resource group does not exist.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.v 51: A specified user group was not found.v 52 : A specified role was not found.v 60: A specified attribute is read-only.v 71: Indicates an internal user registry error.

Examples1. Add a role to a user group and apply to all system groups

This example illustrates how to add the role role1 to user group RemoteDesktop Users.smcli chusergp -e role1 -g "Remote Desktop Users"

2. Remove a role from a user groupThis example illustrates how to removes the role role1 from the user groupGuests.smcli chusergp -r role1 -g Guests

deletecertCRL commandUse the deletecertCRL command to remove a Certificate Revocation List (CRL)from IBM Systems Director.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] deletecertCRL options


smcli deletecertCRL [-h | -? | --help]

smcli deletecertCRL [-v] [-F]

Description

The deletecert command removes the CRL file. All the certificates that wererevoked due to this CRL file are now marked as valid.

Flags


-F | --forceDeletes the CRL file without confirmation.


|

||

|

|

||

|

|

|

||

|

|||

||




Tips:





Exit status


are not authorized to perform the action.v 53: The CRL delete command failed.

Examples1. Remove a CRL file from IBM Systems Director.

This example illustrates how to remove the CRL file.smcli deletecertCRL -F

exportcert commandUse the exportcert command to export a certificates from an IBM SystemsDirector keystore or truststore to a pem file.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] exportcert options


smcli exportcert [-h | -? | --help]

smcli exportcert [-v] -F file_path -t target_store -f certid _filepath | -aalias_name

Description

The exportcert command exports the certificate with the specified alias name (orissuer name and serial number) and file path from an IBM Systems Director


||

||

||||

|

||

||

||

|

|

|||||||

|

|

|

|

|

keystore or truststore into a pem file. Revoked certificates only apply to IntegratedManagement Module (IMMv2) events and Chassis Management Module managedsystems.

Flags


-a | --alias alias_nameSpecifies the name of the certificate alias on which to take the action of thecommand.

-F | --Filepath file_pathSpecifies the qualified path and file name of a certificate to import or acertificate name to which to export. When importing, the certificate must be ofone of the following two types:v Base64-encoded DER certificates, which are enclosed between “-----BEGIN

CERTIFICATE-----” and “-----END CERTIFICATE-----” in Privacy EnhancedMail files

v DER-encoded certificates

-f | --filepath [certid_filepath]Specifies the qualified path and file name which contains certificate serialnumbers and issuer names separated by line breaks.

File should contain certificate serial numbers and issuer names in the followingformat:<Serial Number1> <Issuer Name1>

<Serial Number2> <Issuer Name12>

Example: 43214321535321532 CA1




Tips:



-t | --targetstore {key | trust}

Specifies the target store type on which to take action. The available store typevalues are “key” and “trust”.




Exit status


are not authorized to perform the action.v 10: The file was not found.v 51: The certificate with given alias name does not exist.v 54: The certificate export task failed.v 59: The keystore or truststore will not export the revoked certificate.v 65: A certificate with the specified serial number and issuer name does not exist

in the specified keystore or truststore.

Examples1. Export a certificate from a keystore to a pem file

This example illustrates how to export the certificate with alias name “cert1”into a keystore and put it at file path “c:\cert1.pem”.smcli exportcert -a cert1 -F c:\cert1.cer -t key

2. Export a certificate from a truststore to a pem fileThis example illustrates how to export the certificate with alias name “cert1”into a truststore and put it at file path “c:\cert1.pem”.smcli exportcert -a cert1 -F c:\cert1.pem -t trust

3. Export a certificate from a truststore to a pem file based on serial number andissuer name.This example illustrates how to export the certificate based on serial numberissuer name passed in a file into a truststore and put it at file path“c:\cert1.pem”. Output file created will be in the format offileName_SerialNumber_IssuerName.pemsmcli exportcert -F c:\cert1.pem -t trust -f

importcert commandUse the importcert command to import certificates into an IBM Systems Directorkeystore or truststore.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] importcert options


smcli importcert [-h | -? | --help]

smcli importcert [-v] -F file_path -t target_store [-V] -a alias_name

Description

The importcert command imports the certificate with the specified alias name andfile path into an IBM Systems Director keystore or truststore. If alias_name notspecified, certificate_serialnumberissuer_name will become the alias_name.


Flags



-F | --Filepath file_pathSpecifies the qualified path and file name of a certificate to import or acertificate name to which to export. When importing, the certificate must be ofone of the following two types:v Base64-encoded DER certificates, which are enclosed between “-----BEGIN

CERTIFICATE-----” and “-----END CERTIFICATE-----” in Privacy EnhancedMail files

v DER-encoded certificates




Tips:





-V | --ValidateSpecifies to only validate the target certificate and not also import it into astore.



Exit status


are not authorized to perform the action.v 52: The certificate import task failed.


v 58: The keystore or truststore will not import the revoked certificate.v 70: Alias already exists in keystore or truststore.

Examples1. Import a certificate into a keystore

This example illustrates how to import the certificate with alias name “cert1”and file path “c:\cert1.cer” into a keystore.smcli importcert -a cert1 -F c:\cert1.cer -t key

2. Import a certificate into a truststoreThis example illustrates how to import the certificate with alias name “cert1”and file path “c:\cert1.cer” into a truststore.smcli importcert -a cert1 -F c:\cert1.cer -t trust

3. Validate a certificateThis example illustrates how to validate the certificate with file path“c:\cert1.pem” .smcli importcert -a cert1 -F c:\cert1.pem -t trust -V

importcertCRL commandUse the importcertCRL command to import a Certificate Revocation List (CRL) intoIBM Systems Director.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] importcertCRL options


smcli importcertCRL [-h | -? | --help]

smcli importcertCRL [-v] [-f certcrl_filename]

Description

The importcertCRL command imports the CRL file. All the certificates in theCertificate Trust Store are validated against this CRL file.

Flags


-f | --filepath certcrl_filepathSpecifies the qualified path of the CRL file.





|

||

|

|

||

|

|

|

||

|

|||

||

||

||

||||

Tips:





Exit status


are not authorized to perform the action.v 10: The file was not found.v 52: The CRL import command failed.v 74: The CRL file is not in the X509 format.

Examples1. Import a CRL file into IBM Systems Director.

This example illustrates how to import the CRL file at the c:\cert1.cer filepath.smcli importcertCRL -f c:\test.crl

lsaudit commandUse the lsaudit command to list audit settings and categories.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsaudit options


smcli lsaudit [-h | -? | --help]

smcli lsaudit [-l category_name]

Description

If you use the lsaudit command without any options, it lists the current auditingsettings such as status (enabled or disabled) and the list of available auditingcategories with their status (enabled or disabled). It can also list the informationrelated to all the actions or the actions of particular categories when you use therequired options. If IBM Systems Director is configured to send audit logs to syslogserver, then that configuration will also be listed.


|

||

||

||

|

|

|||||||||

|

|

||

|

|

||||||

Flags





Tips:



-l category_name [, category_name...] | ALLSpecifies the categories for which information is displayed. Each category_nameis separated by a comma. If you specify ALL, information for all categories isdisplayed.

Exit status



Examples1. List all audit settings and audit categories

This example illustrates how to list all audit settings and categories.smcli lsaudit

2. View information for specified audit categoriesThis example illustrates how to list information for specified categories cat_1and cat_2.smcli lsaudit -l cat_1,cat_2

3. View information for all audit categoriesThis example illustrates how to list information for all available categories.smcli lsaudit -l ALL

lsauditlogs commandUse the lsauditlogs command to list a specific number of audit log messages forone or more audit categories.


Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsauditlogs options


smcli lsauditlogs [-h | -? | --help] {-n numberOfMessages} [-ccategory_name]

Description

You can use this command to list a specific number of audit log messages. You canalso list a specific number of log messages for a specific audit log category. Thenumber of log messages to display.

Flags


-c category_name [, category_name...]Specifies the categories for which information is displayed. Each category isseparated by a comma. If you do not specify this option, information for allcategories is displayed.




Tips:



-n numberOfMessagesSpecifies the number of audit log messages to be displayed. This option isrequired.

Exit status


are not authorized to perform the action.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.


v 29: The specified locale is not valid or not supported.

Examples1. List a specific number of audit log messages

This example illustrates how to list 25 messages from all audit log categories.smcli lsauditlogs -n 25

2. List a specific number of log messages from one audit logThis example illustrates how to list 25 messages from the Security audit log.smcli lsauditlogs -n 25 -c Security

lscert commandUse the lscert command to list the certificates in an IBM Systems Directorkeystore or truststore.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lscert options


smcli lscert [-h | -? | --help]

smcli lscert [-v] [-l] [-a alias_name] [-f certid_filename] -t target_store[-r]

Description

The lscert command provides a list of current certificates in an IBM SystemsDirector keystore or truststore. You can also specify the -a option to listinformation about a particular certificate alias. You can specify the -r option to listrevoked certificates.

Flags






Tips:




-l Displays detailed properties information for all certificates.




Example: 43214321535321532 CA1

-r | --revokecertDisplays only those certificates that are revoked.





Exit status


are not authorized to perform the action.v 10: The file was not found.v 51: A certificate with the specified alias name does not exist in the specified

keystore or truststore.v 65: A certificate with the specified serial number and issuer name does not exist


Examples1. List certificate aliases in a keystore

This example illustrates how to list all current certificate aliases in a store oftype “key”.smcli lscert -t key

2. List certificate aliases in a truststoreThis example illustrates how to list all current certificate aliases in a store oftype “trust”.smcli lscert -t trust

3. Display detailed information about a particular certificate in a keystoreThis example illustrates how to display detailed information about thecertificate with the alias name cert1 in a keystore.smcli lscert -l -a cert1 -t key


4. Display detailed information about all certificates in a keystoreThis example illustrates how to display detailed information about allcertificates in a keystore.smcli lscert -l -t key

5. List revoked certificates in a truststoreThis example illustrates how to list all revoked certificate in a store of type“trust”.smcli lscert -r -t trust

6. Display detailed information about particular certificates in a key store.This example illustrates how to display detailed information about thecertificates in a keystore with serial number and issuer name specified in a file“c:\certid.properties” in a keystore.smcli lscert -f c:\certid.properties -t key

lscred commandUse the lscred command to list credentials for systems managed by IBM SystemsDirector.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lscred options


smcli lscred [-h | -? | --help]

smcli lscred [-n hostname] [-i IPaddress] [-r rsap]

Description

The lscred command lists credentials and other detailed information aboutsystems managed by IBM Systems Director.

If no options or operands are specified, this command lists all credentials to whichthe user is mapped. If the user is assigned to a role of SMAdministrator, allcredentials are displayed.

Flags






Tips:



-i IPaddress [,IPaddress...]Specifies to list the credentials for the specified IP address.

-n hostname [,hostname...]Specifies to list the credentials for the specified host name.



Exit status



Examples1. List all credentials

This example illustrates how to list all credentials to which the user is mapped.smcli lscred

2. List all credentials for one or more IP addressesThis example illustrates how to list the credentials for two IP addresses,9.124.29.152 and 9.124.33.174.smcli lscred -i 9.124.29.152,9.124.33.174

3. List all credentials for one or more host namesThis example illustrates how to list the credentials for two host names,rev4.in.ibm.com and x206b.in.ibm.com.smcli lscred -n rev4.in.ibm.com,x206b.in.ibm.com

4. List all credentials for one or more remote service access pointsThis example illustrates how to list the credentials for two remote service accesspoints, https://9.124.111.64:22/ and https://9.126.88.222:22/.smcli lscred -r https://9.124.111.64:22/,https://9.126.88.222:22/

lsperm commandUse the lsperm command to list the permissions.


Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsperm options


smcli lsperm [-h | -? | --help]

smcli lsperm [-v] [-I] [-d delimiter] [-l | -A attribute_list [-s]] [-ffile_name | [-p] permission_list ] [-u user_name] [-c category_name]

Description

If no options are specified, this command lists all permissions. If no displayoptions are specified, only the permission name is displayed.

Operands

This command uses a list of permissions as an operand. The list can optionally bepreceded by the -p | --permission option.

The user operand lists permissions for a specified user.

The category operand filters user permissions based on a permission category.

Flags


-A | --attribute key[,key ... ]so

Displays values for one or more specified attributes, where key is the attributekey.

Tips:

v Separate the keys with commas.v The attributes and attribute values are not locale specific.v You can use the lssys -llsuser -l command to list all attributes associated


You can specify any of the following attribute keys.


ObjectType string Permission object type

DisplayName string Permission name

Description string Permission description

PermissionId string Permission identifier

Category string Permission type

-c | --category categoryNameTargets the specified permission category. To display all available categories,specify all for the -c option.









The behavior of this option depends on the use of other options in thecommand, as shown below.v If you specify this option with the -A | --attribute option, this command

separates data fields in a record by the specified delimiter. Data records areseparated by a line break.

v If you specify this option without the -A | --attribute option, thiscommand separates data fields in a record by a comma followed by a space.Data records are separated by the specified delimiter symbol.

v If you specify this option with the -l | --long option, the delimiter optionis ignored.



The input data must contain one or more valid IBM Systems Directorpermissions. This list can be a mixture of names and IDs, separated bycommas or line breaks.




Tips:




-I | -idDisplays the unique IDs associated with the targeted permissions in additionto other information. IDs are prefixed with a percent sign (%).

Tips: You can combine this option with the -l | --long and -A | --attributeoptions.

-l | --longDisplay detailed information about each permission.

This option lists these attributes for each permission:v PermissionIdv Namev Categoryv IsHidden

-p | --permission {permission_id_string |permission_name}[,{permission_id_string | permission_name }...]

Specifies one or more valid permissions.

This list can be a mixture of names and IDs, separated by commas.


Tips:




Tips:



-s | -sortSorts the output by the first attribute displayed in each row. Each row ispreceded by the name of the permission.

-u | --user user_nameDisplays permissions for the specified user.



Exit status




v 10: The file was not found.v 27: A specified attribute is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: The specified user was not found.v 54: A specified permission was not found.v 59: The specified category was not found.

Examples1. List all permissions

This command illustrates how to list all permissions in IBM Systems Director.smcli lsperm

2. List details of a permissionThis example illustrates how to list all attributes for the permission"engine.secureclients."smcli lsperm -l %engine.secureclients

3. Display permissions for specified userThis example illustrates how to display the permissions for user "Guest."smcli lsperm -u Guest

4. Filter permissions of a specified user based on a specified categoryThis example illustrates how to filter the permissions for user "Guest" based oncategory "Security."smcli lsperm -u Guest -c Security

5. List all permission categories.smcli lsperm -c all

lsrole commandUse the lsrole command to list the roles in IBM Systems Director.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsrole options


smcli lsrole [-h | -? | --help]

smcli lsrole [-v] [-d delimiter] [-o | -p] [-A attribute_list [-s] | -l ][-f file_name | -w query | [-r] role_list]

Description

If no options are specified, this command lists all roles. If no display options arespecified, only the role name is displayed.

Operands

This command uses a list of roles as an operand. The list can optionally bepreceded by the -r | --roles option.


Flags




Tips:

v Separate the keys with commas.v The attributes and attribute values are not locale specific.v You can use the lsrole -l command to list all attributes associated with the

targeted systems.

You can specify any of the following attribute keys.


DisplayName string Name of the role.

Description string Description of the role.

IsDefaultRole string A flag indicating whether the role is the default role. Possible values aretrue if the role is the default and false if the role is not the default.

IsSystemDefinedRole string A flag indicating whether the role was defined by the system. Possiblevalues are true if the role was defined by the system, and false if the rolewas not defined by the system.

Permissions string List of permissions for this role.







v If you specify this option with the -l | --long option, the delimiter option isignored.

v If the delimiter is a semicolon (;), single quote ('), or a double quote ("), youmust prefix the delimiter with a backslash (\).




The input data must contain one or more valid IBM Systems Director roles.This list can be a mixture of names and IDs, separated by commas or linebreaks.




Tips:



-l | --longDisplay detailed information about each role.

This option lists these attribute for each role:v DisplayNamev Descriptionv IsDefaultRolev IsSystemDefinedRolev Permissions

-o | --oidDisplays the unique IDs associated with the targeted roles in addition to otherinformation. IDs are displayed as hexadecimal values, prefixed with 0x (forexample, 0x3e)

Tips:


options.

-p | --pipeDisplays only the unique IDs for the targeted roles instead of the name. IDsare displayed as hexadecimal values, prefixed with 0x (for example, 0x37).

Tips:

v IDs are displayed as hexadecimal values, prefixed with 0x (for example,0x37).



options.

-r | --role {role_name| role_oid}[,{role_name| role_oid}...]Targets one or more valid IBM Systems Director roles, specified by name orIDs.


The list can be a mixture of names and ID, separated by a comma. The list isdelimited by the end-of-line character when read from a file.



role_nameThe name of a role. If the name contains a comma, prefix the comma witha backslash (\). If the member name contains space characters, enclose it inquotation marks.

Tips:

v Use lsrole -A to list the descriptions.v The role names are not locale specific.

-s | -sortSorts the output by the first attribute displayed in each row. Each row ispreceded by the name of the role.



-w | --where "string"Targets one or more systems based on system attributes specified by string andlists systems based on the attributes.

string is a SELECT statement that uses the following format:"key1=value1 [{AND | OR} key2=value2 [{AND | OR}key_n=value_n...]"

Note: Value is case-sensitive.

Enclose the SELECT statement in double quotation marks. If a value includesspaces, enclose the strings in single quotation marks.

System attributes might not be unique. Use the lssys -l command to list theavailable system attributes.

Tips:

v Use logical operators AND or OR to combine attributes.v Use parentheses to create nested logical constructs.v Only system attributes can be specified. Use the lssys -l command to list


Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.


||

|

|

|

||

v 29: The specified locale is not valid or not supported.v 52: A specified role was not found.

Examples1. List all roles

This command illustrates how to list all roles in IBM Systems Director.smcli lsrole

2. List all attributes for a roleThis example illustrates how to list all attributes for the role All Groups Role.smcli lsrole -l "All Groups Role"

lsuser commandUse the lsuser command to list users.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsuser options


smcli lsuser [-h | -? | --help]

smcli lsuser [-v] -f file | -u user_list | -w string [-d symbol] [-o | -p][-A attribute_list [-s] | -l] [-x timeout] [-r role_list]

Description

The lsuser command lists the users that are authorized for access. If no displayoptions or operands are specified, this command lists all currently defined users. Ifno display options are specified, then only the user name is displayed.

Note: To display the version of the lsuser man page on the AIX platform, enter"man user.lsuser". If you enter "man lsuser" on AIX, the AIX operating systemlsuser command man page is displayed instead of this lsuser man page.However, on Linux, entering "man lsuser" displays the IBM Systems Directorlsuser man page.

Operands

This command optionally takes a user list as an operand. The user list also can bepreceded by the -u | --users option.

Flags




Tips:












-f | --file fileSpecifies a standard input pipe or a file that contains a list of users to target.Specify either the fully qualified name of the input file or a dash (-) to indicatethat the data is read from the standard input pipe. If specifying a file, ensurethat each item in the file is separated by a line break.




Tips:



-l | --longSpecifies that the output is displayed in the following format:<user>

attribute1_name: attribute1_valueattribute2_name: attribute2_valueattribute3_name: attribute3_valueattribute4_name: attribute4_value

Note: When specified with just the -v option, all applicable user propertiesand their descriptions are listed.


-o | --oidSpecifies that the object ID is displayed in addition to other information.

The -o option can be used with the -l and -A options.

-p | --pipeSpecifies that only the object ID is displayed.

Tips:




options.

-r | --roles role1[,role2,...]Targets the users that are assigned the listed role or roles.



-u | --users user_listTargets the users specified in a list of user names or object IDS.

Note: If LDAP is configured, both local and LDAP users are shown. Duplicateusers are shown as just one. The properties of the duplicate user is acombination of property values from both LDAP and the operating system ifthis user has never authenticated.



-w | –-where stringTargets one or more users based on attribute values specified in a selectstatement.

-x timeoutSpecifies, in seconds, the length of time before a user's SSH session is timedout. Valid values are 0, which specifies no SSH timeout, or any positive integer.

Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.


v 50: A user was not found.

Examples1. List all authorized users

This example illustrates how to list all users who are authorized for access.smcli lsuser

2. List all attributes for the users specified in a fileThis example illustrates how to list all attributes for users specified in the/tmp/users file.smcli lsuser -l -f /tmp/users

3. List specific attributes for a userThis example illustrates how to list the value of the AssignedRoles attribute foruser “Guest”.smcli lsuser -A AssignedRoles Guest

Guest: {’role1’ applied to ’group1’, ’group2’}, {’role2’}

4. List specific attributes and user ID for a userThis example illustrates how to list the value of the AssignedRoles attributeand the user ID for user “Guest”.smcli lsuser -o -A AssignedRoles Guest

Guest, 0xffffffffffffffe2: {[’role1’, 0xffffffffffffffef] applied to[’group1’, 0xfffffffffffffe3e], [’group2’, 0xfffffffffffffe4e]},{[’role2’, 0xfffffffffffffff0] applied to <ALL GROUPS>}

lsusergp commandUse the lsusergp command to list the IBM Systems Director user groups.

Syntax

smcli lsusergp [-h | -? | --help]


smcli lsusergp [-v] [-d symbol] [-o | -p] [-A key_1,key_2,...key_n [-s] |-l] [-f file_name |[ -U] list | -w string]

Description

The lsusergp command lists the user groups authorized to access IBM SystemsDirector. If no options or operands are specified, the command lists all currentlydefined user groups. If no display options are specified, then only the user groupname is displayed.

Operands

This command uses a list of user groups as an operand. The list can optionally bepreceded by the -U | --usergroup option.

Flags





Tips:




-d | --delimiter symbolSpecifies the character or set of characters that separates data sets:v Used with no options, -o | --OID, or -p | --pipe: By default, IBM Systems

Director uses a line break to separate individual data sets, for example, thedata returned for a specific resource. When you issue the -d option, the linebreak is replaced by the character or set of characters specified. Theindividual items in each data set, for example, the resource name and OID,remain separated by commas followed by spaces.

v Used with -A | --attribute: By default, IBM Systems Director uses aseparate individual data sets, for example, the data returned for a specificresource. Within each data set, IBM Systems Director uses a comma followedby a space to separate subdata sets, for example, the values returned forspecific resource attributes. When you issue the -d | -–delimiter symboloption, the comma followed by a space is replaced by the character or set ofcharacters specified. The individual items in each subdata set, for example,the resource names, remain separated by commas followed by spaces.

v If you specify this option with the -F | -–format or -l | -–long option, thedelimiter option is ignored.

-f | --file fileTargets user groups specified in a file or the standard input pipe. The file mustbe one of the following types:v Specify the fully qualified name of the input file.v Specify a hyphen (-) instead of a file name. The data is read from the





Tips:




-l | --longSpecifies that the output is displayed in the following format:

This option lists these attributes for each user group:v ResourceType: <string>v DisplayName: <string>v Description: <string>v AssignedRoles: <AssignedRole1 applied to <<ALL GROUPS>>,

AssignedRole2 applied to Group2...v Members: <member1,member2,...>

-o | --oidLists the object IDs (OIDs) in addition to other information. The -o option canbe used with the -l and -A options.

-p | --pipeLists only the object IDs (OIDs). The resource name is not displayed. The -poption can be combined with the -l and -A options.

-s | --sortSorts the output by the first attribute displayed in each row. Each row ispreceded by the name of the user group.

-U | --usergroup listTargets the specified user groups.



-w | --where stringTargets user groups based on user group attribute values specified in thestring. Attributes AssignedRoles and Members cannot be used in select string.

In select string, the attribute value should be enclosed with single quotationmarks. For example, "ManagedAsGroup=’false’".

Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 51: A user group was not found.

Examples1. List all user groups

This example illustrates how to list all user groups in IBM Systems Director:smcli lsusergp

2. List all attributes for users in a user groupThis example illustrates how to list all attributes for the users in the “RemoteDesktop Users” user group.


smcli lsusergp -l "Remote Desktop Users"

3. List an attribute for a user groupThis example illustrates how to list the AssignedRole attribute for the “Guest”user group.smcli lsusergp -A AssignedRoles Guests

The output is similar to the following: Guests: {’role1’ applied to ’group1’,’group2’}, {’role2’}

mkrole commandUse the mkrole command to create roles that contain a list of permissions forauthorization to access IBM Systems Director.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkrole options


smcli mkrole [-h | -? | --help]

smcli mkrole [-v] {-f file_name | -p permission_list new_role_name}

Description

This command creates new user defined roles comprising a list of permissions. Youcan create roles with different permission types.

Operands

This command uses a new role name as an operand. The new_role_name creates anew role with the specified name.

Tips:

v This name must be unique.v If the name contains a comma, prefix the comma with a backslash (\). If the

member name contains space characters, enclose it in quotes.v IBM Systems Director assigns a unique ID to the role. Use the lsrole -o

role_name command to list the ID.

Flags





The input data must contain one or more valid IBM Systems Director rolenames and permission lists.

The input data must contain one or more records which are separated bycommas or line breaks. Each record in the input data specifies the role nameand list of permissions. This list of permissions can be a mixture of names andIDs, separated by commas. The role name and list of permissions are separatedby colons. The following example shows the format of each record.role_name:permission_list




Tips:



-p | --permission {permission_id_string |permission_name}[,{permission_id_string | permission_name }...]

Specifies one or more valid permissions.

This list can be a mixture of names and IDs, separated by commas.


Tips:




Tips:






Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 53: The specified role name already exists.v 54: A specified permission was not found.

Examples1. Create a new role with a permission

This example illustrates how to create a new role named “newmanager” withthe permission “partition_create”.smcli mkrole -p %partition_create newmanager

Note: To see a list of valid permissions, use the smcli lsperm command.2. Create a new role with multiple permissions

This example illustrates how to create a new role named “newmanager” withthe permissions “partition_create” and “partitions_manage”.smcli mkrole -p %partition_create,%partitions_manage newmanager

Note: To see a list of valid permissions, use the smcli lsperm command.

revokecert commandUse the revokecert command to invalidate certificates in an IBM Systems Directorkeystore or truststore.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] revokecert options


smcli revokecert [-h | -? | --help]

smcli revokecert [-v] [-F] -a alias_name | -f certid _filename -ttarget_store

Description

The revokecert command designates specified certificates in an IBM SystemsDirector keystore or truststore as invalid, which turns them into revokedcertificates. This is a temporary revoke; the certificate is not being revoked. Therevokecert command should only be used from the IBM Systems Director side andmark the certificate in the store as a temporarily revoked. Revoked certificates areapplicable only to Integrated Management Module events and ChassisManagement Module endpoints.


Flags



-F | --forceSpecifies to not prompt you while taking the action of the command.




Example: 43214321535321532 CA1




Tips:







Exit status


are not authorized to perform the action.v 10: The file was not found.


v 51: A certificate with the specified alias name does not exist in the specifiedkeystore or truststore.

v 61: The certificate invalidation task failed.v 65: A certificate with the specified serial number and issuer name does not exist


Examples1. Invalidate a certificate in a keystore

This example illustrates how to invalidate the certificate with alias name“cert1” in a keystore.smcli revokecert -a cert1 -t key

2. Invalidate a certificate in a truststoreThis example illustrates how to invalidate the certificate with alias name“cert1” in a truststore.smcli revokecert -a cert1 -t trust

3. Invalidate a certificate in a truststore without a promptThis example illustrates how to invalidate the certificate with alias name“cert1” in a truststore and not receive a prompt to confirm the invalidation.smcli revokecert -a cert1 -t trust -F

4. Invalidate a specific certificate from a truststore based on serial number andissuer nameThis example illustrates how to invalidate a certificate from the truststore basedon serial number and issuer name in a file “c:\certid.properties”.smcli revokecert -t trust -f

rmauditlogs commandUse the rmauditlogs command to remove the audit log for one or more auditcategories.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmauditlogs options


smcli rmauditlogs [-h | -? | --help]

smcli rmauditlogs [-a] [-c category_names]

Description

The rmauditlogs command deletes either all the audit logs or the audit logscorresponding to a particular category. The audit logs can be directly deleted usingthe options provided from the IBM Systems Director persistence store. Otherwise,you will need to confirm whether the audit logs can be deleted.

Note: The command also deletes audit logs from the syslog server that has beenconfigured.


||||

||

Flags


-aSpecifies to delete one or more audit logs without asking for confirmation.

-c category_name [, category_name...]Specifies the audit categories for which the audit log is to be deleted. Eachcategory_name is separated by a comma.




Tips:



Exit status



Examples1. Remove all audit logs after confirmation

This example illustrates how to remove audit logs for all audit categories witha prompt to confirm removal before the audit log is deleted.smcli rmauditlogs

2. Remove all audit logs with no confirmationThis example illustrates how to remove audit logs for all audit categorieswithout a prompt to confirm removal before the audit log is deleted.smcli rmauditlogs -a

3. Remove the audit log for a specific audit categoryThis example illustrates how remove the Security audit log.smcli rmauditlogs -c Security


|

rmcert commandUse the rmcert command to remove certificates from an IBM Systems Directorkeystore or truststore.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmcert options


smcli rmcert [-h | -? | --help]

smcli rmcert [-v] [-F] -f certid _filepath | -a alias_name -t target_store

Description

The rmcert command removes available certificates from an IBM Systems Directorkeystore or truststore based on the specified alias or serial number and issuername. Unless you specify -F to force the deletion, you are prompted to confirm theaction before any certificates are removed.

Flags






Tips:








Example: 43214321535321532 CA1





Exit status



keystore or truststore.v 53: The certificate with the specified alias name could not be deleted.v 65: A certificate with the specified serial number and issuer name does not exist


Examples1. Remove a specific certificate from a keystore

This example illustrates how to remove the certificate with the alias namecert1 from a keystore.smcli rmcert -a cert1 -t key

2. Remove a specific certificate from a truststore and not receive a promptThis example illustrates how to remove the certificate with the alias namecert1 from a truststore and not receive a prompt to confirm the deletion.smcli rmcert -F -a cert1 -t trust

3. Remove a specific certificate from a truststore based on serial number andissuer name.This example illustrates how to remove a certificate from truststore based onserial number issuer name passed in a file “c:\cert1.pem”.smcli rmcert -t trust -f

rmcred commandUse the rmcred command to remove credentials for systems managed by IBMSystems Director.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmcred options


smcli rmcred [-h | -? | --help]


smcli rmcred [-S Director_user] {[[-i IPaddress] [-n host_name] [-rrsap,[rsap...]] | [-t target_id] | [-a]}

Description

The rmcred command removes credentials for systems managed by IBM SystemsDirector.

Flags


-a Specifies to remove all credentials to which the user is currently mapped. If theuser belongs to the SMAdministrator role, all credentials for all systems will beremoved.




Tips:



-i IPaddress [,IPaddress...]Specifies to remove the credentials for the specified IP address.

-n hostname [,hostname...]Specifies to remove the credentials for the specified host name.




-t target_ID [,target_ID...]Specifies to remove the credentials for the specified remote service accesspoint.


Exit status



Examples1. Remove all credentials

This example illustrates how to remove all credentials to which the user ismapped. If the user belongs to the SMAdministrator user role, this exampleremoves all credentials.smcli rmcred -a

2. Remove credentials for one or more IP addressesThis example illustrates how to remove the credentials for two IP addresses,9.124.29.152 and 9.124.33.174.smcli rmcred -i 9.124.29.152,9.124.33.174

3. Remove credentials for one or more remote service access pointsThis example illustrates how to remove the credentials for two remote serviceaccess points, https://9.124.111.64:22/ and https://9.126.88.222:22/.smcli rmcred -r https://9.124.111.64:22/,https://9.126.88.222:22/

4. Remove credentials for one or more specified target identity IDsThis example illustrates how to remove the credentials for two target identityIDs, 5A4066582C563AFF9976F80C54C0931D andDD6A3F6008553876A883E40F5363B8BA.smcli rmcred -t 5A4066582C563AFF9976F80C54C0931D,DD6A3F6008553876A883E40F5363B8BA

5. Remove credentials to which a user is mapped using a user belonging to theSMAdministrator roleThis example illustrates how to remove the credentials to which a user ismapped from a user belonging to the SMAdministrator role. In this example:

testuser is the user_ID

9.124.29.152 and 9.124.33.174 are the IPaddress valueshttps://9.124.111.64:22/ and https://9.126.88.222:22/ are the rsapvalues

smcli rmcred -S testuser

smcli rmcred -S testuser -i 9.124.29.152,9.124.33.174

smcli rmcred -S testuser -r https://9.124.111.64:22/,https://9.126.88.222:22/

rmrole commandUse the rmrole command to delete roles.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmrole options



smcli rmrole [-h | -? | --help]

smcli rmrole [-v] {-f file_name | [-r] role_list}

Description

Use this command to delete one or more user roles.

Note: If you delete a parent role, the association between the parent role and childroles is removed. The parent attribute of the child roles is reset. However, the childroles are not deleted.

Operands

This command uses a list of roles as an operand. The list can optionally bepreceded by the -r | --role option.

Flags




The input data must contain one or more valid IBM Systems Director roles.This list can be a mixture of names and IDs, separated by commas or linebreaks.




Tips:



-r | --role {role_name| role_oid}[,{role_name| role_oid}...]Targets one or more valid IBM Systems Director roles, specified by name orIDs.





role_nameThe name of a role. If the name contains a comma, prefix the comma witha backslash (\). If the member name contains space characters, enclose it inquotation marks.

Tips:

v Use lsrole -A Description to list all the descriptions.v The role names are not locale specific.



Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 52: A specified role was not found.

Examples1. Delete a role

This example illustrates how to delete the role named “dbAdmin.”smcli rmrole dbAdmin

2. Delete multiple rolesThis example illustrates how to delete the roles named “dbAdmin” and “role1”.smcli rmrole dbAdmin,role1

rmusergp commandUse the rmusergp command to remove a user group's access authorization or toremove a user group.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmusergp options


smcli rmusergp [-h | -? | --help]

smcli rmusergp [-v] -f file | -g group_name [-r [-F]]


Description

Users with administrative role (SMAdministrator) can use this command to deleteuser groups or the access authorization for that user group.

Notes:

v You cannot remove authorization for the smadmin group.v You cannot delete predefined system groups such as root, sysadmin, users, or

db2iadm1.

Operands

The rmusergp command takes a list of user groups, optionally preceded by the -goption, as an operand.

Flags


-f | --file fileSpecifies a standard input pipe or a file that contains a list of user groups totarget.

Tip: When creating the list of user groups in this file, separate the groupnames using line breaks.


-g | --group group_nameSpecifies the name of the user group or groups to target.




Tips:



-r | --remove group_nameDeletes the specified user group or groups. If -r is not specified, authorizationis removed for the user group but the group is not removed.




Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 51: A specified user group was not found.

Examples1. Remove authorization for a user group

This example illustrates how to remove access authorization for the user groupnamed “Guests”.smcli rmusergp -g Guests

2. Remove a user groupThis example illustrates how to remove the user group named “Guests”.smcli rmusergp -g Guests -r

unrevokecert commandUse the unrevokecert command to revalidate revoked certificates in an IBMSystems Director keystore or truststore.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] unrevokecert options


smcli unrevokecert [-h | -? | --help]

smcli unrevokecert [-v] [-F] -a alias_name | -f certid _filename -ttarget_store

Description

The unrevokecert command designates specified revoked certificates in an IBMSystems Director keystore or truststore as valid again, which turns them intounrevoked certificates. The unrevokecert command should only be used from theIBM Systems Director side to mark an unrevoked certificate.

Flags








Example: 43214321535321532 CA1




Tips:







Exit status



keystore or truststore.v 65: A certificate with the specified serial number and issuer name does not exist

in the specified keystore or truststore.v 71: The certificate revalidation task failed.

Examples1. Revalidate a revoked certificate in a keystore


This example illustrates how to revalidate the revoked certificate with aliasname “cert1” in a keystore.smcli unrevokecert -a cert1 -t key

2. Revalidate a revoked certificate in a truststoreThis example illustrates how to revalidate the revoked certificate with aliasname “cert1” in a truststore.smcli unrevokecert -a cert1 -t trust

3. Revalidate a revoked certificate in a truststore without a promptThis example illustrates how to revalidate the revoked certificate with aliasname “cert1” in a truststore and not receive a prompt to confirm therevalidation.smcli unrevokecert -a cert1 -t trust -F

4. Revalidate a specific revoked certificate in a truststore based on serial numberand issuer name.This example illustrates how to revalidate the revoked certificate in a truststorebased on serial number and issuer name passed in a file “c:\certid.properties”.smcli unrevokecert -t trust -f

Status commandsUse the commands in this section to monitor the status of systems.

smcli commands

The following smcli status commands are available:

chled commandUse the chled command to modify the light-path-diagnostic LED attributes on oneor more systems. You can change the status and polling interval.

Important: This command is supported only by IBM BladeCenter servers andSystem x servers and chassisPower Systems compute nodes and X-Architecturecompute nodes.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chled options


smcli chled [-h | -? | --help]

smcli chled [-v] {-p minutes | -s {off} -l led_list} {-f file_name | -iip_address_list | -N group_list | [-n] system_list}

Description

Note: To display the Systems Director Management Console version of the chledman page, enter "man dpms.chled". If you enter "man chled", theIBM SystemsDirector chled command man page is displayed instead of the Systems DirectorManagement Console chled man page.


Tip: To change the state of the locator LED on a specific system, use the runtaskcommand to run one of these tasks:

Task name Task ID string Description

Led On %BlueLight_ON Turns the locator LED on.

Led Blink %BlueLight_BLINK Causes the locator LED to flash.

Led Off %BlueLight_OFF Turns the locator LED off.

Operands


Flags








Tips:






Tips:





Tips:




-l | --led {led_name}[,led_name...]Changes the state of one or more light-path-diagnostic LEDs, separated by acomma. If the LED name contains spaces, enclose it in quotation marks.

Tips:

v Use the lsled command to obtain a list of valid LED names.v The -s | --state option must be specified with this option.v This option cannot be used with the -p | --polling option.







Tips:


v Use the lssys command without any options to list all system names.





Tips:






Tips:


-p | --polling minutesStarts polling the light-path-diagnostic LED status on the targeted systems atthe specified interval, in minutes.

If the polling interval is set to 0, LED status it not polled.

Tips:

v You can use the lsled -p command to find the current polling interval.v This option cannot be used with the -s | --state or -l | --led options.

-s | --state {off}Turns off the specified light-path-diagnostic LEDs on the targeted systems.

Tip:

v The -l | --led option must be specified with this option.v This option cannot be used with the -p | --polling option.



Exit status




v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 301: The specified LED state was not found.v 302: The specified LED was not found.

Examples1. Turn off an LED on multiple systems

This example illustrates how to turn off the processor LED on all servers in thegroup named group1.smcli chled -s off -l CPU -N group1

2. Turn off multiple LEDs on a systemsThis example illustrates how to turn off the Fault and Info LEDs on the chassiswith ID x078.smcli chled -s off -l Fault,Info -n 0x78

3. Start polling the LED statusThis example illustrates how to poll the LED status on all discovered systemsevery 3 minutes.chled -p 3 -N "All Systems"

4. smcli5. Stop polling the LED status

This example illustrates how to stop polling the LED status on a system namedsystem_1.smcli chled -p 0 system_1

lsled commandUse the lsled command to list light path diagnostic LED status on one or moresystems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsled options


smcli lsled [-h | -? | --help]

smcli lsled [-v] {-p | {-s state_list} {-f file_name} | -i ip_address_list| -N group_list | [-n] system_list}

Description

Important: This command is supported only by IBM BladeCenter servers andSystem x servers and chassis.


Note: To display the Systems Director Management Console version of the lsledman page, enter "man dpms.lsled". If you enter "man lsled", theIBM SystemsDirector lsled command man page is displayed instead of the Systems DirectorManagement Console lsled man page.

Operands


Flags








Tips:






Tips:





Tips:










Tips:





Tips:







Tips:


-p | --pollingDisplays the current polling interval on the targeted systems.

Tip: If the polling interval is 0, LED status is not being polled.

-s | --state {state}[,state...]Lists light path diagnostic LEDs on the targeted systems that are in one ormore specified states, separated by a comma. You can specify any of thesestates:v flash - Lists LEDs that are blinking.v on - Lists LEDs that are on.v off - Lists LEDs that are off.v all - Lists LEDs that are in any state.



Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.

Examples1. List all LEDs that are flashing

This example illustrates how to list the status all LEDs that are currentlyflashing on all discovered systems.smcli lsled -s flash -N "All Systems"

2. List status of all LEDs on a systemThis example illustrates how to list the status of all LEDs on the system namedsystem1.


smcli lsled -s flash,on,off -n system1

3. Display the LED-status polling interval multiple systemsThis example illustrates how to list the LED-status polling interval on allsystems in the group named group1.smcli lsled -p -N group1

lsstatus commandUse the lsstatus command to list the status information for a specified category ofsystems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsstatus options


smcli lsstatus [-h | -? | --help]

smcli lsstatus [-v] [-o | -p] [-l] [-t system_type] [-c category] [-Fformat] [-f file_name | -w query | -i ip_address_list | -N group_list |[-n] system_list]

smcli lsstatus [-v] [-D]

Description

If no options are specified, this command lists the status of all systems in thespecific category. If no categories are specified, this command lists the status of allcategories.

Operands

This command uses a list of systems as an operand. The list can optionally bepreceded by the -n | --names option.

Flags


-c | --category categoryLists the status of the specified category.

Tip: You can use the lsstatus -D command to list the available categories.

-D | --displayLists the available categories. The available categories are dynamic and varybased your environment.




The input data is the list of systems. This list can be a mixture of names andIDs, separated by a comma or end-of-line character.

-F | --format [xml ]Displays the output in XML format. The output can be used as input to othercommands or processed by scripts.

The format of the XML file is:<Status>

<ManageableEndpoint name="" ipaddress=""><ManageableComponent name="">

<Category name=""><attribute name="" value=""/>

</Category></ManageableComponent>

</ManageableEndpoint></Status>

Tip: Multiple <attribute> tags are listed if an attribute has more than onevalue (for example, an attribute with a data type of stringarray).




Tips:






Tips:



host_nameEither the host name or the host name and Domain Name System (DNS)


suffix of the system. If the host name contains spaces, enclose it inquotation marks. If it contains a comma, prefix the comma with abackslash (\).

Tips:




-l | --longDisplays detailed status information.

This option returns these attributes for each system:v System Namev UpdateComplianceStatusv Severity







Tips:





Tips:







Tips:


-o | --oid


Tip:

v This option cannot be used with the -p | --pipe option.v You can combine this option with the -l | --long option.

-p | --pipe


Tip:


v This option cannot be used with the -o | --oid options.v You can combine this option with the -l | --long option.




Tips:










Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: An error occurred because one or more targeted systems are an Agentless

managed system systems.

Examples1. List compliance status of a system

This example illustrates how to list the compliance status of the system namedsystem1. The system ID, category ID, status ID and severity are displayed.smcli lsstatus -c ComplianceStatus -n system_1

system_1 (22F),ComplianceStatusCategory,Fatal, 0

2. List status of all systemsThis example illustrates how to list number of systems with critical errors,warning errors, and without errors.smcli lsstatus -l

MEP ID:105MEP NAME:CS9.56.79.134HardwareStatusCategory Severity: 0HardwareStatusCategory Status ID: FatalHardwareStatusCategory Category: HardwareStatusCategoryMEP Details: generated fatal fan event


MEP Events: Status Set FATAL_SS_NAME

MEP ID:105MEP NAME:CS9.56.79.134ComplianceStatusCategory Severity: 0ComplianceStatusCategory Status ID: FatalComplianceStatusCategory Category: ComplianceStatusCategoryMEP Details: generated fatal fan eventMEP Events: Status Set FATAL_SS_NAME

3. List systems in critical conditionThis example illustrates how to list systems on which one or more criticalevents have occurred.smcli lsstatus -N "Hardware Status Critical"

4. List available categoriesThis example illustrates how to list status categories that are currentlyavailable.smcli lsstatus -D

Storage commandsUse the commands in this section to configure certain aspects of a storage areanetwork (SAN).

Tips:

v To discover, add, remove, and list information about storage systems, use thesystem commands.

v The storage commands are supported on servers based on Intel (such as Systemx), IBM Power systems, and System z servers running Linux.


smcli commands

The following smcli storage commands and command groups are available:

Storage-configuration settingsDefault storage-configuration values are defined in the SSPTSetting.xml file. Youcan optionally configure these values.

The SSPTSetting.xml file is located in the install_root\director\data directory,where install_root is the root directory of your IBM Systems Director installation.Note that this path uses the backslash (\) to delimit the directory; depending onthe system that you are using, you might be required to enter the path using theforward slash (/). The file is fully commented and can be modified using a texteditor.

Tips:

v Do not use the following characters in this file:ampersand (&)greater than symbol (>)less than symbol (<)backslash (\)quotation mark (")


v If you change settings in this file, you must restart IBM Systems Director Server.

The default values specified in this file are listed in the following table.

Configuration setting Description Default value

<FabricInstallZoneName> Sets the prefix for the zone name, which isused when installing operating systems.

Because the Windows installer is notmultipath-enabled, a special installation zoneis created to eliminate multiple paths duringinstallations. The zone name prefix can beconcatenated with the storage-portworldwide number (WWN) to create aunique zone name (for example,DirectorInstallZone_2000000001020304).

DirectorInstallZone

<FabricNumberOfZones> Specifies the number of Fibre Channel zonesthat can be created. The number of zonesdoes not affect the operational behavior ofyour fabric.

This value must be an integer with a valueof 1 - 16. Values greater than 16 areinterpreted as 16.

16

<FabricZoneName> Specifies the default zone name. Zone namescan be concatenated with the zone nameindex and switch WWN on which they arecreated to create a unique zone name, (forexample, DirectorZone_0_2000000001020304).

DirectorZone

<FabricZoneSetName> Specifies the zone-set name to be used ifboth of the following conditions are met:v No active zone set is found in the fabric.v The value of <FabricZoningEnabled> is

true.

Otherwise, <FabricZoneSetName> is ignored.

DirectorZoneSet

<FabricZoningEnabled> Defines the behavior when no active zone setis found in the fabric, using the followingrules:v If the value is true and no active zone set

is found in the fabric, a zone set is createdand activated using the value of<FabricZoneSetName>. This setting isrelevant when the fibre channel switch isbeing initialized for the first time.

v If the value is false and no active zone setis found, no zoning operations areperformed. This setting is useful if youhave a configured SAN that you decidedto operate without zoning.

If an active zone set already exists in thefabric, <FabricZoningEnabled> is ignored.

false

<HostGroupName> Specifies the default host group name.Tip: The name can contain onlyalphanumeric characters, underscores, andhyphens.

Director_Group



<PoolAllocationPolicy> Specifies one of two pool allocation policiesto be implemented when an array or pool oflogical devices must be created on thenetwork-storage system:v MINIMAL: The minimal number of physical

devices needed for the requested RAIDlevel will be used.

v MAXIMAL: The maximum possible numberof devices will be used.

The actual number of physical devices usedmight vary from the minimum numberneeded for the requested Redundant ArrayOf Independent Disks (RAID) level to thenumber of devices available on thenetwork-storage system.

MINIMAL

<PoolNamePrefix> Specifies the default name of the new storagearray, if a new storage array must be createdwhile allocating a volume.Tip: For network-storage systems that donot support the naming of arrays,<PoolNamePrefix> is ignored.

DirectorPool

<UseOfDifferentSizedDevicesEnabled> Defines the behavior when an array or poolof logical devices must be created on thenetwork-storage system. IBM SystemsDirector attempts to use drives of the samesize if possible. When more devices areneeded to fill the requirements, the value of<UseOfDifferentSizedDevicesEnabled>determines the behavior:v If the value is true, different-size devices

are used to create a pool when necessary.v If the value is false, all pools of logic

devices contain devices of equal size.

false

<VolumeNamePrefix> Specifies the default volume prefix fornaming logical devices.

Logical volumes are named by concatenatingthe prefix with an integer, starting with 0 forthe first logical unit number (LUN) allocationto a specific storage system and increasingthe integer by 1 for each additional LUNallocation.Tip: The prefix can contain onlyalphanumeric characters, underscores, andhyphens.

DEV_

<VolumeSetting> Specifies the default RAID level for logicalvolumes.

You can specify one of the values for thevolume setting:v RAID0: Data striping without parity.v RAID1: Mirroring.v RAID3: Data striping with dedicated parity.v RAID5: Data striping with distributed

parity. This value is the default.

RAID5

<VolumeSize> Specifies the default volume size in MB. 1000



<VolumeType> Specifies the default volume type.

You can specify one of these values:v FC: Fibre Channelv SAS: Serial-attached Small Computer

Systems Interfacev iSCSI: Internet SCSI

FC

lsnspool commandUse the lsnspool command to list the storage pools on the target storagesubsystem. The optional attributes flag -A will take a list of volumes and onlyreturn the pools from where those volumes are allocated. The output will displaythe RAID type, available capacity, and name of the storage pool.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsnspool options


smcli lsnspool [-h | -? | --help]

smcli lsnspool -n system_name [-A attribute_list [-w query] [-f file_name][-i] [-N group_name] [-t system_type]

Flags




Tips:


v The attributes and attribute values are not locale specific.v You can use the lssys -llsuser -l command to list all attributes associated








Tips:






Tips:




Tips:











Tips:





Tips:






Tips:





Tips:










Tips:




Exit status



Examples1. Target systems that are not accessible

This example illustrates how to target systems that are not accessible:smcli lsnspool -w AccessState=Locked

2. Target systems with specific architectureThis example illustrates how to target systems with x86 or ppc64 architecture:smcli lsnspool-w "Architecture=x86 OR Architecture=ppc64"

3. Target instances that are accessible and have a specific architectureThis example illustrates how to target all OperatingSystem instances that areaccessible and have x86 or ppc64 architecture:smcli lsnspool -w "ObjectType=OperatingSystem AND (Architecture=x86 OR Architecture=ppc64)AND AccessState=Unlocked"

lsstpool commandUse the lsstpool command to display storage pools or storage system pools thatare accessible by the server or servers given.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsstpool options



smcli lsstpool [-h | -? | --help]

smcli lsstpool -n server_name [-u MB|GB|TB] [-z]

Description

Use lsstpool to display storage pools that can be accessed by the servers listed inthe command. A storage pool can be either a concrete storage pool in a storagesubsystem or a IBM Systems Director VMControl storage system pool. In order fora server to access a storage pool, both physical connectivity and zoning access arerequired. The -z option will display the zoning access with a value of Zoned orAvailable. Zoned refers to storage pools where the servers and storage subsystemsatisfy both physical connectivity and zoning requirements. Available indicates thatonly physical connectivity is satisfied and zoning is required. If the -z option isnot specified, only storage pools with Zoned access are displayed. Refer to themkstvol command for working with Available storage pools. In some cases, thelsstpool command might indicate the server does not have an accessible storagepool. When this happens, one or more of the following problems might be thecause:v Inventory is missing in the IBM Systems Director database. The lsstpool

command relies on the server, switch, and storage subsystem inventories todetermine the physical connectivity between server and storage subsystem in theSAN. The inventory is used to determine if a server's ports have been zoned todiscovered storage subsystems. See the "dumpstcfg" command fortroubleshooting.

v Hardware might be configured incorrectly. Verify that server and storagesubsystem physical connectivity in the SAN is correctly configured.

v Switch zoning might be configured incorrectly. Verify that the zoningconfiguration has the correct hard zoning configuration to allow server andstorage subsystem I/O paths.

Operands

None.

Flags





Tips:




-n | --name server_name[,server_name,...]Name, OID, or GUID one or more servers. If a display name or name propertyis used and results in multiple systems, then the OID or GUID must bespecified to avoid duplicates.

-u | --unitUnits for the storage pool size specified as MB, GB, or TB. Default is GB.



-z | --zoneDisplays the zone access state of the storage pools.

Exit status


are not authorized to perform the action.v 27: A specified attribute is not valid.v 125: Command terminated unexpectedly while executing.

Examples1. List accessible storage pools

This example lists pools accessible by both server1 and 0x23ab.smcli lsstpool -n server1,0x23ab

2. List storage pools accessible by server1 including zone access states.smcli lsstpool -n server1 -z

lsstvol commandUse the lsstvol command to list the volumes attached to given server or thevolumes of a storage subsystem.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsstvol options


smcli lsstvol [-h | -? | --help]

smcli lsstvol -n server_name [-l] [-u MB|GB|TB]


Description

The lsstvol command lists the volumes that are attached to a given server or thevolumes that have been allocated from a given storage subsystem.

Operands

None.

Flags





Tips:



-l | --longDisplay output in long format. This means for every volume additionalinformation will be displayed such as the storage pool and storage controller.

-n | --nameName, OID, or GUID of a server or storage subsystem. If a display name orname property is used and results in multiple systems, then the OID or GUIDmust be specified to avoid duplicates.



-u | --unitUnits for the storage volume size specified as MB, GB, or TB. Default is GB.

Exit status




Examples1. List volumes attached to server

This example illustrates how to list volumes attached to server 0x23ab:smcli lsstvol -n 0x23ab

2. List volumes attached to server in long formatThis example illustrates how to list volumes attached to server 0x23ab in longformat:smcli lsstvol -n 0x23ab -l

3. List volumes based on system nameThis example illustrates how to list volumes from storage subsystem IBMStorwize® V7000-4939:smcli lsstvol -n "Storwize V7000-4939"

lsdatasource commandUse the lsdatasource command to list and filter all data sources.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsdatasource options


smcli lsdatasource [-h | -? | --help]

smcli lsdatasource [-c category] [-t protocol] [-i ip_address] [-p port][-u user_id] [-v version] [-n interopNameSpace] [-k] [-m] [-o oid]

smcli lsdatasource -c svc [-i ip_address] [-v version] [-u user_id] [-k][-m] [-o oid]

smcli lsdatasource -c fabric [-i ip_address] [-p port] [-t protocol] [-uuser_id] [-n interopNameSpace] [-k] [-m] [-o oid]

smcli lsdatasource -c storage [-i ip_address] [-p port] [-t protocol] [-uuser_id] [-n interopNameSpace] [-k] [-m] [-o oid]

smcli lsdatasource -c ds8k [-i ip_address] [-u user_id]

smcli lsdatasource -c xiv [-i ip_address] [-u user_id]

Description

The lsdatasource command lists and filter all data sources. If the command is runwithout specifying any parameters, then all data sources will be listed. Filter thedata sources returned by the command by adding parameters to the command.

Flags


-c | --category ds8k | fabric | storage | svc | xivLists data sources for the type specified.


ds8k Includes native API-managed DS8000® family devices

fabric CIMOM- and SMI-S-managed Fibre Channel switches, such as aBrocade storage area network (SAN) switch.

storageCIMOM- and SMI-S-managed storage subsystems, such as IBM SystemStorage® .

svc Native API-managed SAN Volume Controller devices, including IBMStorwize V7000

xiv Native API-managed XIV® storage systems

Note: For a full list of supported storage devices, see the IBM SystemsDirector "Supported storage devices" topic.




Tips:



-i | --ipaddress ip_addressLists only data sources specified by the datasource IP address

-k | --formatmkcmdFormats the data sources as mkdatasource command lines.

-m | --formatrmcmdFormats the data sources as rmdatasource command lines..

-n | --namespace interopNameSpaceShows only the data sources specified by the namespace of the CIMconnection.

-o | --oid OIDShows only the data sources that manage this device OID.

-p | --port portShows only the data sources of the HTTP communication port of the CIMconnection. Typically, the port is 5988 or 5989.

-t | --protocol http | httpsShows only the data sources of the communication protocol of the CIMconnection.

-u | --userid user_idShows only the data sources specified by the user ID for the data sourceconnection.


-v | --version SVC4 | SVC5 | SVC6Shows only the data sources with the firmware version of the SAN VolumeController. The version of the firmware controls the type of credentials used forthe data source connection: SMI-S or SSH.

SVC4 SMI-S credentials.

SVC5 SSH credentials.


Exit status


are not authorized to perform the action.v 27: A specified attribute is not valid.

Examples1. List all managed data sources

This example illustrates how to list all the data sources managed by the storageFarm in the server.smcli lsdatasource

2. List all data sources by typeThis example illustrates how to list all data sources with the type fabric.smcli lsdatasource -c fabric

3. Show all the mkdatasource commands for the data sourceThis example illustrates how list all the mkdatasource commands for the datasources with the type of fabricsmcli lsdatasource -c fabric --formatmkcmd

mkdatasource commandUse the mkdatasource command to begin using IBM Systems Director StorageControl 4.2.6 to manage a data source, which is either a storage device, a storagesubsystem, or a Fibre Channel switch. These devices and subsystems include theDS8000 family, SAN Volume Controller devices including the IBM Storwize V7000,as well as the Brocade Fibre Channel switches.

Prerequisites

Before issuing this command, adhere to the following prerequisites:v Ensure that the private key file matches the uploaded public key file for either

SAN Volume Controller or IBM Storwize V7000.v If you are not using IBM DB2® managed by Systems Director, complete the

following steps to properly configure the database user group permissions toadd the IBM DB2 user ID to the admin group:1. View TPCHOME/config/InstallVariable.properties and obtain group

information for the varTPCSUGrp property.2. Using the supplied group information, define the group in the /etc/group

file on Linux or net localgroup Administrators on Windows.


Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkdatasource options


smcli mkdatasource [-h | -? | --help]

smcli mkdatasource [--noinventory]

smcli mkdatasource -c ds8k -i ip_address -u user_id -w password

smcli mkdatasource -c fabric -t protocol -i ip_address -p port -u user_id-w password -n namespace

smcli mkdatasource -c storage -t protocol -i ip_address -p port -u user_id-w password -n namespace

smcli mkdatasource -c svc -i ip_address -f file_name -v version [-rpass_phrase]

smcli mkdatasource -c xiv -i ip_address -u user_id -w password

Flags


-c | --category ds8k | fabric | storage | svc | xivSpecifies the device type of the data source.

ds8k Native API-managed DS8000 family devices


storageCIMOM- and SMI-S-managed storage subsystems, such as IBM SystemStorage DS6000™.

svc Native API-managed SAN Volume Controller devices, including IBMStorwize V7000.

xiv Native API-managed XIV storage systems

-f | --file file_nameSpecifies the file that contains the private SSH key for the SAN VolumeController connection.





Tips:



-i | --ipaddress ip_addressSpecifies the IPv4 address of the device.

--noinventorySpecify this option to prevent the inventory collection from runningautomatically with the mkdatasource command. If this option is not specified,inventory will be automatically collected.

-n | --namespace namespaceSpecifies the namespace of the CIM connection.

-p | --port portSpecifies the HTTP communication port of the CIM connection. Typically, theport is 5988 or 5989.

-r | --passphrase pass_phraseSpecifies the pass phrase to be used to decrypt the private SSH key for theSAN Volume Controller connection. The private SSH key can be protected(encrypted) by a pass phrase, optionally specified using this option.

-t | --protocol http | httpsSpecifies the HTTP communication protocol of the CIM connection.

-u | --userid stringSpecifies the user name for the device. This is a required parameter. If thisoption is not specified, the command prompts the user for a value.

-v | --version SVC4 | SVC5 | SVC6 | V7000Specifies the firmware version of the SAN Volume Controller. The version ofthe firmware controls the type of credentials used for the data sourceconnection: SMI-S or SSH.

SVC4 SMI-S credentials.



V7000 SSH credentials. V7000 is required for IBM Storwize V7000.

-w | --password stringSpecifies the password for the device. This is a required parameter. If thisoption is not specified, the command prompts the user for a value.

Exit status

The following codes are returned by this command.v 0: The operation completed.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you

are not authorized to perform the action.v non-zero: An error occurred.


Examples1. Add a storage subsystem

This example illustrates how to add a CIMOM-managed storage subsystem.smcli mkdatasource -c storage -t http -i 9.3.194.11 -p 5988 -u admin -w admin-n /interop

2. Add a Fibre Channel switchThis example illustrates how to add a CIMOM-managed Fibre Channel switch.smcli mkdatasource -c fabric -t http -i 9.3.194.11 -p 5988 -u admin -w admin-n /interop

3. Add a SAN Volume ControllerThis example illustrates how to add a native API for a SAN Volume Controllerusing a Linux key path.smcli mkdatasource -c svc -f /opt/ibm/ssh.acc -v SVC6 -i 9.3.194.11 -r phrase

4. Add an IBM Storwize V7000This example illustrates how to add a native API for an IBM Storwize V7000using a Windows key path.smcli mkdatasource -c svc -f c:\storwize_tpc.ppk -v V7000 -i 9.5.42.165

5. Add a DS8000 family deviceThis example illustrates how to add a native API for a DS8000 family device.smcli mkdatasource -c ds8k -i 9.3.194.11 -u admin -w admin

6. Add a XIV storage systemThis example illustrates how to add a native API for a XIV storage system.smcli mkdatasource -c xiv -i 9.3.194.11 -u admin -w admin

7. Add an HDS storage subsystemThis example illustrates how to add a HDS-managed storage subsystem.smcli mkdatasource -c storage -t http -i 9.114.44.88 -p 15988 -u system

-w manager -n /interop

mkstvol commandUse the mkstvol command to allocate and attach storage to servers in a fibrechannel SAN.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mkstvol options


smcli mkstvol [-h | -? | --help]

smcli mkstvol -n server_name [-P poolName] [-p volume_prefix] [-u MB|GB|TB][-s size] [-z zone]

Description

The mkstvol command is used for allocating a storage volume and attaching thestorage volume to one or more servers in a Fibre Channel SAN. The commandrequires that servers, switches, and storage systems be discovered and inventoried.


When the storage subsystem and server are not currently zoned together, thecommand can create new hard zones in the SAN. The storage pool or storagesystem pool must be accessible (reachable) by the server.

The attachment of the storage volume consists of LUN masking it to the serverand, if possible, discovering the volume on the server.

To create new zones, the user must have the "fabric/zoning" permission.

See the "lsstpool" command for displaying accessible storage pools and the zoneaccess states.

Operands

None.

Flags





Tips:



-l | --longDisplay output in long format. This means for every volume additionalinformation will be displayed such as the storage pool and storage controller.


-P | --poolNameDisplay long format of the display name, OID of a storage pool, or storagesystem pool.

-p | --prefixName for the new volume. To make a volume name unique, the index maybeappended. Name will be checked for invalid length and characters.



-s | --sizeSize for the storage volume in decimal format. The default value is 50.



-u | --unitUnits for the storage pool size specified as MB, GB, or TB. Default is GB.

-z | --zone zone_1[,zone_2,...]One or more zone names used for zone creation when the zone access state isAvailable.

The following conditions apply:1. Zone names must contain only alphanumeric characters or underscore

characters.2. Zone names must begin with a letter.3. Zone names must not exceed 64 characters in length.4. If multiple zone names are specified, the number of zones must match the

number of servers. Servers that currently are zoned to the storagesubsystem must be indicated by an empty entry. Examples of valid zonename arguments are:a. zone1 (means 1 new zone)b. zone1, (means 1 new zone and 1 existing zone)c. ,zone1, (means 2 existing zones and 1 new zone)d. zone1,, (means 1 new zone and 2 existing zones)

5. Specifying a zone name for a server that is already zoned results in afailure.

Exit status


are not authorized to perform the action.v 27: A specified attribute is not valid.v 28: The user does not have permission to create zones.v 125: Command terminated unexpectedly while executing.

Examples1. Create a volume and attach to a server

This example illustrates how to create a volume with default name and size 50GB and attach to server named server1 and server with OID 0x23ab:smcli mkstvol -n server1,0x23ab -P mdiskgrp0

2. Create a volume with a specific size, attach to a server, and create a new zone


This example illustrates how to create a volume of size 1.5 TB with name prefixvol and attach it to server named server1 and create a new zone namedserver1_vol.smcli mkstvol -n server1 -P mdiskgrp0 -p vol -s 1.5 -u T --zone server1_vol

Note: If no server information is displayed, it means that the volume wassimply allocated and LUN masked.

3. Create a volume, attach to a server, and use existing zone namesCreate a volume and attach it to server1, server2, and server3 using the zonenames of my_zone1 and my_zone3.smcli mkstvol -n server1,server2,server3 -P mdiskgrp0 -p vol -z my_zone1,,my_zone3

Note: Since server2 already belongs to a zone which includes the storagesubsystem containing mdiskgrp0, an empty entry is provided.

rmdatasource commandUse the rmdatasource command to stop using IBM Systems Director StorageControl 4.2.6 to manage a data source, which is either a storage device, a storagesubsystem, or a Fibre Channel switch.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmdatasource options


smcli rmdatasource [-h | -? | --help]

smcli rmdatasource -c ds8k -i ip_address

smcli rmdatasource -c fabric -t protocol -i ip_address -p port

smcli rmdatasource -c storage -t protocol -i ip_address -p port

smcli rmdatasource -c svc -i ip_address

smcli rmdatasource -c xiv -i ip_address

Flags


-c | --category ds8k | fabric | storage | svc | xivSpecifies the device type of the data source.

ds8k Native API-managed DS8000 family devices


storageCIMOM- and SMI-S-managed storage subsystems, such as IBM SystemStorage DS6000.


svc Native API-managed SAN Volume Controller devices, including IBMStorwize V7000.

xiv Native API-managed XIV storage systems




Tips:



-i | --ipaddress ip_addressSpecifies the IPv4 address of the device.

-p | --port portSpecifies the HTTP communication port of the CIM connection. Typically, theport is 5988 or 5989.

-t | --protocol http | httpsSpecifies the HTTP communication protocol of the CIM connection.

Exit status



Examples1. Remove a storage subsystem

This example illustrates how to remove a CIMOM-managed storage subsystem.smcli rmdatasource -c storage -t http -i 9.3.194.11 -p 5988

2. Remove a Fibre Channel switchThis example illustrates how to remove a CIMOM-managed Fibre Channelswitch.smcli rmdatasource -c fabric -t http -i 9.3.194.11 -p 5988

3. Remove a SAN Volume ControllerThis example illustrates how to remove a native API for a SAN VolumeController.smcli rmdatasource -c svc -i 9.3.194.11

4. Remove a DS8000 family deviceThis example illustrates how to remove a native API for a DS8000 familydevice.


smcli rmdatasource -c ds8k -i 9.3.194.11

5. Remove a XIV storage system

This example illustrates how to remove a native API for a XIV storage system.smcli rmdatasource -c xiv -i 9.3.194.11

rmstvol commandUse the rmstvol command to detach and remove a storage volume.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmstvol options


smcli rmstvol [-h | -? | --help]

smcli rmstvol -n volume_name

Description

The rmstvol command is used to detach and remove a storage volume. If thestorage volume is attached to one or more servers, an attempt to detach the storagevolume from the server or servers will be made. The storage volume is thenremoved from the corresponding storage subsystem, where it was previouslyallocated. See the "lsstvol" command for displaying available storage volumes fora server or storage subsystem.

Operands

None.

Flags





Tips:



-n | --name volume_nameName, OID, or GUID of the storage volume. If a display name or name


property is used and it results in multiple storage volumes, then the OID orGUID must be specified to avoid duplicates.

Exit status



Examples1. Delete a storage volume

This example illustrates how to delete a storage volume with OID 0x2d43:smcli rmstvol -n 0x2d43

rmstfrompool commandUse the rmstfrompool command to remove storage subsystems from an existingsystem pool of type storage.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmstfrompool options


smcli rmstfrompool [-h | -? | --help]

smcli rmstfrompool -n stsyspoolname -c controller_list

Description

The rmstfrompool command removes storage subsystems from an existing systempool of type storage.

Operands

None.

Flags





|

||

|

|

||

|

|

|

||

|

|

|

|||

||

||


Tips:



-n | --name displayNameSpecifies the display name of the storage system pool.

-c | --ctrl controller_listComma-separated names of storage subsystems to be removed from thesystem pool.

Exit status



Examples1. Remove a storage subsystem.

This example illustrates how to remove a storage subsystem named“MyNewSubsystem” from an existing system pool named “MyStSysPool”.smcli rmstfrompool -n MyStSysPool -c MyNewSubsystem

increasetimeout commandUse the increasetimeout command to modify the timeout configuration for IBMSystems Director and Storage Control timeout settings.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] increasetimeoutoptions


smcli increasetimeout [-h | -? | --help]

smcli increasetimeout -l level_number

Description

The increasetimeout command is used to modify the timeout configuration forIBM Systems Director and Storage Control timeout settings. The increasetimeout


||||

|

||

||

||

|||

|

||||||||

|

|

||

|

|

command can be used to modify the timeout configuration for multiple datasources.

Operands

None.

Flags





Tips:



-l | --level level_numberSpecifies the timeout level. Specified level ranges from 0 to 4. A smallernumber indicates a small timeout. A larger number indicates a large timeout.

Exit status

The following codes are returned by this command.v 0: The operation completed.v 1: A usage error occurred.v 2: The command or bundle was not valid.v 3: The user did not have permission to execute command.v 27: A specified attribute is not valid.v 120: The timeout configuration for the Storage Control probe was not set.v 121: The inventory timeout configuration for Systems Director was not set.v 122: The API execution timeout configuration for Storage Control was not set.

Examples1. Increase the timeout for IBM Systems Director and Storage Control.

This example illustrates how to increase timeout to the lowest timeout level 0.smcli increasetimeout -l 0

Network storage hosts commandsUse the smcli network storage hosts commands to list network storage hosts andedit properties.


smcli commands

The following smcli network storage host commands are available:

chnshost commandUse the chnshost command to change the Storage Area Network (SAN)configuration of one or more system hosts, or detach one or more system hostsfrom the SAN and optionally remove the volumes.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chnshost options


smcli chnshost [-h | -? | --help]

smcli chnshost [-v] [-x file_name] [-D] [-r] [-t system_type] [-w query |-i ip_address_list | -N group | -n system_list

Description

Important: To avoid SAN-access issues, power off the system host or take thesystem host offline before running the chnshost command.

This command acquires the configuration information from an XML input file. Tochange the SAN configuration, modify an XML configuration file that was createdusing the lsnshost command.

Operands

This command uses a list of system hosts for which the SAN configuration is to bechanged as an operand.

Flags


-D | --detachDetaches the system hosts from the SAN, removing all paths and mappings.




Tips:




-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Targets one or more system hosts, specified by IP address or host name. Thelist can be a mixture of IP addresses and host names, separated by a comma.


Tips:




Tips:




-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Targets one or more system hosts, specified by name or ID. The list can be amixture of system names and IDs, separated by a comma.




Tips:




-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Targets all system hosts in one or more specified groups, identified name orID. The list can be a mixture of group names and IDs, separated by a comma.no

Tips:






Tips:


-r | --removeRemoves the volumes if no other system host is attached to the volumes.

-t | --type system_typeTargets all system hosts of the specified type.

Tips:






-w | --where "query"Targets a single system host based on system attributes specified by query.



Tips:

v Use logical operators AND or OR to combine attributes.


v Use parentheses to create nested logical constructs.v The query operand must be enclosed in quotation marks. Do not use double



-x | --xmlfile {file_name}Receives SAN configuration data from the input file file_name.

The input data is the SAN configuration of the system host in XML format.The format of this file must match the format given by the lsnshost command.

Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 51: An internal error occurred.v 52: The host was not found.

Examples1. Change SAN configuration of a system host

This example illustrates how to apply the SAN configuration in the file namedhost_cfg.xml to the system host (system) named system1.smcli chnshost -n system1 -x host_cfg.xml

2. Remove host mapping and destroy volumesThis example illustrates how to remove the host-related mappings in the SANfor the system host (system) named system1 and destroys volumes for whichthis host was the last user.smcli chnshost -rDn system1

lsnshost commandUse the lsnshost command to list in XML format the Storage Area Network (SAN)configuration for system hosts. You can also export the configuration to a file.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsnshost options


smcli lsnshost [-h | -? | --help]

smcli lsnshost [-v] [-f file_name | -w query | -i ip_address_list |-Ngroup_list | [-n] system_list]


Description

This command exports XML that contains the SAN configuration of the specifiedsystem hosts. The XML can be saved to a file and later used by the chnshostcommand to change the configuration.

Restriction: Do not use the -v | --verbose option when saving the output of thiscommand to an XML file. The verbose output is not valid for configuration-fileinput.

Operands

This command uses a system host list as an operand. The list can optionally bepreceded by the -n | --names option.

Flags




The input data is the SAN configuration of the system host in XML format.The format must match the format given by the lsnshost command.




Tips:





Tips:





Tips:








Tips:




Tips:







Tips:







Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 51: An internal error occurred.v 52: The host was not found.

Examples1. List configuration information for a host


This example illustrates how to display the XML configuration for the systemhost named system1

smcli lsnshost -n system1

2. List configuration information for multiple hostsThis example illustrates how to display the XML configuration for all systemhosts in the group name group1.smcli lsnshost -N group1

3. Save host configuration informationThis example illustrates how to save the XML configuration for the system hostnamed system1 to a file named host1_cfg.xml.smcli lsnshost -n system1 > system1_san_cfg.xml

Network storage path commandsUse the smcli network storage path commands to list, create, and delete networkstorage paths and edit properties.

smcli commands

The following smcli network storage path commands are available:

chnspath commandUse the chnspath command to set the zoning configuration such that only one pathexists between the specified system hosts and the specified storage volumes. Youcan also use this command to unisolate the system hosts.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chnspath options


smcli chnspath [-h | -? | --help]

smcli chnspath [-v] {-A attribute_list | -u} [-t system_type] {-ffile_name | -w query | -i ip_address_list | -N group_list | [-n]system_list}

Description

To use this command,v The system host must be powered on.v Fabric zoning must be enabled; that is, <FabricZoningEnabled> must be set to

true in the SSPTSetting.xml file. If you change the SSPTSetting.xml file, youmust restart IBM Systems Director Server.

If you run this command to isolate a system host, you must specify a system host,network-storage system, and one or more logical volumes. If you do not specify alogical volume, only one logical volume can be mapped and zoned for the systemhost.

If you run this command to unisolate system host, you must specify only thesystem host.


Operands


Flags


-A | --attribute {key=value}[,key=value...]Targets the network-storage system and logical volumes, where key is theattribute name and value is the attribute value. The keys-value pairs areseparated by a comma.

Tip: The attributes and attribute values are not locale specific.



nssys string The network-storage system, specified by name, ID, orworld wide number (WWN).

storage_oidThe unique ID of the network-storage system,specified as a hexadecimal value prefixed with 0x(for example, 0x3e).Tip: Tip: You can use the lsmo -o command to listall system IDs, including network-storage systemIDs.

storage_nameThe name of the network-storage system. If thenetwork-storage-system name contains spaces,enclose it in quotation marks. If it contains acomma, prefix the comma with a backslash (\).Tips:

v Network-storage-system names might not beunique. This command acts on allnetwork-storage systems with the specifiedname. Use the -v | --verbose option to generatea message when this command targets multiplenetwork-storage systems with the same name. Totarget a network-storage system that has a namethat is not unique, identify the network-storagesystem by specifying its unique, hexadecimal ID,or use additional target options to refine theselection.

v The network-storage-system names are not localespecific.

storage_wwnThe WWN of the network-storage system. Thisvalue is displayed in the IBM Systems DirectorWeb interface as the System Unique Name of thestorage system.

nsvol string One or more logical volume names, separated by acomma. Do not include spaces.




The input data is the list of system host names and IDs, separated by commasor line breaks.




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Targets one or more system hosts specified by IP address or host name. The listcan be a mixture of IP addresses and host names, separated by a comma.


Tips:




Tips:









Tips:




Tips:






Tips:


-t | --type system_typeTargets all system host of the specified type.



Tips:




-u | --unisolateChanges the system host to the default values, granting other system hostsaccess to the network-storage disk volume.



-w | --where "query"Targets one or more system hosts based on system attributes specified byquery.



Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 51: An internal error occurred.v 52: The host was not found.v 53: A network-storage system was not found.


Examples1. Isolate a system host

This example illustrates how to isolate a system host named host1 from thelogical device DEV_1 on the network-storage system named MyStorage.smcli chnspath -n host1 -A nssys=MyStorage,nsvol=DEV_1

2. Unisolate a system hostThis example illustrates how to return the path for the system host namedhost1 back to the defaults.smcli chnspath -u -n host1

lsnspath commandUse the lsnspath command to list in XML format information about thenetwork-storage path. You can also export the information to a file.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsnspath options


smcli lsnspath [-h | -? | --help]

smcli lsnspath [-v] [-F] {-f file_name | -w query | -i ip_address_list | -Ngroup_list | [-n] system_list}

smcli lsnspath [-v] -W wwn_port_list

Description

If you specify a system host, this command lists the network-storage path (fabricswitches) to which the specified system host is attached. If the system host cannotbe reached, a null value is returned.

If you do not specify a system host, this command lists all available switches thatcan be part of the network-storage path.

If you specify one or more world-wide names (WWNs), this command lists theconnected fabric switches.

The XML can be saved to a file and later used by the chnspath command.

Operands


Flags






-F | --fabricnamePopulates the IBM Systems Director inventory data with the fabric name of theconnected fabric for the Common Agent managed systems.

Tip: For this option to be used successfully, you must first collect inventory forthe Common Agent managed systems. The managed systems must be poweredon and connected to active fabrics.




Tips:





Tips:




Tips:









Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Targets all system hosts in one or more specified groups, identified by name orID. The list can be a mixture of group names and IDs, separated by a comma.no

Tips:






Tips:








Tips:




-W | --wwn {wwn_port}[,wwn_port...]Targets one or more world wide names (WWNs) ports that identify the systemhosts, separated by a comma.

Tip:

v This value is displayed in IBM Systems Director Web interface as the SystemUnique Name of the network-storage system.

v Use the lsnshost command to list the ports.

Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 51:An internal error occurred.v 52: The host was not found.

Examples1. List all fabric switches

This example illustrates how to list all fabric switches in the network.smcli lsnspath

2. List network-storage path for a host


This example illustrates how to list, in XML format, all fabric switchesconnected to the system host named system1.smcli lsnspath system1

3. List connected fabric switchesThis example illustrates how to list, in XML format, fabric switches connectedto the system hosts with WWN ports 12345678 and 99990101.smcli lsnspath -W 12345678,99990101

mknspath commandUse the mknspath command to create a connection (a network-storage path) from asystem host to a logical volume.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mknspath options


smcli mknspath [-h | -? | --help]

smcli mknspath [-v] [-A attribute_list] [-f file_name | -w query | -iip_address_list | -N group_list | [-n] system_list]

Description

None

Operands


Flags


-A | --attribute key[,key ... ]Targets the network-storage system and logical volumes and sets the value ofone or more specified volume attributes, where key is the attribute name andvalue is the attribute value. The keys-value pairs are separated by a comma.




nsvol string Targets a logical volume, specified by name.Tip: You can specify only one logical volume.



nssys string Targets the network-storage system, specified byname, ID, or world wide number (WWN).

storage_oidThe unique ID of the network-storage system,specified as a hexadecimal value prefixedwith 0x (for example, 0x3e).Tip: Tip: You can use the lsmo -o commandto list all system IDs, includingnetwork-storage system IDs.

storage_nameThe name of the network-storage system. Ifthe network-storage-system name containsspaces, enclose it in quotation marks. If itcontains a comma, prefix the comma with abackslash (\).Tips:

v Network-storage-system names might notbe unique. This command acts on allnetwork-storage systems with the specifiedname. Use the -v | --verbose option togenerate a message when this commandtargets multiple network-storage systemswith the same name. To target anetwork-storage system that has a namethat is not unique, identify thenetwork-storage system by specifying itsunique, hexadecimal ID, or use additionaltarget options to refine the selection.

v The network-storage-system names are notlocale specific.

storage_wwnThe WWN of the network-storage system.This value is displayed in the IBM SystemsDirector Web interface as the System UniqueName of the storage system.

hostgroupname string Sets the host group name on the targetnetwork-storage system.Tip:

v The name can contain only alphanumericcharacters, underscores, and hyphens.

v The default value is defined in theSSPTSettings.xml file.

hostname string Sets the host name on the target network-storagesystem.

volumetype string Sets the type of volume to allocate. You canspecify one of these values:

You can specify one of these values:v FC: Fibre Channelv SAS: Serial-attached Small Computer Systems

Interfacev iSCSI: Internet SCSI

Tip: The default value is defined in theSSPTSettings.xml file.




The input data is the SAN configuration of the system host in XML format.The format must match the format given by the lsnshost command.




Tips:





Tips:




Tips:









Tips:




Tips:






Tips:








Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 51: An internal error occurred.v 52: The host was not found.v 53: A network-storage system was not found.v 54: The volume was not found.

Examples1. Connect a volume to a system host

This example illustrates how to connect the logical volume named DEV_1 on thenetwork-storage system named My_DS4000 to the system host named system1.smcli mknspath -A nsnsvol=DEV_1,sys=MyStorage -n system1

rmnspath commandUse the rmnspath command to remove a connection (that is, a network-storagepath) from a system host to one or more volumes, and optionally remove thevolumes if there are no other connections.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmnspath options


smcli rmnspath [-h | -? | --help]


smcli rmnspath [-v] {-A attribute_list} [-r] {-f file_name | -w query | -Ngroup_list | [-n] system_list}

Description

None.

Operands


Flags


-A | --attribute key[,key ... ]Targets the network-storage system and logical volumes, where key is theattribute name and value is the attribute value. The keys-value pairs areseparated by a comma.





nssys string The network-storage system, specified by name, ID, orworld wide number (WWN).

storage_oidThe unique ID of the network-storage system,specified as a hexadecimal value prefixed with 0x(for example, 0x3e).Tip: Tip: You can use the lsmo -o command to listall system IDs, including network-storage systemIDs.

storage_nameThe name of the network-storage system. If thenetwork-storage-system name contains spaces,enclose it in quotation marks. If it contains acomma, prefix the comma with a backslash (\).Tips:

v Network-storage-system names might not beunique. This command acts on allnetwork-storage systems with the specifiedname. Use the -v | --verbose option to generatea message when this command targets multiplenetwork-storage systems with the same name. Totarget a network-storage system that has a namethat is not unique, identify the network-storagesystem by specifying its unique, hexadecimal ID,or use additional target options to refine theselection.

v The network-storage-system names are not localespecific.

storage_wwnThe WWN of the network-storage system. Thisvalue is displayed in the IBM Systems DirectorWeb interface as the System Unique Name of thestorage system.









Tips:





Tips:




Tips:








Tips:

v The system names might not be unique. This command acts on allsystems with the specified name. Use the -v | --verbose option togenerate a message when this command targets multiple systems withthe same name. To target a particular system that has a name that is not


unique, identify the system by specifying its unique, hexadecimal ID, oruse additional target options to refine the selection.



Tips:






Tips:


-r | --removeRemoves the specified volumes if there are no other connections to them.






Tips:





Exit status



Examples1. Remove a connection between a storage subsystem and host

This example illustrates how to detach the logical volume named DEV_1 on thenetwork-storage system named MyStorage from the system host named system1.smcli rmnspath -n system1 -A nssys=MyStorage,nsvol=DEV_1

Network storage systems commandsUse the smcli network storage systems commands to list network storage systemsand edit properties.

smcli commands

The following smcli network storage system commands are available:

chnssys commandUse the chnssys command to change the host-type identifier and auto-logical drivetransfer (ADT) status on a network-storage system.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chnssys options


smcli chnssys [-h | -? | --help]

smcli chnssys [-v] [-A attribute_list] [-t system_type] {-f file_name | -wquery | -i ip_address_list | -N group_list | [-n] system_list}

Description

None


Operands

This command uses a network-storage system list as an operand. The list canoptionally be preceded by the -n | --names option.

Flags


-A | --attribute {key=value}[,key=value...]Targets the network-storage system and changes the value of one or morespecified attributes, where key is the attribute name and value is the attributevalue. The keys-value pairs are separated by a comma.




host string The name of the system host to target. If the systemname contains a comma, prefix the comma with abackslash (\).

adtstatus string A flag indicating whether to set the auto-logical drivetransfer (ADT) status. The value is true if ADT is set,and false if it is not set.

keywords string The keyword for the host type (for example, Linux).Use the lsnssys command to list the host types.



The input data is the list of network-storage system names and IDs, separatedby commas or line breaks.




Tips:




-i | --ipaddress ip_address[,ip_address...]Targets one or more network-storage system, specified by IP address. Separatethe IP addresses by a comma.

ip_addressThe IP address of the network-storage system.

Tips:

v You can enter lssys -A IP_address to list all IP addresses.v You can use either the IPv4 or IPv6 format to specify the IP address.

-n | --names {storage_oid | storage_name}[,{storage_oid |storage_name}...]

Targets one or more network-storage systems specified by name or ID.


storage_oidThe unique ID of the network-storage system, specified as a hexadecimalvalue prefixed with 0x (for example, 0x37).

Tip: Use the lssys -o command to list all network-storage system IDs.

storage_nameThe name of the network-storage system. If the network-storage systemname contains a comma, prefix the comma with a backslash (\).

Tips:

v The network-storage system names might not be unique. This commandacts on all network-storage systems with the specified name. Use the -v| --verbose option to generate a message when this command targetsmultiple network-storage systems with the same name. To target aparticular network-storage system that has a name that is not unique,identify the network-storage system by specifying its unique,hexadecimal ID, or use additional target options to refine the selection.

v Use the lsnssys command without any options to list allnetwork-storage system names.

v The network-storage system names are not locale specific.

-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Targets all network-storage systems in one or more specified groups, identifiedname or ID. The list can be a mixture of group names and IDs, separated by acomma. no

Tips:








Tips:


-t | --type system_typeTargets all network-storage systems of the specified type.


Tips:






-w | --where "query"Targets one or more network-storage systems based on system attributesspecified by query.



Tips:




Exit status




v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 51: An internal error occurred.v 52: The host was not found.v 53: A network-storage system was not found.

Examples1. Change the host type

This example illustrates how to change the host type to Linux for the systemhost named host_1 on the network-storage system named MyStorage.smcli chnssys -n MyStorage -A host=host_1,keyword=Linux

lsnssys commandUse the lsnssys command to list the network-storage systems discovered by IBMSystems Director.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsnssys options


smcli lsnssys [-h | -? | --help]

smcli lsnssys [-v]

Description

Tip: There might be some network-storage systems that have been discovered byIBM Systems Director that are not listed because they are not supported.

Operands

None

Flags






Tips:





Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 51: An internal error occurred.v 52: The host was not found.

Examples1. List all storage subsystems

This example illustrates how to list all network-storage systems, in XMLformat.smcli lsnssys

Network storage volumes commandsUse the smcli network storage volumes commands to list, create, and deletenetwork storage volumes and edit properties.

smcli commands

The following smcli network storage volume commands are available:

chnsvol commandUse the chnsvol command to change the name of a logical volume on anetwork-storage system.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chnsvol options


smcli chnsvol [-h | -? | --help]


smcli chnsvol [-v] {-A attribute_list}{-f file_name | -w query | -iip_address_list | -N group_list | [-n] system_list}

Description

Tip: Some storage systems might not support the renaming of volumes. In suchcases, this command will fail.

Operands

This command uses a network-storage system as an operand. The network-storagesystem can optionally be preceded by the -n | --names option.

Flags


-A | --attribute {key=value}[,key=value...]Targets the network-storage system and logical volumes and sets the value ofone or more specified volume attributes, where key is the attribute name andvalue is the attribute value. The keys-value pairs are separated by a comma.




absolutename string Changes the logical volume name to the specifiedname.

nsvol string Targets an existing logical volume, specified by volume.







Tips:






Tips:








Tips:





Tips:







Tips:







Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 51: An internal error occurred.v 52: The host was not found.v 53: A network-storage system was not found.


Examples1. Change the volume name

This example illustrates how to change the name of the logical volumecurrently named DEV_1 to DEV_NEW on the network-storage system namedMyStorage.smcli chnsvol -n MyStorage -A nsvol=DEV_1,absolutename=DEV_NEW

lsnsvol commandUse the lsnsvol command to list storage volume properties for the specifiednetwork-storage system.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsnsvol options


smcli lsnsvol [-h | -? | --help]

smcli lsnsvol [-v] {-A attribute_list}{-f file_name | -w query | -iip_address_list | -N group_list | [-n] system_list}

Description

This command lists the storage volume properties for the specific volumes on thespecified network-storage system.

If you do not specify any storage volumes, this command lists properties for allvolumes associated on the specified network-storage system.

Operands

This command uses a network-storage system as an operand. This operand mustbe preceded by the -n | --names option.

Flags


-A | --attribute key[,key ... ]Targets the storage volume , where key is the attribute name and value is theattribute value. The keys-value pairs are separated by a comma.












Tips:





Tips:








Tips:

v The network-storage system names might not be unique. This commandacts on all network-storage systems with the specified name. Use the -v| --verbose option to generate a message when this command targetsmultiple network-storage systems with the same name. To target aparticular network-storage system that has a name that is not unique,


identify the network-storage system by specifying its unique,hexadecimal ID, or use additional target options to refine the selection.




Tips:






Tips:







Tips:





Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 51: An internal error occurred.v 53: A network-storage system was not found.v 54: The volume was not found.

Examples1. List all volumes

This example illustrates how to list, in XML format, all storage volumes on thenetwork-storage system named MyStorage.smcli lsnsvol -n MyStorage

2. List information about a volumeThis example illustrates how to list information about the storage volumesnamed DEV_1 and DEV_2.smcli lsnsvol -n MyStorage -A nsvol=DEV_1,DEV_2

mknsvol commandUse the mknsvol command to create a storage volume by allocating a logicalvolume and setting the Redundant Array of Independent Disks (RAID) level forlater attachment to a system host.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] mknsvol options


smcli mknsvol [-h | -? | --help]

smcli mknsvol [-v] {-A attribute_list} {-f file_name | -w query | -iip_address_list | -N group_list | [-n] system_list]

Description

You can specify a system host to ensure that a volume that can be connected to thetargeted host is created. If the system host, network-storage systems, or otheroptions are not specified, default values are used.

Tip: You can set default values for the volume prefix, size, type, and RAID level inthe SSPTSetting.xml file.

Operands

This command uses a network-storage system as an operand. The list canoptionally be preceded by the -n | --names option.


Flags


-A | --attribute key[,key ... ]Targets the network-storage system and logical volumes and sets the value ofone or more specified volume attributes, where key is the attribute name andvalue is the attribute value. The keys-value pairs are separated by a comma.




host string Targets the system host, specified by name orID.

system_oidThe unique ID of the system, specified as ahexadecimal value prefixed with 0x (forexample, 0x37) or a decimal value (forexample, 123).Tip: Use the lssys -o command to list allsystem IDs.

system_nameThe name of the system. If the systemname contains a comma, prefix the commawith a backslash (\).Tips:

v The system names might not be unique.This command acts on all systems withthe specified name. Use the -v |--verbose option to generate a messagewhen this command targets multiplesystems with the same name. To target aparticular system that has a name that isnot unique, identify the system byspecifying its unique, hexadecimal ID, oruse additional target options to refinethe selection.

v Use the lssys command without anyoptions to list all system names.




volumenameprefix string Sets the volume prefix for naming logicalvolumes (for example, DEV_).

Logical volumes are named by concatenatingthe prefix with an integer, starting with 0 forthe first logical unit number (LUN) allocation toa specific storage system and increasing theinteger by 1 for each additional LUN allocation.Tips:

v The prefix can contain only alphanumericcharacters, underscores, and hyphens.

v The default value is defined in theSSPTSettings.xml file.

volumesetting string Sets the RAID level for allocating the volume.You can specify one of these values:

You can specify one of the values for thevolume setting:v RAID0: Data striping without parity.v RAID1: Mirroring.v RAID3: Data striping with dedicated parity.v RAID5: Data striping with distributed parity.

This value is the default.


volumesize Integer Sets the default volume size, in megabytes.Tip: The default value is defined in theSSPTSettings.xml file.

volumetype string Sets the type of volume to allocate.

You can specify one of these values:v FC: Fibre Channelv SAS: Serial-attached Small Computer Systems

Interfacev iSCSI: Internet SCSI









Tips:





Tips:








Tips:





Tips:







Tips:


-t | --type system_typeTargets all network-storage systems of the specified type.


Tips:









Tips:


quotation marks in the query.


v If the value contains spaces, enclose it in single quotation marks.v Only system attributes can be specified. Use the lssys -l command to list


Exit status



Examples1. Create volume using default properties

This example illustrates how to create a volume with default properties.smcli mknsvol

2. Create a volume with customized propertiesThis example illustrates how to creates a 2-GB volume that can be connected tothe network-storage system named storage1.smcli mknsvol -A host=system1,volumesize=2000 -n storage1

rmnsvol commandThe rmnsvol command removes one or more volumes on a network-storage systemif the volume is not connected to a network-storage system.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmnsvol options


smcli rmnsvol [-h | -? | --help]

smcli rmnsvol [-v] {-A attribute_list}{-f file_name | -w query | -iip_address_list | -N group_list | [-n] system_list}

Description

If the volume is attached to a host, it is not removed.


Operands

This command uses a network-storage system as an operand. The network-storagesystem must be preceded by the -n | --names option.

Flags


-A | --attribute key[,key ... ]Targets the storage volume , where key is the attribute name and value is theattribute value. The keys-value pairs are separated by a comma.











Tips:






Tips:








Tips:





Tips:






Tips:








Tips:




Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 51: An internal error occurred.v 52: The host was not found.v 53: A network-storage system was not found.v 54: The volume was not found.

Examples1. Remove a volume

This example illustrates how to remove a logical volume named DEV_1 on thenetwork-storage system named MyStorage.smcli rmnsvol -A nsvol=DEV_1 -n MyStorage

System commandsThe smcli system commands perform administrative operations on the IBMSystems Director system, including discovering, adding, removing, and listinginformation.

dircli commands

Using the new smcli system commands is recommended; however, the dirclimanaged-object commands listed in the following table are supported in this


release for compatibility with IBM Director version 5.20. Note that not allcommand options are supported in this release. For information about the dirclicommands, see the commands reference in the IBM Director version 5.20information center at publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_dircli_managed_object_commands.html.

Important:

v Storage systems are supported only by the current system commands. They arenot supported by the dircli commands listed in the following table.

v You must enter the dircli commands in lower case.v To use a dircli command with the same name as an smcli command, you must




accessmo Requests access to secured systems

Syntax:

accessmo [-t system_type] [-u user] [-p password]{-a | -f file_name | -w query | -i ip_address_list| -N group_list | [-n] system_list}

accesssys

chmo Changes attributes for systems

Syntax:

chmo {[-a | -f file_name | -w query | -N group_list| [-n] system_list] | key=}

chsys

lsmo Lists system attribute information

Syntax:

lsmo [-t system_type] [-d symbol] [-o | -p] [-T][-A attribute_list [-s] | -F | -l] {-f file_name |-w query | -N group_list | [-n] system_list}

lssys

mkmo Creates a system

Syntax:

mkmo[-f file_name | key=value[,{key=value}...]]

discover

pingmo Performs a presence check on the targeted systems

Syntax:

pingmo [-t system_type] [-r [-d seconds]] {-a | -ffile_name | -w query | -N group_list | [-n]system_list}

pingsys

rmmo Removes systems

Syntax:

rmmo [-t system_type] {-f file_name | -w query | -Ngroup_list | [-n] system_list}

rmsys




Table 3. Supported dircli commands (continued)


rpower Performs power-management operations on systems

Syntax:

rpower [-t system_type] {-a | -f file_name | -wquery | -N group_list | [-n] system_list}power_operation

rpower

smcli commands

The following smcli system commands are available:

accesssys commandUse the accesssys command to request secured access to systems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] accesssys options


smcli accesssys [-h | -? | --help]

smcli accesssys [-v] [-t type] [-u user_name] [-p password] {-a | -w query| -i ip_address_list | -N group_list | -n system_list | -f file}

Description

The accesssys command requests access to a system. IBM Systems Director usesthe specified user ID and password to access the system.

You can run this command on multiple systems at one time. The same user ID andpassword is used to access all specified systems.

Tip: This command sets only the user ID and password that IBM Systems Directoruses for connectivity. It does not set or change the user ID and password on thesystem itself.

Operands


Flags


-a | --allTargets all systems.








Tips:






Tips:




Tips:











Tips:





Tips:






Tips:



-p | --password passwordThe password for the specified user ID. If you do not specify this option, IBMSystems Director prompts you for the password.

Attention: Using this option presents a potential security risk. The passwordmight be recorded in the shell or other operating-system areas.

Tips: The value for password is used for all systems targeted by the command.




Tips:




-u | --user user_nameSpecifies a valid user login name with administrative privileges on the targetedsystems. If you do not specify this option, IBM Systems Director prompts youfor the user name.

Tips: The value for user_name is used for all systems targeted by thecommand.






Tips:





Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 51: A system was not locked.v 65: A request for access is not supported. The system cannot be locked or

unlocked.v 66: A system is not available.v 67: A system can not be accessed.v 68: The action was not permitted by the target system.v 69: The request-access operation failed.v 70: An encrypted system was not accessed.v 71: The access request is not finished.v 72: The access request completed successfully with errors.v 73: Request access failed because the system is untrusted.

Examples1. Request access to a system

This example illustrates how to request access to a system named websvr. Thecommand prompts for the user ID and password.smcli accesssys websvr

2. Request access to a system specifying user ID and passwordThis example illustrates how to request access to a system named websvr usingthe user ID userA and the password passwordA.smcli accesssys -u userA -p passwordA websvr

Note: This method of accessing a system presents a security risk, since thecredentials might be recorded inn the shell or another area of the operatingsystem.

3. Request access to all systems of a specific typeThis example illustrates how to request access to all systems of type Server.smcli accesssys -t "Server" -a

chsys commandUse the chsys command to change the attributes of a system.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chsys options



smcli chsys [-h | -? | --help]

smcli chsys [-v] [-t system_type] {-A attribute_list} {[-a | -f file_name |-w query | -i ip_address_list | -N group_list | [-n] system_list]}

Description

This command changes the attributes of the targeted systems. You can changeattribute values by specifying attribute and value pairs in the formattribute_key=value.

Operands


Flags


-A | --attribute key[,key ... ]

Changes values for one or more specified system attributes, where key is theattribute key and value is the attribute value. The key-value pairs are separatedby a comma.

Tips:

v The attributes and attribute values are not locale specific.v If value is a string that contains spaces or other special characters, enclose the

string in quotation marks.v Use the lssys -l command to list the current attribute values.



DisplayName string System name

Ping integer Ping interval, in milliseconds.

Description string Description of the system









Tips:






Tips:




Tips:











Tips:





Tips:






Tips:





Tips:










Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 60: The attribute is not supported.v 61: The attribute is read-only.v 62: No attribute was specified.v 63: The system cannot be renamed.

Examples1. Change the name

This example illustrates how to target a single system named websvr andchange its name to SMTPsvr.smcli chsys -n websvr -A DisplayName=SMTPsvr

2. Increase the ping intervalThis example illustrates how to increase the ping interval to 30 minutes(1 800 000 ms) on all systems with a current ping interval of 15 minutes(9 000 000 ms).smcli chsys -w Ping=900000 -A Ping=1800000


3. Changes the ping interval for systems listed in a fileThis example illustrates how to target all systems listed in the /tmp/modef fileand changes the ping interval to 30 minutes.smcli chsys -f /tmp/modef -A Ping=1800000

lssys commandUse the lssys command to retrieve system attribute information.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lssys options


smcli lssys [-h | -? | --help]

smcli lssys [-v] [-I]

smcli lssys [-v] [-t system_type] [-d symbol] [-o | -p] [-T] [-Aattribute_list [-s] | -F | -l [-e]] {-f file_name | -w query | -iip_address_list | -N group_list | [-n] system_list}

Description

If you do not specify any targeting options, this command lists all systems.

If you do not specify any display options, this command lists only system names.Note that system names might not be unique.

Important: The -i | --listtype option used in IBM Director version 5.20 to listall available types of systems has been replaced with to -I | --listtype in thisrelease. The -i | --listtype option is now used to target systems by IP addressor host name.

Tip: Use the lsvrtsys command to list information about virtual systems,including platform managers, virtual servers, and hosts.

Operands


Flags




Tips:

v Separate the keys with commas.


v The attributes and attribute values are not locale specific.v You can use the lssys -llsuser -l command to list all attributes associated









-e | --expandExpands the long listing to also display a description of the attribute keys.

Note: If you specify this option, you must also specify the -l | --long option.

The information is displayed in this format:key1 (key_string) : value1key2 (key_string) : value2...




-F | --formatDisplays the output in a format that can be saved as a system definition file orused as input for the mkmo -f command. Although the actual attributesdisplayed varies with different system types, the format might resemble thefollowing lines:type = valueip = valuename = valuenetwork = value

Tip:

v If you specify either the --oid or --pipe options, they are ignored.v You can use this option to save the definition of one or more systems, so

that they can be restored at a later time.





Tips:






Tips: Tips:v oYou can enter smcli lssys -A IPv4Address to list the IP address (either

the IPv4 or IPv6 format) of each discovered system.


Tips: Tips:v oYou can enter smcli lssys -A Hostname to list the host name of each

discovered system.v oThe host names are not locale specific.v oA given IP address or host name might resolve multiple systems. For


-I | --listtypeLists all system types. All additional options are ignored.

-l | --longDisplays all attributes for the targeted systems.

This option lists values for each system in this format:system_name

attribute_key: valueattribute_key: value...

Tip:


|

v The attributes and attribute values are in English only. They are not localespecific.




Important: You must provide the host name and the system name when youpass the parameter -n. The system name must not be equal to the host name.Therefore, you must pass the exact system name -n, which is not equal to thehost name.


Tip: Use the smcli lssys -o command to list all system IDs.


Tips:


v Use the smcli lssys command without any options to list all systemnames.




Tips:







||

|


Tips:


-o | --oid id

The ID for the resource that will have the configuration retrieved.

-p | --pipe


Tips:




options.






Tips:




-T | --showtypeLists the system type after the system name. By default, the system name andtype are separated by a comma followed by a space.



-w | --where "string"Targets one or more systems based on system attributes specified by string andlists systems based on the attributes.


|

||

string is a SELECT statement that uses the following format:"key1=value1 [{AND | OR} key2=value2 [{AND | OR}key_n=value_n...]"

Note: Value is case-sensitive.

Enclose the SELECT statement in double quotation marks. If a value includesspaces, enclose the strings in single quotation marks.

System attributes might not be unique. Use the lssys -l command to list theavailable system attributes.

Tips:

v Use logical operators AND or OR to combine attributes.v Use parentheses to create nested logical constructs.v Only system attributes can be specified. Use the lssys -l command to list


Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.

Examples1. List the names and IDs of all systems

This example illustrates how to list the names and IDs of all systems.smcli lssys -o

aixServer, 0x291webServer, 0x292mailServer, 0x295

2. List all attributes for multiple systemsThis example illustrates how to list the attributes for systems with IP addresses9.182.149.105 and 9.182.149.115, and host name myusmibox.raleigh.ibm.com.smcli lssys -l -i 9.182.149.105, 9.182.149.115, myusmibox.raleigh.ibm.com

3. List systems with specific attributesThis example illustrates how to list all systems that are based on POWER or IA32architecture.smcli lssys -w "Architecture=POWER OR Architecture=IA32"

This example illustrates how to list all systems that have AIX or i5 OS installed.smcli lssys -w "OSType=9 OR OSType=11"

4. Sort systems by a specific attributeThis example illustrates how to list the display name and resource-typeattributes for all systems, and sorted by display name.


|

|

|

||

|

|

smcli lssys -sA DisplayName,ResourceType

aixServer, ServermailServer, ServerwebServer, Server

pingsys commandUse the pingsys command to perform a presence check (ping) on the targetedsystems. When the presence check is completed, the results are reflected in theOperatingState and CommunicationState attributes. This command performs anIBM Systems Director presence check and not an Internet Control Message Protocol(ICMP) ping.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] pingsys options


smcli pingsys [-h | -? | --help]

smcli pingsys [-v] [-l level] [-t system_type][-r [-W seconds] ] {-a | -ffile_name | -w query | -i ip_address_list | -N group_list | [-n]system_list}

Description

This command immediately initiates a presence check (ping) on the targetedsystems. When the ping is completed, the results are reflected in the system stateattribute (state). The results are not displayed on the command line.

Operands


Flags










Tips:






Tips:




Tips:




-l | --level levelQueries data at the specified level. Valid values are 1, 2, or 3, where:v 1: operational status queryv 2: light queryv 3: deep query

If you do not specify this option, level 1 is the default value.








Tips:





Tips:






Tips:


-r | --returnReturns the value of the communication state attribute (CommunicationState)


for all target systems after a ten-second delay. To change the time IBM SystemsDirector waits before returning the CommunicationState value, use the -W |--wait option.




Tips:









Tips:




-W | --wait seconds


Tip: If you specify this option, you must also specify the -r | --returnoption.



the lsjob or lsjobhistory command to check the status.



Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.

Examples1. Ping a system

This example illustrates how to ping the system named websvr.smcli pingsys websvr

2. Ping multiple systems using a data fileThis example illustrates how to ping the systems listed in the /tmp/systems.txtfile.smcli pingsys -f /tmp/systems.txt

printDMData commandUse the printDMData command to print the management node Data.

Syntax

smcli printDMData [-c] [-prompt] [-user user_name] [-pw password]


smcli printDMData [-h | -? | --help]

Options

There is only one option for the printDMData command:

-v | --verbosePrint verbose output of the data, including the flight recorder trace data.

Example

Print the management node data with verbose output:smcli printDMData -v


revokeaccesssys commandUse the revokeaccesssys command to revoke access to unlocked systems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] revokeaccesssysoptions


smcli revokeaccesssys [-h | -? | --help]

smcli revokeaccesssys [-v] [-t type] -a | -f file_name | -w query | -iip_address_list | -N group_list | [-n] system_list

Description

The revokeaccesssys command revokes access to an unlocked system. Thecredentials for the endpoints are changed to indicate a locked state.

You can run this command on multiple systems at one time. Access to all the validspecified systems is revoked.

Operands


Flags










Tips:






Tips:




Tips:











Tips:





Tips:






Tips:





Tips:










Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 51: A system is already locked.v 52: Revoking access is not supported.v 53: Revoking access is not authorized.v 54: The revoke-access operation failed.v 55: The revoke-access operation succeeded with error.v 56: The revoke-access operation is not yet finished.v 57: The system is not available.v 58: The system is not accessible.

Examples1. Revoke access to a system

Both of these examples illustrate how to revoke access to a system namedwebsvr.smcli revokeaccesssys websvr

smcli revokeaccesssys -n websvr


2. Revoke access to all systems of a specific typeThis example illustrates how to revoke access to all systems of type Server.smcli revokeaccesssys -a -t Server

3. Revoke access to all systems in a specific groupThis example illustrates how to revoke access to all systems that belong to thegroup websvrgrp.smcli revokeaccesssys -N websvrgrp

rmsys commandUse the rmsys command to remove systems and all associated data.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmsys options


smcli rmsys [-h | -? | --help]

smcli rmsys [-v] [-t system_type] {-f file_name | -w query | -iip_address_list | -N group_list | [-n] system_list}

Description

None

Operands


Flags









Tips:






Tips:




Tips:











Tips:





Tips:






Tips:





Tips:










Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 50: The specified system cannot be removed.v 51: The operation failed.

Examples1. Remove multiple systems

This example illustrates how to remove systems named websvr and with ID0x9A5.smcli rmsys -n websvr,0x9A5

2. Remove systems using a data fileThis example illustrates how to remove the systems that are specified in the/tmp/systems.txt file.smcli rmsys -f /tmp/systems.txt


rpower commandUse the rpower command to perform power-management operations on remotesystems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rpower options


rpower [-h | -? | --help]

rpower [-v] [-t system_type] {-a | -f file_name | -w query | -iip_address_list | -N group_list | [-n] system_list} power_operation

Description


The command returns the names and IDs for the targeted systems, the poweroperation performed, and the results of the operation.

Operands

This command takes a power operation as an operand. This operand is a stringthat specifies the power-management operation to be performed. Possible valuesfor power_operation are:v HardRestart: Resets and then forces a restart of the hardwarev HardRestartSP: Resets and then forces a restart of the system management

processorv PowerOffNow: Powers off the system immediatelyv PowerOn: Powers on the system gracefullyv PowerOnHold: Powers on the system but does not continue with boot operationsv PowerOnRelease: Resumes boot operations after a PowerOnHold operationv Restart: Restarts the operating system after a Suspend operationv RestartNow: Forces a restart of the operating systemv Resume: Resumes operating system activity for a suspended systemv ShutDown: Shuts down the operating systemv ShutDownAndPowerOff: Shuts down the operating system and then powers off the

systemv SoftRestartSP: Restarts the system management processorv Support: Lists the power operations supported for the targeted systemsv Suspend: Suspends the operating systemv RestartStandardDiagnostics: Immediately restarts and runs standard

diagnosticsv RestartExtendedDiagnostics: Immediately restarts and runs extended

diagnosticsv RestartFullDiagnostics: Immediately restarts and runs full diagnostics





v VirtualReseat: Powers the hardware off and then back on in order to virtuallyreseat the system.

v WakeOnLan: Starts a powered off system remotely

Tips:v The power-option values are not case sensitive.v Not all operations are supported on all systems.v Systems must be unlocked.

Flags









Tips:






Tips:





Tips:










Tips:





Tips:







Tips:





Tips:









Tips:





Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 50: A specified power-management operation is not valid.v 51: The power-management operation failed.v 52: One or more managed systems were locked.

Examples1. List power operations supported on a system

This example illustrates how to list all power operations that are supported onthe system named system1.smcli rpower -n system1 support

2. Restart a group of systemsThis example illustrates how to restart all the systems in the group namedgroup1.smcli rpower -N group1 restart

Tasks and scheduled jobs commandsUse the commands in this section to list or run IBM Systems Director tasks, and toschedule one or more noninteractive tasks to run at a later time. You can specify anexact date and time that you want the scheduled task to start, or you can set thescheduled task to repeat automatically at a specified interval.

You can schedule only noninteractive tasks, which are tasks that do not require anyuser input or interaction. Scheduled tasks are referred to as jobs.

Tip: The following functions are not available through the command-line interface.Use the IBM Systems Director Web interface instead.v Creating a jobv Suspending and resuming a jobv Clearing all jobs in the job history logv Listing jobs in calendar view

dircli and dircmd commands

Several dircli and dircmd commands were previously available for task andscheduled job task processing to provide compatibility with IBM Director version5.20, but they are now discontinued. See the “scheduler/command_name”commands in the “Discontinued dircli commands” or “Discontinued dircmdcommands” topic for further information about the commands and their currentsmcli command alternatives.


smcli commands

The following smcli task and scheduled job commands are available:

lsjob commandUse the lsjob command to list information about scheduled tasks (called jobs).

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsjob options


smcli lsjob [-h | -? | --help]

smcli lsjob [-v] -J {low | medium | high} job

smcli lsjob [-v] [-m] [-s {status}] [-t system_type] [-o | -p] [-l] [-ffile_name | -w query | -i ip_address_list | -N group_list | [-n]system_list| [-j] job_list]

Description

If no options are specified, this command displays the job name for all jobs.

If this command targets systems, it displays all jobs scheduled for those systems. Ifthe command targets jobs, it displays information about the jobs, including onwhich systems a job is scheduled.

Operands

This command optionally uses a list of job names or ID as an operand. The list canoptionally be preceded by the -j | --jobs option.

Flags




The input data is the list of jobs to be displayed. This list can be a mixture ofjob names and ID, separated by commas or line breaks.





Tips:






Tips:




Tips:




-j | --jobs {job_oid | job_name}[,{job_oid | job_name}...]Targets one or more jobs, specified by names or ID.

This list can be a mixture of job names and ID, separated by a comma.

job_oidThe unique job ID, specified as a hexadecimal value prefixed with 0x (forexample, 0x54).

Tip: You can use the lsjob -o command to get a list of all job IDs.

job_nameThe name of the job.

Tips:

v Job names might not be unique. This command acts on all jobs with thespecified name. Use the -v | --verbose option to generate a messagewhen this command targets multiple jobs with the same name. To target


a job that has a name that is not unique, identify the job by specifyingits unique, hexadecimal group ID, or use additional target options torefine the selection.

v The job name can be locale specific. The name specified must match thelocale being used by the command line interface.

v If the job name contains a comma, prefix the comma with a backslash(\).

v You can use the lsjob command with no options to get a list of all jobnames.

-J | --joblog [low | med | high]Displays the job log for the specified job. You display the log for only one jobat a time. Specify low, med (medium), or high to identify the level of detail todisplay in the job log. The default value is low.

-l | --longDisplays detailed information about the specified jobs.

This option returns these attributes for each job:v Job name and IDv Task performedv Targeted system namesv Name of the user that created the jobv Email address of the user that created the jobv Notification conditionv Notification serverv Last run date and timev Next scheduled run date and timev Tasksv Status of the job. Values are Completed and Scheduled.v Next scheduled date and time. This field is empty if the job does not repeat.v Status

-m | --summaryDisplays scheduled jobs that ran in the last 30 days.

-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Targets one or more jobs scheduled for the specified systems, identified byname or ID. The list can be a mixture of system names and IDs, separated by acomma.




Tips:




-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Targets one or more jobs scheduled for the specified groups, identified byname or ID. The list can be a mixture of group names and IDs, separated by acomma.

If the same systems are members of more than one group, they are targetedonly once.




Tips:


-o | --oidDisplays the unique IDs associated with the targeted jobs. The IDs aredisplayed as hexadecimal values, prefixed with 0x (for example, 0x3e).

Tip: You cannot use this option with the -p | --pipe option.

-p | --pipeDisplays only the unique IDs for the targeted jobs. IDs are displayed ashexadecimal values, prefixed with 0x (for example, 0x37).

Tips:

v Use this option to pipe output from this command into other smclicommands.


-s | --status {scheduled |running | inactive | complete }Lists all the jobs with the specified status. You can specify one of these values:v scheduled - Scheduled status lists all jobs that have not run before and are

currently scheduled.v running - Running status shows all jobs that have future scheduled runs and

are enabled.v inactive - Inactive status shows all jobs that have been disabled.v complete - Completed status shows all jobs that have completed and with no

future scheduled runs

-t | --type system_typeTargets jobs that run on systems of the specified type.



Tips:






-w | --where "query"Targets jobs that run on one or more systems based on system attributesspecified by query.



Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.

Examples1. List all scheduled jobs

This example illustrates how to list all scheduled jobs.


smcli lsjob

cleareventlogdownload updatescollectinventorypowerdown

2. Display detailed information about a specific job using the job IDThis example illustrates how to display detailed information about a job withjob ID 0x7d.

Tip: For jobs that are yet to be run, the status would be scheduled. The NextRun attribute is blank for jobs that do not repeat.smcli lsjob -l 0x7d

Job: collectinventory, 0x7dTasks: Collect InventoryTargets: dbserver, dataBK, bobmachineCreator Name: ibm userCreator E-mail: [email protected] Condition: NoneNotification Server: localhost.austin.ibm.comNotification Server Port: 9090Last Run: June 20, 2007 8:00:00 AM CDTNext Run: June 20, 2007 9:00:00 AM CDTStatus: Active

3. List all completed jobsThis example illustrates how to list all completed jobs with the status complete.smcli lsjob -s complete

cleareventlogdownload updatescollectinventory

4. List jobs scheduled to run on a specific type of systemThis example illustrates how to list all jobs that are scheduled on systems witha type of Clusters.smcli lsjob -t Clusters

cleareventlogdownload updates

5. Display a job logThis example illustrates how to display the job log for the job with job ID 0x50:smcli lsjob -J high 0x50

JobLog for job: 0x5011/30/2006 6:08:35 PM Job "MakeError" activated.11/30/2006 6:08:35 PM Subtask "Collect Inventory" activated.11/30/2006 6:08:35 PM Starting clients11/30/2006 6:08:35 PM Clients started for task "Collect Inventory"11/30/2006 6:08:35 PM Subtask instance status changed to "Active".11/30/2006 6:08:36 PM Job instance status changed to "Active".11/30/2006 6:08:36 PM 2FDIBM407 client job status changed to "Pending".11/30/2006 6:08:36 PM The collection failed due to a security failure for

client 2FDIBM407.11/30/2006 6:08:36 PM 2FDIBM407 client job status changed to "Error".11/30/2006 6:08:36 PM Subtask instance status changed to "Complete".11/30/2006 6:08:36 PM Job instance status changed to "Active with errors".11/30/2006 6:08:36 PM Job instance status changed to "Complete with errors".

6. List jobs running on a system


This example illustrates how to list all jobs that can run on the system namedsystem1.smcli lsjob -n system1

cleareventlogdownload updatescollectinventory

7. List job summaryThis example illustrates how to list a summary of scheduled jobs in the last 30days.smcli lsjob -m

Number of jobs scheduled: 3Number of jobs complete successfully: 0Number of jobs failed with errors: 19

Upcoming job runs:1/24/08 3:22 PM, Task11/24/08 3?50 PM, Task31/24/08 4:06 PM, Task4

Most recent job runs:1/24/08 3:06 PM, Task1 Active1/24/08 2:50 PM, Task1 Completed

lsjobhistory commandUse the lsjobhistory command to list information about job instances and historydata.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsjobhistory options


smcli lsjobhistory [-h | -? | --help]

smcli lsjobhistory [-v] [-o | -p] [-l] [-s status] {-a | -f file_name |[-j] job_list}

Description

None.

Operands

This command uses a list of jobs as an operand. The list can optionally bepreceded by the -j | --jobs option.

Flags


-a | --allLists all job instances.


Tip: If you do not specify this option, you must specify a job ID.







Tips:








Tips:

v Job names might not be unique. This command acts on all jobs with thespecified name. Use the -v | --verbose option to generate a messagewhen this command targets multiple jobs with the same name. To targeta job that has a name that is not unique, identify the job by specifyingits unique, hexadecimal group ID, or use additional target options torefine the selection.





-l | --longDisplays detailed information about the job.

This option returns these attributes for each job:v Job: Name of the jobv Tasks: Tasks that are associated with this job.v Instance ID: ID of the job instancesv Status: Status of the job instance running on the systemv Pending: A flag indicating whether the job instance is waiting for a resource

to become available.v In Progress: A flag indicating whether the job instance is currently running.v Suspend: A flag indicating whether the job has been deactivated.v Managed Elements: The systems on which the job runs.v Completed: A flag indicating whether the job instance has completed.v Failed: The job failed on the a specific system.v Unavailable: The job status could not be determined on the system. The

system might be offline.v Skipped: The job did not run on the system

-o | --oid


Tips:

v This option cannot be used with the -p | --pipe option.v You can combine this option with the -l | --long option.

-p | --pipe


Tips:


v This option cannot be used with the -o | --oid options.v You can combine this option with the -l | --long option.

-s | --status {running | complete | wait | error}Lists all the job instances with the specified status. You can specify one of thesestates:v running - Running state. Lists all job instances that are currently running (in

progress)v complete - Completed state. Lists all job instances that have completed.v wait - Waiting state. Lists all job instances that are waiting for a resource to

become available.v error - Running with Errors, Complete with Errors, or Waiting with Errors

states. Lists all job instances that produced errors while running, completed,or waiting.




Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 26: An invalid job name or ID was specified.v 29: The specified locale is not valid or not supported.

Examples1. List all instances IDs

This example illustrates how to list all job-instance IDs for a specific job.smcli lsjobhistory -a

cleareventlog: [0xf, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17]

2. List all job-instance IDs for a specific jobThis example illustrates how to list all job-instance IDs for a specific job.smcli lsjobhistory cleareventlog

cleareventlog: 43,45,46

3. Display detailed information about a job-instanceThis example illustrates how to display detailed information about job-instancefor a job with ID 0x7df.smcli lsjobhistory -l 0x7d

Job: collectinventoryTasks: Collect Inventory

Instance ID: 0xfStatus: Completed with errorPending: 0In Progress: 0Suspended: 1-Managed Resources: myhostnameComplete: 0Failed: 0Unavailable: 0Skipped: 0

Instance ID: 0x10Status: Completed with errorPending: 0In Progress: 0Suspended: 1-Managed Resource: myhostnameComplete: 0Failed: 0Unavailable: 0Skipped: 0

lstask commandUse the lstask command to list information about one or more tasks.


Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lstask options


smcli lstask [-h | -? | --help]

smcli lstask [-v] [-p | [-I] [-o]] {-s task} [-A instance [-t type_list [-ffile_name | -w query | -i ip_address_list | -N group_list | [-n]system_list] ]

smcli lstask [-v] [-p | [-I] [-o]] [-l] [-f file_name | [-T] task_list

smcli lstask [-v] [-o] [-I] [-r]

Description

If you do not specify a task name or ID, this command lists information about alldefined tasks. If you do not specify any options, this command lists only the tasknames.

If this command targets systems, it displays all tasks that run on the specifiedsystems. If the command targets tasks, it displays information about the tasksincluding on which systems the task runs.

Important:

v The -e | --exec option used in IBM Director version 5.20 to list the job-instancestatus for the specified systems and subtasks has been replaced with -A |--instance in this release.

v The -E | --executable option used in IBM Director version 5.20 to listnoninteractive subtasks that can be scheduled has been replaced with to -r |--runnable in this release.

Operands

This command uses a list of tasks as an operand. The list can optionally bepreceded by the -T | --task option.

If you specify the -s| --task and -A | --instance options, this commandoptionally uses a list of systems as an operand. The list can optionally be precededby the -n | --names option.

Flags


-A | --instance instance_idDisplays the status of the specified task or subtask instance, identified by ID.The ID is an integer that is incremented each time the task or subtask is run.

Tips:

v If you omit this option, all task instances are listed.


v You can use the lstask -l command to get a list of all task instance IDs.v If you specify this option, you must also specify the -s | --status option.



If you do not specify the -s | --task option, the input data is the list of tasks,specified by name or ID. This list can be a mixture of task names and ID,separated by a comma or end-of-line character.If you specify the -s | --task option, the input data is the list of systems onwhich the specified tasks run. This list can be a mixture of system names andIDs, separated by a comma or end-of-line character.




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Targets one or more tasks that run on the specified systems, identified by IPaddress or host name. The list can be a mixture of IP addresses and hostnames, separated by a comma or end-of-line character.


Tips:




Tips:





Tip: You can use this option only with the -s | --task and -A | --instanceoptions.

-I | --idDisplays the unique task name or task ID string of the targeted task.


-l | --longDisplays detailed information about each task with the specified name or IDstring.

This option returns these attributes for each task:v Task titlev Full parent structurev Task interactive flagv Task statusv ID and status of each task instance

Tip: Data is not displayed for interactive tasks.

-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Targets one or more tasks that run on the specified systems, identified by nameor ID. The list can be a mixture of system names and IDs, separated by acomma.




Tips:





-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Targets one or more tasks that run on members of the specified groups,identified by name or ID. The list can be a mixture of group names and IDs,separated by a comma.

Tips:






Tips:



-o | --oidDisplays the names and unique IDs for the targeted tasks and for the systemson which the tasks run. IDs are displayed as hexadecimal values, prefixed with0x (for example, 0x3e). A task job ID of 0x0 indicates an interactive task.


-p | --pipeDisplays the unique ID of the task. IDs are displayed as hexadecimal values,prefixed with 0x (for example, 0x3e7). No other information is displayed.

Tip:


v This option cannot be used with the -o | oid option.

-r | --runnableLists the noninteractive tasks that can run on the targeted system.

-s | --status {task_ oid | task_string_id | task_title}Displays the status for a noninteractive task, specified by name, ID or stringID.

Tips:

v This option cannot be used with the -T | --tasks option.v An error is displayed if the specified task name or task string ID does not

uniquely identify the task.


v An error is displayed if the specified task is not a noninteractive task.






Tips:




-t | --type system_typeTargets tasks that run on systems of the specified type.


Tips:





Targets one or more tasks, specified by title, unique ID, or ID string.

The list can be a mixture of titles, IDs, and ID strings, separated by a comma.The list is delimited by the end-of-line character when read from a file.







Tips:




Tip: This option cannot be used with the -s | --status option.



-w | --where "query"Targets one or more tasks that run on systems that are based on attributevalues specified by query.



Tips:

v Use logical operators AND or OR to combine attributes.v Use parentheses to create nested logical constructs.


v The query operand must be enclosed in quotation marks. Do not use doublequotation marks in the query.

v If the value contains spaces, enclose it in single quotation marks.v Only system attributes can be specified. Use the lssys -l command to list


Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 22: A specified task is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 51: The task name or ID is not unique or valid.v 52: The task or subtask is interactive.v 53: The task ID was not found.

Examples1. List all defined tasks

This example illustrates how to list all define tasks.smcli lstask

2. List the task ID for a specific taskThis example illustrates how to list the name and ID for the task namedAssistant/Configuration.smcli lstask -oT "Assistant/Configuration"

Assistant/Configuration, 0x3D

3. List a task with a specific IDThis example illustrates how to list detailed information about a task with thetask ID 0x40.smcli lstask -olT 0x40

Power management/ShutDown, 0x40:ST.1.name = Power management/ShutDown, 0x40ST.1.targeted = trueST.1.interactive = falseST.1.exec.1.stat = ActiveST.1.exec.1.stat.client.0 = {Sys1, 0x1A} PendingST.1.exec.1.stat.client.1 = {Sys2, 0x2B} FailedST.1.exec.2.stat = CompleteST.1.exec.2.stat.client.0 = {ServerA, 0x5F}, CompleteST.1.exec.2.stat.client.1 = {ServerB, 0x6B}, Failed

4. List job status for a subtaskThis example illustrates how to list the job-instance status for the subtask withthe ID string %com.ibm.sysmgt.powerapi.ShutDown.smcli lstask -os "%com.ibm.sysmgt.powerapi.ShutDown"

Power management/ShutDown, 0x40:


ST.targeted = trueST.interactive = falseST.1.exec.1.stat = ActiveST.1.exec.1.stat.client.0 = {Sys1, 0x1A}, PendingST.1.exec.1.stat.client.1 = {Sys2, 0x2B}, FailedST.1.exec.2.stat = CompleteST.1.exec.2.stat.client.0 = (ServerA, 0x5F}, CompleteST.1.exec.2.stat.client.1 = (ServerB, 0x6B}, Failed

5. Display the status of a job using its job ID and instanceThis example illustrates how to display the status of job using the job ID 0x15and instance 1.smcli lstask -s 0x15 -A 1

ST.1.exec.1.stat = ActiveST.1.exec.1.stat.client.0 = system1, PendingST.1.exec.1.stat.client.1 = system2, Failed

6. Display the status of a job using its job ID string and instanceThis example illustrates how to displays the status of a job with the ID stringcom.ibm.sysmgt.powerapi.ShutDown/com.ibm.sysmgt.powerapi.PowerOn andinstance 1. Notice that the task ID and subtask ID strings match.smcli lstask -s %com.ibm.sysmgt.powerapi.PowerOn/com.ibm.sysmgt.powerapi.PowerOn-A 1

ST.1.exec.1.stat = ActiveST.1.exec.1.stat.client.0 = system1, PendingST.1.exec.1.stat.client.1 = system2, Failed

7. Display the status of a job, using its job ID string and execution ID, that isrunning on a specific systemThis example illustrates how to display the status of a job with the job ID 0x15,job instance ID 1, running on the system named system1.smcli lstask -s 0x15 -A 1 -n system1

Sys1, Pending

rmjob commandUse the rmjob command to delete one or more jobs.

If more than one job has the same name, all jobs with that name are deleted.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmjob options


smcli rmjob [-h | -? | --help]

smcli rmjob [-v] {-f file_name | [-j] job_list}

Description

None.


Operands


Flags




The input data is the list of jobs to be deleted. This list can be a mixture of jobnames and IDs, separated by a comma or end-of-line character.




Tips:








Tips:

v Job names might not be unique. This command acts on all jobs with thespecified name. Use the -v | --verbose option to generate a messagewhen this command targets multiple jobs with the same name. To target


a job that has a name that is not unique, identify the job by specifyingits unique, hexadecimal group ID, or use additional target options torefine the selection.






Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 26: An invalid job name or ID was specified.v 29: The specified locale is not valid or not supported.v 63: Job could not be deleted.

Examples1. Remove a job

This example illustrates how to remove a job named myJob.smcli rmjob myjob

2. Remove multiple jobsThis example illustrates how to remove three jobs with job IDs 0x54 and 0x43and name myJob.smcli rmjob -j 0x54, myjob1, 0x43

rmjobhistory commandUse the rmjobhistory command to delete job instances or history.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] rmjobhistory options


smcli rmjobhistory [-h | -? | --help]

smcli rmjobhistory [-v] [-I instance_list {-f file_name | [-j] job_list}


Description

If more than one job has the same name, this command deletes job instances for alljobs with the same name. If no instance IDs are specified, this command deletes alljob instances for the specified jobs.

Operands

This command uses a list job names and ID as an operand. The list can optionallybe preceded by the -j | --jobs option.

Flags








Tips:



-I | --instance {instance_id [,instance_id...]}Deletes one or more job instances, specified by ID. The unique ID is specifiedas a hexadecimal value prefixed with 0x (for example, 0x37).

If you do not specify this option, all job instances are deleted for the specifiedjob.

Tip: You can use the lsjobhistory -a command to get a list of all job-instanceIDs for each job.







Tips:







Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 26: An invalid job name or ID was specified.v 29: The specified locale is not valid or not supported.v 60: The job-instance ID was not found.

Examples1. Remove all instances for a specific job

This example illustrates how to remove all instances for the job myjob.smcli rmjobhistory myjob

2. Removes multiple job instancesThis example illustrates how to removes job instances 0x23 and 0x43 for jobs0x54, myjob1, and 0x43.smcli rmjobhistory -I 0x43,0x23 -j 0x54,myjob1,0x43

runjob commandUse the runjob command to run one or more jobs immediately or schedule jobs torun at a specific date and time. You can also schedule a job to repeat automaticallyat a specified interval.


Important: You can schedule only noninteractive tasks, which do not require anyuser input or interaction.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] runjob options


smcli runjob [-h | -? | --help]

smcli runjob [-v] [-o | -p] {-f file_name | [-j] job_list} [-W wait_time]

Description

Running this command is the equivalent to using the Run Now from the actionfrom the Web interface.

If more than one job with the same name exists, the command runs all of the jobs.

By default a job is run indefinitely until complete.

When you run a job, the instance IDs of the jobs are displayed. You can use theinstance ID to get the status of job using the lsjobhistory command. You can alsous the instance ID to cancel the job using the rmjobhistory command.

Operands


Flags




The input data is the list of jobs to run. This list can be a mixture of job namesand IDs, separated by a comma or end-of-line character.





Tips:








Tips:





-o | --oidDisplays the unique IDs associated with the targeted jobs in addition to otherinformation. IDs are displayed as hexadecimal values, prefixed with 0x (forexample, 0x3e).


-p | --pipeDisplays only the unique IDs for the targeted jobs instead of the name. IDs aredisplayed as hexadecimal values, prefixed with 0x (for example, 0x37).

Tips:






-W | --wait seconds






Exit status


are not authorized to perform the action.v 10: The file was not found.v 25: A number-formatting error occurred.v 26: An invalid job name or ID was specified.v 29: The specified locale is not valid or not supported.v 80: The task completed successfully.v 81: The task completed with errors.v 82: None of the tasks completed.v 83: All tasks completed successfully.v 84: All tasks completed with errors.v 85: All the tasks completed with errors.v 86: Some tasks completed, and all of those completely successfully.v 87: Some tasks completed, and all of those completed with errors.v 88: Submission Errorv 126: The task did not complete before the specified wait time. The command is


Examples1. Run a job

This example illustrates how to run the job myJob.smcli runjob myjob

Job myJob submitted with job instance ID 0x8

2. Run a job and display results immediatelyThis example illustrates how to run a long-running job with job ID 0x45. Thecommand exists immediately and the job continues to run in the background.smcli runjob -W 0 myjob

Job myJob submitted with job instance ID 0x8


runtask commandUse the runtask command to run a non-interactive IBM Systems Director task on aspecific system.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] runtask options


smcli runtask [-h | -? | --help]

smcli runtask [-v] [-t system_type] [-W seconds] {-a | -f file_name | -wquery | -i ip_address_list | -N group_list | [-n] system_list}noninteractive_task

Description

None.

Operands

This command uses a noninteractive task title, ID or string ID as an operand.

task_oidThe unique ID of the task, specified as a hexadecimal value prefixed with 0x(for example, 0x37).

Tip: You can use the lstask -o -r command to list all task IDs that are validfor the targeted system.

task_id_stringThe unique ID string of the task, prefixed with a percent sign (%) (for example,%ServerCfgTask). If the string ID contains a comma, prefix the comma with abackslash (\).


task_titleThe title of the task. The task title must be fully qualified with the parent task(for example, grandparent_task_title/parent_task_title/task_title). If the task namecontains a comma, prefix the comma with a backslash (\). Enclose the task titlein quotation marks if it contains a space character.

Tips:

v Task names might not be unique. This command acts on all tasks with thespecified name. Use the -v | --verbose option to generate a message whenthis command targets multiple tasks with the same name. To target a taskthat has a name that is not unique, identify the task by specifying its unique,hexadecimal task ID, or use additional target options to refine the selection.

v Locale-specific task names might not exist for every noninteractive task. Thename specified must match the locale being used by the command lineinterface.

v Use the lstask -r command to list all tasks that are valid for the targetedsystem.


Tip:

v This option cannot be used with the -s | --task option.v An error is displayed if the specified task is not a noninteractive task.

Flags





The input data is the list of noninteractive tasks. This list can be a mixture oftask titles, IDs, and string IDs, separated by a comma and delimited by anend-of-line character.




Tips:



-i | --ipaddress {ip_address | host_name}[,{ip_address | host_name}...]Targets one or more noninteractive targets that can be run on the specifiedsystems, identified by IP address or host name. The list can be a mixture of IPaddresses and host names, separated by a comma.


Tips:



host_nameEither the host name or the host name and Domain Name System (DNS)


suffix of the system. If the host name contains spaces, enclose it inquotation marks. If it contains a comma, prefix the comma with abackslash (\).

Tips:




-n | --names {system_oid | system_name}[,{system_oid | system_name}...]Targets one or more noninteractive tasks that run on the specified systems,identified by name or ID. The list can be a mixture of system names and IDs,separated by a comma.




Tips:



-N | --groups {group_oid | group_name}[,{group_oid | group_name}...]Targets one or more noninteractive tasks that run on the specified groups,identified by name or ID. The list can be a mixture of group names and IDs,separated by a comma.

If the same systems are members of more than one group, they are targetedonly once.




Tips:






Tips:






-W | --wait seconds






Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 27: A specified attribute is not valid.v 29: The specified locale is not valid or not supported.v 50: The specified task or subtask is not valid.v 51: The task name or ID is not unique or valid.


v 52: The task or subtask is interactive.v 53: The task ID was not found.v 54: The task failed to start.v 126: The task did not complete before the specified wait time. The command is


Examples1. Run a task on a system using the task ID string

This example illustrates how to run a non-interactive task with ID stringbluelight_ON on the system named websvr.smcli runtask -n websvr %bluelight_ON

2. Collect inventory on multiple groupsThis example illustrates how to run the collect-inventory task on systems thatare members of the payrollgroup and financegroup groups.smcli runtask -N payrollgroup, financegroup "Inventory/Collect Inventory"

3. Shut down a systemThis example illustrates how to gracefully quiesce all running processes andthen shut down the operating system on systems that are members of themychassis group.smcli runtask -N mychassis "shutdown"

4. Turn power off for a systemThis example illustrates how to gracefully quiesce all running processes, shutdown the operating system, and then power off the system named system1.smcli runtask -n system1 "power off"

5. Turn power off for all virtual serversThis example illustrates how to gracefully quiesce all running processes, shutdown the operating system, and then power off all virtual servers.smcli runtask -a "power off"

6. Turn power on for a systemThis example illustrates how to power on a system named system1.smcli runtask -n system1 "power on"

7. Restart a systemThis example illustrates how to restart a system named system1.smcli runtask -n system1 "restart"

8. Turn on the LED on a systemThis example illustrates how to cause the LED to start blinking on a System xserver named systemx_1.smcli runtask -n systemx_1 %BlueLight_BLINK

9. Turn off the LED on a systemThis example illustrates how to cause the LED to stop blinking on a System xserver named systemx_1.smcli runtask -n systemx_1 %BlueLight_OFF

Update commandsUse the commands in this section to manage updates for systems.



smcli commands

The following smcli task and scheduled job commands are available:

checkupd commandUse the checkupd command to check for new, changed, and superseding updates.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] checkupd options


smcli checkupd [-h | -? | --help]

smcli checkupd [-v] {-a} [-W seconds]

smcli checkupd [-v] [-c] [-W seconds] [-t system_type] [-f file_name | -wquery | -i ip_address_list | -N group_list | [-n] system_list]

Description

By default, this command queries for new, changed, or superseding updates for thespecified systems and for systems that are members of specified groups. It alsochecks for requisite updates that are needed for known updates.

If updates are found, this command downloads the descriptor files, which describethe updates, into the update library and imports the metadata. You can alsodownload installable files for the found updates using the -d | --download option.

Operands

This command optionally uses a list of systems as an operand. The list canoptionally be preceded by the -n | --names option.

Flags


-a | --allAcquires update information for all supported criteria, regardless of whichplatforms or systems are currently being managed.

Tip: This option cannot be used with options that target systems.

Attention: Use this option with care. This option attempts to acquireinformation for all known updates and might take a long time to complete.

-c | --criteriaUses the default criteria for systems rather than update criteria associated withthe compliance checks for each system.

If you specify this option, the default criteria for the targeted systems is used.If you do not specify this option:


v And a compliance policy that is assigned to the targeted systems or groupsexists , the criteria from that compliance policy is used to check for updates.

v And a compliance policy does not exist, no updates will be found. This isnot considered an error condition.

Tip: If you specify this option, you must also specify one or more systems orgroups.



The input data is the list of systems to be considered for the check for updates.This list can be a mixture of names and IDs, separated by a comma orend-of-line character.




Tips:






Tips:




Tips:











Tips:





Tips:








Tips:





Tips:









Tips:




-W | --wait seconds



results. This value is the default if this option is not specified.


v 0: Exits immediately, and the task continues to run in the background. Usethe lsjob or lsjobhistory command to check the status.


Exit status


are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 81: An internal acquisition error occurred.v 86: A server representing the local machine could not be found.v 126: The task did not complete before the specified wait time. The command is

still running in the background.

Examples1. Check for updates on a single platforms using default criteria

This example illustrates how to check for updates for all switches using defaultcriteria.smcli checkupd -c -a -t Switch

2. Check for updates on a system using update criteriaThis example illustrates how to check for updates for the system namedsystem1 using update criteria associated with the system's compliance checks.smcli checkupd -n system1

3. Check for updates on all known systemsThis example illustrates how to check for new updates using all supportedcriteria, regardless of which platforms or systems are currently being managed.

Important: This might take a very long time to complete.smcli checkupd -a

cleanupd commandUse the cleanupd command to clean (that is, delete) update files and informationin the update library.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] cleanupd options



smcli cleanupd [-h | -? | --help]

smcli cleanupd [-v] [-m] [-F] {-a | -f file_name | -P query | [-u]update_list}

Description

This command cleans up the update library. By default, only the installable files inthe update library are deleted. Deleting the update information is optional.

Important:

v An update might have physical files and corresponding information in locationsother than the update library on the management server. These files are notcleaned up.

v You cannot delete update information without also deleting the installable files.If you want to keep the installable update files, create a copy in another locationbefore cleaning in the library.

Operands

This command optionally uses a list of updates as an operand. The list canoptionally be preceded by the -u | --update option.

Flags


-a | --allCleans (deletes) all installable files from the update library.

Tip: If the -m | --metadata option is specified, all update information(metadata) is also deleted.



The input data is the list of IDs or fix IDs for the update, separated by commasor line breaks. See the -u | --updates option for more information.

-F | --forceForces the deletion of update information (metadata) for updates that require,supersede, or contain member updates, and also deletes required updates,superseded updates, and updates that are members of another update.





Tips:



-m | --metadata

Deletes update information (metadata) in addition to installable files andupdate descriptor files in the update library.

Tip: If this option is specified without the -F | --force option, and updateinformation (metadata) is for an update that is required, superseded, or amember of another update, the cleanup for that update will fail.

-P | --patchfilter "query"Targets one or more updates (patches) based on update attributes specified byquery.

The query operand is a string, enclosed in quotation marks, that defines asimple SELECT query using the following format:"attribute_key=’value’ [{AND | OR} attribute_key=’value’...]"

Where attribute_key can be any valid attribute, and value is the value of theattribute. The value must match the expected type for the associated attribute.For example, if the attribute is of type string, a string must be specified.

Tips:

v Use the logical operators =, !=, >, <, >=, or >= between the key and value

v Use logical operators AND or OR to combine attributes.v Use parenthesis to create nested logical constructs.v Only update attributes can be specified. Use the lsupd -l command to list

the available update attributes.v Always enclose query in double quotation marks (for example, "Severity=0").

Do not use quotation marks within the query.v Enclose the value in single quotation marks if it contain special characters,

including space, =, <, >, !, ), and (.v Only update attributes can be specified. Use the lsupd -l command to list the

available update attributes.

-u | --updates {update_oid | update_fix_id}[,{update_oid |update_fix_id}...]

Targets one or more valid updates, specified by ID or fix ID (also called updateID).

The list can be a mixture of IDs and fix IDs, separated by a comma. The list isdelimited by the end-of-line character when read from a file.








Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 55: An error occurred while cleaning one or more updates.v 101: An update being cleaned is dependent on another update. The -F |--force

option must be specified for a successful deletion.v 102: Command could not complete because a database error occurred.

Examples1. Clean all update files and information

This example illustrates how to delete all installable files, update descriptorfiles, and information from the update library.

Important: Use this command with care. It cannot be undone.smcli cleanupd -am

2. Clean update files for multiple updatesThis example illustrates how to delete the installable files for the updates withfix ID brcm_fw_nic_1.0.0_windows_32-64 and ID 0x78 from the update library.The update information is not deleted, so the installable files can bedownloaded again. This command also displays verbose messages.smcli cleanupd -v brcm_fw_nic_1.0.0_windows_32-64,0x78

importupd commandUse the importupd command to import update information and installable files intothe update library on the management server.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] importupd options


smcli importupd [-h | -? | --help]

smcli importupd [-v] [-c] [-s] [-o] [-r] [-W seconds] {path}

smcli importupd [-v] [-c] [-o] [-W seconds] [-u update] {path_list}


Description

This command adds information and files for one or more updates to the updatelibrary on the management system. The update information comes from descriptorfiles identified by path (either specified directly or in the directory). Any updatedocumentation or installable files in the specified path that are associated with theupdate are also copied to the update library.

Operands

This command uses one or more paths, separated by a comma, as an operand.

If you do not specify an update, the path must be the full path and name of one ormore update descriptor files (*.sdd) or the directory that contains one or moreupdate descriptor files. By default, this command first attempts to create updatedescriptor files from existing update information at the given path. Specify the -s| --skipgenerate option to prevent generation of any update descriptor files(*.sdd). If you specify the -r | --recurse option, this command searches allsubdirectories for update descriptor files and update information.

Tip: If the directory or file name in the path contains spaces, enclose the path inquotation marks.

Note: The specified path must be to a local directory. Network mounted directoriescannot be used.

Flags


-c | --cleanCleans (deletes) the original files after the import completes successfully.

Tip: If errors occur during the import, the files are not deleted.




Tips:



-o | --overwriteOverwrites the update if it already exists in the update library.


Tip: If you do not specify this option and the update already exists, the updateis not imported again.

-r | --recurseSearches all subdirectories in the specified path for updates to import.

Tip: You can specify this option only if the operand is a directory. This optionis not valid if the operand is a directory and file name.

-s | --skipgeneratePrevents the generation of any update descriptor files (*.sdd).

Tip: Update descriptor files are generated by default if this option is notspecified.

-u | --updates {update_oid | update_fix_id}Imports one or more files for an existing update, specified by ID or fix ID(update ID), into an existing update.





Tip: To import a new update that is not currently being managed, do notspecify this option.



-W | --wait seconds






Exit status




v 29: The specified locale is not valid or not supported.v 50: The specified update is not valid.v 53: The specified update already exists in the update library on the management

server.v 86: A server representing the local machine could not be found.v 93: An error occurred while parsing the update descriptor file.v 94: An error occurred while generating a descriptor file for this update.v 126: The task did not complete before the specified wait time. The command is


Examples1. Import an update

This example illustrates how to copy the d:\myupdates directory (because it isread-only media) to a temporary writable location on the management server. Itsearches that directory and all subdirectories for update descriptor files (*.sdd)and, if no files are found, automatically generates update descriptor files forplatforms that are known to IBM Systems Director. Then, it imports installablefiles and the update information described in the update-package descriptorfiles into the update library. Finally, the files in the temporary location aredeleted.

Tip: If the d:\myupdates directory is on a read/write file system, the initialcopy to a temporary location will not occur.smcli importupd -c -r d:\myupdates

2. Import an update for IBM iThis example illustrates how to import the SI01234.SAVF save file, which is anIBM i PTF binary, into the update library for the specified update.smcli importupd -o -u SI01234 c:\SI01234.SAVF

installneeded commandUse the installneeded command to update IBM Systems Director servers andagents or to install other types of updates.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] installneededoptions


smcli installneeded [-h | -? | --help]

smcli installneeded [-v] [-t system_type] [-f file_name | -w query | -i{ip_address | host_name} | -N group_list | -n {system_oid | system_name}][-F] [-u update_type_list [-l | -c | import_path | -I]

Description

The installneeded command imports or acquires update information andinstallable files for updates into the update library on the management system.This command also conducts a software inventory of the target systems andinstalls any needed updates to them.


The default behavior is to install only those updates that are needed by the baseproduct. However, you can use the -u option to override this behavior and specifythe update types that you want to install instead.

The installneeded command performs the entire update process, including thefollowing steps:1. Collect inventory on the target system2. Import or acquire updates3. Verify compliance4. Install needed updates5. Collect inventory and verify compliance again

Operands

This command uses the optional path import_path as an operand. The import_path isa path to a directory that contains updates that are already downloaded and readyto import. The import path must be to a local drive; it cannot be to a sharednetwork drive. You cannot specify this path if the -c, -I, or -l options are alsoused.

The path must be the full path of the directory that contains one or more updatedescriptor files. This command searches all subdirectories of the path for updatedescriptor files and update information.

Tip: If the directory or file name in the path contains spaces, enclose the path inquotation marks.

If the -u option is used, one or more update_type values must be specified.However, if the -u option is not used, the update type defaults to Director.

Flags


-c | --checkSpecifies that updates must be acquired from the Internet. This option is usedby default if no other option is specified.




-F | --forceForces the installation of needed updates. If this option is not specified, thecommand displays a list of needed updates and prompts for confirmation tocontinue before installing them.





Tips:



-i | --ipaddress {ip_address | host_name}Targets one system, specified by IP address or host name.


Tips:




Tips:




Note: Passing multiple systems is not supported with the -i option. However,you can use the -N option to pass a group name to the command.

-I | --installInstalls existing updates that were previously imported or acquired from theInternet and place in the updates repository. The default behavior is to installonly those updates that are needed by the base product. However, you can usethe -u option to override this behavior and specify the update types that youwant to install instead.

This option is not valid when used with the -c option or the import_pathoperand.

-l | --listLists available update types that can be used with the -u option.


-n | --names {system_oid | system_name}Targets one system specified by name or ID.





Tips:



Note: Passing multiple systems is not supported with the -n option. However,you can use the -N option to pass a group name to the command.

-N | --groups {group_oid | group_name}Targets all systems in one specified group that is identified by name or OID.

Tip: To target all systems, specify the “All Systems” group.




Tips:


-t | --type system_typeDiscovers one or more systems of the specified type.



Tips:

v This option is not a targeting option by itself. It must be used with anothertargeting option, such as -n | --names or -i | --ipaddress.


v Use the lssys -T command to obtain a list of valid system types.

-u | --updatetypes {update_type}[,{update_type}...]Specifies the types of updates to install. If the -c is used, the -u option alsospecifies the types of updates to acquire from the Internet. If the -u option isused, one or more update_type values must be specified. However, if the -uoption is not used, the update_type defaults to Director.

Tip: To determine a list of valid update types, use the installneededcommand with the -l option.

Notes:

v When using the installneeded command to install updates for update typesother than Director, ensure that you use the -u option with the correctupdate_type. Otherwise, the updates for that update type are not acquiredand are not installed.

v When using -u in combination with import_path to import updates, -u doesnot restrict the update types that are imported; all updates in the suppliedpath are imported.






Tips:




Exit status




v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 25: A number-formatting error occurred.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 60: An error occurred during installation.v 65: Software inventory could not be initiated, or failed.v 86: A server representing the local machine could not be found.v 110: A general failure occurred.v 125: A general failure occurred.

Examples1. Import and install needed updates to the local management server

This example illustrates how to import and install needed updates to the localmanagement server. The -v option writes messages to allow you to trackprogress. The -F option forces the installation of needed updates withoutprompting for confirmation to continue before installing them.smcli installneeded -v -F

2. Import and install needed updates to the local management server with animport pathThis example illustrates how to import and install needed updates to the localmanagement server, with an import_path specified. The import_pathd:\\myupdates is a path to a directory that contains updates to import. The -voption writes messages to allow you to track progress. Because the -F optionis not used, you are prompted for confirmation to continue before installingneeded updates.smcli installneeded -v d:\\myupdates

3. Import updates to the local management server and install needed updates toa specified systemThis example illustrates how to import updates to the local managementserver and install needed updates to the system named mysystem.smcli installneeded -v -n mysystem d:\\myupdates

4. Use the Internet to check for updates, acquire updates, and install neededupdates to the local management serverThis example illustrates how to use the Internet to check for updates, acquirethe updates, and install needed updates to the local management server. Notethat -c is used by default if -l, -c, -I, or import_path are not specified.smcli installneeded -v

5. Use the Internet to check for updates, acquire updates, and install neededupdates to a specified systemThis example illustrates how use the Internet to check for updates, acquire theupdates, and install needed updates to the system named mysystem. Notethat -c is used by default if -l, -c, -I, or import_path are not specified.smcli installneeded -v -n mysystem

6. List update types that can be used with the -u optionThis example illustrates how to list update types that can be used with the -uoption.smcli installneeded -l


7. Use the Internet to check for IBM Systems Director updates, acquire updates,and install needed IBM Systems Directorupdates to a specified systemThis example illustrates how to check for IBM Systems Director updates usingthe Internet, acquire the updates, and install needed IBM Systems Directorupdates to the system named mysystem. This example deals only withupdates that have an update type of “Director”. Note that -c is used bydefault if -l, -c, -I, or import_path are not specified.smcli installneeded -v -n mysystem -u Director

8. Import and install updates to the local management server withoutpreviewing or confirming the updatesThis example illustrates how to import and install updates to the localmanagement server. It uses the –force option so that no preview of neededupdates is shown and no confirmation is needed to install the updates.smcli installneeded -v -F d:\\myupdates

9. Install needed updates to the local management serverThis example illustrates how to install only those existing updates that areneeded by the base product and were previously imported or acquired fromthe Internet.smcli installneeded -v -F -I

10. Install updates for IBM BladeCenter and System x with unique IDThis example illustrates how to install IBM BladeCenter and System x updatesto the system with system_oid 0xa39.smcli installneeded -v -n 0xa39 -F -u systemxandbc

11. Install updates for Linux with IP addressThis example illustrates how to install Linux updates to the system with IPaddress 10.11.9.165.smcli installneeded -v -t OperatingSystem -i 10.11.9.165 -F -u Linux

installupd commandUse the installupd command to install one or more updates on one or moresystems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] installupd options


smcli installupd [-h | -? | --help]

smcli installupd [-v] [-s function] [-F] [-W seconds] [-t system_type] {-ffile_name | -w query | -i ip_address_list | -N group_list | -n system_list}{-P query | -U update_group_list | [-u] update_list}

Description

By default, this command:1. Downloads the specified and requisite installable files if they do not exist in the

update library.2. Distributes the installable files to the systems.


3. Installs requisite updates and restarts the systems, operating system, orsoftware if necessary.

4. Installs the specified update and restarts the systems, operating system, orsoftware if necessary.

5. Performs an inventory discovery on the systems after installation completes.Inventory discovery obtains the latest software levels on the systems.

You can use the --skip option to skip one or more of these steps.

Important: The systems, operating system, or software might be restarted, even ifyou specify the --skip restart option, if the native installation mechanismperforms the restart independent of the IBM Systems Director Server's control.

Operands

This command uses a list of update IDs and fix IDs as an operand. The list canoptionally be preceded by the -u | --update option.

Flags





-F | --forceAttempts to install the updates regardless of whether they apply to the targetsystems.

Only the specified updates are forced. Requisite updates that are not explicitlyspecified will be installed only if they apply to the target systems.

Attention: Use this option with care. Installing updates that do not apply tothe target system can cause the system to become unstable.




Tips:







Tips:




Tips:










Tips:

v The system names might not be unique. This command acts on allsystems with the specified name. Use the -v | --verbose option togenerate a message when this command targets multiple systems with


the same name. To target a particular system that has a name that is notunique, identify the system by specifying its unique, hexadecimal ID, oruse additional target options to refine the selection.




Tips:






Tips:





Tips:



the available update attributes.v Always enclose query in double quotation marks (for example, "Severity=0").

Do not use quotation marks within the query.v Enclose the value in single quotation marks if it contain special characters,

including space, =, <, >, !, ), and (.


v Only update attributes can be specified. Use the lsupd -l command to list theavailable update attributes.

-s | --skip {function}[,{function}...]Skips one or more default steps during installation. You can specify one ormore of these values, separated by a comma:v distribution - Does not download or distribute the specified or requisite

installable files. If you specify this function, the installable files must alreadyexist on the targeted systems.

v discovery - Does not perform an inventory discovery after the installationcompletes. Inventory discovery should be run on the targeted system whenall updates are complete to obtain the latest software levels on the systems.

v requisites - Does not install requisite updates.v restart - Does not restart the systems, operating system, or software during

the installation.




Tips:











-U | --updategroups {update_group_oid |update_group_name}[,{update_group_oid | update_group_name}...]

Targets updates in one or more update groups, specified by name or ID.



update_group_oidSpecifies the unique hexadecimal ID of an update group.

Tip: Use the lsgp -o -m Update command to list all group IDs.

update_group_nameSpecifies the name of an update group. Enclose the user name in quotationmarks if it contains a space character.

Tips:

v The update-group names not locale specific.v Use the lsgp command without any options to list all group names.






Tips:




-W | --wait seconds






Exit status

The following codes are returned by this commandv 0: The operation completed.



are not authorized to perform the action.v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 22: The specified update group is not valid.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 50: The specified update is not valid.v 59: The installable files have not been downloaded.v 60: An error occurred during installation.v 63: A required restart could not be completed.v 65: Discovery could not be initiated.v 126: The task did not complete before the specified wait time. The command is


Examples1. Install an update

This example illustrates how to download, distribute, and install the update fixID of com.ibm.foo_1.0.0 and any requisite updates on the system namedsystem1, and then restart and perform an inventory discovery on the system.smcli installupd -n system1 -u com.ibm.foo_1.0.0

2. Install an update, but skip distributionThis example illustrates how to install the update with ID 0x83 and anyrequisite updates on the system with ID 0x92, and then restart and perform aninventory discovery on the system. The installable files are not downloaded ordistributed.smcli installupd -s distribution -n 0x92 0x83

3. Install an update and skip distribution, requisite updates, and restartThis example illustrates how to install only the update with ID 0x83 on systemsof type OperatingSystem with IP address 9.10.111.100, and then perform aninventory discovery on the system. The installable files are not downloaded ordistributed, requisite updates are not installed, and the system is not restarted.smcli installupd -s distribution,requisites,restarts -i 9.10.111.100-t OperatingSystem -u 0x83

lsupd commandUse the lsupd command to list updates and their attributes.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsupd options


smcli lsupd [-h | -? | --help]

smcli lsupd [-v] [-a ] [-d symbol] [-o | -p] [-A attribute_list [-s] | [{-l[-e]} | -m] [-f file_name | -P query | -U update_group_list | [-u]update_list]


Description

You can use this command list the update files, requisite updates, and supersedingupdates.

If you do not specify any options, this command lists all fix ID (update IDs).

By default, updates are listed one per update per line, and only the update ID isdisplayed. You can list additional attributes using the -A | --attribute options orlist all attributes using the -l | --long option.

Operands

This command uses a list of updates as an operand. The list can optionally bepreceded by the -u | --updates option.

Flags


-a | --allLists information about the update in addition to the specified updateattributes, including:v The documentation files (such as readme files) and installable files that make

up the updatev Requisite updates and softwarev Superseding updatesv Restart actions

-A | --attribute key[,key ... ]


Tip:

v The attributes and attributes values can be locale specific.v You can use the lsupd -l command to list all attributes associated with the

targeted updates.






v If you specify this option with the -l | --long option, the delimiter option isignored.


-e | --expandExpands the long listing to also display a description of the attribute keys.

Note: If you specify this option, you must also specify the -l | --long option.

The information is displayed in this format:key1 (key_string) : value1key2 (key_string) : value2...



The input data is the list of IDs or fix IDs for the update, separated by commasor line breaks.




Tips:



-l | --longDisplay detailed information about each targeted update.

This option lists these values for each update:v DisplayName: The displayable name of the updatev Description: The description of the updatev Version: The version of the update. The version is not applicable to patches

or temporary fixes.v UpdateID: The unique fix ID of all updates of the same provider type.v Severity: The severity of the update, which helps determine the importance

of the update. Possible values are Critical, High, Medium, Low and None.v ComponentName: The identifier of the product that would be updated.v Vendor: The organization that created the update.v RestartType: The kind of restart required if the update is installed.v Superseded: A flag indicating whether this update has been superseded by

another update.v Platform: The hardware platform to which the update applies.v Uninstallable: A flag indicating whether this update can be uninstalled.


v BuildDate: The build date for the update as stated in the update's descriptor(SDD).

v BuildNumber: The build number for this update as stated in the update'sdescriptor (SDD).

v FixType: The type of fix, such as an individual update, a collection ofupdates, or an information-only update.

v PackageType: The update package type as defined by the SolutionDeployment Descriptor standard (for example, base installation ormaintenance)

v SoftwareID: The identifier of the software product to which the updateapplies

v Category : The category (type) of update as defined by the vendorv ImpactStatement: The affect of this update after it is installedv AcquiredDate: The date when the update was downloadedv TotalSize: The total size, in bytes, of all files that belong to this updatev Downloaded: A flag that indicates whether all installable files for the update

have been downloadedv Filenames: The names of the files that belong to the update

-m | --membersLists all updates that are members of each targeted update collection.

Note: This option cannot be used with the -l | --long, -e | --expand, or --a| --all option.

-o | --oidDisplays the unique IDs associated with the targeted updates in addition toother information. IDs are displayed as hexadecimal values, prefixed with 0x(for example, 0x3e).

Tips:


options.




Tips:



the available update attributes.


v Always enclose query in double quotation marks (for example, "Severity=0").Do not use quotation marks within the query.

v Enclose the value in single quotation marks if it contain special characters,including space, =, <, >, !, ), and (.

v Only update attributes can be specified. Use the lsupd -l command to list theavailable update attributes.

-p | --pipe


Tips:




options.

















Tips:




Exit status


are not authorized to perform the action.v 10: The file was not found.v 21: The specified update group is not valid.v 25: A number-formatting error occurred.v 29: The specified locale is not valid or not supported.v 50: The specified update is not valid.

Examples1. List all fix IDs

This example illustrates how to list all update fix IDs (also called updates IDs).smcli lsupd

SA12345com.ibm.usmi.services.updates_1.0.2systemx_1.0.5

2. List all information of an updateThis example illustrates how to list all information for the update with fix IDSA12345.smcli lsupd -l -a SA12345

3. List expanded attributes of an updateThis example illustrates how to list all attributes for the update with fix IDSA12345 and a description of those attributes.smcli lsupd -l -e SA12345

4. List update that match a queryThis example illustrates how to list the fix IDs (also called updates IDs) of allupdates with version 1.2 or 1.3.smcli lsupd -P "Version==’1.2’ OR Version==’1.3’"

5. Sort output by update nameThis example illustrates how to list the update name and version and sort theoutput by update name.smcli lsupd -sA Name,Version

6. List all update collectionsThis example illustrates how to list the names of all updates that are collectionscontaining multiple updates.smcli lsupd -P "FixType=Collection"


lsver commandUse the lsver command to list the current version and, if you have updated theproduct, the previous version of IBM Systems Director that is or was installed onthe system.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] lsver options


smcli lsver [-h | -? | --help]

smcli lsver [-p]

Description

The lsver command lists the current version of IBM Systems Director. Specifyingthe -p option will instead list the previous version of IBM Systems Director, ifapplicable.

Operands

None.

Flags





Tips:



-p | --prevversionLists the previous version of IBM Systems Director installed on the system.

Exit status




are not authorized to perform the action.v 73: The product version was not available.

Examples1. List the currently-installed version of IBM Systems Director

This example illustrates how to list the version of IBM Systems Director that iscurrently installed on the system.smcli lsver

2. List the previously-installed version of IBM Systems DirectorThis example illustrates how to list the version of IBM Systems Director thatwas on the system before the current version was installed.smcli lsver -p

uninstallupd commandUse the uninstallupd command to uninstall (roll back) an update on specifiedsystems.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] uninstallupd options


smcli uninstallupd [-h | -? | --help]

smcli uninstallupd [-v] [-s function] [-W seconds] [-t resource_type] {-ffile_name | -w query | -i ip_address_list | -N group_list | -nresource_list} {-U update_group_list | [-u] update_list}

Description

This command removes or rollbacks the specified updates from one or moresystems. By default, this command:1. Uninstalls the specified update, and restarts the systems, operating system, or

software if necessary.2. Uninstalls requisite updates, and restarts the systems, operating system, or

software if necessary.3. Performs an inventory discovery on the systems after update is removed.

You can use the --skip option to skip one or more of these steps.

Important: The systems, operating system, or software might be restarted, even ifyou specify the --skip restart option, if the native installation mechanismperforms the restart independent of the IBM Systems Director Server's control.

Operands

This command uses a list of update IDs and names as an operand. The list canoptionally be preceded by the -u | --update option.


Flags








Tips:






Tips:




Tips:











Tips:





Tips:






Tips:



-s | --skip function[,{function}...]Skips one or more default functions during installation. You can specify one ormore of these values:v discovery - Does not perform an inventory discovery after the roll back

completes. Inventory discovery should be run on the targeted system whenall updates are uninstalled to obtain the latest software levels on thesystems.

v requisites - Does not uninstall requisite updates.v restart - Does not restart the systems, operating system, or software during

the uninstallation.




Tips:


















Tips:







Tips:




-W | --wait seconds






Exit status




v 10: The file was not found.v 20: A specified system is not valid.v 21: A specified system group is not valid.v 22: The specified update group is not valid.v 26: A specified system type is not valid.v 29: The specified locale is not valid or not supported.v 50: The specified update is not valid.v 61: The specified or requisite update cannot be uninstalled.v 62: An error occurred during uninstallation.v 63: A required restart could not be completed.v 65: Discovery could not be initiated.v 126: The task did not complete before the specified wait time. The command is


Examples1. Uninstall an update

This example illustrates how to uninstall the update with fix IDcom.ibm.foo_1.0.0 and any requisite updates on the system named system1,and then restarts and performs an inventory discovery on the system.smcli uninstallupd -n system1 com.ibm.foo_1.0.0

2. Uninstall an update and skip discovery and restartThis example illustrates how to uninstall the update with ID 0x83 and anyrequisite updates on the systems with IDs 0x92 and 0x123. The systems are notrestart and inventory discovery is not performed after the uninstallationcompletes.smcli uninstallupd -s discovery,restart -n 0x92,0x123 0x83

Web interface commandsUse the commands in this section to manage the IBM Systems Director Webinterface and its users.

smcli commands

The following IBM Systems Director Web interface smcli commands are available:

chgloginmsg commandUse the chgloginmsg command to change the message that is displayed with thelogin prompt for all users.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] chgloginmsg options


smcli chgloginmsg [-h | -? | --help]

smcli chgloginmsg -f file_name | -d directory_name

Description


The chgloginmsg command sets or changes the message that is displayed to allusers when logging in using the Web interface. The message is available to bedisplayed immediately; no server restart is necessary.

Operands

None.

Flags

-d | --dir directory_nameSpecifies the directory of one or more properties files that contain the loginmessage to be displayed with the login prompt through the Web interface. Usethis option when you want to specify multiple properties files, as for loginmessages for multiple languages.

Use the -f | –file option to specify a single properties file. The file must benamed loginMessage.properties. The content of the file can contain HTMLformatting and must use this format:loginMessage=Your custom message

You must specify the absolute path of the directory where the properties filescan be found. For example, you might specify the directory/home/sysadmin/logintext. This directory might include the followingproperties files, where each file supports a different language:

loginMessage.propertiesloginMessage_en.propertiesloginMessage_es.propertiesloginMessage_fr.properties

loginMessage.properties is the default properties file for languages that are notsupported. The other files in this example are for English (_en), Spanish (_es),and French (_fr). Supported languages are the same as those available for yourWeb browser. Check the language settings of your Web browser to determinethe suffix to use for the file name for each language.

The contents of the properties files must be the same as described for the -foption.

Note: This option cannot be used with the -f | –file option.

-f | --file file_nameSpecifies the file name (including the absolute path) of the properties file thatcontains the login message to be displayed with the login prompt. Use thisoption to specify a single properties file. Use the -d | –dir option to specifymultiple properties files.

You must specify the absolute path of the directory where the properties filecan be found, along with the file name. For example: /home/sysadmin/mydir/loginMessage.properties.

The file must be named loginMessage.properties. The content of the file mustuse this format:loginMessage=Your custom message

Note: This option cannot be used with the -d | –dir option.





Tips:



Exit status


are not authorized to perform the action.v 201: The product installation directory could not be determined.v 202: The console installation directory does not exist.v 203: The login message directory could not be created.v 204: A file matching the name of the login message directory exists.v 205: The specified file does not exist.v 206: The specified file is a directory.v 207: The specified directory does not exist.v 208: The specified directory is a file.v 209: The specified directory is empty.v 210: An error occurred copying one or more files.

endSession commandUse the endSession command to end the IBM Systems Director Web interfacesession for the selected user.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] endSession options


smcli endSession [-h | -? | --help]

smcli endSession [-v] {-f file_name | [-u] user_list}

Description

The endSession command ends the IBM Systems Director Web interface session forthe selected user. After the session has been terminated, the user must log back in.

Note: Tasks started during the terminated session will continue to run.


Operands

This command takes a user name as a required operand. The list can optionally bepreceded by the -u | --users option.

Flags




The input data is the list of user names, separated by commas or line breaks.




Tips:



-u | --user user_listSpecifies, by name or ID, one or more valid IBM Systems Director users.

Note: Use the smcli lsuser command to see a full list of authorized IBMSystems Director users.



Exit status


are not authorized to perform the action.v 50: A specified user is not valid.


v 70: A specified user is not active.

Examples1. Log off a user

This example illustrates how to end the IBM Systems Director Web interfacesession for user UserA.smcli endSession -u UserA

importextlps commandUse the importextlps command to import and register external launch points.

Syntax

smcli [-prompt] [-user user_name] [-pw password] importextlps options


smcli importextlps [-h | -? | --help]

smcli importextlps [-v] {-f datafile} [-S] [-c substitution_expression]

Description

The importextlps command imports and registers external launch points with IBMSystems Director.

Operands


Flags


-f | --file file_nameRetrieves data from the input file file_name. The input file defines the externallaunch points to create, and must comply with the appropriate schemadefinition as outlined in the IBM Systems Director SDK. The file_name value isthe full path and file name of the data file. If the path contains spaces, encloseit in quotation marks.

-c | --changetags substitution_expressionSubstitutes specified values for the corresponding custom tags in the templatefile. The substitution_expression must be enclosed in quotation marks, and mustbe in the following format:"<#var1#>=value1,<#var2#>=value2,...,<#varN#>=valueN". In this format,<#varN#> is a custom tag, and valueN is the substitution value with which toreplace the custom tag.





Tips:



-S | --showtagsDisplays the custom tags defined in the template file that must be replaced orcustomized with substitution values before the file can be registered. Customtags can be replaced manually in the file, or dynamically using the -c option.


Exit status


are not authorized to perform the action.v 10: The file was not found.v 29: The specified locale is not valid or not supported.v 40: The input file is not valid.

Examples1. Register launch points using a data file

This example illustrates how to register launch points using the data filec:\datafile.json.smcli importextlps -f c:\datafile.json

2. Register launch points using a data file and substitution valuesThis example illustrates how to register launch points using the data filec:\datafile.json and a specified substitution value of mysys for a custom tag<#hostname#>.smcli importextlps -f c:\datafile.json -c "<#hostname#>=mysys"

listextlps commandUse the listextlps command to list the registered external launch points.

Syntax

smcli [-prompt] [-user user_name] [-pw password] listextlps options


smcli listextlps [-h | -? | --help]

smcli listextlps [-v] [l] [-A applicationID]


Description

The listextlps command lists the external launch points registered with IBMSystems Director.

Operands


Flags


-A | --application applicationIDSpecifies the application ID of the external launch points to list. Omitting thisoption lists all registered external launch points.




Tips:



-l | --longDisplays the external launch point information in the long format.


Exit status


are not authorized to perform the action.v 10: The file was not found.v 29: The specified locale is not valid or not supported.

Examples1. List all registered external launch points

This example illustrates how to list all registered external launch points.smcli listextlps


2. List external launch points that are associated with an application by specifyingan external application IDThis example illustrates how to list the external launch points that areassociated with the application that has an external application ID ofmy_applicationID.smcli listextlps -A my_applicationID

removeextlps commandUse the removeextlps command to remove registered external launch points.

Syntax

smcli [-prompt] [-user user_name] [-pw password] removeextlps options


smcli removeextlps [-h | -? | --help]

smcli removeextlps [-v] {-A applicationID}

Description

The removeextlps command removes registered external launch points from IBMSystems Director.

Operands


Flags


-A | --application applicationIDRemoves the external launch points associated with the specified applicationIDfrom IBM Systems Director.




Tips:





Exit status


are not authorized to perform the action.v 10: The file was not found.v 29: The specified locale is not valid or not supported.

Examples1. Remove external launch points that are associated with an application by

specifying an application IDThis example illustrates how to remove the external launch points associatedwith the application that has an application ID of my_applicationID.smcli removeextlps -A my_applicationID

smcli appliance commandsUse the smcli commands in this section when using IBM Systems Director in anappliance environment.

smcli commands

The following smcli appliance commands are available.

Tip: See Chapter 3, “Appliance commands,” on page 517 for commands that donot run in the smcli interface.

configureHA commandUse the configureHA command to configure nodes for high availability (HA).

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] configureHA options


smcli configureHA [-h | -? | --help]

smcli configureHA -s node -p password --primary-rep-addr address--secondary-rep-addr address --floating-addr address_list [--time-serverserver | --use-primary-as-time-server] [--force-time-sync][--agent-mgr-addr address] [-v] [--tiebreaker-addr address][--network-check-addr address]

Description

Users with smadmin authority can use the configureHA command to configurehigh availability.


Flags

--agent-mgr-addr addressSpecifies the address to use for the active agent manager.

Notes:

v This option is valid only if the --floating-addr option is specified, and isrequired only if multiple floating addresses are specified with the--floating-addr option.

v The address specified with the --agent-mgr-addr option must be in the listof floating addresses specified with the --floating-addr option.

v If the --agent-mgr-addr option is not specified, and the --floating-addroption is specified with a single address, that address is used as the agentmanager address.

--floating-addr "addr,net_interface [addr,net_interface ...]"Specifies one or more floating IP addresses that are to be applied to the nodethat is active. Each IP address is composed of two comma-separated parts: anaddress and a network interface. The subnet mask for the IPv4 addresses andthe prefix length for the IPv6 addresses will be set to the same value as theother addresses on that network adapter. To specify multiple IP addresses,separate each complete IP address from the next with a blank space. Thefollowing example shows how to specify two IP addresses: "9.5.6.1,eth010.1.6.1,eth1".

Note: An IPv4 floating address is required on a given network interface ifboth the primary and secondary nodes have that interface configured for IPv4and if that interface connects both nodes to the same network so those twonetwork adapters can connect with each other over IPv4. An IPv4 floatingaddress is not allowed on a network interface where these conditions are notmet.

An IPv6 floating address is required on a given network interface if both theprimary and secondary nodes have that interface configured for IPv6 with anIP address that is not an auto-configured link-local address and if that interfaceconnects both nodes to the same network so those two network adapters canconnect with each other over IPv6. If only an IPv6 auto-configured link-localaddress is specified on the network interface on each node and that interfaceconnects both nodes, then an IPv6 floating address is optional on that networkinterface. An IPv6 floating address is not allowed on a network interface wherethese conditions are not met.




Tips:




--network-chek-addr address[,address,...]Specifies a list of IP addresses that can be used to verify that the networkadapters for each node are working. All of these IP addresses must be able tobe pinged by both nodes in the high availability environment and consistentlyavailable. At least one IP address is required for each configured networkadapter. For example, eth0 must be able to ping at least one of the IP addressesin the list and eth1, if configured, must also be able to ping at least one of theaddresses.

-p | --password passwordSpecifies the password for the system administrator user on the secondarynode.

--primary-rep-addr addressSpecifies the IP address on the primary node that provides the fastestconnection from the secondary node to the primary node. This address is to beused for data replication between nodes.

-s | --secondary-node nodeSpecifies the secondary node to be configured with the current node in thehigh availability environment.

--secondary-rep-addr addressSpecifies the IP address on the secondary node that provides the fastestconnection from the primary node to the secondary node. This address is to beused for data replication between nodes.

--tiebreaker-addr addressSpecifies an address for each node to use when one node cannot contact theother node. Each node attempts to contact this address to determine if thenode is disconnected from the network. This address is required. It isrecommended to choose one of the specified "network-check" addresses.

--time-server serverSpecifies a time server that the nodes are to use to ensure that their time anddate settings are correct.

Note: Either this option or the --use-primary-as-time-server option isrequired unless the primary node is already configured with a working timeserver.

--use-primary-as-time-serverSpecifies that the primary node is to be used as a time server for both nodes.This option does not ensure that the time and date settings on the nodes arecorrect. This option ensures only that the time and date settings for each nodematch each other.

Notes:

v Either this option or the --time-server option is required unless the primarynode is already configured with a working time server.

v This option should be used only if the nodes are on a private network thatdoes not have access to a time server.




Exit status


are not authorized to perform the action.v 29: The specified locale is not valid or not supported.v 125: An unknown failure occurred.

Examples1. Configure high availability

This example illustrates how to configure high availability using only requiredoptions. In this example, the primary node already has a time serverconfigured. IPv4 is configured on the eth0 node. IPv6 is not configured on theetho node and the eth1 node is not configured.smcli configureHA --secondary-node node2 --password abcdefgh

--primary-rep-addr 10.6.6.100--secondary-rep-addr 10.6.6.101--floating-addr "10.6.6.200,eth0"--network-check-addr 10.6.6.1

2. Configure high availability with a time server and multiple floating addressesThis example illustrates how to configure high availability, specify a timeserver, and an IPv4 and IPv6 floating address

smcli configureHA --secondary-node node2 --password abcdefgh--primary-rep-addr 10.6.6.100--secondary-rep-addr 10.6.6.101--floating-addr "10.6.6.200,eth0 fe80::200:ff:feff:0200,eth0"--network-check-addr 10.6.6.1--tiebreaker-addr 10.6.6.1--time-server time.yourcompany.com

3. Configure high availability with multiple floating IP addresses and multiplenetwork check addressesThis example illustrates how to configure high availability with multiplefloating IP addresses, multiple network check addresses, and other options.

smcli configureHA --secondary-node node2 --password abcdefgh--primary-rep-addr 10.6.6.100--secondary-rep-addr 10.6.6.101--floating-addr "10.6.6.200,eth0 fe80::200:ff:feff:0200,eth0

192.168.6.200,eth1"--agent-mgr-addr 10.6.6.200--network-check-addr "10.6.6.1,fe80::200:ff:feff:abcd,192.168.6.1"--tiebreaker-addr 10.6.6.1--use-primary-as-time-server

4. Configure high availability with additional optionsThis example illustrates how to configure high availability with all otheroptions.

smcli configureHA --secondary-node node2 --password abcdefgh--primary-rep-addr 10.6.6.100--secondary-rep-addr 10.6.6.101--floating-addr "10.6.6.200,eth0 fe80::200:ff:feff:0200,eth0

192.168.6.200,eth1 fe81::300:ff:feff:0300,eth1"--agent-mgr-addr 10.6.6.200--network-check-addr "10.6.6.1,fe80::200:ff:feff:abcd,

192.168.6.1,fe81::300:ff:feff:abcd"--tiebreaker-addr 10.6.6.1--time-server time.yourcompany.com

5. Configure high availability using only IPv6


This example illustrates how to configure high availability using IPv6 andadditional options.smcli configureHA --secondary-node node2 --password abcdefgh

--primary-rep-addr fe80::200:ff:feff:0100--secondary-rep-addr fe80::200:ff:feff:0101--floating-addr "fe80::200:ff:feff:0200,eth0 fe81::300:ff:feff:0300,eth1"--agent-mgr-addr fe80::200:ff:feff:0200--network-check-addr "fe80::200:ff:feff:abcd,fe81::300:ff:feff:abcd"--tiebreaker-addr fe80::200:ff:feff:abcd--time-server time.yourcompany.com

failover commandUse the failover command to start a failover to the passive node.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] failover options


smcli failover [-h | -? | --help]

smcli failover [-v | -r]

Description

Users with smmgr authority can use the failover command to start a failover tothe passive node.

Flags




Tips:



-r | --return-immediateReturns from this command as soon as the failover task is created withoutwaiting for the task to succeed or fail.

Note: Specifying this option could result in a successful return code in a casewhere the failover actually fails.




Exit status


are not authorized to perform the action.v 60: Failover is already in progress.v 61: Failover could not start. Data is not synchronized between active and passive

nodes. Wait a few minutes and try again.v 125: Unknown failure.

Examples1. Start a failover to the passive node

This example illustrates how to start a failover to the passive node.smcli failover

2. Start a failover to the passive node and return immediatelyThis example illustrates how to start a failover to the passive node and returnfrom the command as soon as the failover task is created.smcli failover -r

removeHA commandUse the removeHA command to remove the high availability (HA) configurationfrom the active node and the corresponding passive node.

Syntax

smcli [-c] [-prompt] [-user user_name] [-pw password] removeHA options


smcli removeHA [-h | -? | --help]

smcli removeHA [--discard-floating-addrs]

Description

Users with smmgr authority can use the removeHA command to remove the highavailability configuration from the active node and the corresponding passivenode.

This command reboots only the active node. After the command completes, theactive node is ready for use but is no longer in a high availability environment.The passive node is also not in a high availability environment, and is in anunusable state. To put the passive node back into a usable state, you must reinstallit.


Flags

--discard-floating-addrsSpecifies to not automatically assign the floating IP addresses on the activenode as static IP addresses when removing the high availability configuration.

If this option is not specified, those floating IP addresses are assigned as staticIP addresses to the active node, which is the only node that is usable after highavailability configuration is removed.




Tips:



Exit status



Examples1. Remove high availability configuration

This example illustrates how to remove high availability configuration fromboth the active and passive nodes.smcli removeHA


Chapter 2. Management server and agent commands

Use the commands in this section to perform tasks on the management server andagents, including starting and stopping IBM Systems Director processes,configuring the database, configuring security, managing Common InformationModel (CIM) subscriptions, and more.

Tips:

v These commands do not run in the smcli interface.v Not all commands are supported on all operating systems.

agentreg commandUse the agentreg command to register the agent with IBM Systems Director Server.

Syntax

On Linux: agentreg.sh [--help][-l server location][-c certificate path][-eendpoint IP address] [-f configuration file] [-p server listener port][-vverbose]

On Windows: agentreg.bat [--help][-l server location][-c certificate path][-e endpoint IP address] [-f configuration file] [-p server listenerport][-v verbose]

Description

The Agent registration command notifies IBM Systems Director Server that thePlatform Agent is now installed and must be managed by that server. IBM SystemsDirector Server discovers and provides access to the Platform Agent through thecertificate that is specified on this command.

Agent-initiated discovery allows access to Platform Agent that runs on a managedsystem without requiring any credentials from IBM Systems Director Server. Afteryou install the Platform Agent on the endpoint, run the Agent registration utility toautomatically notify the production IBM Systems Director Server.

Note: The agentreg command requires the Platform Agent to run on a managedsystem.

Operands


Flags

-cSpecifies the absolute path of the configuration file that contains the certificateto use on IBM Systems Director Server. This certificate file must be in privacyenhanced mail (PEM) format and contain only one certificate.

-eSpecify this option and provide the exact IP address to communicate with IBM


Systems Director Server. This option is mandatory and the system displays anerror message if the option is not specified.

-fSpecifies the configuration file that contains the configuration information. Theformat of the configuration file is one line per IBM Systems Director Server.The format starts with the server location and certificate path and an optionalport, and the parameters that are delimited by using a space character. Therequired parameters are either this parameter or the server location and thecertificate path.

The following example shows the format of the configuration file.#Server Location Endpoint IP Certificate Path Port19.12.33.12 9.122.15.4 /etc/certs/isd1.pem 6989sys1.mydomain 9.122.15.4 /home/user4/isd2.cert

Any line that starts with hash (#) character before the line is commented out inthe configuration file and is therefore ignored by the Agent registration utility.

Note: The configuration file is present in the /opt/ibm/platform/bin directoryof IBM Systems Director Server.


-pSpecifies the port that IBM Systems Director Server is listening for CIMindications. The port is an optional parameter. If you do not specify the portnumber, the default value of 6989 is used by IBM Systems Director Server.

-lSpecifies the IP address or host name of IBM Systems Director Server that isused for registering the Platform Agent. The specified host name or IP addressis used to send the indication to IBM Systems Director Server from the agent.

-vPrints verbose output of the data.

Examples

Note: For all the examples that use the Windows agentreg.bat, replaceagentreg.bat with cfguserreg.sh to use the example on Linux.1. Install and start IBM Systems Director Server.2. In IBM Systems Director Web interface navigation area, expand Settings, and

then click Server Preferences.3. In the Inventory pane, select Operating System from the Resource Type list.4. Select Automatically Add check box from the Resources That Contact the

Server list. This configuration allows the administrator to turn on the abilityfor the Platform Agents to notify IBM Systems Director Server when they areavailable.

5. Generate IBM Systems Director Server certificate by using the smclicommand.Usage: smcli lscert -o [output file]

smcli lscert --help

The List Certificate command is a utility that can be used for retrievingIBM Systems Director Server default X509 certificate from the keystore. This


certificate file must be in the PEM format, and contains the Public Key thatcan be transferred to endpoints and imported on the Agent to enable theAgent to trust IBM Systems Director Server .Usage: smcli lscert -o | --outfile [output file]

The required parameter specifies the fully qualified path of the file to outputthe X509 certificate. If the certificate file exists with this name in the location,the file is overridden with the output.

Note: : The command works up to IBM Systems Director Server version 6.3.For IBM Systems Director Server versions later than 6.3, run the followingcommand on Linux systems:/opt/ibm/director/agent/_jvm/jre/bin/keytool -rfc -export -alias secureclient -file directorcert.pem-keystore /opt/ibm/director/data/cim/keystore/ibmd_cert.jks -storepass iSBi06jA

For Windows systems, run the following command:C:\Program Files\IBM\Director\jre\bin>keytool -rfc -export -alias secureclient -file directorcert.pem-keystore "c:\program files\ibm\director\data\cim\keystore\ibmd_cert.jks" -storepass iSBi06jA

6. Install the Platform Agent on the managed system.7. Copy IBM Systems Director Server certificate to any location on the agent

system8. Log in to the agent system by using the administrator credentials and run the

agentreg command to register the agent with IBM Systems Director Server.Usage:agentreg -l [server location] -e [endpoint IP address] -c [certificate path] -p [server listener port]agentreg -f [configuration file]agentreg --help

C:\Program Files\Common Files\ibm\icc\cimom\bin\agentreg -l 10.32.38.52 -e 9.122.15.4 -c \home\directorcert.pem -p 6989

9. Verify whether the endpoint is unlocked by IBM Systems Director Server. Toverify log in to IBM Systems Director Server console, then Navigate Resource> OS MEPs. Search for the host name or IP address that is trying to beregistered. If the endpoint is still locked, run the command again until IBMSystems Director Server unlocks the endpoint.

Note:

v The agentreg command not does not generate any error message if there isa failure to notify IBM Systems Director Server. Verify the Agent traces orsyslog messages for failed notifications to IBM Systems Director Server.

v After endpoint is unlocked, the Managed endpoint (MEP) status changes tothe "Partial Access" state.

10. Use the Configure Access page to manually unlock the remote service accesspoint (RSAP) such as Secure Shell (SSH) or Distributed Component ObjectModel (DCOM) protocol. This step is used to retrieve a full inventory data.

11. When all parameters are correct and CIM server is running, the agentregcommand runs and exits. Any indication of delivery failure is not handled bythis utility.

cfgdbcmd commandUse the cfgdbcmd command to configure and initialize the connection from the IBMSystems Director management server running AIX, Linux, or Windows to a local orremote database other than the managed IBM DB2 database. To switch to themanaged IBM DB2 database, instead use the installdb2 command.

Chapter 2. Management server and agent commands 467

Syntax

cfgdbcmd.sh -usage

On AIX and Linux: cfgdbcmd.sh [-dbAdmin user_ID] [-dbAdminPW password][-dbLocal {true | false}] [-noPrompt {true | false}] {-rspfileresponse_file}

On Windows: cfgdbcmd.cmd [-dbAdmin user_ID] [-dbAdminPW password][-dbLocal {true | false}] [-noPrompt {true | false}] {-rspfileresponse_file}

Description

Important: After using this command to change the database connection andbefore starting IBM Systems Director Server, you must run the smreset commandin order to reset IBM Systems Director. All master data and database data will belost, and existing data is not migrated.

Prerequisite:

v You must close all applications that are accessing the database before runningthis command.

v Ensure the cfgdbcmd response file you are using has the appropriate permissionsset. If you are using the cfgdbcmd response file at location director_root\proddata\cfgdbcmd.rsp then you can disregard this bullet. The appropriate filepermissions are already set.

You can run the cfgdbcmd command locally from the management server orremotely by accessing the management server using a remote-access utility such asSecure Shell (SSH) or Telnet. Always use credentials with administrator rights onthe management server, or the cfgdbcmd tool might not complete successfully.

To run the cfgdbcmd command, navigate to the install_root\bin directory, whereinstall_root is the root directory of your IBM Systems Director installation. Note thatthis path uses the backslash (\) to delimit the directory; depending on the systemthat you are using, you might be required to enter the path using the forwardslash (/).

When configuring a new IBM DB2 or Microsoft SQL Server connection, you do notneed to create a database before configuration. This command creates the databaseusing the name specified in the database configuration response file. Whenconfiguring a new Oracle® Database connection, you must prepare the databaseyourself beforehand.

When configuring a database connection for the first time, you are prompted toenter values for the -dbAdmin and -dbAdminPW options if they are not alreadyspecified.

Note: The -dbAdmin and -dbAdminPW values are only used for the duration of thecommand. IBM Systems Director does not store (cache) these values on the filesystem.

Tip: The option keywords are case sensitive.


If you are using Oracle® Database for the system management database, you mightwant to adjust the setting for the maximum number of open cursors or change thenumber of cached prepared statements. By default, IBM Systems Director cachesprepared statements that typically open a cursor with the database. The number ofopen cursors can grow to exceed the maximum number that is defined for thedatabase, resulting in a ORA-00604 error from Oracle® Database. To prevent thiserror, increase the Oracle® Database OPEN_CURSORS property or change the IBMSystems Director statement cache size in the /lwi/conf/overrides/database.properties file. It is recommended that you specify an OPEN_CURSORSvalue that is 25% larger than the maximum number of statements that IBMSystems Director will cache. You can calculate this value by taking the sum of theproducts of the maxActive and maxOpenPreparedStatement properties for eachdefinition in the database.properties file. The following examples illustrate howto calculate the OPEN_CURSORS value. To change the OPEN_CURSORS property,either update the Oracle® Database init.ora file or use the ALTER SYSTEMcommand to update the SPFILE (system parameter file).=================================rcs.maxActive = 3rcs.maxOpenPreparedStatements = 1000

usmi.maxActive = 3usmi.maxOpenPreparedStatements = 200=================================

OPEN_CURSORS setting = ((3*100) + (3*200)) * 1.25

Important: For all changes to take effect, you must restart the Oracle® Databaseserver after changing the init.ora file, and you must restart IBM Systems DirectorServer after changing the database.properties file.

Flags

-dbAdmin user_IDSpecifies the user ID for the database system administrator to use for thedatabase configuration.

Tip: Specifying this option is optional, but the user ID is potentially stillrequired. If it is required but not specified, you will be prompted to enter avalue. If you are trying to configure for Microsoft SQL Server with integratedsecurity and you do not specify this option, the user ID will default to that ofthe active Windows user.

-dbAdminPW passwordSpecifies the user password for the database system-administrator user.

Attention: Do not specify this option and prompt for it. On AIX and Linuxconfigurations, other users on the machine can see the admin user ID andpassword if they run the ps command while the cfgdbcmd process is running.

Tip: Specifying this option is optional, but the user password is potentially stillrequired. If it is required but not specified, you will be prompted to enter avalue. If you are trying to configure for Microsoft SQL Server with integratedsecurity and you do not specify this option, the user password will default tothat of the active Windows user.

-dbLocal {true | false}Specifies whether the database server is local. Possible values are:v true: The database server is local, meaning that it resides on the same

system as IBM Systems Director Server. This value is the default.


v false: The database server is remote, meaning that it resides on a differentsystem than the IBM Systems Director Server.

Tip: This parameter is required if you want to connect to a remote databaseserver.

-noPrompt {true | false}Specifies whether this command prompts you before continuing. Possiblevalues are:v true: The command continues without prompting.v false: The command prompts you when IBM Systems Director Server needs

to stop to ensure that no other applications are using the database. Thisvalue is the default if this option is not specified.

-rspfile "response_file"Specifies the fully-qualified path of the response file that contains thedatabase-configuration information.

IBM Systems Director provides a default response file named cfgdbcmd.rsp,located in the install_root\proddata directory, where install_root is the rootdirectory of your IBM Systems Director installation. Note that this path usesthe backslash (\) to delimit the directory; depending on the system that youare using, you might be required to enter the path using the forward slash (/).When IBM Systems Director Server is installed, a response file is created basedon the default in the install_root directory.

Important:

v (Windows only) You must enclose the fully-qualified response file path inquotations.

v Ensure that the response file is correctly configured before running thiscommand. See “Configuring the database application after IBM SystemsDirector installation” for details.

-usageDisplays detailed information about the command, including the syntax, adescription of the command, a description of the options and operands, errorcodes, and examples.

Exit status

The following codes are returned by this command.v 0: The operation completed.v 1: An error occurred. For more information, view the log file located at

install_root\log\cfgdbmd.log, where install_root is the root directory of your IBMSystems Director installation. Note that this path uses the backslash (\) todelimit the directory; depending on the system that you are using, you might berequired to enter the path using the forward slash (/). There is also aninstall_root\log\cfgdbcmd-install.log file that keeps track of the success ofthe IBM Systems Director database configuration during installation.



Examples1. Configure a remote database

This example illustrates how to configure a remote database other than themanaged IBM DB2 database for the first time or switch to a database other


than the managed IBM DB2 database using the data stored in the cfgdbcmd.rspresponse file and the database system administrator ID and password. Thisexample is run from a management server that is running Windows.cfgdbcmd.cmd -rspfile “install_root\proddata\cfgdbcmd.rsp”-dbAdmin admin -dbAdminPW passw0rd -dbLocal false

where install_root is the root directory of your IBM Systems Directorinstallation.

2. Configure or switch to a local non-embedded IBM DB2 databaseThis example illustrates how to configure or switch to non-embedded IBM DB2for the first time using the data stored in the response file cfgdbcmd.rsp andthe default IBM DB2 administrator ID and password.

Note: To switch from a database other than IBM DB2 to the managed IBM DB2database, instead use the installdb2 command.This example is run from a management server that is running Windows. Theapplicable section in cfgdbcmd.rsp would resemble the following example:DbmsApplication = DB2DbmsTcpIpListenerPort = 50000DbmsServerName = 10.10.10.10DbmsDatabaseName = dirdbDbmsUserId = myUserIDDbmsPassword = myPasswordDbmsDatabaseAppHome = C:\Program Files\IBM\SQLLIB

You would then run the following cfgdbcmd command:cfgdbcmd.cmd -rspfile "C:\Program Files\IBM\Director\proddata\cfgdbcmd.rsp"-dbAdmin db2inst1 -dbAdminPW password -dbLocal true

3. Configure or switch to a remote Oracle® Database databaseThis example illustrates how to configure or switch to remote Oracle® Databasefor the first time using the data stored in the response file cfgdbcmd.rsp and anOracle® Database administrator ID and password. This example is run from amanagement server that is running Windows. The applicable section incfgdbcmd.rsp would resemble the following example:DbmsApplication = OracleDbmsTcpIpListenerPort = 1521DbmsServerName = 10.0.0.72DbmsDatabaseName = MYDATABASEDbmsUserId = useridDbmsPassword = mypwdDbmsDatabaseAppHome = c:\oracle\product\10.2.0\client_1

You would then run the following cfgdbcmd command:cfgdbmcd.cmd -rspfile "C:\Program Files\IBM\Director\proddata\cfgdbcmd.rsp"-dbAdmin oracleAdmin -dbAdminPW oracleAdminPW -dbLocal false

4. Configure or switch to a local Microsoft SQL Server 2005 database withWindows authenticationThis example illustrates how to configure or switch to the Microsoft SQL Server2005 database for the first time using the data stored in the response filecfgdbcmd.rsp. This example is run from a management server that is runningWindows. The applicable section in cfgdbcmd.rsp would resemble the followingexample:


DbmsApplication = SQLServerDbmsTcpIpListenerPort = 1433DbmsServerName = 10.10.10.10DbmsDatabaseName = DIRDBDbmsDatabaseAppHome = C:\sqljdbc2\sqljdbc_2.0\enuDbmsIntegratedSecurity = true

You would then run the following cfgdbcmd command:cfgdbcmd.cmd -rspfile "C:\Program Files\IBM\Director\proddata\cfgdbcmd.rsp"

cfguserreg commandUse the cfguserreg command to configure the authentication registry for IBMSystems Director.

Syntax

On AIX and Linux: cfguserreg.sh [--help] [-os] [-ldap [-verify] [-ffile_name] -admin user -base base_distinguished_name -checkgroup group_list-checkuser users_list -default LDAPtype –host LDAP_server_host_name-password password -port LDAP_port -base LDAPBase -searchfiltersearch_filter -ugfilter filters.usergroup -ufilter filters.users–memAtrRole names.memberAttribute -login loginName [-ssl –keyStorekeystore_file_path -trustStore ssl.trustStore –keyStorePasswordkeystore_password -trustStorePassword truststore_password]] [-normalizeclass_name]

On Windows: cfguserreg.bat [--help] [-os] [-ldap [-verify] [-f file_name]-admin user -base base_distinguished_name -checkgroup group_list -checkuserusers_list -default LDAPtype –host LDAP_server_host_name -password password-port LDAP_port -base LDAPBase -searchfilter search_filter -ugfilterfilters.usergroup -ufilter filters.users –memAtrRole names.memberAttribute-login loginName [-ssl –keyStore keystore_file_path -trustStoressl.trustStore –keyStorePassword keystore_password -trustStorePasswordtruststore_password]] [-normalize class_name]

Description

Used without any option, the cfguserreg command displays which authenticationregistry is used currently. If specified with –os, IBM Systems Director will beconfigured to use the local OS registry for authentication. When specified with–ldap and all its required properties, IBM Systems Director will be configured touse LDAP as its authentication registry. The user can also verify the LDAPproperties using the –ldap –verify option. By default, the IBM Systems DirectorServer will not be restarted to use the new security configuration.

You can run this command as a non interactive command.

Operands



Flags


-admin userSpecifies the distinguished name of the Administrator as defined on the LDAPserver.

-base base_distinguished_nameSpecifies the base (root) distinguished name defined on the LDAP server.

-checkgroup groups_listVerifies if one or more groups are present on the LDAP server and displays thelist of all the users that belong to the groups. Specify a list of groups using acomma-separated list.

-checkuser users_listVerifies if one or more users are present on the LDAP server and displays thelist of all the groups to which the user belongs. Specify a list of users using acomma-separated list.

-default LDAP_typeValidates the LDAP with pre-defined filters. The LDAP type must be specified.Select one of the following LDAP types:v TDSv ADv ADAMv OpenLDAPv Oracle

-host LDAP_server_host_nameSpecifies the host name of LDAP server.

-keyStore keystore_file_pathSpecifies the client keystore file path.

-keyStorePassword keystore_passwordSpecifies the keystore password.

-ldap {with all required parameters}Configures IBM Systems Director to use LDAP as its authentication registry.

-ldap -f file_name {with all required parameters}Configures IBM Systems Director to use the specified LDAP server as itsauthentication registry with the specified properties file.

-ldap -verify {with all required parameters}Verifies settings for the specified LDAP server to ensure that it can be used forauthentication.1. Verifies that IBM Systems Director can communicate with the LDAP host.2. Verifies that required groups smadmin, smmgr, smmon, and smuser exist.3. Verifies that at least one user exists in smadmin group, so that the user will

be able to log on to IBM Systems Director.

-ldap -verify -f file_name {with all required parameters}Verifies LDAP settings in the specified file for the specified LDAP server toensure that it can be used for authentication.


1. Verifies that IBM Systems Director can communicate with the LDAP host.2. Verifies that required groups smadmin, smmgr, smmon, and smuser exist.3. Verifies that at least one user exists in smadmin group, so that the user will

be able to log on to IBM Systems Director.

-login loginNameSpecifies the login name of the user in the directory.

-memAtrRole names.memberAttribute[,{names.memberAttribute}...]Specifies the name of the member attribute of the role object in the directory.To specify more than one member attribute, separate each value by a comma.

-normalize class_nameSpecifies the name of the class that will be used to normalize the user name.

Some user registries support case-sensitive complete user names while othersdo not. For example, BOB, bOb, or boB are three different users on Windows.The option determines how all the user names are passed to underlyingregistry.v If user names on the LDAP server are configured as non-case-sensitive

fields, then use the com.ibm.security.jaas2lwi.CaseNormalizeUsernameclassname as its value.

v If user names on the LDAP server are configured as case-sensitive fields,then use com.ibm.security.jaas2lwi.NativeNormalizeUsername classname asits value.

-osConfigures IBM Systems Director to use Operating System Users as itsauthentication registry.

-password passwordSpecifies the password of the Administrator user defined on the LDAP server.

-port LDAP_portSpecifies the listening port defined on the LDAP server.

-searchfilter search_filterSpecifies user search filter to use on the LDAP server.

-sslEnables or disables LDAP SSL communication

-trustStore ssl.trustStoreSpecifies the client truststore file path.

-trustStorePassword truststore_passwordSpecifies the truststore password.

-ufilter filters.usergroupSpecifies the LDAP filter string used to search the directory for group objects.

-ugfilter filters.usersSpecifies the LDAP filter string used to search the directory for user objects.

-vLists all the users and groups on the LDAP server.

-verifyLoginVerifies the user credentials on the LDAP server.


Exit status


are not authorized to perform the action.v 2: Not all required groups exist on the LDAP server.v 3: No user exists in smadmin group in LDAP server.v 29: The specified locale is not valid or not supported.

Examples

Note: For all the examples using the Windows cfguserreg.bat, replacecfguserreg.bat with cfguserreg.sh in order to use the example on AIX or Linux.1. See the current authentication registry

cfguserreg

2. Set the authentication registry for IBM Systems Director to the users andgroups of the operating system on the servercfguserreg -os

3. Verify the Tivoli Directory Server LDAP server (without ssl) settings forconfiguration to be set as authentication registry for IBM Systems Directorcfguserreg -ldap -verify -host 10.2.3.89 -port 389-base "DC=systemx,DC=sc,DC=ibm,DC=com"-searchfilter "(&(uid=%v)(objectclass=ePerson))"-ugfilter "(|(objectclass=groupOfNames)

(objectclass = groupOfUniqueNames))"-ufilter "(objectclass=person)"-memAtrRole member -login uid

4. Set Active Directory Server LDAP server (with ssl) settings for configurationto be set as authentication registry for IBM Systems Directorcfguserreg -ldap -host 10.2.3.91 -port 636-base "DC=systemx,DC=sc,DC=ibm,DC=com"-searchfilter "(&(sAMAccountName=%v)(objectcategory=user))"-ugfilter "(|(objectCategory=group)

(objectCategory = groupOfNames))"-ufilter "(|(objectCategory=person)(objectCategory=user))"-memAtrRole member -login sAMAccountName -ss1-keystore "security/keystore/clientKeyStore.jks"-keyStorePassword #########-trustStore "security/keystore/clientTrustStore.jks"-trustStorePassword #########

5. Set authentication registry to LDAP using ldap.properties file for LDAPsettingscfguserreg -ldap -f c:\ldap.properties

6. Verify LDAP settings through a non interactive scriptcfguserreg.bat -host servername -port ldapport-searchfilter searchfilter -ugfilter ugfilters -ufilter ufilters-login loginName -memAtrRole member-ssl -keyStore filepath -keyStorePassword #####-trustStore filepath -trustStorePassword ####-normalize com.ibm.security.jaas2lwi.CaseNormalizeUsername

7. Configure IBM Systems Director to use LDAP as its authentication registrythrough a non-interactive scriptcfguserreg.bat -host servername -port ldapport-searchfilter searchfilter -ugfilter ugfilters-ufilter ufilters -login loginName -memAtrRole member -ssl-keyStore filepath -keyStorePassword #####-trustStore filepath -trustStorePassword ####-normalize com.ibm.security.jaas2lwi.CaseNormalizeUsername


8. The following command validates if the LDAP Sever can be configured withdefault filter values.cfguserreg.sh -ldap -default TDS -host 192.168.1.120

-admin "cn=root,dc=lab,dc=ibm,dc=com"-password passw0rd -base "dc=ibm,dc=com"

9. The following command validates if the user and the group are present on theserver.cfguserreg.sh -ldap -verify -f security.properties -checkuser user1,user2

-checkgroup group1,group2

10. The following command validates if the user credentials are correct by a loginattempt on the LDAP Server.cfguserreg.bat -ldap -verifyLogin -host 192.168.1.120

-admin "cn=user1,dc=ibm,dc=com" -password passw0rd

changePassword toolUse the changePassword tool to change the password for the database user ID inIBM Systems Director. The tool is located in the install_root\bin directory.

Syntax

On Linux: changePassword.sh [-h]

On Windows: changePassword.cmd [-h]

Description

Important:

v The changePassword tool changes the password for the database user with whichIBM Systems Director is configured. If you have not already done so, you mustalso manually change the password for the database that you are using.

v You should run the changePassword tool when IBM Systems Director Server isstopped, and you must restart IBM Systems Director for changes to take effect.

v If you are changing the password for a managed IBM DB2 database, themanaged IBM DB2 database user ID is updated as well as the configurationinformation. For most other database types, only the configuration informationis updated and you are responsible for using the specific tool to update the userID.

v If you are using Microsoft SQL Server with integrated security, then you do notneed to run the changePassword tool because the Windows credentials are notstored.

v If you are using Storage Control, once the changePassword tool completes youmust complete the steps listed in the "Cannot communicate with Storage Controlafter changing the IBM DB2 password" topic.

Note: For more information on passwords see: Tips for database user authoritiesand passwords.

Flags

new_passwordSets the password for the database account that IBM Systems Director uses toaccess the configured database. Parameter is optional. If you do not specifythis parameter and if this is managed DB2, the system generates a password


||

||

http://pic.dhe.ibm.com/infocenter/director/pubs/index.jsp?topic=%2Fcom.ibm.director.configdir.helps.doc%2Ffqm0_t_user_auth_tips.html

http://pic.dhe.ibm.com/infocenter/director/pubs/index.jsp?topic=%2Fcom.ibm.director.configdir.helps.doc%2Ffqm0_t_user_auth_tips.html

for the user. If you do not specify this parameter and if this is an externaldatabase, the user will be asked to enter the information.



-forcePromptIf you specify this option, it asks the user to enter a password to use. On Linuxor AIX systems, specify this option to avoid exposing the password to otherusers who might be running the ps command

Exit status

The following table contains the codes returned by this command.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you


cimsubscribe commandUse the cimsubscribe command on systems running Windows or Linux to manageCIM subscriptions for Common Agent.

Syntax

cimsubscribe {-h | -?}

cimsubscribe -b batch_filename

cimsubscribe -cf -fn filter_name -q query [-s {[no] | yes {{-u user_name -ppassword} | {-c certificate_file -k key_file}}}] [-n namespace] [-llocation]

cimsubscribe -ch -hn handler_name -d destination [-s {[no] | yes {{-uuser_name -p password} | {-c certificate_file -k key_file}}}] [-nnamespace] [-l location]

cimsubscribe -cs -fn filter_name -hn handler_name [-s {[no] | yes {{-uuser_name -p password} | {-c certificate_file -k key_file}}}] [-nnamespace] [-l location]

cimsubscribe -df -fn filter_name [-s {[no] | yes {{-u user_name -ppassword} | {-c certificate_file -k key_file}}}] [-n namespace] [-llocation]

cimsubscribe -dh -hn handler_name [-s {[no] | yes {{-u user_name -ppassword} | {-c certificate_file -k key_file}}}] [-n namespace] [-llocation]

cimsubscribe -ds -fn filter_name -hn handler_name [-s {[no] | yes {{-uuser_name -p password} | {-c certificate_file -k key_file}}}] [-nnamespace] [-l location]

cimsubscribe -i


||

|

cimsubscribe -lf

cimsubscribe -lh [-u user_name -p password -n namespace -l unsecurelocation]

cimsubscribe -lh [-u user_name -p password -n namespace -l secure location-s yes]

cimsubscribe -ls

Description

The cimsubscribe command resides in the following location, depending on youroperating system:v Linux: install_root/icc/bin

v Windows 32-bits: C:\Program files\Common files\ibm\icc\cimom\bin

v Windows 64-bits: C:\Program files (x86)\Common files\ibm\icc\cimom\bin

where install_root is the root directory of your IBM Systems Director installation.

You can use this command during installation to set up the default localsubscriptions.

You can run this command either in interactive mode or in silent mode, whichallows you to include it in scripts.

You can use this command to connect to a local or remote CIMOM. The commandincludes options for authentication.

You can also use other clients for managing CIM subscriptions, for example cimclior wbemtest.

You can use this command to verify IBM Systems Director alert destinations.

Flags

-b batch_filenameReads the specified batch file and performs a sequence of operations using thecommand options in the batch file.

Tip: The specified batch file must be a text file with one or more lines, each ofwhich specifies options for this command.

-cf | -createfilterCreates a new CIM-indication filter.

-fn | -filtername filter_nameTargets the specified CIM-indication filter.

-q | -query querySpecifies a Windows Management Instrumentation Query Language (WQL)query used to filter CIM-indication instances.

-ch | -createhandlerCreates a new CIM-indication handler.

-hn | -handlername handler_nameTargets the specified CIM-indication handler.


-d | -destination destinationSpecifies a destination uniform resource locator (URL) used to identify an endconsumer location (for example, http://localhost:6988/CIMListener/Log).

Tip: The port number specified by destination should be appropriate for thespecified communications protocol.

-cs | -createsubscriptionCreates a new CIM_IndicationSubscription.

Tip: On Linux systems, the CIMOM verifies that the specified handler andfilter exist.

-df | -deletefilterDeletes the specified CIM-indication filter if the specified filter exists and is notbeing used by an existing CIM-indication subscription.

-dh | -deletehandlerDeletes the specified CIM-indication handler if the specified handler exists andis not being used by an existing CIM-indication subscription.

-ds | -deletesubscriptionDeletes the specified CIM-indication subscription if the specified subscriptionexists.

-h | -?Displays command-line help information about this command.

-i Performs the command in interactive mode. You will be prompted for valuesthat are not specified on the command line.

Tip: When you are deleting handlers, filters, or subscriptions in interactivemode, all objects (handlers, filters, or subscriptions) are displayed in a orderedlist. Because this list can be long, it might be necessary to increase the buffersize so that you can scroll through the list to identify the number of the objectto delete.

-lf | -listfiltersLists the current set of CIM-indication filters.

-lh | -listhandlersLists the current set of CIM-indication handlers.

-ls | -listsubscriptionsLists the current set of CIM-indication subscriptions.

-s | -secure {yes | [no]}Specifies whether the HTTP or HTTPS protocol is used for communications.When followed by yes, this command connects securely through SSL to port5989 (HTTPS). If this option is omitted or followed by no, the commandconnects using port 5988 (HTTP). This option is required if other optionsspecify port 5989.

Tip: HTTPS communications might decrease performance because of increasedprocessing. The port number specified by destination should be appropriate tothe selected communications protocol.

-u | -username user_nameSpecifies a user name to use when authenticating with the management server.


Note: Ensure that you specify the same user name as that which is alreadyconfigured for the target system. The default user name for an IMM system isUSERID.

-p | -password passwordSpecifies a password to use when authenticating with the management server.

Note: Ensure that you specify the same password as that which is alreadyconfigured for the target system. The default password for an IMM system isPASSW0RD.

-c | -certificate certificate_fileSpecifies the full system path to the client x509 certificate, for example,c:\test\client.cert. This parameter us valid only when the command isusing secure communications through HTTPS.

-k | -key key_fileSpecifies the full system path to the client private key file (for example,c:\test\client.key).

Tip: This parameter is valid only when the command is using securecommunications through HTTPS.

-n | -namespace namespaceSpecifies a namespace. Possible values include the following namespaces:

root/interopSpecifies a namespace on an IMM or ESXi system

root/pg_interopSpecifies a namespace on a Platform Agent system

If you do not specify a namespace, the default value is root/ibmsd.

-l | -location host_name:portSpecifies the fully-qualified host name and port of the system on whichsubscriptions are to be modified (for example,remotehost.raleigh.ibm.com:5988).

Tips:

v Ensure that you specify the same port number as that which is alreadyconfigured for IBM Systems Director. You can find this port number on theConfigure Access Panel for the ManageableEndpoint.

v If you do not specify a host name, the default value is localhost:5988.v If you are creating a remote filter, handler, or subscription, you must specify

a fully-qualified host name.v If the destination is not the local host, you must also specify the -u |

-username and -p | -password options.v There is no default Web Based Enterprise Management (WBEM) port for

indications. The ports 5992 - 5998 are not reserved, so any of these ports is agood candidate for a default port. Although the system administrator canchange the listener port, it is not recommended.

v If you specify port 5989, you must also specify -s yes.v Platform Agent systems always uses a secure port.v IMM and ESXi systems can use either a secure or unsecure port.


Exit status

The following codes are returned by this command.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you


Examples1. Connect to a remote host over HTTP

This example illustrates how to create a handler named SNMP on listener9.44.169.107 and port 5988 (HTTP). The destination for the handler ishttp://localhost:6988/CIMListener/SnmpConsumer.cimsubscribe -ch -hn "SNMP" -d "http://localhost:6988/CIMListener/SnmpConsumer"-l 9.44.169.107:5988 -u user1 -p passw0rd

2. Connect to a remote host over HTTPS using a client certificate and keyThis example illustrates how to create a handler named SNMP on listener9.44.169.107 and port 5989 (HTTPS). A client certificate client.cert and keyclient.key is used for authentication.cimsubscribe -ch -hn "SNMP" -d "http://localhost:6988/CIMListener/SnmpConsumer"-l 9.44.169.107:5989 -s yes -c client.cert -k client.key

3. Create a filterThis example illustrates how to create a filter named Sev2 on the defaultlistener.cimsubscribe -cf -fn Sev2 -q "SELECT * FROM IBM_AlertIndication where Severity = 2"

4. Create a handler for another namespaceThis example illustrates how to create a handler named SNMP for a namespace(root/cimv2) other than the default namespace.cimsubscribe -ch -hn "SNMP" -d "http://localhost:6988/CIMListener/SnmpConsumer"-n root/cimv2

5. Create a handler using batch processingThis example illustrates how to use a batch file named defaultHandlers.dat forprocessing.cimsubscribe -b defaultHandlers.dat

The batch file contains the following lines:-ch -hn "SNMP" -d "http://localhost:6988/CIMListener/SnmpConsumer"-ch -hn "TEC" -d "http://localhost:6988/CIMListener/TivoliConsumer"-ch -hn "Log" -d "http://localhost:6988/CIMListener/LogConsumer"-ch -hn "Health" -d "http://localhost:6988/CIMListener/HealthConsumer"-ch -hn "SMS" -d "http://localhost:6988/CIMListener/SMSConsumer"-ch -hn "PopUp" -d "http://localhost:6988/CIMListener/PopupConsumer"

6. Create a filter using interactive processingThe following example creates a new filter using interactive processing.

Notes:

v The interactive command does not explicitly indicate that the new filter wascreated, but displays the query criteria for the filter again.

v After the filter is created, the interactive session prompts for a new action.C:\Program Files\IBM\Director\cimom\bin>cimsubscribe -iWhat system would you like to connect to?1. localhost2. remote host1What port would you like to connect to?1. 5988 (HTTP)


2. 5989 (HTTPS)3. Another port1Enter the namespace.root/ibmsdDo you want a secure connection?1. Yes2. No2Connecting to localhost:5988...Interactive mode

What would you like to do?1. Create a filter2. Create a handler3. Create a subscription (bind an existing filter and handler)4. Delete an existing filter5. Delete an existing handler6. Delete an existing subscription7. Exit1

What is the name of this filter?new_filter

What is the WQL query for this filter?SELECT * from IBMPSG_ProcessorPFEvent where PerceivedSeverity = 2

Name new_filterQuery SELECT * from IBMPSG_ProcessorPFEvent where PerceivedSeverity = 2

What would you like to do?1. Create a filter2. Create a handler3. Create a subscription (bind an existing filter and handler)4. Delete an existing filter5. Delete an existing handler6. Delete an existing subscription7. Exit7

7. Verify IBM Systems Director alert destinationsThis example illustrates how to confirm the IBM Systems Director Server IPaddress that is used for CIM subscriptions in the “root/interop” namespace onan IMM system and on listener 9.44.169.107 and port 5989 (HTTPS).

Note: Look through the resulting list of all CIM subscriptions and locate eachsubscription for IBM Systems Director Server, then look at the Destinationproperty in the Indication Handler for that subscription to determine the targetIP address.cimsubscribe -lh -u USERID -p PASSW0RD -n root/interop -l9.44.169.107:5989 -s yes

configAgtMgr commandUse the configAgtMgr script on management servers running or Linux to configurethe agent manager after installing IBM Systems Director Server.

Note: Agent manager configuration on Windows is performed by the installationprocess and cannot be started manually with the configAgtMgr script.


Syntax

On AIX and Linux: configAgtMgr.sh

Description

Prerequisite: You can run this command only when all of the following criteria aremet:v You have installed IBM Systems Director Server on a management server

running either AIX or Linux.v You have not started IBM Systems Director processes on the management

servers by running the smstart command.

To run the configAgtMgr command, navigate to the install_root/bin directory on themanagement server, where install_root is the root directory of your IBM SystemsDirector installation.

The configAgtMgr command issues the following prompts for information.

Note: For descriptions of resource managers and agent managers, see “Commonagent services”.

Tips:

v If you are setting up a second instance of IBM Systems Director Server in yourenvironment and you want it to manage the same common agents as your firstinstance of IBM Systems Director Server, select to register with an existing agentmanager and provide the same information that you provided when you firstconfigured the agent manager. This will ensure that the second instance of IBMSystems Director Server will automatically recognize every common agent thatwas discovered with the first instance of IBM Systems Director Server.

v Before running the configAgtMgr script, ensure that the DEFAULT_MTU value inthe <IBM_System_Director_path>/lwi/runtime/agentmanager/toolkit/data/slp.prop file is set large enough to avoid overflow. If the value is set too small,the configuration task will fail with a return code of 2 for the usmi-cas-setup.shscript and the <IBM_System_Director_path>/lwi/runtime/agentmanager/toolkit/logs/traceRegistrationTool.log file will contain the statement “request SrvRqstis too large (overflow)”.

Enter 1 to use the Agent Manager installed with this server (recommended),Enter 0 to use an existing Agent Manager (advanced)

Enter 0 or 1 to specify which agent manager to use:

0 Enter 0 to use an existing agent manager.

Important: Ensure that the user ID and password that you willenter here match the user ID and password of the existing agentmanager.

1 Enter 1 to configure and use the agent manager that is embeddedwith IBM Systems Director Server.

Enter the Resource Manager user ID that you would like to set for the AgentManager

If you want to register with an existing agent manager, enter the sameresource manager user ID as that of the agent manager. If you want tocreate a new agent manager, enter in any user ID that will then be defined


as the resource manager user ID for that new agent manager. The user IDdoes not need to be an operating system user ID.

Note: The resource manager user ID is an identifier that is used by IBMSystems Director or other resource managers to communicate with theagent manager; it is not a user ID on the operating system or an LDAPserver.

Enter the Resource Manager password to set for the Agent ManagerIf you want to register with an existing agent manager, enter the sameresource manager password as that of the agent manager. If you want tocreate a new agent manager, enter in any password that will then bedefined as the resource manager password for that new agent manager.

Verify the Resource Manager password to set for your Agent ManagerReenter the password you entered for Enter the Resource Managerpassword to set for the Agent Manager.

Enter the Agent Registration password to set for your Agent ManagerIf you want to register with an existing agent manager, enter the sameagent registration password as that of the agent manager. If you want tocreate a new agent manager, enter in any password that will then bedefined as the agent registration password for that new agent manager.

Verify the Agent Registration password to set for your Agent ManagerReenter the password you entered for Enter the Agent Registrationpassword to set for your Agent Manager.

Enter the IP address for the existing Agent ManagerIf you selected 0 (use an existing agent manager), you must provide the IPaddress of the existing agent manager.

Enter the port number for the existing Agent ManagerIf you selected 0 (use an existing agent manager), you must provide theport number of the existing agent manager. The port number must be avalid number between 0 and 65535.

After you have provided all the requested information, the configuration of theembedded agent manager and registration of IBM Systems Director Server as theresource manager with the embedded agent manager begins. The agent managerconfiguration script runs and displays a series of status messages.

Operands

None

Flags

None

Exit status

The following codes are returned by this command.v 0: The operation completed.v 10: The specified parameters are not valid..v 12: The configuration is complete and configAgtMgr does not need to be run.v 13: Error updating the /proddata/agentmanagerconfig.properties file.v 14: Script did not complete. See the /opt/ibm/director/log/

installconfigtools.log to determine which script did not complete.


Examples1. Configure the agent manager for a new installation of IBM Systems Director on

AIX or LinuxThis example illustrates how to start the agent manager configuration script onAIX or Linux.. /opt/ibm/director/bin/configAgtMgr.sh

dirinstall.server commandUse the dirinstall.server command to install IBM Systems Director on amanagement server running AIX or Linux. You can also use this command touninstall, or remove, IBM Systems Director on a management server runningLinux, to extract RPMs for Linux distributions, and to migrate your database datato the managed IBM DB2 database when you upgrade to IBM Systems DirectorServer 6.3.x. Use the diruninstall command to uninstall IBM Systems Director ona management server running AIX.

Syntax

dirinstall.server [-h]

Install or upgrade (on Linux):

dirinstall.server [-i] [-f] [-g] [-k] [-l] [-s] [-v] [-n port_list] [-oport_list] [-d path_name] [-b path_name] [-m path_name] [-M] [-p path_name][-r response_file]

Install or upgrade (on AIX):

dirinstall.server [-g] [-k] [-s] [-n] [-d path_name] [-b path_name] [-M][-r response_file]

Uninstall (Linux only):

dirinstall.server -u [-f] [-l] [-s] [-v]

Extract (Linux only):

dirinstall.server -x distro [-i] [-p path_name] [-s]

Description

Important:

v Installation of IBM Systems Director installs IBM Systems Director Server,Common Agent, and Platform Agent all together as a bundle. Therefore, it is notnecessary to separately install Common Agent or Platform Agent on themanagement server after installing IBM Systems Director Server.

v Before installing IBM Systems Director Server on a system that has IBM StorageConfiguration Manager installed, you must first uninstall IBM StorageConfiguration Manager. After installing IBM Systems Director Server, you canre-install IBM Storage Configuration Manager on a different system.

v IBM Systems Director Server is not supported to run on a system with workloadpartitions (WPARs) enabled. This applies only to AIX.


Note: For additional details about usage of the dirinstall.server command, readthe shipped response file and use dirinstall.server -h. The response file isnamed dirserv.rsp, and is available in the same directory as thedirinstall.server command.

Flags

-b path_nameSpecifies the path to the directory where database data is saved during a IBMSystems Director migration. This option is required if the database is remote(on a system other than the system where IBM Systems Director is beinginstalled). This option is ignored if the -g option is specified.

-d path_nameSpecifies the path to the directory where data is saved during a IBM SystemsDirector migration. This option is ignored if the -g option is specified.

-f When not used with the -u option, specifies to ignore all prerequisite checksand force an installation of IBM Systems Director. When used with the -uoption, specifies to force IBM Systems Director to be uninstalled, or removed.

Note: This option is valid for Linux only.

Attention: Use this option with caution.

-g Specifies to install IBM Systems Director without using any data that wassaved from previous versions of IBM Systems Director. In other words, thisoption forces a clean installation.

-h Displays the syntax and a brief description of the command.

-i Specifies to run in unattended mode.

Note: This option is valid for Linux only. For AIX, dirinstall.server alwaysruns in unattended mode.

-k Specifies to discard any saved data after an IBM Systems Director migration.This option is ignored if the -g option is specified.

-l Specifies to disable logging. By default, logging is enabled.

-m path_nameSpecifies the path to the directory where updates that are to be merged into anIBM Systems Director installation are stored.

-MYou must specify this option if you are migrating to the default managed IBMDB2 database from a non-default IBM DB2 database or from Oracle® Database.

-n port,port,portFor Linux, specifies to install IBM Systems Director using the specified ports.The following three port values must be specified, separated by commas:v HTTP portv HTTPS portv Agent manager asynchronous port

For example: -n 8421,8422,20000.

-nFor AIX, specifies to install IBM Systems Director without using any data thatwas saved from previous versions of IBM Systems Director, but instead torestore an existing backup into this installation.


Note: The -n option when used for AIX does not accept values for ports.

-o port,port,portSpecifies to install IBM Systems Director with Common Agent using thespecified ports. The following three port values must be specified, separated bycommas:v common agent services portv nonstop input portv nonstop output port

For example: -o 9510,9514,9515.


-p path_nameWhen not used with the -x option, specifies to install all IBM Systems DirectorRPMs extracted to the specified directory path. The specified path must be adirectory containing only IBM Systems Director RPMs. When used with the -xoption, specifies to extract the RPMs for the specified distribution and versionto the specified directory path.

Tip: In the response file, the path_name variable name is UPDATES_PATH.


-r response_fileSpecifies the fully qualified path of the server response file that contains thecustomized installation information. Using this option overrides anyinstallation command line options.

IBM Systems Director provides a default response file. The response file isnamed dirserv.rsp, and is available in the same directory as thedirinstall.server command.

Important: It is recommended that you create and edit a local copy of theresponse file and not modify the default response file.

You can specify the following information in the server response file:v Log optionsv Port numbers for the IBM Systems Director Web interfacev Whether to enable or disable the nonstop service, which keeps the server

continuously runningv Whether to install Common Agent in managed modev Location of the RPM filesv IBM Systems Director plug-ins and features to installv Database configuration settings to use with IBM Systems Directorv Migration settings

Tip: In the response file, 1 indicates that an item is to be installed and 0indicates that an item is not to be installed.

-s Specifies to print traces of the script and RPM scriptlets.

-u Specifies to uninstall, or remove, IBM Systems Director.


Note: This option is valid for Linux only. For AIX, use /opt/ibm/director/bin/diruninstall script to uninstall. See the “diruninstall command” topic forinformation.

-v Specifies to print traces of the RPM transactions.


-x distro | allSpecifies to extract the RPMs for the specified distribution and version. Forexample: -x rhel4. Use the -h option to display the list of valid values. If youspecify all, RPMs for all supported distributions and versions are extracted.

The RPMs are extracted to /tmp/server.xxxxxxxxxx, where xxxxxxxxxx is a setof random alphanumeric characters.


Exit status



Examples1. Install using default values

This example illustrates how to install IBM Systems Director Server using thedefault settings.dirinstall.server

2. Install using a customized response fileThis example illustrates how to install IBM Systems Director Server using acustomized response file.dirinstall.server -r /temp/response.rsp

3. Migrate using a remote database with tracingThis example illustrates how to migrate IBM Systems Director Server from a 32bit to a 64 bit operating system, using a remote database and with tracingenabled.dirinstall.server -s -d /isdbackup -b /remotedbdir

diruninstall commandUse the diruninstall command to uninstall IBM Systems Director on amanagement server running AIX.

Syntax

diruninstall

Description

The diruninstall command uninstalls IBM Systems Director on a managementserver running AIX. This command uninstalls IBM Systems Director Server,


Common Agent, and Platform Agent. It does not uninstall the CommonInformation Model (CIM) server or CIM providers, because they might be used byother applications. This command applies to IBM Systems Director for AIX only.

Flags

None.

Exit status



Examples1. Uninstall IBM Systems Director

This example illustrates how to uninstall IBM Systems Director, along with IBMSystems Director Server, Common Agent, and Platform Agent..diruninstall

genuid commandUse the genuid command to generate a unique ID for a Common Agent managedsystem.

Syntax

genuid

Description

The genuid command generates a unique ID for a system with Common Agentinstalled. This command is useful for replacing a unique ID on a cloned system,when the unique ID has been copied to the clone from the original system and isno longer a “unique” ID.

Flags

None.

Exit status



Examples1. Generate a unique ID

This example illustrates how to generate a unique ID.


genuid

lsagent.agent commandUse the lsagent.agent command on a Common Agent system to determine theCommon Agent version. This command is supported on AIX agents only.

Syntax

lsagent.agent

Description

The lsagent.agent command returns the version of the installed Common Agent.

Flags

None.

Exit status



Examples1. List the version of the installed Common Agent

This example illustrates how to run the lsagent.agent command to return theCommon Agent version.lsagent.agent

logcollector commandUse the logcollector command to collect all log files for any affected system.

Syntax

On AIX and Linux:

logcollector.sh [-h | -? | --help]


logcollector.sh [-c configuration_path] [-o output_path] [-p password] [-uuser] [-t time] [-v]

logcollector.sh [-x configuration_path] [-o output_path] [-p password] [-uuser] [-t time] [-v]

logcollector.sh [-clean-logs][-v]

logcollector.sh [-debug][-v]


[logcollector.sh [-V]

On Windows:

logcollector.bat [-h | -? | --help]


logcollector.bat [-c configuration_path] [-o output_path] [-p password] [-uuser] [-t time] [-v]

logcollector.bat [-x configuration_path] [-o output_path] [-p password] [-uuser] [-t time] [-v]

logcollector.bat [-clean-logs][-v]

logcollector.bat [-debug][-v]

[logcollector.bat [-V]

Description

The logcollector command collects as much static problem determination data aspossible from IBM Systems Director and consolidate the logs into a single archive(.zip) file.

Flags





Tips:



-c | --collector-file configuration_pathsSpecifies the individual collector files rather than taking the defaults. Specifymultiple collector files using a comma-separated list.

--clean-logsDeletes all the files in the logs directory /opt/ibm/director/lwi/logs.

--dumpCollects the most recent two head dump files and all the core dump files.


-o | --output output_pathSpecifies the output director location and output filenames. If you specify adirectory, then put the default zip filename into that directory. If you specify afilename, the create a zip file with that path and name.

-p | --smcli-passwordSpecifies the password to use for the smcli commands.

-t | --timeout timeSpecifies the amount of time in seconds to wait for a command to completebefore skipping the command, then moving on to the next command. Thedefault value is 900 seconds (15 minutes).

-u | --smcli-userSpecifies the user name to use for the smcli commands.

Exit status



Examples1. Collect data files for specific components

This example illustrates how to collect data files for components common_agentand server_core.logcollector -c common_agent.xml,server_core.xml

2. Collect all the data files on the system.This example illustrates how to collect all data files on the system.logcollector

3. Collect data files for a specific component using a specified username anddirectory.This example illustrates how to collect data files for the component server_coreusing username user and the tmp directory.logcollector -u user -o /tmp -c server_core.xml

reset_diragent_keys commandUse the reset_diragent_keys command to reset the identification keys that arerelated to Common Agent on AIX. This command is available on Common Agentrunning on AIX only.

Syntax

reset_diragent_keys [-h]

Description

You must correctly configure systems that are cloned or that use a mirrored imageto ensure successful discovery.v Each cloned Platform Agent managed system and Common Agent managed

system must have a unique identifier (UID) and a unique TIVguid.


v Any mirrored system that is managed by IBM Systems Director must have aunique Secure Shell (SSH) host key.

Typically, when an AIX system is installed with a mksysb image that was createdon another system that includes Common Agent, the newly installed system willhave the same agent identifiers as the system on which the mksysb image wascreated. Running the reset_diragent_keys command on the newly installedsystem will make the identifiers unique.

Starting with AIX 6.1 TL05, if the reset_diragent_keys script is installed on asystem, it will run when restoring a mksysb image on a system other than the oneon which it was created. However, the reset_diragent_keys script is not includedin the Common Agent version that comes with AIX 6.1 TL05. For AIX 6.1 TL05,you must also install Common Agent 6.2.0 to use the reset_diragent_keyscommand. AIX 6.1 TL06 and AIX 7.1 already include Common Agent 6.2.0, so noadditional installation of Common Agent is needed for these AIX versions.

Note: The reset_diragent_keys command runs the steps provided in “Discoveringsystems that use a mirrored image”.

Operands

None.

Flags

-h Displays the syntax and a brief description of the command.

Exit statusv 0: The operation completed.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you


Note: To ensure that the script has run successfully, check the status of the scriptin the log file that is created at the /var/log/dirinst.log location.

Examples1. Reset the agent identifiers

This example illustrates how to run the command to reset the agent identifiers.reset_diragent_keys

paservices utilityUse the paservices utility to start, stop, and restart the IBM Systems DirectorPlatform Agent on Linux (paservices utility is available for xLinux only), Windows,and Linux Kernel-based Virtual Machine (KVM).

Syntax

On Linux: paservices [start | stop | restart ]

On Windows: paservices.vbs [start | stop | restart ]


||

|

Description

The paservices utility can be used to start, stop, and restart the Platform Agentservices. On Windows, the log files can be found at temp\paservices.log. OnxLinux, generate the log with the following:./paservices [start|stop|restart] >> Log_File_Name.

The script displays usage help by default or when incorrect parameters are used.

Flags

startStarts the platform agent services in the required sequence.

stopStops the platform agent services in the required sequence.

restartRestarts the platform agent services in the required sequence.

securityCryptoMode commandUse the securityCryptoMode command to configure the Secure Sockets Layer (SSL)or the Transport Layer Security (TLS) level for web browser communication to useTLS version 1.2.

Syntaxv On AIX and Linux operating systems, securityCryptoMode.sh [--help | -h |

-?] [-webbrowser <level> -d | -u | -c]

v On the Windows operating system, securityCryptoMode.bat [--help | -h |-?] [-webbrowser <level> -d | -u | -c]

Description

Use this command to configure the web browser to accept ciphers that are onlyenabled with TLS version 1.2. You can run this command as a non-interactivecommand.

Operands

None.

Flags

--helpDisplays detailed information about the command, including the syntax,description of the command, description of the options, operands, andexamples.

-d | --doConfigures the protocol to TLS version 1.2.

-u | --undoRemoves the configuration and reverts to the default protocol settings. Thedefault configuration value is SSL_TLS.

-c | --commitCommits the configuration after verifying the changes.


|

|

|||

|

||

||

|

|||

|

|

|

||||

||

|||

||

Examples1. Use the following command to configure the web browser communication to

use TLS version 1.2 cipher suites.securityCryptoMode.sh -webbrowser TLSv1.2 -d

2. Use the following command to undo the TLS version 1.2 changes and revertthe settings to the default value.securityCryptoMode.sh -webbrowser -u

3. Use the following command to commit the TLS version 1.2 configuration anddisplay a message to restart the server.securityCryptoMode.sh -webbrowser TLSv1.2 -c

4. Use the following command to commit the default configuration value ofSSL_TLS and display a message to restart the server.securityCryptoMode.sh -webbrowser -c

slptool commandUse the slptool command on management servers running Linux with IBMSystems Director Platform Agent to manage the agent manager used by a CommonAgent.

Syntax

slptool [-v | -s scope_list | -l language_tag | -i interface_list | -uinterface] {command arguments}

Description

To run the slptool command, navigate to the install_root/bin directory on themanagement server, where install_root is the root directory of your IBM SystemsDirector installation.

Operands

None

Flags

-i | –interfaces interface[,interface,...]Specifies one or more interfaces applicable for the command, in acomma-separated list.

-l | –language language_tagSpecifies the language tag to be used for the command.

-s | –scope scope[,scope,...]Specifies one or more scopes applicable for the command, in acomma-separated list.

-u | --unicastifc interfaceSpecifies a single interface.

-v | –versionDisplays the versions of the slptool command and OpenSLP.

deregister urlDeregisters service registrations for the specified URL.


|

||

|

||

|

||

|

||

|

|

findattrs url [attr_ids]Displays a list of attributes for the service registrations for the specified URL.You can specify one or more attribute IDs in a comma-separated list.

findscopesDisplays information related to the available scopes.

findsrvs service_type [filter]Displays a list of URLs for all services registered with the specified servicetype. You can specify a filter with format "(attr1=val1)" to display URLs foronly those services satisfying the filter condition.

findsrvtypes [authority]Displays a list of all service types registered to the SLP. You can specify anaming authority for the SLP.

getproperty property_nameDisplays the property value in the slp.conf file for the specified property name.

register url [attrs]Registers a specified URL. You can specify a list of attributes to use forregistering the URL, separated by commas.

Exit status



Examples1. Run commands using slptool

The following examples illustrate how to use the slptool command to runvarious commands.. /opt/ibm/icc/bin/slptool register service:myserv.x://myhost.com"(attr1=val1),(attr2=val2)"

. /opt/ibm/icc/bin/slptool findsrvs service:myserv.x

. /opt/ibm/icc/bin/slptool findsrvs service:myserv.x "(attr1=val1)"

. /opt/ibm/icc/bin/slptool -i 10.77.13.240,192.168.250.240findsrvs service:myserv.x

. /opt/ibm/icc/bin/slptool -u 10.77.13.237 findsrvs service:myserv.x"(attr1=val1)"

. /opt/ibm/icc/bin/slptool findattrs service:myserv.x://myhost.com

. /opt/ibm/icc/bin/slptool findattrs service:myserv.x://myhost.com attr1

. /opt/ibm/icc/bin/slptool -i 10.77.13.243findattrs service:myserv.x://myhost.com attr1

. /opt/ibm/icc/bin/slptool -u 10.77.13.237findattrs service:myserv.x://myhost.com attr1

. /opt/ibm/icc/bin/slptool deregister service:myserv.x://myhost.com

. /opt/ibm/icc/bin/slptool getproperty net.slp.useScopes

2. Identify the agent manager for a Common Agent managed systemThe following examples illustrate how to identify the agent manager for aCommon Agent managed system on the management server.


. /opt/ibm/icc/bin/slptool -u 10.11.19.203findsrvs service:management-software.IBM:platform-agent

. /opt/ibm/icc/bin/slptool -u 10.11.19.203findsrvs service:wbem

smdb commandUse the smdb command to start, stop, restart, and check the status of the managedIBM DB2 database server.

Syntax

smdb [-h | -? | --help]

smdb start | stop | restart | status

Description

Use this command as a wrapper function for the managed IBM DB2 databasedb2start and db2stop commands and as a method to provide status of themanaged IBM DB2 database server. When IBM Systems Director is configured touse the managed IBM DB2 database, this command is also installed and providesmanagement capabilities for the managed IBM DB2 database.

Operands

This command uses start, stop, restart, and status as operands.

Attention: Use care when stopping the managed IBM DB2 database server whileIBM Systems Director Server is running, as problems could result.

Flags




Tips:



Exit status



Examples1. Stop the managed IBM DB2 database server

This example illustrates how to stop the managed IBM DB2 database server.smdb stop

smdbcli commandUse the smdbcli command to configure the managed IBM DB2 database automaticreorganization policies.

Syntax

smdbcli [-h | -? | --help]

smdbcli setAutoReorgPolicy -onlineStartTime time -onlineDuration duration-onlineDaysOfWeek ALL | day_or_days [-offlineStartTime time | OFF][-offlineDuration duration] [-offlineDaysOfWeek ALL | day_or_days][-maxOfflineReorgTableSize size_in_KB]

Description

You can use IBM Systems Director to configure the managed IBM DB2 database asthe backing database management server (DBMS). When IBM Systems Director isconfigured to use the managed IBM DB2 database, this command is also installedand provides management capabilities for the managed IBM DB2 database.

Operands

This command uses setAutoReorgPolicy as an operand.v Automatic reorganization for the managed IBM DB2 database is configured with

a continuously running online window and no offline window. This allows thereorganization of indexes but not tables. The setAutoReorgPolicy operandallows you to adjust both the online and offline automated tasks, includingsetting the start time, duration, day of the week, and maximum tablereorganization size. Use any or all of the following values for the day:– Mon

– Tues

– Wed

– Thu

– Fri

– Sat

– Sun

Flags





Tips:



Exit status


Examples1. Set reorganization policies

This example illustrates how to set the online window to 24 hours a day oneach weekday, and the offline window from 6 pm to midnight every Saturdayand Sunday. During the offline window, only tables smaller than 100 KB arereorganized.smdbcli setAutoReorgPolicy-onlineStartTime 00:00:00-onlineDuration 24-onlineDaysOfWeek Mon Tues Wed Thu Fri-offlineStartTime 18:00:00-offlineDuration 12-offlineDaysOfWeek Sat Sun-maxOfflineReorgTableSize 100

2. Change the auto reorganization policy back to the defaultsThis example illustrates how to change the auto reorganization policy back tothe defaults of a 24x7 online window with no offline window.smdbcli setAutoReorgPolicy-onlineStartTime 00:00:00-onlineDuration 24-onlineDaysOfWeek ALL-offlineStartTime OFF

smexport commandUse the smexport command to export IBM Director persistent data for migration toIBM Systems Director.

Syntax

smexport [-e {all | cred } [-p password] ][-d directory] [-v | --verbose]{-a } [-h | --help | -?]


Description

Prerequisite: Before running this command, install it on a management serverrunning IBM Director version 5.20. The smexport command is not installed as partof IBM Director version 5.20. See “Obtaining and installing the IBM SystemsDirector Migration Tool.”

You can run the smexport command locally from the management server orremotely by accessing the management server using a remote-access utility, such asSecure Shell (SSH) or Telnet.

To run the smexport command, navigate to the tool-installation-location/bindirectory and type the smexport command, where tool-installation-location is thedirectory where you installed the IBM Systems Director Migration Tool.

The smexport command runs on the IBM Director version 5.20 management server,and creates migration data files in a directory accessible to the IBM Directorversion 5.20 management server. The migration data files are then copied(manually) to a directory that is accessible to the IBM Systems Director 6.1management server, and the smimport command imports the migration data to theIBM Systems Director 6.1 system.

The default directory used by the IBM Systems Director Migration Tool forimporting and exporting data is named: tool-installation-location\migration, wheretool-installation-location is the directory where the IBM Systems Director MigrationTool is installed.

The smexport command provides notification if it detects data that resides on theIBM Director version 5.20 system but cannot be migrated to IBM Systems Director6.1 because there is no equivalent, or the function is not implemented in IBMSystems Director 6.1.

The smexport command produces log files and error messages, so that you candetermine which pieces of data are being migrated, the progress of the migration,and its success or failure.

If the smexport command is run more than once on the same IBM Director version5.20 system, multiple export directories will be created, and each is given a uniquename with an incremental number.

Operands

None

Flags


-a | --allSelects all supported objects for migration.

-d | --dir directorySets the directory for the migration data.


-e | --encrypt {all | cred}Specifies what information should be encrypted:

all Everything is encrypted.

cred Credential information is encrypted. This is the default.

-h | --help | -?Displays command-line help information about this command. If other optionsare present, all but the -L option are ignored.

-p | --password passwordSet the password used for encryption. A default password will be used ifencryption is selected and no password is specified.


-v | --verboseAdds verbose messages to the log file.

Exit status



Examples1. Export objects for migration

This example illustrates how to export all supported objects for migration.smexport -a

smimport commandUse the smimport command to import IBM Director persistent data for migration toIBM Systems Director.

Syntax

smimport [-e {all | cred} [-p password] ][-d directory] [-v | --verbose]{-a } [-h | --help | -?]

Description

Prerequisite: Before running this command, install it on a management serverrunning IBM Systems Director 6.1. The smimport command is not installed as partof IBM Systems Director 6.1. See “Obtaining and installing the IBM SystemsDirector Migration Tool.”

You can run the smimport command locally from the management server orremotely by accessing the management server using a remote-access utility, such asSecure Shell (SSH) or Telnet.


To run the smimport command, navigate to the tool-installation-location/bindirectory and type the smimport command, where tool-installation-location is thedirectory where you installed the IBM Systems Director Migration Tool.

The smexport command runs on the IBM Director version 5.20 management server,and creates migration data files in a directory accessible to the IBM Directorversion 5.20 management server. The migration data files are then copied(manually) to a directory that is accessible to the IBM Systems Director 6.1management server, and the smimport command imports the migration data to theIBM Systems Director 6.1 system.

Note: Before running the smimport command on Linux, you must configure theAgent manager by running the director/bin/configAgtMgr.sh script.

The default directory used by the IBM Systems Director Migration Tool forimporting and exporting data is named: tool-installation-location\migration, wheretool-installation-location is the directory where the IBM Systems Director MigrationTool is installed.

The smimport command produces log files and error messages, so that you candetermine which pieces of data are being migrated, the progress of the migration,and its success or failure.

As part of smimport processing, after creating the Managed End Point objectframework, for some managed objects a light discovery process is performed. Thismeans that until the smimport is completed, the Inventory details for some objectswill be only partially populated.

When the smimport command completes, an automatic restart of the IBM SystemsDirector 6.1 management server is performed. Some of the migration tasks can berun during this restart.

If the smimport command fails, it will be necessary to run the smreset command inorder to recover.

Operands

None

Flags


-a | --allSelects all supported objects for migration.

-d | --dir directorySets the directory for the migration data.

-e | --encrypt {all | cred}Specifies what information should be encrypted:

all Everything is encrypted.

cred Credential information is encrypted. This is the default.


-h | --help | -?Displays command-line help information about this command. If other optionsare present, all but the -L option are ignored.

-p | --password passwordSet the password used for encryption. A default password will be used ifencryption is selected and no password is specified.


-v | --verboseAdds verbose messages to the log file.

Exit status



Examples1. Import objects for migration

This example illustrates how to import all supported objects for migration.smimport -a

smreset commandUse the smreset command to return IBM Systems Director Server to its installationdefault values. This command must be run immediately after you run cfgdbcmd tochange to a new database (for example, when upgrading from a managed IBMDB2 database to an enterprise database such as Oracle® Database) and only whenIBM Systems Director Server is stopped.

Syntax

smreset -l

Prerequisitesv Ensure that the database server is active. If you are using the managed IBM DB2

database, smreset will restart the server if the server is down. If you are usinganother database server, you will receive an error if that database server isdown.

Description

Important: The smreset command changes the configuration of IBM SystemsDirector Server and can be undone only by manually reconfiguring IBM SystemsDirector Server or by restoring a backup image.

The smreset command reinitializes the databases and clears all persistent data. Itdeletes local data on the file system where IBM Systems Director is installed aswell as deletes and rebuilds all database tables that are used by IBM SystemsDirector. The smreset command does not delete or reset agent managerinformation. The deleted data incudes:


v Discovered resource datav Inventory datav Event data (event log, custom event filters, custom event actions, custom event

plans)v Monitoring datav Updates datav Status datav Configuration templatesv Security configurationsv All other data associated with running and configuring IBM Systems Director

after installation

Note: After the smreset command is run, all 6.x Common Agents previouslyaccessed will not automatically repopulate after restarting IBM Systems DirectorServer unless Common Agents are manually discovered.

Operands

None

Flags

-l Writes verbose messages and non-zero exit statuses to standard output.

Exit statusv 0: The operation completed.v 1: An error occurred. For more information, view the log file located at

install_root\log\smreset.log or the database reset log file located atinstall_root\reset.log, where install_root is the root directory of your IBM SystemsDirector installation. Note that this path uses the backslash (\) to delimit thedirectory; depending on the system that you are using, you might be required toenter the path using the forward slash (/).



Examples1. Reset the IBM Systems Director Server configuration

This example illustrates how to reinitialize the databases and clear all persistentdata on the management server.smreset

smrestore commandUse the smrestore command to restore the persistent data. Persistent data includesfile system data, agent manager data, and data in the IBM Systems Directordatabase.

Syntax

smrestore [-h | -? | --help]

smrestore [-dbUserName user_name] [-dbUserPwd password] -sourceDirdirectory -dbSourceDir directory -timestamp timestamp [-noPrompt true |false]


Prerequisitesv Ensure that the database server is active. If you are using the managed IBM DB2

database, smrestore will restart the server if the server is down. If you are usinganother database server, you will receive an error if that database server isdown.

v You must stop IBM Systems Director Server before running the smrestorecommand to ensure that database updates are not being made.

v If you are restoring an external database, ensure that the -dbUserName argumentis specified correctly. With some database types, less authority is needed to runthe smsave command than the smrestore command. Ensure the -dbUserName userhas the appropriate permissions for all restore tasks. Refer to "Tips for databaseuser authorities and passwords" for more information.

v If you choose to use a custom remote database, it is important to realize thatdata is stored and migrated differently on a remote database. If you plan to usethe smsave and smrestore commands to migrate a remote database environmentto a new release, you must use additional parameters to ensure that alldiscovery and inventory data is restored correctly on the remote database. The-dbSourceDir directory command is required when migrating a remote databaseand you must ensure that the user ID performing the migration has the correctauthority.

Description

You can run the smrestore command locally from the management server orremotely by accessing the management server using a remote-access utility, such asSecure Shell (SSH) or Telnet.

To run the smrestore command, navigate to the install_root\bin directory, whereinstall_root is the root directory of your IBM Systems Director installation. Note thatthis path uses the backslash (\) to delimit the directory; depending on the systemthat you are using, you might be required to enter the path using the forwardslash (/).

Tips:

v You can restore saved persistent data only on a management server that isrunning the same operating system, with the same version of IBM SystemsDirector Server and Common Agent from which the data was saved, and withthe same database type and version. In addition, IBM Systems Director Serverand the database that you are restoring must be the same installation instancesthat were saved.

v You can save a backup image of persistent data using the smsave command.v The execution log is populated in install_root\log\smrestore.log, and all status

is updated in real time in that file. No output is posted to the command prompt.v If you save a backup image of a remote database, then you must restore the

backup to a remote database.v If you want to restore your data, you must use the same version of the Agent

Manager that was used during the backup.

Operands

None


|

||

||

Flags

-dbSourceDir directorySpecifies the directory from which the database backup image is loaded.

Note: If the database is remote, this option is required. This specified directoryis relative to the remote database system.

-dbUserName user_nameSpecifies the database user name to use for restoring the database.

Tips:v You must specify a database user name that has the privileges that are

necessary to restore the database. In most environments, the runtime accountthat is configured to access the remote database does not have theappropriate authority to execute this command.

v This option and the -dbUserPwd option are optional for AIX and Linux.These options are recommended for Windows.

v For AIX and Linux, if -dbUserName and -dbUserPwd are not specified and youhave an IBM DB2 or Oracle® Database database, you are prompted toprovide a user name and password.

v If -dbUserName and -dbUserPwd are not specified, and you are not promptedto provide a user name and password, the user name and password definedin the install_root\lwi\conf\overrides\database.properties file are used.

v If IBM Systems Director Server is using the managed IBM DB2 database, the-dbUserName and -dbUserPwd options are unnecessary and, if specified,ignored.

v If IBM Systems Director is using an external IBM DB2 database, you mustspecify the IBM DB2 instance user ID for the -dbUserName. If you specify adifferent IBM DB2 administrator ID, you might need to modify the fileownership and permissions on the database backup file in the -dbTargetDirdirectory in order to run the smrestore command.

-dbUserPwd passwordSpecifies the password for the database user.

Tips:

v This option and the -dbUserName option are optional for AIX and Linux.These options are recommended for Windows.








Tips:



-noPrompt true | falseSpecifies whether this command prompts you before continuing. Possiblevalues are:v true: The command continues without prompting.

Note: If you set -noPrompt to true, you will receive a warning after issuingthe smrestore command saying that the command execution is destructiveand will completely replace the current IBM Systems Director data with therestored image. You will be prompted to confirm that you still want to runthe operation.

v false: The command prompts you to ensure that if IBM Systems DirectorServer is stopped, no other applications are using the database. This value isthe default if this option is not specified.

-sourceDir directorySpecifies the directory that contains the backup image of the master data. Thisdirectory is the same directory that was specified for the smsave -targetDir ifthe backup image was not moved. If the backup image was moved, the sourcedirectory is the directory that contains the backup timestamp (for example,backup_20080206151358).

Note: If there is more than one backup image in the source directory, pointdirectly to the image that you want using the backup timestamp (for example,-sourceDir /ISD_bk/backup_20100128152340).

-timestamp timestampSpecifies the timestamp of the backup image to be restored, using the formatyyyymmddhhss, where yyyy is the year, mm is the month, dd is the day, hh is thehour, and ss is the seconds (for example, 20080206151358).

When the smsave command completes, it displays the timestamp of thebackup. The backup image is saved in the install_root\backup directory in asubdirectory named backup_timestamp (for example, backup_20080206151358).You can also find the timestamp in the install_root\tpm\config\logs\backup.logfile.

Exit status


install_root\log\smrestore.log, where install_root is the root directory of yourIBM Systems Director installation. Note that this path uses the backslash (\) todelimit the directory; depending on the system that you are using, you might berequired to enter the path using the forward slash (/).

v 2: The command or bundle was not found.



Examples1. Restore data from the default location on an AIX or Linux system

This example illustrates how to restore data that was saved at the timestamp20080206151358 in the default location install_root/backups on an AIX or Linuxsystem.smrestore -dbUserName Administrator -dbUserPwd secret-timestamp 20080206151358

2. Restore data from the default location on a Windows systemThis example illustrates how to restore data that was saved at the timestamp20080206151358 in the default location install_root\backups using the user ID“Administrator” and the password “secret” on a Windows system.smrestore -dbUserName Administrator -dbUserPwd secret-timestamp 20080206151358

3. Restore persistent dataThis example illustrates how to restore the backup image using the master datastored in the d:\MasterBackups directory using the user ID “Administrator”and the password “secret” on a management server running Windows.smrestore -dbUserName Administrator -dbUserPwd secret-sourceDir "D:\MasterBackups" -dbSourceDir "d:\dbBackUp"

4. Restore managed IBM DB2 database data from the default locationThis example illustrates how to restore the data for a managed IBM DB2database from the default location of install_root\backups.smrestore

smsave commandUse the smsave command to save a backup image of persistent data, including filesystem (master) data and databases.

Syntax

smsave [-h | -? | --help]

smsave [-dbUserName user_name] [-dbUserPwd password] [-targetDir directory][-dbTargetDir directory]

Prerequisitesv You must stop IBM Systems Director Server before running the smsave

command.v Ensure that all steps have been completed to prepare the database.v If you are configuring a database on a management server running AIX, the

Bash shell must be installed.

Note: This prerequisite does not apply to IBM Systems Director version 6.2.v You must stop all activity on the database before running the smsave command.

For information about how to stop activity on an IBM DB2 database, see theIBM DB2 database for Linux, Unix, and Windows Information Center.


v Ensure that the database server is active. If you are using the managed IBM DB2database, smsave will restart the server if the server is down. If you are usinganother database server, you will receive an error if that database server isdown.

v Ensure that you have sufficient disk space to store the database backup. Forinstructions, see one of the following tasks depending on your database type:– “Estimating free storage space required for IBM DB2 database”– “Estimating free storage space required for the Microsoft SQL Server and

Microsoft SQL Server Express® databases”– “Estimating free storage space required for Oracle® Database”

v If you are backing up an Oracle® Database database, use the Oracle® Databaseuser ID to ensure that you have the appropriate permissions for all backuptasks.

v If the database is remote, the smsave command produces backup of data at thelocation of the remote database server and on IBM Systems Director. Both databackup must be maintained and restored together.

v If you choose to use a custom remote database, it is important to realize thatdata is stored and migrated differently on a remote database. If you plan to usethe smsave and smrestore commands to migrate your remote databaseenvironment to a new release, you must use additional parameters to ensurethat all discovery and inventory data is restored correctly on the remotedatabase. The -dbTargetDir directory command is required when migrating aremote database and you must ensure that the user ID performing the migrationhas the correct authority.

v If your database is on a remote server, ensure that you create a directory on thatdatabase server with required permissions for the IBM Systems Director smsavecommand to ensure the smsave command has write access. On AIX and Linux,run chmod 777 on this directory so that the Oracle® Database user ID is able towrite to the directory.

Description

You can run the smsave command locally from the management server or remotelyby accessing the management server using a remote-access utility, such as SecureShell (SSH) or Telnet. The backup image is saved in the install_root\backupdirectory unless otherwise specified.

To run the smsave command, navigate to the install_root\bin directory, whereinstall_root is the root directory of your IBM Systems Director installation. Note thatthis path uses the backslash (\) to delimit the directory; depending on the systemthat you are using, you might be required to enter the path using the forwardslash (/).

This command creates a backup image of IBM Systems Director persistent data.Persistent data includes file system data, agent manager data, and data in the IBMSystems Director database. The backup image contains information about wherethe database backup is located at and uses that stored location when running therestore operation. The database backup image is saved in a format specific to thedatabase type.

Note: You can use a different database instead of the IBM Systems Directordatabase to create a backup image. However, for information about the backupimage format refer to the product specifications of that database.


|||

|||

Backups cannot be restored if database configuration for the IBM Systems Directorwas changed after the backup was created.

Important: When you run the smrestore command to restore the backup, thedatabase settings must match the settings that was used when you ran the smsaveto create the backup.

Tips:

v You can restore the saved data using the smrestore command. You can restoresaved persistent data only on a management server that is running the sameoperating system, with the same version of IBM Systems Director Server andCommon Agent from which the data was saved, and with the same databasetype and version. In addition, IBM Systems Director Server and the databasethat you are restoring must be the same installation instances that were saved.

v If the database is remote, the backup image is stored on the database server, andnot locally on the management server.

v The execution log is populated in install_root\log\smsave.log and all status isupdated in real time in that file. No output is posted to the command prompt.

Operands

None

Flags

-dbTargetDir directorySpecifies the directory in which to save the master backup image. If thedirectory is not specified, the default directory is used. The default directory isinstall_root\backup, where install_root is the root directory of your IBM SystemsDirector installation. If the database is remote, you must specify a directorythat exists on the remote database server.

Tips:

v This option is optional if you want to keep both the file backup anddatabase backup in the target directory.

v This option is required if the database is remote. The default directory,install_root\backup, does not exist on the remote database server.

v Ensure that the user ID that is running the smsave command has theappropriate operating system permissions to update this directory.

-dbUserName user_nameSpecifies the database user name to use for backing up the database.

Tips:v You must specify a database user name that has the privileges that are

necessary to back up the database. In most environments, the runtimeaccount that is configured to access the remote database does not have theappropriate authority to execute this command.

v If IBM Systems Director is using an external IBM DB2 database, you mustspecify the IBM DB2 instance user ID for the -dbUserName. Using a differentIBM DB2 administrator ID may require you to modify the file permissionson the database backup file before you are able to run the smrestorecommand.

v This option and the -dbUserPwd option are optional for AIX and Linux.These options are recommended for Windows.


|||

|




-dbUserPwd passwordSpecifies the password for the database user.

Tips:

v This option and the -dbUserName option are optional for AIX and Linux.These options are recommended for Windows.







Tips:



-targetDir directorySpecifies the directory in which to save the master backup image. If thedirectory is not specified, the default directory is used. The default directory isinstall_root\backup, where install_root is the root directory of your IBM SystemsDirector installation.

Exit status


install_root\log\smsave.log, where install_root is the root directory of your IBMSystems Director installation. Note that this path uses the backslash (\) to


delimit the directory; depending on the system that you are using, you might berequired to enter the path using the forward slash (/).



Examples1. Save data to the default location on an AIX or Linux system

This example illustrates how to save the data in the default locationinstall_root\backup on an AIX or Linux system.smsave

2. Save data to the default location on WindowsThis example illustrates how to save the data in the default locationinstall_root/backup using the user ID “Administrator” and the password“secret” on a Windows system.smsave -dbUserName Administrator -dbUserPwd secret

3. Save master data and backup data in different locationsThis example illustrates how to save the master data in the d:\MasterBackupsdirectory and the database backup in the d:\DBBackups directory using the userID “Administrator” and the password “secret” on a Windows system.smsave -dbUserName Administrator -dbUserPwd secret-targetDir "D:\MasterBackups" -dbTargetDir "d:\DBBackups"

4. Save managed IBM DB2 database data to the default locationThis example illustrates how to save the data for a managed IBM DB2 databasein the default location of install_root\backup.smsave

Once the smsave command is completed, a backup of the IBM Systems Directormaster (non-database) data will reside in the ?D:\MasterBackups? directory. Abackup of the database data will reside in the "D:\DBBackups" directory.

smstart commandUse the smstart command to start IBM Systems Director processes on managementservers running AIX and Linux.

Syntax

smstart

Description

Important: This command starts IBM Systems Director Server processes only onmanagement servers running AIX and Linux.

For management servers running on Windows, the IBM Systems Director Serverprocesses start automatically. If the processes have been stopped, you can manuallystart the processes using the net start dirserver command.

To restart a process, first stop the process and then start the process again.


Operands

None

Flags

None

Exit statusv 0: The operation completed.v 1: A usage error occurred.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you


Examples1. Start processes on Linux:

This example illustrates how to start processes running on a Linuxmanagement server.smstart

2. Start processes on Windows:This example illustrates how to start processes running on a Windowsmanagement server.net start dirserver

smstatus commandUse the smstatus command to return the active state of IBM Systems DirectorServer on a management server running Windows, AIX, or Linux.

Syntax

smstatus [-r]

Description

Tips:

v This command must be performed on the management server on which theinstallation of IBM Systems Director Server to be monitored is located.

v This command is available on Windows, but the command is not typically used.On Windows, the active status of IBM Systems Director Server is displayed inthe system tray.

Operands

None

Flags

-r Checks the state of IBM Systems Director Server and, when a status changeoccurs, displays the new status.


Exit status

The following codes are returned by this command.v 0: Active: The process is fully active and ready for work.v 1: Starting: The process is starting but is not yet ready for work.v 2: Ending: The process was requested to end but has not yet ended.v 3: Inactive: The process has ended or was never started.v 4: Error: The process has ended abnormally.v 6: Updating: The server is completing the update process. Depending upon what

is being updated, this might take several minutes. The server will start after theprocess is complete.

v 7: Incorrect parameters: Incorrect parameters were entered.

Examples1. Display the state of IBM Systems Director Server

This example illustrates how to display the current state of an IBM SystemsDirector Server that is in the process of starting but is not ready for work.smstatus

2. Display the state of IBM Systems Director Server when the status changesThis example illustrates how to display the current state of an IBM SystemsDirector Server every time the status changes.smstatus -r

smstop commandUse the smstop command to stop IBM Systems Director Server processes onmanagement servers running AIX and Linux.

Syntax

smstop

Description

Important: This command stops IBM Systems Director Server processes only onmanagement servers running AIX and Linux.

To stop IBM Systems Director Server processes on management servers running onWindows, use the net stop dirserver command.

To restart a process, first stop the process and then start the process again.

Operands

None

Flags

None

Exit statusv 0: The operation completed.v 1: A usage error occurred.v 2: The command or bundle was not found.



Examples1. Stop processes on Linux

This examples illustrates how to stop processes running on a Linuxmanagement server:smstop

2. Stop processes on WindowsThis examples illustrates how to stop processes running on a Windowsmanagement server:net stop dirserver

Supported IBM Director version 5.20 commandsThe event-action plan commands in this section are compatible with IBM Directorversion 5.20.

The commands listed in the following table are supported in this release forcompatibility with IBM Director version 5.20. For more information about thesecommands, see the commands reference in the IBM Director version 5.20information center at publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_cli_table_toc.html.

Table 4. Supported IBM Director version 5.20 commands

IBM Director version 5.20command Description and supported syntax Equivalent smcli command

genevent Sends a custom event from a Level-2 managed systemto IBM Director Server

Syntax:

genevent /type:event_type text:event_description/dest:[protocol::server_address | @EventServer]/sev:[UNKNOWN | FATAL | CRITICAL | MINOR | WARNING| HARMLESS]

genevent

twgreset Returns IBM Director Server to its installation defaultvalues

Syntax:

twgreset [-i]

smreset

twgrestore Restores the IBM Director persistent data

Syntax:

twgrestore directory [-t]

smrestore

twgsave Saves the IBM Director persistent data

Syntax:

twgsave [-s]

smsave


http://publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_cli_table_toc.html

http://publib.boulder.ibm.com/infocenter/eserver/v1r2/topic/diricinfo_5.20/fqm0_r_cli_table_toc.html

Table 4. Supported IBM Director version 5.20 commands (continued)

IBM Director version 5.20command Description and supported syntax Equivalent smcli command

twgstart Starts IBM Director processes on Linux operatingsystems

Syntax:

tgwstart

smstart

twgstat Returns the active state of IBM Director Server on AIXand Linux operating systems

Syntax:

tgwstat [-r]

smstatus

twgstop Stops IBM Director processes on Linux operatingsystems

Syntax:

twgstop

smstop

twgend Stops IBM Director processes on IBM i operatingsystems

Syntax:

twgend

smstop


Chapter 3. Appliance commands

Use the commands in this section when using IBM Systems Director in anappliance environment.

Tips:

v These commands do not run in the smcli interface.

backup commandUse the backup command to back up your whole system to a USB device or remotesecure FTP server.

Syntax

backup [--help]

backup -l usb [-Y]

backup -l sftp -s sftp_server -d sftp_directory -u user_ID [-p password][-Y]

backup -e

backup -status

Description

The backup command backs up your entire system. If you choose to back up to aUSB device, several 2 GB files with the common part of file nameYYYYmmddHHMMSS.tar.gz are created there. If you choose to back up to an SFTPserver, a file named YYYYmmddHHMMSS.tar.gz is created there. YYYYmmddHHMMSSis the time at which the backup operation started.

Notes:

v You must have smadmin authority to use this command.v The management server is stopped during the backup operation.

Flags

-d sftp_directorySpecifies the directory path on the USB device or SFTP server where thebackup file is saved. Example: -d /data/backup

-e Displays the estimated uncompressed size of the backup.


-l usb | sftpSpecifies the type of storage location for the files.


|

|

usbSpecifies to use a connected USB device.

sftpSpecifies to use a remote secure FTP server.

-p passwordSpecifies the password of the designated user.

-s sftp_serverSpecifies the path of the abstract SFTP server directory that will store thebackup files.

--statusDisplays the status of backup process.

-u user_IDSpecifies the user ID of a user who has the authority to access the SFTP server.

-Y Specifies to automatically answer “yes” to all prompts.

Exit status

The following codes are returned by this command.v 0: The operation completed.v 1: A usage error occurred.v 2: An internal error occurred. Creation of the snapshot failed.v 3: The command was not performed because authentication failed or the user

account is not authorized to perform the action.v 4: Failed to write to the USB device.v 5: A usable USB device was not found.v 6: Failed to transfer the backup file to the SFTP server.v 7: Backup or restore is already running.v 8: The usb option was specified, but an available USB device was not found.v 9: Unable to communicate with the SFTP server.v 10: Authentication with the SFTP server failed.v 11: The specified SFTP directory path is not correct.v 13: There was an unexpected error.v 14: Unable to mount the USB device.v 15: This command is not supported when HA is configured.v 16: The USB device is busy.v 17: Unable to estimate the size of the uncompressed backup.v 18: Unable to contact hypervisor for backup.v 30: Preparing the files for the image snapshot.v 31: Taking the image snapshot.v 32: Compressing and copying the image.v 50: Backup parameter validation failed.v 51: Backup notification processing failed.v 52: Backup preprocessing failed.v 53: Backup postprocessing failed.v 99: User responded no to continuation warning.

Examples1. Back up a system to a USB device

This example illustrates how to back up your whole system to an attached USBdevice.backup -l usb

2. Back up a system to a remote SFTP server


|

This example illustrates how to back up your whole system to the /backupdirectory on the remote secure FTP server with the host nameftp.yourserver.com.backup -l sftp -s ftp.yourserver.com -d /backup -u admin -p password

3. Back up a system to a specified directory on a USB device.This example illustrates how to back up your whole system to the /backupdirectory of an attached USB device.backup -l usb -d /backup

4. Get the estimated total uncompressed size of the backup file or files.This example illustrates how to get the estimated total uncompressed size ofthe backup.backup -e

5. Get the status of the backup process.This example illustrates how to get the status of the backup process while abackup is running.backup --status

cfgkbd commandUse the cfgkbd command to configure the keyboard.

Syntax

cfgkbd [--help]

cfgkbd keyboard_layout

Description

The cfgkbd command configures the keyboard.

Operands

This command takes the keyboard layout as an operand. To display a list of validkeyboard layout values that you can specify, run the command with no options oroperands, or with the --help option.

Flags


Exit status



Chapter 3. Appliance commands 519

Examples1. Change the current keyboard layout

This example illustrates how to change the current keyboard layout to the USkeyboard layout.cfgkbd us

chagentregpasswd commandUse the chagentregpasswd command to change the agent registration password.

Syntax

chagentregpasswd [--help]

chagentregpasswd -p agent_reg_password -n new_agent_reg_password

Description

Users with smadmin authority can use the chagentregpasswd command to changethe agent registration password. This command updates the agent registrationpassword on the Agent Manager Server side.

The management server must be in the Inactive state to run the chagentregpasswdcommand. Use the smstop command to change the management server to theInactive state. Restart the management server for the changes to take effect.

Note: You can use this command only for an embedded agent manager.

After you run the chagentregpasswd command, you must also update the newpassword on unregistered common agents and, if necessary, on the resourcemanager. See the “Changing the agent registration password” topic in theInformation Center for more information about how to update the agentregistration password on a common agent and resource manager.

Flags


-n | --newpassword new_agent_reg_passwordSpecifies the new agent registration password.

-p | --password agent_reg_passwordSpecifies the current agent registration password.

Exit status




Examples1. Change agent registration password

This example illustrates how to change the agent registration password. Thecommand updates the password in the “AgentManager.properties” file and thepassword of the “agentTrust.jks” truststore file.chagentregpasswd -p oldpassword -n newpassword

Note: You must also update the agent registration password on unregisteredCommon Agents and other Resource Managers. You also need to restart themanagement server for the changes to take affect.

chconfig commandUse the chconfig command to change the system date, time, time zone, locale,, orto regenerate the SSH key.

Syntax

chconfig [--help]

chconfig [[--clock local | utc] [--datetime date_time] [--timezonetime_zone | none] [-l locale] [--nonstop Enable | Disable] [--regenSShKey]]

Description

The chconfig command changes the system date, time, time zone, and locale. Itcan also regenerate the SSH key.

Flags

--clock local | utcChanges the BIOS clock to the specified type.

--datetime date_timeSets the specified date and time on the system clock. Specify date_time usingthe format MMDDhhmm[[CC]YY][.ss]:

MM month

DD day

hh hour in 24 hour format

CC century

YY year

ss seconds

The --datetime option is required when you specify the --clock option.


-l localeSets the specified locale. To see a list of all supported locales run the lsconfig-L command.


--nonstop Enable | DisableEnables or disables the IBM Systems Director nonstop service.

--regensshkeyRegenerates the SSH RSA1, DSA, and RSA keys.

--timezone time_zone | noneSets the specified time zone for the system, or removes the current time zonesetting. Specify time_zone in the format continent/city. Specify none to removethe current time zone setting.

Exit status


are not authorized to perform the action.v 5: The command was not successful.

Examples1. Update system date and time

These examples illustrate various ways to update the system clock to January25, 2010 14:30:50. These examples assume that the current year is 2010.chconfig --datetime 01251430.50

chconfig --datetime 012514302010.50

chconfig --datetime 0125143010.50

2. Update system date and time for local timeThis example illustrates how to update the system clock to December 8, 201009:45, local time.chconfig --datetime 120809452010 --clock local

3. Update system time zoneThis example illustrates how to update the system time zone to United States,Central time.chconfig --timezone America/Chicago

4. Remove system time zone settingThis example illustrates how to remove the system time zone setting.chconfig --timezone none

5. Set current localeThis example illustrates how to set the current locale to Spanish.chconfig -l es_ES

6. Regenerate the SSH keyThis example illustrates how to regenerate the SSH key.chconfig --regensshkey

chipsec commandUse the chipsec command to change the IP security connection for the applianceenvironment.


||

Syntax

chipsec [--help]

chipsec [-m IPv6_address --left IPv6_address --passkey pass_phrase] | [-cfile_name [--cert certificate_path --privateKey key_path] --passkeypass_phrase] | [{--up | --down | -r} connection_name] | [--start] |[--stop]

Description

The chipsec command changes the IP security connection for the applianceenvironment.

Flags

-c file_nameCreates an IP security connection using the specified connection file. The filetype must be txt. The connection file contains the following attributes andtheir values.

connConnection name. The connection name can be any name. For example,conn my_connection.

leftLocal system IPv6 address used for IP security connection. For example,left=fe80::21a:64ff:fe28:1799.

leftcertFile name for the security certificate to be added to the IP securityconnection. For example, leftcert=moonCert.pem. This attribute is optional.

rightRemote system IPv6 address used for IP security connection. For example,right=fe80::21a:64ff:fe29:1798.

authbyAuthentication type. For example, authby=psk.

autoAutomatic operation to be done at when the IP security connection starts.For example, auto=start.

The –passkey option is required with the -c option.

--cert certificate_pathAdds the specified security certificate to the IP security connection. Specify theabsolute path to the certificate file to be used by the IP security connection.This option is valid only with the –c option and the –privateKey option.

--down connection_nameEnds the specified connection.



--left IPv6_addressSpecifies the local IP address to be used for the IP security connection. Thisoption is required with the –m option.

-m IPv6_addressCreates an IP security connection to a Flexible Service Provider (FSP). The–left and –passkey options are required with this option.

--passkey pass_phraseSpecifies the passphrase to be used for pre-shared key (PSK) authentication.This option is required with the –c and –m options.

--privateKey key_pathSpecifies the key to be used by the IP security connection. This option is validonly with the –c option and the —cert option.

-r connection_nameRemoves the specified existing connection.

--startStarts the IP security connection service.

--stopStops the IP security connection service.

--up connection_nameEstablishes the specified connection.

Exit status



Examples1. Create an IP security connection using a connection file

This example illustrates how to create an IP security connection using aconnection file.chipsec -c user_file.txt --cert /home/pe/moonCert.pem--privateKey /home/sysadmin/moonKey.pem--passkey 1234

2. Create an IP security connection by specifying IP addressesThis example illustrates how to create an IP security connection by specifyingthe FSP and local IP addresses.chipsec -m 2002:97D:EEC3:604:9:123:99:64--left 2002:97D:EEC3:604:9:123:99:16--passkey 1234

3. Remove an IP security connectionThis example illustrates how to remove an IP security connection by connectionname.chipsec -r connection1

chkmedia commandUse the chkmedia command to test for media readiness.


Syntax

chkmedia [--help]

chkmedia -r dvd | usbdiskette | usbflashmem

Description

The chkmedia command checks media devices to determine whether they are readyto be used. The media devices that can be checked for readiness with thiscommand are DVDs, USB diskette drives, and USB flash drives. This commandtests for media readiness by mounting the specified media device. The commandwrites a small amount of data to the device, then reads and deletes the data fromthe device. Finally, the command unmounts the media device.

No other diagnostic actions are performed on the media or the media device. Themedia device cannot already be mounted when this command is run.

Flags


-r dvd | usbdiskette | usbflashmemSpecifies the type of media to test.

dvdDVD

usbdisketteUSB diskette drive

usbflashmemUSB flash drive

Exit status



Examples1. Check a USB flash drive for readiness

This example illustrates how to check a USB flash drive for readiness.chkmedia -r usbflashmem

chnetcfg commandUse the chnetcfg command to change the network settings for the system.

Syntax

chnetcfg [--help]


|

Add or remove entries from the DNS server search order or the domain suffixsearch order

chnetcfg -s {add | remove | enable | disable} [-ns DNS_server] [-dsdomain_suffix]

Add or remove a default route setting

chnetcfg -s {add | remove} --route-type Default [-i any | interface]--gateway {IPv4_address | IPv6_address}

Add a route setting to a host

chnetcfg -s add --route-type Host --destination {IPv4_address |IPv6_address} [-i any | interface] [--gateway IPv4_address | IPv6_address]

Remove a route setting from a host

chnetcfg -s remove --route-type Host --destination {IPv4_address |IPv6_address}[--gateway IPv4_address | IPv6_address]

Add route settings to a network

chnetcfg -s add --route-type Net --destination {IPv4_address |IPv6_address} --netmask IPv4_network_mask [-i any | interface] [--gatewayIPv4_address | IPv6_address]

Remove route settings from a network

chnetcfg -s remove --route-type Net --destination {IPv4_address |IPv6_address} --netmask IPv4_network_mask

Change firewall settings

chnetcfg -s {add | remove} --app-name application_name [-a none |ip_address] [--netmask IPv4_network_mask] [-i interface]

Change local name service settings

chnetcfg -s modify [--host-name host_name] [--domain-name domain_name][--host-ip-address IPv4_address | IPv6_address]

Change network settings for a specific network interface

chnetcfg -s modify -i interface {-a none | clear | multi_address |IPv4_address | IPv6_address[/prefix-length]} [--netmask IPv4_network_mask][--ipv6auto on | off] [--ipv6privacy on | off] [--dhcp-client 4 | 6 | all |none]

Change the system services settings

chnetcfg -s {enable | disable | add | remove} -c service_name[--start-on-boot on | off]

Change the DHCP service setting for a specific network interface


chnetcfg -s modify -i interface --start-ip-address IPv4_address--end-ip-address IPv4_address --netmask IPv4_network_mask

Change the NTP time server settings

chnetcfg -s {add | remove} -c xntp -a {IPv4_address | IPv6_address[/prefix_length]} | -h host_name [--ntpversion 1 | 2 | 3 | 4] [--keyindexntp_key_index] [--keyvalue ntp_key_value]

Change syslog configuration settings

chnetcfg -c syslog -s {add | remove} {-a ip_address | -h host-name} [-t{udp | tcp | tls}]

Enable TLS encryption for syslog

chnetcfg -c syslog -s enable -t tls --cacert CA-certificate --applkeyappliance-private-key --applcert appliance-certificate

Disable TLS encryption for syslog

chnetcfg -c syslog -s disable -t tls

Description

The chnetcfg command changes network settings for the system.

Flags

-a {none | multi_address | IPv4_address | IPv6_address[/prefix-length]}Specifies the network IP address. For network interface configuration, thisaddress is the static IP address configuration.

IPv6 addresses must use the following format: static-address/prefix-length.Use a value of none when no static IP address is configured.

--app-name application_nameSpecifies the application name in the firewall setting. When an invalidapplication name is specified, all valid application names are displayed.

--applcert appliance-certificateSpecifies the appliance certificate file.

--applkey appliance-private-keySpecifies the appliance private key file.

-c ssh | syslog | xntp | dhcp | networkSpecifies the type of service to change.

--cacert CA-certificateSpecifies the CA certificate file.

--destination IPv4_address | IPv6_addressSpecifies the IP address of the destination host, network, or subnet.

--dhcp-client 4 | 6 | all | noneSpecifies the type of DHCP client to configure.

--domain-name domain_nameSpecifies the local network domain name.


-ds domain_suffixSpecifies the domain suffix to add or remove.

--end-ip-address IPv4_addressSpecifies the ending IPv4 address of a DHCP range.

--gateway IPv4_address | IPv6_addressSpecifies the IP address of the next hop in the path to the destination.

-h host_nameSpecifies the host name for an NTP or syslog server.


--host-ip-address IPv4_address | IPv6_addressSpecifies the IP address that resolves to the host name.

--host-name host_nameSpecifies the new local host name.

-i any | interfaceSpecifies the LAN interface to configure, such as “eth0”. Use the value any tospecify all LAN interfaces.

CAUTION:Ensure that all four of the default ethernet ports have the same settings. Ifany of those four ports is set differently from the others, the wholeoperation will fail.

--ipv6auto on | offSpecifies whether to turn on or turn off the IPv6 autoconfiguration setting forthe network interface.

--ipv6privacy on | offSpecifies whether to turn on or turn off the IPv6 privacy extensions forautoconfiguration of the network interface.

--keyindex ntp_key_indexSpecifies the NTP authentication key index.

--keyvalue ntp_key_valueSpecifies the NTP authentication key value.

--netmask IPv4_network_maskSpecifies the IPv4 network mask.

-ns DNS_serverSpecifies the IP address of the name server to add or remove.

--ntpversion 1 | 2 | 3 | 4Specifies the NTP version when the server is not at NTP version 3 or later. Thedefault version is 3.

--route-type Net | Host | DefaultSpecifies the route type.

-s enable | disable | add | remove | modifySpecifies the new state value of the configuration.

--start-ip-address IPv4_addressSpecifies the starting IPv4 address of a DHCP range.


--start-on-boot on | offSpecifies whether to start the service specified by the -c option when thesystem is started.

Note: This option cannot be used at the same time as the add or removeoptions.

-t udp | tcp | tlsSpecifies the transmission protocol for syslog.

Exit status


are not authorized to perform the action.v 4: You must restart the system for the changes to take effect.v 12: Configuration of the route failed due to DHCP server configuration.v 13: Configuration of the route failed due to the absence of an IPv4 address.v 14: Configuration of the route failed due to the absence of an IPv6 address.v other: Other internal or external errors occurred.

Examples1. Change the host name and the network domain name

This example illustrates how to change the host name and network domainname.chnetcfg -s modify --host-name myhost --domain-name my.domain.com

2. Add the DNS settingThis example illustrates how to add the DNS setting.chnetcfg -s add -ns 9.0.7.1 -ds my.domain.com

3. Set IP address and network maska. This example illustrates how to set the IPv4 address and network mask for

network interface eth0.chnetcfg -s modify -i eth0 -a 192.168.1.11 --netmask 255.255.255.0

b. This example illustrates how to set the IPv6 address and prefix fornetwork interface eth0.chnetcfg -s modify -i eth0 -a 2002:97d:eec3:611:192:168:1:10/64

c. This example illustrates how to set the IPv4 and IPv6 address for networkinterface eth0.chnetcfg -s modify -i eth0 -a 2002:97d:eec3:611:192:168:1:10/64,192.168.1.11/24

d. This example illustrates how to set the IPv4 address and DHCP4 client fornetwork interface eth0.chnetcfg -s modify -i eth0 -a 192.168.1.11 --netmask 255.255.255.0 --dhcp-client 4

e. This example illustrates how to set the IPv4 address and DHCP6 client fornetwork interface eth0.chnetcfg -s modify -i eth0 -a 192.168.1.11 --netmask 255.255.255.0 --dhcp-client 6

f. This example illustrates how to set the IPv4 address, DHCP4 client, andDHCP6 client for network interface eth0.chnetcfg -s modify -i eth0 -a 192.168.1.11 --netmask 255.255.255.0 --dhcp-client all

g. This example illustrates how to set the IPv4 address, IPv6 address, andDHCP4 client for network interface eth0.


chnetcfg -s modify -i eth0-a 2002:97d:eec3:611:192:168:1:10/64,192.168.1.11/24 --dhcp-client 4

h. This example illustrates how to set the IPv4 address, IPv6 address, andDHCP6 client for network interface eth0.chnetcfg -s modify -i eth0

-a 2002:97d:eec3:611:192:168:1:10/64,192.168.1.11/24 --dhcp-client 6

i. This example illustrates how to set the IPv4 address, IPv6 address, DHCP4client and DHCP6 client for network interface eth0.chnetcfg -s modify -i eth0

-a 2002:97d:eec3:611:192:168:1:10/64,192.168.1.11/24 --dhcp-client all

j. This example illustrates how to set the IPv6 address and DHCP4 client fornetwork interface eth0.chnetcfg -s modify -i eth0

-a 2002:97d:eec3:611:192:168:1:10/64 --dhcp-client 4

k. This example illustrates how to set the IPv6 address and DHCP6 client fornetwork interface eth0.chnetcfg -s modify -i eth0

-a 2002:97d:eec3:611:192:168:1:10/64 --dhcp-client 6

l. This example illustrates how to set the IPv6 address, DHCP4 client andDHCP6 client for network interface eth0.chnetcfg -s modify -i eth0

-a 2002:97d:eec3:611:192:168:1:10/64 --dhcp-client all

4. Set DHCP serverThis example illustrates how to set the DHCP server on eth1.chnetcfg -s modify -i eth1 --start-ip-address 10.254.0.4

--end-ip-address 10.254.0.254 --netmask 255.255.255.0

5. Set firewall to allow incoming data packagesThis example illustrates how to set the firewall to allow incoming datapackages for the RMC application on all network interfaces.chnetcfg -s add --app-name RMC

6. Set firewall to not allow incoming data packagesThis example illustrates how to set the firewall to not allow incoming datapackages for the RMC application on all network interfaces.chnetcfg -s remove --app-name RMC

7. Set firewall to allow incoming data packages by IP addressesThis example illustrates how to set the firewall to allow incoming datapackages for the RMC application on network interface eth0.chnetcfg -s add --app-name RMC -i eth0 -a 10.10.10.135--netmask 255.255.255.0

8. Enable a serviceThis example illustrates how to enable Network Time Protocol service.chnetcfg -c xntp -s enable

9. Add an authenticated Network Time Protocol serverThis example illustrates how to add an authenticated Network Time Protocolserver. If the key index exists in the key file, the --keyvalue option is ignored.If the key index does not exist, the command will add the new key.chnetcfg -c xntp -s add -h mytimeserver.company.com--keyindex index --keyvalue password

10. Add an unauthenticated Network Time Protocol serverThis example illustrates how to add an unauthenticated Network TimeProtocol server.chnetcfg -c xntp -s add -h mytimeserver.company.com


11. Remove a Network Time Protocol serverThis example illustrates how to remove a Network Time Protocol server.chnetcfg -c xntp -s remove -a 10.10.10.32

12. Add an NTP keyThis example illustrates how to add an NTP key.chnetcfg -c xntp -s add --keyindex 999 --keyvalue password

13. Remove an NTP keyThis example illustrates how to remove an NTP key.chnetcfg -c xntp -s remove --keyindex 999

14. Add a remote logging serverThis example illustrates how to add a remote logging server to the syslogconfiguration file to enable remote logging.chnetcfg -c syslog -s add -h myhost.company.comd

15. Remove all IP addresses for an ethernet adapterThis example illustrates how to remove all IP addresses for the eth0 ethernetadapter.chnetcfg -s modify -i eth0 -a 0.0.0.0

chrmpasswd commandUse the chrmpasswd command to change the password of the specified ResourceManager user ID in the Authorization.xml file.

Syntax

chrmpasswd [--help]

chrmpasswd -t toolkit_password -u user -o old_authorization_password -nnew_authorization_password

Description

Users with smadmin authority can use the chrmpasswd command to change thepassword of the specified Resource Manager user ID in the Authorization.xml file.

The management server must be in the Active state to run the chrmpasswdcommand. Use the smstart command to change the management server to theActive state.

Flags


-n | --newpassword new_authorization_passwordSpecifies the new authorization password for the user.

-o | --oldpassword old_authorization_passwordSpecifies the old authorization password for the user.

-t | --toolkitpassword toolkit_passwordSpecifies the toolkit password. The -t | –toolkitpassword option unlocks thelocal toolkit keystore and truststore files.


Note: The toolkit registration process sets the default value of the toolkitpassword to the same value as the agent manager SSL password.

-u | --user userSpecifies the name of the user in the authorization schema for whom thepassword is changed.

Exit status



Examples1. Change password

This example illustrates how to change the agent registration password. Thecommand updates the Authorization.xml file with the new password for theuser user1.chrmpasswd -t toolkitpassword -u user1 -o oldpassword -n newpassword

chtoolkitpasswd commandUse the chtoolkitpasswd command to change the toolkit password.

Syntax

chtoolkitpasswd [--help]

chtoolkitpasswd {-a agentmanager_password -t new_toolkit_password} | -r

Description

Users with smadmin authority can use the chtoolkitpasswd command to changethe toolkit password or restore the previous toolkit password. You can use thiscommand only if the toolkit pack is already registered with the agent manager.

The toolkit password unlocks the local toolkit keystore, which enables access toevery tool inside the toolkit pack. The default toolkit password is the same as theagent manager SSL password.

The management server must be in the Active state to run the chtoolkitpasswdcommand. Use the smstart command to change the management server to theActive state.

Flags

-a | --ampassword agentmanager_passwordSpecifies the Agent Manager SSL password.



-r | --restoreRestores the previous toolkit password.

Note: You can successfully restore the previous toolkit password by using the-r option only if an attempt to run the chtoolkitpasswd command to changethe toolkit password failed.

-t | --newtoolkitpassword new_toolkit_passwordSpecifies the new toolkit password.

Exit status



Examples1. Change toolkit password

This example illustrates how to change the toolkit password.chtoolkitpasswd -a password -t newtoolkitpassword

2. Restore toolkit passwordThis example illustrates how to restore the previous toolkit password.chtoolkitpasswd -r

cpwin commandUse the cpwin command to capture a screen.

Syntax

cpwin [--help]

cpwin -o {c | v | r} -f file

Description

The cpwin command captures a screen on the local system and saves or displaysthe screen capture. You can also delete screen captures.

Flags

-f fileSpecifies the file name to be used when saving or removing the screen capture.The file is saved to or removed from the user's $HOME/.screen_capture/directory.


-o c | v | rSpecifies the screen capture options.


c Captures the screen and saves it using the file name specified with the -foption. The file is saved to the user's $HOME/.screen_capture/ directory.

When this option is specified, you are required to click the window thatyou want to capture. If you click the window manager window, the entirescreen is captured. If you click a foreground window, only the foregroundwindow is captured.

r Removes the saved screen capture file from the user's $HOME/.screen_capture/ directory, using the file name specified with the -f option.

v Displays a screen capture that was previously saved, using the file namespecified with the -f option, in the user's $HOME/.screen_capture/directory.

To close the display of the screen capture, left click on the displayed screencapture, or press Ctrl+C.

Exit status



lsconfig commandUse the lsconfig command to list the system configuration information.

Syntax

lsconfig [--help]

lsconfig -V | -v | -l | -L | -m | -k

Description

The lsconfig command lists the system configuration information. Use thiscommand to list the current locale, the supported locales, the vital product data(VPD), the version information of the system, the SSH key fingerprint, or thesystem machine type, model, and serial number (MTMS).

Flags


-k Displays the SSH key fingerprint.

-l Displays the current locale.

-L Displays all supported locales.

-m Displays the system machine type, model, and serial number (MTMS). ForSoftware Appliance, shows a virtual value that begins with the letter “V”.

-v Displays system vital product data (VPD) information.


-V Displays system version information.

Exit status



Examples1. Display system version information

This example illustrates how to display system version information.lsconfig -V

2. Display system VPD informationThis example illustrates how to display system vital product data (VPD)information.lsconfig -v

3. Display current localeThis example illustrates how to display the current locale.lsconfig -l

4. Display all supported localesThis example illustrates how to display all supported locales.lsconfig -L

5. Display system MTMSThis example illustrates how to display the system machine type, model, andserial number (MTMS).lsconfig -m

6. Display SSH key fingerprintThis example illustrates how to display the SSH key fingerprint.lsconfig -k

lsipsec commandUse the lsipsec command to display the IP security connection status for theappliance environment.

Syntax

lsipsec [--help]

lsipsec -l | -F attribute_name_list [--header] | --statusall | --statusconnection_name | -c connection_name

Description

The lsipsec command displays the IP security connection status for the applianceenvironment.


Flags

-c connection_nameDisplays information about the attributes for the specified IP securityconnection.

-F attribute_name [,{attribute_name}...]Displays information about the specified attribute name or names for all theexisting IP security connections. Multiple attribute names can be specified,separated by a comma.

--headerDisplays the attribute name with the attribute information returned by the -Foption. This option is valid only with the -F option.


-l Displays names for all existing IP security connections.

--status connection_nameDisplays the status for the specified IP security connection.

--statusallDisplays the status for all existing IP security connections.

Exit status



Examples1. Display information for attributes for all IP security connections

This example illustrates how to display information about several attributes forall existing IP security connections. In this example, the –header option is usedto display the attribute names in the output.lsipsec -F left,right,auto,authby --header

2. Display status for all IP security connectionsThis example illustrates how to display status for all existing IP securityconnections.lsipsec --statusall

3. Display information for attributes for a specified IP security connectionThis example illustrates how to display information about the attributes for thespecified IP security connection.lsipsec -c connection1

lsldap commandUse the lsldap command to display the LDAP configuration of a system.


Syntax

lsldap [--help]

Description

The lsldap command displays the Lightweight Directory Access Protocol (LDAP)configuration information of a system. LDAP-related passwords are not printed.Only a user with a role of SMAdministrator, SMManager, or SMMonitor can runthe lsldap command.

Operands

None.

Flags

--helpDisplays the syntax, a brief description of the command, and a description ofthe options and operands.

Exit status

The following codes are returned by this command.v 2: The command or bundle was not found.v 3: The command was not performed because either authentication failed or you


Examples1. Sample output from running the lsldap command

~>lsldapLDAP server: ldapserver.mycompany.comLDAP port: 636Default base DN: ou=People,dc=ldapserver,dc=mycompany,dc=comUser search filter: (&(uid=%v)(objectclass=ePerson))Bind DN: cn=Administrator,dc=ldapserver,dc=mycompany,dc=comLogin attribute: uidFilter for group objects:(|(objectclass=groupOfNames)(objectclass=groupOfUniqueNames))Filter for user objects: (objectclass=person)Member attribute: memberMember attribute is DN: trueDescription attribute: descriptionSSL enabled: true

lslogon commandUse the lslogon command to list logon information.

Syntax

lslogon [--help]

lslogon -r gui | ssh {-t | -u} [-F [attribute_name_list] [--header]]


Description

The lslogon command lists the logged on users or the tasks that they are runningon the system.

Flags

-F [attribute_name_list]Displays attribute values for attributes specified in a delimiter-separated list ofattribute names. If no attribute names are specified, then values for all of theattributes are displayed.v When specifying task attributes with the -t option, the following attribute

names are valid.

process_idThe process ID (PID) of an SSH task.

startup_timeThe time that the task started.

task_idThe ID of the task.

tty_idThe terminal ID of the user for an SSH task

user_nameThe name of the user who is logged on.

v When specifying user attributes with the -u option, the following attributenames are valid.

access_locationThe IP address or host name of the system from which the user loggedin.

logon_timeThe time that the user logged on.

session_idThe ID of the user who is logged on. For a console interface task, the IDis the session ID of the user. For an SSH task, the ID is the TTY ID of theuser.

user_nameThe name of the user who is logged on.

The attribute names can be delimited in the list by a character such as acomma (,). as in attribute_1,attribute_2. Only attribute values are displayed;attribute names are not displayed. The displayed attribute values are separatedby the same delimiter that was specified with this option.

Tip: Use this option when you want to display only attribute values, or thevalues of only selected attributes.

--headerDisplays a header record, which is a delimiter-separated list of attribute namesfor the attribute values that are displayed. This header record is the first recorddisplayed.

This option is valid only when used with the -F option.



-r gui | sshSpecifies the type of logon information to list.

guiSpecifies to list console user interface users or tasks.

sshSpecifies to list SSH users or tasks.

-t Lists information about the tasks that the users that are logged onto the systemare running.

Either this option or the -t option is required. The -t and -u options aremutually exclusive.

-u Lists information about the users that are logged on to the system.

Either this option or the -u option is required. The -u and -t options aremutually exclusive.

Exit status



Examples1. List all tasks

This example illustrates how to list all of the tasks that users logged on to theHMC Web user interface are running.lslogon -r gui -t

2. List all usersThis example illustrates how to list all of the users that are remotely logged onto the system using SSH.lslogon -r ssh -u

lsmediadev commandUse the lsmediadev command to list storage media devices.

Syntax

lsmediadev [--help]

lsmediadev [-F [attribute_name_list] [--header]]

Description

The lsmediadev command lists the storage media devices that are available for useon the system.


Flags

-F [attribute_name_list]Displays attribute values for attributes specified in a delimiter-separated list ofattribute names. If no attribute names are specified, then values for all of theattributes are displayed.

The following attribute names are valid.

descriptionSpecifies the description of the device type.

deviceSpecifies the name of the device file that represents the device.

typeRepresents the type of device.

1 CD/DVD device

2 Internal diskette drive

3 USB flash memory device

4 USB diskette drive

5 Disk drive

The attribute names can be delimited in the list by a character such as acomma (,). as in attribute_1,attribute_2. Only attribute values are displayed;attribute names are not displayed. The displayed attribute values are separatedby the same delimiter that was specified with this option.

Tip: Use this option when you want to display only attribute values, or thevalues of only selected attributes.

--headerDisplays a header record, which is a delimiter-separated list of attribute namesfor the attribute values that are displayed. This header record is the first recorddisplayed.

This option is valid only when used with the -F option.


Exit status



Examples1. List all storage media devices

This example illustrates how to list all of the storage media devices that areavailable for use.lsmediadev


lsnetcfg commandUse the lsnetcfg command to list the system network settings.

Syntax

lsnetcfg [--help]

lsnetcfg -n [-F attribute_name_list [--header]] | -f

Description

The lsnetcfg command lists the system network settings.

Flags

-f Displays firewall settings.

Either this option or the -n option is required.

-F attribute_name[,attribute_name...]Displays one or more attributes for the network settings with the -n option.Specify the attributes to display by listing one or more attribute names,separating each with a comma. If -F is specified without any attribute names,the command fails. The -F option is valid only when you also specify the -noption.

--headerDisplays a header of attribute names.

The --header option is valid only when you also specify the -F option.


-nDisplays all network settings, except those for firewall.

Exit status


are not authorized to perform the action.v 5: The command was not successful.

Examples1. Display network settings

This example illustrates how to display the system network settings, except forfirewall settings.lsnetcfg -n

2. Display host name and IP addressThis example illustrates how to display the system host name and IP address.lsnetcfg -n -F hostname,ipaddr


3. Display firewall settingsThis example illustrates how to display the system firewall settings.lsnetcfg -f

mkauthkeys commandUse the mkauthkeys command to manage SSH authentication keys.

Syntax

mkauthkeys [--help]

mkauthkeys -a "string" | -r {"ssh_string" | user_string | -u user-id}

Description

The mkauthkeys command manages SSH authentication keys. You can use thiscommand to add or remove SSH key authentication.

Flags

-a | --add "string"Adds the specified SSH key "string" as an authorized key for the user whoruns this command. The string must be enclosed in quotation marks.

The SSH key string is added to the $HOME/.ssh/authorized_keys2 file in the$HOME directory of the user.


-r | --remove {"ssh_string" | user_string | -u user_id}Performs one of the following actions, depending on the specified values.

"ssh_string"Specifying an "ssh_string" removes the specified SSH key string from theauthorized keys for the user who runs this command. The ssh_string mustbe enclosed in quotation marks.

user_stringSpecifying a user_string removes all the SSH keys generated for thespecified user from the authorized keys for the user who runs thiscommand.

Using the -r option without specifying a value removes all the SSH keysgenerated for the user specified by the -u option. Omitting a value for the-r option is valid only when you also specify the -u option.

-u user_idSpecifies the user_id for which you want to remove all authorized SSH keys.The -u option is valid only when you also specify the -r option withoutspecifying a value for the -r option.

Exit status





Examples1. Add or remove an SSH key

These examples illustrate how to add or remove an SSH key as an authorizedkey for the user who runs the mkauthkeys command. In both examples, the SSHkey “ssh-rsa AAAB3NzaC1yc2EAAA joe@somehost” is generated for the user“joe@somehost”.mkauthkeys -a "ssh-rsa AAAB3NzaC1yc2EAAA joe@somehost"

mkauthkeys -r "ssh-rsa AAAB3NzaC1yc2EAAA joe@somehost"

2. Remove all SSH keys generated for specific userThis example illustrates how to remove all of the SSH keys generated for aspecific user from the authorized keys for your user ID.mkauthkeys -r joe@somehost

3. Remove all of the authorized SSH keysThis example illustrates how to remove all of the authorized SSH keys for user“User1”.mkauthkeys -r -u User1

mkcert commandUse the mkcert command to create either a certificate signing request (CSR) or aself-signed certificate.

Syntax

mkcert [--help]

To create a certificate signing request in the default keystore :

mkcert -r -l cert_request_label -d distinguished_name -s size -frequest_filename -p keystore_password

To create a self-signed certificate:

mkcert -c -k keystore_name -n cert_label -p keystore_password -ddistinguished_name -e cert_expiry -s size

Description

Users with smadmin authority can use the mkcert command to create either acertificate signing request (CSR) or a self-signed certificate.

A CSR will be created in the default keystore file. The CSR file is created in thespecified location and can be sent to any authority that is trusted to obtain theCA-signed certificate. You can import the received CA-signed certificate into thedefault keystore. Refer to the Web site of the trusted authority that is issuing thecertificate for details about how to obtain a trusted certificate using the CSR file.


If the certificate is self-signed, the command creates a type .jks keystore in which itstores the self-signed certificate. You can then use the updcert command to importthe self-signed certificate into the default keystore.

Ensure that the host name that is specified in the Common Name (CN) field of thecertificate matches the host name that is specified in the URL that is used to accessthe targets. For example, if a long name is specified for the host name in theCommon Name field of the certificate, a long name should be specified in theURL. If these host names do not match, an error might occur while accessingtargets. If the certificate is self-signed, the command creates a type jks keystore inwhich it stores the self-signed certificate. You can import the self-signed certificateinto the default keystore.

Note: If you are creating a self-signed certificate, you can use the DNS host nameof the IBM Systems Director for the "CN" attribute. If you do not know the DNShost name, use a tool, such as nslookup, to determine the DNS host name from theIP address.

Operands


Flags

-c | --selfsigneddbCreates a self-signed certificate. If you specify -c, you must also specify thefollowing additional parameters:v -n to specify a unique name (label) for the certificatev -d to specify identity information for the certificate in the form of a

distinguished namev -s to specify a key sizev -e to specify an expiration date for the certificatev -k to create a keystore file in which to store the certificatev -p to specify a password for the keystore file

After you create the certificate, you can import it into the default keystore.

-d | --distinguishedname distinguished_nameSpecifies the identity information for the certificate request or the self-signedcertificate in the form of a distinguished name, which you specify as a quotedstring. You must use the following format, where only CN, O, and C arerequired: “CN=common_name, O=organization, OU=organization_unit,L=location, ST=state, province, C=country”. Refer to the Web site of thetrusted authority that is issuing the certificate to determine the required fieldsfor -d. This parameter is required when using either the -r parameter to createa certificate request or the -c parameter to create a self-signed certificate.

-e | --expire cert_expirySpecifies the number of days in which the self-signed certificate that you arecreating expires. The minimum value that you can specify is one day. Themaximum value is 7300 days. This parameter is required when you use the -cparameter to create a self-signed certificate.

-f | --csrfilename request_filenameSpecifies the location of a new file in which the certificate request is to be


stored. You must specify the full path and file name for this new file. Thisparameter is required when you use the -r parameter to create a certificaterequest.


-k | --selfsignedkeystore keystore_nameSpecifies the location of a new keystore file in which the self-signed certificateis to be stored. You must specify the full path and file name for this newkeystore file. This parameter is required when you use the -c parameter tocreate a self-signed certificate.

-l | --csrlabel cert_request_labelSpecifies a unique name (label) for the certificate request. This parameter isrequired when you use the -r parameter to create a certificate request.

-n | --selfsignedcertlabel cert_labelSpecifies a unique name (label) for the self-signed certificate in the keystore filespecified by the -k parameter. This parameter is required when you use the -cparameter to create a self-signed certificate.

-p | --keystorepassword keystore_passwordSpecifies the password for the keystore file to be accessed. When used with -r,the password is the password for the default keystore file. When used with -cparameter, the password is the password to be assigned to the keystore filethat is used to store the self-signed certificate.

-r | --certreqCreates a certificate request in the default keystore. If you specify -r, you mustalso specify the following additional parameters:v -l to specify a unique name for the certificate requestv -d to specify the identity information for the certificate request in the form

of a distinguished namev -s to specify a key sizev -f to create a file that contains the requestv -p to specify the password of the default keystore file

You can use the information in the file to obtain a certificate from thecertificate authority of your choice. When you obtain the certificate, you canimport it into the default keystore.

-s | --size sizeSpecifies a key size for the certificate request or the self-signed certificate thatyou are creating. You can specify a key size of 512, 1024, or 2048. Thisparameter is required when you use the -r parameter to create a certificaterequest or the -c parameter to create a self-signed certificate.

Exit status




Examples1. Create a self-signed certificate in a new keystore and assign a keystore

passwordThis example illustrates how to create a self-signed certificate “selfsignedcert”in a new keystore “sample.jks” in the location /opt/ibm/director/vmi/data andassign the keystore password as “password”. The command creates thekeystore “sample.jks” in the given location and creates the certificate“selfsignedcertlabel” inside the keystore.mkcert -c -k /opt/ibm/director/vmi/data/sample.jks

-p password -n selfsignedcert-d "CN=wl.loc.con.com,O=con,OU=IBMHTTPServer,L=RTP,ST=NC,C=US"-s 512 -e 365

2. Generate a certificate signing request (CSR) and save the request fileThis example illustrates how to generate a certificate signing request (CSR)with the label “csrfordirector” and save the request file with the name“dirservercsr.arm” in the location /opt/ibm/director/vmi/data. The commandcreates the request file in the specified location and with the name“dirservercsr.arm”. The command also creates the request in the defaultkeystore. The request file can be sent to any certificate authority (CA) forsigning. The trusted certificates received from the CA can be imported into thekeystore.mkcert -r -l csrfordirector

-d "CN=wl.loc.con.com,O=ibm,OU=IBMHTTPServer,L=RTP,ST=NC,C=US"-s 512 -f /opt/ibm/director/vmi/data/dirservercsr.arm -p passw0rd

pesh commandUse the pesh command to obtain shell access to the system for product engineeringor support.

Syntax

pesh system_id

Description

The pesh command provides full shell access to the system for product engineeringand support personnel. The pesh command takes the UVMID or unique ID of thesystem for which full shell access is needed, then prompts the user for a one daypassword that was obtained from the support organization. If the password isvalid, the user is granted full shell access.

Note: Only the pe user ID can access this command.

Tip: You can use the lsconfig command to determine the UVMID or unique ID ofthe system.

Flags

system_idIndicates the UVMID or unique ID of the system for which the pesh commandis obtaining shell access.


Exit status



Examples1. Obtain full shell access to a system

This example illustrates how to use the lsconfig command and the peshcommand to access the system with a UVMID 00abfe984677.a. Use the following command to list the system information:

lsconfig -v

The command will produce the following output:"vpd=*FC ????????Fri Mar 19 14:10:08 EDT 2010\*DS Director Management Console\*TM 7310-CR2\*SE 2022031\*MN IBM\*OS Embedded Operating Systems\*NA 9.3.78.222\*RM V1R7.2.0M0\*UUID 53859D47-C97D-475F-B953-BE684785CF48\*UVMID 00abfe984677

b. Using the unique ID that follows *UVMID, pass the system_id value to thepesh command.pesh 00abfe984677

c. When you are prompted, enter the password that you obtained fromsupport.

restore commandUse the restore command to restore your whole system from a USB device orremote secure FTP server to which you previously backed up your system.

Syntax

restore [--help]

restore -l usb -n backup_filename [-Y]

restore -l sftp -s sftp_server -n backup_filename -u user_ID [-p password][-Y]

Description

The restore command restores your entire system to the state that was saved in aprevious backup file. All data that was saved to your system since you performedthe backup is removed.

If you backed up to a USB device, the backup is contained in several 2 GB fileswith the common part of file name YYYYmmddHHMMSS.tar.gz. If you backed up to an


SFTP server, the backup is contained in a file named YYYYmmddHHMMSS.tar.gz.YYYYmmddHHMMSS is the time at which the backup operation completed.

Flags


-l usb | sftpSpecifies the type of storage location for the files.

usbSpecifies to use a connected USB device.

sftpSpecifies to use a remote secure FTP server.

-n backup_filenameSpecifies the path of the abstract directory that contains the backup files on theUSB device or SFTP server.

Note: If the backup is on a USB device, it is in the form of several 2 GB files,so you need to specify only the common part of the file names.

-p passwordSpecifies the password of the designated user.

-s sftp_serverSpecifies the path of the abstract SFTP server directory that stores the backupfiles.

-u user_IDSpecifies the user ID of a user who has the authority to access the SFTP server.

-Y Specifies to automatically answer “yes” to all prompts.

Exit status


are not authorized to perform the action.v 8: The usb option was specified, but an available USB device was not found.v 9: Unable to communicate with the SFTP server.v 10: Authentication with the SFTP server failed.v 11: The specified SFTP directory path is not correct.v 13: There was an unexpected error.v 14: Unable to mount the USB device.v 15: This command is not supported when HA is configured.v 16: The USB device is busy.v 25: Failed to copy the backup file from the SFTP server.v 26: The restore media is newer than the installed software.v 27: The backup file is not applicable for this machine.v 35: Failed to extract the backup file contents.v 50: Restore parameter validation failed.v 51: Restore notification processing failed.


v 52: Restore preprocessing failed.v 53: Restore postprocessing failed.v 99: User responded no to continuation warning.

Examples1. Restore a system from a USB device

This example illustrates how to restore your whole system from the backupcontained in file 20110110131235.tar.gz, which is on an attached USB device.restore -l usb -n 20110110131235.tar.gz

2. Restore a system from a specified directory of a USB deviceThis example illustrates how to restore your whole system from the backupcontained in file /backup/20110110131235.tar.gz of an attached USB device.restore -l usb -n /backup/20110110131235.tar.gz

3. Restore a system from a remote SFTP serverThis example illustrates how to restore your whole system from the backupcontained in file /backup/20110110131235.tar.gz on the remote secure FTPserver with the host name ftp.yourserver.com.restore -l sftp -s ftp.yourserver.com -n /backup/20110110131235.tar.gz-u admin -p password

rmloginmsg commandUse the rmloginmsg command to remove a message that is displayed with the loginprompt for all users.

Syntax

rmloginmsg [--help]

rmloginmsg -r gui | ssh

Description

The rmloginmsg command removes a message that is displayed with the loginprompt for all users.

Operands

None.

Flags

-h | --helpDisplays the syntax, a brief description of the command, and a description ofthe options and operands.

-r gui | sshSpecifies whether to remove the message that is displayed during loginthrough the Web interface (gui), or during login through SSH (ssh).

Exit status





rnvi commandUse the rnvi command to edit a text file in restricted mode.

Syntax

rnvi [--help]

rnvi -f file

Description

The rnvi command allows you to edit a text file in restricted mode. The rnvicommand starts the nvi command in a chroot (change root) environment.

The rnvi command must be issued from your home directory. Only one file can bespecified using the -r option. You can edit a file in a subdirectory located in yourhome directory by specifying the relative path name.

When this command is issued for the first time, a temporary directory, called.rnvi_tmp, is created in your home directory to store the editor's temporary files. Ifyour editing session crashes, the files cannot be recovered.

Note: When the editor exits, the error message stderr: Bad file descriptormight be displayed. You can safely ignore this message.

Flags

-f fileSpecifies the name of the text file to edit. Only one file can be specified. Thefile must be located in your home directory or a subdirectory of your homedirectory. To edit a file in a subdirectory of your home directory, specify therelative path name.


Exit status



Examples1. Edit a file in your home directory

This example illustrates how to use the rnvi command to edit a file namedexample.txt in your home directory.


rnvi -f example.txt

2. Edit a file in a subdirectory of your home directoryThis example illustrates how to use the rnvi command to edit a file named“example.txt” in the subdirectory called “myfiles” in your home directory.rnvi -f myfiles/example.txt

sendfile commandUse the sendfile command to transfer a file to a remote system.

Syntax

sendfile [--help]

sendfile -f file -h host_name -u user_ID [--passwd password] -dremote_directory [-n remote_file_name] [-s] [-k key_file]

Description

The sendfile command transfers a file to a remote system by using File TransferProtocol (FTP) or secure FTP (SFTP).

Flags

-d remote_directorySpecifies the directory on the remote system to which the file is transferred.

-f fileSpecifies the name of the file to transfer.

-h host_nameSpecifies the host name or IP address of the remote system to which the file istransferred.


-k key_fileSpecifies the name of the identity key file. The identity key file is used forpublic key authentication and is generated by the ssh-keygen command.

When the matching public key file resides on the remote system, and thepassphrase is empty, a password is not required with this command.

Note: The -k option is valid only when using secure FTP (SFTP) to transfer thefile.

-n remote_file_nameRenames the file to the specified remote_file_name when it is transferred to theremote system. When this option is not used, the transferred file retains theoriginal file name (the name that it has on the system on which you run thesendfile command).

--passwd passwordSpecifies the password to use to log in to the remote system. When this optionis not used, you are prompted to enter the password.


-sSpecifies to use SFTP to transfer the file. When this option is not specified, thecommand uses FTP to transfer the file.

Note: SSH is used to transfer the file, so the remote system must have SSHinstalled and running.

-u user_idSpecifies the user ID to use to log in to the remote system.

Exit status



Examples1. Transfer a file using FTP

This example illustrates how to use normal FTP to transfer a file to thedirectory /home/myid on the remote system.sendfile -f /home/joe/myfile -h IP Address/hostname -d /home/myid-u myid

2. Transfer a file using SFTPThis example illustrates how to use secure FTP (SFTP) to transfer a file to thedirectory /tmp on the remote system.sendfile -f /home/joe/myfile -h IP Address/hostname -d /tmp -n xfile-u myid -s

3. Transfer a file using public key authentication with SFTPThis example illustrates how to use the ssh-keygen command to generate apublic key on the HMC, then the scp command to copy the key to the remotesystem. Finally, it illustrates how to use the sendfile command to transfer a fileto the directory /tmp on the remote system by using public key authenticationwith SFTP.ssh-keygen -t rsa -f mykey

scp mykey me@myhost:/home/me/.ssh/authorized_keys2

sendfile -f /home/me/myfile -h IP Address/hostname -d /tmp -s -k mykey

setloginmsg commandUse the setloginmsg command to set a message to be displayed with the loginprompt for all users.

Syntax

setloginmsg [--help]

setloginmsg -r gui {-f file_name | -d directory_name}

setloginmsg -r ssh -f file_name

Description


|

|

|

The setloginmsg command sets a message to be displayed with the login promptfor all users.

Operands

None.

Flags

-d directory_nameSpecifies the directory of one or more properties files that contain the loginmessage to be displayed with the login prompt through the Web interface. Usethis option when you want to specify multiple properties files, as for loginmessages for multiple languages.

Use the -f | –file option to specify a single properties file. The file must benamed loginMessage.properties. The content of the file can contain HTMLformatting and must use this format:loginMessage=Your custom message

For example, you might specify the directory /home/sysadmin/logintext. Thisdirectory might include the following properties files, where each file supportsa different language:

loginMessage.propertiesloginMessage_en.propertiesloginMessage_es.propertiesloginMessage_fr.properties

loginMessage.properties is the default properties file for languages that are notsupported. The other files in this example are for English (_en), Spanish (_es),and French (_fr). Supported languages are the same as those available for yourWeb browser. Check the language settings of your Web browser to determinethe suffix to use for the file name for each language.

The contents of the properties files must be the same as described for the -foption for the Web interface.

Note: This option cannot be used with the -f option or with the -r optionwhen ssh is specified.

-f | --file file_nameSpecifies the file_name of the properties file that contains the login message tobe displayed with the login prompt. Use this option to specify a singleproperties file. Use the -d option to specify multiple properties files.

By default, when you specify a file name with no path information, the currentdirectory is assumed. To specify a different directory, specify the absolute path,for example: /home/sysadmin/mydir/loginMessage.properties.

To display a message during login through the Web interface, the file must benamed loginMessage.properties. The content of the file can contain HTMLformatting and must use this format:loginMessage=Your custom message

To display a message during login through SSH, the file can have any name.The file must contain only the text of the message to be displayed, in ASCII.The file must not contain any HTML formatting tags.

Note: This option cannot be used with the -d option.


-h | --helpDisplays the syntax, a brief description of the command, and a description ofthe options and operands.

-r gui | sshSpecifies whether to display the message during login through the Webinterface (gui), or during login through SSH (ssh).

Note: When ssh is specified, this option cannot be used with the -d option.

Exit status



smha commandUse the smha command to administer high availability (HA) configuration.

Syntax

smha [-h | --help]

smha [-s] [-p] [-S] [-R] [-r] [-X] [-F [-v | -c]] [-C resource_group_name][-E resource_group_name] [-D resource_group_name]

smha [-A [-v]]

Description

Users with smmgr authority can use the smha command to administer the highavailability (HA) configuration.

Flags

-A | --forceActiveAttempts to force the passive node to become the active node. This option isintended to be used when a node is offline and cannot be brought online andthe remaining node will not become active.

Note: If the --forceActive option is used with the --validate option, thenthe--forceActive option does not try to make the passive node active. Insteadit validates whether the current conditions allow for a --forceActive option tosucceed.

-c | --cancelCancels the current failover request.

-C resource_group_name | --configure-rg=resource_group_nameConfigures the subsystems specified by the resource group name for highavailability.


-D resource_group_name | --disable-rg=resource_group_nameDisables the subsystem specified by the resource group name. The resourcegroup is set offline.

-E resource_group_name | --enable-rg=resource_group_nameEnables the subsystem specified by the resource group name. The resourcegroup is set online.

-F | --failoverMoves the active resources to the passive node, which causes the passive nodeto become active and the active node to become passive.

Note: If the --failover option is used with the --cancel or --validate option,then the --failover option does not move the active resources. Instead, theoption either attempts to cancel the current failover request, or it validateswhether the current conditions allow for a successful failover.

-h | --helpDisplays detailed information about the command, including the syntax, adescription of the command, a description of the options and operands, errorcodes, and examples.

-p | --stopStops the HA environment, if it is configured.

-r | --resetResets any failed or stuck online resources.

-R | --resumeResumes the product in the HA environment, which restarts the managementserver.

-s | --startStarts the HA environment, if it is configured.

-S | --suspendSuspends the product in the HA environment, which shuts down themanagement server.

-v | --validateChecks for conditions that do not allow a successful failover or passive nodetakeover.

-X | --cleanupCleans up the system after a failed high availability (HA) configuration.

Note: Use this option if, due to a failed high availability (HA) configuration,one or both nodes report a status other than "Not Configured" for smhastatus.

Exit status




Examples1. Initialize a failover attempt to the passive node

This example illustrates how to initiate a failover attempt to the passive node.smha --failover

2. Cancel a failover attempt to the passive nodeThis example illustrates how to cancel a failover attempt to the passive node.smha --failover --cancel

3. Reset any failed or stuck online resourcesThis example illustrates how to reset any failed or stuck online resources.smha --reset

smhastatus commandUse the smhastatus command to display the status of the high availability (HA)configuration.

Syntax

smhastatus [-h | --help]

smhastatus [-r] [-d]

smhastatus [-r] [-m]

Description

Users with smmon authority can use the smhastatus command to display thestatus of the high availability configuration.

Flags

-d | --detailsDisplays the detailed HA resources status.

-h | --helpDisplays detailed information about the command, including the syntax, adescription of the command, a description of the options and operands, errorcodes, and examples.

-m | --mirrorsDisplays the mirroring status.

-r | --refreshContinually monitor the status and display any changes.

Exit status

The following codes are returned by this command.v 0: This HA node is active. (Issued for all options except the -h option.)v 0: The command completed successfully. (Issued only for the -h option.)v 2: The HA configuration is in the process of being removed.v 3: This HA node is passive.v 4: HA is not configured on this node.v 6: HA is in the process of being configured.


Examples1. Display the current HA status

This example illustrates how to display the current HA status.smhastatus

2. Continually display the detailed HA statusThis example illustrates how to continually display the detailed HA status.smhastatus --details --refresh

3. Continually display the mirroring statusThis example illustrates how to continually display the mirroring status.smhastatus --mirrors --refresh

smshutdown commandUse the smshutdown command to shut down the system.

Syntax

smshutdown [--help]

smshutdown -t now | number_of_minutes [-r]

Description

The smshutdown command shuts down the system. When specified, the commandreboots the system after the shutdown completes.

Flags


-rSpecifies to reboot the system after the shutdown process completes. When thisoption is not specified, the system is halted after the shutdown.

-t now | number_of_minutesSpecifies the number of minutes to wait before the shutdown process begins.Specify now as the value to start the shutdown process immediately.

Exit status



Examples1. Reboot the system

This example illustrates how to reboot the system after 3 minutes.smshutdown -t 3 -r


2. Halt the systemThis example illustrates how to halt the system immediately.smshutdown -t now

termtask commandUse the termtask command to terminate a task.

Syntax

termtask [--help]

termtask -r {gui | ssh} -s session_id -t {task_id | all}

Description

The termtask command terminates a user's task that is running on the system.

Tip: You can use the lslogon command to list information about the users loggedon to the system and the tasks that they are running.

Flags


-r gui | sshSpecifies the type of task to terminate.

guiSpecifies to terminate console user interface tasks.

sshSpecifies to terminate SSH tasks.

-s session_idSpecifies the session ID of the user that is running the task to terminate. Toterminate a console interface task (gui), use this option to specify the sessionID of the user. To terminate an SSH task (ssh), use this option to specify theTTY ID of the user.

-t task_id | allSpecifies the task or tasks to terminate.

task_idSpecifies the ID of the task. To terminate a console interface task (gui),specify the task ID of the task to terminate. To terminate an SSH task (ssh),specify the process ID (PID) of the task to terminate.

allSpecifies that all tasks that the user associated with the session is runningbe terminated. After the tasks are terminated, the user is logged off.

Exit status





Examples1. Terminate a task

This example illustrates how to use the lslogon command to display the userand task information, and then how to use the termtask command to terminatean SSH task that a user who is remotely logged on to the system is running.Use the following command to display the user and task information.lslogon -r ssh -t

In this example, assume that the output of this command shows a TTY ID of“pts/4”, and an SSH task process ID of “11655”Using this information, pass the session_id (TTY ID) and task_id (process ID)values to the termtask command.termtask -r ssh -s pts/4 -t 11655

updcert commandUse the updcert command to replace the default self-signed certificate with either acertificate signed by a certificate authority (CA) or a self-signed certificate that youcreate with the mkcert command.

Syntax

updcert [--help]

To replace the default certificate that is shipped with a CA-signed certificate:updcert -t [-i file_list] -c ssl_cert_file -n new_password

-d keystore_password

To replace the default certificate that is shipped with a self-signed certificate:updcert -s -k keystore_name -p keystore_password -l cert_name

-n new_password -d keystore_password

To restore (roll back) the default certificate into the keystore file:updcert -r -d keystore_password

To replace the entire keystore that is shipped with the management server:updcert -I -f keystore_file_path -n new_password

Description

Users with smadmin authority can use the updcert command to replace the defaultself-signed certificate. You can replace the default certificate with either aCA-signed certificate (from a trusted authority) or a customer self-signedcertificate. You can also use the updcert command to restore (roll back) the defaultcertificate into the keystore and remove the new certificate (if a rollback isrequired). The rollback option also restores the default keystore password and thewebcontainer.properties file.

Important:


v The default keystore password is ibmpassw0rd. You need the default keystorepassword to change the certificate from the default certificate to either aself-signed certificate or a CA-signed certificate.

v The updcert command works correctly only if no changes are made to thekeystore after it is shipped.

v The management server must be in the inactive state to run the updcertcommand, so use the smstop command to put the management server into aninactive state if necessary.

v When you use the updcert command to import a CA-signed certificate, thecertificate signing request (CSR) must already exist in the default keystore file .Use the mkcert command to create the CSR and store the request in the defaultkeystore file. When you use the updcert command to import either a CA-signedcertificate or a self-signed certificate, you overwrite the default certificate withthe new one.

Note: You cannot overwrite an imported certificate. If you import a certificateand later decide that you will import and use a different certificate, you mustfirst use the updcert command with the rollback option to restore the defaultcertificate into the keystore file. You can then run the updcert command toimport the new certificate.

v When you use the updcert command to import either a CA-signed certificate ora self-signed certificate, the command imports the new certificate into the defaultkeystore file, changes the keystore password, and updates thewebcontainer.properties file. The backup of the entire keystore file is created in/opt/ibm/director/vmi/data/directorbackupkeystore. The backup of thewebcontainer.properties file is created in /opt/ibm/director/vmi/data/directorbackupforwct. These files are used when you restore (roll back) thedefault keystore file.

Operands


Flags

-c | --sslcertfile ssl_cert_fileSpecifies the location of the SSL certificate file that you received from thecertificate authority (CA). You must specify the full path and file name of thisfile. This parameter is required when you use the -t parameter to import anSSL certificate.

-d | --directorkeystorepassword keystore_passwordSpecifies the current password of the default keystore file. This parameter isrequired when you use any of the following parameters:v -t parameter to import an SSL certificatev -s parameter to import a self-signed certificatev -r parameter to perform a rollback

-f | --keystorefile keystore_file_pathSpecifies the location of the keystore which will replace the management serverkeystore. This parameter is required when you use the -I parameter to replacethe management server keystore with a new keystore..



-i | --intermediatecertfile file[,file,...]Specifies the location of any certificate authority signing certificate files thatyou received from the certificate authority (CA). You must specify the full pathand file name of the files. If there is more than one file, use a ',' (comma) as thedelimiter between the files. This parameter is optional when you use the -tparameter to import the SSL certificate.

-I | --keystoreReplaces the keystore that is shipped with the management server with a newkeystore. This parameter requires you to use the -f parameter to specify thelocation of the new keystore and the -n parameter to specify new password ofthe new keystore.

-k | --keydb keystore_nameSpecifies the location of the keystore file that contains the self-signed certificateto be imported into the default keystore. You must specify the full path andfile name of the keystore file. This parameter is required when you use the -sparameter to import a self-signed certificate.

-l | --label cert_nameSpecifies the unique name (label) of the self-signed certificate to be importedinto the default keystore. This parameter is required when you use the -sparameter to import a self-signed certificate.

-n | --newpassword new_passwordSpecifies a new password for the default keystore file that is assigned after thecertificate is imported. This parameter is required when you use the -tparameter to import an SSL certificate or the -s parameter to import aself-signed certificate.

-p | --password keystore_passwordSpecifies the password of the keystore file that contains the self-signedcertificate to be imported into the default keystore. This parameter is requiredwhen you use the -s parameter to import a self-signed certificate.

Note: The default keystore password is ibmpassw0rd.

-r | --restoreRestores the contents of the keystore file with the contents of a previouslysaved backup file of the keystore. You also must use the -d parameter tospecify the current password of the default keystore file.

-s | --selfsignedImports a self-signed certificate into the default keystore file. If you specify -s,you must also specify the following additional parameters:v -k to specify the location of the user keystore file that contains the

self-signed certificatev -p to specify the password of the keystore filev -l to specify the name of the self-signed certificatev -d to specify the current password of the default keystorev -n to specify a new password for the default keystore


-t | --trustedImports the SSL certificate into the default keystore. If you specify -t, youmust also specify the following additional parameters:v -c to specify the name of the file that contains the SSL certificatev -d to specify the current password of default keystorev -n to specify a new password for the default keystore

Exit status



Examples1. Replace the default certificate in the keystore file with a self-signed certificate

This example illustrates how to replace the default certificate in the keystorefile with a self-signed certificate named “selfsignedcert”.updcert -s -k /home/<userid>/sample.jks

-l selfsignedcert -p password -n passw0rd -d passw0rd2

2. Replace the default certificate in the keystore file with an SSL certificate andimport the CA signing certificatesThis example illustrates how to replace the default certificate in the keystorefile with the SSL certificate “DSSecPubCert.arm” and import the CA signingcertificates “intcert1.arm” and “intcert2.arm”, which were received from atrusted authority such as VeriSign. There are five steps to this example.a. If the CA sends the new certificate to you as part of an e-mail message, you

must cut and paste the certificate from the e-mail message and save it in acertificate file, for example “DSSecPubCert.arm”.

Note: The e-mail message from the CA might include supplemental text infront of and after the certificate. You might see the text “BEGINCERTIFICATE” in front of the certificate and “END CERTIFICATE” after thecertificate. In this case, make sure that you cut and paste the supplementaltext along with the certificate text.

b. Save the file in the applicable directory in /home/<userid>/.c. The certificate authority might send more than one certificate. In addition to

the certificate for your server, the CA might also send additional signingcertificates or intermediate CA certificates. For example, VeriSign includesan intermediate CA certificate when sending a global server ID certificate.Copy and paste the contents of any of these certificates into separate filesand save them in the applicable directory.

Note:

v Check with the CA for the procedure for storing the intermediatecertificates. Examples are /home/<userid>/intcert1.arm and/home/<userid>/intcert2.arm.

v Save the signing certificate files and the SSL certificate file with anextension of .arm. The updcert command supports only file types of .armand .cer.


d. If the certificate authority sends a test root certificate, check with the CAregarding what to do with the certificate.

e. Run the updcert command:updcert -t

-i /home/<userid>/intcert1.arm,/home/<userid>/intcert2.arm

-c /home/<userid>/DSSecPubCert.arm-n passw0rd -d passw0rd2

3. Roll back (restore) the default certificate back into the keystore fileThis example illustrates how to roll back (restore) the default certificate backinto the keystore file. This command replaces the existing certificate in thedefault keystore file with the original default certificate. It also replaces theexisting webcontainer.properties file with the default webcontainer.propertiesfile and restores the keystore file password.updcert -r -d passw0rd

4. Replace an imported self-signed certificate with another self-signed certificateThis example illustrates how to replace the imported self-signed certificate“selfsignedcert” with another self-signed certificate “secondselfsignedcert”.

Note: You cannot use the import option to replace a previously importedcertificate. Instead, you must use the rollback option to restore the keystore fileto the default state before you can import the new certificate.There are two steps to this example:a. Run roll back to restore the default certificate into the keystore file:

updcert -r -d passw0rd

b. On successful completion of the rollback process, run the updcert commandto import the new certificate secondselfsignedcert:updcert -s -k /home/<userid>/sample1.jks

-l secondselfsignedcert -p password -n passw0rd -d passw0rd2

5. Replace the existing management server keystore with a new keystoreThis example illustrates how to replace the entire management server keystorewith a new keystore.

updcert -I -f /home/<userid>/sample.jks -n passw0rd



Appendix. Discontinued commands

This topic lists commands formerly available through the dircmd and dirclicommand-line interfaces (CLIs) and commands formerly available from themanagement server that are no longer available for use. In most cases, equivalentfunction are implemented through commands in the smcli command-line interface.

Discontinued dircli commandsThis topic lists commands formerly available through the dircli command-lineinterface (CLI) that are no longer available for use.

The following table lists dircli commands that are no longer available andprovides equivalent smcli commands if they are available.

Table 5. Discontinued dircli commands

dircli bundle/command Description Equivalent smcli syntax

configmgr/lscmcfg Retrieves configuration informationfrom IBM BladeCenter configurationprofiles or IBM BladeCenter chassis

smcli lscfgplan

configmgr/mkcmprof Creates IBM BladeCenterconfiguration profiles

smcli mkcfgplan

configmgr/rmcmprof Deletes IBM BladeCenterconfiguration profiles

smcli rmcfgplan

eal/listcmdextdirs Lists external-application tasks in theIBM Systems Director Web interface

An equivalent command is notavailable; however, you can performthis task from the IBM SystemsDirector Web interface by clickingTask Management > ExternalApplication Launch.

eal/refreshcmdextdirs Refreshes the list ofexternal-application tasks in the IBMSystems Director Web interface

An equivalent command is notavailable; however, you can performthis task from the IBM SystemsDirector Web interface by clickingTask Management > ExternalApplication Launch.

mpa/mpcli Starts the IBM Management ProcessorCommand-Line Interface (MPCLI)utility, which provides systemmanagement functions from a CLIthat connects to a service processor

An equivalent command is notavailable. Use the mpcli interfaceinstead.

remotelib/lsmethod Lists available software developmentkit (SDK) and applicationprogramming interface (API) methods

An equivalent command is notavailable.

scheduler/cancelrdmtaskactivation Cancels activation of the specifiedRemote Deployment Manager task


security/certmgr Generates, imports, distributes, orrevokes security certificates forAgentless managed system systems



Table 5. Discontinued dircli commands (continued)


ssptcli/chnsaccess Changes or removes the user ID andpassword that used to access anetwork storage switch, or listsnetwork storage switches for which auser ID and password are set


ssptcli/chnshost Changes the Storage Area Network(SAN) configuration of a specifiedhost

smcli chnshost

ssptcli/chnspath Changes a network storage path smcli chnspath

ssptcli/chnssys Changes the keyword for the hosttype identifier on a target storagesystem

smcli chnssys

ssptcli/lsnshost Exports XML containing the view ofnetworked storage for the specifiedhost

smcli lsnshost

ssptcli/lsnspath Lists network storage pathinformation in XML format or toupdate the fabric name in theinventory table

smcli lsnspath

ssptcli/lsnssys Lists (in XML) all the storagesubsystems known to the IBM ServerStorage Provisioning Tool

smcli lsnsvol

ssptcli/lsnsvol Lists network-storage volumeproperties for the specified storagesubsystem

smcli lsnspath

ssptcli/mknspath Creates a network storage pathbetween the specified host andvolume

smcli mknspath

ssptcli/mknsvol Allocates a network storage volumeand set the RAID level for laterattachment to a host

smcli mknsvol

ssptcli/rmnspath Removes a network storage pathfrom a specified host to one or morevolumes, and optionally remove thevolume if the deleted path was thelast attachment

smcli rmnspath

ssptcli/rmnsvol Removes one or more volumes on thespecified storage system

smcli rmnsvol

swd/impuapkg Imports IBM Systems Director Webinterface Update Assistant packages

smcli importupd

updatemgr/cleanlib Deletes from the library all updatesthat are no longer a member of anyprofiles or that are out-of-date

An equivalent command is notavailable; however, you can performthis task from the IBM SystemsDirector Web interface.

updatemgr/exportprof Exports all updates included in asingle profile from the library to aspecified directory location on the filesystem

smcli lsgp -F > exportgrp

updatemgr/importup Imports System x and IBMBladeCenter updates into the updateslibrary

smcli mkgp -f exportgrp


Table 5. Discontinued dircli commands (continued)


user/authusrgp Authorizes an existing user group toaccess IBM Director

smcli authusergp

user/chusr Changes access privileges for a user smcli chuser

user/chusrgp Changes access privileges for a usergroup

smcli chusergp

user/lsusr Lists the members of the IBMDirector administrator group

smcli lsuser

user/lsusergp Lists the user groups smcli lsusergp

user/rmusergp Removes a user group's authorizationto access IBM Director Server

smcli lscfgplan

Discontinued dircmd commandsThis topic lists commands formerly available through the dircmd command-lineinterface that are no longer available for use.

The following table lists dircmd commands that are no longer available andprovides equivalent smcli commands if they are available.

Tip: Although the most appropriate smcli replacement syntax is listed here, inmost cases the behavior and outputs of the equivalent smcli command are notidentical to the dircmd command.

Table 6. Discontinued dircmd commands

dircmd bundle/command Description Equivalent smcli syntax

bladecenterchassis/addbcchassis Adds a IBM BladeCenter chassissystem

smcli discover

bladecenterchassis/discoverbcchassis

Discovers IBM BladeCenter chassissystems

smcli discover

bladecenterchassis/listbcchassis Lists all IBM BladeCenter chassissystems

smcli lssys

bladecenterconfiguration/xmlfile Creates a IBM BladeCenter Deploymentwizard profile

smcli mkcfgtmpl

chassis/chassislist Lists all IBM BladeCenter chassissystems

smcli lssys -t "Chassis"

chassis/chassissubsystemlist Lists all IBM BladeCenter chassissubsystems

smcli lssys -t "Chassis"

chassis/chassissubsystemtypelist Lists all chassis subsystems types smcli lssys -t "Chassis"

cli/help Displays help for the specified dircmdcommand

smcli command -help

cli/listbundle Lists all installed dircmd commandbundles

smcli lsbundle

event/applyeventactionplan Applies an event action (automation)plan to a managed object (system) orgroup

smcli evtautopln

event/createeventactionplan Creates an event action (automation)plan

smcli mkevtautopln

Appendix. Discontinued commands 567

Table 6. Discontinued dircmd commands (continued)


event/listeventactionplans Lists all event action (automation)plans

smcli lsevtautopln

event/listeventactions Lists all of the available event actions smcli lsevtact

event/listevents Lists the contents of the event log smcli lsevtlog

event/listeventtypes Lists all of the event types smcli lsevttype

event/listeventfilters Lists information about event filters smcli lsevtfltr

monitor/applythreshold Applies a resource-monitor thresholdtask to a managed system or group

Equivalent function is not available.

monitor/listthreshold Lists all the resource-monitor thresholdtasks

smcli lsresmonthresh

mpa/listobjectattributes Lists information about some of theattributes that can be retrieved formanaged objects by thelistobjectsbyattribute command

smcli lssys -l

mpa/listobjectattributevalues Lists attribute values for a specifiedmanaged system

smcli lssys -l

mpa/listobjectbyattribute Lists information about managedobjects that match specified attributecriteria

smcli lssys -l

mpa/mpcli Starts the IBM Management ProcessorCommand Line Interface

Use the mpcli interface.

mpa/setcredentials Specifies the user ID and password forcommunicating with a serviceprocessor

smcli accesssys

mpa/setsysinterconnectconnection Creates a Management ProcessorAssistant interconnect connection toone or more remote service processorsusing a managed service processor as agateway

Equivalent function is availablefrom the mpcli interface. See theMPCLI documentation for moreinformation.

native/addsystem Creates a system object on themanagement server

smcli discover

native/listsystems Lists all systems smcli lssys

native/startdiscovery Discovers systems smcli discover

procmon/applypmtask Applies a process-monitor task to asystem

smcli runtask

procmon/createpmtask Creates a process monitor that can beused to generate events for processeson systems

smcli mkpmtask

procmon/listpmtask Lists the defined process-monitor tasks smcli lstask

scheduler/canceljobactivation Cancels activation of the specified job smcli rmjobhistory

scheduler/cancelrdmtaskactivation Cancels activation of the specifiedRemote Deployment Manager task

smcli rmjob

scheduler/getjobactivationlog Lists the activation log for the specifiedjob

smcli lsjob

scheduler/getjobstatus Lists the job status of a specified job smcli lsjob

scheduler/listjobactivations Lists all activations of all jobs with thespecified job ID

smcli lsjobhistory




scheduler/listjobactivationsbysystem

Lists all job activations for the specifiedmanaged object (systems)

smcli lsjob

scheduler/listjobs Lists scheduled jobs smcli lsjob

server/accessobjects Requests access to systems smcli accesssys

server/addtostaticgroup Adds systems to a static group smcli chgp

server/createdynamicgroup Creates a dynamic system group smcli mkgp

server/createstaticgroup Creates a static system group smcli mkgp

server/deletegroups Removes a system group smcli rmgp

server/deleteobjects Removes a system smcli rmsys

server/discoverall Discovers systems smcli discover

server/doconstraintdump

server/listdynamicgroupcriteria Lists criteria that can be used to createdynamic groups

smcli lsgp

server/listgroupattributes Lists attributes of system groups smcli lsgp

server/listgroupmembers Lists systems belonging to a specifiedgroup

smcli lsgp

server/listgroups Lists system groups smcli lsgp

server/listgroupsbyattribute Lists system groups that meet thespecified criteria

smcli lsgp

server/listinventoryvalues Lists the database inventory value forthe specified identifiers

smcli lsinv

server/listnoninteractivetasks Lists noninteractive tasks smcli lstask

server/listobjectattributes Lists system attributes which can beused as query criteria

smcli lssys

server/listobjects Lists systems smcli lssys

server/listobjectsbyattribute Lists systems that meet the specifiedcriteria

smcli lssys

server/listtaskactivationstatus Lists the activation and execution statusof noninteractive tasks

smcli lstask

server/pingobjects Performs a presence check on thespecified systems

smcli pingsys

server/removefromstaticgroup Removes systems from a static group smcli chsys

server/renameobject Renames the specified system smcli chsys

server/runtask Starts a noninteractive taskNote: The replacement smcli commandis also called runtask, but has differentcommand syntax and behaviors.

smcli runtask

snmp/addsystem Creates a new SNMP system on themanagement server

smcli discover

snmp/listsystems Lists all SNMP systems smcli lssys -t "SNMP Devices"

snmp/startdiscovery Discovers SNMP systems smcli discover

user/addgroupaccess Adds access to the specified systemgroups for the user

smcli chuser

Appendix. Discontinued commands 569



user/addtaskaccess Adds access to the specified tasks forthe user

smcli chuser

user/listgroups Lists user groups smcli lsusergp

user/listprivilegetokens Lists available privilege tokens smcli lsperm

user/listtasks Lists available tasks smcli lstask

user/listuserattributes Lists available user attributes smcli lsuser

user/listusers Lists authorized IBM Systems Directorusers

smcli lsuser

user/modifyuserattributes Changes specified user attributes for auser

smcli chuser

user/removegroupaccess Removes system group access for auser

smcli chuser

user/removetaskaccess Removes task access for a user smcli chuser

Discontinued management-server and agent commandsThis topic lists commands formerly available from the management server that areno longer available for use.

The following table lists the management-server commands that are no longeravailable and provides equivalent commands if they are available.

Table 7. Discontinued management-server commands

Command Description Equivalent syntax

crtauthlist Creates an IBM i authorization listthat includes all the objects, IFS files,and directories that are required tostart either IBM Systems DirectorServer or Common Agent.

An equivalent command is notavailable. IBM Systems Director nowsupports a Light WeightInfrastructure (LWI) security model.

twgend Stops IBM Systems Director processeson IBM i operating systems.

smcli smstop


Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte character set (DBCS) information,contact the IBM Intellectual Property Department in your country or sendinquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan, Ltd.1623-14, Shimotsuruma, Yamato-shiKanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.


IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM CorporationDept. LRAS/Bldg. 90311501 Burnet RoadAustin, TX 78758-3400U.S.A

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this information and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement, or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subjectto change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject tochange before the products described become available.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,


modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. The sampleprograms are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

TrademarksIBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and services names might be trademarks of IBM or othercompanies. A current list of IBM trademarks is available on the Web at “Copyrightand trademark information” at www.ibm.com/legal/copytrade.shtml.

Adobe is either a registered trademark or trademark of Adobe SystemsIncorporated in the United States, and/or other countries.

Other product and services names might be trademarks of IBM or othercompanies.

INFINIBAND, InfiniBand Trade Association, and the INFINIBAND design marksare trademarks and/or service marks of the INFINIBAND Trade Association.

Intel is a trademark or registered trademark of Intel Corporation or its subsidiariesin the United States and other countries.

Java and all Java-based trademarks and logos are trademarks or registeredtrademarks of Oracle and/or its affiliates.

Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both.

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

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

Other company, product, or service names may be trademarks or service marks ofothers.

Notices 573

http://www.ibm.com/legal/copytrade.shtml

Privacy policy considerationsIBM Software products, including software as a service solutions, (“SoftwareOfferings”) may use cookies or other technologies to collect product usageinformation, to help improve the end user experience, to tailor interactions withthe end user or for other purposes. In many cases no personally identifiableinformation is collected by the Software Offerings. Some of our Software Offeringscan help enable you to collect personally identifiable information. If this SoftwareOffering uses cookies to collect personally identifiable information, specificinformation about this offering’s use of cookies is set forth below.

This Software Offering does not use cookies or other technologies to collectpersonally identifiable information.

If the configurations deployed for this Software Offering provide you as customerthe ability to collect personally identifiable information from end users via cookiesand other technologies, you should seek your own legal advice about any lawsapplicable to such data collection, including any requirements for notice andconsent.

For more information about the use of various technologies, including cookies, forthese purposes, See IBM’s Privacy Policy at http://www.ibm.com/privacy andIBM’s Online Privacy Statement at http://www.ibm.com/privacy/details thesection entitled “Cookies, Web Beacons and Other Technologies” and the “IBMSoftware Products and Software-as-a-Service Privacy Statement” athttp://www.ibm.com/software/info/product-privacy.


http://www.ibm.com/privacy

http://www.ibm.com/privacy/details

http://www.ibm.com/software/info/product-privacy

Glossary

This glossary includes terms and definitions for IBM Systems Director.

To view glossaries for other IBM products, go towww.ibm.com/software/globalization/terminology/.

A

Advanced Encryption Standard (AES)A data encryption technique thatimproved upon and officially replaced theData Encryption Standard (DES). AES issometimes referred to as Rijndael, whichis the algorithm on which the standard isbased.

Advanced System Management interconnect(ASM interconnect)

A feature of IBM service processors thatenables users to connect up to 24 serversto one service processor, thus eliminatingthe need for multiple modems,telephones, and LAN ports. It providessuch out-of-band management functionsas system power control,service-processor event-log management,firmware updates, alert notification, anduser profile configuration.

Advanced System Management processor (ASMprocessor)

A service processor built into themid-range Netfinity and early xSeriesservers. IBM Systems Director can connectout-of-band to an ASM processor locatedon an ASM interconnect; an ASM PCIadapter, a Remote Supervisor Adapter, ora Remote Supervisor II must serve as thegateway service processor.

AES See Advanced Encryption Standard.

agentlessPertaining to a type of data collection thatis accomplished without installingadditional agents. Data is obtained byusing software that is already installed onthe computer.

agent managerA network service that providesauthentication and authorization and thatmaintains a registry of configuration

information about the common agentsand resource managers in a user'senvironment.

Agentless-managed systemA system that does not have an agentinstalled but can be discovered by IBMSystems Director using Secure Shell(SSH), Distributed Component ObjectModel (DCOM), or Simple NetworkManagement Protocol (SNMP).

The function available toAgentless-managed systems is limited tothe following tasks, and varies based onoperating system and hardware: discoversystems, collect limited operating-systeminventory data, remotely deploy andinstall Common Agent and PlatformAgent, perform limited remote access, andperform limited restart capabilities

alert A message or other indication that signalsan event or an impending event.

alert forwardingA function that ensures that alerts aresent, even if a managed systemexperiences a catastrophic failure, such asan operating-system failure.

Alert Standard Format (ASF)A protocol for the remote management ofsystems in environments withoutoperating systems.

ASM interconnectSee Advanced System Managementinterconnect.

ASM processorSee Advanced System Managementprocessor.

Auto-Logical Drive TransferSee auto volume transfer/auto disktransfer.

auto volume transfer/auto disk transfer(AVT/ADT)

A function that provides automaticfailover in case of controller failure on astorage subsystem.


http://www.ibm.com/software/globalization/terminology/

http://www.ibm.com/software/globalization/terminology/

AVT/ADTSee auto volume transfer/auto disktransfer.

B

Basic Input/Output System (BIOS)The code that controls basic hardwareoperations, such as interactions withdiskette drives, hard disk drives, and thekeyboard.

Bash shellAn sh-compatible shell that incorporatesthe positive aspects of Korn shell and Cshell. It serves as the GNU operatingsystem's command language interpreter.

BIOS See Basic Input/Output System.

Blade slot connectionThe connection between the SASconnectivity module and a BladeCenterserver blade.

Basic Zone Permission TableA table on the Manage Fabric page. Use itto map zone groups with hosts to zonegroups that have storage that you wantthose hosts to have access to.

BladeCenter chassisA BladeCenter unit that acts as anenclosure. This 7-U modular chassis cancontain up to 14 blade servers. It enablesthe individual blade servers to shareresources, such as the management,switch, power, and blower modules.

blade serverA high-throughput, two-way, IntelXeon-based server on a card that supportssymmetric multiprocessors (SMPs).

browser systemA system that connects to the IBMSystems Director Web interface on themanagement server through a Webbrowser.

C

chassisThe metal frame in which variouselectronic components are mounted.

chassis detect-and-deploy profileA profile that IBM Systems Directorautomatically applies to all newBladeCenter chassis when they arediscovered. The profile settings include

management module name, networkprotocols, and static IP addresses. IfRemote Deployment Manager (RDM) isinstalled on the management server, thechassis detect-and-deploy profile also caninclude deployment policies.

CIM See Common Information Model.

cloningIn z/VM®, a copying technique thatpreserves the characteristics of theoriginal but personalizes instance-specificdata. The result of a cloning operation isnew instance of an entity (for example, ofa virtual disk, a virtual computer system,or an operating system) rather than abackup of the original.

clusterA collection of complete systems thatwork together to provide a single, unifiedcomputing capability.

Common AgentCommon Agent provides a rich set ofsecurity, deployment, and managementfunction. The function available forCommon-Agent managed systems variesbased on operating system and hardware,and includes the following tasks: discoversystems; collect comprehensive platformand operating system inventory data;monitor health and status; manage alerts;remotely deploy and install CommonAgent; perform remote access, includingtransferring files; perform powermanagement function; additional eventsupport; monitor processes and resources,and set critical thresholds that sendnotifications when triggered; manageoperating system resources and processes.

Common Agent-managed systemAn IBM or non-IBM server, desktopcomputer, workstation, or mobilecomputer that has Common Agentinstalled. The function of a CommonAgent-managed system varies dependingon the operating system and hardware.

Common Information Model (CIM)An implementation-neutral,object-oriented schema for describingnetwork management information. TheDistributed Management Task Force(DMTF) develops and maintains CIMspecifications.


configuration planA set of configuration templates used toconfigure a system.

configuration settingRealtime definition of a system or device,which can be saved as a configurationtemplate. You can save configurationsettings from a system and turn then intoconfiguration templates, or you can createconfiguration setting from scratch.

configuration templateA version of configuration settings thatare not on a given system, but are storedfor future deployment. You can deploy aconfiguration template on a systemwithout having it as a member of aconfiguration plan.

D

databaseThe database that contains the data storedby IBM Systems Director Server.

database serverThe server on which the databaseapplication and database are installed.

Data Encryption Standard (DES)A cryptographic algorithm designed toencrypt and decrypt data using a privatekey.

DES See Data Encryption Standard.

Diffie-Hellman key exchangeA public, key-exchange algorithm that isused for securely establishing a sharedsecret over an insecure channel.

digital signature algorithm (DSA)A security protocol that uses a pair ofkeys (one public and one private) and aone-way encryption algorithm to providea robust way of authenticating users andsystems. If a public key can successfullydecrypt a digital signature, a user can besure that the signature was encryptedusing the private key.

discoveryThe process of finding resources withinan enterprise, including finding the newlocation of monitored resources that weremoved.

disk poolIn z/VM Center, a logical grouping ofcontiguous disk spaces. A disk pool can

include disk spaces from multiplephysical disks. A disk pool corresponds toa z/VM Directory Maintenance Facilityallocation group.

distributed component object model (DCOM)An extension of the Microsoft ComponentObject Model (COM) to support objectsdistributed across a network.

DomainA group of IP addresses that correspondsto a specific site, group, university,company, or other organization.

DSA See digital signature algorithm.

DwordA sequence of four contiguous bytes orcharacters which, together, are consideredone unit. When discussing the bits thatare transmitted over a physical link, dwordrepresents four characters (or 40 bits).When discussing the contents of a frameafter 10b8b decoding, dword representsfour bytes (or 32 bits).

Dword syncDword synchronization. Detection of anincoming stream of dwords from aphysical link by a PHY.

E

ECM Expander connection manager. An objectwithin an expander that manages routing.

enclosureA unit that houses the components of astorage subsystem, such as a control unit,disk drives, and power source.

endpointThe system that is the origin ordestination of a session.

event An occurrence of significance to a task orsystem. Events can include completion orfailure of an operation, a user action, orthe change in state of a process.

event actionThe action that IBM Systems Directortakes in response to a specific event orevents.

event-automation planA user-defined plan that determines howIBM Systems Director will manage certainevents. An event action plan comprises

Glossary 577

one or more event filters and one or morecustomized event actions.

event filterA filter that specifies the event criteria foran event action plan. Events must meetthe criteria specified in the event filter inorder to be processed by the event actionplan to which the filter is assigned.

ExpanderA device that enables quick aggregationof several disk drives in a single SASdomain. An expander can connectmultiple hosts to multiple targets. A SASconnectivity module is an expander.

Extensible Markup Language (XML)A standard metalanguage for definingmarkup languages that is based onStandard Generalized Markup Language(SGML).

F

fabric A complex network using hubs, switches,and gateways. Fibre channel uses a fabricto connect devices.

field-replaceable unit (FRU)An assembly that is replaced in itsentirety when any one of its componentsfails.

File Transfer Protocol (FTP)In TCP/IP, an application layer protocolthat uses TCP and Telnet services totransfer bulk-data files between machinesor hosts.

FRU See field-replaceable unit.

G

gateway

gigabyte (GB)In decimal notation, 1 073 741 824 whenreferring to memory capacity; in all othercases, it is defined as 1 000 000 000.

group A logical set of managed objects. Groupscan be dynamic, static, or task-based.

H

HBA Host bus adapter. It plugs into a host sothat it can communicate with a SCSIdevice.

host objectA logical object that groups one or more

worldwide port names (WWPNs) of thehost bus adapters (HBAs) that the clusterhas detected on the storage area network(SAN).

host systemA system that contains resources fromwhich virtual servers are constructed.

HT See Hyper-Threading.

Hyper-Threading (HT)A technology with which a singleprocessor can function as two virtualprocessors and execute two threadssimultaneously.

hypervisorA program or a portion of LicensedInternal Code (LIC) that allows multipleinstances of operating systems to runsimultaneously on the same hardware.

I

IBM Systems Director environmentThe complex, heterogeneous environmentmanaged by IBM Systems Director. Itincludes systems, BladeCenter chassis,software, and SNMP devices.

IBM Systems Director plug-insA tool that extends the functionality ofIBM Systems Director (for example,Electronic Service Agent™).

IBM Systems Director ServerThe main component of IBM SystemsDirector software. When installed on themanagement server, it provides basicfunctions such as discovery of themanaged systems, persistent storage ofconfiguration and management data, aninventory database, event listening,security and authentication, managementconsole support, and administrative tasks.

IBM Systems Director Server serviceA service that runs automatically on themanagement server, and provides theserver engine and application logic forIBM Systems Director.

IBM Systems Director service accountThe Windows operating-system accountassociated with the IBM Systems Directorservice.

image A bootable operating system andadditional software in the form of a singleraw image file. You can store, copy, and


customize system images to reuse themfor creating virtual servers.

image repositoryA part of a local or shared file system thatis used to store system images.

inband communicationPertaining to events that are transmittedbetween IBM Systems Director Server andservice processors in systems that arerunning the required IBM SystemsDirector agent

InitiatorA SCSI device that asks another SCSIdevice (the target) to perform anoperation. Usually, a host computer actsas an initiator and a peripheral deviceacts as a target. With SAS zoning,initiators and targets can see only parts ofa domain. These parts are called zonegroups.

instanceAn individual realization of the operatingsystem with a particular version,configuration, physical location, andidentifier.

In object-oriented programming, an objectof a particular class.

integrated system management processor(ISMP)

A service processor built into somexSeries servers. ISMP is the successor tothe Advanced System Management (ASM)processor.

Intelligent Peripheral Management Interface(IPMI)

A standard for controlling intelligentdevices that monitor a system. It providesfor dynamic discovery of sensors in thesystem and the ability to monitor thesensors and be informed when thesensor's values change or go outsidecertain boundaries.

interprocess communication (IPC)

1. The process by which programs sendmessages to each other. Sockets,semaphores, signals, and internalmessage queues are common methodsof interprocess communication.

2. A mechanism of an operating systemthat allows processes to communicate

with each other within the samecomputer or over a network.

IPC See interprocess communication.

ISMP See integrated system managementprocessor.

iso imageA disk image for an ISO 9660 file system,containing the installable files for aparticular update or upgrade.

inventory dataInformation about physical, logical, andvirtual hardware (such as virtual systems,virtual servers, and farms), softwareapplications, operating systems,middleware, firmware and BIOS,diagnostics, and network.

J

job A separately runnable unit of work.

job instanceA specific occurrence of a job that isrunning or has completed running.

K

keystoreIn security, a storage object, either a file ora hardware cryptographic card, whereidentities and private keys are stored, forauthentication and encryption purposes.Some keystores also contain trusted, orpublic, keys.

L

launched taskTasks that start outside of the IBMSystems Director Web interface.

light path diagnosticsA technology that provides a lighted pathto failed or failing components toexpedite hardware repairs.

logical unit number (LUN)In the Small Computer System Interface(SCSI) standard, a unique identifier usedto differentiate devices, each of which is alogical unit (LU).

Loss dword syncAn error that occurs when a PHY stopsdetecting an incoming stream of dwords.

LUN See logical unit number.

Glossary 579

M

MAC addressSee Media Access Control address.

management moduleThe BladeCenter component that handlessystem-management functions. Itconfigures the chassis and switchmodules, communicates with the bladeservers and all I/O modules, multiplexesthe keyboard/video/mouse (KVM), andmonitors critical information about thechassis and blade servers.

MD5 A type of message algorithm that convertsa message of arbitrary length into a128-bit message digest. This algorithm isused for digital signature applicationswhere a large message must becompressed in a secure manner.

management serverThe server on which IBM SystemsDirector is installed.

Media Access Control address (MAC address)In a local area network, the protocol thatdetermines which device has access to thetransmission medium at a given time.

megabyte (MB)For processor storage, real and virtualstorage, and channel volume, 2 to the20th power or 1 048 576 bytes.

For disk storage capacity andcommunications volume, 1 000 000 bytes.

N

network interface cardA printed circuit board that plugs into apersonal computer, server, or workstation.It controls the exchange of data over anetwork and provides the electronicfunctions for the data-link protocol oraccess method, such as token ring orEthernet.

network interface controller (NIC)Hardware that provides the interfacecontrol between system main storage andexternal high-speed link (HSL) ports.

Network News Transfer Protocol (NNTP)A protocol that is used to post messagesin, distribute messages to, and retrievemessages from news groups and totransfer articles between news servers.

nonvolatile random access memory (NVRAM)Random access memory (storage) thatretains its contents after the electricalpower to the machine is shut off.

NVRAMSee nonvolatile random access memory.

O

out-of-band communicationPertaining to events that are transmittedbetween the service processor and IBMSystems Director Server over a sharedconnection. The type of service processorpresent in a server determines whichpaths out-of-band communication cantake. These types of communication areknown as out-of-band communicationbecause they take place independent of anoperating system.

P

PCI See Peripheral Component Interconnect.See also Peripheral ComponentInterconnect-X.

PCI-X See Peripheral Component Interconnect-X.See also Peripheral ComponentInterconnect.

Peripheral Component Interconnect (PCI)A local bus that provides a high-speeddata path between the processor andattached devices. See also PeripheralComponent Interconnect-X.

Peripheral Component Interconnect-X (PCI-X)An enhancement to the PeripheralComponent Interconnect (PCI)architecture. PCI-X enhances thePeripheral Component Interconnect (PCI)standard by doubling the throughputcapability and providing additionaladapter-performance options whilemaintaining backward compatibility withPCI adapters. See also PeripheralComponent Interconnect.

persistentPertaining to data that is maintainedacross session boundaries, usually innonvolatile storage such as a databasesystem or a directory.

PFA See Predictive Failure Analysis.

PHY Physical layer. A PHY is responsible forthe transmission of signals between


computers. The function of each zonegroup is determined by how youconfigure each PHY port on an expander.

PHY resetAny of several problems that can ariseduring a PHY reset sequence that cancause the sequence to fail.

physical platformAn IBM Systems Director managed objectthat represents a single physical chassis orserver that has been discovered throughthe use of the Service Location Protocol(SLP).

Platform AgentPlatform Agent provides a lighterfootprint and fewer managementfunctions than the Common Agent. Thefunction available for Platform-Agentmanaged systems is limited to thefollowing tasks, and varies based onoperating system and hardware: discoversystems, collect limited platforminventory data, monitor health and status,manage alerts, remotely deploy andinstall Common Agent, perform limitedremote access, and perform limited restartcapabilities.

Platform Agent-managed systemAn IBM or non-IBM server, desktopcomputer, workstation, or mobilecomputer that has Platform Agentinstalled.

Platform managerSoftware that manages one or more hostsystems and their associated virtualservers and operating systems. Platformmanagers can be started from the IBMSystems Director Web interface. Forexample, IBM BladeCenter ManagementModule, IBM Hardware ManagementConsole (HMC), IBM IntegratedVirtualization Manager (IVM), andVMware VirtualCenter are platformmanagers.

plug-inA software module that adds function toan existing program or application.

POST See power-on self-test.

power-on self-test (POST)A series of internal diagnostic testsactivated each time the system power isturned on.

Predictive Failure Analysis (PFA)A scheduled evaluation of system datathat detects and signals parametricdegradation which might lead tofunctional failures.

private keyIn secure communication, an algorithmicpattern used to encrypt messages thatonly the corresponding public key candecrypt. The private key is also used todecrypt messages that were encrypted bythe corresponding public key. The privatekey is kept on the user's system and isprotected by a password. See also publickey.

public keyIn secure communication, an algorithmicpattern used to decrypt messages thatwere encrypted by the correspondingprivate key. A public key is also used toencrypt messages that can be decryptedonly by the corresponding private key.Users broadcast their public keys toeveryone with whom they must exchangeencrypted messages. See also private key.

Q

R

remote I/O enclosureAn expansion enclosure of PeripheralComponent Interconnect-X (PCI-X) slots,for example, an RXE-100 RemoteExpansion Enclosure. The enclosureconsists of one or two expansion kits.

Remote Supervisor AdapterAn IBM service processor. It is built intosome xSeries servers and available as anoptional adapter for use with others.When used as a gateway serviceprocessor, the Remote Supervisor Adaptercan communicate with all serviceprocessors on the Advanced SystemManagement (ASM) interconnect.

resourceA generic term for anything that IBMSystems Director can manage. Forexample, systems, groups, and updatesare all resources.

resource managerIn the Tivoli common agent services , theserver of a management application thatdirectly interacts with a managed

Glossary 581

resource. For example, a resourcemanager installs bundles on the agentand starts and stops a subagent.

resource-monitor thresholdThe point at which a resource monitorgenerates an event.

root user

1. In Linux and UNIX operatingsystems, a user who has superuserauthority and root privileges. A rootuser's user identifier (UID) is 0.

2. A system user who operates withoutrestrictions. A root user has the specialrights and privileges needed toperform administrative tasks.

RSA See Remote Supervisor Adapter.

S

SAN Storage area network. A network thatattaches computer storage devices toservers. (A disk array controller is anexample of a computer storage device.)

SAS Serial attached SCSI. A mechanism foraccessing computer peripheral devices.SAS employs a serial (one bit at a time)means of digital data transfer over thincables.

SAS domainThe I/O system that can also serve as aSCSI domain. Also known as a servicedelivery subsystem.

SATA Serial advanced technology attachment. Away to connect hard disk drives tocomputer systems. SATA is based onserial signaling technology, unlike currentIntegrated Drive Electronics (IDE) harddisk drives that use parallel signaling.

scalable nodeA physical platform that has at least oneSMP Expansion Module. Additionalattributes are assigned to a physicalplatform when it is a scalable node. Theseadditional attributes record the number ofSMP Expansion Modules, SMP ExpansionPorts, and RXE Expansion ports on thephysical chassis.

scalable partitionAn IBM Systems Director managed objectthat defines the scalable nodes that canrun a single image of the operatingsystem. A scalable partition has a single,

continuous memory space and access toall associated adapters. A scalablepartition is the logical equivalent of aphysical platform. Scalable partitions areassociated with scalable systems andcomprise only the scalable nodes fromtheir associated scalable systems.

scalable systemAn IBM Systems Director managed objectthat consists of scalable nodes and thescalable partitions that are composed ofthe scalable nodes in the scalable system.When a scalable system contains two ormore scalable nodes, the servers that theyrepresent must be interconnected throughtheir SMP Expansion Modules to make amultinode configuration, for example, a16-way xSeries 455 server made from fourscalable nodes.

SCSI Small computer systems interface. Ahigh-speed communications protocol thatallows your computer to communicatewith peripheral hardware.

SCSI domainAn I/O system that consists of a set ofSCSI devices that communicate with eachother through a service deliverysubsystem.

secure copy (SCP)A means of securely transferringcomputer files between a local and aremote host or between two remote hostsusing secure shell (ssh).

Secure Hash Algorithm (SHA)An encryption method in which data isencrypted in a way that is mathematicallyimpossible to reverse. Different data canpossibly produce the same hash value,but there is no way to use the hash valueto determine the original data.

Secure Sockets Layer (SSL)A security protocol that providescommunication privacy. With SSL,client/server applications cancommunicate in a way that is designed toprevent eavesdropping, tampering, andmessage forgery.

secure shell (ssh)A Unix-based command interface andprotocol for securely getting access to aremote computer.


server farmA group of network servers that arehoused in one location.

Service delivery subsystemA SAS domain.

Service Location Protocol (SLP)An Internet protocol that identifies anduses network hosts without having todesignate a specific network host name.

service processorA generic term for Remote SupervisorAdapters, Advanced System Managementprocessors, Advanced SystemManagement PCI adapters, integratedmanagement modules, and integratedsystem management processors (ISMPs).These hardware-based managementprocessors used in IBM Netfinity andxSeries servers work with IBM SystemsDirector to provide hardware status andalert notification.

Simple Object Access Protocol (SOAP)A lightweight, XML-based protocol forexchanging information in adecentralized, distributed environment.SOAP can be used to query and returninformation and invoke services acrossthe Internet.

SLP See Service Location Protocol.

SMBIOSSee system management BIOS.

SMP SCSI management protocol. Used tomanage SAS point-to-point topology.

SMP Expansion ModuleAn IBM xSeries hardware option. It is asingle module that containsmicroprocessors, disk cache, randomaccess memory, and three SMP ExpansionPort connections. Two SMP ExpansionModules can fit in a chassis.

snap-inA registered user exit program that isdefined to be called from mail serverframework user exit points. The mailserver framework user exit points arereferred to as ports by the mail serverframework. Systems will snap-in theprograms that are needed to operate.

SNMP Access and Trap ForwardingAn IBM Systems Director Agent featurethat enables SNMP to access

managed-system data. When installed ona managed system, this feature enablesSNMP-based managers to poll themanaged system and receive its alerts. IfSystem Health Monitoring is installed onthe managed system also, hardware alertscan be forwarded as SNMP traps.

SNMP deviceAn embedded device that uses SNMP tomonitor network-attached devices,printers, or computers for conditions thatrequire system-management attention.

SOAP See Simple Object Access Protocol.

SQL See Structured Query Language.

SSL See Secure Sockets Layer.

SSP Serial SCSI protocol. Used tocommunicate with SAS devices and SCSIsoftware.

static partitionA view-only scalable partition.

Storage Management Initiative Specification(SMI-S)

A design specification developed by theStorage Networking Industry Association(SNIA) that specifies a secure and reliableinterface with which storage managementsystems (SMSs) can identify, classify,monitor, and control physical and logicalresources in a storage area network(SAN). The interface integrates thevarious devices to be managed in astorage area network (SAN) and the toolsused to manage them.

storage poolContainers of virtual disks that reside onthe Virtual I/O Server.

storage subsystemA storage control and its attached storagedevices.

storage volumeA representation of a volume from thestandpoint of the storage system thatcontains the volume.

STP SCSI tunneling protocol. Used to identifyand communicate with SATA devices.

Structured Query Language (SQL)A standardized language for defining andmanipulating data in a relationaldatabase.

Glossary 583

Subtractive routing attributeThe attribute of an expander PHY thatindicates that it can be used by the ECMto route connection requests to anattached expander device.

Subtractive routing methodThe method the ECM uses to routeconnection requests to an expanderdevice.

switch moduleThe BladeCenter component that providesnetwork connectivity for the BladeCenterchassis and blade servers. It also providesinterconnectivity between themanagement module and blade servers.

systemOperating-system-based orhardware-based endpoint that has an IPaddress and host name and can bediscovered and managed by IBM SystemsDirector. For example, storage devices,network devices, physical servers, virtualservers, and operating systems aresystems.

system management BIOS (SMBIOS)A specification that extends BIOS tosupport the retrieval of management data.

system variableA user-defined keyword and value pairthat can be used to test and track thestatus of network resources. Systemvariables can be referred to whereverevent-data substitution is allowed.

T

Target Another SCSI device that communicateswith the originating SCSI device.

target systemA managed system on which an IBMSystems Director task is performed.

terabyte (TB)For processor storage, real and virtualstorage, and channel volume, 2 to the40th power or 1 099 511 627 776 bytes.

For disk storage capacity andcommunications volume, 1 000 000 000000 bytes.

TopologyThe geometric configuration of acomputer network, or how the network isphysically laid out. Common topologies

are star (centralized), bus (decentralized),and ring (decentralized).

triple Data Encryption Standard (triple DES)A block cipher algorithm that can be usedto encrypt data transmitted betweenmanaged systems and the managementserver. Triple DES is a securityenhancement of DES that employs threesuccessive DES block operations.

triple DESSee triple Data Encryption Standard.

Trivial File Transfer Protocol (TFTP)In Internet communications, a set ofconventions that transfers files betweenhosts using minimal protocol.

trustoreIn security, a storage object, either a file ora hardware cryptographic card, wherepublic keys are stored in the form oftrusted certificates, for authenticationpurposes in Web transactions. In someapplications, these trusted certificates aremoved into the application keystore toreside with the private keys.

U

Universally Unique Identifier (UUID)The 128-bit numerical identifier that isused to ensure that two components donot have the same identifier.

undoable diskA type of virtual disk that saves changesto a temporary file instead of to thevirtual disk itself. Changes can becommitted when the virtual machine ispowered off.

UUID See Universal Unique Identifier.

V

viewport

1. In the GDDM function, a rectangulararea within the picture space thatdefines where the output of thecurrent page appears on the workstation.

2. In GL, the last transformation in thegraphics pipeline, which is used tomap from normalized devicecoordinates to device coordinates. Theviewport maps the unit cube x/w =


+/-1, y/w = +/-1, z/w = +/-1 to thescreen space, as measured in pixels.

3. That portion of a partition or usablearea defined for display of data to theoperator. The viewport has apredefined size and position on thescreen and is related to a presentationspace through a specified window.

4. In BMS, that part of a screen that isallocated to a partition.

virtual farmA collection of host systems and theirassociated virtual servers. Virtual farmscan represent farms that are defined inVMware VirtualCenter. Virtual farms canalso be a collection of hosts in othersupported virtualization environments.

virtualization environmentDescribes all of the componentsassociated with a managed system and itsvirtualized resources. The associatedcomponents can include a platformmanager, host systems, virtual farms,virtual servers, and guest operatingsystems. The following are examples ofvirtualization environments:1. Power Systems that are under the

control of a Hardware ManagementConsole (HMC)

2. Power Systems that are under thecontrol of an Integrated VirtualizationManager (IVM)

3. VMware ESX Server4. VMware VirtualCenter

virtual serverA system composed of partitioned,shared, or virtualized resources presentedfrom a host system. An operating systemand other software can be installed on avirtual server. Terms also used for thisconcept are Virtual Machine, HostedComputer, Child Partition, Logical Partition,Domain Guest, Guest Domain, or domU.

vital product data (VPD)Information that uniquely defines system,hardware, software, and microcodeelements of a processing system.

volumeA discrete unit of storage on disk, tape, orother data recording medium thatsupports some form of identifier and

parameter list, such as a volume label orinput/output control.

VPD See vital product data.

W

Wake on LANA technology that enables a user toremotely turn on systems for off-hoursmaintenance. A result of the Intel-IBMAdvanced Manageability Alliance andpart of the Wired for ManagementBaseline Specification, users of thistechnology can remotely turn on a serverand control it across the network, thussaving time on automated softwareinstallations, upgrades, disk backups, andvirus scans.

walk An SNMP operation that is used todiscover all object instances ofmanagement information implemented inthe SNMP agent that can be accessed bythe SNMP manager.

Web Services Description Language (WSDL)An XML-based specification fordescribing networked services as a set ofendpoints operating on messagescontaining either document-oriented orprocedure-oriented information.

Windows Management Instrumentation (WMI)An application programming interface(API) in the Windows operating systemthat enables devices and systems in anetwork to be configured and managed.WMI uses the Common InformationModel (CIM) to enable networkadministrators to access and sharemanagement information.

WMI See Windows ManagementInstrumentation.

WMI Query Language (WQL)A subset of the Structured QueryLanguage (SQL) with minor semanticchanges to support WindowsManagement Instrumentation (WMI).

WQL See WMI Query Language.

WSDLSee Web Services Description Language.

X

XML See Extensible Markup Language.

Glossary 585

Y

Z

z/VM An IBM System z and zSeries operatingsystem that acts as virtualization software.z/VM can virtualize all system resources,including processors, memory, storagedevices, and communication devices.z/VM supports the concurrent operationof hundreds of operating systeminstances.

Zone configurationA collection of information that describesthe zoning for a SAS domain.

Zone groupA part of a domain whose properties andlimits you specify on the Basic ZonePermission Table. This table is on theManage Fabric page.

Symbols and Numerics

10b8b decodingDecoding a 10-bit character (a control ordata character) into an 8-bit byte (acontrol or data byte).


��

Printed in USA