IBM System Storage N Series Reporting With Operations Manager

Front cover
IBM System Storage N series Reporting with Operations Manager

Working with reports Using the Web interface Scheduled customer reports
Alex Osuna Helvio Homem Jim Lanson
ibm.com/redbooks
International Technical Support Organization IBM System Storage N series Reporting with Operations Manager May 2007
SG24-7464-00
Note: Before using this information and the product it supports, read the information in Notices on page v.
First Edition (May 2007) This edition applies to Operations Manager 3.4.1.
Copyright International Business Machines Corporation 2007. All rights reserved. Note to U.S. Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Contents
Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v Trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii The team that wrote this IBM Redbooks publication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Comments welcome. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii Chapter 1. IBM System Storage N series reporting with Operations Manager . . . . . . . 1.1 Overview of custom reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.1 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.1.2 Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 2 2 2
Chapter 2. Working with reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.1 Command-line interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.1.1 Listing catalogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 2.1.2 Field format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.1.3 Creating reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.4 Viewing custom reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.5 Running a report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.6 Modifying an existent report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.7 Destroying a report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.8 Creating and running a custom report using CLI - scenario 1. . . . . . . . . . . . . . . . . 8 2.1.9 Creating and running a custom report using CLI - scenario 2. . . . . . . . . . . . . . . . . 9 2.1.10 Cross-library reporting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 2.1.11 Creating and running a linked custom report using CLI - scenario 3 . . . . . . . . . 13 2.2 Web interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 2.2.1 Accessing and understanding Custom Report window. . . . . . . . . . . . . . . . . . . . . 16 2.2.2 Creating a custom report using Web interface - scenario 1 . . . . . . . . . . . . . . . . . 20 2.2.3 Creating a custom report using the Web interface - scenario 2 . . . . . . . . . . . . . . 24 2.2.4 Creating a linked custom report using the Web interface - scenario 3 . . . . . . . . . 27 Chapter 3. Working with scheduled custom reports . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1 Zip file contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1.1 Script.xml file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1.2 Script file to execute the custom report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2 Adding a script package to Operations Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2.1 Scheduling a report on Operations Manager - scenario 4 . . . . . . . . . . . . . . . . . . 3.2.2 Checking status of scheduled reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 32 32 36 37 38 42
Appendix A. Report catalogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Related publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IBM Redbooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Other publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Online resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to get IBM Redbooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Help from IBM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 65 65 65 66 66
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Copyright IBM Corp. 2007. All rights reserved.
iii
iv
Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing, IBM Corporation, North Castle Drive, Armonk, NY 10504-1785 U.S.A. The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.
Trademarks
The following terms are trademarks of the International Business Machines Corporation in the United States, other countries, or both:
Redbooks (logo) IBM Redbooks System Storage Tivoli
The following terms are trademarks of other companies: Vfiler, Snapshot, Network Appliance, SnapVault, SnapMirror, DataFabric, and the Network Appliance logo are trademarks or registered trademarks of Network Appliance, Inc. in the U.S. and other countries. Excel, Microsoft, Windows, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries.
Other company, product, or service names may be trademarks or service marks of others.
vi
Preface
In any IT environment today there is a frequent and heavy need for reporting capability. These reports may be for managers or for administrative documentation. As the number of reports increases, so does the complexity of the reporting process. For some time Operations Manager has provided an extensive library of standard reports giving administrators the information they need. However, since no two IT organizations are alike, there are always different reporting needs. An organization may require a report that must have data that in the Operations Manager environment is on multiple reports. Rather than submit multiple reports, it would be more efficient to create a report that has just the data objects desired. The Custom Reporting feature of Operations Manager 3.4.1 provides such functionality. This functionality is discussed further in this IBM Redbooks publication.
The team that wrote this IBM Redbooks publication

This book was produced by a team of specialists from around the world working at the International Technical Support Organization, San Jose Center. Alex Osuna is a Project Leader at the International Technical Support Organization, Tucson Center. He writes extensively and teaches IBM classes worldwide on all areas of IBM storage. Before joining the ITSO two years ago, Alex Osuna worked in Tivoli Sales as a Systems Engineer. He has over 29 years experience in the IT industry with 20 of them focused mainly on data storage. He holds over 10 certifications from IBM, Microsoft, and Red Hat. Helvio Homem is an IT Specialist in IBM Global Services in Brazil. He has six years of experience in IT Infra-Structure field. He holds a degree in Information Systems from Universidade Paulista and holds several product certifications from Microsoft. His areas of expertise include Microsoft infra-structure environments and NAS support. Jim Lanson works for the Network Appliance Corporation.
vii
Figure 1 Alex Osuna and Helvio Homem
Become a published author Join us for a two- to six-week residency program! Help write an IBM Redbooks publication dealing with specific products or solutions, while getting hands-on experience with leading-edge technologies. You will have the opportunity to team with IBM technical professionals, Business Partners, and Clients. Your efforts will help increase product acceptance and customer satisfaction. As a bonus, you will develop a network of contacts in IBM development labs, and increase your productivity and marketability. Find out more about the residency program, browse the residency index, and apply online at: ibm.com/redbooks/residencies.html
Comments welcome
Your comments are important to us! We want our Redbooks to be as helpful as possible. Send us your comments about this book or other Redbooks in one of the following ways: Use the online Contact us review Redbooks form found at: ibm.com/redbooks Send your comments in an e-mail to: redbooks@us.ibm.com
viii
Mail your comments to: IBM Corporation, International Technical Support Organization Dept. HYTD Mail Station P099 2455 South Road Poughkeepsie, NY 12601-5400
Preface
ix
Chapter 1.
IBM System Storage N series reporting with Operations Manager

This book provides an introduction to custom reporting with Operations Manager (formerly known as Data Fabric Manager). This book describes in detail the commands used to implement and manage custom reports, examples of reports, and reference information for the creation of custom reports using Operations Manager. For this book Operations Manager 3.4.1 was used. In any IT environment today there is a heavy and frequent need for reporting capability. These reports may be for managers or for administrative documentation. As the number of reports increases, so does the complexity of the reporting process. Operations Manager has for some time provided an extensive library of standard reports, giving administrators the information they need. However, since no two IT organizations are alike, there are always different reporting needs. An organization may require a report that must have data that in the Operations Manager environment is on multiple reports. Rather than submit multiple reports, it would be more efficient to create a report that has just the data objects desired. The Custom Reporting feature of Operations Manager 3.4.1 provides such functionality.
1.1 Overview of custom reporting

Custom Reporting is a powerful feature provided by Operations Manager. Their catalogs were developed to give you the necessary flexibility when creating custom reports for businesses of any size. In the following sections you can check what the requirements are to use this feature and find a brief explanation of custom report architecture on Operations Manager.
1.1.1 Requirements
The requirements are: The custom reporting feature was introduced in Operations Manager (OM) Release 3.2, so a running server of that release or later is required. Command-line access on the OM server. Custom reports are created on the command line, so such access is required.
1.1.2 Architecture
In an effort to provide more flexibility in reporting, OM 3.2 and later introduced a series of data objects available for creating custom reports. They are grouped into catalogs of related objects or fields. The catalogs of available objects are shown Figure 1-1. A complete breakdown of each catalog is provided in Appendix A, Report catalogs on page 45.
Figure 1-1 OM data object libraries
Chapter 2.
Working with reports

Working with custom reports can be done on the command-line interface (CLI) on the Operations Manager (OM) server or through the OM Web interface. In this chapter we cover both interfaces, explaining and using them in common scenarios. We found that the Web interface is much easier to use than the command line. However, the CLI may be very helpful in situations where you need to have custom reports as part of scripts.
2.1 Command-line interface

In order to work with the command-line interface, you need to have access to the Operations Manager Server console once the commands need to be ran there.
2.1.1 Listing catalogs

The catalog listing command allows you to see all of the catalogs that Operations Manager provides you with. Example 2-1 shows the command to list all of the available catalogs, and Example 2-2 shows its output.
Example 2-1 Listing all available catalogs
dfm report catalog list

Example 2-2 dfm report catalog list command output
Catalog ----------------------------------Appliance Aggregate Disk Event Filer FCPTarget HBAPort Interface InitiatorGroup IPAddress LUN Qtree SANHost Script ScriptJob ScriptSchedule SnapReserve Snapshot User UserQuota vFiler Volume
Default Tab ----------------------------------Appliances Aggregates Appliances Events Appliances LUNs LUNs Appliances LUNs vFilers LUNs Filesystems LUNs Scripts Scripts Scripts Filesystems Filesystems Quotas Quotas vFilers Filesystems
Keep in mind that other releases of Operations Manager may include different catalogs of data objects. Consult the release notes for details.
Catalog format
Each of the catalogs has a specific format and naming convention. Each data object is referenced using the following convention: catalogname.fieldname
Consequently, to refer to the total capacity of storage systems we would use the format shown in Figure 2-1.
Figure 2-1 Catalog reference example
To list the contents of a catalog along with default formats, the command shown in Example 2-3 would be executed on the OM server.
Example 2-3 dfm report list command syntax
dfm report catalog list report-catalog-name For example, to list all of the fields associated with a Snapshot, use the command shown in Example 2-4.
Example 2-4 Listing snapshot catalog
dfm report catalog list snapshot Example 2-5 shows the format of the command output.
Example 2-5 Output of Snapshot catalog
Snapshot Catalog Default Display Tab: Filesystems Fields: Field --------------All Name Id SnapReserve AccessTime Dependency Default Name Default Format ------------------------------ ------------All fields of this catalog Snapshot Name Snapshot Id Snapshot Volume (A) Snapshot Access Time DD MMM 24H Snapshot Dependency
2.1.2 Field format

Displayed above for each field is a column called Default Format. This column shows the default format for that field. Operations Manager 3.4.1 provides flexibility in formatting certain fields when creating custom reports. It may be more informative to change the format of a date or a value field. Each of the fields with formatting options can be specified as follows: catalogname.fieldname:format-qualifier[.precision][=prettyname] For example, the following would change the output of the System Storage capacity field to be displayed in gigabytes instead of kilobytes. Refer to Example 2-6.
Example 2-6 Changing field format on dfm report create command
Filer.TotalCapacity:GB
Chapter 2. Working with reports
Examples of field format usage will be covered later. The valid format qualifiers are: bytes: A, B, KB, MB, GB, TB, PB. time: 24H or AMPM dates: Any combination of DD, MM or MMM, and YY or YYYY. percentages: a number. precision: a number. Optional. The default is 0. The option is ignored with B and A. Pretty names for fields cannot contain colons (:), commas (,) or the equals sign (=). The long name for reports may contain any ASCII characters. Fields specification must be separated by commas. If a report with the specified report-name already exists (canned or custom), an error will be reported.
2.1.3 Creating reports

The syntax to create a report is as follows: dfm report create [-L long-name ][-d description]-R report-catalog -f field-spec report-name -L: The default is the same as report-name. This is how you want the report displayed in the OM window View drop-down box. -d: The default is empty. This is the description that you want displayed when running the dfm report help command. -R: Mandatory field. The specifies the catalog on which the report is based and the tab under which it will appear in the GUI. -f: Mandatory field. The format of a field spec is field-name [:format-qualifier[.precision] ][=pretty-name]. The valid format qualifiers can be found in 2.1.2, Field format on page 5. Creating a report is similar to creating a SQL query for a database. You will need to run this query later to get the current database information. Also, you can reuse that query anytime you want.
2.1.4 Viewing custom reports

