Creating custom tool definition files for HP Systems Insight Manager 5.1 or greater (481365-002, January 2009)

ManualsBrandsHP ManualsSoftwareHP Systems Insight Manager 4.x Windows Software

Creating custom tool definition files for HP Systems Insight

Manager 5.1 or greater

Table of Contents

Abstract

................................

..............

Introduction

................................

.........

What is a tool definition file?

................................

.............

Tool types

................................

.......

Creating custom t

ools manually with the HP SIM CLI

................................

................

Tool elements and structure

................................

...............

Creating a custom SSA tool

................................

...............

Sample web launch tool

................................

....................

Sample MSA tool

................................

.............................

Sample Enabling Remote Desktop tool

................................

..............................

Adding a TDEF to HP SIM

................................

...............

Removing a TDEF from HP SIM

................................

........

Modifying a TDEF

................................

..........................

Creating custom tools with the HP SIM GUI

................................

...........................

Creating Custom Tools

................................

....................

Creating a New Remote Tool

................................

.......

Creating a New CMS Tool

................................

..........

Creating a New Web Page Tool

................................

Managing custom tools

................................

...................

Conclusion

................................

........

Appendix A: tool type

specific requirements

................................

..........................

SSA

specific attributes

................................

.....................

MSA

specific attributes

................................

....................

WLA

specific attribute

................................

....................

Appendix B: mxtool command parameters

................................

............................

Appendix C: parameterized strings

................................

.....

Appendix D: Common tool attributes

................................

....

Summary of content (32 pages)

PAGE 1
Creating custom tool definition files for HP Systems Insight Manager 5.1 or greater Table of Contents Abstract.............................................................................................................................................. 3 Introduction......................................................................................................................................... 3 What is a tool definition file?.........................................................................
PAGE 2
Appendix E: Tool Filtering attributes ..................................................................................................... 28 Appendix F: Environment Variables ..................................................................................................... 29 Appendix G: Tool parameter guidelines ............................................................................................... 31 For more information.........................................................................
PAGE 3
Abstract HP Systems Insight Manager (HP SIM) is a flexible management utility for an enterprise environment employing HP ProLiant, BladeSystem, StorageWorks, and Integrity solutions. This paper describes how you can customize HP SIM to run the tools you typically use in your environment. Introduction HP Systems Insight Manager is the foundation for the HP unified server-storage management strategy.
PAGE 4
Tool types HP SIM defines six types of tools described in the following table. Table 1. Tool types Name Description Single-system-aware command tool OR Remote Tool in the GUI A single-system-aware (SSA) tool executes on a selected target and is only aware of the target system environment. In executing an SSA tool, the HP SIM distributed task facility (DTF) of the central management server (CMS) uses secure shell (SSH) to send one or more files to the target system, which then executes the tool.
PAGE 5
Table 2. Basic TDEF elements Element Syntax Description Tool type and name Defines the type of tool (SSA, MSA, or web-launch) and the name. The name should be descriptive and must be in quotations. Tool type = ssa-command, msa-command, weblaunch, app-launch. Category Element used by HP SIM for organizing tools, limited to 80 characters. This is used for toolbox authorizations.
PAGE 6
called Software Distributor, which when invoked will enable the administrator to execute this custom tool. 1. Log into the CMS using a valid user name and password. HP SIM grants authorization based on the operating system login. NOTE: Only administrators have command line access to HP SIM on a Windows CMS. Administrators on a HP-UX/Linux CMS must have root capability. 2. Open a terminal window or a command prompt window to execute HP SIM commands. 3.
PAGE 7
8. Following the include-filter element is a block element that is the heart of the tool and includes the command(s) to be executed. Enter the ssa block element as shown below. It will copy the file to the specified destination and execute it there. In the example below, the HP Security Patch v.1 executable is given the filename hpsecurity_patch.exe. C:\\Program Files\\hpsecurity_patch.exe C:\\temp\\hpsecurity_patch.
PAGE 8
C:\\Program Files\\ hpsecurity_patch.exe Deploy|Software Distributor TOOL,mxtools 11. Save the file. HP recommends using a file name that indicates its function, in this case, DeployHPSecurityPatchv.1.xml. Verify that the file name ends with the .XML extension. Note that file names on Linux and HP-UX operating systems are case-sensitive.
PAGE 9
http://hostname.domain:8000/device/%n/ Tools|System Information WJAFrame NOTE: In the previous example, hostname.domain should be replaced with the fully qualified host name of where the WebJetAdmin tool is running.
PAGE 10
CMS true /taskandjob/MpTools/MpInstallSSHKeyCPP1.
PAGE 11
NOTE: For more information about mxtool command parameters, refer to Appendix B: mxtool command parameters. 2. To use the web launch tool previously created, type: mxtool –a –f A successful following: Successfully Successfully Successfully /tools/webjetadmin.xml TDEF addition results in a dialog box displaying the parsed tool file added tool named “WebJetAdmin” added 1 tool Removing a TDEF from HP SIM Removing a TDEF from HP SIM requires using the option –r when running the command mxtools.
PAGE 12
e. Run mxtool to update the tool definition: Example: mxtool –m –f netstat.xml –x force.
PAGE 13
 Configure each managed system that is to run tools with the user account. If the current users account was used to install OpenSSH, then the managed system should be correctly configured. If a different account is used, then the administrator should either run the “Configure or Repair Agents” tool on the systems (specifying the administrator or other account to be used by the SSH), or perform the following steps: a.
