NAME

XAS::Lib::Batch::Queue - A class for the XAS environment

SYNOPSIS

 use XAS::Lib::Batch::Queue;

 my $queue = XAS::Lib::Batch::Queue->new();

 $queue->qstop(-queue => 'batch');

 ...

 $queue->qstart(-queue => 'batch');

DESCRIPTION

This module provides an interface for manipulating queues in a Batch System. Each available method is a wrapper around a given command. A command line is built, executed, and the return code is checked. If the return code is non-zero an exception is thrown. The exception will include the return code and the first line from stderr.

Since each method is a wrapper, there is a corresponding man page for the actual command. They should also be checked when problems arise.

METHODS

new

This method initializes the module and takes these parameters:

-interface

The command line interface to use. This defaults to XAS::Lib::Batch::Interface::Torque.

qstat(...)

This method returns that status of a queue. This status will be a hash reference of the parsed output on stdout. It takes the following parameters:

-queue

The name of the queue.

-host

The optional host that the queue may be on.

qstart(...)

This method start a queue. It takes the following parameters:

-queue

The name of the queue.

-host

The optional host that the queue may be on.

qstop(...)

This method will stop a queue. It takes the following parameters:

-queue

The name of the queue.

-host

The optional host that the queue may be on.

SEE ALSO

XAS::Lib::Batch
XAS

AUTHOR

Kevin L. Esteb, <kevin@kesteb.us>

COPYRIGHT AND LICENSE

Copyright (c) 2012-2015 Kevin L. Esteb

This is free software; you can redistribute it and/or modify it under the terms of the Artistic License 2.0. For details, see the full text of the license at http://www.perlfoundation.org/artistic_license_2_0.