Frp0 Bk Commands

IBM SystemsIBM Systems DirectorCommands ReferenceVersion 6.1.2

GC30-4170-04

NoteBefore using this information and the product it supports, read the information in Notices onpage 523.

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

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

Chapter 1. smcli - Systems managementcommand-line interface . . . . . . . . 1Language specifications for smcli commands . . . 5Port configuration for smcli . . . . . . . . . 6CLILEGACY environment variable . . . . . . . 6Alphabetical listing of all smcli commands . . . . 6lsbundle command . . . . . . . . . . . . 14System commands . . . . . . . . . . . . 15

accesssys command. . . . . . . . . . . 17chsys command . . . . . . . . . . . . 22lssys command . . . . . . . . . . . . 27pingsys command . . . . . . . . . . . 33rmsys command. . . . . . . . . . . . 38rpower command . . . . . . . . . . . 42

Web interface commands . . . . . . . . . . 47endSession command . . . . . . . . . . 47

Group commands . . . . . . . . . . . . 49chgp command . . . . . . . . . . . . 50lsgp command . . . . . . . . . . . . 55mkgp command . . . . . . . . . . . . 62rmgp command . . . . . . . . . . . . 67

Discovery and inventory commands . . . . . . 70discover command . . . . . . . . . . . 71collectinv command . . . . . . . . . . 74lsinv command . . . . . . . . . . . . 79

Configuration plans and templates commands. . . 85Configuration plan commands . . . . . . . 85Configuration template commands . . . . . 93

Status commands . . . . . . . . . . . . 102chled command . . . . . . . . . . . 103lsled command . . . . . . . . . . . . 107lsstatus command . . . . . . . . . . . 110

Resource monitor commands . . . . . . . . 116Resource monitor commands . . . . . . . 117Resource-monitor threshold commands. . . . 126Resource-monitor recording commands. . . . 146

Process monitor commands. . . . . . . . . 165lsps command . . . . . . . . . . . . 165mkpmtask command . . . . . . . . . . 169rmpmtask command . . . . . . . . . . 172

Event and event automation plan commands . . . 174Event, event log and event action historycommands . . . . . . . . . . . . . 177Event automation plan commands . . . . . 200Event action commands . . . . . . . . . 222Event filter commands . . . . . . . . . 239

Remote access commands . . . . . . . . . 249dconsole command . . . . . . . . . . 249

dsh command . . . . . . . . . . . . 252Tasks and scheduled jobs commands . . . . . 257

lstask command . . . . . . . . . . . 259runtask command . . . . . . . . . . . 267lsjob command . . . . . . . . . . . . 272lsjobhistory command . . . . . . . . . 279rmjob command . . . . . . . . . . . 283rmjobhistory command . . . . . . . . . 285runjob command . . . . . . . . . . . 288

Update commands . . . . . . . . . . . 291checkupd command . . . . . . . . . . 292cleanupd command . . . . . . . . . . 297lsupd command . . . . . . . . . . . 300lsver command . . . . . . . . . . . . 306importupd command. . . . . . . . . . 307installupd command . . . . . . . . . . 310uninstallupd command . . . . . . . . . 317

Security commands . . . . . . . . . . . 322authusergp command . . . . . . . . . 323cfgcred command . . . . . . . . . . . 325chaudit command . . . . . . . . . . . 328chcred command . . . . . . . . . . . 329chusergp command . . . . . . . . . . 331lsaudit command . . . . . . . . . . . 335lsauditlogs command. . . . . . . . . . 336lscred command . . . . . . . . . . . 338lsuser command . . . . . . . . . . . 340lsusergp command . . . . . . . . . . 345rmauditlogs command . . . . . . . . . 349rmcred command . . . . . . . . . . . 351rmusergp command . . . . . . . . . . 353Users . . . . . . . . . . . . . . . 356chuser command . . . . . . . . . . . 356lsuser command . . . . . . . . . . . 360Roles . . . . . . . . . . . . . . . 365chrole command . . . . . . . . . . . 365lsperm command . . . . . . . . . . . 369lsrole command . . . . . . . . . . . 372mkrole command . . . . . . . . . . . 377rmrole command . . . . . . . . . . . 379

