NCI Help

Page tree

Account Status

When logging into Gadi, users can run several different commands to access information regarding their compute grant, storage grant, and their usage of different filesystems, by running the commands to the right. 

This information is a basic overview but can be modified to show information more relevant to you or to your project. By running 

$ login-info-config

login-info-config is a utility that will change your ~/.config/gadi-login.conf file and allow you modify what information is displayed to you upon login, to make the data more relevant. 

nci_account = Display compute grant and usage.

quota -s  = Display storage grant and usage on /home.

lquota = Display storage grant and usage on /scratch and g/data by project.

nci-files-report = Report data usage on filesystem.


After running $ login-info-config, the application will start and look similar to the screenshot below.

This application is keyboard interactive, meaning you can use the 'up/down/↑↓' keys to navigate the menu, and the 'enter' key to select an option.

Selecting to change 'Your default login project' will bring you to a new menu with several ways to customise the information presented to you. For instance, if you are part of more than one project, you can select to change 'Your default login project', to make it quicker to navigate where you want to land when logging in. Other options include:

 Data Categories 

Here you can set which categories you'd like to see. Pressing 'Space' or 'tab' will allow you to select multiple options at once. Selecting cancel will take you back to the original menu, without saving any changes.

 Project Thresholds

This will allow you to select which projects you want to see the data usage for. Again, pressing 'Space' or 'tab' will allow you to select multiple options at once. Selecting cancel will take you back to the original menu, without saving any changes.

Category Thresholds

Within this menu, you can set the thresholds for each directory. This will alter at what stage you are notified of usage in these categories. You will be asked to enter a threshold number between 0% and 100%, however, a value of 100% has the same effect as removing the category from the list to be displayed. 

Note that NCI-managed data collection projects will not be shown in the list of projects able to be selected as a default login project, nor will they be visible in the Projects to display when over threshold menu. This is because these projects are expected to be near capacity all of the time.

These projects will only be displayed if they are selected from the Projects to display regardless of thresholds menu.

Please note that no changes will be enacted unless you select 'Save configuration' before exiting the utility. Selecting 'Exit' will revert back to the default settings. 

Manual configuration

Please note:

It is not recommended to manually configure keys beginning with LOGIN_DATA_ that are used by the login info service, as it is possible to create conflicting and/or invalid configurations. 

The following configuration keys are accepted in your ~/.config/gadi-login.conf file.

  • PROJECT  - Your default login project.
  • SHELL  - Your default login shell. Supported shells (i.e. shells in which we guarantee modules and default NCI environment settings will work) are /bin/bash , /bin/tcsh , /bin/ksh and /bin/zsh.
  • LOGIN_DATA_DISPLAY_ONLY - When present, only metrics in this comma-separated list will appear. The allowed metrics can be found in /system/nci/login-info/target/csv_metrics.yaml, though when present in this list, spaces must be replaced with underscores.
  • LOGIN_DATA_DO_NOT_DISPLAY - When present, metrics in this comma-separated list are not displayed. Conflicts with LOGIN_DATA_DISPLAY_ONLY. If both keys are present, an error message will be generated on login and no information will be displayed.
  • LOGIN_DATA_PROJECT_DISPLAY_ONLY - When present, only projects in this comma-separated list will appear when over thresholds.
  • LOGIN_DATA_PROJECT_DO_NOT_DISPLAY - When present, projects in this comma-separated list are not displayed. Conflicts with LOGIN_DATA_PROJECT_DO_NOT_DISPLAY. If both keys are present, an error message will be generated on login and no information will be displayed.
  • LOGIN_DATA_PROJECT_ALWAYS_DISPLAY - When present, projects in this comma-separated list will appear regardless of threshold.
  • LOGIN_DATA_{METRIC}_CUTOFF - Modifies the threshold for displaying a particular metric. In this case {METRIC} corresponds to an entry in /system/nci/login-info/target/csv_metrics.yaml capitalised and with spaces replaced by underscores. As for example, the cutoff for the scratch capacity metric is set by the value corresponding to the LOGIN_DATA_SCRATCH_CAPACITY_CUTOFF key. This should be a value between 0 and 0.99. Values outside of this range are invalid and will be ignored.
  • LOGIN_DATA_NEVER_SHOW - When present, never show login info. Overrides all other LOGIN_DATA_* keys.
In all cases, attempting to view data for projects that you do not belong to, is not possible. 
Authors: Ben Menadue, Mohsin Ali, Andrew Johnston