1 Oracle Services Tools Bundle Overview

The Oracle Services Tools Bundle (STB) is a self-extracting installer bundle that supports all Solaris standard operating systems and architectures, enabling customers to get the most from their Oracle Premier Support plans.

With Oracle STB, you can realize the following key benefits:

  • Expedites problem diagnosis and resolution.

  • Proactive prevention.

  • Easy installation of all the latest tools.

This chapter covers the following topics:

1.1 Oracle STB Components

Each release of Oracle STB includes the latest versions of the component parts that make up STB. Each component is specifically designed to analyze or gather information for efficient problem resolution. A component can group more than one product. For example, the Oracle Explorer Data Collector groups the Explorer and the Remote Diagnostic Agent (RDA) products.

  • Oracle Explorer Data Collector

    The Oracle Explorer Data Collector is a collection of shell scripts and a few binary executables that gathers information and creates a detailed snapshot of a system's configuration and state. See Chapter 2, "Oracle Explorer Data Collector," for details.

  • Oracle Remote Diagnostic Agent (RDA)

    RDA is a command-line diagnostic platform that is executed by an engine written in the Perl programming language. It provides a unified package of support diagnostics tools and preventive solutions. The data captured provides a comprehensive picture of the your environment, which aids in problem diagnosis.

    See the RDA Getting Started Guide (Doc ID 314422.1) in My Oracle Support for details:

    https://support.oracle.com
    
  • Oracle Serial Number in EEPROM (SNEEP)

    Oracle Serial Number in EEPROM (SNEEP) provides a software-accessible Chassis Serial Number (CSN) for all Oracle Solaris hardware platforms. See Chapter 3, "Oracle SNEEP," for details.

  • Other STB components

    Depending on the specific architecture and version of the target system, other components for STB may be included, such as:

    • Oracle Autonomous Crashdump Tool (ACT)

      Oracle ACT is an extension to mdb(1) which creates a readable summary of a Solaris kernel crash dump. It will automatically process in the background any new kernel crash dump it finds on reboot after a system panic.

      See Oracle Autonomous Crashdump Tool (ACT) (Doc ID 1438006.1) in My Oracle Support for more information:

      https://support.oracle.com
      
    • Oracle Service Tags.

1.2 Download and Install Oracle Services Tools Bundle

Oracle Services Tools Bundle is available as a single installer bundle from My Oracle Support.

https://support.oracle.com

Note:

A login is required for accessing content on My Oracle Support.

To install the Oracle Services Tools Bundle:

  1. Download and unzip the Oracle Services Tools Bundle from Doc ID 1153444.1. The latest available version of Oracle STB provides for:

    • Oracle Solaris: 8, 9, 10, 11 Express, and 11

      • Includes both 32-bit and 64-bit

        Note:

        To determine if your version of Oracle Solaris is 32 or 64 bit, run:
        example% isainfo -v
        

        Output will look like:

        64-bit sparcv9 applications
        32-bit sparc applications
        

        To determine the kernel modules, run:

        example% isainfo -vk
        

        Output will look like:

        64-bit sparcv9 kernel modules
        
    • SPARC and x86 infrastructure

  2. Log in as root.

  3. Make sure the install script is executable:

    chmod +x install_stb.sh
    
  4. Run the following command:

    ./install_stb.sh -verbose
    

You will be asked to choose between I(install), X(extract), or E(exit). Choose the I(install) option. The installer will transparently install:

  • On Oracle Solaris 11 Express, 11, or higher:

    • RDA and Explorer via an image package system (IPS) package with the following command as a leading part of the Fault Management Resource Identifier (FMRI):

      pkg://solaris/support/explorer
      

      The software locations are /usr/lib/explorer for the Explorer part and /usr/lib/rda for the RDA part. Three symbolic links are created:

      • From /usr/sbin/explorer to /usr/lib/explorer/bin/explorer

      • From /usr/bin/rda to /usr/lib/rda/rda.sh

      • From /usr/bin/sdci to /usr/lib/rda/sdci.sh

    • SNEEP via an IPS package with the following command as leading part of the FMRI.

      pkg://solaris/support/sneep
      

      The software location is the /usr/lib/sneep directory. A symbolic link is created from /usr/sbin/sneep to /usr/lib/sneep/bin/sneep.

    • ACT via the IPS package with the following command as leading part of the FMRI.

      pkg://solaris/support/act
      

      The software location is the /usr/lib/act directory.

  • On Oracle Solaris 8, 9, and 10:

    Note:

    When installing via IPS, the software is always installed in the default directories. When installing via SVR4, you can modify the location of the installation directory by installing the packages manually via pkgadd.
    • Explorer and RDA via the packages SUNWexplo, SUNWexplu, and SUNWrda. The default software locations are the /opt/SUNWexplo, /etc/opt/SUNWexplo, and /usr/lib/rda directories.

    • SNEEP via the package SUNWsneep. The standard software location is the /opt/SUNWsneep directory.

    • ACT is shipped via the CTEact package. The standard software location is the /opt/CTEact directory.