SNMP device commands . . . . . . . . . 382SNMP get command . . . . . . . . . . 384SNMP getbulk command . . . . . . . . 386SNMP getnext command . . . . . . . . 387SNMP inform command. . . . . . . . . 389SNMP set command . . . . . . . . . . 391SNMP trap command . . . . . . . . . 393SNMP walk command . . . . . . . . . 395

Storage commands . . . . . . . . . . . 397Storage-configuration settings . . . . . . . 398Network storage hosts commands . . . . . 401Network storage path commands. . . . . . 409Network storage systems commands . . . . 429Network storage volumes commands . . . . 435

Virtualization commands . . . . . . . . . 452chvrtauth command . . . . . . . . . . 455

Copyright IBM Corp. 1999, 2009 iii

chvrthost command . . . . . . . . . . 459chfarm command . . . . . . . . . . . 464chvs command . . . . . . . . . . . . 467lsvrtsys command . . . . . . . . . . . 471lsvrtcap command. . . . . . . . . . . 477mkfarm command. . . . . . . . . . . 482mkrelocatetask command . . . . . . . . 484mkvs command . . . . . . . . . . . 487

Chapter 2. Management server andagent commands. . . . . . . . . . 491cfgdbcmd command . . . . . . . . . . . 491changePassword command . . . . . . . . . 495cimsubscribe command . . . . . . . . . . 495configAgtMgr command . . . . . . . . . 500dirinstall.server command . . . . . . . . . 502getfru command . . . . . . . . . . . . 503smexport command . . . . . . . . . . . 503

smimport command . . . . . . . . . . . 505smreset command . . . . . . . . . . . . 507smrestore command . . . . . . . . . . . 509smsave command . . . . . . . . . . . . 511smstart command . . . . . . . . . . . . 513smstatus command . . . . . . . . . . . 514smstop command . . . . . . . . . . . . 515Supported IBM Director v5.20 commands . . . . 515

Appendix. Discontinued commands 517Discontinued dircli commands . . . . . . . 517Discontinued dircmd commands . . . . . . . 519Discontinued management-server and agentcommands . . . . . . . . . . . . . . 522

Notices . . . . . . . . . . . . . . 523Trademarks . . . . . . . . . . . . . . 524

iv IBM Systems Director Commands Reference

About this publicationThis book provides reference information for commands available in IBM SystemsDirector 6.10. 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 terminologyThese 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, 2009 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.

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 IBM Systems Director Information Center asPDF documents. To view a PDF file, you need Adobe Acrobat Reader, which canbe downloaded for free from the Adobe Web site at www.adobe.com/products/acrobat/readstep.html.

Information centers and topic collectionsv IBM Systems

publib.boulder.ibm.com/infocenter/systems/index.jspView the IBM Systems information center which provides integratedinformation for multiple IBM Systems products, including operating systems,hardware, storage, and software. This information center also contains scenariosto help you use multiple IBM Systems products in the same environment.

v IBM Systems Directorpublib.boulder.ibm.com/infocenter/systems/topic/director_6.1/fqm0_main.htmlUpdated periodically, the IBM Systems Director topic collection contains themost up-to-date documentation available for IBM Systems Director.

v IBM Systems Director plug-inspublib.boulder.ibm.com/infocenter/systems/index.jspView the IBM Systems information center for information about to install anduse 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-management products to interpret and display data that is provided byCommon Agent and Platform Agent.

v IBM Systems Director API Licensinghttp://www.ibm.com/vrm/4api1

vi IBM Systems Director Commands Reference

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

PublicationsRelease Notes 6.1, Release Notes 6.1.1, and Release Notes 6.1.2

Provides information about hardware requirements for running IBMSystems Director components, supported IBM Systems Director hardware,operating systems, databases, and workgroup and enterprisesystems-management software.

Hardware and Software Support GuideProvides information about hardware requirements for running IBMSystems Director components, supported IBM Systems Director hardware,operating systems, databases, and workgroup and enterprisesystems-management software.

Planning, Installation, and Configuration Guide for AIX

Provides detailed instructions to install and configure each component ofIBM Systems Director on system running AIX using the standardinstallation option.

Planning, Installation, and Configuration Guide for IBM iProvides detailed instructions to install and configure each component ofIBM Systems Director on system running IBM i using the Standardinstallation option.