To view the list of custom reports on an OM server, the command shown in Example 2-7 must be used.
Example 2-7 Listing custom reports on OM Server
dfm report -C The output will be similar to Example 2-8.

Example 2-8 dfm report -C output
Available custom reports are my-disks-report My second custom report my-disks-report-web My Second Web Custom Report my-linked-report My First linked report my-linked-report-web My First Linked Web Custom Report
my-nseries-report my-nseries-report-web my-snap-report my-vol-report
My My my my
First First first first
Custom Report Web Custom Report custom report custom report
In order to get further information about a specific report shown with the dfm report -C command, use this syntax: dfm report report-name help This will show you all of the information about the report, such as fields and their formats.
2.1.5 Running a report

The syntax to run a report is: dfm report [options] report-name The available options when running a report are: -g group-id or group-name: This allows you to run a report based on a specific OM group of system storage. If the group name contains spaces, you must use double quotation marks. -F output-format: This specifies the output format of the report. Valid output formats are text, html, csv, perl, xls, and xml. -l number-of-lines: This limits the number of data rows a report will have. -s field-name: This allows you to specify what field you want the report sorted by. -N repeat-for-number-of-times: This is the number of times that you want the report output to be showed. The default interval is 30 seconds and can be changed by using the -i switch. -i repeat-interval-in-seconds: This specifies the interval between the repeats. This does not provide any functionality if not used with the -N switch. -H: This includes deleted objects from Operations Manager on the report.
2.1.6 Modifying an existent report

This is the syntax to have a report modified: dfm report modify [-f field] [-L long-name] [-d description] [-D display-tab] [-n new-name] report-name All switches above are optional, except report-name. The new values will replace the current values from the report. For example, there is no way to just add a field on a report using CLI. You need to type all of the fields you currently have on the report in addition to the one that you want to add.
2.1.7 Destroying a report

Finally, to destroy a report, this syntax must be used: dfm destroy report-name Note: The action of destroying a report cannot be undone.
2.1.8 Creating and running a custom report using CLI - scenario 1

By using the command-line interface, create a new report named my-nseries report that shows the following information about system storages monitored by Operations Manager: appliance name, model, serial number, group ID, and status. After created, run it against all systems and for a specific group only. Also, test the -F and -H switches: 1. Enter the command shown in Example 2-9 to create the report.
Example 2-9 Creating my-nseries-report
dfm report create -L "my nseries report" -d "My First Custom Report" -R Appliance -f "appliance.name, appliance.model=Model, appliance.serialnumber=Serial Number, appliance.groupid=Group ID, appliance.status=Status" my-nseries-report 2. The expected output is shown in Example 2-10.
Example 2-10 my-nseries-report creation command output
Report my-nseries-report created 3. Enter the command shown in Example 2-11 to run the report for all systems monitored by OM.
Example 2-11 Running my-nseries-report for all systems
dfm report my-nseries-report 4. Example 2-12 shows the output of the report.
Example 2-12 my-nseries-report output - all systems
Appliance Name -------------itsotuc1 itsotuc2 itsotuc3 itsotuc4
Model ----N3700 N3700 N5500 N5200
Serial Number ------------3105699 3105699 2865130008600 1052596
Group ID Status -------- -------Critical Critical ITSO Lab Critical ITSO Lab Critical
5. Run the report against a specific group by entering the switch -g, as in Example 2-13. In this case the group name is ITSO Lab. It is not necessary to have the groupid as a field on the report to use this option (that is, you can specify a group to run any report).
Example 2-13 my-nseries-report for ITSO Lab group only
dfm report -g ITSO Lab my-nseries-report 6. See that the output has only the system storages from the ITSO Lab group, as shown in Example 2-14.
Example 2-14 my-nseries-report output - ITSO Lab group only
Appliance Name -------------itsotuc3 itsotuc4
Model ----N5500 N5200
Serial Number ------------2865130008600 1052596
Group ID -------ITSO Lab ITSO Lab
Status -------Critical Critical
7. We use the -F switch and specify that we want the last report ran in comma-separated values (csv) format. Example 2-15 shows how to do it.
Example 2-15 my-nseries-report for ITSO Lab group in csv format
dfm report -g ITSO Lab -F csv my-nseries-report 8. We should now have the output shown in Example 2-16. The contents of this output can be copied and pasted on MS Excel, for example, which allows you to work with csv files. You could also send the output directly to a xls file, as in Example 2-17.
Example 2-16 my-nseries-report output - ITSO Lab group only in csv format
"Appliance Name","Model","Serial Number","Group ID","Status" itsotuc3,N5500,2865130008600,ITSO Lab,Critical itsotuc4,N5200,1052596,ITSO Lab,Critical "Totals",,,,

Example 2-17 my-nseries-report for ITSO Lab group in csv format and output to an external file
dfm report -g "ITSO Lab" -F xls my-nseries-report > e:\report\my-nseries.xls 9. The -H switch allows you to include on the report objects previously deleted from the Operations Manager server. Example 2-19 shows that two more System Storages are displayed.
Example 2-18 my-nseries-report with -H switch
dfm report -H my-nseries-report

Example 2-19 my-nseries-report output with -H switch
Appliance Name -------------dual1-3 Dublin3 itsotuc1 itsotuc2 itsotuc3 itsotuc4
Model -----FAS270 N3700 N3700 N3700 N5500 N5200
Serial Number ------------1045982 -A 3105699 3105699 2865130008600 1052596
Group ID Status -------- -------Critical Warning Critical Critical ITSO Lab Critical ITSO Lab Critical
2.1.9 Creating and running a custom report using CLI - scenario 2

By using a command-line interface, create a new report named my-disks-report that shows the following information about disks on your system storages: filer name, disk size, shelf, bay, and used space (in GB format). After created, run it for a specific group, then test the -l switch to limit the numbers of rows on the report. Finally, test the -s switch to get report rows sorted by the bay in which they are installed: 1. Enter the command shown in Example 2-20. (Note that this command illustrates all of the aspects of how custom report create command switches would be used.)
Example 2-20 Creating my-disks-report
dfm report create -L "my disks report" -d "My second custom report" -R disk -f "disk.filer=Filer Name, disk.Size:GB=Size, disk.Shelf=Shelf, disk.Bay=Bay, disk.UsedSpace:GB=Used Space" my-disks-report
2. You should receive the message shown in Example 2-21 confirming the report creation.
Example 2-21 my-disks-report creation command output
Report my-disks-report created 3. Run the previously created report. Example 2-22 shows how to do this.
Example 2-22 Running my-disks-report
dfm report my-disks-report 4. The output of the previous command can be found in Example 2-23. Note that it is too long.
Example 2-23 my-disks-report output
Filer Name Size (GB) Shelf Bay Used Space (GB) -------------------- ------------ ----- --- --------------itsotuc1.itso.tucson 68 1 9 66 itsotuc1.itso.tucson 68 1 7 0 itsotuc1.itso.tucson 68 1 1 66 itsotuc1.itso.tucson 68 1 5 66 itsotuc1.itso.tucson 68 1 11 66 itsotuc1.itso.tucson 68 1 6 0 itsotuc1.itso.tucson 67 1 8 66 itsotuc1.itso.tucson 68 1 10 66 itsotuc2.itso.tucson 67 2 7 66 itsotuc2.itso.tucson 67 2 4 66 itsotuc2.itso.tucson 67 2 9 0 itsotuc2.itso.tucson 68 1 12 66 itsotuc2.itso.tucson 67 2 1 66 itsotuc2.itso.tucson 67 2 11 66 itsotuc2.itso.tucson 67 2 10 66 itsotuc2.itso.tucson 67 2 2 66 itsotuc2.itso.tucson 67 2 8 66 itsotuc2.itso.tucson 68 1 2 66 itsotuc2.itso.tucson 67 2 13 0 itsotuc2.itso.tucson 67 2 12 66 itsotuc2.itso.tucson 67 2 3 66 itsotuc2.itso.tucson 68 1 4 66 itsotuc2.itso.tucson 68 1 0 66 itsotuc2.itso.tucson 67 2 6 66 itsotuc2.itso.tucson 67 2 0 66 itsotuc2.itso.tucson 67 2 5 66 itsotuc2.itso.tucson 68 1 13 66 itsotuc3.itso.tucson 68 1 12 66 itsotuc3.itso.tucson 274 1 2 66 itsotuc3.itso.tucson 68 1 4 66 itsotuc3.itso.tucson 274 1 0 266 itsotuc3.itso.tucson 274 1 4 266 itsotuc3.itso.tucson 68 1 5 66 itsotuc3.itso.tucson 274 1 1 266 itsotuc3.itso.tucson 274 1 5 266 itsotuc3.itso.tucson 68 1 0 66 itsotuc3.itso.tucson 274 1 11 266 itsotuc3.itso.tucson 68 1 7 66
10
itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc3.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson itsotuc4.itso.tucson Totals
274 68 68 274 274 274 274 68 68 68 274 68 68 274 68 274 68 208 208 208 208 208 208 208 208 208 208 208 208 208 208 208 208 208 208 208 10546
1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
8 11 6 9 13 6 3 3 10 8 10 1 13 12 2 7 9 4 5 13 1 11 2 3 4 7 9 10 12 0 0 5 1 6 3 6
0 0 66 0 0 266 66 66 0 66 66 66 66 266 66 0 66 206 0 0 0 0 206 206 0 0 0 0 0 0 206 206 206 0 0 0
5. Run the last command, but limiting the number of data rows on the report to 20 using the -l switch, as in Example 2-24. Note that on Example 2-25 only the first 20 rows from Example 2-23 on page 10 appear.
Example 2-24 my-disks-report with -l switch
dfm report -l 20 my-disks-report

Example 2-25 my-disks-report output with -l switch
Filer Name Size (GB) Shelf Bay Used Space (GB) -------------------- ----------- ----- --- --------------itsotuc1.itso.tucson 68 1 9 66 itsotuc1.itso.tucson 68 1 7 0 itsotuc1.itso.tucson 68 1 1 66 itsotuc1.itso.tucson 68 1 5 66 itsotuc1.itso.tucson 68 1 11 66 itsotuc1.itso.tucson 68 1 6 0
11
itsotuc1.itso.tucson itsotuc1.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson itsotuc2.itso.tucson Totals 1348
67 68 67 67 67 68 67 67 67 67 67 68 67 67
1 1 2 2 2 1 2 2 2 2 2 1 2 2
8 10 7 4 9 12 1 11 10 2 8 2 13 12
66 66 66 66 0 66 66 66 66 66 66 66 0 66
6. Now we want to run the same report again, but sorting it by the bay it is installed. You can do that by entering the command shown in Example 2-26. The result can be seen in Example 2-27.
Example 2-26 my-disks-report with -l and -s switches
dfm report -l 20 -s disk.bay my-disks-report

