gcharge
Synopsis
gcharge [-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 <usage_state>] [-X, --extension <property>=<value>]... [-t <charge_duration>] [-s <charge_start_time>] [-e <charge_end_time>] [-d <charge_description>] [-z <charge_amount>] [-f <fund_id>] [--incremental] [-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>] [-l <lien_id>] {-J <instance_name>|<job_id>}
Overview
gcharge charges for resource or service usage.
Options
| -a |
| Format |
-a <account_name>
|
| Default |
--- |
| Description |
Specifies the account to charge. |
| -c |
| Format |
-c <class_name>
|
| Default |
--- |
| Description |
Specifies the class of queue used. |
| -C |
| Format |
-C <cpu_time>
|
| Default |
--- |
| Description |
Specifies the CPU time used. |
| -d |
| Format |
-d <charge_description>
|
| Default |
--- |
| Description |
Specifies an explanatory message for the charge. You can pass the overall usage description
via the extension property option (-X Description=<description>). |
| -D |
| Format |
-D <disk>
|
| Default |
--- |
| Description |
Specifies the amount of disk space used. |
| -e |
| Format |
-e <charge_end_time>
|
| Default |
Now
|
| Description |
Specifies an end time for the charge in the format YYYY-MM-DD[ hh:mm:ss]|-Infinity|Infinity|Now
You can pass the overall usage end time via the extension property option (-X EndTime=<end_time>).
|
| -f |
| Format |
-f <fund_id>
|
| Default |
--- |
| Description |
Specifies the fund ID to charge.
|
| -g |
| Format |
-g <group_name>
|
| Default |
--- |
| Description |
Specifies the name of the group to charge. |
| -h, --hours |
| 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 |
Specifies the usage record id for the charge (if already created with gmkusage, gquote, greserve or a previous gcharge). Use -j to charge an existing usage record if the instance name (such as a job ID) is ambiguous or if a usage has already been debited and you want to charge an additional amount to the same usage record.
|
| -J |
| Format |
-J <instance_name>|<job_id>
|
| Default |
--- |
| Description |
Specifies the instance name or job ID for the charge 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 charge. In such cases, look up and specify the usage record ID for the charge.
|
| -l |
| Format |
-l <lien_id>
|
| Default |
--- |
| Description |
Specifies the lien ID, which MAM will use to match up the right usage record ID and remove the correct lien, if ambiguous.
|
| -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 MAM should use to determine charge rates. |
| -Q |
| Format |
-Q <quality_of_service_name>
|
| 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 |
Specifies the charge rates in the charge. The specified rates
override the general rates or rates guaranteed through a quote. You can pass multiple charge rates -R option in a
comma-delimited list or specify multiple -R options. |
| -s |
| Format |
-s <charge_start_time>
|
| Default |
Now - <duration>
|
| Description |
Specifies a start time for the charge in the format YYYY-MM-DD[ hh:mm:ss]|-Infinity|Infinity|Now
You can pass the overall usage end 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 <charge_duration>
|
| Default |
--- |
| Description |
Specifies the wallclock duration for the charge in seconds. You can pass the total wallclock time for the lifetime usage via the extension property option (-X Duration=<duration_in_seconds>).
|
| -T |
| Format |
-T <usage_record_type>
|
| Default |
--- |
| Description |
Specifies the usage record type (Job, Reservation, etc.).
|
| -u |
| Format |
-u <user_name>
|
| Default |
--- |
| Description |
Specifies the user name. |
| -x |
| Format |
-x <usage_state>
|
| Default |
--- |
| Description |
Specifies the final status of the usage. |
| -X, --extension |
| Format |
-X or --extension <property>=<value> |
| Default |
--- |
| Description |
Specifies an extension property. You can specify any number of extra field assignments. |
| -z |
| Format |
-z <charge_amount>
|
| Default |
--- |
| Description |
Specifies the charge amount if calculated externally. |
| --debug |
| Format |
--debug
|
| Default |
--- |
| Description |
Logs debugging information to the screen.
|
| --help |
| Format |
--help
|
| Default |
--- |
| Description |
Displays a brief help message.
|
| --incremental |
| Format |
--incremental
|
| Default |
--- |
| Description |
Debits any associated liens instead of removing them.
|
| --itemize |
| Format |
--itemize
|
| Default |
--- |
| Description |
Returns the composite charge information in the response data. This must be used in conjunction with the --verbose flag to display the data.
|
| --man |
| Format |
--man
|
| Default |
--- |
| Description |
Displays the 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 |
Displays modified object details.
|
| --version |
| Format |
--version
|
| Default |
--- |
| Description |
Displays the product version.
|
Related topics