Sshare: Difference between revisions

From CMU -- Language Technologies Institute -- HPC Wiki
Jump to navigation Jump to search
Created page with "Category:Monitoring Category:Slurm Category:Jobs = sshare = == Overview == The [https://slurm.schedmd.com/sshare.html sshare] command in Slurm provides detailed information about resource shares and usage. It's essential for managing fair-share priorities in a cluster. == Key Features == * <code>Account/User Share Information</code>: Displays the allocation of resources to users and accounts. * <code>Raw and Normalized Shares</code>: Shows both actual and..."
 
No edit summary
 
Line 3: Line 3:
[[Category:Jobs]]
[[Category:Jobs]]


= sshare =
[https://slurm.schedmd.com/sshare.html sshare] is a command-line tool in the SLURM workload manager, used for displaying historical resource usage and fair-share information for users and groups. This information is crucial for understanding how SLURM allocates resources based on past usage, aiding in efficient job scheduling.
 
== Overview ==
The [https://slurm.schedmd.com/sshare.html sshare] command in Slurm provides detailed information about resource shares and usage. It's essential for managing fair-share priorities in a cluster.


== Key Features ==
== Key Features ==
Line 13: Line 10:
* <code>Usage Data</code>: Details resource consumption, aiding in monitoring and planning.
* <code>Usage Data</code>: Details resource consumption, aiding in monitoring and planning.
* <code>Fair-share Factor</code>: Indicates the priority based on usage and allocation. (Higher is better)
* <code>Fair-share Factor</code>: Indicates the priority based on usage and allocation. (Higher is better)
== Usage ==
The basic syntax for '''sshare''' is:
<source lang="bash">
sshare [options]
</source>
Common options include:
* <code>-a</code> or <code>--all</code>: Show all users/groups.
* <code>-u</code> or <code>--user=[users]</code>: Display information for specific user(s).
* <code>-A</code> or <code>--account=[accounts]</code>: Display information for specific account(s).
* <code>-l</code> or <code>--long</code>: Show detailed information.
== Viewing Your Fair-Share Value ==
To view your fair-share value, simply run:
<source lang="bash">
sshare -u <username>
</source>
Replace <code><username></code> with your actual username.
== Checking Group Usage ==
To check the usage for a specific group:
<source lang="bash">
sshare -A <group_name>
</source>
Replace <code><group_name></code> with the name of the group you want to check.
== Detailed Information ==
For more detailed information, including fields like '''RawUsage''', '''EffectvUsage''', '''NormUsage''', and '''FairShare''':
<source lang="bash">
sshare -l
</source>


== Examples ==
== Examples ==


Usage: sshare [OPTION]
# '''View All User Usage:'''
  Valid OPTIONs are:
<source lang="bash">
    -a or --all            list all users
sshare -a
    -A or --accounts=      display specific accounts (comma separated list)
</source>
    -e or --helpformat    Print a list of fields that can be specified
This command lists fair-share and usage information for all users.
                            with the '--format' option
 
    -l or --long          include normalized usage in output
# '''Specific User in Detail:'''
    -m or --partition      print the partition part of the association
<source lang="bash">
    -M or --cluster=names  clusters to issue commands to.
sshare -l -u jdoe
                            NOTE: SlurmDBD must be up.
</source>
    -n or --noheader      omit header from output
Replace '''jdoe''' with the username. This provides detailed usage information for user '''jdoe'''.
    -o or --format=       Comma separated list of fields (use
 
                            "--helpformat" for a list of available fields).
# '''Multiple Users:'''
    -p or --parsable      '|' delimited output with a trailing '|'
<source lang="bash">
    -P or --parsable2      '|' delimited output without a trailing '|'
sshare -u "user1,user2"
    -u or --users=        display specific users (comma separated list)
</source>
    -U or --Users         display only user information
This shows the information for '''user1''' and '''user2'''.
    -v or --verbose        display more information
    -V or --version        display tool version number
          --help          display this usage description
          --usage          display this usage description


=== User Details ===
== Conclusion ==
% sshare -u dvosler
Understanding '''sshare''' outputs allows users to better comprehend how their and their group's historical usage impacts current and future resource allocation, leading to more efficient job submissions and scheduling on SLURM clusters.
              Account      User  RawShares  NormShares    RawUsage  EffectvUsage  FairShare
-------------------- ---------- ---------- ----------- ----------- ------------- ----------
root                                          0.000000  3339151397      1.000000
  local                                  1    0.500000  3339151397      1.000000
  local                dvosler          1    0.002660      28672      0.000009  0.305040


== See Also ==
== See Also ==

Latest revision as of 11:26, 13 December 2023


sshare is a command-line tool in the SLURM workload manager, used for displaying historical resource usage and fair-share information for users and groups. This information is crucial for understanding how SLURM allocates resources based on past usage, aiding in efficient job scheduling.

Key Features

[edit | edit source]
  • Account/User Share Information: Displays the allocation of resources to users and accounts.
  • Raw and Normalized Shares: Shows both actual and proportionate shares.
  • Usage Data: Details resource consumption, aiding in monitoring and planning.
  • Fair-share Factor: Indicates the priority based on usage and allocation. (Higher is better)

Usage

[edit | edit source]

The basic syntax for sshare is:

<source lang="bash"> sshare [options] </source>

Common options include:

  • -a or --all: Show all users/groups.
  • -u or --user=[users]: Display information for specific user(s).
  • -A or --account=[accounts]: Display information for specific account(s).
  • -l or --long: Show detailed information.

Viewing Your Fair-Share Value

[edit | edit source]

To view your fair-share value, simply run:

<source lang="bash"> sshare -u <username> </source>

Replace <username> with your actual username.

Checking Group Usage

[edit | edit source]

To check the usage for a specific group:

<source lang="bash"> sshare -A <group_name> </source>

Replace <group_name> with the name of the group you want to check.

Detailed Information

[edit | edit source]

For more detailed information, including fields like RawUsage, EffectvUsage, NormUsage, and FairShare:

<source lang="bash"> sshare -l </source>

Examples

[edit | edit source]
  1. View All User Usage:

<source lang="bash"> sshare -a </source> This command lists fair-share and usage information for all users.

  1. Specific User in Detail:

<source lang="bash"> sshare -l -u jdoe </source> Replace jdoe with the username. This provides detailed usage information for user jdoe.

  1. Multiple Users:

<source lang="bash"> sshare -u "user1,user2" </source> This shows the information for user1 and user2.

Conclusion

[edit | edit source]

Understanding sshare outputs allows users to better comprehend how their and their group's historical usage impacts current and future resource allocation, leading to more efficient job submissions and scheduling on SLURM clusters.

See Also

[edit | edit source]