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

greserve

Synopsis

greserve [-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 <lien_duration> [-G <grace_duration>]] [-s <lien_start_time>] [-e <lien_end_time>] [-d <lien_description>] [-z <lien_amount>] [--modify|--replace] [-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_id>] [-J <instance_name>|<job_id>]

Overview

greserve obtains a lien for usage.

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 <lien_description>
Default	---
Description	Specifies an explanatory message for the lien. 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 <lien_end_time>
Default	Now
Description	Specifies the end time for the lien 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 lien duration but not the lien end time, MAM will calculate the lien end time as the lien start time plus the lien 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 lien if already created with gmkusage, gquote, or a previous greserve. This places a hold against an existing usage record if the instance name (such as a job ID) is ambiguous or if usage has already been debited and you want to reserve an additional amount associated with the same usage record.

-J
Format	-J <instance_name\|job_id>
Default	---
Description	Instance name or the job ID of the lien if known. This can sometimes be non-unique, such as when a resource manager recycles job ids, and does not always unambiguously identify a usage record to reserve. In such cases, look up and specify the usage record ID for the lien.

-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_id>
Default	---
Description	Specifies the quote used to determine 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 lien. The specified rates override the general rates or rates guaranteed through a quote. You may pass multiple charge rates to the -R option in a comma-delimited list or specify multiple -R options.

-s
Format	-s <lien_start_time>
Default	---
Description	Specifies the start time for the lien 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 <lien_duration>
Default	---
Description	Specifies the wallclock duration for the lien 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 <lien_amount>
Default	---
Description	Specifies the lien amount if calculated externally.

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

--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.

--modify
Format	--modify
Default	---
Description	Causes the reserve operation to augment existing liens instead of creating new ones. This new option is mutually exclusive with the --replace option which deletes existing matching liens and recreates a new one. The default action is to create a new lien even if a lien for an instance of the same name exists. The modify behavior supports extending liens out dynamically and is often used with incremental charging.

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

--replace
Format	--replace
Default	---
Description	If you specify this option, MAM will delete similarly named liens before creating this lien. The default action is to create a new lien while leaving any existing liens for instances of the same name. The replace option should be specified if you want this lien to replace existing liens for instances of the same name such as when a system reuses instance names. This new option is mutually exclusive with the --modify option which modifies any existing matching lien instead of creating a new one.

--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.