5.6 AMCFG Parameters and Flags

ALWAYSCHARGERESERVATIONS

BACKUPHOST

BLOCKINGACTIONS

CHARGEPOLICY

CHARGERETRYCOUNT

CONTINUEFAILUREACTION

CONTINUEISBLOCKING

CONTINUEURL

CREATECRED

CREATEFAILUREACTION

CREATEISBLOCKING

CREATEURL

DELETEISBLOCKING

DELETEURL

DISABLEDACTIONS

ENDISBLOCKING

ENDURL

FALLBACKACCOUNT

FALLBACKQOS

FLAGS

FLUSHINTERVAL

HOST

LIENGRANULARITY

MODE

NODECHARGEPOLICY

PAUSEISBLOCKING

PAUSEURL

PORT

QUERYURL

REFRESHPERIOD

RESUMEFAILUREACTION

RESUMEISBLOCKING

RESUMEURL

RETRYFAILEDCHARGES

SERVER

STARTFAILUREACTION

STARTISBLOCKING

STARTURL

TIMEOUT

TYPE

UPDATEURL

VALIDATEJOBSUBMISSION

FALSE

This parameter is deprecated. It may be removed in a future release.

Instead, specify the corresponding AMCFG[] CREATEISBLOCKING, DELETEISBLOCKING, ENDISBLOCKING, PAUSEISBLOCKING, RESUMEISBLOCKING, and STARTISBLOCKING parameters.

Only applicable if RETRYFAILEDCHARGES is enabled.

Specifies the maximum number of times that Moab will retry failed connection charges. Moab will continue to retry until the charge succeeds, the charge fails due to a non-connection failure, or until the CHARGERETRYCOUNT limit is reached. If set to zero, no retries will be performed, and all charge failures will be written to files in the SPOOL/am/failed/ directory.

Specifies how consumed resources should be charged against the consumer's credentials. See 5.5.5.A Charge Metrics for details.

DEBITALLBLOCKED or DEBITSUCCESSFULBLOCKED should only be used with policies that allow only a single job to dedicate a node such as with a Node Access Policy of SINGEJOB or SINGLETASK, or using a QOS with the DEDICATED flag. Using DEBITALLBLOCKED or DEBITSUCCESSFULBLOCKED with any policy allowing more than one job to dedicate a node (such as a Node Access Policy of SINGLEUSER, SINGLECLASS, SINGLEACCOUNT or UNIQUEUSER) is not supported

The DEBITSUCCESSFUL* policies require Torque to work. Additionally, the job scripts must return a negative number as the exit code on failure in order to be ignored for charging.

IGNORE,IGNORE,IGNORE

If periodic charging is enabled (via the AMCFG[] FLUSHINTERVAL parameter), this parameter specifies the action to be taken if a failure is detected when Moab performs its periodic accounting update (e.g. to determine whether the job should be continued).

• Moab applies <ConnectionFailureAction> to a job if it is rejected due to a connection failure to MAM.
• Moab applies <FundsFailureAction> to a job if it is rejected due to insufficient funds.

• Moab applies <GeneralFailureAction> to a job if the account manager rejects it for any other reason.

• If you do not specify a <ConnectionFailureAction>, or if you do not specify a <FundsFailureAction>, then Moab will apply the <GeneralFailureAction> for the unspecified case.

If the action is set to CANCEL, Moab cancels the job; for IGNORE, Moab ignores the failure and continues running the job.

TRUE

exec://$TOOLSDIR/mam/usage.reserve.mam.pl if TYPE=Native, otherwise it will make a direct call to MAM (mam:)

If periodic charging is enabled (via AMCFG[] FLUSHINTERVAL), when Moab performs a periodic accounting update for a job, this script is invoked to determine whether there are sufficient allocations for it to continue running for another period.

For jobs, the CONTINUEFAILUREACTION attribute specifies the action that Moab should take if the authorization fails (such as for insufficient funds). If you use a DebitSuccessful{Blocked,CPU,PE,WC} charge policy, Moab will not call the script because it does not yet know the completion status of the job.

To disable a script from being run at this stage, use 'null:' as the parameter value.

If set to TRUE, Moab will be enabled to query accounts, users, user membership in accounts, and users' default accounts from Moab Accounting Manager and define them in Moab. These credentials can be manually updated by running mrmctl -R AM or automatically updated be setting the AMCFG[] REFRESHPERIOD parameter.

