Skip to content
Snippets Groups Projects
Commit 494a6996 authored by Joseph P. Donaghy's avatar Joseph P. Donaghy
Browse files

edits only.

parent 52f50beb
No related branches found
No related tags found
No related merge requests found
......@@ -76,70 +76,59 @@ This is equivalent to the \fBversion\fR command.
.SH "COMMANDS"
.TP
\fBassociations\fR
Use with show or list to display associations with the entity.
\fBall\fR
Display associations.
.TP
\fBhelp\fP
Display a description of sshare options and commands.
\fBaccounts\fR
Display accounts.
.TP
\fBlist\fR <\fIENTITY\fR> [<\fISPECS\fR>]
Display information about the specified entity.
By default, all entries are displayed, you can narrow results by
specifing SPECS in your query.
Identical to the \fBshow\fR command.
\fBcluster\fR
Display cluster.
.TP
\fBoneliner\fP
Output one record per line.
\fBhelp\fP
Display a description of sshare options and commands.
.TP
\fBquiet\fP
Print no messages other than error messages.
\fBno_header\fP
Display output without the header.
.TP
\fBverbose\fP
Enable detailed logging.
This includes time\-stamps on data structures, record counts, etc.
This is an independent command with no options meant for use in interactive mode.
\fBparsable\fP
Display output will be '|' delimited with a '|' at the end.
.TP
\fBversion\fP
Display the version number of sshare.
.SH "ENTITIES"
\fBparsable2\fP
Display output will be '|' delimited without a '|' at the end.
.TP
\fIaccount\fP
A bank account, typically specified at job submit time using the
\fI\-\-account=\fR option.
These may be arranged in a hierarchical fashion, for example
accounts \fIchemistry\fR and \fIphysics\fR may be children of
the account \fIscience\fR.
The hierarchy may have an arbitrary depth.
\fBquiet\fP
Print no messages other than error messages.
.TP
\fIassociation\fP
The entity used to group information consisting of four parameters:
\fIaccount\fR, \fIcluster\fR, \fIpartition (optional)\fR, and \fIuser\fR.
\fBuid\fP
Display user.
.TP
\fIcluster\fP
The \fIClusterName\fR parameter in the \fIslurm.conf\fR configuration
file, used to differentiate accounts from on different machines.
\fBusage\fP
Display a description of sshare options and commands.
.TP
\fIuser\fR
The login name.
\fBuser\fP
Display user.
.SH "GENERAL SPECIFICATIONS FOR ASSOCIATION BASED ENTITIES"
.TP
\fBverbose\fP
Enable detailed logging.
This includes time\-stamps on data structures, record counts, etc.
This is an independent command with no options meant for use in interactive mode.
.TP
\fIFairshare\fP=<fairshare>
Number used in conjunction with other accounts to determine job priority.
To clear a previously set value use the modify command with a new value of \-1.
\fBversion\fP
Display the version number of sshare.
.SH "LIST/SHOW ACCOUNTS FORMAT OPTIONS"
......@@ -148,24 +137,6 @@ To clear a previously set value use the modify command with a new value of \-1.
\fIAccount\fP
The name of a bank account.
.TP
\fIDescription\fP
An arbitrary string describing an account.
.TP
\fIOrganization\fP
Organization to which the account belongs.
.TP
\fICoordinators\fP
List of users that are a coordinator of the account. (Only filled in
when using the WithCoordinator option.)
.SH ""
NOTE: If using the WithAssoc option you can also view the information
about the various associations the account may have on all the
clusters in the system. The Association format fields are described
in the \fILIST/SHOW ASSOCIATION FORMAT OPTIONS\fP section.
.RE
.SH "LIST/SHOW CLUSTER FORMAT OPTIONS"
......@@ -174,75 +145,14 @@ in the \fILIST/SHOW ASSOCIATION FORMAT OPTIONS\fP section.
\fICluster\fP
The name of the cluster.
.TP
\fIControl Host\fP
When a slurmctld registers with the database the ip address of the
controller is placed here.
.TP
\fIControl Port\fP
When a slurmctld registers with the database the port the controller
is listening on is placed here.
.TP
\fIRPC\fP
When a slurmctld registers with the database the rpc version the controller
is running is placed here.
.SH ""
NOTE: You can also view the information about the root association for
the cluster. The Association format fields are described
in the \fILIST/SHOW ASSOCIATION FORMAT OPTIONS\fP section.
.RE
.SH "LIST/SHOW TRANSACTIONS FORMAT OPTIONS"
.TP
\fIAction\fP
.TP
\fIActor\fP
.TP
\fIInfo\fP
.TP
\fITimeStamp\fP
.TP
\fIWhere\fP
.SH ""
NOTE: If using the WithAssoc option you can also view the information
about the various associations the transaction effected. The
Association format fields are described
in the \fILIST/SHOW ASSOCIATION FORMAT OPTIONS\fP section.
.RE
.SH "LIST/SHOW USER FORMAT OPTIONS"
.TP
\fIAdminLevel\fP
Admin level of user.
.TP
\fIDefaultAccount\fP
An the users default account.
.TP
\fICoordinators\fP
List of users that are a coordinator of the account. (Only filled in
when using the WithCoordinator option.)
.TP
\fIUser\fP
The name of a user.
.SH ""
NOTE: If using the WithAssoc option you can also view the information
about the various associations the user may have on all the
clusters in the system. The Association format fields are described
in the \fILIST/SHOW ASSOCIATION FORMAT OPTIONS\fP section.
.RE
.SH "EXAMPLES"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment