| Current File : //usr/man/man1m/sdci.1m |
.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "sdci 1m"
.TH sdci 1m "14 Jun 2016" "RDA 8.12" "Oracle Support Tools Commands"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
sdci \- Support Diagnostic Command\-line Interface (SDCI)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& sdci.sh [\-bilnqvy] [\-X pkg|\-M|\-V] [\-e edt] [\-s nam] [\-t lvl] [\-u lng]
\& [fct arg...]
\&
\& sdci.cmd [\-bilnqvy] [\-X pkg|\-M|\-V] [\-e edt] [\-s nam] [\-t lvl] [\-u lng]
\& [fct arg...]
\&
\& sdci.pl [\-bilnqvy] [\-X pkg|\-M|\-V] [\-e edt] [\-s nam] [\-t lvl] [\-u lng]
\& [fct arg...]
.Ve
.PP
See the following sections for additional information about the switches.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1SDCI\s0 is a command-line tool to manage Oracle diagnostic data collectors and,
more particularly, the Remote Diagnostic Agent (\s-1RDA\s0).
.PP
The purpose of \s-1RDA\s0 is to assist in problem analysis and troubleshooting of
local and remote databases, file systems, and operating system environments in
relation to Oracle products. This tool helps automate the task of gathering
information about an Oracle environment for the Oracle Support and Development
teams and customers to analyze the Oracle technology stacks quickly.
.PP
For example, if a customer has problems with Oracle Net, then Oracle Support
may want to view the configuration files and the environment related to the
problems. This can include information about the operating system, database,
and file system. The \s-1RDA\s0 Development team adds content to the tool regularly
to gather information about more products.
.PP
You can run \s-1RDA\s0 concurrently as long as each execution refers to a different
setup file. You can share the same report directory if you specify different
report groups during the setup phase. However, usually the compiled versions of
the \s-1RDA\s0 engine do not allow concurrent executions.
.PP
For more information about this tool, or to download the latest version, see
My Oracle Support documents 314422.1 and 330363.1.
.SH "COMMAND VARIANTS"
.IX Header "COMMAND VARIANTS"
.IP "\fIsdci.sh\fR" 10
.IX Item "sdci.sh"
\&\s-1UNIX\s0 shell \s-1SDCI\s0 launcher, which attempts to locate Perl in the Oracle home
directory structure when it is not available in the \f(CW\*(C`PATH\*(C'\fR environment
variable.
.IP "\fIsdci.cmd\fR" 10
.IX Item "sdci.cmd"
Microsoft \s-1SDCI\s0 launcher, which attempts to locate Perl in the Oracle home
directory structure.
.IP "\fIsdci.com\fR" 10
.IX Item "sdci.com"
\&\s-1VMS\s0 \s-1SDCI\s0 launcher, which checks the user environment and locates Perl and Zip.
.IP "\fIsdci.pl\fR" 10
.IX Item "sdci.pl"
\&\s-1SDCI\s0 main script, which can be used directly if Perl is available in the
\&\f(CW\*(C`PATH\*(C'\fR environment variable (for \s-1UNIX\s0) or if the \f(CW\*(C`.pl\*(C'\fR suffix is registered
(for Windows).
.SH "OPTIONS"
.IX Header "OPTIONS"
.SS "Mode Options"
.IX Subsection "Mode Options"
.IP "\fB\-M\fR" 4
.IX Item "-M"
Displays the command manual pages.
.IP "\fB\-V\fR" 4
.IX Item "-V"
Displays the software and engine builds.
.IP "\fB\-X pkg\fR" 4
.IX Item "-X pkg"
Invokes the specified user interface. The default user interface is \f(CW\*(C`Rda\*(C'\fR.
.SS "Modifiers"
.IX Subsection "Modifiers"
.IP "\fB\-b\fR" 8
.IX Item "-b"
Does not back up the setup file. By default, \s-1SDCI\s0 renames the setup file with a
\&\f(CW\*(C`.bak\*(C'\fR suffix before rewriting the file.
.IP "\fB\-e key=value[,...]\fR" 8
.IX Item "-e key=value[,...]"
Specifies a temporary value for one or more settings. \s-1SDCI\s0 converts the setting
names automatically to upper case and separates the different assignments by
commas.
.Sp
For example, the following value enables some ping tests and allows a maximum
of 120 seconds for executing each \s-1SQL\s0 request.
.Sp
.Vb 1
\& \-e OS.NET.B_PING_TESTS=1,DFT/N_SQL_TIMEOUT=120
.Ve
.Sp
You can use this mechanism also to alter the default setting values when making
non-interactive setups.
.IP "\fB\-h\fR" 8
.IX Item "-h"
Displays the command usage and exits.
.IP "\fB\-i\fR" 8
.IX Item "-i"
Reads settings from the standard input. Therefore, this option suppresses all
interactive dialogues in setup and all user acknowledge requests in the data
collection or tests.
.IP "\fB\-l\fR" 8
.IX Item "-l"
Uses a lock file to prevent concurrent usage of a setup file. \s-1RDA\s0 derives the
name of the lock file from the setup file name. \s-1RDA\s0 generates an error if the
lock cannot be acquired immediately.
.IP "\fB\-n\fR" 8
.IX Item "-n"
Ignores the content of any existing setup file. This option enables you to
start a new collection without any manual operation on existing setup files.
.IP "\fB\-q\fR" 8
.IX Item "-q"
Sets the quiet mode.
.IP "\fB\-s nam\fR" 8
.IX Item "-s nam"
Specifies the name of the setup file (\fIoutput\fR by default). You can maintain
multiple setup configurations in the same directory structure. The name of the
setup file can contain a directory part. That directory must exist and will
be used as the default location for other files (such as lock files and the
report directory).
.IP "\fB\-u lng\fR" 8
.IX Item "-u lng"
Specifies the language and the character set to use for the engine error
messages and texts. For example,
.Sp
.Vb 1
\& \-l es.88591
.Ve
.Sp
gives the preference to Spanish when available. \s-1SDCI\s0 will encode them with the
\&\s-1ISO\s0 8859\-P1 character set.
.IP "\fB\-v\fR" 8
.IX Item "-v"
Sets the verbose mode.
.IP "\fB\-y\fR" 8
.IX Item "-y"
Accepts all setting defaults in the module configuration. This option
suppresses all interactive dialogues in setup and all user acknowledge requests
in the data collection or tests.
.SS "Debugging Options"
.IX Subsection "Debugging Options"
.IP "\fB\-t lvl\fR" 8
.IX Item "-t lvl"
Enables \s-1RDA\s0 tracing and specifies the global trace level. The trace level is an
integer number between 0 and 99. The upper digit is dedicated to the agent
operations, while the lower digit is more used by the functional layers.
.Sp
Specialized dump and trace mechanisms requires the presence of this option,
regardless its value.
.SH "SPECIAL USAGE"
.IX Header "SPECIAL USAGE"
The mode flags are exclusive.
.PP
By default, \s-1SDCI\s0 creates collector definition files and their corresponding
diagnostic data directories in the current working directory. The name of the
diagnostic data directory is derived from the collector name. Use the \fB\-s\fR
option or the \f(CW\*(C`RDA_SETUP\*(C'\fR environment variable to store them in another
directory.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
The following environment variables influence the execution of \s-1RDA:\s0
.IP "\s-1COLUMNS\s0" 13
.IX Item "COLUMNS"
Used to adjust the page width when displaying manual pages (78 by default).
.IP "\s-1HOME\s0" 13
.IX Item "HOME"
User home directory.
.IP "\s-1ORACLE_BASE\s0" 13
.IX Item "ORACLE_BASE"
Oracle base directory.
.IP "\s-1ORACLE_HOME\s0" 13
.IX Item "ORACLE_HOME"
Oracle home directory.
.IP "\s-1ORACLE_SID\s0" 13
.IX Item "ORACLE_SID"
Oracle system identifier.
.IP "\s-1PAGER\s0" 13
.IX Item "PAGER"
Pager that \s-1RDA\s0 uses to display the manual pages. \s-1RDA\s0 uses \fImore\fR by default.
.IP "\s-1PATH\s0" 13
.IX Item "PATH"
Command execution path.
.IP "\s-1RDA_BUNDLE\s0" 13
.IX Item "RDA_BUNDLE"
Path of a complementary \s-1XML\s0 conversion bundle definition file (none by
default). \s-1SDCI\s0 ignores the environment variable when the corresponding file
does not exist or cannot be read.
.IP "\s-1RDA_CHARSET\s0" 13
.IX Item "RDA_CHARSET"
Character set to use when displaying engine message (\f(CW\*(C`utf8\*(C'\fR by default)
.IP "\s-1RDA_CONVERT\s0" 13
.IX Item "RDA_CONVERT"
Alternative location for the \s-1XML\s0 conversion plug-in directory structure
(\fIConvert\fR by default).
.IP "\s-1RDA_CWD\s0" 13
.IX Item "RDA_CWD"
Alternative working directory for the setup files or for relative paths to
setup files. When you do not specify this variable, \s-1RDA\s0 uses the current
working directory.
.IP "\s-1RDA_DOMAIN\s0" 13
.IX Item "RDA_DOMAIN"
Default domain name used to bypass the domain detection. \s-1RDA\s0 performs this
detection at setup when the domain name is not available from the setup file
and not included in the host name.
.IP "\s-1RDA_EDIT\s0" 13
.IX Item "RDA_EDIT"
Specifies a temporary value for one or more settings as for the \fB\-e\fR option.
.IP "\s-1RDA_FILTER\s0" 13
.IX Item "RDA_FILTER"
Filter definition file to load when creating a new setup file.
.IP "\s-1RDA_LANG\s0" 13
.IX Item "RDA_LANG"
Preferred language to use by the engine (\f(CW\*(C`en\*(C'\fR by default).
.IP "\s-1RDA_LEVEL\s0" 13
.IX Item "RDA_LEVEL"
Sets the global trace level.
.IP "\s-1RDA_LOCK\s0" 13
.IX Item "RDA_LOCK"
Directory where the \s-1RDA\s0 lock files are stored. By default, they are stored in
the directory that contains the setup file.
.IP "\s-1RDA_MAN\s0" 13
.IX Item "RDA_MAN"
When specified, it does not use \f(CW\*(C`Pod::Text\*(C'\fR to display manual pages.
.IP "\s-1RDA_MRC\s0" 13
.IX Item "RDA_MRC"
Path of a complementary multi-run collection definition file. \s-1RDA\s0 ignores the
environment variable when the corresponding file does not exist or cannot be
read.
.IP "\s-1RDA_NO_7ZIP\s0" 13
.IX Item "RDA_NO_7ZIP"
When specified, it disables the search and the use of the \fI7zip\fR command.
.IP "\s-1RDA_NO_COMPRESS\s0" 13
.IX Item "RDA_NO_COMPRESS"
When specified, it disables the search and the use of the \fIcompress\fR command.
.IP "\s-1RDA_NO_DBD_ORACLE\s0" 13
.IX Item "RDA_NO_DBD_ORACLE"
When set to a nonzero value, disables the usage of \f(CW\*(C`DBD::Oracle\*(C'\fR. The command
wrappers do not verify that Perl can load this package without errors when a
value is set.
.IP "\s-1RDA_NO_GZIP\s0" 13
.IX Item "RDA_NO_GZIP"
When specified, it disables the search and the use of the \fIgzip\fR command.
.IP "\s-1RDA_NO_JAR\s0" 13
.IX Item "RDA_NO_JAR"
When specified, it disables the search and the use of the \fIjar\fR command.
.IP "\s-1RDA_NO_PAX\s0" 13
.IX Item "RDA_NO_PAX"
When specified, it disables the search and the use of the \fIpax\fR command.
.IP "\s-1RDA_NO_TAR\s0" 13
.IX Item "RDA_NO_TAR"
When specified, it disables the search and the use of the \fItar\fR command.
.IP "\s-1RDA_NO_ZIP\s0" 13
.IX Item "RDA_NO_ZIP"
When specified, it disables the search and the use of the \fIzip\fR command.
.IP "\s-1RDA_PID\s0" 13
.IX Item "RDA_PID"
Directory where the control files for the background collection are stored.
By default, they are stored in the directory that contains the setup file.
.IP "\s-1RDA_PROFILE\s0" 13
.IX Item "RDA_PROFILE"
Path of a complementary profile definition file. \s-1RDA\s0 ignores the
environment variable when the corresponding file does not exist or cannot be
read.
.IP "\s-1RDA_SETUP\s0" 13
.IX Item "RDA_SETUP"
Specifies the setup name to be used when the \fB\-s\fR option is not specified. The
name can contain a directory part. That directory must exist and is used as a
default location for other files (such as the lock files and the report
directory).
.IP "\s-1SHELL\s0" 13
.IX Item "SHELL"
For \s-1UNIX\s0, the command interpreter (shell) to use.
.IP "\s-1TERM\s0" 13
.IX Item "TERM"
Terminal name. When supported by the platform, it identifies the escape
sequences used for controlling the display.
.SH "FILES"
.IX Header "FILES"
For \s-1UNIX\s0, \fIsdci.sh\fR or \fIrda.sh\fR creates a \fI.config\fR file to cache where Perl
is located in the Oracle home directory structure.
.PP
\&\s-1RDA\s0 collects execution events and statistics in an \fI\s-1RDA\s0.log\fR file in the data
diagnostic data directory. Use this file to retrieve the execution history. For
security reasons, it does not contain any setting or command arguments. The
report packages contain the \fI\s-1RDA\s0.log\fR file to identify further product
improvements.
.PP
The \s-1RDA\s0 engine can create three lock files. The names are derived from the
setup file name:
.IP "\fI<setup>.lck\fR" 16
.IX Item "<setup>.lck"
To avoid concurrent usage of a setup file (see options \fB\-B\fR and \fB\-l\fR)
.IP "\fI\-B\-<setup>.lck\fR" 16
.IX Item "-B-<setup>.lck"
To serialize file manipulation tasks between foreground and background \s-1RDA\s0
processes.
.IP "\fI\-T\-<setup>.lck\fR" 16
.IX Item "-T-<setup>.lck"
To monitor thread execution completion.
.PP
The \f(CW\*(C`RDA_LOCK\*(C'\fR environment variable influences the location of the lock files.
.SH "PERL PACKAGES USED"
.IX Header "PERL PACKAGES USED"
An \s-1RDA\s0 data collection explicitly calls the following Perl packages:
.IP "o \fIstrict\fR" 2
.IX Item "o strict"
.PD 0
.IP "o \fIvars\fR" 2
.IX Item "o vars"
.IP "o \fICwd\fR" 2
.IX Item "o Cwd"
.IP "o \fIExporter\fR" 2
.IX Item "o Exporter"
.IP "o \fIFile::Basename\fR" 2
.IX Item "o File::Basename"
.IP "o \fIFile::Copy\fR" 2
.IX Item "o File::Copy"
.IP "o \fIFile::Spec\fR" 2
.IX Item "o File::Spec"
.IP "o \fIGetopt::Std\fR" 2
.IX Item "o Getopt::Std"
.IP "o \fIIO::File\fR" 2
.IX Item "o IO::File"
.IP "o \fIIO::Handle\fR" 2
.IX Item "o IO::Handle"
.IP "o \fI\s-1POSIX\s0\fR" 2
.IX Item "o POSIX"
.IP "o \fISocket\fR" 2
.IX Item "o Socket"
.IP "o \fISymbol\fR" 2
.IX Item "o Symbol"
.IP "o \fITime::Local\fR" 2
.IX Item "o Time::Local"
.PD
.PP
The following packages are used but they are not required for the data
collection:
.IP "o \fICompress::Zlib\fR (used for accessing archives)" 2
.IX Item "o Compress::Zlib (used for accessing archives)"
.PD 0
.IP "o \fI\s-1DBD::ODBC\s0\fR (used for alternative \s-1ODBC\s0 accesses)" 2
.IX Item "o DBD::ODBC (used for alternative ODBC accesses)"
.IP "o \fIDBD::Oracle\fR (used for alternative accesses to Oracle databases)" 2
.IX Item "o DBD::Oracle (used for alternative accesses to Oracle databases)"
.IP "o \fI\s-1DBI\s0\fR (used for alternative database accesses)" 2
.IX Item "o DBI (used for alternative database accesses)"
.IP "o \fIDigest::MD5\fR (used for check sums)" 2
.IX Item "o Digest::MD5 (used for check sums)"
.IP "o \fIFcntl\fR (used in locking context)" 2
.IX Item "o Fcntl (used in locking context)"
.IP "o \fISys::Hostname\fR (used as help for determining the domain name)" 2
.IX Item "o Sys::Hostname (used as help for determining the domain name)"
.IP "o \fITerm::Cap\fR (used to enhance the display)" 2
.IX Item "o Term::Cap (used to enhance the display)"
.IP "o \fITime::HiRes\fR (used for clock checks)" 2
.IX Item "o Time::HiRes (used for clock checks)"
.IP "o \fIWin32\fR (used for spawning processes)" 2
.IX Item "o Win32 (used for spawning processes)"
.IP "o \fIWin32::Console\fR (used for disabling echo)" 2
.IX Item "o Win32::Console (used for disabling echo)"
.IP "o \fIWin32::ODBC\fR (used for \s-1ODBC\s0 accesses)" 2
.IX Item "o Win32::ODBC (used for ODBC accesses)"
.IP "o \fIWin32::Process\fR (used for spawning processes)" 2
.IX Item "o Win32::Process (used for spawning processes)"
.PD
.SH "COPYRIGHT NOTICE"
.IX Header "COPYRIGHT NOTICE"
Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.
.SH "TRADEMARK NOTICE"
.IX Header "TRADEMARK NOTICE"
Oracle and Java are registered trademarks of Oracle and/or its
affiliates. Other names may be trademarks of their respective owners.