Example 2-27 my-disks-report output with -l and -s switches
Filer Name Size (GB) Shelf Bay Used Space (GB) -------------------- ------------ ----- --- --------------itsotuc2.itso.tucson 68 1 0 66 itsotuc3.itso.tucson 68 1 0 66 itsotuc3.itso.tucson 274 1 0 266 itsotuc4.itso.tucson 208 1 0 206 itsotuc4.itso.tucson 208 1 0 0 itsotuc2.itso.tucson 67 2 0 66 itsotuc2.itso.tucson 67 2 1 66 itsotuc3.itso.tucson 68 1 1 66 itsotuc4.itso.tucson 208 1 1 206 itsotuc1.itso.tucson 68 1 1 66 itsotuc3.itso.tucson 274 1 1 266 itsotuc4.itso.tucson 208 1 1 0 itsotuc2.itso.tucson 68 1 2 66 itsotuc3.itso.tucson 68 1 2 66 itsotuc2.itso.tucson 67 2 2 66 itsotuc4.itso.tucson 208 1 2 206 itsotuc3.itso.tucson 274 1 2 66 itsotuc3.itso.tucson 274 1 3 66 itsotuc3.itso.tucson 68 1 3 66 itsotuc4.itso.tucson 208 1 3 0 Totals 3017
12
2.1.10 Cross-library reporting

Up to this point reports have been created that contain data objects from a single catalog. Sometimes there is a need to pull information from a related catalog. Related catalogs have links between them. To specify a linked field in a related library the syntax would be: Catalogname.linkfieldname.linkedcatalogfield
2.1.11 Creating and running a linked custom report using CLI - scenario 3
This is an example of a linked report, and a detailed explanation of linked fields follows: 1. To create a report that includes fields from related catalogs by using the command-line interface, enter the command shown in Example 2-28.
Example 2-28 Creating my-linked-report
dfm report create -L "my linked report" -d "My First linked report" -R qtree -f "qtree.name, qtree.volume.name=Volume Name, qtree.volume.aggregate.name=Aggregate, qtree.volume.aggregate.filer.name" my-linked-report 2. The message in Example 2-29 is shown if the report is successfully created.
Example 2-29 my-linked-report creation command
Report my-linked-report created 3. In order to run the report, the command shown in Example 2-30 should be used.
Example 2-30 Running my-linked-report
dfm report my-linked-report 4. The output shown in Example 2-31is displayed.

Example 2-31 my-lined-report output
Qtree Name ----------mixed_qtree NFSqtree ntfs_qtree qpiet qpiet qtmixed qtree1 qtree1 qtree2 qtux qtwin sqldat sqldata unix_qtree
Volume Name ----------------vol1bkup NFSvol vol1bkup tuc3ag1vol1 tuc3ag1vol1clone1 tuc4ag0vol1 vol0 vol_itsosj01 vol0 tuc4ag0vol1 tuc4ag0vol1 vol0 vol0 vol1bkup
Aggregate --------aggr1 aggr1 aggr1 aggr1 aggr1 aggr0 aggr0 aggr0 aggr0 aggr0 aggr0 aggr0 aggr0 aggr1
Filer Name ---------itsotuc1 itsotuc3 itsotuc1 itsotuc3 itsotuc3 itsotuc4 itsotuc2 itsotuc2 itsotuc2 itsotuc4 itsotuc4 itsotuc2 itsotuc2 itsotuc1
For a better understanding of this topic, the steps followed to determine how the Filer Name field (qtree.volume.aggregate.filer.name) could be reached on the example above are covered here.
13
First, it is necessary to understand how the relation between catalogs can be viewed. The fields with links to another catalogs are shown with an (A) in the default name column when the dfm report catalog list is entered. Then what we need to determine is, by using only the qtree catalog on the dfm report create command, how can we reach the field name located on the Filer catalog? The answer can be found below. The first thing was to check what fields from the qtree catalog have links to another catalogs. The command dfm report catalog list qtree was used, and the output in Example 2-32 was shown. Note: The following command outputs used in this example are partials for brevity purposes.
Example 2-32 Qtree catalog
Qtree Catalog Default Display Tab: Filesystems Fields: Field Default Name Default Format ------------ ----------------------------------- -------------All All fields of this catalog Name Qtree Name FullName Qtree FullName Id Qtree Id GroupId Qtree Group Id Volume Qtree Volume (A) vFiler Qtree vFiler (A) Status Qtree Status DeletedWhen Qtree Time of Deletion DD MMM 24H Note that two fields with an (A) were exhibited: Volume and VFiler. These fields are linked to Volume and VFiler catalogs, respectively. As we are not working with VFilers, the Volume catalog will be used to continue looking for the filer name. Until now, this is the path we already have: qtree.volume. Remember that our target is qtree.volume.aggregate.filer.name, so the command dfm report catalog list volume is entered, and we have the output shown in Example 2-33.
Example 2-33 Volume catalog
Volume Catalog Default Display Tab: Filesystems Fields: Field Default Name ------------ -------------------------All All fields of this catalog Name Volume Name FullName Volume Full Name Id Volume Id GroupId Volume Group Id Aggregate Volume Aggregate (A) vFiler Volume vFiler (A) Type Volume Type
Default Format --------------
14
There are two linked fields: Aggregate and VFiler. These indicate links to Aggregate and VFiler catalogs. We already know that VFiler is not in use, and that we need to use the Aggregate linked field to continue looking for the Filer Name field. The path that we have now is qtree.volume.aggregate. After the command dfm report catalog list aggregate is entered, this output in Example 2-34 is shown.
Example 2-34 Aggregate catalog
Aggregate Catalog Default Display Tab: Aggregates Fields: Field Default Name Default Format ---------- ---------------------------- ------------All All fields of this catalog Name Aggregate Name FullName Aggregate Full Name Id Aggregate Id GroupId Aggregate Group Id Filer Aggregate Filer (A) Comment Aggregate Comment We now have the linked field Filer on the Aggregate Catalog, which indicates a link to the Filer catalog, so the current path is qtree.volume.aggregate.filer, and we just need to confirm on which field to get the Filer name on the Filer catalog. We then run the command dfm report catalog list filer and see the output shown in Example 2-35.
Example 2-35 Filer catalog
Filer Catalog Default Display Tab: Appliances Fields: Field Default Name Default Format ----------- -------------------------------- ------------All All fields of this catalog Name Filer Name FullName Filer Full Name Id Filer Id Appliance Common Appliance Properties (A) The field to get the filer name on the catalog field is Name, so we conclude that to get the Filer name through the Qtree catalog we should use the command shown in Example 2-36.
Example 2-36 Getting the filer name through the Qtree catalog
qtree.volume.aggregate.filer.name
2.2 Web interface

Custom reports can also be managed through the Operations Manager Web interface. We found this way easier to use than the command line one. The same examples were used, so it is possible to compare them.
15
2.2.1 Accessing and understanding Custom Report window

To do this: 1. Open a Web browser and enter this address to get access to the Operations Manager Web interface: http://OMServer:8080 2. You will need to log in on Operations Manager. Click Login, as in Figure 2-2. Then enter the credentials to get administrator access on the server and click Login again, as in Figure 2-3.
Figure 2-2 Operations Manager initial window
Figure 2-3 Logging into Operations Manager
16
3. Click the Administration menu and select Custom Reports, as in Figure 2-4.
Figure 2-4 Custom Reports selection
The Custom Reports window will be split into three figures for a better explanation of each field. The first one (Figure 2-5) contains the following fields: Name: The name that OM will know the report for. This is a mandatory field. Web Display Name: A name to identify it on the Web interface. For example, you can use a short name in a previous field and a long one here. The field is optional and the default entry is blank. Description: A description of the report can be used to help identify it. This field is optional and the default entry is blank. Base Catalog: This is the catalog that will be used for the report. This is a mandatory field. Display Tab: The Operations Manager tab report will be available to be run after it is created. You must select one of them.
Figure 2-5 Custom Reports window - 1/3
The next part of the window (Figure 2-6 on page 18) contains these fields: Related Catalogs: This allows you to select which catalog you want to pick up the fields fromthe base catalog selected previously or the catalogs linked to it. According to the selection you make here, you will see different fields in the Choose from available fields list (where you effectively add fields to the report). Note that this area provides the same functionality as Cross-library reporting used with command-line interface, but on a more intuitive way. Choose from available fields: This shows the list of fields available on the catalog selected previously in Related Catalogs and allows you to select them to be added to the report. They will change according to the selected catalog.
17
Enter Field Name Displayed on Report: If you want a different name from the default for this field on the report, type it here. Default name is the field name. It cannot contain colons(:), commas(,), or the equals sign (=). Choose Formatting to Apply on Field: Just as in the command-line interface, this allows you to change the format for certain fields. There are two combo boxes that become available when the selected field enables you to change its format. The valid format qualifiers are: bytes: A, B, KB, MB, GB, TB, and PB. time: 24H or AMPM dates: any combination of DD, MM or MMM, and YY or YYYY. percentages: a number precision: a number. Optional. The default is 0. The option is ignored with B and A.
Add/Remove Buttons: Use them to add or remove the selected field from the report. When adding, if desired, choose the new field name and format before clicking the Add button. Reported Fields: This shows the list of fields already added to the report and the sequence in which they will be shown. Report is always sorted based on the first field. Move Up/Move Down Buttons: Use these to change the position of the fields on the report. Select the field you want to change and click the appropriate button. Create button: Effectively create the report based on options chosen.
Figure 2-6 Custom Reports window - 2/3
18
The last part of the window (Figure 2-7) lists all of the existent reports. It also allows you to edit or delete them. To edit, click the Edit link located on the respective report line. To delete it, select the report and click Delete. You can run the report by clicking its link in the Web Display Name column. The Display Tab column also contains links that take you to the Display tabs session on Operations Manager.
Figure 2-7 Custom Report window - 3/3
Another way to run a report is to click first on the group (Figure 2-8) that you want the report for, click Member Details (Figure 2-9), select the appropriate tab where the custom report is located (Figure 2-10 on page 20), and then select the desired custom report (Figure 2-11 on page 20).
Figure 2-8 Selecting the group you want to run the reports
Figure 2-9 Clicking Member Details
19
Figure 2-10 Choosing the tab to get custom reports
Figure 2-11 Choosing the desired custom report
2.2.2 Creating a custom report using Web interface - scenario 1

Using the Web interface, create a new report named my-nseries-report-web that shows the following information about system storages monitored by Operations Manager: appliance name, model, serial number, group ID, and status. After created, run it against all systems and for a specific group only. Also, use the export report functionality. 1. After logging on to the Operations Manager Web interface and choosing the Custom Reports window (see Accessing and understanding Custom Report window on page 16 for details), perform the following tasks: 2. Fill out the fields as below: a. Name: my-nseries-report-web. b. Web Display Name: my nseries report web. c. Description: My First Web Custom Report. d. Base Catalog: Select Appliance. e. Display Tab: Select Appliances. 20
3. Make sure that Appliance is selected in the Related Catalogs field. It may be the only option. 4. Based on the following lists, choose the following fields in the Choose from available fields form. For each field, fill in the appropriate name in the Enter field name field and click Add: a. Appliance Name: Keep default name. b. Appliance Type: Replace name with Type. c. Appliance Model: Replace name with Model. d. Appliance Serial Number: Replace name with Serial Number. e. Appliance Status: Replace name with Status. 5. If you have any doubt, refer to Figure 2-12. You can see all fields filled out there. 6. Click Create.
Figure 2-12 my-nseries-report-web creation window
7. You should receive the message shown in Figure 2-13.
Figure 2-13 my-nseries-report-web successfully creation message
21
8. Confirm that it appears in the report list on the bottom of Custom Reports window, as in Figure 2-14.
Figure 2-14 my-nseries-report-web successfully added to report list
9. Click the my nseries report web link in the Web Display Name column, as in Figure 2-15.
Figure 2-15 Running my nseries report web
10.The link takes you to the report view, applied to the Global group, as in Figure 2-16. Note that the report is automatically selected in the View field.
Figure 2-16 my nseries report web visualization
22
11.Apply the report only to ITSO Lab Group. In order to do this, click the group link on the left side of the window, in this case the ITSO Lab, as indicated in Figure 2-17.
Figure 2-17 Applying custom report to a specific group
12.See that the report is now applied only to the group ITSO Lab. To have it exported to spreadsheet format, click the icon indicated in Figure 2-18. After clicking it, you will be automatically taken to an MS Excel file with the report contents.
Figure 2-18 Exporting report contents to an MS Excel file
23
2.2.3 Creating a custom report using the Web interface - scenario 2

Using the Web interface, create a new report named my-disks-report-web that shows the following information about disks on your system storages: filer name, disk size, shelf, bay, and used space (in GB format). After created, run it for a specific group and then test sorting functionality. After logging on to the Operations Manager Web interface and choosing the Custom Reports window (see 2.2.1, Accessing and understanding Custom Report window on page 16 for details), perform the following tasks: 1. Fill out the fields as below: a. Name: my-disks-report-web. b. Web Display Name: my disks report web. c. Description: My Second Web Custom Report. d. Base Catalog: Select Disk. e. Display Tab: Select Appliances. 2. Make sure that Disk is selected in the Related Catalogs field. 3. Based on the following lists, choose the fields in the Choose from available fields form. For each field, fill out the appropriate name in the Enter field name field and click Add. For the Disk Size and Used Space fields, select GB as the field format. After completing steps a through d you should see something similar to Figure 2-19. a. Disk Size: Replace the name with Size and select GB for the field format. b. Disk Shelf: Replace the name with Shelf. c. Disk Bay: Replace the name with Bay. d. Disk Used Space: Replace the name with Used Space and select GB for field format.
Figure 2-19 my-disks-report-web creation
24
4. Change the selection to the Filer catalog in the Related Catalogs list. Then look for the field Filer name on Choose from available fields list, select it, and click Add. 5. The Filer Name field is added to the final of the list by default. We want in on the top. To do this, select the field on the Reported Fields list and click the button Move Up until the field is on the top of the list. Check Figure 2-20 and see how the fields should be organized now.
Figure 2-20 my-disks-report-web - ready to be created
6. Click Create. You should receive the message shown in Figure 2-21.
Figure 2-21 my-disks-report-web successfully created
7. Confirm that it appears on the report list on the bottom of the Custom Reports window, as in Figure 2-22.
Figure 2-22 my-disks-report-web successfully added to the custom report list
25
8. Click the my disks report web link in the Web Display Name column, as in Figure 2-23.
Figure 2-23 Running my disks report web
9. The report will be applied for the Global group, and in this case is displayed in several pages once the system storages contain many disks. You can navigate through the report pages by selecting a number or clicking the forward/back buttons. Also, you can change the visualization to a single page by clicking Show All. These options are highlighted in Figure 2-24.
Figure 2-24 my disks report web visualization
26
10.In order to sort the report by a specific field, it is necessary to click the column name. Figure 2-25 shows the report sorted by disk size and highlights the option used to do this.
Figure 2-25 my disks report web visualization - sorted by disk size
2.2.4 Creating a linked custom report using the Web interface - scenario 3
Using the Web interface, create a report that contains the following information about qtrees and volumes of system storages monitored by Operations Manager: Qtree name, volume name, aggregate name, and filer name. After created, run it. After logging on to the Operations Manager Web interface and choosing the Custom Reports window (see 2.2.1, Accessing and understanding Custom Report window on page 16 for details), perform the following tasks: 1. Fill out the fields as below: a. Name: my-linked-report-web. b. Web Display Name: my linked report web. c. Description: My First Linked Web Custom Report. d. Base Catalog: Select Qtree. e. Display Tab: Select File Systems. 2. Make sure that Qtree is selected in the Related Catalogs field. Navigate to the Choose from available fields list and select Qtree Name. Add it to the report by clicking Add. 3. Change the selection to the Volume Catalog in the Related Catalogs list. Then look for the Volume name field in the Choose from available fields list, select it, and click Add. 4. Expand Volume in the Related Catalogs Field by clicking the plus sign (+). Then select the Aggregate catalog. Find the Aggregate Name fiedl in the Choose from available fields list, select it, and add it to the report by clicking Add.
27
5. Expand Aggregate item in the Related Catalogs field by clicking the plus sign (+) again. After selecting the Filer catalog, navigate through the Choose from available fields list and select Filer Name. Click Add to add it to the report. Figure 2-26 shows the panel of the custom report that is being created.
Figure 2-26 my linked report web creation
6. Click Create. 7. You should receive the message shown in Figure 2-27.
Figure 2-27 my linked report web successfully created
8. The report is added to the custom report list. In order to run it, click the link under the Web Display Name column, as highlighted in Figure 2-28.
Figure 2-28 Running my linked report web
28
Figure 2-29 shows the report visualization.
Figure 2-29 my linked report web visualization
29
30
Chapter 3.
Working with scheduled custom reports

In addition to custom reporting, Operations Manager (OM) provides a scripting engine allowing customer-written scripts to be imported into OM and run on a specific schedule. One of the uses of this capability would be to schedule an OM report to run automatically. In order to do this we need the following: Zip file containing Package.xml file Script file to execute the custom report Help file, if desired A script interpreter, such as Perl. Depending on what script language is being used, this must be installed on the OM Server. Path to store the results of the script.
31
3.1 Zip file contents

One of the requirements to have custom reports running according to a schedule on the OM server is a zip file. This section covers the details of each element of the zip file.
3.1.1 Script.xml file

The package.xml file contains information about the script, and may optionally contain definitions of new event types that your script generates. Figure 3-1 shows a sample package.xml file.
Figure 3-1 Package.xml sample file
32
Table 3-1 contains the explanations regarding Figure 3-1 on page 32.
Table 3-1 Package.xml file explanation Code line Line 2 Description Specifies the unique identifier that Operations Manager can use to refer to this script, sample-script. If another script has already been installed with the same name element, then installation of this script will fail. The name element is also used as the name of the subdirectory that the script is installed in. Specifies the version number of the script as 1.0.0. Specifies that the script was provided by your company. Indicates that the name of the executable to use when interpreting the script is perl. Indicates that the name of the file in the zip file that contains the script is sample-script.pl. When the Operations Manager server attempts to run this script, it will execute a command line that starts with perl sample-script.pl.
Line 3 Line 4 Line 5 Line 6
Line 7 Lines 810 Line 11
Script.
Specifies that the name to display for the script in Operations Manager is Sample Provides a brief description of what the script does.
Specifies the name of the file in the zip file that contains the text of the license agreement for this script. The licensing text is presented to the user during installation of the script, and the user is given the opportunity to cancel the installation of the script if he does not agree to the terms. Specifies the name of the file in the ZIP file that contains help text. Specifies that an Operations Manager user must have the read and write privilege for any group they would like to run this script against. Contains custom event type definitions for this script. Lines 1831 define one class of events. Lines 1942 define a second class of events. Lines 2430 define the specific names of events that can be generated for the
Line 12 Lines 1316 Lines 1743
an-event-class defined in lines 1831.

Lines 3841 define the specific names of events that can be generated for the
a-second-event-class defined in lines 1942.

These event class definitions mean that after installation, sample-script.pl would be able to generate three different types of events: an-event-class:an-event-name, an-event-class:a-second-event-name, and a-second-event-class:an-event-name.
During installation, the package.xml file is validated using a validating XML parser. The XML schema file used for this validation is kept in the om-installation-dir/misc/script_package.xsd file (where om-installation-dir is the directory where Operations Manager has been installed).
Chapter 3. Working with scheduled custom reports
33
Table 3-2 is a text description of what is in the script_package.xsd file.

Table 3-2 script_package.xsd (XML schema) file explanation Element package name Required Yes Yes Description All XML files must have a root element, and the root element for a package.xml file is called package. Specifies the unique name for the script package. This name cannot already be in use by other scripts. It must be between 1 and 32 characters in length, and can only include digits, letters, the underscore (_), and the hyphen (-). Indicates the version of the script. It has three attributes: major, minor, and revision. All of them must be integer values. The major attribute is required. The minor and revision attributes are optional. Indicates who created the script. It can be up to 255 characters. This element is used to indicate which interpreter should be used to process the script. The value for this element should just be the name of the interpreters executable, not a path to the executable. For example, you would use perl, not /usr/local/bin/perl, since you do not know where the Perl executable will reside. This value can contain letters, digits, the underscore character (_), the hyphen character (-), the space character ( ), the single quotation mark character, and the double quotation mark character, and can be up to 255 characters in length. The Operations Manager server treats the first space character it sees in the value for this element as being the end of the interpreter executable name. It then treats the rest of the value as command-line parameters. Specifies the name of the script that will be part of the zip file. It should be a simple filenamepath separator characters (/ on UNIX variants, \ on Windows) are not allowed. It must start with a letter, digit, underscore (_), or hyphen (-); may contain a single period (.); and must be between 1 and 32 characters in length. Specifies the name used in Operations Manager to refer to the script. It has no uniqueness constraint placed on it, and can be up to 255 characters long. Contains a description of the script. It may contain between 1 and 1024 characters. Contains the simple file name of a file containing the text of a license. The file should be a plain text file. If this element is present, then installation and upgrade of scripts display this text, giving the user a chance to abort installation if she does not agree with the licensing terms. It must start with a letter, digit, underscore (_), or hyphen (-); may contain a single period (.); and must be between 1 and 32 characters in length. Contains the simple file name of a file containing help text. The file can be plain text or it can be HTML. It must start with a letter, digit, underscore (_), or hyphen (-); may contain a single period (.); and must be between 1 and 32 characters in length.
version
Yes
provider interpreter
No No
exec-file
Yes
display-name (child of package element) description license-file
Yes
Yes No
help-file
No
34
Element required-privileges
Required Yes
Description Contains required-privilege elements. It can be thought of as the list of privileges an Operations Manager user is required to have for a group in order to successfully schedule or run a job using this script. This element appears inside the required-privileges element. It specifies a single privilege that must be held by an Operations Manager user for a given group if that user would like to schedule or run a job on that group using this script. Valid values for required-privilege are Full Control, Read, Write, Delete, Back Up, Restore, Mirror, Distribution, Manage SAN, SRM View, Quota, and Event. This element starts the definition of the list of event classes being defined for this script. The contents of this element are event-class elements, which contain the individual definitions of each event class. The event-class element contains the definition of a single event class, which consists of one or more event names and a description of the event class. You must have at least one of these inside an event-classes element. It has a required attribute name that specifies the name of the event-class. Names can be up to 255 characters long. It has an optional boolean attribute allow-duplicate that specifies whether the event system will drop an incoming event from this class of events if the last event it received was from this event-class. A value of false means that the event will be dropped. True means that it will not. If not specified, the duplicates are dropped. It has an optional boolean attribute multi-current, which indicates whether multiple events from this class are allowed to exist simultaneously for a given Operations Manager object. If true, then multiple events are kept around. If false, then only the most recent event from this class is maintained. Describes the event class, and is displayed on the event details page for an event. It is required to be inside any event-class element. This value can be up to 255 characters long. Defines a specific event type. It describes the name of the type, the severity, and the name to use in Operations Manager. Every event-class element is required to have at least one event-name element. The event-name element must contain a display-name element and a severity element. This element has a single required attribute, name. This attribute gives the name of the type. It must be between 1 and 32 characters in length. The name that can be used to describe an event is a concatenation of the event class name (given by the name attribute of the event-class element) and this elements name attribute, separated with a colon (:). If two scripts use the same event-class/event-name combination, the value of the name element for the script can be prepended to determine which event type is being specified. For the example above, that fully qualified name for the event-name shown on line 24 would be sample-script:an-event-class:an-event-name.
required-privilege
Yes
event-classes
No
event-class
No
about
No
event-name
No
35
Element display-name (child of event-name) severity incompatiblewarning
Required No
Description Specifies the name to display on the events detail page of Operations Manager. Every event-name element must contain this element. It can be up to 64 characters long. Specifies the severity of the event. Valid values are Emergency, Critical, Error, Warning, Information, and Normal. Indicates that a new version of a script is not compatible with an old version of a script. By incompatible, we mean that attempts to use old schedules with the new script might not work due to changes to the command-line arguments the script expects, or for some other reason internal to the script. It should contain text that should be displayed to the user.
No No
3.1.2 Script file to execute the custom report

