Previous Topic: Configuring Email Notifications upon Dashboard Message ChangeNext Topic: How to Maintain a Grid


3tsrv - CA AppLogic® Server Control Utility

This section contains the following topics:

Server Control Utility Overview

info Command (3tsrv Utility)

set Command (3tsrv Utility)

reboot Command (3tsrv Utility)

shutdown Command (3tsrv Utility)

applogic activate Command (3tsrv Utility)

applogic deactivate Command (3tsrv Utility)

applogic start Command (3tsrv Utility)

applogic stop Command (3tsrv Utility)

diskchk enable Command (3tsrv Utility)

diskchk disable Command (3tsrv Utility)

bd list Command (3tsrv Utility)

sd get Command (3tsrv Utility)

sd set Command (3tsrv Utility)

logs collect Command (3tsrv Utility)

help Command (3tsrv Utility)

Server Control Utility Overview

This section specifies the command line usage of the 3tsrv utility. 3tsrv is a utility that resides in dom0 of each server -- only grid administrators have access to this utility. This utility is used to retrieve and modify server information, and also performs useful functions such as log collection for failure analysis. The 3tsrv utility is executed with the following command line:

3tsrv command [ prop[=val] ]* [ --batch ][ --force ] 

Where

The following commands are supported:

info

Retrieve detailed server information

set

Set server information

reboot

Reboot the server

shutdown

Shutdown the server

applogic activate

Activate CA AppLogic® on the server

applogic deactivate

Deactivate CA AppLogic® on the server

applogic start

Start CA AppLogic® on the server

applogic stop

Stop CA AppLogic® on the server

diskchk enable

Enable disk failure detection on the server

diskchk disable

Disable disk failure detection on the server

bd list

List the active block devices used by CA AppLogic® on the server

sd get

Display the contents of the server data file

sd set

Update the server data file

logs collect

Collect server logs and information

help

Display help

info Command (3tsrv Utility)
Description:

Retrieve detailed information for the server

Syntax:
3tsrv info [ --batch ] 
Arguments:

None.

Note: The output of this command is here.

set Command (3tsrv Utility)
Description:

Set server information

Syntax:
3tsrv set role=primary | secondary | none [ --recover ] 
Arguments:

role

Server's HA role
If primary, specify server as the primary controller server.
If secondary, specify server as the secondary controller server.
If none, specify server to have no HA role.

Note: --recover is valid only when setting the role to primary. If specified, starts the controller on the server.

reboot Command (3tsrv Utility)
Description:

Reboot the server

Syntax:
3tsrv reboot [ --force ] 
Arguments:

None.

Note: If --force is specified, force reboot of the server (skip shutdown).

shutdown Command (3tsrv Utility)
Description:

Shutdown the server

Syntax:
3tsrv shutdown 
Arguments:

None.

applogic activate Command (3tsrv Utility)
Description:

Activate CA AppLogic® on the server

Syntax:
3tsrv applogic activate 
Arguments:

None.

Note: This command enables the CA AppLogic® service on the server.

applogic deactivate Command (3tsrv Utility)
Description:

Deactivate CA AppLogic® on the server

Syntax:
3tsrv applogic deactivate 
Arguments:

None.

Note: This command disables the CA AppLogic® service on the server.

applogic start Command (3tsrv Utility)
Description:

Start CA AppLogic® on the server

Syntax:
3tsrv applogic start 
Arguments:

None.

Note: This command starts the CA AppLogic® service on the server.

applogic stop Command (3tsrv Utility)
Description:

Stop CA AppLogic® on the server

Syntax:
3tsrv applogic stop 
Arguments:

None.

Note: This command stops the CA AppLogic® service on the server.

diskchk enable Command (3tsrv Utility)
Description:

Enable disk failure detection on the server

Syntax:
3tsrv diskchk enable 
Arguments:

None.

diskchk disable Command (3tsrv Utility)
Description:

Disable disk failure detection on the server

Syntax:
3tsrv diskchk disable 
Arguments:

None.

bd list Command (3tsrv Utility)
Description:

List the active block devices used by CA AppLogic® on the server

Syntax:
3tsrv bd list --md | --hoop | --nbd | --all [ --batch ] 
Arguments:
--md

Display active md devices used by CA AppLogic® on the server

--hoop

Display active hoop devices used by CA AppLogic® on the server

--nbd

Display active nbd devices used by CA AppLogic® on the server

--all

Display all active block devices used by CA AppLogic® on the server

Note: The output of this command is here.

Typical Output

non-batch, list md

Name      Attached Devices
-----------------------------------------
md0       hoop0, nbd0
md1       hoop1
md2       nbd2, nbd3
md10      nbd23

batch, list md

device md0   : attached_devices = "hoop0:nbd0"
device md1   : attached_devices = "hoop1"
device md2   : attached_devices = "nbd2:nbd3"
device md10  : attached_devices = "nbd23"

non-batch, list hoop

Name      Volume                                   Shared   Port
-----------------------------------------------------------------
hoop0     v-ctl-boot                               Y        63001
hoop1     v-ctl-meta                               Y        63002
hoop2     v-ctl-impex                              Y        63003
hoop21    v-07a2155b-48eb-4075-b56c-3f36157afcc7   Y        63022
hoop117   v-099c4908-d7a0-4fcd-ab3e-44caf9ab7518   N        n/a

batch, list hoop

device hoop0   : vol = v-ctl-boot, shared = y, port = 63001
device hoop1   : vol = v-ctl-meta, shared = y, port = 63002
device hoop2   : vol = v-ctl-impex, shared = y, port = 63003
device hoop21  : vol = v-07a2155b-48eb-4075-b56c-3f36157afcc7, shared = y, port = 63022
device hoop117 : vol = v-099c4908-d7a0-4fcd-ab3e-44caf9ab7518, shared = n, port = n/a

non-batch, list nbd

Name     Remote IP         Remote Port
--------------------------------------
nbd9     192.168.1.2       63006
nbd13    192.168.1.2       63027
nbd56    192.168.1.3       63027
nbd104   192.168.1.4       63104

batch, list nbd

device nbd9   : ip = 192.168.1.2, port = 63006
device nbd13  : ip = 192.168.1.2, port = 63027
device nbd56  : ip = 192.168.1.3, port = 63027
device nbd104 : ip = 192.168.1.4, port = 63104

non-batch, list all

--- md Devices ---
Name      Attached Devices
-----------------------------------------
md0       hoop0, nbd0
md1       hoop1
md2       nbd2, nbd3
md10      nbd23

--- hoop Devices ---
Name      Volume                                   Shared   Port
-----------------------------------------------------------------
hoop0     v-ctl-boot                               Y        63001
hoop1     v-ctl-meta                               Y        63002
hoop2     v-ctl-impex                              Y        63003
hoop21    v-07a2155b-48eb-4075-b56c-3f36157afcc7   Y        63022
hoop117   v-099c4908-d7a0-4fcd-ab3e-44caf9ab7518   N        n/a

--- nbd Devices ---
Name     Remote IP         Remote Port
--------------------------------------
nbd9     192.168.1.2       63006
nbd13    192.168.1.2       63027
nbd56    192.168.1.3       63027
nbd104   192.168.1.4       63104

batch, list all

