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

gquote

Synopsis

gquote [-T <usage_record_type>] [-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>] [-N <nodes>] [-P <processors>] [-C <cpu_time>] [-M <memory>] [-D <disk>] [-X, --extension <property>=<value>]... [-t <quote_duration> [-G <grace_duration>]] [-s <quote_start_time>] [-e <quote_end_time>] [-d <quote_description>] [-z <quote_amount>] [--cost-only | --guarantee] [-R <charge_rate_name>[{<charge_rate_value>}]=<charge_rate_amount>,...]... [-h, --hours] [--itemize] [--debug] [--site <site_name>] [--help] [--man] [--quiet] [--verbose] [--version] [[-j] <usage_record_id>] [-q <quote_template_id>] [-J <instance_name>|<job_id>]

Overview

gquoteobtains a quote for usage. This command and its options can estimate the cost of using resources or services, validate that a requester has sufficient access and funds to use the requested resources or services, and guarantee that the charge rates used to generate the quote do not change when applying subsequent liens and charges.

Options

-a
Format	-a <account_name>
Default	---
Description	Specifies the account name.

-c
Format	-c <class_name>
Default	---
Description	Specifies the class or queue used.

-C
Format	-C <cpu_time>
Default	---
Description	Specifies the estimated CPU time used.

-d
Format	-d <quote_description>
Default	---
Description	Specifies an explanatory message for the quote. You can pass overall usage description via the extension property option (-X Description=<description>).

-D
Format	-D <disk>
Default	---
Description	Specifies the amount of disk used.

-e
Format	-e <quote_end_time>
Default	---
Description	Specifies the end time for the quote in the format YYYY-MM-DD[ hh:mm:ss]\|-Infinity\|Infinity\|Now.

-g
Format	-g <group_name>
Default	---
Description	Specifies the group name.

-G
Format	-G <grace_duration>
Default	---
Description	Specifies a grace period in seconds. If you specify the quote duration but not the quote end time, MAM will calculate the quote end time as the quote start time plus the quote duration plus the grace duration.

-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	Usage record ID for the quote if already created with gmkusage or a previous gquote.

-J
Format	-J <instance_name\|job_id>
Default	---
Description	Instance name or the job ID of the quote if known.

-m
Format	-m <machine_name>
Default	---
Description	Specifies the name of the cluster, cloud, or system used.

-M
Format	-M <memory>
Default	---
Description	Specifies the amount of memory used.

-N
Format	-N <nodes>
Default	---
Description	Specifies the number of nodes used.

-o
Format	-o <organization_name>
Default	---
Description	Specifies the organization name.

-P
Format	-P <processors>
Default	---
Description	Specifies the number of processors used.

-q
Format	-q <quote_template_id>
Default	---
Description	Specifies quote template used to override standard charge rates.

-Q
Format	-Q <quality_of_service>
Default	---
Description	Specifies the quality of service used.

-R
Format	-R <charge_rate_name>[{<charge_rate_value>}]=<charge_rate_amount>[,<charge_rate_name>[{<charge_rate_value>}]=<charge_rate_amount>...]
Default	---
Description	Uses the specified charge rates in the quote. The specified rates override the general rates. If you specify the --guarantee option, these charge rates will be saved and used when this quote is referenced in a charge action. You may pass multiple charge rates to the -R option in a comma-delimited list or you can specify multiple -R options.

-s
Format	-s <quote_start_time>
Default	---
Description	Specifies the start time for the quote in the format YYYY-MM-DD[ hh:mm:ss]\|-Infinity\|Infinity\|Now. You can pass the overall usage start time via the extension property option (-X StartTime=<start_time>).

-S
Format	-S <service_id>
Default	---
Description	Specifies the root service ID (cloud).

-t
Format	-t <quote_duration>
Default	---
Description	Specifies the wallclock duration for the quote in seconds. You can pass the estimated wallclock time for the total lifetime usage via the extension property option (-X Duration=<usage_duration>).

-T
Format	-T <usage_record_type>
Default	---
Description	Specifies the usage record type, such as job or reservation.

-u
Format	-u <user_name>
Default	---
Description	Specifies the user name.

-X
Format	-X or --extension <property>=<value>
Default	---
Description	Specifies an extension property. You can specify any number of extra custom conditions.

-z
Format	-z <quote_amount>
Default	---
Description	Specifies the quote amount if calculated externally.

--cost-only
Format	--cost-only
Default	---
Description	Returns the cost, ignoring all balance and validity checks. This option is mutually exclusive with --guarantee.

--debug
Format	--debug
Default	---
Description	Logs debug information to the screen.

--guarantee
Format	--guarantee
Default	---
Description	Guarantees the quote and returns a quote ID to secure the current charge rates. This results in the creation of a quote record and a permanent usage record. This option is mutually exclusive with --cost-only.

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

--itemize
Format	--itemize
Default	---
Description	Returns the composite charge information in the response data. You must use this in conjunction with the --verbose flag to display the data.

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

--quiet
Format	--quiet
Default	---
Description	Suppresses headers and success messages.

--site
Format	--site <site_name>
Default	---
Description	Obtains a response from specified site.

--verbose
Format	--verbose
Default	---
Description	Display modified object details.

--version
Format	--version
Default	---
Description	Displays the product version.