<!--Arbortext, Inc., 1988-2008, v.4002-->
<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD SolBook 3.5//EN" [
<!ENTITY options-common SYSTEM "options-common.sgm">
<!ENTITY synopsis-common SYSTEM "synopsis-common.sgm">
<!ENTITY % commonents SYSTEM "common.ent">
%commonents;
]>
<?Pub UDT _bookmark _target>
<?Pub EntList bull rArr sect>
<?Pub Inc>
<refentry id="generate-diagnostic-report-1"><?Pub Tag atict:info tracking="off"
ref="2"><?Pub Tag atict:user user="hl34125" fullname=""><?Pub Tag atict:user
user="pmdavies" fullname=""><?Pub Tag atict:user user="ah95648" fullname="">
<!-- @(#)generate-diagnostic-report.1 1.10 07/07/27 SMI; -->
<refmeta><refentrytitle>generate-diagnostic-report</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">30 Jan 2007</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&software;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">Copyright (c) 2007, Sun Microsystems, Inc.
All Rights Reserved</refmiscinfo>
</refmeta>
<refnamediv><indexterm><primary>generate-diagnostic-report</primary></indexterm>
<indexterm><primary>generates reports that can help diagnose malfunctioning</primary>
</indexterm>
<refname>generate-diagnostic-report</refname><refpurpose>generates reports
that can help diagnose malfunctioning</refpurpose></refnamediv>
<refsynopsisdiv><title></title>
<synopsis><command>generate-diagnostic-report </command>  <option
role="double-dash">outputfile</option> <replaceable>jar_file_name</replaceable>&synopsis-common;
 [<option role="double-dash">local</option>=<replaceable>false</replaceable>] [<option
role="double-dash">file</option> <replaceable>filename</replaceable>]
 [<option role="double-dash">bugids</option><replaceable> bugids</replaceable>] [<option
role="double-dash">logstartdate</option><replaceable> start-date</replaceable>]
 [<option role="double-dash">logenddate</option><replaceable> end-date</replaceable>] [<option
role="double-dash">targetdir</option><replaceable> local_dir_path</replaceable>]
 <replaceable>target</replaceable></synopsis>
</refsynopsisdiv>
<refsect1 role="description"><title></title>
<para>The <command>generate-diagnostic-report</command> command generates
an HTML report that contains pointers or navigational links to installation
details such as configuration details, HADB information, logging details,
process specific information, for an instan<?Pub Caret>ce. If report generation
is targeted for a domain, data is collected for all instances belonging to
the domain and is stored on DAS. Such data may help diagnose malfunctioning
such as exceptions, performance bottlenecks, and unexpected results. This
command is supported in remote and local mode. In local mode, reports can
be generated for a DAS, a server instance, or a node agent. In remote mode,
this command can generate reports for all the targets supported by the local
mode and for the entire domain or a cluster. </para>
</refsect1>
<refsect1 role="options"><title></title>
<variablelist termlength="medium">
<varlistentry><term><option role="double-dash">outputfile</option></term>
<listitem><para>Absolute path to the filename on the client machine. The filename
must end with a .jar extension. This option is mandatory in both the local
and remote mode.</para>
</listitem>
</varlistentry>&options-common;
<varlistentry><term><option role="double-dash">file</option></term>
<listitem><para>A text file describing customer's information such as customer
name, customer point of contact, error description. Contents of this file
are appended to the diagnostic report. </para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">bugids</option></term>
<listitem><para>One or more IDs of known bugs similar to customer issue, separated
by comma. </para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">logstartdate</option></term>
<listitem><para>Use the mm/dd/yy format to specify the date from which <filename>
server.log</filename> files for server instances are captured (if log rotation
is enabled). If the date is not specified, number of entries from <filename>server.log
</filename> file as specified by <literal>max-no-of-entries</literal> matching <literal>
min-log-level</literal> in diagnostic service are collected.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">logenddate</option></term>
<listitem><para>Date in mm/dd/yy format. If specified, takes precedence over <literal>
max-no-of-entries</literal> from diagnostic-service configuration.If you specify
a <option role="double-dash">logenddate</option>, you will need to specify
a <option role="double-dash">logstartdate</option> also. If specified, entries
between <option role="double-dash">logstartdate</option> and <option
role="double-dash">logenddate</option> matching <literal>min-log-level</literal> are
captured. If this option is not specified, <literal>max-no-of-entries</literal> from
diagnostic-service is used to limit the <filename>server.log</filename> content
being captured.</para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">local</option></term>
<listitem><para>If set to true, the <command>generate-diagnostic-report</command> command
runs in local mode and collects a limited set of information. When the command
is run locally for a domain, data for the default server instance, that is,
the DAS for the domain, is collected. In local mode, this command can generate
report for a DAS, a server instance, or a node agent. </para>
</listitem>
</varlistentry>
<varlistentry><term><option role="double-dash">targetdir</option></term>
<listitem><para>This option is required only if the command is run locally.
If target is a domain name, this value is parent directory of the domain upon
which the command will operate. This is a mandatory field in local mode.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="operands"><title></title>
<variablelist termlength="medium">
<varlistentry><term>target: </term>
<listitem><para>allowed values are domain, cluster, nodeagent, and instance. </para>
<itemizedlist>
<listitem><para>domain: generates report for all clustered and non clustered
instances administered by the DAS, including default admin server instance.
 This command when executed locally, collects information for default server
instance only. </para></listitem>
<listitem><para>cluster: generates report for every server instance in the
cluster.</para></listitem>
<listitem><para>instance: generates report for a particular server instance.</para>
</listitem>
<listitem><para>nodeagent: generates reports for all server instances associated
with a specific node agent. </para></listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="examples"><title></title>
<example><title>Using the generate-diagnostic-report command (remote mode)</title>
<screen>asadmin> <userinput>generate-diagnostic-report
 --user admin --port 4848 
--outputfile /export/software/sjsas/diagnostic-reports/domain1.jar domain1

</userinput>
Please enter the admin password>
Following attributes from domain.xml are masked with **** in the generated report.
domain/configs/config=server-config/jms-service/jms-host=default_JMS_host/admin-password="admin"
If you want to mask additional properties, use create-password-alias and set com
mand before continuing the report generation.
Press 'y' to continue or 'n' to exit : y
Command generate-diagnostic-report executed successfully.

</screen>
</example>
<example><title>Using the generate-diagnostic-report command (local mode)</title>
<screen>asadmin> <userinput>asadmin generate-diagnostic-report --user admin 
--local=true --outputfile /export/software/sjsas/diagnostic-reports/domain1.jar 
--targetdir /export/software/sjsas/domains domain1

</userinput>
Following attributes from domain.xml are masked with **** in the generated report. 
domain/configs/config=server-config/jms-service/jms-host=default_JMS_host/admin-
password="admin"
If you want to mask additional properties, use create-password-alias and set com
mand before continuing the report generation.
Press 'y' to continue or 'n' to exit : y
Report File : /export/software/sjsas/diagnostic-reports/domain1.jar
Command generate-diagnostic-report executed successfully.</screen>
</example>
</refsect1>
<refsect1 role="exit-status"><title></title>
<variablelist termlength="medium">
<varlistentry><term>0</term>
<listitem><para>command executed successfully</para>
</listitem>
</varlistentry>
<varlistentry><term>1</term>
<listitem><para>error in executing the command</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
