Note: This web site is only kept up to date for OSG Software 1.2 (VDT 2.0.0). If you are looking for information for the most recent release, the RPM-based OSG Software 3.0, please see the OSG documentation web site

NAME

vdt-control - Enable and disable VDT services

SYNOPSIS

    vdt-control [options] [service-name(s)]
                --on
                --off
                --force
                --no-start
                --non-root
                --service-priority
                --help
    Note: The optional service name(s) only apply to --on and --off.

    OR

    vdt-control --list [service-name(s)]

    OR

    vdt-control --enable/--disable service-name(s)

DESCRIPTION

This program is used to enable and disable services installed by the VDT. Enable means to install-it at the system-wide level, and possibly start the service. Specifically, enable means:

  For init services:   Install into /etc/init.d and start service
  For cron jobs:       Install into crontab
  For xinetd services: Install into /etc/services and /etc/xinetd and 
                       restart xinetd

To disable a service means to reverse the above operation:

  For init services:   Stop service and remove from /etc/init.d
  For cron jobs:       Remove from crontab
  For xinetd services: Remove from /etc/services and /etc/xinetd

After you have installed the VDT as root, you usually want to run "vdt-control --on" to get everything installed and running. If you ever need to shut down the VDT, a good way to do it is to run "vdt-control --off".

Most people do not need the --no-start option. It modifies the operation of --on in the following ways:

  For init services:   Install into /etc/init.d but do not start service
  For xinetd services: Install into /etc/services and /etc/xinetd, but do
                       not restart xinetd.
  

OPTIONS

--on

If no service names are provided, attempt to enable all services that should be enabled. If one or more service names are provided, then just attempt to enable those services. Note that if the desired state is marked as "disable", --on will not turn it on, even if it is explicitly listed. To enable a service, use vdt-register-service.

--off

If no service names are provided, attempt to disable all services that have been installed. If one or more service names are provide, then only disable those services.

--force

In some cases, you cannot enable a service with --on because it may appear to conflict with an existing service on your computer that is not provided by the VDT. Using the --force option will enable it even if it does conflict with another service.

--no-start

For init services, do not start the service. For xinetd service, do not restart xinetd. This is not usually an option you need to use, except in rare circumstances. If you are unsure if you should use it, you probably shouldn't.

--non-root

When supplying --on or --off as a non-root user, this option must be supplied.

--service-priority

This option will modify the priority an xinetd service is started at. The value is the nice level, it must be an integer. By default, the globus-gatekeeper service is started at nice level 20 - all other services are started with no nice level supplied.

--list

List all of the services that have been installed as part of the VDT, and their desired state (enabled or disabled). Note that this does not reflect the current state (whether or not a service is actually enabled), but the desired state. If you ran "vdt-control --off" (to turn off all services) followed by "vdt-control --on" (to enable services that should be enabled), the output of --list should match what is enabled and disabled, excepting any errors that occur.

--enable

Set the desired state of the listed service(s) to be enabled.

--disable

Set the desired state of the listed service(s) to be disabled.

--help

Show brief explanatory text for using vdt-control

Exit codes

0 - The script completed with no errors

1 - The script failed to do anything useful. This will be returned for errors such as bad command-line options or failing to load the services information from disk.

2 - The script had one or more problems modifying services, but may have also successfully modified some services. This code can be returned when the --enable, --disable, --on, or --off flags are provided.

3 - The script was unable to start one or more enabled services because the user is not the root user. Currently inetd services cannot be started as non-root. This exit code is superceded by exit code 2 if both errors occur.

SEE ALSO

vdt-register-service