IBM System Storage N series Reporting with Operations Manager Front cover

advertisement
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
IBM System Storage N series Reporting with Operations Manager
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.
© Copyright IBM Corp. 2007. All rights reserved.
v
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
IBM System Storage N series Reporting with Operations Manager
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.
© Copyright IBM Corp. 2007. All rights reserved.
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
IBM System Storage N series Reporting with Operations Manager
򐂰 Mail your comments to:
IBM Corporation, International Technical Support Organization
Dept. HYTD Mail Station P099
2455 South Road
Poughkeepsie, NY 12601-5400
Preface
ix
x
IBM System Storage N series Reporting with Operations Manager
1
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.
© Copyright IBM Corp. 2007. All rights reserved.
1
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
2
IBM System Storage N series Reporting with Operations Manager
2
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.
© Copyright IBM Corp. 2007. All rights reserved.
3
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
4
IBM System Storage N series Reporting with Operations Manager
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
5
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
6
IBM System Storage N series Reporting with Operations Manager
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.
Chapter 2. Working with reports
7
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
8
Model
----N5500
N5200
Serial Number
------------2865130008600
1052596
Group ID
-------ITSO Lab
ITSO Lab
IBM System Storage N series Reporting with Operations Manager
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
Chapter 2. Working with reports
9
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
IBM System Storage N series Reporting with Operations Manager
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
Chapter 2. Working with reports
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
IBM System Storage N series Reporting with Operations Manager
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.
Chapter 2. Working with reports
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
14
Default Format
--------------
IBM System Storage N series Reporting with Operations Manager
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.
Chapter 2. Working with reports
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
IBM System Storage N series Reporting with Operations Manager
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
from—the 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.
Chapter 2. Working with reports
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
IBM System Storage N series Reporting with Operations Manager
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
Chapter 2. Working with reports
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
IBM System Storage N series Reporting with Operations Manager
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
Chapter 2. Working with reports
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
IBM System Storage N series Reporting with Operations Manager
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
Chapter 2. Working with reports
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
IBM System Storage N series Reporting with Operations Manager
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
Chapter 2. Working with reports
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
IBM System Storage N series Reporting with Operations Manager
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.
Chapter 2. Working with reports
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
IBM System Storage N series Reporting with Operations Manager
Figure 2-29 shows the report visualization.
Figure 2-29 my linked report web visualization
Chapter 2. Working with reports
29
30
IBM System Storage N series Reporting with Operations Manager
3
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.
© Copyright IBM Corp. 2007. All rights reserved.
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
IBM System Storage N series Reporting with Operations Manager
Table 3-1 contains the explanations regarding Figure 3-1 on page 32.
Table 3-1 Package.xml file explanation
Code line
Description
Line 2
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.
Line 3
Specifies the version number of the script as 1.0.0.
Line 4
Specifies that the script was provided by your company.
Line 5
Indicates that the name of the executable to use when interpreting the script is perl.
Line 6
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 7
Specifies that the name to display for the script in Operations Manager is Sample
Script.
Lines 8–10
Provides a brief description of what the script does.
Line 11
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.
Line 12
Specifies the name of the file in the ZIP file that contains help text.
Lines 13–16
Specifies that an Operations Manager user must have the read and write privilege for
any group they would like to run this script against.
Lines 17–43
Contains custom event type definitions for this script.
Lines 18–31 define one class of events.
Lines 19–42 define a second class of events.
Lines 24–30 define the specific names of events that can be generated for the
an-event-class defined in lines 18–31.
Lines 38–41 define the specific names of events that can be generated for the
a-second-event-class defined in lines 19–42.
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
Required
Description
package
Yes
All XML files must have a root element, and the root element for
a package.xml file is called package.
name
Yes
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 (-).
version
Yes
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.
provider
No
Indicates who created the script. It can be up to 255 characters.
interpreter
No
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 interpreter’s 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.
exec-file
Yes
Specifies the name of the script that will be part of the zip file. It
should be a simple filename—path 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.
display-name (child of
package element)
Yes
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.
description
Yes
Contains a description of the script. It may contain between 1
and 1024 characters.
license-file
No
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.
help-file
No
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.
34
IBM System Storage N series Reporting with Operations Manager
Element
Required
Description
required-privileges
Yes
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.
required-privilege
Yes
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.
event-classes
No
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.
event-class
No
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.
about
No
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.
event-name
No
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.
Chapter 3. Working with scheduled custom reports
35
Element
Required
Description
display-name (child of
event-name)
No
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.
severity
No
Specifies the severity of the event. Valid values are Emergency,
Critical, Error, Warning, Information, and Normal.
incompatiblewarning
No
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.
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
IBM System Storage N series Reporting with Operations Manager
$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.
Chapter 3. Working with scheduled custom reports
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
#
#
#
#
#
#
#
#
#
#
38
--------------------------------------------------------------------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.
IBM System Storage N series Reporting with Operations Manager
# --------------------------------------------------------------------# 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>
Chapter 3. Working with scheduled custom reports
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
IBM System Storage N series Reporting with Operations Manager
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.
Chapter 3. Working with scheduled custom reports
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
IBM System Storage N series Reporting with Operations Manager
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
Chapter 3. Working with scheduled custom reports
43
44
IBM System Storage N series Reporting with Operations Manager
A
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
Catalog links
Default tab
Agent
-
FileSRM
Aggregate
Filer
Aggregates
Appliance
-
Appliances
Disk
Filer
Appliances
Event
Agent, Filer, Aggregate, Appliance, Qtree,
Volume, Interface, Vfiler™,
PrimaryDirectory, ScriptJob
Events
FCPTarget
Filer
LUNs
Filer
Appliance
Appliances
HBAPort
SANHost, InitiatorGroup
LUNs
InitiatorGroup
Filer, vFiler
LUNs
Interface
Appliance
Appliances
© Copyright IBM Corp. 2007. All rights reserved.
45
Catalog
Catalog links
Default tab
IPAddress
Interface, vFiler
vFilers
LUN
Filer, vFiler
LUNs
PrimaryDirectory
-
Filesystems
Qtree
Volume, vFiler
Filesystems
SANHost
-
LUNs
Script
-
Scripts
ScriptJob
ScriptSchedule
Scripts
ScriptSchedule
Script
Scripts
SnapReserve
Volume
Filesystems
Snapshot
SnapReserve
Filesystems
SRMDir
SRMPath
FileSRM
SRMFile
SRMPath
FileSRM
SRMPath
Agent
FileSRM
User
-
Quotas
UserQuota
User, Qtree, Volume
Quotas
vFiler
Filer
vFilers
Volume
Aggregate, vFiler
Filesystems
Field
Default name
Default format
All
All fields of this catalog
Name
Agent Name
FullName
Agent Full Name
Id
Agent ID
HostOS
Agent OS
Status
Agent Status
PathCount
Agent Number of SRM Paths
TotalSize
Agent Total Size
TotalFiles
Agent Total Files
Comment
Agent Comment
Table A-2 Agent catalog
KB
Table A-3 Aggregate catalog
46
Field
Default name
All
All fields of this catalog
Name
Aggregate Name
IBM System Storage N series Reporting with Operations Manager
Default format
Field
Default name
Default format
FullName
Aggregate Full Name
Id
Aggregate Id
GroupId
Aggregate Group Id
Filer
Aggregate Filer (A)
Comment
Aggregate Comment
Type
Aggregate Type
RAID
Aggregate RAID Type
State
Aggregate State
Snaplock
SnapLock
Status
Aggregate Status
Mirrored
Aggregate Mirrored
DeletedWhen
Aggregate Deleted When
DeletedBy
Aggregate Deleted By
Used
Aggregate Used Capacity
KB
UsedPct
Aggregate Used Capacity %
1
FullThreshold
Aggregate Full Threshold
1
NearlyFullThreshold
Aggregate Nearly Full Threshold
1
FullThresholdInterval
Aggregate Full Threshold Interval
OvercommittedThreshold
Aggregate Overcommitted Threshold
1
NearlyOvercommittedThresh
Aggr. Nearly Overcommitted Thresh.
1
TotalSpace
Aggregate Total Space
KB
SpaceAvailable
Aggregate Space Available
KB
AvailablePct
Aggregate Space Available in %
1
BytesCommitted
Aggregate Bytes Committed
KB
BytesCommittedPct
Aggregate Bytes Committed %
1
DailyGrowthRate
Aggregate Daily Growth Rate
KB
DailyGrowthPct
Aggregate Daily Growth (%)
1
DaysToFull
Aggregate Days to Full
SnapshotDisabled
Aggregate Snapshot Disabled
SnapshotAutoDelete
Aggregate Snapshot Autodelete
SnapReserveTotal
Aggregate Snap Reserve Total
KB
SnapReserveUsed
Aggregate Snap Reserve Used
KB
SnapReserveUsedPct
Aggregate Snap Reserve Used %
1
DD MMM 24H
Appendix A. Report catalogs
47
Table A-4 Appliance catalog
48
Field
Default name
All
All fields of this catalog
ClusterPartner
Appliance Cluster Partner
Comment
Appliance Comment
ConfigGroup
Appliance Config Group
ConfigMatches
Appliance Config Matches
ConsoleAddress
Appliance Console Address
Contact
Appliance Contact
CPUPct
Appliance CPU %
1
CPUThreshold
Appliance CPU Threshold
1
CPUThresholdInterval
Appliance CPU Threshold Interval
DeletedBy
Appliance Deleted By
DeletedWhen
Appliance Deleted When
DD MMM 24H
DownTimestamp
Appliance Down Timestamp
DD MMM 24H
Fans
Appliance Fans
FirmwareVersion
Appliance Firmware Version
FullName
Appliance Full Name
GroupId
Appliance Group Id
GUILink
Appliance GUI Link
Id
Appliance Id
IPAddress
Appliance IP Address
Location
Appliance Locations
Model
Appliance Model
Name
Appliance Name
NVRAMBattery
Appliance NVRAM Battery
OSVersion
Appliance OS Version
PingStatus
Appliance Ping Status
PingTimestamp
Appliance Ping Timestamp
PowerUnits
Appliance Power Units
RLMStatus
Appliance RLM Status
SecureGUILink
Appliance Secure GUI Link
SerialNumber
Appliance Serial Number
Status
Appliance Status
Temperature
Appliance Temperature
IBM System Storage N series Reporting with Operations Manager
Default format
DD MMM 24H
Field
Default name
Type
Appliance Type
Uptime
Appliance Uptime
Default format
Table A-5 Disk catalog
Field
Default name
Default format
All
All fields of this catalog
Name
Disk Name
Filer
Disk Filer (A)
Size
Disk Size
FirmwareRevision
Disk Firmware Revision
Vendor
Disk Vendor Name
Model
Disk Model
Shelf
Disk Shelf
Bay
Disk Bay
Plex
Disk Plex
BytesPerSector
Disk Bytes per Sector
ChecksumCompatibility
Disk Checksum Compatibility
HostAdapter
Disk Host Adapter
Id
Disk Id
IsZeroed
Disk Is Zeroed
PhysicalBlocks
Disk Physical Blocks
Pool
Disk Pool
Port
Disk Port
PortName
Disk Port Name
RaidGroup
Disk RAID Group
RaidType
Disk RAID Type
RaidState
Disk RAID State
SecondaryName
Disk Secondary Name
SecondaryPort
Disk Secondary Port
SerialNumber
Disk Serial Number
UsedBlocks
Disk Used Blocks
UsedSpace
Disk Used Space
Volume
Disk Volume
ZeroingPercent
Disk Zeroing Percent
MB
MB
1
Appendix A. Report catalogs
49
Table A-6 Event catalog
Field
Default name
All
All fields of this catalog
Description
Event Description
Id
Event Id
Severity
Event Severity
Triggered
Event Time of Trigger
AcknowledgedBy
Event Acknowledged By
Acknowledged
Event Acknowledged
SourceId
Event Source Id
Source
Event Source
SourceType
Event Source Type
Agent
Event Agent (A)
Filer
Event Filer (A)
Aggregate
Event Aggregate (A)
Appliance
Event Appliance (A)
Qtree
Event Qtree (A)
Volume
Event Volume (A)
Interface
Event Interface (A)
vFiler
Event vFiler (A)
PrimaryDirectory
Event Primary Directory (A)
ScriptJob
Event Script Job (A)
DeletedWhen
Event Time of Deletion
DeletedBy
Event Deleted By
TrapDescription
SNMP Trap Description
TrapCondition
SNMP Trap Condition
TrapSeverity
SNMP Trap Severity
TrapTimestamp
SNMP Trap Timestamp
Default format
DD MMM 24H
DD MMM 24H
DD MMM 24H
DD MMM 24H
Table A-7 FCPTarget catalog
50
Field
Default name
All
All fields of this catalog
Name
FCP Target Name
WWPN
FCP Target WWPN
OpStatus
FCP Target Op Status
Filere
FCP Target Filer (A)
IBM System Storage N series Reporting with Operations Manager
Default format
Table A-8 Filer catalog
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)
UsedCapacity
Filer Used Capacity
KB
TotalCapacity
Filer Total Capacity
KB
UsedCapacityPct
Filer Used %
1
CPUPct
Filer CPU %
1
TotalOpsperSec
Filer Total Ops/Sec
NFSOpsperSec
Filer NFS Ops/Sec
CIFSOpsperSec
Filer CIFS Ops/Sec
HTTPOpsperSec
Filer HTTP Ops/Sec
FCPOpsperSec
Filer FCP Ops/Sec
iSCSIOpsperSec
Filer iSCSI Ops/Sec
NFS
Filer NFS protocol
CIFS
Filer CIFS protocol
SnapMirror®
Filer SnapMirror protocol
DAFS
Filer DAFS protocol
VFiler
Filer VFiler protocol
FCP
Filer FCP protocol
iSCSI
Filer iSCSI protocol
SnapVaultPrimary
Filer SnapVault® Primary protocol
SnapVaultSecondary
Filer SnapVault Secondary protocol
PeriodBeginThis
Filer Beginning of Period This Mont
PeriodEndThis
Filer End of Period This Month
DaysinCycleThis
Filer Days in cycle This Month
AverageUsageThis
Filer Avg. Usage This Month
AnnualRate
Filer Rate/GB
MonthlyRateThis
Filer Monthly Rate/GB
UsageChargeThis
Filer Usage Charge This Month
AverageAllocationThis
Filer Avg. Allocation This Month
AllocationChargeThis
Filer Allocation Charge This Month
h
KB
KB
Appendix A. Report catalogs
51
Field
Default name
Default format
PeriodBeginLast
Filer Beginning of Period Last Mont
h
PeriodEndLast
Filer End of Period Last Month
DaysinCycleLast
Filer Days in cycle Last Month
AverageUsageLast
Filer Avg. Usage Last Month
MonthlyRateLast
Filer Rate/GB Last Month
UsageChargeLast
Filer Usage Charge Last Month
AverageAllocationLast
Filer Avg. Allocation Last Month
AllocationChargeLast
Filer Allocation Charge Last Month
FailedDiskCount
Filer Failed Disk Count
FailedDisks
Filer Failed Disks
hostvFilerCount
Number of vFilers
PhysicalStorage
Filer Physical Storage
KB
KB
MB
Table A-9 HBAPort catalog
Field
Default name
Default format
All
All fields of this catalog
Port
HBA Port
HBA
HBA
Type
Type
State
Port State
OutperSec
Out/Sec
B
InperSec
In/Sec
B
SANHost
SAN Host (A)
InitiatorGroup
Initiator Group (A)
Table A-10 InitiatorGroup catalog
Field
Default name
All
All fields of this catalog
Name
Initiator Group
iGroupType
Initiator Group Type
iGroupOSType
Initiator Group OS Type
Filer
Filer (A)
vFiler
vFiler (A)
52
IBM System Storage N series Reporting with Operations Manager
Default format
Table A-11 Interface catalog
Field
Default name
Default format
All
All fields of this catalog
Name
Interface Name
FullName
Interface Full Name
Id
Interface Id
Appliance
Interface Appliance (A)
Address
Interface Address
Mask
Interface Mask
PhysicalAddress
Interface Physical Address
Type
Interface Type
InOctetsPerSec
Interface Input Octets/sec
B
OutOctetsPerSec
Interface Output Octets/sec
B
InErrors
Interface Input Errors
InErrorsPerSec
Interface Input Errors/sec
OutErrors
Interface Output Errors
OutErrorsPerSec
Interface Output Errors/sec
MTU
Interface MTU
B
Speed
Interface Speed
B
Status
Interface Status
Table A-12 IPAddress catalog
Field
Default name
All
All fields of this catalog
IPAddress
IP Address
Interface
IP Address Interface (A)
vFiler
IP Address vFiler (A)
Default format
Table A-13 LUN Catalog
Field
Default name
All
All fields of this catalog
LunPath
LUN Path
FullPath
LUN Full Path
Id
LUN Id
InitGroup
LUN Initiator Group
Size
LUN Size
Default format
B
Appendix A. Report catalogs
53
Field
Default name
Default format
Filer
LUN Filer (A)
vFiler
LUN vFiler (A)
Status
LUN Status
Description
LUN Description
Comment
LUN Comment
DeletedWhen
LUN Time of Deletion
DeletedBy
LUN Deleted By
ReadperSec
LUN Reads/Sec
B
WriteperSec
LUN Writes/Sec
B
OpsperSec
LUN Operations/Sec
B
DD MMM 24H
Table A-14 PrimaryDirectory catalog
Field
Default name
Default format
All
All fields of this catalog
Name
Primary Directory
PrimarySystem
Primary System
LastBackupStatus
Last Backup Status
SecondaryVolume
Secondary Volume
SecondaryQtree
Secondary Qtree
State
State
Lag
Lag
Status
Status
BandwidthLimit
Bandwidth Limit
KB
Table A-15 Qtree catalog
54
Field
Default name
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
IBM System Storage N series Reporting with Operations Manager
Default format
DD MMM 24H
Field
Default name
Default format
DeletedBy
Qtree Deleted By
Comment
Qtree Comment
Used
Qtree Used Capacity
KB
UsedPct
Qtree Used Capacity %
1
SoftLimit
Qtree Soft Limit
KB
DiskSpaceLimit
Qtree Disk Space Limit
KB
FilesLimit
Qtree Files Limit
FilesUsed
Qtree Files Used
FilesUsedPct
Qtree Files Used %
1
Available
Qtree Available
KB
AvailablePct
Qtree Available %
1
DailyGrowthRate
Qtree Daily Growth Rate
KB
DailyGrowthPct
Qtree Daily Growth %
1
DaysToFull
Qtree Days to Full
PossibleAddition
Qtree Possible Addition
KB
PossibleAvailable
Qtree Possible Available
KB
PeriodBeginThis
Qtree Period Beginning This Month
PeriodEndThis
Qtree Period End This Month
DaysInCycleThis
Qtree Days In Cycle This Month
AverageUsageThis
Qtree Avg. Usage This Month
AnnualRate
Qtree Annual Rate/GB
MonthlyRateThis
Qtree Rate/GB This Month
UsageChargeThis
Qtree Usage Charge This Month
AverageAllocationThis
Qtree Avg. Allocation This Month
AllocationChargeThis
Qtree Allocation Charge This Month
PeriodBeginLast
Qtree Period Beginning Last Month
PeriodEndLast
Qtree Period End Last Month
DaysInCycleLast
Qtree Days In Cycle Last Month
AverageUsageLast
Qtree Avg. Usage Last Month
MonthlyRateLast
Qtree Rate/GB Last Month
UsageChargeLast
Qtree Usage Charge Last Month
AverageAllocationLast
Qtree Avg. Allocation Last Month
AllocationChargeLast
Qtree Allocation Charge Last Month
FullThreshold
Qtree Full Threshold
KB
KB
KB
KB
1
Appendix A. Report catalogs
55
Field
Default name
Default format
NearlyFullThreshold
Qtree Nearly Full Threshold
1
FullThresholdInterval
Qtree Full Threshold Interval
BytesUsedPct
Qtree Bytes Used %
IsPrimaryDirectory
Is Primary Directory
SnapvaultedTo
Qtree Snapvaulted To
SnapvaultedFrom
Snapvaulted From
IsSnapMirrorSource
Is SnapMirror Source
IsSnapMirrorDestination
Is SnapMirror Destination
MirrorOf
Mirror Of
MirroredTo
Mirrored To
1
Table A-16 SANHost catalog
Field
Default name
Default format
All
All fields of this catalog
Name
SAN Host Name
FullName
SAN Host Full Name
Id
SAN Host Id
Status
SAN Host Status
AgentId
SAN Host Agent Id
FCP
SAN Host FCP Protocol
iSCSI
SAN Host iSCSI Protocol
DeletedWhen
SAN Host Time of Deletion
DeletedBy
SAN Host Deleted By
Comment
SAN Host Comment
FCPOutperSec
FCP Out/Sec
B
FCPInperSec
FCP In/Sec
B
Field
Default name
Default format
Field
Default Name
Default Format
All
All fields of this catalog
Name
Script Name
Id
Script Id
Version
Script Version
Provider
Script Provider
DD MMM 24H
Table A-17 Script catalog
56
IBM System Storage N series Reporting with Operations Manager
Field
Default name
Scheduled
Script Scheduled
Description
Script Description
InstalledBy
Script Installed By
InstallTimestamp
Script Installed On
ReqdPrivileges
Script Required Privileges
InstallDir
Script Installed In
Interpreter
Script Interpreter
Default format
DD MMM 24H
Table A-18 ScriptJob catalog
Field
Default name
All
All fields of this catalog
Name
Job Name
Id
Job Id
ScriptSchedule
Job Schedule (A)
Status
Job Status
StartTime
Job Start Time
Default format
DD MMM 24H
Table A-19 ScriptSchedule catalog
Field
Default name
All
All fields of this catalog
Name
Schedule Name
Id
Schedule Id
Script
Schedule Script (A)
Enabled
Schedule Enabled
Schedule
Schedule Schedule
LastRun
Schedule Last Run
LastResult
Schedule Last Run Result
Creator
Schedule Created By
Arguments
Schedule Arguments
RecurseSubGrps
Schedule Applied to Subgroups
Groups
Schedule Group(s)
Default format
DD MMM 24H
Table A-20 SnapReserve catalog
Field
Default name
All
All fields of this catalog
Default format
Appendix A. Report catalogs
57
Field
Default name
Default format
Name
SnapReserve Name
FullName
SnapReserve Full Name
Id
SnapReserve Id
Volume
SnapReserve Volume (A)
Used
SnapReserve Used Space
KB
Total
SnapReserve Total Space
KB
Available
SnapReserve Available Space
KB
UsedPct
SnapReserve Used %
1
Status
SnapReserve Status
FullThreshold
SnapReserve Full Threshold
1
DailyGrowthRate
SnapReserve Daily Growth Rate
KB
DailyGrowthPct
SnapReserve Daily Growth %
1
DaysToFull
SnapReserve Days to full
Table A-21 Snapshot catalog
Field
Default name
All
All fields of this catalog
Name
Snapshot Name
Id
Snapshot Id
SnapReserve
Snapshot Volume (A)
AccessTime
Snapshot Access Time
Dependency
Snapshot Dependency
Default format
DD MMM 24H
Table A-22 SRMDir catalog
Field
Default name
All
All fields of this catalog
Name
SRM Directory Name
SRMPath
SRM Directory Path (A)
Owner
SRM Directory Owner
Size
SRM Directory Size
Default format
B
Table A-23 SRMFile catalog
Field
Default name
All
All fields of this catalog
Name
SRM File Name
58
IBM System Storage N series Reporting with Operations Manager
Default format
Field
Default name
Default format
SRMPath
SRM File Path (A)
Owner
SRM File Owner
FileSize
SRM File Size
B
CreateTime
SRM File Creation Time
DD MMM YYYY 24H
AccessTime
SRM File Access Time
DD MMM YYYY 24H
ModificationTime
SRM File Modification Time
DD MMM YYYY 24H
Table A-24 SRMPath catalog
Field
Default name
All
All fields of this catalog
Path
SRM Path
Id
SRM Path Id
Agent
SRM Path Agent (A)
TotalSize
SRM Path Total Size
TotalFiles
SRM Path Total Files
LastWalkTime
SRM Path Last Walk Time
Comment
SRM Path Comment
Default format
KB
DD MMM 24H
Table A-25 User catalog
Field
Default name
All
All fields of this catalog
Name
User Name
Id
User Id
Status
User Status
Email
User Email
Comment
User Comment
Default format
Table A-26 UserQuota catalog
Field
Default name
All
All fields of this catalog
User
User Quota User (A)
Id
User Quota Id
Status
User Quota Status
Qtree
User Quota Qtree (A)
Volume
User Quota Volume (A)
DiskSpaceUsed
User Quota Disk Space Used
Default format
KB
Appendix A. Report catalogs
59
Field
Default name
Default format
DiskSpaceUsedPct
User Quota Disk Space Used %
1
DiskSpaceThreshold
User Quota Disk Space Threshold
KB
DiskSpaceSoftLimit
User Quota Disk Space Soft Limit
KB
DiskSpaceHardLimit
User Quota Disk Space Hard Limit
KB
FilesUsed
User Quota Files Used
FilesUsedPct
User Quota Files Used %
FilesSoftLimit
User Quota Files Soft Limit
FilesHardLimit
User Quota Files Hard Limit
DailyGrowthRate
User Quota Daily Growth Rate
KB
DailyGrowthPct
User Quota Daily Growth (%)
1
DaysToFull
User Quota Days to Full
NearlyFullThreshold
User Quota Nearly Full Threshold
1
FullThreshold
User Quota Full Threshold
1
PeriodBeginThis
User Quota Period Beginning This Month
PeriodEndThis
User Quota Period End This Month
DaysInCycleThis
User Quota Days in Cycle This Month
AverageUsageThis
User Quota Avg. Usage This Month
AnnualRate
User Quota Annual Rate/GB
MonthlyRateThis
User Quota Rate/GB This Month
UsageChargeThis
User Quota Usage Charge This Month
AverageAllocationThis
User Quota Avg. Alloc. This Month
AllocationChargeThis
User Quota Allocation Charge This Month
PeriodBeginLast
User Quota Period Beginning Last Month
PeriodEndLast
User Quota Period End Last Month
DaysInCycleLast
User Quota Days in Cycle Last Month
AverageUsageLast
User Quota Avg. Usage Last Month
MonthlyRateLast
User Quota Rate/GB Last Month
UsageChargeLast
User Quota Usage Charge Last Month
AverageAllocationLast
User Quota Avg. Alloc. Last Month
AllocationChargeLast
User Quota Allocation Charge Last Month
1
KB
KB
KB
KB
Table A-27 vFiler catalog
Field
Default name
All
All fields of this catalog
60
Default format
IBM System Storage N series Reporting with Operations Manager
Field
Default name
Default format
Name
vFiler Name
FullName
vFiler Full Name
InternalName
vFiler Internal Name
Id
vFiler Id
GroupId
vFiler Group Id
SystemId
vFiler System Id
Comment
vFiler Comment
DeletedWhen
vFiler Deleted At
DeletedBy
vFiler Deleted By
PingTimestamp
vFiler Ping Timestamp
DD MMM 24H
DownTimestamp
vFiler Down Timestamp
DD MMM 24H
Filer
vFiler Hosting Filer (A)
Type
vFiler Type
Status
vFiler Status
PingStatus
vFiler Ping Status
PrimaryIP
vFiler Primary IP Address
IPSpace
vFiler IP Space
CPUPct
vFiler CPU %
1
CPUThreshold
vFiler CPU Threshold
1
NFS
vFiler NFS Allowed
CIFS
vFiler CIFS Allowed
iSCSI
vFiler iSCSI Allowed
RSH
vFiler RSH Allowed
PrimaryStore
vFiler Primary Storage Unit
PeriodBeginThis
vFiler Beginning of Period This Month
PeriodEndThis
vFiler End of Period This Month
DaysinCycleThis
vFiler Days in cycle This Month
AverageUsageThis
vFiler Avg. Usage This Month
AnnualRate
vFiler Rate/GB
MonthlyRateThis
vFiler Monthly Rate/GB
UsageChargeThis
vFiler Usage Charge This Month
AverageAllocationThis
vFiler Avg. Allocation This Month
AllocationChargeThis
vFiler Allocation Charge This Month
PeriodBeginLast
vFiler Beginning of Period Last Month
DD MMM 24H
KB
KB
Appendix A. Report catalogs
61
Field
Default name
Default format
PeriodEndLast
vFiler End of Period Last Month
DaysinCycleLast
vFiler Days in cycle Last Month
AverageUsageLast
vFiler Avg. Usage Last Month
MonthlyRateLast
vFiler Rate/GB Last Month
UsageChargeLast
vFiler Usage Charge Last Month
AverageAllocationLast
vFiler Avg. Allocation Last Month
AllocationChargeLast
vFiler Allocation Charge Last Month
Used
vFiler Used Capacity
KB
KB
KB
Table A-28 Volume catalog
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
RAID
Volume RAID
State
Volume State
SnaplockMinPeriod
SnapLock Minimum Retention Period
SnaplockDefaultPeriod
SnapLock Default Retention Period
SnaplockMaxPeriod
SnapLock Maximum Retention Period
Status
Volume Status
DeletedWhen
Volume Time of Deletion
DeletedBy
Volume Deleted By
Comment
Volume Comment
CloneParent
Volume Clone Parent
Clones
Volume Clones
Total
Volume Total Capacity
KB
Used
Volume Used Capacity
KB
UsedPct
Volume Used %
1
Available
Volume Available
KB
62
IBM System Storage N series Reporting with Operations Manager
Default format
DD MMM 24H
Field
Default name
Default format
AvailablePct
Volume Available %
1
DailyGrowthRate
Volume Daily Growth Rate
KB
DailyGrowthPct
Volume Daily Growth %
1
DaysToFull
Volume Days to full
PossibleAddition
Volume Possible Addition
KB
PossibleAvailability
Volume Possible Available Space
KB
TotalSpaceBreakout
Volume Space Breakout
OverwriteRate
Volume Overwrite Rate
KB
OverwriteReserveSpaceAvail
Volume Overwrite Reserve Available
KB
OverwriteDaysToFull
Volume Overwrite Days to Full
ReservedFilesTotalSize
Volume Reserved Files Total Size
KB
FractionalOverwritePct
Volume Fractional Overwrite %
1
ReservedSpaceUsed
Volume Reserved Space Used
KB
ReservedSpaceUsedPct
Volume Reserved Space Used %
1
ReservedSpaceAvail
Volume Reserved Space Available
KB
ReservedSpaceTotal
Volume Reserved Space Total
KB
FirstSnapReservationReqd
Volume First Snapshot Reserve Reqd
KB
VolSpaceAfterFirstSnap
Volume Space After 1st Snapshot
KB
AggrSpaceAfterFirstSnap
Vol. Agg. Space After 1st Snapshot
KB
VolSpaceAfterFirstSnapPct
Volume Space After 1st Snapshot %
1
AggrSpaceAfterFirstSnapPct
Vol. Agg. Spc. After 1st Snapshot %
1
SpaceGuarantee
Volume Space Guarantee
UnusedGuaranteedSpace
Volume Unused Guaranteed Space
KB
UnusedGuaranteedSpacePct
Volume Unused Guaranteed Space %
1
AggrUnusedGuaranteedSpacePct
Vol. Agg. Unused Guaranteed Space %
1
SnapshotCount
Volume Snapshot Count
NearlyNoSnapThreshold
Volume Nearly No Snapshot Threshold
1
NoSnapThreshold
Volume No Snap Threshold
1
ReserveDepletedThreshold
Volume Reserve Depleted Threshold
1
ReserveNearlyDepletedThresh
Vol. Res. Nearly Depleted Thresh.
1
PeriodBeginThis
Volume Beginning of Period This Month
PeriodEndThis
Volume End of Period This Month
DaysInCycleThis
Volume Days in Cycle This Month
AverageUsageThis
Volume Avg. Usage This Month
KB
Appendix A. Report catalogs
63
Field
Default name
AnnualRate
Volume Annual Rate/GB
MonthlyRateThis
Volume Rate/GB This Month
UsageChargeThis
Volume Usage Charge This Month
AverageAllocationThis
Volume Avg. Allocation This Month
AllocationChargeThis
Volume Allocation Charge This Month
PeriodBeginLast
Volume Beginning of Period Last Mon
PeriodEndLast
Volume End of Period Last Month
DaysInCycleLast
Volume Days in Cycle Last Month
AverageUsageLast
Volume Avg. Usage Last Month
MonthlyRateLast
Volume Rate/GB Last Month
UsageChargeLast
Volume Usage Charge Last Month
AverageAllocationLast
Volume Avg. Allocation Last Month
AllocationChargeLast
Volume Allocation Charge Last Month
FullThreshold
Volume Full Threshold
1
NearlyFullThreshold
Volume Nearly Full Threshold
1
FullThresholdInterval
Volume Full Threshold Interval
InodesUsedPct
Volume Inodes Used %
SnapHourlyCount
Hourly Retention
SnapNightlyCount
Nightly Retention
SnapWeeklyCount
Weekly Retention
SchedSnapshots
Scheduled Snapshots
SnapDirVisible
Snapshot Directory Visible
IsSecondaryVolume
Is Secondary Volume
IsSnapMirrorSource
Is SnapMirror Source
IsSnapMirrorDestination
Is SnapMirror Destination
MirrorOf
Mirror Of
MirroredTo
Mirrored To
64
IBM System Storage N series Reporting with Operations Manager
Default format
KB
th
KB
KB
1
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
© Copyright IBM Corp. 2007. All rights reserved.
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
IBM System Storage N series Reporting with Operations Manager
Index
A
Aggregate 28
B
Base Catalog 17
C
catalog 4, 6
catalog field 15
Catalog Format 4
CLI 7
comma separated values 9
Command Line Interface 3, 8–9, 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
L
-l switch 11
linked report 13
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
O
OM 6, 17
OM 3.2 2
OM Server 37–38, 43
OM server 2, 6
Operations Manager 2, 4, 7, 16, 19–20, 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, 39–40
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
H
-H switch 9
Help file 31
http
/ /OMServer
8080 16
I
IBM Redbook 1
IT 1
© Copyright IBM Corp. 2007. All rights reserved.
R
Redbooks Web site 66
Contact us viii
Related Catalogs 17
Related Catalogs Field 27
report creation 10
Reported Fields 18
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 31–32
zip file 36
68
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
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
IBM System Storage N series
Reporting with Operations Manager
Back cover
®
IBM System Storage N
series Reporting with
Operations Manager
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
Download