If you want Moab to enforce the imported account-user memberships, you will need to set the ENFORCEACCOUNTACCESS parameter to TRUE. See Appendix A Moab Parameters for more information on the ENFORCEACCOUNTACCESS parameter.

Before creating a job that should be tracked or charged within the accounting manager, Moab contacts the accounting manager for authorization. If the job creation is rejected due to lack of funds, Moab applies the FundsFailureAction to the job. For any other rejection reason including a connection problem, Moab applies the AMFailureAction to the job. If you do not specify a FundsFailureAction, Moab will apply the AMFailureAction for an insufficient funds failure. If the action is set to CANCEL, Moab cancels the job; DEFER, defers the job; HOLD, puts the job on hold; and IGNORE, ignores the failure and continues to start the job.

In order for the CREATEFAILUREACTION policy to be applied, the AMCFG[] VALIDATEJOBSUBMISSION parameter must be set to true.

If you have either the AMCFG[] FALLBACKQOS or FALLBACKACCOUNT parameter defined and a job is submitted that has insufficient funds to run, the fallback credential will be applied and the configured CREATEFAILUREACTION action will be ignored.

TRUE

Moab runs this script at the time a job or reservation is being created.

For jobs, the CREATEFAILUREACTION attribute specifies the action that should be taken if the authorization fails (such as for insufficient funds).

To disable a script from being run at this stage, use 'null:' as the parameter value.

TRUE

Moab runs this script to clean up after an interrupted job or reservation life-cycle. The default behavior is to remove outstanding liens.

To disable a script from being run at this stage, use 'null:' as the parameter value.

This parameter is deprecated. It may be removed in a future release.

Instead, specify an empty value or a protocol of 'null:' for the corresponding AMCFG[] CREATEURL, DELETEURL, ENDURL, PAUSEURL, RESUMEURL, STARTURL, and UPDATEURL parameters.

FALSE

Moab runs this script after the end of a chargeable job or reservation in order to make a final charge or update the accounting record. The default behavior is to make a prorated charge for the job or reservation.

To disable a script from being run at this stage, use 'null:' as the parameter value.

[[[DD:]HH:]MM:]SS or INFINITY

The former values of HOUR, DAY, WEEK, MONTH, or NONE are deprecated and may be removed in a future release.

When periodic charging is enabled via AMCFG[] FLUSHINTERVAL, lien granularity controls whether a combined lien is sought for the duration of the entire job (Combined) or whether partial liens are sought for the duration of each periodic charge interval (Partial).

• When using a lien granularity of Partial, a job or reservation may get started if if has enough funds to run for the FLUSHINTERVAL, but it may trigger a CONTINUEFAILUREACTION if it runs out of funds before completion.
• When using a lien granularity of Combined, the funds for the entire job or reservation must be available before it starts, but the funds will be protected by the lien and consumed on a periodic interval.

When charging for resource usage, the accounting manager will charge by node allocation according to the specified policy. For AVG, MAX, and MIN, the accounting manager will charge by the average, maximum, and minimum node charge rate of all allocated nodes. See CHARGEPOLICY.

If you use this feature in conjunction with the AMCFG[] LOCALCOST flag, Moab will include the calculation of the node charge value sent to MAM. See LOCALCOST.

If you do not use this feature in conjunction with the AMCFG[] LOCALCOST flag, you must perform the following MAM commands to include node charges in charge calculations:

1. Add NodeCharge as a usage record property.

   mam-shell Attribute Create Object=UsageRecord Name=NodeCharge DataType=Float Description="\"Node Charge\""

2. Add NodeCharge as a multiplier charge rate.

   mam-create-chargerate -n NodeCharge -z "*1" -d "Node Charge Multiplier"

TRUE

Moab runs this script after preempting a job that might be resumed later. The default behavior is to make an incremental charge but not create a fresh lien. If you use a DebitSuccessful{Blocked,CPU,PE,WC} charge policy, Moab will not call the script because it does not yet know the completion status of the job.

To disable a script from being run at this stage, use 'null:' as the parameter value.

exec://<fullPathToQueryScript> or null:

Moab runs this script to customize and forward the Moab query to the accounting manager. The standard input to the script will be an XML Request in SSS format and is used directly between Moab and Moab Accounting Manager. Its primary purpose is to synchronize accounts and user information with the accounting manager if the CREATECRED parameter is specified.

To disable a script from being run at this stage, use 'null:' as the parameter value.