Planning, Installation, and Configuration Guide for Linux on Power Systems

Provides detailed instructions to install and configure each component ofIBM Systems Director on system running Linux for Power Systems usingthe Standard installation option.

Planning, Installation, and Configuration Guide for Linux on x86Provides detailed instructions to install and configure each component ofIBM Systems Director on system running Linux for System x using theStandard installation option.

Planning, Installation, and Configuration Guide for Linux on System z

Provides detailed instructions to install and configure each component ofIBM Systems Director on system running Linux for System z using theStandard installation option.

Planning, Installation, and Configuration Guide for WindowsProvides detailed instructions to install and configure each component ofIBM Systems Director on system running Windows using the Standardinstallation option.

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

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

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

About this publication vii

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.

Hardware Command Line User's GuideProvides information about installing and using the Hardware CommandLine (formerly known as the IBM Management Processor Command-LineInterface). Command output in this release might vary from commandoutput in previous releases.

White papers and briefsv IBM Systems Director

ftp://ftp.software.ibm.com/common/ssi/sa/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 Directorftp://ftp.software.ibm.com/common/ssi/sa/wh/n/xbw03007usen/XBW03007USEN.PDFThis paper describes the challenges of operational management for enterpriseserver installations and the value provided IBM Systems Director.

v Managing IBM Power Servers with IBM Systems Director 6.1www.ibm.com/common/ssi/fcgi-bin/ssialias?infotype=SA&subtype=WH&appname=STGE_PO_PO_USEN&htmlfid=POW03011USEN&attachment=POW03011USEN.PDFProvides information about managing the virtualization and consolidation onPower systems using IBM Systems Director.

v IBM Systems Director 6.1 Migration Tipswww.ibm.com/common/ssi/fcgi-bin/ssialias?infotype=SA&subtype=WH&appname=STGE_XB_XB_USEN_&htmlfid=XBW03009USEN&attachment=XBW03009USEN.PDFProvides information about migrating data when upgrading your environmentfrom IBM Director V5.20 to IBM Systems Director V6.1.

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.

viii IBM Systems Director Commands Reference

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

Web sitesv IBM Systems Director

www.ibm.com/systems/management/director/View the IBM Systems Director Web site 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 Web site 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 Web site onibm.com which provides links to product documentation, redbooks, redpapers,white papers, and learning modules related to IBM Systems Director, IBMSystems Director plug-ins, and IBM Systems Director upward integrationmodules.

v IBM Systems Director Upward Integrationwww.ibm.com/systems/management/director/upward/View the IBM Systems Director Upward Integration Web site on ibm.com whichprovides more information about IBM Systems Director upward integrationmodules created by IBM and other companies. IBM Systems Director UIMsenable third-party workgroup and enterprise systems-management products tointerpret and display data that is provided by IBM Systems DirectorPlatform-Agent managed system.

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

v IBM ServerProven

www.ibm.com/servers/eserver/serverproven/compat/us/View the IBM ServerProven Web site to learn about hardware compatibility ofIBM System x and BladeCenter systems with IBM applications andmiddleware, including IBM Systems Director.

Forumsv IBM Systems Director

www.ibm.com/developerworks/forums/forum.jspa?forumID=759View the IBM Systems Director forum Web site on ibm.com to discussproduct-related issues pertaining to IBM Systems Director, IBM Systems DirectorUIMs, and IBM Systems Director extensions. This Web site includes a link forobtaining the forum using a Rich Site Summary (RSS) feed.

v IBM Systems Director SDKwww.ibm.com/developerworks/forums/dw_esforums.jspa

About this publication ix

View the IBM Systems Director SDK forum Web site to discuss issues pertainingto the IBM Systems Director Software Development Kit (SDK). This Web siteincludes a link for obtaining the forum using a Rich Site Summary (RSS) feed.

v IBM Systemswww.ibm.com/developerworks/forums/dw_esforums.jspView the IBM Systems forums Web site on ibm.com to learn about variousforums that are available to discuss technology-related and product-relatedissues pertaining to IBM Systems hardware and software products. This Website includes a link for obtaining the forum using a Rich Site Summary (RSS)feed.

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/systems/topic/director_6.1/fqm0_main.html.There you will find the feedback page where you can enter and submit comments.

x IBM Systems Director Commands Reference

Chapter 1. smcli - Systems management command-lineinterface

From the systems management command-line interface (called smcli), you canspecify 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.

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.

Starting with IBM Systems Director 6.1.1, you can execute up to 17 concurrentsmcli or dircli threads simultaneously. The 17 concurrent threads are executed inthe sequence in which you issue them as 17 independent commands. Obtaining athread for final execution is dependent on the availability and priority of thethread.

Notes:

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 one

Copyright IBM Corp. 1999, 2009 1

or more of those options, you must also specify smcli. If the management serverruns on Windows, specifying smcli is required.

IBM Systems Director authenticates and authorizes command requests using aLightweight Directory Access Protocol (LDAP) server. You must specify usercredentials (user name and password) for authentication and authorization everytime that you run a command. You can specify the user credentials in one of theseways: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 SystemsDirector uses the persistent copy of the user name and encrypted password; it thenauthorizes and authenticates using the operating-system authenticationmechanisms.

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.

v 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 Systems Director version 5.20and earlier. 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.

Operands

None

Flags-c Creates a persistent copy of the specified user name and password. The

password in the persistent copy is encrypted.

2 IBM Systems Director Commands Reference

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 uses the persistent copy of the user name and encryptedpassword; it then authorizes and authenticates using the operating-systemauthentication mechanisms.

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

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 -d commandwhen 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 forprompting, including the CLIPROMPT environment variable.

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

-pw passwordSpecifies the password for the user name.

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

Chapter 1. smcli 3

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 with administrative privileges to be authenticatedby the IBM Systems Director Server.

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 table contains the codes returned by this command.v 0: The operation completed successfully.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.smcli -prompt lsuseruser: Admin1password:

mysystem\Admin1mysystem\Admin2

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

5. Create a credentials file


This example illustrates how to create a persistent copy of the user name andencrypted password that can be used to authenticate the user when runningfuture commands. The PROMPT environment variable is set to yes, so the useris prompted 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 provides various language-specification methods that can beused with smcli commands.

Although you can use the -L | --lang option in the command syntax to specify thelanguage for commands that run in smcli, you can also define the default languageby setting the DIR_LANG environment variable or by retrieving languageinformation from the operating-system language settings. Thelanguage-specification methods are applied in the following order:v -L | --lang language option in the smcli command syntax

Specifying the language explicitly for a smcli command using the -L | --langlanguage option overrides all other mechanisms for specifying the language,including the DIR_LANG environment variable and operating-system settings.

v DIR_LANG environment variableIf the smcli command does not specify the language explicitly using the -L |--lang language option, the value of the environment variable DIR_LANG (if set)is used to specify the language.

v Operating-system language settingsFor Windows, the language is specified using the Regional and LanguageOptions setting.For AIX and Linux, the values of these variables are used in the following order: LC_ALL LANG LC_LANG

Tip: For messages returned by the smcli command itself, the language is takenfrom the System language setting for Windows and or the LANG variable for AIXand Linux.

These languages can be specified for the -L | --lang option and DIR_LANGenvironment variable:v de: Germanv en: Englishv es: Spanishv fr: Frenchv it: Italianv ja: Japanesev ko: Koreanv pt_BR: Brazilian Portuguesev zh_CN: Simplified Chinesev zh_TW: Traditional Chinese

Chapter 1. smcli 5

Tips:

v If you specify the language using the format language_country, where language isa supported language but country is a not a supported country code for thatlanguage (for example, en_US), then the specified language is used (for example,in this case en would be used). An error will not be displayed.

v If you specify a language that is not supported, irrespective of country code, thedefault language is used and an error message will be displayed.

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 Director v5.20dircli commands from smcli.

Using the latest smcli commands is recommended; however, dircli commands aresupported in this release for compatibility with IBM Systems Director version 5.20and earlier. 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.

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 the IBMDirector v5.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.

Alphabetical listing of all smcli commandsThe IBM Systems Director smcli commands are grouped in the documentation byfunction; use this alphabetical listing for quick access to a specific command.

Aaccesssys

Use the accesssys command to request secured access to systems.


authusergpUse the authusergp command to authorize an existing user group to accessthe IBM Systems Director Server.