PAGE 14
Figure 1: HP SIM New Custom Tool window – Step 1: Tool selection 2. Select Remote Tool, and then click Next. Step 2 of the New Custom Tool window appears as shown in Figure 2 and Figure 3. CMS tool is selected by default.
PAGE 15
Figure 3: New Custom Tool window – Step 2: Bottom of Remote tool window  Enter the required and optional parameters for the new tool in the Tool Parameters section. Parameters marked with an asterisk (*) require data entry (see Appendix G: Tool parameter guidelines for tool parameter guidelines).  When finished, click OK. After you create a new tool, the tool displays in the Custom Tools list. Figure 4 provides an example of a user-created tool named “TestTool” in the list.
PAGE 16
Figure 5: HP SIM New Custom Tool window – Step 1: Tool selection 2. Select CMS tool, and then click Next. Step 2 of the New Custom Tool window appears as shown in Figure 6 and Figure 7. Figure 6: HP SIM New Custom Tool window – Step 2: CMS tool 3. Enter the required and optional parameters for the new tool in the Tool Parameters section. Parameters marked with an asterisk (*) require data entry. Data entry tips: o The Name must be between 1 and 255 characters.
PAGE 17
o Parameter substitution is defined in the Parameterized Strings (refer to Appendix C). In the example below, %n is used to substitute the host name of the server used to run the tool. Additional login requirements for devices can be passed on the command line for the Windows tool SYSTEMINFO. o When using Environment Variables, enter data (refer to Appendix F for Environment Variable data) in the Name field. Enter data in the Value field, and click Add. Enter next Name and Value, as needed.
PAGE 18
Figure 8: HP SIM New Custom Tool window – Step 2: Web page tool 3. Enter the required and optional parameters for the new tool in the Tool Parameters section. Parameters marked with an asterisk (*) require data entry (refer to Appendix G for tool parameter guidelines). 4. When finished, select OK.
PAGE 19
1. In the top menu bar of the main HP SIM window bar, select Tools > Custom Tools > Manage Custom Tools. The Manage Custom Tools window appears as shown in Figure 9. Figure 9: HP SIM Manage Custom Tools window 2. Select the tool to delete checking the box next to the appropriate tool. 3. Click Delete, and then click OK to confirm the deletion. Conclusion Using the capabilities of the XML file format, HP SIM offers flexibility in customizin g management tools for HP-UX, Linux, and Windows systems.
PAGE 20
Appendix A: tool type-specific requirements SSA-specific attributes Table A - 1 lists the SSA-specific attributes. Table A - 1. SSA-specific attributes Attribute Syntax [1] Description ssa-block (command/copy-block attributes) You should specify only one command or copy-block or both; however, you may specify up to 16 multiple copy-blocks can be specified. After the command and/or copy-blocks, one may specify the parameters for the command and/or copy-block.
PAGE 21
MSA-specific attributes MSA command tools must specify a command and the system on which the command will execute. Table A - 2 lists the MSA-specific attributes. Table A - 2. MSA-specific attributes Attribute Syntax [1] Description msa-block (command/parameters) Specifies an MSA command, the parameters for the command, and an execution node on which the command executes. Command (parameters) Specifies the command for an MSA tool.
PAGE 22
WLA-specific attributes Web-launch aware tools must specify a main URL. Table A - 3 lists the WLA-specific attributes. Table A - 3. WLA-specific attributes Attribute Syntax [1] Description Web-block (URL/format attributes) Specifies a main-URL element. Also may specify parameters for the URLs. May optionally specify a target format to describe how targets are passed to a web-launch aware tool. Main-URL http://xxx.xxx.
PAGE 23
Appendix B: mxtool command parameters The HP SIM mxtool command allows you to perform specific actions as defined by the parameter(s) that follow it. Table B - 1 is a partial list of common parameters used with the mxtool command. Table B - 1.
PAGE 24
Appendix C: parameterized strings Parameterized strings (Table C - 1) allow tool developers to greatly enhance the options available in creating TDEFs. Parameterized strings contain replacement fields (similar to the format strings used in the popular printf() function in the standard C library).
PAGE 25
Parameter Description This allows the text to be optional and dependent upon the target selection list. %i Selection index (one-based). %z Do not substitute anything, but increment the selection index to the next integer and the referenced target system to the next target in the selected target list. % < ... % > Encrypted text (encrypt after all other parameters have been substituted). %% Enables you to retain a % in the command/URL after substitution.
PAGE 26
Appendix D: Common tool attributes Table D - 1 lists the common name values available to use for TDEFs. Table D - 1. Common attribute name values Names Values Description Task Wizard names values show-cmdline Displays command line equivalent of GUI action. Values: True | False (default: true) Custom-page-n Value is a string giving relative path to jsp page that should be displayed, where n = sequential value starting at 1.
PAGE 27
Names Values Description menu-path A string in the form “base|submenu|subsubmenu”. Overrides the tool’s category. title String. Display the supplied string in the tool’s window title area. By default, the name of the tool (used in the Manage menu) will be used as the title of the tool. show-title Values: true | false. (default: true) If false, the portal will not display a title bar for the tool. Menu-sort-key String. Integer sort key used to sort among the other menu items in the group.
PAGE 28
Appendix E: Tool Filtering attributes Table E - 1 lists the common filtering values available to use for TDEFs. Table E - 1. Tool filtering attributes Filter name Description OSName Acceptable values include: HPUX (no space or hyphen in the value) Linux WINNT (all windows flavors) Solaris AIX Hypervisor OSVendor Acceptable values include: Microsoft SuSE RedHat HP OSRevision Acceptable values are as follows (see text below for version number details) (for Windows) 4.0, 4.1, 5.0, 5.1 (for Linux) 7.
PAGE 29
Appendix F: Environment Variables Table F - 1 lists the specific environment variables (EVs) available to use for TDEFs. In addition to this list, operating system environment variables are also available (for Windows systems) to be passed into TDEFs. In addition to these ‘automatic’ EV’s, user-defined environment variables can be set as part of scripting in the TDEFs. Table F - 1.
PAGE 30
Names Values Description SystemRoot Variable received from the operating system (received in context of the windows service account) WinDIR Variable received from the operating system (received in context of the windows service account) ComputerName Variable received from the operating system (received in context of the windows service account) MPIP The IP address of the associated management processor MPNAME The name of the associated management processor RELATEDDEVICECOUNT The number of assoc
PAGE 31
Appendix G: Tool parameter guidelines Table G - 1 lists guidelines for entering parameter field data when creating new command line tools. Table G - 1. New Command Line Tool parameter entry guidelines Parameter Field Data entry required? Parameter string assignment Entry guidelines Tool name Yes %1 As when using the CLI, the name of the new tool should be descriptive of the tool’s function. Tool command Yes %2 This is the new command used to call the tool, and it can include parameters.
PAGE 32
For more information For more information about HP Systems Insight Manager, visit the HP website at the following URL: www.hp.com/go/hpsim © 2007-2009 Hewlett-Packard Development Company, L.P. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty.