NERSC High Performance Computing
   
   You are here: hpcf / accounts / nim / getnim   You came from:
   http://hpcf.nersc.gov/accounts/nim/ NERSC Home: www.nersc.gov
     _________________________________________________________________
   
                              The getnim command
                                       
   The command getnim replaces the setcub command for use in user scripts
   to query the NIM database to find out how much time they have left.
   
SYNOPSIS
     getnim [ -tthreshold ] [ -r | -Rrname ]
     or
     getnim [ -uuid | -Uuname ]
     or
     getnim [ -tthreshold ] [ -rrid | -Rrname ] [ -uuid | -Uuname ]


        Where
                rname is a repository name
                uname is a username (login name)
                uid is a numerical user id
                threshold: see below
DESCRIPTION
     The getnim command queries the NERSC account database and returns
     the amount of time remaining in the allocation, either at a repo-
     sitory level or at the user level.

     The numbers returned are all in decimal hours  with  two  decimal
     digit  precision.   A zero or negative value indicates that there
     is no more time within the given allocation  for  further  execu-
     tion.

     The first and third forms given above
     getnim [ -tthreshold ] [ -rrid | -Rrname ]
     and
     getnim [ -tthreshold ] [ -rrid | -Rrname ] [ -uuid | -Uuname ]
     return a single value representing the decimal hours left  in the
     given  repository  as  a  whole or for the given user taking into
     account the user's allowed percentage.

     The second form
     getnim [ -uuid | -Uuname ]
     will return a list of repositories, one per  line,  followed
     by  a  tab character and the user's remaining balance within
     the repository accounting for the  user's allowed percentage.


OPTIONS
     The following options have the interpretation:

     -tthreshold         getnim will return a zero exit status to
                         the shell if the reported balance is less
                         than or equal to threshold. The default
                         value of threshold is 0.0

EXIT STATUS
     The getnim command will have an exit  status  of  0  if  the
     returned  balance is less than or equal to the value of
     threshold and there is no error;   else it will return an exit
     status  of 1 if the returned balance is greater than the
     threshold.  A return status of 2 or more indicates that there
     was an error.

     For the second form, which returns a  list  of  repositories
     and values, the return status is 0 if any  of the balances
     are greater than threshold.  The return status is 1 if none
     are greater.


DIAGNOSTICS
     Error messages should be self-explanatory.


AUTHOR
     R.K.Owen,Ph.D. NERSC



Page last modified: Monday, 18-Sep-00 10:28:01
Page URL: http://hpcf.nersc.gov/accounts/nim/getnim.html
Contact: Webmaster <webmaster@nersc.gov>
Notice to Users