Depending on your software installation preferences, you have several options for installing the Oracle Explorer Data Collector, including:

1.2.1 Non-Global Zone Installation

Beginning with Oracle Solaris 10, non-global zones are supported. However, Oracle Explorer, ACT, and RDA can only be installed in the global zone. SNEEP can be installed in a non-global zone.

1.2.2 Using the STB_INST_PATH Environment Variable

To install the software packages, the install_stb.sh installation script will extract the software archive. By default, it uses the /tmp/STBinstall directory. You can specify an alternative extraction directory by setting the STB_INST_PATH environment variable, in which case the $STB_INST_PATH/tmp/STBinstall directory will be used as the extraction directory.

Note:

The extracted software archive will be deleted after the execution of the install_stb.sh script. You can indicate that you want to keep the extraction archive by setting the environment variable STB_INST_KEEP to 1.

1.2.3 Command Line Interface Options of the Oracle STB Installer

The following command options are available to the Oracle STB installation script:

install_stb.sh [-verbose] [-trace]
install_stb.sh -version
install_stb.sh -V
install_stb.sh -help
install_stb.sh -runmode manual [-force] [-trace] [-verbose]
install_stb.sh -runmode auto [-force] [-trace] [-verbose]
install_stb.sh -runmode auto -ext [architecture,version] [-trace] [-verbose]

Where:

  • -verbose will make the STB installer more verbose. This option is highly recommended.

  • -version displays the README.txt file. The README.txt file contains release and build information on the STB components.

  • -V displays release and build of STB.

  • -help displays the online help man pages for STB.

  • -runmode manual runs STB in manual mode (default)

  • -runmode auto installs packages in auto/non-interactive mode

  • -runmode auto -ext extracts packages for the current or the specified architecture and operating system version combination (for example, Solaris 9 on SPARC or Solaris 11 on x86)

  • -trace will run the STB installer, which is a shell script, in trace mode. This option is mainly used for debugging purposes.

Notes:

  • When installing via the install_stb.sh script, all relevant products for this platform will be considered for installation/upgrade.

  • When you specify the -force option on Solaris 8, 9, and 10, STB will always uninstall the currently installed SVR4 packages and install the bundled versions. Without the -force option, the SVR4 packages will only be uninstalled if the SVR4 package in the extraction archive is more recent than the installed SVR4 package.

1.2.4 Extracting Packages

To extract individual packages from the Oracle STB software bundle:

  1. Log in as root.

  2. Make sure the install script is executable:

    chmod +x install_stb.sh
    
  3. Run ./install_stb.sh -verbose

  4. Choose X(extract), and the packages specific for the current architecture and OS version will be extracted.

    By default the /var/tmp/stb/extract directory will be used but you can use the STB_EXT_PATH environment variable to change this destination. In this case, the software will be extracted to the $STB_EXT_PATH/stb/extract directory.

    • For Solaris 11 or later, a file-based IPS repository will be extracted, which contains the IPS packages for RDA/Explorer, SNEEP, and ACT. On top of this, one package stream containing a Service Tag package is extracted.

    • For Solaris 8, 9, and 10 systems:

      SVR4 package streams will be extracted. For example, you will find /var/tmp/stb/extract/Explorer/SUNW.<version>.pkg (RDA is considered as part of the Explorer distribution).

When using the command-line options, it is possible to specify an alternative extraction platform. For example, you can extract the SVR4 package streams for a SPARC Solaris 10 system on a Solaris 11 system.

1.2.5 IPS Actions, Triggered by STB Installation

For systems running Solaris 11 or later, most installation tasks are done through the Image Packaging System (IPS). The steps taken for IPS are:

  • Publish the file-based IPS repository, extracted from the install_stb.sh script. Run:

    pkg set-publisher –g <ips repository> solaris
    
  • For software that is in IPS format, the installer will launch:

    ips install <software>
    
  • When all the software is installed, the file-based repository is unpublished with:

    pkg set-publisher –G <ips-repository> solaris
    

Note:

The individual IPS actions can take time, which might give the impression that the STB installer on Solaris 11 is slow or even hanging.