The second item of the zip file is the script itself. Its name is described on the package.xml file and it can be written in any language, since you have its interpreter on the OM Server. Here we cover one sample for Perl language. Note that this is not intended to be a model of Perl scripting expertise but simply an example of how an OM report could be run via a script. You can use the sample shown in Example 3-1. Remember to change the lines indicated in bold on comments with Customize Here. Note: On perl scripting, the number sign (#) indicates commented lines.
Example 3-1 Perl script sample
# --------------------------------------------------------------------# Program Name: sample_report_script_perl # Purpose: Runs a Operations Manager report and stores it on a # determined folder on OM Server # Created by: Jim Lanson # Updated by: Helvio Homem # Comments: This script will run a report already existent on an OM # Server named my-report and generate a report file named # myreportdateinfo.xml, where dateinfo is checked on the OM # Server by the script. Default location for report to be stored is # C:\My-Reports and it default format is XML. # --------------------------------------------------------------------# Customize Here: Set the proper path and file name below $ReportDir = "C:\\My-Reports\\"; $ReportName = "myreport"; $ReportExt = ".xml"; $timestamp = &get_timestamp(time); # Create the report file name $FileName = $ReportDir . $ReportName . $timestamp . $ReportExt; # Customize Here: This is the command to run the report. If # necessary, change the parameters to get the report you want. system("dfm report -F xml my-report > $FileName"); open (FILE, "$FileName") || die "Cannot open $FileName: $!\n"; @source=<FILE>; close(FILE); $dest[0] = $source[0];
36
$dest[1] = '<?xml:stylesheet type="text/xsl" href="c:\Scripts\Report_script\reports.xsl"?>' . "\n"; for ($index=2; $index < @source; $index++) { $oldind = $index-1; $dest[$index] = $source[$oldind]; } open (FILE, "$FileName") || die "Cannot open $FileName: $!\n"; print FILE @dest; close(FILE); sub get_timestamp { my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($_[0]); $year += 1900; $mon=$mon+1; return "$mon$mday$hour$min"; }
3.2 Adding a script package to Operations Manager

After having the package.xml and the script file ready, add it to a zip file named package.zip and do the following: 1. Log on to Operations Manager, click Management, and select Scripts, as in Figure 3-2.
Figure 3-2 Accessing Scripts page on OM
2. The Scripts page on Operations Manager is composed of the following parts: Add a script Path to ZIP file on the Operations Manager server field: If you have the package.zip file on the OM server, fill in this field with the local path (for example, c:\scripts\package.zip). Path to ZIP file on your computer field: If the zip file is stored on your workstation, you can browse it or type the path here. Add a script button: Click this button when one of the two fields above is filled out. It will add the script package to the OM server.
Added scripts list: This contains all of the scripts already added to the OM Server. This allows you to see their information and to edit script schedules.
37
Figure 3-3 shows the script page on the OM Server. Note that no scripts were added to it yet.
Figure 3-3 Scripts page
3.2.1 Scheduling a report on Operations Manager - scenario 4

By using scripts (perl), schedule the custom report named my-linked-report to run hourly at minute 30. Limit the scheduled report to run on group ITSO Lab. Reports must be stored in folder E:\Reports and must be named qtreereportdateinfo.xml, where dateinfo is automatically supplied by the script. 1. First we must define the exact syntax of the report we want to run. You can run it on the OM server to make sure it works as expected. See Example 3-2.
Example 3-2 Command syntax for scheduled report
dfm report -F xml my-linked-report -f xml specifies the output be in xml format. my-linked-report is the name of the custom report previously created. 2. Now we create a Perl script to run the above report and store it in the specified location. It will be created based on Example 3-1 on page 36. The information we need to change in the sample is: Lines 1 to 11: Script information (Head). These lines are comments on the script, so do not forget to use the number sign (#) at the beginning of each one. Line 13: $ReportDir = "E:\\Reports\\"; Line 14: $ReportName = "qtreereport"; Line 21: system("dfm report -F xml my-linked-report > $FileName"); 3. After making these changes, you should see a script file, as shown in Example 3-3.
Example 3-3 Scenario 4 perl script
# # # # # # # # # #
--------------------------------------------------------------------Program Name: my-linked-report-perl-script Purpose: Runs a Operations Manager report and stores it on OM Server Created by: Jim Lanson Updated by: Helvio Homem Comments: This script will run a report already existent on an OM Server named my-linked-report and generate a report file named qtreereportdateinfo.xml, where dateinfo is checked on the OM Server by the script. Default location for report to be stored is E:\Reports and it default format is XML.
38
# --------------------------------------------------------------------# Customize Here: Set the proper path and file name below $ReportDir = "E:\\Reports\\"; $ReportName = "qtreereport"; $ReportExt = ".xml"; $timestamp = &get_timestamp(time); # Create the report file name $FileName = $ReportDir . $ReportName . $timestamp . $ReportExt; # Customize Here: This is the command to run the report. If # necessary, change the parameters to get the report you want. system("dfm report -F xml my-linked-report > $FileName"); open (FILE, "$FileName") || die "Cannot open $FileName: $!\n"; @source=<FILE>; close(FILE); $dest[0] = $source[0]; $dest[1] = '<?xml:stylesheet type="text/xsl" href="c:\Scripts\Report_script\reports.xsl"?>' . "\n"; for ($index=2; $index < @source; $index++) { $oldind = $index-1; $dest[$index] = $source[$oldind]; } open (FILE, "$FileName") || die "Cannot open $FileName: $!\n"; print FILE @dest; close(FILE); sub get_timestamp { my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime($_[0]); $year += 1900; $mon=$mon+1; return "$mon$mday$hour$min"; } 4. Save the script file as my-linked-report.pl in the c:\scripts folder of the OM server or in another temporary file. You will need to add this file to the zip package later. 5. Create the package.xml file according to our needs. It is created based on Figure 3-1 on page 32. Example 3-4 shows the contents of package.xml for this scenario. Customized entries are in bold. Note that we did not use all of the sections shown in Figure 3-1 on page 32 once we did not need any events on this case.
Example 3-4 Contents of package.xml
<?xml version="1.0" ?> <package> <name>My-first-script</name> <version major="1" minor="0" revision="0" /> <provider>IBM</provider> <interpreter>perl</interpreter> <exec-file>my-linked-report.pl</exec-file> <display-name>My First Automatic Report Generation</display-name> <description> Test to add a schedule to run the report my-linked-report </description> <required-privileges>
39
<required-privilege>Read</required-privilege> <required-privilege>Write</required-privilege> <required-privilege>Delete</required-privilege> </required-privileges> </package> 6. Save the file as package.xml in the same temporary folder in which you saved the perl script file. 7. Add the two files created (my-linked-report.pl and package.xml) into a zip file, name it package.zip, and save it in the c:\scripts folder of the OM server. 8. Log in to Operations Manager and access the Scripts page. (Refer to Figure 3-2 on page 37 if you need to know how to do this.) 9. Select the option Path to ZIP file on the DataFabric Manager server and fill out its field with the package zip file c:\scripts\package.zip. Then click Add Script, as in Figure 3-4.
Figure 3-4 Adding my-linked-report script to OM Server
10.Confirm the script adding by clicking Add in the next window, as shown in Figure 3-5. Note that the information entered on the XML file appears in this window.
Figure 3-5 Confirming script adding to OM server
11.The script is then added to the scripts list. However, it does not have a schedule assigned to it yet, as shown in Figure 3-6. 12.Schedule the report to run automatically. Click the No link, shown in Figure 3-6.
Figure 3-6 My First Automatic Report added to the report list
40
13.Fill out the fields in the Add a schedule window and then click Add Schedule, as in Figure 3-7.
Figure 3-7 Adding a schedule to a script on OM server
14.You should see a successful creation message, as in Figure 3-8.
Figure 3-8 My Linked Report Hourly Schedule added sucessfully to OM server
15.Check whether the jobs are going to work as expected. Look for the E:\Reports folder to see whether they are running. The next section covers the checking of scheduled reports status.
41
3.2.2 Checking status of scheduled reports

After scheduling your jobs, you will probably want to see whether they are running accordingly. Operations Manager provides a centralized management of your scheduled script jobs. Below you can find the main features of this OM funcitionality: 1. In order to see the status of your scheduled script jobs, first log on to the Operations Manager Server, select the group you want to work with, and then select Member Details, as shown in Figure 3-9.
Figure 3-9 Selecting the group you want to see the scheduled jobs
2. Click Scripts, as in Figure 3-10.
Figure 3-10 Selecting Scripts tab to see the scheduled jobs
42
The Scheduled Script jobs window is shown in Figure 3-11. It contains the following items: Start a Job button: You can use this to manually start a job. You will select one job from all of the scripts already added to the OM server. Do thus when you need an immediately report. View Combo Box: This allows you to select the kind of view for your jobs. It helps you to filter them when you have a long list. List Columns Name: shows the name of the scheduled job. Clicking the link will take you to the job details. Status: shows the status of that instance for the job. You can click the link on a specific report to get more information about the status. When you have an error status, you can use it for troubleshooting. Start Time: shows the start time of that instance of the job. Does not have a link. Schedule: shows the current description for the job. You can click its link and edit the schedule. Groups: shows the groups selected for the job. You can click its link and add or remove groups.
Figure 3-11 Scheduled script jobs window
43
44
Appendix A.
Report catalogs
This appendix lists tables associated with the report catalogs. When implementing report catalogs keep the following items in mind: Keep in mind that other releases of Operations Manager may include different catalogs of data objects. Consult release notes for details. If no default format is specified, no formatting of the field is possible. For byte values, the default formatting is raw (B) for CLI and auto-scaling (A) for GUI. The lists below specify only the CLI default (B). In the output of the dfm report catalog list, fields that can be used as ancestors are indicated by an (A) in the default field name. The following tables represent the contents and fields of the report catalogs.
Table A-1 Catalogs list and links Catalog Agent Aggregate Appliance Disk Event Catalog links Filer Filer Agent, Filer, Aggregate, Appliance, Qtree, Volume, Interface, Vfiler, PrimaryDirectory, ScriptJob Filer Appliance SANHost, InitiatorGroup Filer, vFiler Appliance Default tab FileSRM Aggregates Appliances Appliances Events
FCPTarget Filer HBAPort InitiatorGroup Interface
LUNs Appliances LUNs LUNs Appliances
45
Catalog IPAddress LUN PrimaryDirectory Qtree SANHost Script ScriptJob ScriptSchedule SnapReserve Snapshot SRMDir SRMFile SRMPath User UserQuota vFiler Volume Table A-2 Agent catalog Field All Name FullName Id HostOS Status PathCount TotalSize TotalFiles Comment
Catalog links Interface, vFiler Filer, vFiler Volume, vFiler ScriptSchedule Script Volume SnapReserve SRMPath SRMPath Agent User, Qtree, Volume Filer Aggregate, vFiler
Default tab vFilers LUNs Filesystems Filesystems LUNs Scripts Scripts Scripts Filesystems Filesystems FileSRM FileSRM FileSRM Quotas Quotas vFilers Filesystems
Default name All fields of this catalog Agent Name Agent Full Name Agent ID Agent OS Agent Status Agent Number of SRM Paths Agent Total Size Agent Total Files Agent Comment Table A-3 Aggregate catalog Field All Name Default name All fields of this catalog Aggregate Name
Default format
KB
Default format
46
Field FullName Id GroupId Filer Comment Type RAID State Snaplock Status Mirrored DeletedWhen DeletedBy Used UsedPct FullThreshold NearlyFullThreshold FullThresholdInterval OvercommittedThreshold NearlyOvercommittedThresh TotalSpace SpaceAvailable AvailablePct BytesCommitted BytesCommittedPct DailyGrowthRate DailyGrowthPct DaysToFull SnapshotDisabled SnapshotAutoDelete SnapReserveTotal SnapReserveUsed SnapReserveUsedPct
Default name Aggregate Full Name Aggregate Id Aggregate Group Id Aggregate Filer (A) Aggregate Comment Aggregate Type Aggregate RAID Type Aggregate State SnapLock Aggregate Status Aggregate Mirrored Aggregate Deleted When Aggregate Deleted By Aggregate Used Capacity Aggregate Used Capacity % Aggregate Full Threshold Aggregate Nearly Full Threshold Aggregate Full Threshold Interval Aggregate Overcommitted Threshold Aggr. Nearly Overcommitted Thresh. Aggregate Total Space Aggregate Space Available Aggregate Space Available in % Aggregate Bytes Committed Aggregate Bytes Committed % Aggregate Daily Growth Rate Aggregate Daily Growth (%) Aggregate Days to Full Aggregate Snapshot Disabled Aggregate Snapshot Autodelete Aggregate Snap Reserve Total Aggregate Snap Reserve Used Aggregate Snap Reserve Used %
Default format
DD MMM 24H
KB 1 1 1
1 1 KB KB 1 KB 1 KB 1
KB KB 1
Appendix A. Report catalogs
47
Table A-4 Appliance catalog Field All ClusterPartner Comment ConfigGroup ConfigMatches ConsoleAddress Contact CPUPct CPUThreshold CPUThresholdInterval DeletedBy DeletedWhen DownTimestamp Fans FirmwareVersion FullName GroupId GUILink Id IPAddress Location Model Name NVRAMBattery OSVersion PingStatus PingTimestamp PowerUnits RLMStatus SecureGUILink SerialNumber Status Temperature Default name All fields of this catalog Appliance Cluster Partner Appliance Comment Appliance Config Group Appliance Config Matches Appliance Console Address Appliance Contact Appliance CPU % Appliance CPU Threshold Appliance CPU Threshold Interval Appliance Deleted By Appliance Deleted When Appliance Down Timestamp Appliance Fans Appliance Firmware Version Appliance Full Name Appliance Group Id Appliance GUI Link Appliance Id Appliance IP Address Appliance Locations Appliance Model Appliance Name Appliance NVRAM Battery Appliance OS Version Appliance Ping Status Appliance Ping Timestamp Appliance Power Units Appliance RLM Status Appliance Secure GUI Link Appliance Serial Number Appliance Status Appliance Temperature DD MMM 24H DD MMM 24H DD MMM 24H 1 1 Default format
48
Field Type Uptime Table A-5 Disk catalog Field All Name Filer Size FirmwareRevision Vendor Model Shelf Bay Plex BytesPerSector ChecksumCompatibility HostAdapter Id IsZeroed PhysicalBlocks Pool Port PortName RaidGroup RaidType RaidState SecondaryName SecondaryPort SerialNumber UsedBlocks UsedSpace Volume ZeroingPercent
Default name Appliance Type Appliance Uptime
Default format
Default name All fields of this catalog Disk Name Disk Filer (A) Disk Size Disk Firmware Revision Disk Vendor Name Disk Model Disk Shelf Disk Bay Disk Plex Disk Bytes per Sector Disk Checksum Compatibility Disk Host Adapter Disk Id Disk Is Zeroed Disk Physical Blocks Disk Pool Disk Port Disk Port Name Disk RAID Group Disk RAID Type Disk RAID State Disk Secondary Name Disk Secondary Port Disk Serial Number Disk Used Blocks Disk Used Space Disk Volume Disk Zeroing Percent
Default format
MB
MB
49
Table A-6 Event catalog Field All Description Id Severity Triggered AcknowledgedBy Acknowledged SourceId Source SourceType Agent Filer Aggregate Appliance Qtree Volume Interface vFiler PrimaryDirectory ScriptJob DeletedWhen DeletedBy TrapDescription TrapCondition TrapSeverity TrapTimestamp Table A-7 FCPTarget catalog Field All Name WWPN OpStatus Filere Default name All fields of this catalog FCP Target Name FCP Target WWPN FCP Target Op Status FCP Target Filer (A) Default format Default name All fields of this catalog Event Description Event Id Event Severity Event Time of Trigger Event Acknowledged By Event Acknowledged Event Source Id Event Source Event Source Type Event Agent (A) Event Filer (A) Event Aggregate (A) Event Appliance (A) Event Qtree (A) Event Volume (A) Event Interface (A) Event vFiler (A) Event Primary Directory (A) Event Script Job (A) Event Time of Deletion Event Deleted By SNMP Trap Description SNMP Trap Condition SNMP Trap Severity SNMP Trap Timestamp DD MMM 24H DD MMM 24H DD MMM 24H DD MMM 24H Default format
50
Table A-8 Filer catalog Field All Name FullName Id Appliance UsedCapacity TotalCapacity UsedCapacityPct CPUPct TotalOpsperSec NFSOpsperSec CIFSOpsperSec HTTPOpsperSec FCPOpsperSec iSCSIOpsperSec NFS CIFS SnapMirror DAFS VFiler FCP iSCSI SnapVaultPrimary SnapVaultSecondary PeriodBeginThis PeriodEndThis DaysinCycleThis AverageUsageThis AnnualRate MonthlyRateThis UsageChargeThis AverageAllocationThis AllocationChargeThis Default name All fields of this catalog Filer Name Filer Full Name Filer Id Common Appliance Properties (A) Filer Used Capacity Filer Total Capacity Filer Used % Filer CPU % Filer Total Ops/Sec Filer NFS Ops/Sec Filer CIFS Ops/Sec Filer HTTP Ops/Sec Filer FCP Ops/Sec Filer iSCSI Ops/Sec Filer NFS protocol Filer CIFS protocol Filer SnapMirror protocol Filer DAFS protocol Filer VFiler protocol Filer FCP protocol Filer iSCSI protocol Filer SnapVault Primary protocol Filer SnapVault Secondary protocol Filer Beginning of Period This Mont Filer End of Period This Month Filer Days in cycle This Month Filer Avg. Usage This Month Filer Rate/GB Filer Monthly Rate/GB Filer Usage Charge This Month Filer Avg. Allocation This Month Filer Allocation Charge This Month KB KB h KB KB 1 1 Default format
51
Field PeriodBeginLast PeriodEndLast DaysinCycleLast AverageUsageLast MonthlyRateLast UsageChargeLast AverageAllocationLast AllocationChargeLast FailedDiskCount FailedDisks hostvFilerCount PhysicalStorage Table A-9 HBAPort catalog Field All Port HBA Type State OutperSec InperSec SANHost InitiatorGroup Table A-10 InitiatorGroup catalog Field All Name iGroupType iGroupOSType Filer vFiler Default name
Default name Filer Beginning of Period Last Mont Filer End of Period Last Month Filer Days in cycle Last Month Filer Avg. Usage Last Month Filer Rate/GB Last Month Filer Usage Charge Last Month Filer Avg. Allocation Last Month Filer Allocation Charge Last Month Filer Failed Disk Count Filer Failed Disks Number of vFilers Filer Physical Storage
Default format h
KB
KB
MB
Default name All fields of this catalog HBA Port HBA Type Port State Out/Sec In/Sec SAN Host (A) Initiator Group (A)
Default format
B B
Default format
All fields of this catalog Initiator Group Initiator Group Type Initiator Group OS Type Filer (A) vFiler (A)
52
Table A-11 Interface catalog Field All Name FullName Id Appliance Address Mask PhysicalAddress Type InOctetsPerSec OutOctetsPerSec InErrors InErrorsPerSec OutErrors OutErrorsPerSec MTU Speed Status Table A-12 IPAddress catalog Field All IPAddress Interface vFiler Table A-13 LUN Catalog Field All LunPath FullPath Id InitGroup Size Default name All fields of this catalog LUN Path LUN Full Path LUN Id LUN Initiator Group LUN Size B Default format Default name All fields of this catalog IP Address IP Address Interface (A) IP Address vFiler (A) Default format Default name All fields of this catalog Interface Name Interface Full Name Interface Id Interface Appliance (A) Interface Address Interface Mask Interface Physical Address Interface Type Interface Input Octets/sec Interface Output Octets/sec Interface Input Errors Interface Input Errors/sec Interface Output Errors Interface Output Errors/sec Interface MTU Interface Speed Interface Status B B B B Default format
53
Field Filer vFiler Status Description Comment DeletedWhen DeletedBy ReadperSec WriteperSec OpsperSec
Default name LUN Filer (A) LUN vFiler (A) LUN Status LUN Description LUN Comment LUN Time of Deletion LUN Deleted By LUN Reads/Sec LUN Writes/Sec LUN Operations/Sec
Default format
DD MMM 24H
B B B
Table A-14 PrimaryDirectory catalog Field All Name PrimarySystem LastBackupStatus SecondaryVolume SecondaryQtree State Lag Status BandwidthLimit Table A-15 Qtree catalog Field All Name FullName Id GroupId Volume vFiler Status DeletedWhen Default name All fields of this catalog Qtree Name Qtree FullName Qtree Id Qtree Group Id Qtree Volume (A) Qtree vFiler (A) Qtree Status Qtree Time of Deletion DD MMM 24H Default format Default name All fields of this catalog Primary Directory Primary System Last Backup Status Secondary Volume Secondary Qtree State Lag Status Bandwidth Limit KB Default format
54
Field DeletedBy Comment Used UsedPct SoftLimit DiskSpaceLimit FilesLimit FilesUsed FilesUsedPct Available AvailablePct DailyGrowthRate DailyGrowthPct DaysToFull PossibleAddition PossibleAvailable PeriodBeginThis PeriodEndThis DaysInCycleThis AverageUsageThis AnnualRate MonthlyRateThis UsageChargeThis AverageAllocationThis AllocationChargeThis PeriodBeginLast PeriodEndLast DaysInCycleLast AverageUsageLast MonthlyRateLast UsageChargeLast AverageAllocationLast AllocationChargeLast FullThreshold
Default name Qtree Deleted By Qtree Comment Qtree Used Capacity Qtree Used Capacity % Qtree Soft Limit Qtree Disk Space Limit Qtree Files Limit Qtree Files Used Qtree Files Used % Qtree Available Qtree Available % Qtree Daily Growth Rate Qtree Daily Growth % Qtree Days to Full Qtree Possible Addition Qtree Possible Available Qtree Period Beginning This Month Qtree Period End This Month Qtree Days In Cycle This Month Qtree Avg. Usage This Month Qtree Annual Rate/GB Qtree Rate/GB This Month Qtree Usage Charge This Month Qtree Avg. Allocation This Month Qtree Allocation Charge This Month Qtree Period Beginning Last Month Qtree Period End Last Month Qtree Days In Cycle Last Month Qtree Avg. Usage Last Month Qtree Rate/GB Last Month Qtree Usage Charge Last Month Qtree Avg. Allocation Last Month Qtree Allocation Charge Last Month Qtree Full Threshold
Default format
KB 1 KB KB
1 KB 1 KB 1
KB KB
KB
KB
KB
KB
55
Field NearlyFullThreshold FullThresholdInterval BytesUsedPct IsPrimaryDirectory SnapvaultedTo SnapvaultedFrom IsSnapMirrorSource IsSnapMirrorDestination MirrorOf MirroredTo Table A-16 SANHost catalog Field All Name FullName Id Status AgentId FCP iSCSI DeletedWhen DeletedBy Comment FCPOutperSec FCPInperSec Table A-17 Script catalog Field Field All Name Id Version Provider
Default name Qtree Nearly Full Threshold Qtree Full Threshold Interval Qtree Bytes Used % Is Primary Directory Qtree Snapvaulted To Snapvaulted From Is SnapMirror Source Is SnapMirror Destination Mirror Of Mirrored To
Default format 1
Default name All fields of this catalog SAN Host Name SAN Host Full Name SAN Host Id SAN Host Status SAN Host Agent Id SAN Host FCP Protocol SAN Host iSCSI Protocol SAN Host Time of Deletion SAN Host Deleted By SAN Host Comment FCP Out/Sec FCP In/Sec
Default format
DD MMM 24H
B B
Default name Default Name All fields of this catalog Script Name Script Id Script Version Script Provider
Default format Default Format
56
Field Scheduled Description InstalledBy InstallTimestamp ReqdPrivileges InstallDir Interpreter Table A-18 ScriptJob catalog Field All Name Id ScriptSchedule Status StartTime
Default name Script Scheduled Script Description Script Installed By Script Installed On Script Required Privileges Script Installed In Script Interpreter
Default format
DD MMM 24H
Default name All fields of this catalog Job Name Job Id Job Schedule (A) Job Status Job Start Time
Default format
DD MMM 24H
Table A-19 ScriptSchedule catalog Field All Name Id Script Enabled Schedule LastRun LastResult Creator Arguments RecurseSubGrps Groups Table A-20 SnapReserve catalog Field All Default name All fields of this catalog Default format Default name All fields of this catalog Schedule Name Schedule Id Schedule Script (A) Schedule Enabled Schedule Schedule Schedule Last Run Schedule Last Run Result Schedule Created By Schedule Arguments Schedule Applied to Subgroups Schedule Group(s) DD MMM 24H Default format
57
Field Name FullName Id Volume Used Total Available UsedPct Status FullThreshold DailyGrowthRate DailyGrowthPct DaysToFull Table A-21 Snapshot catalog Field All Name Id SnapReserve AccessTime Dependency Table A-22 SRMDir catalog Field All Name SRMPath Owner Size Table A-23 SRMFile catalog Field All Name Default name
Default name SnapReserve Name SnapReserve Full Name SnapReserve Id SnapReserve Volume (A) SnapReserve Used Space SnapReserve Total Space SnapReserve Available Space SnapReserve Used % SnapReserve Status SnapReserve Full Threshold SnapReserve Daily Growth Rate SnapReserve Daily Growth % SnapReserve Days to full
Default format
KB KB KB 1
1 KB 1
Default name All fields of this catalog Snapshot Name Snapshot Id Snapshot Volume (A) Snapshot Access Time Snapshot Dependency
Default format
DD MMM 24H
Default name All fields of this catalog SRM Directory Name SRM Directory Path (A) SRM Directory Owner SRM Directory Size
Default format
Default format
All fields of this catalog SRM File Name
58
Field SRMPath Owner FileSize CreateTime AccessTime ModificationTime Table A-24 SRMPath catalog Field All Path Id Agent TotalSize TotalFiles LastWalkTime Comment
Default name SRM File Path (A) SRM File Owner SRM File Size SRM File Creation Time SRM File Access Time SRM File Modification Time
Default format
B DD MMM YYYY 24H DD MMM YYYY 24H DD MMM YYYY 24H
Default name All fields of this catalog SRM Path SRM Path Id SRM Path Agent (A) SRM Path Total Size SRM Path Total Files SRM Path Last Walk Time SRM Path Comment
Default format
KB
DD MMM 24H
Table A-25 User catalog Field All Name Id Status Email Comment Default name All fields of this catalog User Name User Id User Status User Email User Comment Default format
Table A-26 UserQuota catalog Field All User Id Status Qtree Volume DiskSpaceUsed Default name All fields of this catalog User Quota User (A) User Quota Id User Quota Status User Quota Qtree (A) User Quota Volume (A) User Quota Disk Space Used KB Default format
59
Field DiskSpaceUsedPct DiskSpaceThreshold DiskSpaceSoftLimit DiskSpaceHardLimit FilesUsed FilesUsedPct FilesSoftLimit FilesHardLimit DailyGrowthRate DailyGrowthPct DaysToFull NearlyFullThreshold FullThreshold PeriodBeginThis PeriodEndThis DaysInCycleThis AverageUsageThis AnnualRate MonthlyRateThis UsageChargeThis AverageAllocationThis AllocationChargeThis PeriodBeginLast PeriodEndLast DaysInCycleLast AverageUsageLast MonthlyRateLast UsageChargeLast AverageAllocationLast AllocationChargeLast Table A-27 vFiler catalog Field All
Default name User Quota Disk Space Used % User Quota Disk Space Threshold User Quota Disk Space Soft Limit User Quota Disk Space Hard Limit User Quota Files Used User Quota Files Used % User Quota Files Soft Limit User Quota Files Hard Limit User Quota Daily Growth Rate User Quota Daily Growth (%) User Quota Days to Full User Quota Nearly Full Threshold User Quota Full Threshold User Quota Period Beginning This Month User Quota Period End This Month User Quota Days in Cycle This Month User Quota Avg. Usage This Month User Quota Annual Rate/GB User Quota Rate/GB This Month User Quota Usage Charge This Month User Quota Avg. Alloc. This Month User Quota Allocation Charge This Month User Quota Period Beginning Last Month User Quota Period End Last Month User Quota Days in Cycle Last Month User Quota Avg. Usage Last Month User Quota Rate/GB Last Month User Quota Usage Charge Last Month User Quota Avg. Alloc. Last Month User Quota Allocation Charge Last Month
Default format 1 KB KB KB
KB 1
1 1
KB
KB
KB
KB
Default name All fields of this catalog
Default format
60
Field Name FullName InternalName Id GroupId SystemId Comment DeletedWhen DeletedBy PingTimestamp DownTimestamp Filer Type Status PingStatus PrimaryIP IPSpace CPUPct CPUThreshold NFS CIFS iSCSI RSH PrimaryStore PeriodBeginThis PeriodEndThis DaysinCycleThis AverageUsageThis AnnualRate MonthlyRateThis UsageChargeThis AverageAllocationThis AllocationChargeThis PeriodBeginLast
Default name vFiler Name vFiler Full Name vFiler Internal Name vFiler Id vFiler Group Id vFiler System Id vFiler Comment vFiler Deleted At vFiler Deleted By vFiler Ping Timestamp vFiler Down Timestamp vFiler Hosting Filer (A) vFiler Type vFiler Status vFiler Ping Status vFiler Primary IP Address vFiler IP Space vFiler CPU % vFiler CPU Threshold vFiler NFS Allowed vFiler CIFS Allowed vFiler iSCSI Allowed vFiler RSH Allowed vFiler Primary Storage Unit vFiler Beginning of Period This Month vFiler End of Period This Month vFiler Days in cycle This Month vFiler Avg. Usage This Month vFiler Rate/GB vFiler Monthly Rate/GB vFiler Usage Charge This Month vFiler Avg. Allocation This Month vFiler Allocation Charge This Month vFiler Beginning of Period Last Month
Default format
DD MMM 24H
DD MMM 24H DD MMM 24H
1 1
KB
KB
61
Field PeriodEndLast DaysinCycleLast AverageUsageLast MonthlyRateLast UsageChargeLast AverageAllocationLast AllocationChargeLast Used Table A-28 Volume catalog Field All Name FullName Id GroupId Aggregate vFiler Type RAID State SnaplockMinPeriod SnaplockDefaultPeriod SnaplockMaxPeriod Status DeletedWhen DeletedBy Comment CloneParent Clones Total Used UsedPct Available
Default name vFiler End of Period Last Month vFiler Days in cycle Last Month vFiler Avg. Usage Last Month vFiler Rate/GB Last Month vFiler Usage Charge Last Month vFiler Avg. Allocation Last Month vFiler Allocation Charge Last Month vFiler Used Capacity
Default format
KB
KB
KB
Default name All fields of this catalog Volume Name Volume Full Name Volume Id Volume Group Id Volume Aggregate (A) Volume vFiler (A) Volume Type Volume RAID Volume State SnapLock Minimum Retention Period SnapLock Default Retention Period SnapLock Maximum Retention Period Volume Status Volume Time of Deletion Volume Deleted By Volume Comment Volume Clone Parent Volume Clones Volume Total Capacity Volume Used Capacity Volume Used % Volume Available
Default format
DD MMM 24H
KB KB 1 KB
62
Field AvailablePct DailyGrowthRate DailyGrowthPct DaysToFull PossibleAddition PossibleAvailability TotalSpaceBreakout OverwriteRate OverwriteReserveSpaceAvail OverwriteDaysToFull ReservedFilesTotalSize FractionalOverwritePct ReservedSpaceUsed ReservedSpaceUsedPct ReservedSpaceAvail ReservedSpaceTotal FirstSnapReservationReqd VolSpaceAfterFirstSnap AggrSpaceAfterFirstSnap VolSpaceAfterFirstSnapPct AggrSpaceAfterFirstSnapPct SpaceGuarantee UnusedGuaranteedSpace UnusedGuaranteedSpacePct AggrUnusedGuaranteedSpacePct SnapshotCount NearlyNoSnapThreshold NoSnapThreshold ReserveDepletedThreshold ReserveNearlyDepletedThresh PeriodBeginThis PeriodEndThis DaysInCycleThis AverageUsageThis
Default name Volume Available % Volume Daily Growth Rate Volume Daily Growth % Volume Days to full Volume Possible Addition Volume Possible Available Space Volume Space Breakout Volume Overwrite Rate Volume Overwrite Reserve Available Volume Overwrite Days to Full Volume Reserved Files Total Size Volume Fractional Overwrite % Volume Reserved Space Used Volume Reserved Space Used % Volume Reserved Space Available Volume Reserved Space Total Volume First Snapshot Reserve Reqd Volume Space After 1st Snapshot Vol. Agg. Space After 1st Snapshot Volume Space After 1st Snapshot % Vol. Agg. Spc. After 1st Snapshot % Volume Space Guarantee Volume Unused Guaranteed Space Volume Unused Guaranteed Space % Vol. Agg. Unused Guaranteed Space % Volume Snapshot Count Volume Nearly No Snapshot Threshold Volume No Snap Threshold Volume Reserve Depleted Threshold Vol. Res. Nearly Depleted Thresh. Volume Beginning of Period This Month Volume End of Period This Month Volume Days in Cycle This Month Volume Avg. Usage This Month
Default format 1 KB 1
KB KB
KB KB
KB 1 KB 1 KB KB KB KB KB 1 1
KB 1 1
1 1 1 1
KB
63
Field AnnualRate MonthlyRateThis UsageChargeThis AverageAllocationThis AllocationChargeThis PeriodBeginLast PeriodEndLast DaysInCycleLast AverageUsageLast MonthlyRateLast UsageChargeLast AverageAllocationLast AllocationChargeLast FullThreshold NearlyFullThreshold FullThresholdInterval InodesUsedPct SnapHourlyCount SnapNightlyCount SnapWeeklyCount SchedSnapshots SnapDirVisible IsSecondaryVolume IsSnapMirrorSource IsSnapMirrorDestination MirrorOf MirroredTo
Default name Volume Annual Rate/GB Volume Rate/GB This Month Volume Usage Charge This Month Volume Avg. Allocation This Month Volume Allocation Charge This Month Volume Beginning of Period Last Mon Volume End of Period Last Month Volume Days in Cycle Last Month Volume Avg. Usage Last Month Volume Rate/GB Last Month Volume Usage Charge Last Month Volume Avg. Allocation Last Month Volume Allocation Charge Last Month Volume Full Threshold Volume Nearly Full Threshold Volume Full Threshold Interval Volume Inodes Used % Hourly Retention Nightly Retention Weekly Retention Scheduled Snapshots Snapshot Directory Visible Is Secondary Volume Is SnapMirror Source Is SnapMirror Destination Mirror Of Mirrored To
Default format
KB
th
KB
KB
1 1
64
Related publications
The publications listed in this section are considered particularly suitable for a more detailed discussion of the topics covered in this book.
IBM Redbooks
For information about ordering these publications, see How to get IBM Redbooks on page 66. Note that some of the documents referenced here may be available in softcopy only. IBM N Series Storage Systems in a Microsoft Windows Environment, REDP-4083 Setting up CIFS and Joining the Active Directory, REDP-4074 IBM System Storage N series Operations Manager Sizing and Installation Guide, REDP-4270 The IBM System Storage N Series, SG24-7129
Other publications
These publications are also relevant as further information sources: DataFabric Manager 3.4.1 Installation and Upgrade Guide, GC26-7892-01 DataFabric Manager 3.4.1 with Operations Manager Administration Guide, GC26-7 IBM System Storage N series DataFabric Manager Host Agent 2.4.1 Installation Guide, GC26-7894-01
Online resources
These Web sites are also relevant as further information sources: Support for DataFabric Manager http://www-304.ibm.com/jct01004c/systems/support/supportsite.wss/support resources?taskind=3&brandind=5000029&familyind=5329833 Support for IBM System Storage and TotalStorage products http://www-304.ibm.com/jct01004c/systems/support/supportsite.wss/storageselect product?brandind=5000029&familyind=0&oldfamily=0&continue.x=3&continue.y=14 Network attached storage (NAS) http://www-03.ibm.com/systems/storage/nas/index.html
65
How to get IBM Redbooks

You can search for, view, or download Redbooks, IBM Redpapers, Technotes, draft publications and Additional materials, as well as order hardcopy Redbooks, at this Web site: ibm.com/redbooks
Help from IBM

IBM Support and downloads ibm.com/support IBM Global Services ibm.com/services
66
Index
A
Aggregate 28
L
-l switch 11 linked report 13
B
Base Catalog 17
M
Management menu 37 Mandatory field 6 MS Excel 9 MS Excel file 23 my disks report web link 26 my nseries report web 22 my-disks-report-web 24 my-linked-report.pl 39 my-nseries-report-web 20
C
catalog 4, 6 catalog field 15 Catalog Format 4 CLI 7 comma separated values 9 Command Line Interface 3, 89, 18 Command Line Interface, 4 command output 5 command switches 9 cript_package.xsd file 34 Custom Report Architeture 2 custom report list 28 Custom Reports 15, 17 Custom Reports screen 22
O
OM 6, 17 OM 3.2 2 OM Server 3738, 43 OM server 2, 6 Operations Manager 2, 4, 7, 16, 1920, 24, 27, 31, 37, 40, 42, 45 Operations Manager tab 17
D
data objects 13 Default Format 5 default formats 5 dfm report 6 dfm report -C 7 dfm report catalog list 14, 45 dfm report create 14
P
package.xml 32, 3940 Package.xml file 31 package.zip 37, 40 Perl 31
Q F
Fields specification 6 fm report catalog list qtree 14 format qualifiers 6 Qtree 27 qtree.volume 14 qtree.volume.aggregate 15 qtree.volume.aggregate.filer 15 qtree.volume.aggregate.filer.name 13 qtreereportdateinfo.xml 38
G
GUI 45
R
Redbooks Web site 66 Contact us viii Related Catalogs 17 Related Catalogs Field 27 report creation 10 Reported Fields 18
H
-H switch 9 Help file 31 http / /OMServer 8080 16
I
IBM Redbook 1 IT 1
S
Script File 31 Snapshot 5 SQL query 6 storage systems 5
67
switch -g 8 System Storage capacity 5
W
Web Display Name 17 web interface 3
X
XML parser 33
Z
ZIP file 37 Zip file 3132 zip file 36
68

Back cover

Working with reports Using the Web interface Scheduled customer reports
This IBM Redbooks publication provides an introduction to custom reporting, a feature in Operations Manager. The book describes in detail the commands used to implement and manage custom reports, examples of reports, and reference information for the creation of custom reports within the Operations Manager environment. In any IT environment today there is a frequent and heavy need for reporting capability. These reports may be for managers or for administrative documentation. As the number of reports increases, so does the complexity of the reporting process. For some time Operations Manager has provided an extensive library of standard reports giving administrators the information they need. However, since no two IT organizations are alike, there are always different reporting needs. An organization may require a report that must have data that in the Operations Manager environment is on multiple reports. Rather than submit multiple reports, it would be more efficient to create a report that has just the data objects desired. the custom reporting feature of Operations Manager 3.4.1 provides such functionality. This functionality is discussed further in this book.
INTERNATIONAL TECHNICAL SUPPORT ORGANIZATION
BUILDING TECHNICAL INFORMATION BASED ON PRACTICAL EXPERIENCE

IBM Redbooks are developed by the IBM International Technical Support Organization. Experts from IBM, Customers and Partners from around the world create timely technical information based on realistic scenarios. Specific recommendations are provided to help you implement IT solutions more effectively in your environment.
For more information: ibm.com/redbooks

SG24-7464-00 ISBN 0738489409

IBM System Storage N Series Reporting With Operations Manager

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IBM System Storage N Series Reporting With Operations Manager

Uploaded by

Copyright:

Available Formats

Front cover

IBM System Storage N series Reporting with Operations Manager

Alex Osuna Helvio Homem Jim Lanson

Copyright IBM Corp. 2007. All rights reserved.

IBM System Storage N series Reporting with Operations Manager

Copyright IBM Corp. 2007. All rights reserved.

IBM System Storage N series Reporting with Operations Manager

The team that wrote this IBM Redbooks publication

Copyright IBM Corp. 2007. All rights reserved.

Figure 1 Alex Osuna and Helvio Homem

IBM System Storage N series Reporting with Operations Manager

IBM System Storage N series Reporting with Operations Manager

IBM System Storage N series reporting with Operations Manager

Copyright IBM Corp. 2007. All rights reserved.

1.1 Overview of custom reporting

Figure 1-1 OM data object libraries

IBM System Storage N series Reporting with Operations Manager

Working with reports

Copyright IBM Corp. 2007. All rights reserved.

2.1 Command-line interface

2.1.1 Listing catalogs

dfm report catalog list

IBM System Storage N series Reporting with Operations Manager

Figure 2-1 Catalog reference example

2.1.2 Field format

Chapter 2. Working with reports

2.1.3 Creating reports

2.1.4 Viewing custom reports

dfm report -C The output will be similar to Example 2-8.

IBM System Storage N series Reporting with Operations Manager

my-nseries-report my-nseries-report-web my-snap-report my-vol-report

First First first first

Custom Report Web Custom Report custom report custom report

2.1.5 Running a report

2.1.6 Modifying an existent report

2.1.7 Destroying a report

Chapter 2. Working with reports

2.1.8 Creating and running a custom report using CLI - scenario 1

Appliance Name -------------itsotuc1 itsotuc2 itsotuc3 itsotuc4

Model ----N3700 N3700 N5500 N5200

Serial Number ------------3105699 3105699 2865130008600 1052596

Appliance Name -------------itsotuc3 itsotuc4

Model ----N5500 N5200

Serial Number ------------2865130008600 1052596

Group ID -------ITSO Lab ITSO Lab

Status -------Critical Critical

IBM System Storage N series Reporting with Operations Manager

"Appliance Name","Model","Serial Number","Group ID","Status" itsotuc3,N5500,2865130008600,ITSO Lab,Critical itsotuc4,N5200,1052596,ITSO Lab,Critical "Totals",,,,

dfm report -H my-nseries-report

Appliance Name -------------dual1-3 Dublin3 itsotuc1 itsotuc2 itsotuc3 itsotuc4

Model -----FAS270 N3700 N3700 N3700 N5500 N5200

Serial Number ------------1045982 -A 3105699 3105699 2865130008600 1052596

2.1.9 Creating and running a custom report using CLI - scenario 2

Chapter 2. Working with reports

IBM System Storage N series Reporting with Operations Manager

0 0 66 0 0 266 66 66 0 66 66 66 66 266 66 0 66 206 0 0 0 0 206 206 0 0 0 0 0 0 206 206 206 0 0 0

dfm report -l 20 my-disks-report

Chapter 2. Working with reports

dfm report -l 20 -s disk.bay my-disks-report

IBM System Storage N series Reporting with Operations Manager

2.1.10 Cross-library reporting

dfm report my-linked-report 4. The output shown in Example 2-31is displayed.

Chapter 2. Working with reports