NAME

       acct_gather.conf - Slurm configuration file for the acct_gather plugins

DESCRIPTION

       acct_gather.conf  is  an  ASCII  file which defines parameters used by Slurm's acct_gather
       related plugins.  The file location can  be  modified  at  system  build  time  using  the
       DEFAULT_SLURM_CONF  parameter  or  at execution time by setting the SLURM_CONF environment
       variable. The file will always be located in the same directory as the slurm.conf file.

       Parameter names are case insensitive.  Any text following a "#" in the configuration  file
       is  treated  as a comment through the end of that line.  The size of each line in the file
       is limited to 1024 characters.  Changes to the configuration file take effect upon restart
       of  SLURM  daemons,  daemon  receipt  of  the  SIGHUP  signal, or execution of the command
       "scontrol reconfigure" unless otherwise noted.

       The following acct_gather.conf parameters are defined to control the general  behavior  of
       various plugins in SLURM.

       The  acct_gather.conf file is different than other Slurm .conf files.  Each plugin defines
       which options are available.  So if you do not load the respective plugin  for  an  option
       that  option will appear to be unknown by Slurm and could cause Slurm not to load.  If you
       decide to change plugin types you might also have to change the related options as well.

       EnergyIPMI
              Options used for AcctGatherEnergyType/ipmi are as follows:

              EnergyIPMIFrequency=<number>
                                  This parameter is the number  of  seconds  between  BMC  access
                                  samples.

              EnergyIPMICalcAdjustment=<yes|no>
                                  If  set  to  "yes", the consumption between the last BMC access
                                  sample and a step consumption update  is  approximated  to  get
                                  more  accurate task consumption.  The adjustment is made at the
                                  step start and each time the consumption is updated,  including
                                  the  step end. The approximations are not accumulated, only the
                                  first  and  last  adjustments  are  used  to   calculated   the
                                  consumption. The default is "no".

              EnergyIPMIPowerSensor=<number>
                                  This  parameter is optional.  If the parameter is included, the
                                  plugin searches the node for a "watt" sensor  with  the  number
                                  specified  by  <number>.  If  a  matching sensor is found, that
                                  sensor is used for power data. If no matching sensor is  found,
                                  a value of zero is returned for power data. If the parameter is
                                  omitted, the plugin will use the first "watt" sensor it finds.

              The following acct_gather.conf parameters are defined to control  the  IPMI  config
              default values for libipmiconsole.

              EnergyIPMIUsername=USERNAME
                     Specify BMC Username.

              EnergyIPMIPassword=PASSWORD
                     Specify BMC Password.

       ProfileHDF5
              Options used for AcctGatherProfileType/hdf5 are as follows:

              ProfileHDF5Dir=<path>
                                  This  parameter is the path to the shared folder into which the
                                  acct_gather_profile plugin will write detailed data (usually as
                                  an HDF5 file).  The directory is assumed to be on a file system
                                  shared by the controller and  all  compute  nodes.  This  is  a
                                  required parameter.

              ProfileHDF5Default  A  comma  delimited list of data types to be collected for each
                                  job submission.  Allowed values are:

                                  All All data types are  collected.  (Cannot  be  combined  with
                                  other values.)

                                  None No data types are collected. This is the default.
                                          (Cannot be combined with other values.)

                                  Energy Energy data is collected.

                                  Task Task (I/O, Memory, ...) data is collected.

                                  Lustre Lustre data is collected.

                                  Network Network (InfiniBand) data is collected.

       InfinibandOFED
              Options used for AcctGatherInfinbandType/ofed are as follows:

              InfinibandOFEDFrequency=<number>
                                  This  parameter  is  the number of seconds between the calls to
                                  infiniband counters.

              InfinibandOFEDPort=<number>
                                  This  parameter  represents  the  port  number  of  the   local
                                  Infiniband  card  that  we are willing to monitor.  The default
                                  port is 1.

EXAMPLE

       ###
       # Slurm acct_gather configuration file
       ###
       # Parameters for AcctGatherEnergy/impi plugin
       EnergyIPMIFrequency=10
       EnergyIPMICalcAdjustment=yes
       #
       # Parameters for AcctGatherProfileType/hdf5 plugin
       ProfileHDF5Dir=/app/slurm/profile_data
       # Parameters for AcctGatherInfiniband/ofed plugin
       InfinibandOFEDFrequency=4
       InfinibandOFEDPort=1

COPYING

       Copyright (C) 2012-2013 Bull.  Produced at Bull (cf, DISCLAIMER).

       This  file  is  part  of  SLURM,  a  resource  management  program.   For   details,   see
       <http://slurm.schedmd.com/>.

       SLURM  is  free  software; you can redistribute it and/or modify it under the terms of the
       GNU General Public License as published by the Free Software Foundation; either version  2
       of the License, or (at your option) any later version.

       SLURM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
       even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
       GNU General Public License for more details.

SEE ALSO

       slurm.conf(5)