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

grefund

Synopsis

grefund [-z <amount>] [-f <fund_id>] [-d <description>] [-A] [--filter <filter_name>=<filter_value>]... [--filter-type <filter_type>] [-h, --hours] [--debug] [--site <site_name>] [--help] [--man] [--quiet] [--verbose] [--version] {-J <instance_name>|<job_id> | [-j] <usage_record_id>}

Overview

grefund issues a refund for the specified usage. The command will return a list of usage records if the usage search does not yield a unique match.If you do not specify an amount, MAM will credit the appropriate allocations for the full amount the overall usage was charged. You may specify a lesser amount for a partial refund.

Options

-A
Format	-A
Default	---
Description	When you use filters to select the fund to be refunded, specifies that only active allocations should be considered.

-d
Format	-d <description>
Default	---
Description	Specifies an explanatory message for the refund.

-f
Format	-f <fund_id>
Default	---
Description	Specifies the fund to be refunded to. If you omit this, MAM will look in the transaction table to determine to which fund it should deposit the refund.

-h, --hours
Format	-h or --hours
Default	---
Description	Treats currency as specified in hours. In systems where the currency is measured in resource-seconds (like processor-seconds), this option allows the amount to be specified in resource-hours.

-j
Format	[-j] <usage_record_id>
Default	---
Description	Specifies the unique usage record identifier the accounting manager assigns to distinguish between usage with non-unique instance names.

-J
Format	-J <instance_name>\|<job_id>
Default	---
Description	Specifies the name of the instance (such as a job ID assigned by the local resource manager). This ID might not be unique among the historical list of usage records the accounting manager manages.

-z
Format	-z <amounts>
Default	---
Description	Specifies the amount to refund. This amount must be non-negative and less than or equal to the amount charged for the overall usage.

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

--filter
Format	--filter <filter_name>=<filter_value>
Default	---
Description	By default, MAM refunds amounts to the same fund from which it took them. If you want to override this, by specifying filters you may restrict the fund to be refunded to one whose constraints are consistent with the specified filters. For example, grefund --filter User=amy will refund the amount to the fund usable by the user amy. You may specify multiple filter options by logically ANDing them together.

--filter-type
Format	--filter-type <filter_type>
Default	NonExclusive
Description	Selects the filtering type. If you use the Exclusive filter type, a fund will only be matched if the specified filters meet all constraints. If you use the NonExclusive filter type, a fund will be matched as long as the specified filters do not conflict with the constraints.

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

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