.. _jutil:

User tool jutil
+++++++++++++++

The tool jutil can be used to manage different projects in the system environment and querying information about the account and connected projects.

.. _jutil_usage:

Usage
-----

.. code-block:: none
   
   jutil [-h] <subcommand> <action> [<options>][-v][-o <format>]

Available subcommands
^^^^^^^^^^^^^^^^^^^^^

.. table::
   :align: left

   +------------+------------------------------------------------------------+
   | Subcommand | Description                                                |
   +============+============================================================+
   | *person*   | Queries persons                                            |
   +------------+------------------------------------------------------------+
   | *user*     | Queries users                                              |
   +------------+------------------------------------------------------------+
   | *project*  | Queries projects                                           |
   +------------+------------------------------------------------------------+
   | *env*      | Prepares the environment                                   |
   +------------+------------------------------------------------------------+

Available actions
^^^^^^^^^^^^^^^^^

.. table::
   :align: left

   +-------------+---------------------------------------------------------------------+
   | Action      | Description                                                         |
   +=============+=====================================================================+
   | *show*      | Query info for users or projects                                    |
   +-------------+---------------------------------------------------------------------+
   | *projects*  | List of projects that a user is member of                           |
   +-------------+---------------------------------------------------------------------+
   | *cpuquota*  | Query CPU quota                                                     |
   +-------------+---------------------------------------------------------------------+
   | *dataquota* | Query disk quota                                                    |
   +-------------+---------------------------------------------------------------------+
   | *activate*  | Activate a project -> exports env vars and change current unixgroup |
   +-------------+---------------------------------------------------------------------+

Available options
^^^^^^^^^^^^^^^^^

.. table::
   :align: left

   +----------------------------------+----------------------------------------------------+
   | Option                           | Description                                        |
   +==================================+====================================================+
   | *-A <val> -\-budget=<val>*       | Filter results with given budget account ID        |
   +----------------------------------+----------------------------------------------------+
   | *-C <val> -\-contingent*         | Query only research projects (with contingent)     |
   +----------------------------------+----------------------------------------------------+
   | *-c <val>, -\-contpart=<val>*    | Query a contingent partition                       |
   +----------------------------------+----------------------------------------------------+
   | *-D <val>, -\-data*              | Query only data projects (without contingent)      |
   +----------------------------------+----------------------------------------------------+
   | *-E <val>, -\-end=<val>*         | Search jobs until this end date                    |
   +----------------------------------+----------------------------------------------------+
   | *-g <val>, -\-group=<val>*       | Specify project or (primary) group                 |
   +----------------------------------+----------------------------------------------------+
   | *-h, -\-help*                    | Print this help message                            |
   +----------------------------------+----------------------------------------------------+
   | *-k <val>, -\-pkey=<val>*        | Specify personal key                               |
   +----------------------------------+----------------------------------------------------+
   | *-L <val>, -\-last=<val>*        | Search jobs for specified recent period            |
   +----------------------------------+----------------------------------------------------+
   | *-M <val>, -\-members*           | Show data quotas from all project members          |
   +----------------------------------+----------------------------------------------------+
   | *-n <val>, -\-noheader*          | Do not print output header                         |
   +----------------------------------+----------------------------------------------------+
   | *-o <val>, -\-format=<val>*      | Output format: rows(default),columns,parsable,json |
   +----------------------------------+----------------------------------------------------+
   | *-p <val>, -\-project=<val>*     | Specify project                                    |
   +----------------------------------+----------------------------------------------------+
   | *-R <val>, -\-reservation=<val>* | Exports Slurm env vars for given reservation       |
   +----------------------------------+----------------------------------------------------+
   | *-S <val>, -\-start=<val>*       | Search jobs from this start date                   |
   +----------------------------------+----------------------------------------------------+
   | *-s <val>, -\-system=<val>*      | Query cpuquota only for given system               |
   +----------------------------------+----------------------------------------------------+
   | *-U <val>, -\-units=<val>*       | Specify project                                    |
   +----------------------------------+----------------------------------------------------+
   | *-u <val>, -\-user=<val>*        | Specify user                                       |
   +----------------------------------+----------------------------------------------------+
   | *-v, -\-verbose*                 | Show more info/logs                                |
   +----------------------------------+----------------------------------------------------+
   | *-Z, -\-currsys*                 | Query cpuquota only for current/local system       |
   +----------------------------------+----------------------------------------------------+

Allowed user interfaces
-----------------------

.. code-block:: none
   
    jutil person show [-u <uid>|-k <persKey>|-a] [-o <fmt>] [-n] [-v]

.. code-block:: none
   
    jutil user show      [-u <uid>|-a [--global]] [-o <fmt>] [-n] [-v]
    jutil user projects  [-u <uid>] [--contingent|--data] [-o <fmt>] [-n] [-v]
    jutil user cpuquota  [-u <uid>|-a] [-p <project>] [-s <sys>|-Z] [-c <contpart>] [-A <budget>] [-o <fmt>] [-n] [-v]
    jutil user jobs      [-u <uid>] [-J <id>|[-p <proj>] [-c <cp>] [-A <bg>] [-L <lst>|-S <dt> -E <dt>]] [-o <fmt>] [-n] [-v]
    jutil user dataquota [-u <uid>|-a] [-p <project> | -g <group>] [-U <units>] [-o <fmt>] [-n] [-v]

.. code-block:: none
   
    jutil project show      -p <project>|-a [-o <fmt>] [-n] [-v]
    jutil project cpuquota  -p <project> [-s <sys>|-Z] [-c <contpart>] [-A <budget>] [-o <fmt>] [-n] [-v]
    jutil project dataquota -p <project> [--members] |-a [-U <units>] [-o <fmt>] [-n] [-v]

.. code-block:: none
   
    jutil env activate -p <project> [-A <budget>] [-R <resv>] [-v]
    jutil env init [-v]
    jutil env refresh [-v]
    jutil env dump [-v]
    jutil env cleanup [-v]