Indicates the period at which Moab will poll for updated information from Moab Accounting Manager (MAM).

• If AMCFG[] CREATECRED is set to TRUE, Moab will update the accounting credentials from MAM on the specified period.
• If AMCFG[] MODE is set to fast-allocation, Moab will update the account balance cache from MAM on the specified period.

Moab will poll MAM for updated information when it first starts up unless REFRESHPERIOD is set to 0. If REFRESHPERIOD is set to a positive time period, Moab will refresh the accounting credentials on the specified period relative to the scheduler start time. If REFRESHPERIOD is set to INFINITY, Moab will only request updated information from MAM when first started. Use mrmctl -R am to force an immediate refresh.

This action is applied after a failure with the accounting manager when a job is being resumed (e.g. after being suspended).

• Moab will apply <ConnectionFailureAction> to a job if there is a connection failure between Moab and the accounting manager.
• Moab applies <FundsFailureAction> to the job if it is rejected due to insufficient funds.

• Moab applies <GeneralFailureAction> to a job if the account manager rejects it for any other reason.

• If you do not specify a <ConnectionFailureAction>, or if you do not specify a <FundsFailureAction>, then Moab will apply the <GeneralFailureAction> for the unspecified case.

If the action is set to CANCEL, Moab cancels the job; DEFER, Moab defers the job; HOLD, Moab puts the job on hold; IGNORE, Moab ignores the failure and continues to resume the job; RETRY, Moab does not resume the job on this attempt but will continue to try to resume the job at the next opportunity.

TRUE

Moab runs this script before resuming a suspended job to determine whether there it has authorization to resume (e.g. has sufficient funds).

For jobs, the RESUMEFAILUREACTION attribute specifies the action that Moab should take if the authorization fails (such as for insufficient funds). If you use a DebitSuccessful{Blocked,CPU,PE,WC} charge policy, Moab will not call the script because it does not yet know the completion status of the job.

To disable a script from being run at this stage, use 'null:' as the parameter value.

If set to TRUE, job charges will be retried if they have failed due to a connection failure. When a job charge or usage record update (such as might occur when a job is suspended, at the periodic charge interval, or when a job completes) results in a connection failure between Moab and the accounting manager, then the charge request will be saved to a file in SPOOLDIR/am/retrying/. Once Moab detects that the connection with the accounting manager has been restored, the charge will be retried up tp CHARGERETRYCOUNT times. Charges that fail due to reasons other than a connection failure, or connection failures that surpass the CHARGERETRYCOUNT, will be saved to files in SPOOLDIR/am/failed/.

Moab applies the appropriate failure action if there is a failure when registering the job start with the accounting manager.

• Moab applies <ConnectionFailureAction> to the job if there is a communication problem with the accounting manager.
• Moab applies <FundsFailureAction> to the job if it is rejected due to insufficient funds.
• Moab applies <GeneralFailureAction> to a job if the account manager rejects it for any other reason.
• If you do not specify a <ConnectionFailureAction>, or if you do not specify a <FundsFailureAction>, then Moab will apply the <GeneralFailureAction> for the unspecified case.

If the action is set to CANCEL, Moab cancels the job; DEFER, Moab defers the job; HOLD, Moab puts the job on hold; IGNORE, Moab ignores the failure and continues to start the job; and RETRY, Moab does not start the job on this attempt but attempts to start the job at the next opportunity.

TRUE

If set to TRUE, the scheduler will block while authorizing the starting of a job with the accounting manager. If set to FALSE, the accounting operation will be queued to the accounting thread pool and scheduling will continue, but the start of the job will be delayed until a response is received.

If using Moab in a Peer-to-Peer grid, do not set this parameter to FALSE. The Start action is not supported as a non-blocking action in Peer-to-Peer grids.

Moab runs this script on a chargeable job or reservation to determine whether it should start.

For jobs, the STARTFAILUREACTION attribute specifies the action that Moab should take if the authorization fails (such as for insufficient funds).

To disable a script from being run at this stage, use 'null:' as the parameter value.

If you have FLUSHINTERVAL set, Moab runs this script every flush interval for each chargeable job or reservation to charge for the previous interval. This call is usually followed by a call to the CONTINUEURL script, if defined, to check whether there are sufficient funds to run for the next interval. If you use a DebitSuccessful{Blocked,CPU,PE,WC} charge policy, Moab will not call the script because it does not yet know the completion status of the job.

To disable a script from being run at this stage, use 'null:' as the parameter value.