(Click to open topic with navigation)

Moab Accounting Manager > Appendices > Appendix A: Commands Reference > glsusage

glsusage

Synopsis

glsusage [-T <usage_record_type>] [-J <instance_name_pattern>|<job_id_pattern>] [-S <service_id>] [-u <user_name>] [-g <group_name>] [-a <account_name>] [-o <organization_name>] [-c <class_name>] [-Q <quality_of_service>] [-m <machine_name>] [--stage <stage>] [-s <start_time>] [-e <end_time>] [-X, --extension <property>=<value>]... [--full] [--show <attribute_name>,...] [--format <output_type>] [-h,--hours] [--debug] [--site <site_name>] [--help] [--man] [--quiet] [--version] [[-j] <usage_record_id>]

Overview

glsusage displays usage record information.

You can customize the fields this command displays by default by setting the usagerecord.show configuration parameter in gold.conf.

Options

-a
Format -a <account_name>
Default ---
Description

Displays only usage records affiliated with the specified account.
-c
Format -c <class_name>
Default ---
C

Specifies the class or queue name.
-e
Format -e <end_time>
Default ---
Description

Ended before the specified time.
-g
Format -g <group_name>
Default ---
Description

Displays only usage records affiliated with the specified group
-h
Format -h or --hours
Default ---
Description

Displays 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.
-j
Format [-j] <usage_record_id>
Default ---
Description

Displays the usage record with the specified ID.
-J
Format -J <instance_name>|<job_pattern>
Default ---
Description

Displays only usage records matching the specified instance name or job id pattern. The following wildcards are supported:

  • * – matches any number of characters
  • ? – matches a single character
-m
Format -m <machine_name>
Default ---
Description

Displays only usage records affiliated with the specified machine.
-o
Format -o <organization_name>
Default ---
Description

Displays only usage records affiliated with the specified organization.
-Q
Format -Q <quality_of_service>
Default ---
Description

Displays only usage records affiliated with the given quality of service .

-s
Format -s <start_time>
Default ---
Description

Started after the specified time.
--stage
Format --stage <stage>
Default ---
Description

Last stage completed by the usage (Quote, Create, Reserve, Charge).
-S
Format -S <service_id>
Default ---
Description

Display on usage records associated with the specified root service ID (cloud).
-T
Format -T <usage_record_type>
Default ---
Description

Displays only usage records associated with the specified type (such as Job or Reservation).
-u
Format -u <user_name>
Default ---
Description Displays only usage records affiliated with the given user.
-X
Format -X or --extension <property>=<value>
Default ---
Description Specifies an extension property. You can specify any number of extra custom conditions.
--debug
Format --debug
Default ---
Description

Logs debug information to the screen.
--format
Format --format <output_format>
Default standard
Description Specifies a data output format. Valid values include standard and csv.
--full
Format --full
Default ---
Description Displays all attributes.
--help
Format --help
Default ---
Description

Displays a brief help message.
--man
Format --man
Default ---
Description

Displays full documentation.
--quiet
Format --quiet
Default ---
Description

Suppresses headers and success messages.
--show
Format --show <attribute_name>[,<attribute_name>...]
Default ---
Description

Displays only the specified attributes in the order specified. Valid attributes include the following:

  • Account – Account name associated with the usage.
  • Charge – Cumulative amount charged.
  • Class – Class or queue name associated with the usage.
  • CPUTime – CPU time used.
  • CreationTime – Time this usage record was created.
  • Deleted – Boolean indicating whether this usage record is deleted or not.
  • Description – Usage description.
  • Disk – Amount of disk used.
  • Duration – Expected duration of the usage.
  • EndTime – Overall end time of the usage.
  • Id – Usage record ID.
  • Instance – Instance name (job ID).
  • JobTemplate – Job template name (cloud).
  • Machine – Cluster name (HPC) or virtual or physical machine name (cloud).
  • Memory – Amount of memory used.
  • ModificationTime – Time this usage record was last modified.
  • Nodes – Number of nodes used (HPC).
  • Organization – Organization name associated with the usage.
  • Processors – Number of cores or processors used.
  • QualityOfService – Quality of service associated with the usage.
  • Quote – Associated quote ID.
  • RequestId – ID of the last modifying request.
  • Service – Root service ID (cloud).
  • ServiceComponent – Leaf service ID (cloud).
  • Stage – Last affecting action (Create, Quote, Reserve, Query).
  • StartTime – Overall start time of the usage.
  • TransactionId – ID of the last modifying transaction.
  • Type – Usage record type.
  • User – User name associated with the usage.
--site
Format --site <site_name>
Default ---
Description Obtains a response from specified site.
--version
Format --version
Default ---
Description

Displays the product version.

Related topics

© 2014 Adaptive Computing