snap Command

Purpose

Gathers system configuration information.

Syntax

snap [-@] [ -a ] [-z "product_name=prd_name,..." | "class=myclass,.." | ALL] [-M Timeout][ -A ] [ -b ] [ -B ] [ -c ] [ -C ] [ -D ] [ -f ] [ -F] [ -g ] [ -G ] [ -i ] [ -k ] [ -l ] [ -L ][ -n ] [ -N ] [ -p ] [ -r ] [ -R ] [ -s ] [ -S ] [ -t ] [ -T Filename ][-u user1,...] [ -w ] [ -X ] [ -Y ][ -o OutputDevice ] [ -d Dir ] [ -v Component ] [ -O FileSplitSize ] [ -P Files ] [ script1 script2 ... | All | file:filepath ] [-U]

snap -e [ -m Nodelist ] [ -d Dir ]

snap -z ADD ["product_name=prod_name" "class=myclass" "command_path=/tmp/myprod_myscript -a"]

snap -z DELETE ["product_name=prod_name" ]

Description

Use the snap -o /dev/rfd0 command to copy the compressed image to diskette. Use the snap -o /dev/rmt0 command to copy the image to tape.

The snap -g command gathers general system information, including the following:

• Error report
• Copy of the customized Object Data Manager (ODM) database
• Trace file
• User environment
• Amount of physical memory and paging space
• Device and attribute information
• Security user information
• Configuration and tuning parameter information of the system

The output of the snap -g command is written to the /tmp/ibmsupt/general/general.snap file.

The snap command checks for available space in the /tmp/ibmsupt directory, the default directory for snap command output. You can write the output to another directory by using the -d flag. If there is not enough space to hold the snap command output, you must expand the file system.

Each execution of the snap command appends information to previously created files. Use the -r flag to remove previously gathered and saved information.

Flags

Parameters

Arguments

Names of third-party scripts to be executed are specified as parameters to snap. A parameter can be a single word or a list of words enclosed in quotes. When parameters are enclosed in quotes, the first parameter in the list represents the name of the script and the subsequent words represent the arguments to pass to the script.

When All is specified as a parameter, all the scripts in the script repository are executed. No script parameters may be passed in this case.

If the file: keyword is used and is immediately followed by a path to a file, that file is read to get the scripts to execute. Each line in the file represents a script and optional parameters to the script .

snap Scripts

A third-party script must be executable in /usr/lib/ras/snapscripts, and must follow the guidelines described below. When called during pass 1, a script must return its size estimation to snap. In pass 2, it collects the data and saves it as specified by snap.

The script must read and utilize the following environment variables, SNAPDIR, PASSNO, SCRIPTSIZE and SCRIPTLOG.

The scripts or commands can also use SNAPDEBUGDATA variable to learn about the debug data collected by snap script. This variable has comma separated name of the products for which the snap command collects the data during execution.

All output files must be written to $SNAPDIR. This is the directory where the script should be saving its output. The PASSNO variable contains the snap phase during which the script is called. During the first pass, the script should calculate a size estimation for the data it will write during the second pass. It will then write that numeric estimation to the file pointed to by $SCRIPTSIZE. The value saved to the file should be in decimal. snap passes the path to a log file where all debug data for the script should be saved. Standard out and standard error should not be redirected by the script, because snap will save standard out and standard error to $SNAPDIR/ScriptName.out and $SNAPDIR/ScriptName.err, respectively.

#!/usr/bin/ksh


if [ "$PASSNO" = 1 ]
then
         (( size=99999 ))
        .... 
        # this is where code to do the size estimation should go.
        ....
        echo $size > $SCRIPTSIZE

else if [ "$PASSNO" = 2 ]
then
        # debug information should go to $SCRIPTLOG
        echo "Debug Data" >> $SCRIPTLOG

        # .....where the work to collect the data takes place
        # ...

        # The data collected should be written to $SNAPDIR        .
        touch $SNAPDIR/foo_output1
        touch $SNAPDIR/foo_output2
fi
fi

