above to Expand/Collapse the menu
Molecular Science Computing FacilityInstructions & Guidelines for Managing Allocation Accounts
All users must have an allocation (bank account) of node-hours to be able to submit jobs to the batch queue. The Gold Allocation Manager manages and controls the allocation of cpu resources on the MSCF supercomputers.
Most commonly used Gold commands
mybalance, gbalance and glsaccount are three of the most commonly used commands to check account status. They are described below. If you are authorized to charge against multiple projects, you will need to determine which project should be used: see Specifying Projects below. To charge a job to the default project, no user action is required.
Gold on the supercomputers
Gold client commands are available to users to query balance and account information. The Gold commands can be found in /home/mscf/bin and should correctly resolve to this path if you have not overriden the system default path.
Gold on the Web
Complete documentation is available online for the current version of Gold.
If you experience problems with the allocations system, or have any questions, please contact the MSCF Computer Operations group through the web support form or send email to mscf-support@emsl.pnl.gov.
Checking Your Accounts
The following is a list of commonly used Gold commands. Detail for any Gold command can be obtained by invoking the command with the --help flag (brief help message) or the --man flag (full documentation). For more information about using Gold, see the User's Guide on the Gold Home Page.
- mybalance
- Displays personal balance information (also useful to determine the list of projects you can charge to)
- gbalance
- Displays balance information
- glsaccount
- Displays account information
- glsuser
- Displays user information
- glsjob
- Displays job information
- gstatement
- Displays an account statement
mybalance - display personal balance information
SYNOPSIS mybalance [-h, --hours] [-?, --help] [--man] DESCRIPTION mybalance is used to display balance information for the invoking user. OPTIONS -h | --hours displays balance in processor-hours (instead of processor-seconds) -? | --help brief help message --man full documentation EXAMPLE mybalance -h
gbalance - display balance information
SYNOPSIS gbalance [-p <project name>] [-u <user name>] [-m <machine name>] [--available] [--total] [--show <attribute name>[,<attribute name>]*] [-l, --long] [-w, --wide] [--raw] [-h, --hours] [--debug] [-?, --help] [--man] [--quiet] [-V, --version] DESCRIPTION gbalance is used to display balance information. OPTIONS -p <project name> displays balance available to the specified project. -u <user name> displays balance available to the specified user -m <machine name> displays balance available to the specified machine -c <call type> shows balance pertaining to the specified call type. Valid call types include Normal, Back and Forward with Normal being the default. --available total amount represents balance plus available credit. This option only has an effect when combined with the --total option. --total reports a single balance total --show <attribute name>[,attribute name>]* displays only the specified attributes in the order listed. Valid attributes include: Id, Name, Amount, Reserved, Balance, CreditLimit, Available, Deposited, Percentage, Projects, Users, Machines, Description, CreationTime, ModificationTime, Deleted, RequestId, TransactionId -l | --long long format. Display multi-valued fields in a multi-line format. -w | --wide wide format. Display multi-valued fields in a single- line comma-separated format. --debug log debug info to screen -? | --help brief help message --raw raw data output format. Data will be displayed with pipe-delimited fields without headers for automated parsing. -h | --hours display time-based credits in hours. In cases where the currency is measured in resource-seconds (like processor-seconds), the currency is divided by 3600 to display resource-hours. --man full documentation --quiet suppress headers and success messages -V | --version display Gold package version EXAMPLE gbalance -u scottj -h
glsaccount - query accounts
SYNOPSIS glsaccount [-A|-I] [-n <account name>] [-p <project name>] [-u <user name>] [-m <machine name>] [-s <start time>] [-e <end time>] [--exact-match] [--show <attribute name>[,<attribute name>]*] [--showHidden] [-l, --long] [-w, --wide] [--raw] [-h, --hours] [--debug] [-?, --help] [--man] [--quiet] [-V, --version] [[-a] <account id>] DESCRIPTION glsaccount is used to display account information. OPTIONS -A displays accounts with active allocations -I displays accounts with inactive allocations [-a] <account id> displays only accounts with the specified id -n <account name> displays only accounts with the specified name -p <project name> displays only accounts valid toward the specified project -u <user name> displays only accounts valid toward the specified user -m <machine name> displays only accounts valid toward the specified machine --exact-match displays only accounts that are an exact match for the specified entities (project, user and machine). Furthermore, this option causes all matching accounts to be displayed, independent of whether they are valid toward any actual set of entities (for example this will display accounts associated with no projects, or accounts associated with a user designation of MEMBERS where the projects have no members). -l | --long long format. Display multi-valued fields in a multi- line format. -w | --wide wide format. Display multi-valued fields in a single- line comma-separated format. --show <attribute name>[,attribute name>]* displays only the specified attributes in the order listed. Valid attributes include: Id, Name, Amount, CreditLimit, Deposited, Projects, Users, Machines, Allocations, Description, CreationTime, ModificationTime, Deleted, RequestId, TransactionId --debug log debug info to screen -? | --help brief help message --raw raw data output format. Data will be displayed with pipe-delimited fields without headers for automated parsing. -h | --hours display time-based credits in hours. In cases where the currency is measured in resource-seconds (like processor-seconds), the currency is divided by 3600 to display resource-hours. --man full documentation --quiet suppress headers and success messages -V | --version display Gold package version EXAMPLE glsaccount -u scottj -h
glsuser - query users
SYNOPSIS glsuser [-A|-I] [--show <attribute name>[,<attribute name>]*] [--showHidden] [--showSpecial] [-l, --long] [-w, --wide] [--raw] [--debug] [-?, --help] [--man] [--quiet] [-V, --version] [[-u] <user pattern>] DESCRIPTION glsuser is used to display user information. OPTIONS [-u] <user pattern> displays only users matching the pattern. If no pattern is specified then all users are displayed. The following wildcards are supported: matches any number of characters ? matches a single character -A displays only active users -I displays only inactive users -l | --long long format. Display multi-valued fields in a multi- line format. -w | --wide wide format. Display multi-valued fields in a single- line comma-separated format. --show <attribute name>[,<attribute name>]* displays only the specified attributes in the order listed. Valid attributes include: Name, Active, CommonName, PhoneNumber, EmailAddress, DefaultProject, Projects, Organization, Description, CreationTime, ModificationTime, Deleted, RequestId, TransactionId --debug log debug info to screen -? | --help brief help message --raw raw data output format. Data will be displayed with pipe-delimited fields without headers for automated parsing. --man full documentation --quiet suppress headers and success messages -V | --version display Gold package version EXAMPLE glsuser -u scottj
glsjob - query jobs
SYNOPSIS
glsjob [-J <job id pattern>] [-p <project name>] [-u <user name>] [-m <machine name>] [-C <queue>] [-T <type>] [--stage <stage>]
[-s <start time>] [-e <end time>] [--show <attribute name>[,<attribute name>]*] [--showHidden] [--raw]
[-h, --hours] [--debug] [-?, --help] [--man] [--quiet]
[-V, --version] [[-j] <gold job id>]
DESCRIPTION
glsjob is used to display job information.
OPTIONS
[-j] <gold job id>
displays only the job with the database unique id
-J <job id pattern>
displays only jobs with jobids matching the pattern.
The following wildcards are supported:
matches any number of characters
? matches a single character
-p <project name>
display only jobs affiliated with the given project
-u <user name>
display only jobs affiliated with the given user
-m <machine name>
display only jobs affiliated with the given machine
-C <queue>
class or queue name
-T <type>
job type
--stage <stage>
last stage completed by the job (Quote, Reserve,
Charge)
-s <start time>
started after the specified time
-e <end time>
ended before the specified time
--show <attribute name>[,<attribute name>]*
displays only the specified attributes in the order
listed. Valid attributes include: Id, JobId, User,
Project, Machine, Charge, Class, Type, Stage, Quality
OfService, Nodes, Processors, Executable, Application,
StartTime, EndTime, WallDuration, QuoteId, CallType,
Description, CreationTime, ModificationTime, Deleted,
RequestId, TransactionId
--debug
log debug info to screen
-? | --help
brief help message
--raw
raw data output format. Data will be displayed with
pipe-delimited fields without headers for automated
parsing.
-h | --hours
display time-based credits in hours. In cases where
the currency is measured in resource-seconds (like
processor-seconds), the currency is divided by 3600 to
display resource-hours.
--man
full documentation
--quiet
suppress headers and success messages
-V | --version
display Gold package version
EXAMPLE
glsjob -u scottj -s 2005-05-01 -e 2005-06-01
gstatement - display account statement
SYNOPSIS
gstatement [[-a] <account id>] [-p <project name>] [-u <user name>] [-m <machine name>] [-s <start time>] [-e <end time>] [--summarize]
[-h, --hours] [--debug] [-?, --help] [--man] [-V, --version]
DESCRIPTION
gstatement is used to display an account statement. For a
specified time frame it displays the beginning and ending
balances as well as the total credits and debits to the
account over that period. This is followed by an itemized
report of the debits and credits.
OPTIONS
[-a] <account id>
An account statement will be displayed for the specified account.
-p <project name>
The statement will represent a combination of information
for all of the accounts available to the specified
project. Note that the statement may include
information from other projects if the included
accounts are shared by multiple projects.
-u <user name>
The statement will represent a combination of information
for all of the accounts available to the specfied user.
Note that the statement may include information from other
users if the included accounts are shared by multiple users.
-m <machine name>
The statement will represent a combination of information
for all of the accounts available to the specified machine.
Note that the statement may include information from other
machines if the included accounts are shared by multiple
machines.
-s <start time>
the beginning of the reporting period in the format:
[YYYY-MM-DD[ hh:mm:ss]|-infinity|infinity|now]. A
default of -infinity is taken if this option is omitted.
-e <end time>
the end of the reporting period in the format: [YYYY-
MM-DD[ hh:mm:ss]|-infinity|infinity|now]. A default of
now is taken if this option is omitted.
--summarize
display transaction summaries only. Deposits, Refunds,
Charges etc. will be shown as total as opposed to
being itemized.
-h | --hours
display time-based credits in hours. In cases where
the currency is measured in resource-seconds (like
processor-seconds), the currency is divided by 3600 to
display resource-hours.
--debug
log debug info to screen
-? | --help
brief help message
--raw
raw data output format. Data will be displayed with
pipe-delimited fields without headers for automated
parsing.
--man
full documentation
--quiet
suppress headers and success messages
-V | --version
display Gold package version
EXAMPLE
gstatement -p chemistry -s 2005-05-01 -e 2005-06-01 --summarize -h
Specifying Projects
To control the account to which a job is charged, specify the "-P project_name" option in the bsub command arguments or in your job submission script.
bsub -P chemistry jobscript #BSUB -P chemistry