Ccfgcred

Use the cfgcred command to configure credentials for systems managed byIBM Systems Director.

chauditUse the chaudit command to modify audit settings.

chcred Use the chcred command to change credentials for systems managed byIBM Systems Director.

checkupdUse the checkupd command to check for new, changed, and supersedingupdates.

chevtautoplnUse the chevtautopln command to change an existing event-automationplan.

chfarmUse the chfarm command to add a host to or remove a host from a virtualfarm or change a virtual farm's attributes.

chgp Use the chgp command to modify groups, including changingmembership, modifying attributes, and processing change-specificationfiles.

chled Use the chled command to modify the light-path-diagnostic LED attributeson one or more systems. You can change the status and polling interval.

chnshostUse the chnshost command to change the Storage Area Network (SAN)configuration of one or more system hosts, or detach one or more systemhosts from the SAN and optionally remove the volumes.

chnspathUse the chnspath command to set the zoning configuration such that onlyone path exists between the specified system hosts and the specifiedstorage volumes. You can also use this command to unisolate the systemhosts.

chnssysUse the chnssys command to change the host-type identifier andauto-logical drive transfer (ADT) status on a network-storage system.

chnsvolUse the chnsvol command to change the name of a logical volume on anetwork-storage system.

chresmonthreshUse the chresmonthresh command to change the settings of one or moreresource monitor thresholds. You can also use this command to activate ordeactivate thresholds using this command.

chrole Use the chrole command to change the properties of a role.

chsys Use the chsys command to change the attributes of a system.

Chapter 1. smcli 7

chuser Use the chuser command to change the attributes and access settings for aspecific user.

chusergpUse the chusergp command to change attributes and access privileges for auser group.

chvrtauthUse the chvrtauth command to authorize one or more platform managersor host systems by setting or revoking authorization credentials.

chvrthostUse the chvrthost command to change the attributes of one or morevirtual-server host.

chvs Use the chvs command to change the attributes of one or more virtualservers.

cleanupdUse the cleanupd command to clean (that is, delete) update files andinformation in the update library.

collectinvUse the collectinv command to collect data about hardware and softwareresources that are currently installed on specified systems and to updatethe database.

Ddconsole

Use the dconsole command to run a remote serial console from the IBMSystems Director Server CLI with the purpose of opening the serial consoleto IBM Power managed systems. This command runs on IBM SystemsDirector Server for AIX V6.1F or later.

discoverUse the discover command to discover resources on networks that areconnected to the management server.

dsh Use the dsh command to run Distributed Shell from the IBM SystemsDirector Server CLI with the purpose of running commands on remotesystems. This command applies to IBM Systems Director Server for AIXonly.

EendSession

Use the endSession command to end the IBM Systems Director Webinterface session for the selected user.

evtacthistUse the evtacthist command to manage the event-action history, includingactivating or deactivating the history collection and clearing the log.

evtautoplnUse the evtautopln command to apply one or more systems and groups toor remove one or more systems and groups from one or moreevent-automation plans. You can also activate or deactivate anevent-automation plan.

evtlog Use the evtlog command to manage the size of the event log.


Ggenevent

Use the genevent command to send a custom event to the event router onthe management server for testing purposes.

get Use the get command to perform an SNMP GET request to displayinformation about an SNMP device.

getbulkUse the getbulk command to perform multiple get requests.

getnextUse the getnext command to perform an SNMP GETNEXT request on theSNMP device.

Iimportupd

Use the importupd command to import update information and installablefiles into the update library on the management server.

informUse the inform command to perform an SNMP Inform request on theSNMP device.

installupdUse the installupd command to install one or more updates on one ormore systems.

Llsaudit

Use the lsaudit command to list audit settings and categories.

lsauditlogsUse the lsauditlogs command to list a specific number of audit logmessages for one or more audit categories.

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

lscfgplanUse the lscfgplan command to list configuration plans for systems.

lscfgtmplUse the lscfgtmpl command to list configuration templates for systems inXML format.

lscred Use the lscred command to list credentials for systems managed by IBMSystems Director.

lsevtactUse the lsevtact command to display information about available eventactions or event-action types.

lsevtacthistUse the lsevtacthist command to display entries in the event-action historylog that are associated with a specific event action or system.

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

Chapter 1. smcli 9

lsevtfltrUse the lsevtfltr command to display information about the event filters. Ifyou do not specify any display options, this command lists the names ofall event filters.

lsevtlogUse the lsevtlog command to list the contents of the event log (the eventsthat have occurred).

lsevttypeUse the lsevttype command to list all event types.

lsgp Use the lsgp command to list the groups that are currently defined in IBMSystems Director.

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

lsjob Use the lsjob command to list information about scheduled tasks (calledjobs).

lsjobhistoryUse the lsjobhistory command to list information about job instances andhistory data.

lsled Use the lsled command to list light path diagnostic LED status on one ormore systems.

lsnshostUse the lsnshost command to list in XML format the Storage AreaNetwork (SAN) configuration for system hosts. You can also export theconfiguration to a file.

lsnspathUse the lsnspath command to list in XML format information about thenetwork-storage path. You can also export the information to a file.

lsnssysUse the lsnssys command to list the network-storage systems discoveredby IBM Systems Director.

lsnsvolUse the lsnsvol command to list storage volume properties for thespecified network-storage system.

lspermUse the lsperm command to list the permissions.

lsps Use the lsps command to list the processes that are available on thespecified system.

lsresmonUse the lsresmon command to list resource monitors that are available formonitoring systems.

lsresmonrecUse the lsresmonrec command to list information about previouslyconfigured resource-monitor recordings.

lsresmonthreshUse the lsresmonthresh command to list the resource-monitor thresholds.

lsrole Use the lsrole command to list the roles in IBM Systems Director.


lsstatusUse the lsstatus command to list the status information for a specifiedcategory of systems.

lssys Use the lssys command to retrieve system attribute information.

lstask Use the lstask command to list information about one or more tasks.

lsupd Use the lsupd command to list updates and their attributes.

lsuser Use the lsuser command to list IBM Systems Director users.

lsusergpUse the lsusergp command to list the IBM Systems Director user groups.

lsver Use the lsver command to list the current version and, if you haveupdated the product, the previous version of IBM Systems Director that isor was installed on the system.

lsvrtcapUse the lsvrtcap command to list virtualization capabilities of a virtualserver or host system.

lsvrtsysUse the lsvrtsys command to list the name and ID for virtual systems.

Mmkcfgplan

Use the mkcfgplan command to create a configuration plan for a system.This command acquires the configuration information only from an XMLinput file.

mkcfgtmplUse the mkcfgtmpl command to create a configuration template for asystem. This command acquires the configuration-template informationonly from an XML input file.

mkevtactemailUse the mkevtactemail command to create a customized event action thatsends an e-mail over the Internet (SMTP) or to a mobile phone.

mkevtactstpgmUse the mkevtactstpgm command to create a customized event action thatstarts a program.

mkevtactsttaskUse the mkevtactsttask command to create a customized event action thatstarts a noninteractive task.

mkevtautoplnUse the mkevtautopln command to create a new event-automation plan orimport one or more existing event-automation plans.

mkfarmUse the mkfarm command to create a virtual farm.

mkgp Use the mkgp command to create static and dynamic groups.

mknspathUse the mknspath command to create a connection (a network-storagepath) from a system host to a logical volume.

mknsvolUse the mknsvol command to create a storage volume by allocating a

Chapter 1. smcli 11

logical volume and setting the Redundant Array of Independent Disks(RAID) level for later attachment to a system host.

mkpmtaskUse the mkpmtask command to create a new process-monitor task.

mkrelocatetaskUse the mkrelocatetask command to create a task to relocate (or migrate)virtual servers.

mkresmonrecUse the mkresmonrec command to record resource-monitor values.

mkresmonthreshUse the mkresmonthresh command to create a new resource-monitorthreshold for a system or group.

mkroleUse the mkrole command to create roles that contain a list of permissionsfor authorization to access IBM Systems Director.

mkvs Use the mkvs command to create a virtual server.

Ppingsys

Use the pingsys command to perform a presence check (ping) on thetargeted systems. When the presence check is completed, the results arereflected in the OperatingState and CommunicationState attributes. Thiscommand performs an IBM Systems Director presence check and not anInternet Control Message Protocol (ICMP) ping.

Rrmauditlogs