device md0     : type = md, attached_devices = "hoop0:nbd0"
device md1     : type = md, attached_devices = "hoop1"
device md2     : type = md, attached_devices = "nbd2:nbd3"
device md10    : type = md, attached_devices = "nbd23"
device hoop0   : type = hoop, vol = v-ctl-boot, shared = y, port = 63001
device hoop1   : type = hoop, vol = v-ctl-meta, shared = y, port = 63002
device hoop2   : type = hoop, vol = v-ctl-impex, shared = y, port = 63003
device hoop21  : type = hoop, vol = v-07a2155b-48eb-4075-b56c-3f36157afcc7, shared = y, port = 63022
device hoop117 : type = hoop, vol = v-099c4908-d7a0-4fcd-ab3e-44caf9ab7518, shared = n, port = n/a
device nbd9    : type = nbd, ip = 192.168.1.2, port = 63006
device nbd13   : type = nbd, ip = 192.168.1.2, port = 63027
device nbd56   : type = nbd, ip = 192.168.1.3, port = 63027
device nbd104  : type = nbd, ip = 192.168.1.4, port = 63104
sd get Command (3tsrv Utility)
Description:

Display the server data file

Syntax:
3tsrv sd get 
Arguments:

None.

Notes:

Typical Output
cluster
   {
   signature = "S20080703050330522166000361146"
   }

volume boot
   {
   mirrors
      {
      mirror v-ctl-boot-14924: server = srv1, synced = 1
      mirror v-890d9dca-338b-450b-bce0-4d224fbc3ba4: server = srv2, synced = 1
      }
   }

volume meta
   {
   mirrors
      {
      mirror v-ctl-meta: server = srv1, synced = 1
      mirror v-32b6577f-6ed8-405c-9687-b19f984b0fac: server = srv2, synced = 1
      }
   }

volume impex
   {
   mirrors
      {
      mirror v-ctl-impex: server = srv1, synced = 1
      mirror v-37c7a46a-8e87-4263-b792-ec1a9f86be0b: server = srv2, synced = 1
      }
   }
sd set Command (3tsrv Utility)
Description:

Update the server data file

Syntax:
3tsrv sd set file=file 
Arguments:
file

input file used to update the server data file

Note: The server data file is a binary file that specifies on which servers the controller volume streams are located and their state (For example, ok or error). Typically, the output of sd get is redirected to a file, the file is modified, and the file is then passed to sd set.

logs collect Command (3tsrv Utility)
Description:

Collect server logs and information and save them in a tar file

Syntax:
3tsrv logs collect [ file=file ] 
Arguments:
file

name of the tar file where the server logs and other server information are stored

Notes:

Server logs and files containing server information are saved in a directory named server_name-logs and the directory is tarred. The name of the tar is specified by the file argument. If file is not specified, then the tar file is named /var/log/server_name-logs.tar.
The following logs are collected, including the rotated copies (That is, xxx.1, xxx.2, and so on):

  1. /var/log/messages
  2. /var/log/applogic
  3. /var/log/secure
  4. /var/log/xen/ (the entire directory)

The following commands are executed on the server and the returned information is stored in the following files:

  1. lspci stored in lspci.out
  2. lspci -n stored in lspci-n.out
  3. lspci -v stored in lspci-v.out
  4. lsmod stored in lsmod.out
  5. cat /proc/cpuinfo stored in cpuinfo.out
  6. cat /proc/meminfo stored in meminfo.out
  7. dmidecode stored in dmidecode.out
help Command (3tsrv Utility)
Description:

Display online help

Syntax:
3tsrv help 
Arguments:

None.

Output
3tsrv: AppLogic Server Control Utility v 1.00.00
Copyright (c) 2009 3tera, Inc. All Rights Reserved.

usage:
   help                                      -- provide more detailed help
   info [--batch]                            -- set server information
   reboot [--force]                          -- reboot server
   shutdown                                  -- shutdown server
   applogic activate                         -- activate AppLogic on server
   applogic deactivate                       -- deactivate AppLogic on server
   applogic start                            -- start AppLogic on server
   applogic stop                             -- stop AppLogic on server
   diskchk enable                            -- enable disk failure detection
   diskchk disable                           -- disable disk failure detection
   bd list --md|--hoop|--nbd|--all [--batch] -- list active block devices on server
   sd get                                    -- display server data file
   logs collect [file=file]                  -- collect server logs and information
   sd set file=<file>                        -- update server data file

