Rechercher une page de manuel

Maui::Client.3pm

Langue: en

Version: 2002-12-19 (mandriva - 01/05/08)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME
SYNOPSIS
METHODS
AUTHOR
SEE ALSO
POD ERRORS

NAME

Maui::Client - Client interface to Maui scehduler

SYNOPSIS

   use Maui::Client;
 
   my $client = new Maui::Client(   PeerAddr   => "localhost",
                                    PeerPort   => 42559,
                                    ClientName => "test",
                                    Cksum_Seed => 123456,
                                    Mode       => "raw",
                                    Auth       => "maui" ) ||  die "Can't connect to server \n";
 
 
   my ($sc, $responce) = $client->showq( );
   print "sc = $sc\n";
   print $responce;
 
   my ($sc, $responce) = $client->showres( );
   print "sc = $sc\n";
   print $responce;
 
 
   my ($sc, $responce) = $client->setres( UserList => "auser", StartTime => "+".24*3600,
                                          Duration => 9*3600, ResourceExp => "TASKS==2" );
   print "sc = $sc\n";
   print $responce;

METHODS

Each of the following methods take a combination of required and optional arguments. All of these arguments are passed as a series of named pairs. For example:

canceljob ( JobIDs => jobid [, jobid,...] )

Cancels the specified jobs. This command can be run by any Maui Scheduler Administrator and the owner of the job.

parameters:

JobIDs list of jobs to cancel

changeparam ( Parameter => parameter, Value => value )

The changeparam command is used to dynamically change the value of any parameter which can be specified in the maui.cfg file. The changes take affect at the beginning of the next scheduling iteration. They are not persistent, only lasting until Maui is shutdown. This command can be run by any user with 'ADMIN1' authority.

parameters:

Parameter is any valid Maui parameter
Value is any valid value for <PARAMETER>

checkjob ( JobID => jobid [, OPTIONS] )

Display detailed job state information and diagnostic output for specified job. This command can be run by any Maui admininstrator. Additionally, valid users may use this command to obtain information about their own jobs.

parameters:

JobID job to check

optional parameters:

PolicyLevel Off || Soft || Hard
Verbose 0 || 1
ReservationList

checknode ( NodeID => nodeid )

Displays state information and statistics for the specified node. This command can be run by any Maui Scheduler Administrator.

parameters:

NodeID node to check

diagnose ( ObjectType => type [,OPTIONS] )

The diagnose command is used to display information about various aspects of scheduling and the results of internal diagnostic tests

parameters:

ObjectType FairShare || Job || Node || Partition || Priority || Queue || QOS || Reservation || User || Group || Account || Class

jobctl ( JobID => jobid, Mode => mode )

Modify attributes or perform operation on a specified job This command can be run by any Maui administrator or by the owner of the specified job.

parameters:

JobID job
Mode Cancel || Suspend

metactl ( Mode => mode, Args => args )

parameters:

Mode Commit || List || Modify || Remove || Submit || Set || Query
Args

migratejob ( JobID => jobid, Server => server )

parameters:

JobID job
Server

nodectl ( Mode => mode, Args => args, NodeIDs => nodeids )

Modify attributes or perform operation on a specified nodes This command can be run by any Maui administrator or by the owner of the specified nodes.

parameters:

Mode Create || Destroy || Modify
Args
NodeiIDs

query ( Args => args )

parameters:

Args

releasedeadline ( JobID => jobid )

parameters:

JobID job

releasehold ( JobID => jobid [, Holdtype => holdtype ])

Release hold on specified job(s). This command can be run by any Maui Scheduler Administrator.

parameters:

JobID job

optional parameters:

HoldType User || System || Batch || All

releaseres ( ResID => resid )

Modify attributes or perform operation on a specified nodes This command can be run by any Maui administrator or by the owner of the specified nodes.

parameters:

ResID

resetstats ( )

Modify attributes or perform operation on a specified nodes

This command can be run by any Maui administrator or by the owner of the specified nodes.

parameters:

NONE

runjob ( JobID => jobid, NodeList => nodelist, Mode => mode [, OPTIONS] )

Immediately run the specified job.

This command can be run by any Maui administrator.

parameters:

JobID job to runA
NodeList Attempt to start the job using the specified nodelist where nodenames are comma or colon delimited
Mode CLEAR || BLOCK || FORCE || FORCE2

schedctl ( Mode => mode, Arg => arg )

The 'schedctl' command controls various aspects of scheduling behavior. It is used to manage scheduling activity, kill the scheduler, and create resource trace files

parameters:

Mode Submit || Kill || List || Modify || NodeTable || Resume || Reconfig || Stop || Step
Arg

setdeadline ( JobID => jobid, Deadline => deadline )

parameters:

JobID job
Deadline

sethold ( JobID => jobid [, Holdtype => holdtype ])

Set hold on specified job(s).

This command can be run by any Maui Scheduler Administrator.

parameters:

JobID job to hold

optional parameters:

HoldType

setqos ( JobID => jobid, QOS => qos )

Set Quality Of Service for a specified job.

This command can be run by any user.

parameters:

JobID job number
QOS Quality Of Service level. Range is 0 (lowest) to 8 (highest)

head2 setspri ( JobID => jobid, Priority => priority, [,Mode => mode] )