Use the rmauditlogs command to remove the audit log for one or moreaudit categories.

rmcfgplanUse the rmcfgplan command to delete configuration plans.

rmcfgtmplUse the rmcfgtmpl command to delete configuration templates.

rmcredUse the rmcred command to remove credentials for systems managed byIBM Systems Director.

rmevtactUse the rmevtact command to remove customized event actions.

rmevtautoplnUse the rmevtautopln command to delete one or more event-automationplans.

rmevtfltrUse the rmevtfltr command to remove event filters.

rmevtlogUse the rmevtlog command to remove entries from the event log.

rmgp Use the rmgp command to delete one or more system groups.

rmjob Use the rmjob command to delete one or more jobs.


rmjobhistoryUse the rmjobhistory command to delete job instances or history.

rmnspathUse the rmnspath command to remove a connection (that is, anetwork-storage path) from a system host to one or more volumes, andoptionally remove the volumes if there are no other connections.

rmnsvolThe rmnsvol command removes one or more volumes on anetwork-storage system if the volume is not connected to anetwork-storage system.

rmpmtaskUse the rmpmtask command to delete a process-monitor task.

rmresmonrecUse the rmresmonrec command to delete one or more resource-monitorrecordings.

rmresmonthreshUse the rmresmonthresh command to remove one or moreresource-monitor thresholds.

rmroleUse the rmrole command to delete roles.

rmsys Use the rmsys command to remove systems and all associated data.

rmusergpUse the rmusergp command to remove a user group's authorization toaccess IBM Systems Director Server.

rpowerUse the rpower command to perform power-management operations onremote systems.

runjobUse the runjob command to run one or more jobs immediately or schedulejobs to run at a specific date and time. You can also schedule a job torepeat automatically at a specified interval.

runresmonUse the runresmon command to start monitoring one or more resources onsystems and display the monitored values.

runtaskUse the runtask command to run a non-interactive IBM Systems Directortask on a specific system.

Sset Use the set command to perform an SNMP Set request on the SNMP

device.

stopresmonrecUse the stopresmonrec command to stop recording resource-monitorvalues.

Ttestevtact

Use the testevtact command to test customized event actions.

Chapter 1. smcli 13

trap Use the trap command to send an SNMP trap to the SNMP device.

Uuninstallupd

Use the uninstallupd command to uninstall (roll back) an update onspecified systems.

Wwalk Use the walk command to traverse a branch of the Management

Information Base (MIB) tree of the SNMP device.

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

Syntax

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

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

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

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 available in this release are listed first, followedby a blank line. The bundles commands listed after the blank line are supportedcommands that were introduced in IBM Systems Director 5.20. or earlier.

Operands

None.

Flags-h | -?

Displays the syntax and a brief description of the command.

Tip: If you specify additional options other than -L | --lang, the options areignored.

--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 -L | --lang, 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.

-L | --lang languageSpecifies the language to use for the command.

The following languages are supported:v de: Germanv en: Englishv es: Spanishv fr: Frenchv it: Italianv ja: Japanesev ko: Koreanv pt_BR: Brazilian Portuguesev zh_CN: Simplified Chinesev zh_TW: Traditional Chinese

Tips:

v This option overrides other mechanisms for specifying the locale, includingthe environment variable DIR_LANG and operating-system settings.

v If you specify the language using the format language_country, wherelanguage is a supported language but country is a not a supported countrycode for that language (for example, en_US), then the specified language isused (for example, in this case en would be used). An error will not bedisplayed.

v If you specify a language that is not supported, irrespective of country code,the default language is used and an error message will be displayed.

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

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

Exit status

The following table contains the codes returned by this command.v 0: The operation completed successfully.v 1: A usage error occurred.v 29: The specified locale is not valid or not supported.

Example

List the smcli commands

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

System commandsThe smcli system commands perform administrative operations on the IBMSystems Director system, including discovering, adding, removing, and listinginformation.

Chapter 1. smcli 15

smcli commands

These smcli system commands are available:

accesssysUse the accesssys command to request secured access to systems.

chsys Use the chsys command to change the attributes of a system.

lssys Use the lssys command to retrieve system attribute information.

pingsysUse the pingsys command to perform a presence check (ping) on thetargeted systems. When the presence check is completed, the results arereflected in the OperatingState and CommunicationState attributes. Thiscommand performs an IBM Systems Director presence check and not anInternet Control Message Protocol (ICMP) ping.

rmsys Use the rmsys command to remove systems and all associated data.

rpowerUse the rpower command to perform power-management operations onremote systems.

dircli commands

Using the new smcli system commands is recommended; however, the dirclimanaged-object commands listed in the following table are supported in thisrelease for compatibility with IBM Director version 5.20.

For information about the dircli commands, see the commands reference in theIBM Director v5.20 information 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

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

Table 1. Supported dircli commandsdircli command Description and supported syntax Equivalent smcli command

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


Table 1. Supported dircli commands (continued)dircli command Description and supported syntax Equivalent smcli command

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

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

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] [-L language]

smcli accesssys [-L language] [-v] [-t type] [-m | [-u user_name] [-ppassword]] {-a | -f file_name | -w query | -i ip_address_list | -Ngroup_list | [-n] system_list}

Description

You can run this command on multiple systems at one time. The same user ID andpassword is used to access all specified systems.

Chapter 1. smcli 17

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

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

Flags-a | --all

Targets all systems.

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

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

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



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 IPv4Address to list all IP addresses.v Use IPv4 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 use the lsgp -N Hosts -A GroupMembers command to list allhost names.

v The host names are not locale specific.v A given IP address or hostname 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.



Tips:




-m | --multiprotocolEmploys user-identity associations to grant access to users across multiplesecurity domains.

Tips:

v Use the IBM Systems Director Web interface to manage users across multiplesecurity domains.

v This option cannot be used with the -u | --user or -p | --password options.v If you specify this option, the accesssys command does not prompt for user

ID and password.

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

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

Chapter 1. smcli 19

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

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.

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

The 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 | --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:

v The value for password will be used for all systems targeted by thecommand.

v This option cannot be used with the -m | --multiprotocol option.-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.

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

v The value for user_name is used for all systems targeted by the command.v This option cannot be used with the -m | --multiprotocol option.



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

Chapter 1. smcli 21

Exit status

The following table contains the codes returned by this command.v 0: The operation completed successfully.v 1: A usage error occurred.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 32: A specified system ID is not valid.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.

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

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] [-L language]

smcli chsys [-L language] [-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

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

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.You can specify any of the following attribute keys:

Key Data type Description

DisplayName string System name

Ping integer Ping interval, in milliseconds.

Description string Description of the system

-a | --allTargets all systems.







Chapter 1. smcli 23

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:






Tips:







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.




Tips:





Tips:






Tips:

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

Chapter 1. smcli 25

v The group names are not locale specific.-t | --type system_type



Tips:









Tips:




Exit status

The following table lists the codes returned by this command.v 0: The operation completed successfully.v 1: A usage error occurred.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] [-L language]

smcli lssys [-L language] [-v] [-I]

smcli lssys [-L language] [-v] [-t system_type] [-d symbol] [-o | -p] [-T][-A attribute_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 Systems Director v5.20 to list allavailable types of systems has been replaced with to -I | --listtype in this release.The -i | --listtype option is now used to target systems by IP address or hostname.

Tip: Use the lsvrtsys command to list information about virtual systems, includingplatform managers, virtual servers, and hosts.

Operands

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

Chapter 1. smcli 27

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

-d | --delimiter symbol

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

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.

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


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:




-I | --listtypeLists all system types. All additional options are ignored.

Chapter 1. smcli 29

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

Tips:

v The attributes and attribute values are in English only. They are not localespecific.

v Using this option does not display hidden properties, such as ImageSet. Todisplay hidden attributes, use the lssys -A key command (for example, lssys-A ImageSet).



Tips:






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.





Tips:





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.

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

-p | --pipe

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

Tips:

Chapter 1. smcli 31

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

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

-t | --type system_type



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.






Tips:





Exit status

The following table lists the codes returned by this command.v 0: The operation completed successfully.v 1: A usage error occurred.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 do not have a license forIBM Systems Director.smcli lssys -w "HasLicense=False"

This 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 Windows NT or Windows2000 installed.smcli ls

Frp0 Bk Commands

Documents

Transcript of Frp0 Bk Commands