wiki:WRF4G2.0/CLI

Version 1 (modified by carlos, 7 years ago) (diff)

--

CLI

wrf4g is a WRF4G's Command Line Interface (CLI) for administrative both computing resources and jobs.

Available commands

Type --help option obtain information about all commands:

$ wrf4g --help
DRM4G is an open platform, which is based on GridWay Metascheduler, to define, 
submit, and manage computational jobs. For additional information, 
see http://meteo.unican.es/trac/wiki/DRM4G .

Usage: drm4g [ --version ] [ -h | --help ] [ --dbg ]
             <command> [ <args>... ]

Options:
    -h --help  Show help.
    --version  Show version.
    --dbg      Debug mode.
    
drm4g commands are:
   start       Start DRM4G daemon and ssh-agent
   stop        Stop DRM4G daemon and ssh-agent
   status      Check DRM4G daemon and ssh-agent
   restart     Restart DRM4G daemon
   clear       Start DRM4G daemon deleting all the jobs available on DRM4G
   conf        Configure DRM4G daemon, scheduler and logger parameters
   resource    Manage computing resources
   host        Print information about the hosts
   job         Submit, get status and history and cancel jobs
 
See 'drm4g --help <command>' for more information on a specific command.

start :

Start DRM4G daemon and ssh-agent. 
   
Usage: 
    drm4g start [ --dbg ] 
   
Options:
    --dbg    Debug mode.

stop:

Stop DRM4G daemon and ssh-agent.  
    
Usage: 
    drm4g stop [ --dbg ] 
   
Options:
    --dbg    Debug mode.

status:

Check DRM4G daemon and ssh-agent.   
               
Usage:  
    drm4g status [ --dbg ] 
           
Options:    
    --dbg    Debug mode. 

clear:

Start DRM4G daemon deleting all the jobs available on DRM4G. 
                
Usage:  
    drm4g clear [ --dbg ] 
           
Options:   
    --dbg    Debug mode.

restart :

Restart DRM4G daemon.
                
Usage:  
    drm4g restart [ --dbg ] 
            
Options:    
    --dbg    Debug mode.

conf:

Configure DRM4G daemon, scheduler and logger parameters.
                
Usage:  
    drm4g conf ( daemon | sched | logger ) [ --dbg ]
            
Options:    
    --dbg    Debug mode.

resource:

Manage computing resources on DRM4G.
    
Usage: 
    drm4g resource [ list | edit | check ] [ --dbg ] 
    drm4g resource <name> id conf [ --public-key=<file> --grid-cerd=<file> --lifetime=<hours> --dbg ]
    drm4g resource <name> id init [ --lifetime=<hours> --dbg ]
    drm4g resource <name> id info [ --dbg ]
    drm4g resource <name> id delete [ --dbg ]

Options:
   -l --lifetime=<hours>   Duration of the identity's lifetime [default: 168].
   -p --public-key=<file>  Public key file.
   -g --grid-cerd=<file>   Grid certificate.
   --dbg                   Debug mode.
    
Commands:
   list                    Show resources available.    
   edit                    Configure resources.
   check                   Check out if configured resources are accessible.
   id                      Manage identities for resources. That involves 
                           managing private/public keys and grid credentials, 
                           depending on the resource configuration.
                                           
                           With init, creates an identity for a while, by 
                           default 168 hours (1 week). Use the option --lifetime 
                           to modify this value. It adds the configured private
                           key to a ssh-agent and creates a grid proxy using 
                           myproxy server.
       
                           With conf, initializes an identity (init comnand) 
                           and appends the public key to the remote user's 
                           ~/.ssh/authorized_keys file (creating the file, and 
                           directory, if necessary). It tries to load the public 
                           key obtained by appending *.pub to the name of the 
                           configured private key file. Alternative the public 
                           key can be given by --public-key option.
                           It also configures the user's grid certificate 
                           under ~/.globus directory (creating directory, 
                           if necessary) if --grid-cerd option is used.
                                  
                           With info, it gives some information about the 
                           identity status.
                                
                           With delete, the identity is removed from the 
                           ssh-agent and the myproxy server.


host:

Print information about the hosts available on DRM4G.
     
Usage: 
    drm4g host [ list ] [ --dbg ] [ <hid> ] 
    
Arguments:
    <hid>         Host identifier.

Options:
    --dbg         Debug mode.        
 
Host field information:
    HID 	  Host identifier.
    ARCH 	  Architecture.
    JOBS(R/T)     Number of jobs: R = running, T = total.
    LRMS 	  Local Resource Management System.
    HOSTNAME      Host name.
    QUEUENAME     Queue name.
    WALLT 	  Queue wall time.
    CPUT 	  Queue cpu time.
    MAXR          Max. running jobs.
    MAXQ 	  Max. queued jobs. 

job:

Submit, get status and history and cancel jobs.

Usage: 
    drm4g job submit [ --dbg ] [ --dep <job_id> ... ] <template> 
    drm4g job list [ --dbg ] [ <job_id> ] 
    drm4g job cancel [ --dbg ]  <job_id> ... 
    drm4g job get-log [ --dbg ] <job_id>
    drm4g job get-history [ --dbg ] <job_id> 
   
Arguments:
    <job_id>               Job identifier.
    <template>             Job template.

Options:
    --dep=<job_id> ...     Define the job dependency list of the job.
    --dbg                  Debug mode.
    
Commands:
    submit                 Command for submitting jobs.
    list                   Monitor jobs previously submitted.
    cancel                 Cancel jobs.
    get-log                Keep track of a job.
    get-history            Get information about the execution history of a job.

Job field information:
    JID 	           Job identification.
    DM 	                   Dispatch Manager state, one of: pend, hold, prol, prew, wrap, epil, canl, stop, migr, done, fail.
    EM 	                   Execution Manager state: pend, susp, actv, fail, done.
    START 	           The time the job entered the system.
    END 	           The time the job reached a final state (fail or done).
    EXEC 	           Total execution time, includes suspension time in the remote queue system.
    XFER 	           Total file transfer time, includes stage-in and stage-out phases.
    EXIT 	           Job exit code.
    TEMPLATE               Filename of the job template used for this job.
    HOST 	           Hostname where the job is being executed.
    HID 	           Host identification.
    PROLOG 	           Total prolog (file stage-in phase) time.
    WRAPPER                Total wrapper (execution phase) time.
    EPILOG 	           Total epilog (file stage-out esphase) time.
    MIGR 	           Total migration time.
    REASON 	           The reason why the job left this host.
    QUEUE 	           Queue name.