HP Systems Insight Manager 6.
© Copyright 2010 Hewlett-Packard Development Company, L.P. Legal Notices Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice.
Table of Contents 1 About the HP SIM command line interface.....................................................9 Introduction............................................................................................................................................9 Commands............................................................................................................................................9 manpages (manual pages).......................................................................
Description......................................................................................................................................27 Options..........................................................................................................................................27 mxexec................................................................................................................................................28 Synopsis.......................................................
Remote SQL Server database settings.................................................................................................42 Configure and repair agents.............................................................................................................42 Author............................................................................................................................................43 Debug settings...........................................................................
Return values...................................................................................................................................72 See also.........................................................................................................................................72 Example.........................................................................................................................................72 mxpassword............................................................
Examples........................................................................................................................................92 Limitations.......................................................................................................................................94 See also.........................................................................................................................................94 mxtool..............................................................
Managing users............................................................................................................................126 Managing system groups................................................................................................................127 Managing toolboxes......................................................................................................................128 Adding tools to toolboxes...................................................................
1 About the HP SIM command line interface Introduction HP SIM provides a command line interface (CLI) in addition to the graphical user interface (GUI). Many functions available in the GUI are also available in the CLI. Commands HP SIM commands are installed in the following locations on the central management server (CMS): • HP-UX and Linux: /opt/mx/bin/ • Windows: C:\Program Files\HP\Systems Insight Manager\bin\ NOTE: The Windows path varies if HP SIM is not installed in the default location.
operating systems, and 8 for Linux operating systems. The CLI XML usage manpage section number is 4 for all operating systems. Command Functionality Available manpages mcompile Compiles a Simple Network Management Protocol (SNMP) Management mcompile(1M, 8) Information Base (MIB) file into an intermediate format configuration (CFG) file for importing into HP SIM using mxmib.
Command Functionality Available manpages to mxcollection for creating and manipulating collections (previously known as categories). mxreport Enables users with sufficient privileges to run reports and add, delete, and list reports and report categories. mxreport(1M, 8), mxreport(4) mxstart Starts the HP SIM daemons. mxstart(1M, 8) mxstatus Displays or returns (through the exit code) the current ready or not-ready mxstatus(1M, 8) state of HP SIM.
• mxstatus • mximport • mxexport Permissions On an HP-UX or Linux CMS, you can log in to the operating system as any valid HP SIM user and use the CLI (complete CLI functionality is available only to users with full configuration rights or limited configuration rights on the CMS).
To log out from the CLI, log off of the CMS or the Secure Shell (SSH) client application.
2 Command descriptions This chapter describes the commands in the HP SIM CLI. The commands in this chapter use the following conventions: • Optional items are enclosed in square brackets [ ]. • Required parameters are in italics. • The | character indicates a choice between options. • Curly brackets { } indicate an option that requires one or more values. mcompile Compiles SNMP mib files into intermediate format (.cfg) files.
Processing import file: RFC1155-SMI.mib Processing import file: RFC1155-SMI.mib Processing import file: rfc1213.mib Processing import file: RFC-1212.mib Processing import file: RFC-1215.mib Processing import file: rfc1213.mib Mib Compilation completed successfully. See also mxmib(1) mxagentconfig Configures the agent to work with a CMS.
-o host|user Specify whether to configure the managed node with SSH host-based authentication or user key-based authentication. If this option is not specified, the default is host-based authentication. -u login Enter the user name to enable SSH execution. -p password Enter the password of the specified user on the managed node. If the password contains special characters that the shell might interpret, for example, $ or &, enclose the string in quotation marks.
Linux mxexec(8) mxauth Adds, removes, or lists authorizations in HP SIM. Synopsis mxauth -a|r -u username | -U usergroupname -R toolboxname -n nodename mxauth -a|r -u username | -U usergroupname -R toolboxname -g groupname mxauth -a|r -f filename mxauth [-l t] mxauth -l f [-b encoding ] Description The mxauth command is used to manage authorizations. These associations between users, user group name, toolboxes, and nodes or node groups can be added or removed only by administrative rights users.
When you use -l t, mxauth lists all authorizations in a table with column headings identifying each field. For HP SIM 5.1 and later, the enabled/disabled state of the Auto Update feature is displayed for node group authorizations. Auto Update enables you to configure authorizations that can be automatically updated (systems added or removed from the associated node group list) in the background at a configurable interval, for example, every five minutes.
Remove authorizations. The wildcard character (*) is supported for nodename and groupname . -f filename Specify a file that contains the list of authorizations to add or remove. -l t List all authorizations in tabular format. -l f List authorization information in XML format. The resulting file can be edited and used to add or remove authorizations with -f. -b encoding Specify the character encoding for the XML file. This is used with -l f. -u username Specify the user for the authorization.
Value Meaning 249 Unable to connect to the session manager. Examples Example 1 To add the authorizations in the file my_auths.xml, enter mxauth -a -f my_auths.xml. The contents of my_auths.xml might look like: PAGE 21Example 8 To remove the node group authorization for user john to execute any tools assigned to the dbadmin toolbox on nodegroup dbGroup, enter mxauth -r -u john -R dbadmin -g dbGroup. Example 9 To remove the node group authorizations that allow user john to execute any tools assigned to the dbadmin toolbox on all configured node groups at the time the command is executed, enter mxauth -r -u john -R dbadmin -g "*".
Description The mxcert option enables you to manage the server certificate and the trusted certificates in the HP SIM keystore. Options -n Create a new server certificate. -n [CN=x] [ALT=x] [OU=x] [O=x] [L=x] [ST=x] [C=x] -n [CN=x][ ALT=x] [OU=x] [O=x] [L=x] [ST=x] [C=x] Create a new server certificate with the provided details, where CN=common_name, ALT=alternative name(s), OU=organizational_unit, O=organization_name, L=locality_name, ST=state, and C=country-code.
Return values Value Meaning 0 Successful completion. 2 Command line syntax error. >0 An error occurred during operation. Examples Example 1 To create a new server certificate with the specified X.509 distinguished name, enter mxcert -n CN=Bob O=BobCo L=Anytown C=US A=alt . Example 2 To import a trusted certificate called sample.cert into the keystore, enter mxcert -t -f sample.cert. Example 3 To list the certificates in the keystore (short format), enter mxcert -ln.
enables you to choose members individually by name. You can continue using mxquery to manage collections that are created by specifying member attributes. • mxcollection -a -f filename This command enables you to add collections and collection members. Possible collection members include systems, queries, and other collections. Collection information is provided in an XML file, and you can add multiple collections with a single file.
Systems or Events list in the System and Event Collections panel. If a value is not specified, the default is the system branch. Options -a Add one or more collections that are specified in a collection definition file. -a mem Add one or more members to the collections defined in the specified collection definition file. -m mem Modify one or more collection members defined in the specified collection definition file.
-syscoll systemcollname Specify an existing system collection to include in a combination collection. This option is used with -a combo. -evcoll eventcollname Specify an existing event collection to include in a combination collection. This must be a collection that was created by attributes in the GUI. This option is be used with -a combo. -branch sysbranch|evbranch Specify whether a parent collection is in the Systems or Events list in the System and Event Collections panel.
Example 4 To copy a collection called sample collection, rename it to sample collection copy, and assign the parent collection Private in the Events list, enter mxcollection -cp "sample collection" -name "sample collection copy" -to Private -branch evbranch. See also mxcollection(4), mxquery(1M) mxconfigrepo Verifies and fixes HP SIM database errors. mxconfigrepo is also used by the installer to create or remove the database.
mxexec Runs a HP SIM tool. Synopsis mxexec -t toolname [-u signinuser ] [-p elevationpassword ] [-A argvalue... ] [-h|-O filename|-o directory ] [-n target...|-q queryname... ] mxexec -c [-k] -j job_ID mxexec [-l n|t] [-i task_name... ] [|-j job_ID... ] [-d date ] mxexec -l d [-h] -j job_ID... Description The mxexec command executes an HP SIM tool with associated arguments on specific managed nodes and node groups. A tool and its arguments, specified to run on one or more nodes, is called a task.
Tool authorization is all or none, meaning that it will fail if the user is not authorized to run the tool on all nodes in the target list. Default target node influence on tool The value of the default targets tool attribute defTargets enables different tool execution behaviors if no targets are specified on the command line.
• Running tool. If there is a command line to execute (the command line is optional for a tool), the job enters the Running tool state. During this state, the target forks (starts) a process to run the command and establishes a clean process environment (see Target Execution Environment). It then executes (see execl(1) ) the POSIX shell with the command line as the argument (see sh-posix(1) ).
Specify the arguments required for the intended tool execution. The values are matched to the arguments by order: first specified to first argument, second specified to second argument, and so on. If an argument value contains embedded spaces or other characters interpreted by the shell, enclose it in quotation marks. Argument values are separated by spaces. When specifying argument values, enter any necessary spaces.
Display detailed information for the specified job, including stdout, stderr, and completion status per target. An error occurs if you do not specify a job ID. One job ID and one -l option can be specified. -l n List job IDs only. -l n is the default for listing; it behaves as if no options are specified. Normally, -l n is not specified with any job_ID values, and it lists all jobs. Otherwise, it repeats the job ID values specified on the command line, if they exist. Only one -l option can be specified.
Value Meaning 245 Unable to connect to the job manager. 249 Unable to connect to the session manager. 250 Remote exception. 254 Properties file error. Examples Example 1 To check the disk space on the database node group, dbgroup, which includes the nodes db1, db2, and db3, enter mxexec -t "bdf" -n g:dbgroup.
Example 3 To view more detail for job 123, on a node-by-node basis, enter mxexec -l d -j 123. The output might look like: Task Name Job ID Tool Name Job State User Name Start Time End Time Elapsed Time Node Status : : : : : : : : : : defRunNowTaskId_10 4 Install Software Complete root Wednesday, March 15, 2000 3:18:46 PM MST Wednesday, March 15, 2000 3:18:47 PM MST 12 minutes 17 seconds 261 milliseconds machine2.myco.
Description The mxexport command enables you to perform the data migration export functionality and creates a ZIP file, which migrates entire data from HP SIM 5.3.x or later to a new version of HP SIM 6.0 running on a different CMS. Options -f Specifies the name of the zip file. If a file name is not specified, the zip file will be created under HP SIMs installed location \data\configdata-export with name as Products.zip. -p Specifies the password. Minimum allowed length is 8 characters.
Example 5 To export a data by specifying a filename and a password, enter mxexport[-f c:\data\Products.zip -p d&128Pa ] Author mxexport was developed by the Hewlett-Packard Company. Debug Settings By default, the debug log is disabled for migration. To turn on the debug log, open the file migration.props under [HPSIM]\config\debugsettings, and modify the value of the property GlobalEnable to true and set the log level to 20 or above for finest logging.
Display the path to the PostgreSQL program directory (HP-UX only). -b Display the path to the PostgreSQL program directory (HP-UX only). Return values Value Meaning 0 Successful completion. >0 An error occurred during operation. Examples Example 1 Enter mxgetdbinfo to display the hostname, port number, database name, username, and database type. The output might look like: host=127.0.0.
Value Meaning >0 An error occurred during operation. Example To view information for the host rose.co.com, enter mxgethostname -n rose.co.com. mxglobalprotocolsettings Manages global protocol settings in HP SIM. Synopsis mxglobalprotocolsettings -s [-f file-name|- ] mxglobalprotocolsettings -s {setting=value}... mxglobalprotocolsettings [-ld] mxglobalprotocolsettings -lf [-b encoding ] Description mxglobalprotocolsettings is used to manage HP SIM's global protocol settings.
Enable WBEM = true Enable HTTP and HTTPS = true Enable SNMP = true Default SNMP timeout (in seconds) = 5 Default SNMP retries = 1 Enable DMI = true Example 2 To list the global protocol settings in XML format, enter mxglobalprotocolsettings -lf. The output might look like: PAGE 40Return values Value Meaning 0 Successful completion. 2 Command line syntax error. -1 An error occurred during operation. Files /etc/opt/mx/config/globalsettings.props Examples Example 1 To list all the settings from the globalsettings.props file, enter mxglobalsettings -ld. The output might look like: AllowAltIpForTrap = enabled CMSDeviceKey = 2 CMSLocale = en_US CertificateExpirationCriticalStart = 0 CertificateExpirationMajorStart = 10 CertificateExpirationMinorStart = 30 ...
Prerequisites 1. 2. 3. 4. 5. You must be a member of the local Windows Administrators group. The server has HP Insight Control Suite 6.0 or later installed, which includes HP SIM 6.0 or later. All HP Insight Control software that were installed on source server must be installed on target server as well. Stop the HP SIM service and all other HP Insight Control software before running import function. The CMS must be a clean installation and have no prior configurations.
mximport -f c:\data\Products.zip -p d&e128Pa Remote SQL Server database settings 1. 2. The target CMS and the remote SQL database server must be in the same domain. The folder configdata-import under [HPSIM]\data on the target server must be shared and granted with full permissions. Configure and repair agents CRA Query and Task XML files are created and placed under [HPSIM]\config\migration\CRA. The Configure or Repair Agent Query XML file is named as HPSIMCRAQuery.
Default value : certificate Other allowed values : empty Note: This enables HP SIM users to connect to the System Management Homepage, Onboard Administrator, iLO (version 2 and later), and Version Control using the HP SIM certificate for authentication. This deploys the HP SIM certificate to the managed system. 6.
If no options are entered, the configuration status is listed ( -l ). WhenHP SIMis running, you can use -l to list the configuration status, but you cannot run mxinitconfig -a or mxinitconfig -r. • mxinitconfig -a This command performs the initial configuration procedure. The following steps are performed during the initial configuration: • • The initialization file and property file are set up. • The database is configured. • The server daemons are started.
Example 2 To view the current configuration status, enter mxinitconfig -l. mxlog Logs or prints a log entry. Synopsis mxlog -l [-r result ] [-a action ] [-o object_type ] [-n object_name ] [-u user ] [-s sessionID ] [-t transactionID ] [-v verbosity ] [-m message ] mxlog –p [-r result ] [-a action ] [-o object_type ] [-n object_name ] [-u user ] [-s sessionID ] [-t transactionID ] [-v verbosity ] [-m message ] Description The mxlog command logs an entry to the log file or standard out.
-r result Specify the result of the event that occurred. You must specify a value if -r is used. If -r is not used, the default is SUCCESS. Valid values include IN_PROGRESS, SUCCESS, FAILURE, SOME_FAILURES, CANCELED, KILLED and RESULT_NONE (no result, which appears as a "<>" string). -s sessionID Enter the session ID in string form. You must specify a value if -s is used. If -s is not used, there is no value for this field. -t transactionID Enter the transaction ID in string form.
mxmib Adds, deletes, processes a list of mibs, list registered mibs, and lists traps for a specific registered mib. Synopsis mxmib mxmib –a CFG filename mxmib -d mib filename mxmib -l mxmib -f filespec mxmib -t mib Description The mxmib command enables you to register and unregister a mib, register a list of mibs from a file, list mibs registered in HP SIM, and list a registered mib's traps. Options -a CFG filename Register a new CFG, file ( filename.cfg ), or replace the data of a registered mib.
1. 2. Download the new mib and copy it into the mibs directory. Run mcompile to update the existing .cfg file. NOTE: 3. If the existing .cfg file had any customizations, these must be reapplied. Run mxmib -a updatedfile.cfg to update the MIB data in theHP SIMdatabase. mxngroup Adds, modifies, removes, or lists system groups in HP SIM. Synopsis mxngroup -a -g groupname [-d description ] [-n [ member... ] ] mxngroup -a -f filename mxngroup -m -g groupname [-d description ] [-n [ member...
• mxngroup [-l d|f|m|n] [-g groupname... ] mxngroup [-l d|f|m|n] [-n [ member... ] ] These commands allow you to list system group names and attributes. The -l option indicates that system group information is to be listed. • d specifies a detailed listing of system group names and attributes. • f results in a listing that matches the XML file format defined in mxngroup(4). • m specifies a combined list of system group members, one member per line. • n lists system group names, one per line.
Display a file-formatted list of system group information (see mxngroup(4) ). -l m Display the member systems of the system group. -l n Display the names of the system groups. -f filename Specify the path and name of the input file for an add, modify, or remove operation. -g groupname Specify the name of the group to be added, modified, removed, or listed. System group names must be 80 characters or less, and must start with an alphabetic character.
Value Meaning 102 Database error. 222 The CMS is not initialized. 249 Unable to connect to the session manager. 250 Remote exception. Examples Example 1 To create the system group group1 containing systems systema, systemb, and systemc, enter mxngroup -a -g group1 -d "Example system group" -n systema systemb systemc. Example 2 To modify the system group group1 by replacing system systemc with system systemd, enter mxngroup -m -g group1 -n systema systemb systemd.
This is group1. Limitations • This command can only be run on the CMS. • Only administrative rights users can use mxngroup to add, modify or remove system groups. Any user can list group information.
mxnode -a -m -f filename [-w] [-v] • When a system is added to the database with the -a option, mxnode stores the system name, the fully-qualified network hostname (if it exists), and an IP address as system attributes. • The system is identified, meaning it is examined via the SNMP and WBEM management protocols to determine the device type, the operating system type and revision, and other information needed to determine which tools are appropriate for use with the system.
Modifying systems mxnode -m [-p] -f filename [-w] [-v] • The -m -f option enables you to modify the attributes of an existing system in the database. • This option requires the system name rather than the hostname or IP address (mxnode can look up the system name if the hostname or IP address is provided in XML input). • The system attributes to be modified for a particular system must reside within a specified mxnode XML file.
• AgentUUID . The unique identifier value from the SNMP agent installed on the system. On ProLiant servers, this is the cpqHoGUID MIB value from the ProLiant Insight Agent. For certain switches, this value is the same as the switch serial number from the SNMP agent. • UniqueIdentifier . The unique identifier value of the system from the WBEM provider. For standalone servers, this value is the unique identifier property from the ComputerSystem provider as defined as the unique identifier of the machine.
NOTE: The attribute name in parentheses is the actual attribute name that would be used in the mxnode XML file. Software attributes • Preferred Node Name (PreferredNodeName) . An alternate system/node name of your choosing which can make it easier for you to identify, find, or organize systems/nodes in the database. • System Description (SystemDescription) . This attribute describes the device. Any displayable text can be used as a value for this attribute. • Asset Number (AssetNumber) .
GUI name mxnode attribute name Printer Printer Switch Switch Hub Hub Remote Access Device RAS Unknown Unknown Management Processor MgmtProc Tape Library TapeLibrary Shared Resource Domain SRD Resource Partition RESPAR Application Application • Device Subtype (DeviceSubType) . The subtype of the device within the major type. Only the following predefined valid device subtypes can be used as values for a device subtype.
GUI name mxnode attribute name HP Virtual Partition Server vParMonitor Storage Essentials Managed StorageEssentials HP 9000 Superdome HP9000Superdome HP Integrity HPIntegrity HP Alpha Station HPAlphaStation Virtual Machine Host VMHost HP Serviceguard HP Serviceguard High Availability Cluster HighAvailabilityCluster nPar nPar HP Deskpro HPDeskpro HP Integrity Superdome HPSuperdome MSCS MSCS HP Integrity Workstation HPIntegrityWorkStation High Availability Array HighAvailabilityAr
and Warranty data can be added or modified. MPO or Contract and Warranty data for a system can be added, modified or removed only through the use of an external XML file. This data cannot be specified directly on the command line for add, modify or remove operations. -f filename Specify a filename containing systems to be added, modified, or removed. The contents and format of the xml file are shown in the Examples section. See mxnode(4) for additional information about using XML input files with mxnode.
Return values Value Meaning 0 Successful completion. 2 Command line syntax error. 3 Undefined system error. 5 Duplicate system error. 6 Nonexistent user error. 7 System is locked error. 8 Nonexistent system group error. 21 Invalid name. 31 Unknown network host. 33 Missing mxnode plug-in identification collector. 38 Undefined node name. 50 Unauthorized user. 102 Database error. 221 Authentication failure. 222 The CMS is not initialized. 224 System installation error.
IP addresses: 192.1.2.3 OS name: HPUX OS revision: 11.00 OS revision text: 11.00 OS vendor: HP Protocols: SNMP:1.0 GUID: 00000000864162de0f07e31d86c00000 Hardware device ID: 00000000864162de0f07e31d86b00000 Device type: UnixWorkstation Device subtype: HP9000 Model: 9000/785 Added by: root Added on: Sep 24, 2002 4:15:46 PM Monitoring: Not suspended OS description: Preferred node name: LABabc System description: Hardware: x86 Family Contact: ph: 555-1234 Location: Bldg 6,Room123 UUID: n...
One method for modifying a system is to use the mxnode -lf > filename command to output the XML data to an external output file. The output file can then be edited to change or add attributes that need to be modified or locked. After editing the file, modify the system by entering mxnode -m -f filename and specifying the edited file as the input file. The sample XML includes the method for locking the lockable attributes.
L* your data here L* your data here L your data here L your data here 10 12345 L* your data here L your data here PAGE 64not support a network connection. The MPO must also be able to support defining a path to obtain SNMP data for a server via an iLO for cases in which a server is in a DMZ with the iLO on a management network. The two types of MPOs that might reside on a node are a Management Agent (MAO) and a Management Route (MRO). An MAO defines and supports a management agent such as a CIMOM or SNMP agent.
hpmxCimomMro nnnnnnnnnnn Switch root .... nn...nn nnnnnnnnnnn nn...
Notes • When modifying a node with the mxnode -m -f filename command, your XML file must include only the attributes you want to modify. You must always include the three attribute lock flags and set all three flags to true or false. In most cases, you will want to use the false setting so the lockable attributes will not be overwritten by the Discovery and Identification processes.
Description The mxnodesecurity command enables a CMS user to add, list, or remove default/global and node/system credentials in the CMS. All credentials are stored in the HP SIM database. The difference between default and node type credentials are: • Default (or Global) • Node (or System) • mxnodesecurity -a -p protocol -c username:password [-t on or off ] [-n nodename ] Credentials that apply to all managed systems. Credentials that apply to specific managed systems.
mxnodesecurity -r -p protoName -n @default1 [-x {forceDelete | fd}] • To first copy the credential, then forcefully remove the global credential, use the -x option with the following argument: mxnodesecurity -r -p protoName [-x {forceCopyDelete | fd}] mxnodesecurity -r -p protoName -n @default1 [-x {forceCopyDelete | fd}] If you omit the node name during a remove operation, all default/global credentials for the supplied protocol are removed from the HP SIM credentials database.
Specify a username and password for a WBEM credential. This option is used with -a -p protocol/wbem. NOTE: Be careful when entering passwords in the CLI. This makes them available in the command history, the process list during execution, and the audit log if the command is executed as part of a task. Be sure to clear your command history or use alternate methods for specifying passwords, for example, a prompt or input file.
Example 3 To add a default/global type credential to the Systems Insight Manager database of specified protocol., enter mxnodesecurity -a -p protocol -c username:password. When adding default or global credentials, you can specify any protocol name, except for WBEM. A username and password are required for any protocol. NOTE: A node name is not needed when you add default credentials, because default credentials apply to all nodes. Default credentials for the sign-in protocol are limited to 10.
Example 9 To remove all all default or global (and only default or global) type credentials in the HP SIM of the specified protocol type or name, enter mxnodesecurity -r -p wbem. Example 10 To remove all WBEM credentials of default port number for the node mycomputer.ak.hp.com, enter mxnodesecurity -r -p wbem -n mycomputer.ak.hp.com. Example 11 To remove credentials in the HP SIM database based on the contents of /home/user1/defs/newcredentials.
Specify the port number of the Oracle TCP/IP listener service on the Oracle database server. If -n is not specified, the default is 1521. -d database name Specify the instance name of the database to be used for HP SIM. This should be a new database created exclusively for HP SIM use. Set up this database to use the Unicode character set (AL32UTF8). -u username Enter the username authorized to log in to the Oracle database instance. This user must have the DBA privilege. -p password Enter the password.
mxpassword –c Description The mxpassword enables you to add, remove, modify, and list the passwords stored for use with HP SIM. The passwords are displayed in clear text for readability. CAUTION: To prevent clear text passwords from being exposed to unintended eyes, close the command window after executing this command. Options -a Add a new password. -m Modify an existing password. -r Remove an existing password. -l List the passwords stored by HP SIM. -g Start the mxpassword GUI.
Example 2 To change the current SSH password to scoobydoo2, enter mxpassword -m -x MxSshKeyPassword=scoobydoo2. Example 3 To change the current database password to rocketboy2, enter mxpassword -m -x MxDBUserPassword=rocketboy2. Example 4 To remove the current SSH password, enter mxpassword -r -x MxSshKeyPassword. Example 5 To remove the current database password, enter mxpassword -r -x MxDBUserPassword. Example 6 To add, modify or remove passwords using a graphical user interface, enter mxpassword -g.
During an add operation, HP SIM adds only the queries whose names do not reference existing queries in the database. If a duplicate query is detected, it is skipped, and all non-duplicate queries are added. Skipping duplicate queries does not affect the return value. Optionally, you can specify the force flag, which instructs the system to add a query's criteria even if there is not a database entry corresponding to the criteria value.
• mxquery -l mode criterianame This command lists the operation modes or operators that are valid for a specified criteria. • mxquery -l val criterianame This command lists the defined criteria values for the specified criteria. If the specified criteria does not have defined values, no data is listed. Option -a Add one or more queries specified in a query definition file. -m Replace one or more query definitions with the definition in the specified file. -e Execute the specified query.
Specify an extended option value. This is used with the following keywords. force Force a query into the system when used in conjunction with -af / -mf. cat List only query categories when used with -lf. query List only queries when used with -lf. -b encoding Specify the character encoding for an XML file when used with -lf. xml Display the output of query execution results in xml format when used with -e. You can also use this option with force to force the addition of a query.
Example 4 To remove queries based on the query definition file /home/user1/defs/myquerymods, enter mxquery -r -f /home/user1/defs/myquerymods. Example 5 To view a list of HP SIM query names, enter mxquery -ln. Example 6 This view a tabular listing of queries with column headings, enter mxquery -lt. Example 7 To view a list of queries in XML file format, enter mxquery -lf. Example 8 To view a list of categories to which you can save queries, enter mxquery -lcat.
mxreport [-b encoding ] [-n valid-report-or-category-name ] -l -x [report|category] Description The mxreport command enables users with sufficient privileges to run reports, and to add, delete, and list reports and report categories. • mxreport -a -f fully-qualified-file-name This command enables you to add reports if you have sufficient privileges. Report information is provided in a report definition file (see mxreport(4)).
• • -o specifies the output file path. Without this option, the output is displayed in the console. • You must have the REPORT_VIEW_SECURED_DATA_PRIVILEGE to generate a report that contains license information. mxreport [-b encoding ] [-n valid-report-or-category-name ] -l -x [report|category] This command lists the attributes of a predefined report or report category by passing a report name or category name. • -b specifies the language encoding for the XML file.
-b Specify the character encoding for reports and report categories listed with -l -x. -n valid report or category name Specify the name of an existing report or report category to list with -l -x. -eCat Generate a report from the specified report category. reportname Specify the name of a report. Specifying an invalid report name results in an invalid name return value. If the report name contains spaces, enclose it in quotation marks. categoryname Specify the name of a report category.
Example 4 To create the report category specified in the file /home/user1/defs/myreportcatdef, enter mxreport -c -f "/home/user1/defs/myreportcatdef". Example 5 To run the report Catapult Launchers and format the output as CSV, enter mxreport -e "Catapult Launchers" -x CSV. Example 6 To list all reports, enter mxreport -l -x report. Example 7 To list the contents of the report Islands of Phoenix, enter mxreport -l -x report -n "Islands of Phoenix".
Return values Value Meaning 0 HP SIM and TomCat started correctly. >0 An error occurred during startup. Example To start the HP SIM daemons, enter mxstart. mxstatus mxstatus displays or returns (through the exit code) the current ready or not-ready state of HP SIM Synopsis mxstatus [ [ [-w [-t minutes] ] [-v] ] | [-l] | [-h] | [-v] ] Description The mxstatus command may be used to determine if Systems Insight Manager is running and in a ready or accessable state.
The VERBOSE option may be used to enable verbose mode which forces the command to print progress messages to the console (stdout), while the command is running. This option is provided for command line use and would only be beneficial for HP SIM partner developers who may have the need to determine the command behavior by manual command line invocation.
See also HP-UX mxstatus(1M) Linux mxstatus(8) mxstm Adds, removes, and lists system type manager rules. Synopsis mxstm -a -n product name -p snmp (-x attribute=value)+ NOTE: Systems Insight Manager 6.0 no longer supports DMI. mxstm -r -n product name mxstm -a -f filespec mxstm -r -f filespec mxstm -l [-n product name ] mxstm -l [-p snmp [-f filespec ] ] Description The mxstm command enables you to add, remove, and list system type manager rules for use with HP SIM. Options -a Add a new rule.
The SNMP optional attributes are: url, urldesc, type, subtype, osname, osvendor, osversion, sysoidrule, oid, oidval, oidrule, and priority. The type attribute can use the values: Application, Cluster, Complex, Desktop, Enclosure, Env, Handheld, Hub, KVM, MgmtProc, Other, PDU, Partition, Portable, PowerSupply, Printer, RAS, Rack, RESPAR, Router, Server, SRC, Storage, Switch, TapeLibrary, UPS, Unknown, Workstation, or other values as defined in the nodeTypesEnum table.
Example 3 To delete the rule that was added in the first example, enter mxstm -r -n "Digital LN07". See also /opt/mx/dtd/stmrules.dtd mxstop Stops HP SIM and the TomCat web server. Synopsis mxstop Description The mxstop command stops the HP SIM daemons. Return values Value Meaning 0 HP SIM and TomCat stopped correctly. >0 An error occurred while attempting to stop HP SIM or TomCat. Example To stop the HP SIM daemons, enter mxstop.
Description The mxtask command enables you to list all tasks, list details for a particular task, list task parameters in XML format, execute a task, remove a task, change ownership for a task, and create a task from the command line or an XML file. • mxtask mxtask -lt These commands provide a tabular listing showing the major attributes of all tasks currently registered in the database.
• mxtask -rf taskxmlfile This command enables you to remove the specified task(s). The information regarding the task(s) is provided by an external task specific XML definition file. You must be an authorized user to remove a task. See the mxtask(4) manpage for a description of the task-specific XML format • mxtask -h This command displays extended help for mxtask. Options -lt Display a tabular listing of all registered tasks with their associated attributes.
Specify task schedule data. scheduleinfo is a parameterized string that defines the schedule data. See the schedule parameterized string format section for details about the format for this string. -t toolname Specify the name of an existing tool. -A toolparms or -f toolparmsfile is required if the specified tool requires additional user parameters. -A toolparms Specify the parameter data for a tool that requires user parameters.
• Tschedule.Idaily. Task runs once a day at specified time. • Tschedule.Irunonce. Task runs once at specified date/time. The P parameter signifies the periodic interval (how often the task will run) and is required when the T task type value is schedule. Valid periodic values (n) are any numeric values greater than zero. For example: Tschedule.Iminutes.Pn.
Examples Example 1 To list all scheduled tasks in tabular format, including the task name, associated tool name, last run time and schedule information, enter mxtask. Example 2 To list all scheduled tasks in tabular format, including the task name, associated tool name, last run time and schedule information, enter mxtask -lt. Example 3 To list the details for the task test_task, enter mxtask -ld test_task.
In this example, there are no tool (user) parameters required for the tool being specified, so -A and -f are not required. Example 12 To create task1, which runs every 12 hours, with the associated query query1 and tool toolexample that already exists in the database, with the task type schedule, enter mxtask -c task1 -q query1 -t toolexample -w Tschedule.Ihours.P12. In this example, there are no tool (user) parameters required for the tool being specified, so -A and -f are not required.
Example 19 To create task1, with the associated query query1 and tool toolexample that already exists in the database, with the task type manual, and the task owner owner1, enter mxtask -c task1 -q query1 -t toolexample -w Tmanual -o owner1. In this example, there are no tool (user) parameters required for the tool being specified, so -A and -f are not required.
mxtool -s -f filename mxtool -r [-f filename|-c category|-t toolname ] [-x force] mxtool -l d|f|n|t [-c category...|-t toolname... ] mxtool -lf [-b encoding ] [-c category...|-t toolname... ] mxtool Description The mxtool enables you to add, list, modify or remove tools. • mxtool -a -f filename This command enables you to add tools. Tool information is provided in a tool definition file (see mxtool(4)) that enables you to add one or more tools.
• mxtool -s -f filename This command lets you scan a tool definition file for syntax errors without actually adding or modifying the tool. • mxtool -r [-f filename|-c category|-t toolname ] [-x force] This command enables you to remove tools. Only an administrative rights user can remove a tool. If you enter a tool name that does not exist, HP SIM notifies you that it cannot find the tool, and will attempt to remove the next tool in the list. Skipping undefined tools does not affect the return value.
Specify the name of the tool to be removed or listed. Specifying an undefined tool name results in mxtool operating on zero tools and a return value of SUCCESS. Specifying a tool name that violates the rules for tool names (see mxtool(4)), results in an invalid name return value. -f filename Specify the path and name of a file that contains the definition of one or more tools to be added or modified. This option must be specified with the scan option, -s. See mxtool(4) for additional information.
Examples Example 1 To add the tools defined in the file /home/user1/defs/mytooldef, enter mxtool -a -f /home/user1/defs/mytooldef. Example 2 To modify tools based on the file /home/user1/defs/mytoolmods, enter mxtool -m -f /home/user1/defs/mytoolmods. Example 3 To forcefully modify tools based on the file /home/user1/defs/mytoolmods, enter mxtool -m -f /home/user1/defs/mytoolmods -x force. Example 4 To remove the tool badtool, enter mxtool -r -t badtool.
characters, underscores (_), or dashes (-) are allowed. If you have full configuration rights, you can add up to 32 toolboxes. Toolboxes are enabled by default. To explicitly enable a toolbox, you must have full rights and enter t after -e. To disable a toolbox enter f after -e. When a toolbox is enabled, tools associated with it can be authorized using the toolbox. When the toolbox is disabled, tools associated with it cannot be authorized using the toolbox.
The first pass attempts to parse the XML file and generate a list of toolboxes to process. This pass ensures that the XML file is formatted correctly, that the toolbox names are valid, and the toolbox objects contain valid information. During the first pass, if an error is detected, HP SIM interrupts the process, issues an error message, and leaves the database unchanged. If the XML file is successfully processed in the first pass, HP SIM attempts to process the toolbox list collected during the first pass.
Return values Value Meaning 0 Successful completion. 2 Command line syntax error. 3 Nonexistent toolbox error. 5 Duplicate toolbox error. 21 Invalid name. 22 Invalid description. 26 Unsupported operation. 50 Unauthorized user. 102 HP Systems Insight Manager repository error. 222 The CMS is not initialized. 249 Unable to connect to the session manager. 250 Remote exception. 253 Duplicate name. Examples Example 1 To add toolboxes from the file toolboxlist.
operator webadmin Administrators dbadmin All Tools true true A read-only toolbox for operators A toolbox for WEB Server true true A toolbox for Database Administrators The HP Systems Insight Manager toolbox Example 8 To list all toolboxes in an XML file, enter mxtoolbox -lf The output might look like the following:
Linux mxtoolbox(4), mxauth(8), mxtool(8) mxuser Adds, modifies, removes, or lists users in HP SIM.
the listing options of HP SIM commands. In addition to listing, limited configuration rights users can create tools with mxtool (1M). If you do not specify full rights or CMSSecurity rights for a new user or user group, the default setting is limited configuration rights. Additionally, this command enables a full rights user or CMSSecurity rights user to assign the authorizations of an existing user or group to the new user or group. For more information about authorizations, see mxauth(1M).
NOTE: For backward compatibility with Service Control Manager 3.0, the -p option also supports the Trusted and Untrusted User +T and -T options. The +T option creates a user with, or modifies a user to full configuration rights. The -T option creates a user with, or modifies a user to limited configuration rights.
-l ng Display a list of user group names (with no details). -l tg Display a tabular list of users groups and attributes. -l dg Display a detailed screen-viewable list of user groups and attributes. username... Specify the user names to list with -l. usergroupname... Specify the user group names to list with -l. -b encoding Specify the character encoding of an XML file when used with -lf. -C authorization_source_user Specify an existing user or user group.
Value Meaning 3 Nonexistent user error. 5 Duplicate user error. 21 Invalid name. 26 Invalid operation. 50 Unauthorized user. 102 HP Systems Insight Manager repository error. 222 The CMS is not initialized. 249 Unable to connect to the session manager. 250 Remote exception. 252 File input parsing error. 253 Duplicate name. 254 HP SIM properties file error.
Limitations • Only full configuration or CMSSecurity rights users can add, remove, or modify users. Any user can list information. • Only a unique instance of any user name can be added. Attempting to add a user name that already exists results in an error. • Only existing users can be successfully removed. • This command can only be run on the CMS. • When you add an administrative rights user, the user will not be able to run mxagentconfig until you assign system authorizations with mxauth.
• mxwbemsub -l [ destination ] (-n nodenames|-f filename) [-t indication type ] This option enables you to list WBEM subscriptions from a set of nodes. This option can list subscriptions to another CMS. If a CMS is not specified, then subscriptions to the CMS on which the command is being run are listed. • mxwbemsub -m [ current destination ] new destination (-n nodenames|-f filename) [-t indication type ] This option enables you to move WBEM subscriptions for a set of nodes from one CMS to another CMS.
Examples Example 1 To create WBEM event subscriptions from the node mycomputer.ak.hp.com, enter mxwbemsub -a -n mycomputer.ak.hp.com. The destination for this command is the CMS on which the command is running. Example 2 To create WBEM subscriptions for the node mycomputer.ak.hp.com, enter mxwbemsub -a destinationcms.ak.hp.com -n mycomputer.ak.hp.com. The destination for this command is destinationcms.ak.hp.com. Example 3 To remove WBEM event subscriptions from the node mycomputer.ak.hp.
Example 12 To remove health lifecycle event subscriptions for the node mycomputer.ab.cd.com, enter mxwbemsub -r -n mycomputer.ab.cd.com -t health. Limitations ▲ This command must be run on a CMS. File processing If CMS detects an error while processing an input file, CMS interrupts processing and displays an error message describing the error.
3 Infrastructure management using CLI Inventory management Configuring HP SIM Before adding systems to HP SIM, you must set up and configure the protocols that communicate with the managed systems. The mxglobalprotocolsettings command enables you to set most of the available HP SIM protocol settings. The mxnodesecurity command enables you to set Sign-in, WBEM, SSH, WS-MAN, and SNMP credentials on a per-system basis.
The credential.xml file might contain the following:
# # # # # mxnode mxnode mxnode mxnode mxnode –l –l –l –l –l n [systemnames] d [systemnames] t [systemnames] f [systemnames] mpo The system names parameter is an optional list of one or more system names. If you use this parameter, the command displays the requested data for the systems you list. Otherwise, the command displays the requested data for all systems known to HP SIM. • The -ln option displays the system names. • The -ld option displays detailed information for each system in the database.
# mxreport –l –x category The -n option enables you to select a specific report, or specific report category, for display. The output is XML formatted data that includes details of the report or report category.
The items Systems, Shared, and Systems by Operating System are collections that contain other collections as their members. The items HP-UX and Windows Server 2003 are also collections, but they also define a query that is performed on the HP SIM database. In this section, the term query collection will be used to refer to collections that define a query on the HP SIM database. The mxcollection command enables you to add, modify, remove, or list collections, or members within a collection in HP SIM.
• is not equal to • starts with Because CriteriaByNameComparison is a text criteria, and the operators apply to text fields in the database only. Other criteria are selection criteria, and their operators are is and is not, since selection criteria are the specific values being compared, not free-form text. In the example, CriteriaByNameComparison is a text criteria and does not have any values. However, the criteria ProductByName is a selection criteria.
AssociatedName: associatedDeviceKey: 0 timeStamp: 1144308295806 The mxcollection command enables you to manage the HP SIM collections and help organize query collections. To display all the collections in a hierarchical tree, use the following command: # mxcollection –ln The hierarchy shown at the beginning of this section is the output of the above command.
As shown in the hierarchy above, both the Systems and Events collections contain a sub-collection called Shared. The items shown for the Shared collection are the same as what is shown above in the hierarchy list, with one notable exception. The example query collection is shown as part of the lf output for a collection, but not in the –ln output.
To add to this collection, use the mxcollection –a –f testcoll.xml command, where testcoll.xml contains the XML shown in the example. Event management You can use HP SIM to manage alerts from the systems you are managing. HP SIM accepts SNMP traps and WBEM indications. This section discusses how to use the CLI to manage traps and indications.
files, those MIB files must reside in the same directory as the mibfile.mib file. The cfg file is placed in the same directory as the mibfile.mib file. After compiling the MIBs, the mxmib command enables you to process the cfg file. You can register, un-register, list registered MIBs, and list the traps for a specific registered MIB. To register a newly-compiled MIB file, use the –a option: # mxmib –a mibfile.cfg This command replaces the data on an already-registered MIB if the MIB has been updated.
To remove authentication, use the –r option: # mxagentconfig –r [–n host] This removes the host key for system host from the CMS known hosts file. If a host is not provided, the CMS removes authentication to itself. Managing tasks The mxtask command enables you to create, remove, execute, list, and change ownership of HP SIM tasks, either from the command line or through XML files.
Using the –c option to create a task can be complicated if all of the options are required to properly define the task. You can create a task by defining the task in XML format, and use the mxtask command use the XML definition. The command is: # mxtask –cf taskfile.xml The XML format for the task is defined in the mxtask(4) man page. The general format of the XML syntax for the task is:
as to manage other jobs running within HP SIM. For a full description of the mxexec command, see the mxexec man page. To run a tool, enter: # mxexec –t tool[-u signinuser ] [-p elevationpassword ] [–A arg ...] [–h | –O file | –o dir] [–n target ... | –q query] The only required argument is –t tool, where tool is the name of the tool to execute. The –A option is used to pass required arguments to the tool.
If you do not specify any options, as shown in the first example, all your incomplete jobs appear. • The –l n option lists job IDs only. • The -l t option lists job information in a tabular format, providing task name, job ID, HP SIM user, HP SIM tool name, and the job state. The –i and –j options are mutually exclusive. • Use the –i option to display the data for any job associated with for one or more task names. • Use the –j option to display information for one or more job IDs.
There are several ways to display user information on the screen. You can also save user information in an XML-formatted file.
# mxngroup –m –g grp –n n4 n2 n3 ; replace n1 with n4. # mxngroup –m –g grp –n n5 ; n5 is the only member of the group # mxngroup –m –g grp –n n5 n4 n3 n2 ; add n4, n3, n2 to the group Use caution when modifying groups from the command line, as the second example illustrates, the –m option is replacing systems in the group. Using XML syntax to modify a group is more reliable, especially when the group contains many members. To modify a group that is described in a file called grp.
# mxtoolbox –r tbname ; remove toolbox “tbname” • The –d description option displays a description of the toolbox. In the modify toolbox example, –N newtbname renames the toolbox from tbname to newtbname. Both –d and –N are optional parameters. • The –e [t|f] switch is an optional parameter used to enable or disable a toolbox.
To remove the system authorization, remove the group authorization, and remove authorizations as specified in the XML file, respectively, replace the –a option with the –r option in the previous examples.
and the Tomcat web server. Neither command uses any options. After running mxstop, HP recommends that you do not run mxstart until all the services and related processes are stopped. On HP-UX and Linux operating systems, run the ps –ef | grep mx command until all processes that start with mx are stopped. If after several minutes, there are mx processes still running, manually kill the processes using the kill PID command, where PID is the process ID displayed using the ps –ef|grep mx command.
The mxgetdbinfo command displays information about the HP SIM database. Without any parameters, the database port, database name, user ID, database type, path to executables, and path to data appear. The following options are supported: • The –a option displays the same output as if you did not provide an option. • The –h option returns the host name of the server where the database is installed. • The –p option returns the TCP/IP port number used to connect to the database.
HP SIM passwords The mxpassword command adds, removes, modifies, and lists SSH key passwords stored by HP SIM. Passwords appear in clear text. When using this command, ensure that the passwords are protected. To add a new password, enter: # mxpassword –a –x key1=value1 [–x key2=value …] # mxpassword –a –f file • The –x option assigns password value to password key name key. There can be multiple key and value pairs provided to the add command. • The –f option adds the passwords defined in the file.
4 Support and other resources Information to collect before contacting HP Be sure to have the following information available before you call contact HP: • Software product name • Hardware product model number • Operating system type and version • Applicable error message • Third-party hardware or software • Technical support registration number (if applicable) How to contact HP Use the following methods to contact HP technical support: • In the United States, see the Customer Service / Contact
Warranty information HP will replace defective delivery media for a period of 90 days from the date of purchase. This warranty applies to all Insight Software, Insight Control Management, HP Systems Insight Manager, and ProLiant Essentials products. Typographic conventions Book Title Linked Title http://www.hp.com Command user input computer output Enter term variable value Title of a book or other document. Title that is a hyperlink to a book or other document.
Index devices third-party, 116 discovery task, 113 Distributed Task Facility, 122 mxagentconfig, 15, 122 mxauth, 17, 23, 129 mxcert, 21, 132 mxcollection, 23, 116 mxcompile, 121 mxconfigrepo, 27 mxexec, 28, 124 mxexport, 34 mxgetdbinfo, 36 mxgethostname, 37, 131 mxglobalprotocolsettings, 38, 112, 121 mxglobalsettings, 39, 132 mxgroup, 127 mximport, 40 mxinitconfig, 43, 130 mxlog, 45, 131 mxmib, 47 mxngroup, 48 mxnode, 52, 113 mxnodesecurity, 66, 112, 121 mxoracleconfig, 71, 130 mxpassword, 72, 133 mxquery
SNMP managed systems, 121 support, 135 system group, 127 create, 127 System Type Manager, 116 T tasks create, 122 manage, 123 schedule, 122 toolboxes, 128 add, 129 modify, 129 remove, 129 U users managing, 126 V viewing manpages, 9 W WBEM managed systems, 121 System Fault Management, 121 137
