Instructions & Guidelines for Managing Allocation Accounts
MSC News
- EMSL introduces a new video about Chinook on EMSL's YouTube channel (script, .pdf, 9kb)
- Chinook - Living Life in the Fastlane [.pdf, 107kb]
Additional Information
- Meet the MSC Staff
- Related EMSL User Projects
- Active CIR Projects
- Completed CIR Projects: Final Reports
- Help
- User Policies
- User Tips
- Accounts
- Sampling of Jobs Running
- Emergencies
- Glossary
- Training and Events
- Next-Generation Supercomputing (Greenbook) [.pdf, 2.4mb]
- FAQ
- Partners and Related Links
- Spokane Cluster for Biogeochemistry Research
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 MSC supercomputers.
Most commonly used Gold commands
gbalance and glsaccount are two 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 /mscf/mscf/gold/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 MSC Consulting group by email to mscf-consulting@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.
- gbalance
- Displays balance information
- glsaccount
- Displays account information
- glsuser
- Displays user information
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
Specifying Projects
To control the account to which a job is charged, specify the "-A project_name" option in the msub command arguments or in your job submission script.
msub -A <yourGOLDaccount> jobscript
#MSUB -A <yourGOLDaccount>