Splitting of snap Output

If it is split, snap output might look like the following:

% ls -l
total 112048
-rw-r--r--   1 lmic     adm         6291456 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xaa
-rw-r--r--   1 lmic     adm         6291456 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xab
-rw-r--r--   1 lmic     adm         6291456 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xac
-rw-r--r--   1 lmic     adm         6291456 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xad
-rw-r--r--   1 lmic     adm         6291456 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xae
-rw-r--r--   1 lmic     adm         6291456 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xaf
-rw-r--r--   1 lmic     adm         6291456 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xag
-rw-r--r--   1 lmic     adm         6291456 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xah
-rw-r--r--   1 lmic     adm         6291456 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xai
-rw-r--r--   1 lmic     adm          744518 Nov 26 09:56 snap.hastings.112603095649.pax.Z.xaj

Executing Third Party Scripts

An external product debug data collection command or script is a standalone executable. The script is registered with the snap framework before it can be used to collect user defined debug data. These scripts can be de-registered as per user discretion.

Following is the ODM class defined in the system.

#define DEFAULTSIZE 256
#define DATA_VALUESIZE 1024

class snap_config {
        char product_name[DEFAULTSIZE]; key
        char class[DEFAULTSIZE];key
        char command_path[DATA_VALUESIZE];
        vchar sc_reserved1[DATA_VALUESIZE];
        vchar sc_reserved2[DATA_VALUESIZE];
}

Registration of Third Party Debug Script with Snap framework

Deregistration of Third party debug scripts from Snap framework

Examples

1. Enter the following command to gather all system configuration information:

   snap -a

   The output of this command is written to the /tmp/ibmsupt directory.
2. Enter the following command to create a pax image of all files contained in the /tmp/ibmsupt directory:

   snap -c

3. Enter the following command to gather general system configuration information, including the output of the lslpp -hac command:

   snap -g -o /dev/rfd0

   Output is written to the /tmp/ibmsupt/general/lslpp.hac and /tmp/ibmsupt/general/general.snap files. This command also writes the system information to a removable diskette.
4. Enter the following command to gather HACMP specific information from nodes node1 and node2 belonging to a single cluster:

   snap -e -m node1,node2

   Output is written to the /tmp/ibmsupt/hacmp directory.
5. To run the scripts foo1, foo2 and foo3. where foo1 takes no argument, foo2 takes three arguments and foo3 takes one argument, type the following:

   snap  foo1 "foo2 -x -y 3" "foo3 6"

   Output is written to /tmp/ibmsupt/snapscripts/foo1, /tmp/ibmsupt/snapscripts/foo2 and /tmp/ibmsupt/snapscripts/foo3 assuming the destination directory is the default, /tmp/ibmsupt.
6. To specify the All parameter to run all the scripts, type:

   snap All

   Note: No parameters are passed in this case.
7. To specify the path to a file containing the name and optional parameter list of scripts to execute, type:

   snap file:/tmp/scriptnames

   A sample input file to execute the scripts from example 5:

   foo1 
   foo2 -x -y 3
   foo6

8. If splitting of the snap output into 4MB files is desired, type:

   snap -a -c -O 4

9. To submit only the HACMP snap -e data from nodes node1 and node2, enter the following command:

   snap -e -m node1,node2
   snap -c

   Submit the <pax.z> file to IBM according to the instructions of the service representative.

10. To submit all of the snap data from nodes node1 and node2, enter the following commands:

    snap -e -m node1,node2
    snap -a
    snap -c 

    Submit the <pax.z> file to IBM according to the instructions of the service representative.

11. To register a debug script present in the /usr/lpp/abc/debug_abc directory of product abc, in class storage enter the following command:

    snap –z ADD "product_name=abc" "class=storage" "command_path=/usr/lpp/abc/debug_abc –a"

12. To deregister a debug script of product abc, enter the following command:

    snap –z DELETE "product_name=abc"

13. To gather debug data of multiple products, enter the following command:

    snap –z "product_name=abc, product_name=def"

Files