McIDAS-XCD Administrator's Guide
Version 2010.1

[Search Manual] [Table of Contents] [Go to Previous] [Go to Next]


xcdadmin

Unix command for managing the XCD status and the log file.


Formats

xcdadmin start
xcdadmin stop
xcdadmin status
xcdadmin statdisp
xcdadmin log flag


Parameters

start

starts XCD in a background mcenv session

stop

kills any background XCD sessions

status

prints XCD status (on or off) as well as useful statistics including XCD version, log file location, data directory, disk space usage, and processor load averages

statdisp 

runs the statdisp program

log

accesses the log file, performing the action specified in flag

flag

-f

follows the log file (using tail -f)

 

-l

prints the contents of the XCD log file (default)

 

-r

rotates the log file, creating a new xcd.log file named xcd.log.mondd_hhmm_GMT

 

-t

prints the current time, disk usage, and load averages to the log file


Remarks

The Configurable Options section of the xcdadmin script appears in the box below. It contains variables that change its behavior. These variables must be reviewed before using the script. In particular, the xcd_data_path variable must be set.

#=========================================================
# Configurable Options:
#
# The variables in this section hold information that is
# subject to varying McIDAS-XCD configurations.  Please
# check the values of each of these variables and make
# any necessary changes to accommodate your system's
# configuration.  Note: The value of 'xcd_data_path'
# must be modified in order for the xcdadmin script to
# work.

xcd_admin="oper"
xcd_admin_home="/home/oper"
xcd_admin_profile="$xcd_admin_home/.profile"

# The 'xcd_data_path' holds the fully qualified path to
# the directory in which XCD data will be written. This
# variable must be changed for the 'xcdadmin' script to
# work.

xcd_data_path="Insert path to XCD data directory here"

# The 'xcd_log_file' variable holds the fully qualified path
# to the file in which output from 'startxcd' is written.
# This file must be writable by the McIDAS-XCD admin
# account. It is advisable to set up a daily cron job which
# calls 'xcdadmin log -r' to rotate the log file. Otherwise
# it is possible for the log file to grow until it fills the
# disk.

xcd_log_file=$xcd_admin_home/xcd.log

# The 'seconds_to_wait' variable holds the number of
# seconds to wait for data monitors to exit gracefully
# before a 'kill' command is used.  It is beneficial to
# wait for data monitors to exit on their own accord
# because data can be lost if/when 'kill' is used.

seconds_to_wait=30

# The 'statdisp_refresh' variable holds the refresh rate
# in seconds for the statdisp window.

statdisp_refresh=5

# Number of old log files to keep on disk. When
# 'xcdadmin log -r' is called the name of the current log
# file is appended with the current date and time, e.g.
# xcd.log.Apr12_1200_GMT and a new log file 'xcd.log' is
# created.  Then the number of old log files is checked
# and if it exceeds 'num_logs_to_save' then the older
# log files will be deleted.  For example; If you rotate
# the logs daily then setting 'num_logs_to_save' to 7
# results in saving one week's worth of log files in
# addition to the current log file on disk.

num_logs_to_save=7

#=========================================================

 


Examples

xcdadmin status

This entry prints XCD status (on or off) as well as useful statistics including XCD version, log file location, data directory, disk space usage, and processor load averages.

xcdadmin log  -t

This entry prints the current time, disk usage, and load averages to the log file.


[Search Manual] [Table of Contents] [Go to Previous] [Go to Next]