Set or remove and absolute or relative system priority on a specified job.

This command can be run by any Maui Scheduler Administrator.

parameters:

JobID job number
Priority System priority level. Range is 0 to clear, 1 for lowest, 1000 for highest.

optional parameters:

Mode> Relative || Absolute

head2 setupri ( JobID => jobid, Priority => priority, [,Mode => mode] )

parameters:

JobID job
Priority priority

optional parameters:

Mode> Relative ||

head2 setres ( AccountList => accountlist, Duration => duration, Name => name,
               ResourceExp => resourceexp, Starttime => starttime
               [,ChargeSpec => chargespec] [, ClassList => classlist] [,Featurelist => featurelist ]
               [,Flags => flags ] [,GroupList => grouplist ] [,Partition => partition ]
               [, ResourceDes => resourcedes ] [, QOSList => qoslist ] [, UserList => userlist ] )

Reserve resources for use by jobs with particular credentials or attributes.

This command can be run by level 1 and level 2 Maui administrators.

parameters:

AccountList List of accounts that will be allowed access to the reserved resources
Duration Duration of the reservation
Name Name for new reservation
ResourceExp Specifies the tasks to reserve. ALL indicates all resources available should be reserved.
StartTime Absolute or relative time reservation will start

optional parameters:

ChargeSpec Specifies which credentials will be accountable for unused resources
ClassList List of classes that will be allowed access to the reserved resource
FeatureList List of node features which must be possessed by the reserved resources
Flags List of reservation flags
GroupList List of groups that will be allowed access to the reserved resources
Partition Partition in which resources must be located
ResourceDes Specifies the resources to be reserved per task. (-1 indicates all resources on node)
QOSList List of QOS's that will be allowed access to the reserved resource
UserListList of users that will be allowed access to the reserved resources

head2 showbf ( Duration NodeCount ProcCount Dmemory, BfMode
UserName, Group, Account Partition,Memory, Class Feature QOS Verbose)

Shows what resources are available for immediate use.

This command can be run by any user.

optional parameters:

Account Account name

Class Class/queue required.

Duration Time duration

FeatureList =back

head2 showconfig ( [Verbose => 0 || 1 ] )

View the current configurable parameters of the Maui Scheduler.

This command can be run by a level 1, 2, or 3 Maui administrator.

optional parameters:

Verbose 0 || 1 Turns on verbose mode

head2 showdeadline ( JobId => jobid )

parameters:

JobId job identifier

showgrid ( StatisticType => type )

Shows table of various scheduler statistics. This command can be run by any Maui Scheduler Administrator.

parameters:

StatisticType is one of AVGBYPASS || AVGQTIME || AVGXFACTOR || BFCOUNT || BFNHRUN || JOBCOUNT || JOBEFFICIENCY || MAXBYPASS || MAXXFACTOR || NHREQUEST || NHRUN || QOSDELIVERED || WCACCURACY

head2 showhold ( )

parameters:

NONE

head2 showq ( [QueueMode => 0, Partition => partition] )

Shows information about running, idle, and non-queued jobs.

This command can be run by any user. However, the QueueMode options can only be used by Maui Scheduler Administrator

optional parameters:

QueueMode 0
Partition

head2 showres ( [, ResID => resid ] [, Partition => partition ] [, Grep => 0 || 1 ]
[, Relative => 0 || 1] [, Summary => 0 || 1] [, Verbose => 0 || 1 ] )

show detailed reservation information

This command can be run by any Maui administrator, or by any valid user if the parameter RESCTLPOLICY is set to ANY

optional parameters:

ResID ID of reservation of interest else 'ALL'
Grep 0 || 1 show 'grep'-able output with nodename on every line
Relative 0 || 1 display reservation timeframes in relative time mode
Summary 0 || 1 display summary reservation information
Partition partition of interest
Verbose 0 || 1 verbose output

head2 showstart ( JobId => jobid )

parameters:

JobID

head2 showstate ( )

Summarizes the state of the system.

This command can be run by any Maui Scheduler Administrator.

parameters:

NONE

head2 showstats ( ObjectType => 'Account' || 'Group' || 'Node' || 'Scheduler' || 'User'
[, ObjectID => objectid] [, Partition => partition] [, Verbose => 0 || 1 ] )

Show resource usage statistics

This command can be run by any Maui level 1, 2, or 3 Administrator.

parameters:

ObjectType Account || Group || Node || Scheduler || User

optional parameters:

ObjectID id of object
Partition partition of interest
Verbose 0 || 1 Turn on verbose output

AUTHOR

Alex Martin <a.j.martin@qmul.ac.uk>

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 475:: You forgot a '=back' before '=head3'
Around line 512:: =back without =over

Linux Certif

Toute la documentation sur la certification Linux LPI

Rechercher une page de manuel

Maui::Client.3pm

Sommaire

NAME

SYNOPSIS

METHODS

AUTHOR

SEE ALSO

POD ERRORS

Découvrir

Apprendre

Linux Certif

Toute la documentation sur la certification Linux LPI

Rechercher une page de manuel

Maui::Client.3pm

Sommaire

NAME

SYNOPSIS

METHODS

AUTHOR

SEE ALSO

POD ERRORS

Découvrir

Apprendre

Partager