|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JGDIRemoteBase
Base interface for the JGDIRemote.
add qquota functions
, optional ??add qstat functions
, optional ??add qhost functions
, optional ??add qmod functions
Method Summary | |
---|---|
void |
cleanQueues(java.lang.String[] queues)
Cleans queue from jobs which haven't been reaped. |
void |
clearJobs(java.lang.String[] jobs,
boolean force)
Clears the error state of the specified jobs(s). |
void |
clearQueues(java.lang.String[] queues,
boolean force)
Clears the error state of the specified queues(s). |
void |
clearShareTreeUsage()
Clears all user and project usage from the sharetree. |
void |
close()
Close the JGDI object. |
void |
disableQueues(java.lang.String[] queues,
boolean force)
Disable queue(s), i.e. |
void |
enableQueues(java.lang.String[] queues,
boolean force)
Enable queue(s). |
QHostResult |
execQHost(QHostOptions options)
Get summary information about cluster hosts. |
java.lang.String |
getActQMaster()
Get the hostname of the current qmaster |
java.lang.String |
getAdminUser()
Get the admin user |
java.util.List |
getClusterQueueSummary(ClusterQueueSummaryOptions options)
Get summary information about cluster queues. |
QQuotaResult |
getQQuota(QQuotaOptions options)
Get the limit information. |
QueueInstanceSummaryResult |
getQueueInstanceSummary(QueueInstanceSummaryOptions options)
Get summary information abouter queue instances. |
java.util.List |
getRealExecHostList()
Get the list of real exec hosts (excludes "template" and "global"). |
java.lang.String |
getSchedulerHost()
Return the host where the Sun™ Grid Engine scheduler sge_schedd(8) is active or null otherwise |
java.lang.String |
getSGECell()
Get the cell of the grid engine |
java.io.File |
getSGERoot()
Get the root directory of the grid engine installation |
void |
killAllEventClients()
Used to shutdown event clients all registered at qmaster(8). |
void |
killAllExecds(boolean terminateJobs)
Send all execution hosts a kill signal. |
void |
killEventClients(int[] ids)
Used to shutdown event clients registered at qmaster(8), except special clients like the sge_schedd(8) |
void |
killExecd(java.lang.String[] hosts,
boolean terminateJobs)
Send some execution hosts a kill signal. |
void |
killMaster()
Send the qmaster a kill signal. |
void |
killScheduler()
Send the schedduler a kill signal. |
void |
rescheduleJobs(java.lang.String[] jobs,
boolean force)
If applied to running jobs, reschedules the jobs. |
void |
rescheduleQueues(java.lang.String[] queues,
boolean force)
Reschedules all jobs currently running in the queue(s). |
void |
suspendJobs(java.lang.String[] jobs,
boolean force)
Suspends job(s). |
void |
suspendQueues(java.lang.String[] queues,
boolean force)
Suspend the queues and any jobs which might be active. |
void |
triggerSchedulerMonitoring()
The Sun™ Grid Engine scheduler sge_schedd(8) is forced to print trace messages of its next scheduling run to the file <sge_root>/<cell>/common/schedd_runlog. |
void |
unsuspendJobs(java.lang.String[] jobs,
boolean force)
Unsuspends the job(s). |
void |
unsuspendQueues(java.lang.String[] queues,
boolean force)
Unsuspends the queues and any jobs which might be active. |
Method Detail |
---|
java.lang.String getAdminUser() throws java.rmi.RemoteException
java.rmi.RemoteException
- on any error on the GDI layerjava.io.File getSGERoot() throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.String getSGECell() throws java.rmi.RemoteException
java.rmi.RemoteException
java.lang.String getActQMaster() throws java.rmi.RemoteException
java.rmi.RemoteException
- on any error on the GDI layervoid close() throws java.rmi.RemoteException
JGDI
object. After calling this method
the JGDI
is not longer useable.
java.rmi.RemoteException
- on any error on the GDI layerjava.util.List getRealExecHostList() throws java.rmi.RemoteException
java.rmi.RemoteException
QHostResult execQHost(QHostOptions options) throws java.rmi.RemoteException
qhost
(see man qhost(1)).
options
- host summary options
QHostResult
object which the host summary information
java.rmi.RemoteException
- on any error in the GDI layerjava.util.List getClusterQueueSummary(ClusterQueueSummaryOptions options) throws java.rmi.RemoteException
qstat -g c
(see man qstat(1)).
options
- options the cluster queue summary algorithm
java.rmi.RemoteException
- on any error in the GDI layerQueueInstanceSummaryResult getQueueInstanceSummary(QueueInstanceSummaryOptions options) throws java.rmi.RemoteException
qstat
(see man qstat(1)).
options
- Options for the queue instance summary algorithm
java.rmi.RemoteException
- on any error in the GDI layerQQuotaResult getQQuota(QQuotaOptions options) throws java.rmi.RemoteException
qquota
(see man qquota(1)).
options
- the options for the qquota algorithm
QQuotaResult
instances
java.rmi.RemoteException
void clearShareTreeUsage() throws java.rmi.RemoteException
Clears all user and project usage from the sharetree. All usage will be initialized back to zero.
The CLI equivialent for this method is qconf -clearusage
(see man qconf(1)).
java.rmi.RemoteException
void cleanQueues(java.lang.String[] queues) throws java.rmi.RemoteException
Cleans queue from jobs which haven't been reaped. Primarily for development purpose. Requires root/manager/operator privileges.
The CLI equivialent for this method is qconf -kcq
(see man qconf(1)).
queues
- a wild card queue list
java.rmi.RemoteException
- on any error on the GDI layervoid killMaster() throws java.rmi.RemoteException
The CLI equivialent for this method is qconf -km
(see man qconf(1)).
java.rmi.RemoteException
- on any error on the GDI layervoid killScheduler() throws java.rmi.RemoteException
The CLI equivialent for this method is qconf -ks
(see man qconf(1)).
java.rmi.RemoteException
- on any error on the GDI layervoid killExecd(java.lang.String[] hosts, boolean terminateJobs) throws java.rmi.RemoteException
The CLI equivialent for this method is qconf -ke
(see man qconf(1)).
hosts
- a host name listterminateJobs
- if true, all jobs running on the execution hosts are
aborted prior to termination of the corresponding
sge_execd(8).
java.rmi.RemoteException
- on any error on the GDI layervoid killAllExecds(boolean terminateJobs) throws java.rmi.RemoteException
The CLI equivialent for this method is qconf -ke all
(see man qconf(1)).
terminateJobs
- if true, all jobs running on the execution hosts are
aborted prior to termination of the corresponding
sge_execd(8).
java.rmi.RemoteException
- on any error on the GDI layervoid killEventClients(int[] ids) throws java.rmi.RemoteException
Used to shutdown event clients registered at qmaster(8), except special clients like the sge_schedd(8)
Requires root or manager privilege.
The CLI equivialent for this method is qconf -secl
(see man qconf(1)).
ids
- array with the ids of the event clients which should be killed
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid killAllEventClients() throws java.rmi.RemoteException
Used to shutdown event clients all registered at qmaster(8).
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid triggerSchedulerMonitoring() throws java.rmi.RemoteException
The Sun™ Grid Engine scheduler sge_schedd(8) is forced to print trace messages of its next scheduling run to the file <sge_root>/<cell>/common/schedd_runlog. The messages indicate the reasons for jobs and queues not being selected in that run.
Requires root or manager privileges.
The CLI equivialent for this method is qconf -tsm
(see man qconf(1)).
java.rmi.RemoteException
- RemoteException on any error on the GDI leveljava.lang.String getSchedulerHost() throws java.rmi.RemoteException
Return the host where the Sun™ Grid Engine scheduler sge_schedd(8) is active or null otherwise
The CLI equivialent for this method is qconf -sss
(see man qconf(1)).
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid enableQueues(java.lang.String[] queues, boolean force) throws java.rmi.RemoteException
Enable queue(s).
The CLI equivialent for this method is qmod -e
(see man qmod(1)).
queues
- a wildcard queue listforce
- force the action
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid disableQueues(java.lang.String[] queues, boolean force) throws java.rmi.RemoteException
Disable queue(s), i.e. no further jobs are dispatched to disabled queues while jobs already executing in these queues are allowed to finish.
The CLI equivialent for this method is qmod -d
(see man qmod(1)).
queues
- a wildcard queue listforce
- force the action
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid suspendQueues(java.lang.String[] queues, boolean force) throws java.rmi.RemoteException
Suspend the queues and any jobs which might be active.
The CLI equivialent for this method is qmod -sq (see man qmod(1)).
queues
- a wildcard queue listforce
- force the action
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid suspendJobs(java.lang.String[] jobs, boolean force) throws java.rmi.RemoteException
Suspends job(s). If a job is both suspended explicitly and via suspension of its queue, a following unsuspend of the queue will not release the suspension state on the job.
The CLI equivialent for this method is qmod -sj
(see man qmod(1)).
jobs
- a wildcard job listforce
- force the action
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid unsuspendQueues(java.lang.String[] queues, boolean force) throws java.rmi.RemoteException
Unsuspends the queues and any jobs which might be active.
The CLI equivialent for this method is qmod -usq
(see man qmod(1)).
queues
- a wildcard queue listforce
- force the action
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid unsuspendJobs(java.lang.String[] jobs, boolean force) throws java.rmi.RemoteException
Unsuspends the job(s). If a job is both suspended explicitly and via suspension of its queue, a following unsuspend of the queue will not release the suspension state on the job.
The CLI equivialent for this method is qmod -usj
(see man qmod(1)).
jobs
- a wildcard queue listforce
- force the action
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid clearQueues(java.lang.String[] queues, boolean force) throws java.rmi.RemoteException
Clears the error state of the specified queues(s).
The CLI equivialent for this method is qmod -cq
(see man qmod(1)).
queues
- a wildcard queue listforce
- Force the modification action for the queue despite the apparent current state of the queue.
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid clearJobs(java.lang.String[] jobs, boolean force) throws java.rmi.RemoteException
Clears the error state of the specified jobs(s).
The CLI equivialent for this method is qmod -cj (see man qmod(1)).
jobs
- a wildcard job listforce
- Force the modification action for the job(s)
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid rescheduleQueues(java.lang.String[] queues, boolean force) throws java.rmi.RemoteException
Reschedules all jobs currently running in the queue(s). Requires root or manager privileges.
The CLI equivialent for this method is qmod -r
(see man qmod(1)).
queues
- a wildcard queue listforce
- Force the modification action for the queue
despite the apparent current state of the queue.
java.rmi.RemoteException
- RemoteException on any error on the GDI levelvoid rescheduleJobs(java.lang.String[] jobs, boolean force) throws java.rmi.RemoteException
If applied to running jobs, reschedules the jobs. Requires root or manager privileges.
The CLI equivialent for this method is qmod -r
(see man qmod(1)).
jobs
- a wildcard job range listforce
- Force the modification action for the job(s)
java.rmi.RemoteException
java.rmi.RemoteException
- RemoteException on any error on the GDI level
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |