Icon

This is the documentation for an older version of Qube. The latest version of the documentation can be found here: Qube

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Administrative Description | Usage | Options | Examples | Notes | See also

Excerpt
hiddentrue

administrative command used to control qube

.

Anchor_TOC77670_TOC77670Usage
qbadmin mode

Description

qbadmin provides command-line administration of various aspects Qube.

Usage 

qbadmin mode [options]

where mode is either supervisor, worker or worker.
Anchor_TOC77742_TOC77742Description
Qbadmin is a special command to allow command line administration of Qube.
Anchor_TOC77829_TOC77829Example
Tell the Supervisor to stop tracking host machine01:
% qbadmin worker --remove machine01
Anchor_TOC77926_TOC77926local.

mode may be shortened to s, w, or l

Options

Flag

Description

mode: supervisor

 

--list

List all Supervisor hosts.

--backup

Backups all of the supervisor's data.

--find

Auto-detects all available supervisors.

--configuration

Display the configuration for the Supervisor.

-set reject_submit-set stop_activity

Set Supervisor mode

-unset reject_submit-unset stop_activity

Unsets Supervisor mode

--resource

Display the current state of all global resources.

--globalcallback language triggers code

Submit a globalcallback language is: "perl", "python", or "qube" triggers are callback trigger events code is source code for callback

--emailtest

Send a test email via SMTP using qb.conf settings.

mode: worker

 

--remove string

Remove and ban Worker list string

--reboot string…

Reboot Worker list string

--shutdown string…

Shutdown Worker list string

--refresh

Force the Supervisor to re-detect all of its workers.

--clearbanned

Clear all workers from the "banned" list.

--reconfigure

Push out new configuration to the workers.

--configuration string

Display the configuration for the Worker string

--assignments string

Query the Worker string directly for jobs it is currently working on.

--help

Command help

--version

Command version

Notes

The user must have either of the following qube admin privileges to use this command.

Refer to User Permissions or qbusers for more detail on the Qube! permission scheme

Examples

Tell the Supervisor to re-read the qbwrk.conf and signal the workers to request a new remote configuration from the Supervisor:

% qbadmin worker --reconfigure

Tell the Supervisor to stop tracking host machine01:

% qbadmin w --remove machine01

Test the supervisor's mail configuration:

% qbadmin supervisor --emailtest

Display the supervisor's running configuration:

% qbadmin s --config

See also