====                                       
HELP
====
Description:
   Display this help.
   
Usage:
   3tsrv help

====
INFO
====
Description:
   Retrieve detailed information for the server.
   
Usage:
   3tsrv info [--batch]
   
Options:
   --batch   - display output in UDL format

======
REBOOT
======
Description:
   Reboot the server.
   
Usage:
   3tsrv reboot
   
Options:
   --force   - force reboot of the server (skip shutdown)
   
========
SHUTDOWN
========
Description:
   Shutdown the server.
   
Usage:
   3tsrv shutdown

=================
APPLOGIC ACTIVATE
=================
Description:
   Activate AppLogic on the server.
   
Usage:
   3tsrv applogic activate
   
Notes:
   This command enables the applogic service on the server.

===================
APPLOGIC DEACTIVATE
===================
Description:
   Deactivate AppLogic on the server.
   
Usage:
   3tsrv applogic deactivate
   
Notes:
   This command disables the applogic service on the server.

==============
APPLOGIC START
==============
Description:
   Start AppLogic on the server.
   
Usage:
   3tsrv applogic start
   
Notes:
   This command starts the applogic service on the server.

=============
APPLOGIC STOP
=============
Description:
   Stop AppLogic on the server.
   
Usage:
   3tsrv applogic stop
   
Notes:
   This command stops the applogic service on the server.

==============
DISKCHK ENABLE
==============
Description:
   Enable disk failure detection on the server.
   
Usage:
   3tsrv diskchk enable
   
===============
DISKCHK DISABLE
===============
Description:
   Disable disk failure detection on the server.
   
Usage:
   3tsrv diskchk disable
   
=======
BD LIST
=======
Description:
   List the block devices used by AppLogic on the server.
   
Usage:
   bd list --md | --hoop | --nbd | --all [--batch]
   
Options:
   --md     - display active md devices used by AppLogic on the server
   --hoop   - display active hoop devices used by AppLogic on the server
   --nbd    - display active nbd devices used by AppLogic on the server 
   --all    - display all active block devices used by AppLogic on the server
   
======
SD GET
======
Description:
   Display the server data file.
   
Usage:
   3tsrv sd get
   
Notes:
   The server data file is a binary file that specifies on which servers the
   controller volume streams are located and their state (e.g., ok or error).
   

======
SD SET
======
Description:
   Update the server data file.
   
Usage:
   3tsrv sd set file=<file>
   
Options:
   <file>   - input file used to update the server data file
   
Notes:
   The server data file is a binary file that specifies on which servers the
   controller volume streams are located and their state (e.g., ok or error).
   
   Typically, the output of 'sd get' is redirected to a file, the file is modified,
   and the file is then passed to sdset.

   
============
LOGS COLLECT
============
Description:
   Collect server logs and information.
   
Usage:
   3tsrv logs collect [ file=<file> ]
   
Options:
   <file>   - name of the tar file where the server logs and other server
              information are stored
   
Notes:
   Server logs and files containing server information are saved in a directory
   named <server name>-logs and the directory is tarred.  The name of the tar is
   specified by the <file> argument.  If <file> is not specified, then the tar
   file is named /var/log/<server name>-logs.tar=.
   
   The following logs are collected, including the rotated copies (i.e., xxx.1,
   xxx.2, etc):
   - /var/log/messages
   - /var/log/applogic
   - /var/log/secure
   - /var/log/xen/ (the entire directory)
   
   The following commands are executed on the server and the returned
   information is stored in the following files:
   - 'lspci' stored in lspci.out
   - 'lspci -n' stored in lspci-n.out
   - 'lspci -v' stored in lspci-v.out
   - 'lsmod' stored in lsmod.out
   - 'cat /proc/cpuinfo' stored in cpuinfo.out
   - 'cat /proc/meminfo' stored in meminfo.out
   - 'dmidecode' stored in dmidecode.out