NAME
mxreport - add, delete, run, list reports and report categories in
Systems Insight Manager
SYNOPSIS
mxreport -a -f fully-qualified-file-name
mxreport -d existing-report-name
mxreport -r existing-report-category-name
mxreport -c -f fully-qualified-file-name
mxreport [-x HTML|XML|CSV] [-o fully-qualified-file-name] -e existing-
report-name
mxreport [-b languageencoding] [-n validreportorcategoryname] -l-x [
report|category ]
DESCRIPTION
The mxreport command allows a Systems Insight Manager user with
sufficient privilege to run reports, and to add, delete, and list
reports and report categories in Systems Insight Manager.
The mxreport -a form of this command allows the user to add a report.
The information regarding the report is provided in a report
definition file (see mxreport(4)) and allows the user to add one or
more Systems Insight Manager reports.
During an add operation, Systems Insight Manager only adds reports
whose names do not reference reports currently in the Systems Insight
Manager repository. If Systems Insight Manager detects a duplicate
report, Systems Insight Manager will skip the duplicate report, but
continue to add all non-duplicate reports. Skipping duplicate reports
in this case does not affect the exit code.
The mxreport -d form of the command allows the user to delete a
Systems Insight Manager report. The user must specify the name of an
existing report to delete. The user must either be the report's owner
or be a full rights user to delete a report.
The mxreport -r form of the command allows users to remove a Systems
Insight Manager report category. Only a full rights user or the report
owner may remove a report category. The user is notified if the user
specifies a report category name that does not exist in Systems
Insight Manager.
The mxreport -c form of the command allows users to create a new
report category. The category is defined in an XML file. The user must
have REPORT_MODIFICATION_PRIVILEGE privilege in order to create a new
report category.
The mxreport -e form of the command is used to run a pre-defined
report. The report name is a mandatory argument. The "-x" flag
specifies the generated report file output format. The default output
type is XML. The optional "-o" flag specifies the output file path.
Without the "-o" option, output will be displayed on the console. The
user must have REPORT_VIEW_SECURED_DATA_PRIVILEGE privilege in order
to generate a report that contains License information.
The mxreport -l -x form of the command is used to list the attributes
of a pre-defined report or report category by passing a report name or
category name. The "-b" flag is used to specify the language encoding
for the XML file. The "-x" flag is used to specify whether to list a
report or a category. The default is "report". The "-n" flag specifies
the report name or category name to list. If "-n" is not specified
with "-l -x report", a list of all pre-defined reports will be
displayed. If "-n" is not specified with "-l -x category", a list of
all existing categories will be displayed.
Options
mxreport recognizes the following options:
-a -f Indicates that one or more Systems Insight Manager
reports, specified in a report definition file,
are to be added.
-d Indicates that the named Systems Insight Manager
report is to be removed.
-r Indicates that the specified Systems Insight
Manager report category is to be removed.
-c -f Indicates that the category specified in the file
is to be added.
-e Indicates that the specified Systems Insight
Manager report is to be run.
-x Indicates the output type (HTML, XML, or CSV) for
the "-e" option.
-o Indicates an output file for the "-e" option.
-l -x Indicates that all pre-defined report names are to
be listed.
report Indicates that all pre-defined report names are to
be listed for the "-l -x" option.
category Indicates that all pre-defined report category
names are to be listed for the "-l -x" option.
category Indicates that all pre-defined report category
names are to be listed for the "-l -x" option.
-b Indicates the language encoding for reports and
report categories to be listed for the "-l -x"
option.
-n Indicates the name of an existing report or report
category to be listed for the "-l -x" option.
reportname Specifies the name of a Systems Insight Manager
report. Specification of an invalid report name
results in an invalid name exit code.
categoryname Specifies the name of a Systems Insight Manager
report category. Specification of an invalid
report category name results in an invalid name
exit code.
EXTERNAL INFLUENCES
For HP-UX or Linux, LANG determines the default encoding that the
system will use to output XML data if no encoding is specified on the
command line. If LANG is not specified or null or LANG does not
correspond to a recognized encoding, it defaults to C (see lang (5)).
In this case, the user should use the -b option to specify the desired
encoding of the XML data.
RETURN VALUE
mxreport returns one of the following values:
0 Successful completion.
1 Command completed with an error.
2 Specified command arguments constituted bad usage.
3 Specified command is either not found or has been
disabled for remote execution.
4 User/client does not have sufficient privileges to
execute the given command.
5 Command has been terminated abnormally by a third
party.
6 No valid licenses exist for the command.
7 Command has not completed execution.
8 Security token was not valid.
9 SessionID was invalid. Can only be returned from
status() calls.
EXAMPLES
This command adds the reports defined in the Systems Insight Manager
report definition file "/home/user1/defs/myreportdef".
mxreport -a -f /home/user1/defs/myreportdef
This command deletes the Systems Insight Manager report called
"Inventory - Third Floor Servers".
mxreport -d Inventory - Third Floor Servers
This command deletes the Systems Insight Manager report category
called "Old Array Controllers".
mxreport -r Old Array Controllers
This command created the Systems Insight Manager report category
specified in the file "/home/user1/defs/myreportcatdef".
mxreport -c -f /home/user1/defs/myreportcatdef
This command runs the report named "Catapult Launchers" and formats
the output as CSV.
mxreport -e Catapult Launchers -x CSV
This command lists all reports.
mxreport -l -x report
This command lists the contents of the report named "Islands of
Phoenix".
mxreport -l -x report -n Islands of Phoenix
This command lists all report categories.
mxreport -l -x category
This command lists the contents of the report category named "White
Noise".
mxreport -l -x category -n White Noise
LIMITATIONS
This command may only be run on the CMS.
AUTHOR
mxreport was developed by the Hewlett-Packard Company.
SEE ALSO for HP-UX
mxauth(1M) mxreport(4).
SEE ALSO for Linux
mxauth(8) mxreport(4).