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

gchevent

Synopsis

gchevent [--fire-command <fire_command>] [-s <fire_time>] [-e <end_time>] [--rearm-period <rearm_period>] [--rearm-on-failure <boolean>] [--failure-commmand <failure_command>] [--notify <notification_url>] [--catch-up <boolean> [-d <description>] [--debug] [--site <site_name>] [--help] [--man] [--quiet] [--verbose] [--version] {[-E] <event_id>}

Overview

gchevent modifies an event.

Options

-d
Format	-d <description>
Default	---
Description	Specifies a new description.

-e
Format	-e <end_time>
Default	---
Description	Specifies the time this event becomes inactive.

-E
Format	-E <event_id>
Default	---
Description	Specifies the ID of the event to modify.

-s
Format	-s <fire_time>
Default	---
Description	Specifies a new target time for the event to be triggered by the event scheduler. The actual fire time may be dependent on the state of the server and will be recorded in the CreationTime property of the corresponding "Event Fire" Transaction. An event may also be fired manually with the goldsh Event Fire action.

--catch-up
Format	--catch-up <boolean>
Default	True
Description	If you set the --catch-up boolean to True and the server was down during the time this event should have fired, the event scheduler will attempt to make up for the past due events by progressively firing them (rearming based on previous arm time) until it catches up to the present. The actions will still show as having occurred in the present rather than in the past. If set to False and the server is brought back up after an outage, the event scheduler will still fire immediately for a past due event, but it will only fire once and then rearm relative to the current time.

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

--failure-command
Format	--failure-command <goldsh_command>
Default	---
Description	Specifies a new command MAM should execute if the fired command results in an unsuccessful response status. This command is expressed in a serialized form of the request identical to the syntax used in the interactive control program (goldsh). The option argument will need to be appropriately quoted and/or escaped in order to avoid misinterpretation or alteration by the shell.

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

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

--notify
Format	--notify [+-=][<delivery_method>:][recipient]
Default	Logs all event statuses to the Notification table.
Description	A Notification method logs the result of the fired command. If the term is a -, the notification is sent only on failure. If the term is a +, the notification is sent only on success. Otherwise the notification is always sent. See Managing notifications for more information about delivery method and recipient.

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

--rearm-on-failure
Format	--rearm-on-failure <boolean>
Default	False
Description	If you set the --rearm-on-failure boolean to False, MAM will not rearm the event if the command was unsuccessful. If you set it to True, MAM will evaluate the event for rearming even if the command response has a status of Failure.

--rearm-period
Format	--rearm-period <period>[[@instant][~\|^]\|!]
Default	---
Description	The --rearm-period is a time period expression specifying when MAM will rearm the event. This period expression is of the form: <period>[[@instant][~\|^]\|!] where <period> may be something like 1 day, 2 hours, or 5 minutes. Instant locks the period to a specific instant within the time period such as 1 day @ hour 12 or 1 month @ day 3. The modifiers indicate whether the time period should be relative to now (!), or relative to the start of this (~) designator (month, minute, or other unit), or relative to the start of the first (^) designator (month, minute, or other unit). For example, assuming the fire time was 7:15, if you specified 4 hours ! as the rearm period, MAM would rearm it at 11:15; if you specified 4 hours ~ as the rearm period, MAM would rearm it at 11:00; and if you specified 4 hours ^ as the rearm period, MAM would rearm it at 8:00.

--rearm-period

Format

--rearm-period <period>[[@instant][~|^]|!]

Default

---

Description

The --rearm-period is a time period expression specifying when MAM will rearm the event. This period expression is of the form:

<period>[[@instant][~|^]|!]

where <period> may be something like 1 day, 2 hours, or 5 minutes. Instant locks the period to a specific instant within the time period such as 1 day @ hour 12 or 1 month @ day 3. The modifiers indicate whether the time period should be relative to now (!), or relative to the start of this (~) designator (month, minute, or other unit), or relative to the start of the first (^) designator (month, minute, or other unit). For example, assuming the fire time was 7:15, if you specified 4 hours ! as the rearm period, MAM would rearm it at 11:15; if you specified 4 hours ~ as the rearm period, MAM would rearm it at 11:00; and if you specified 4 hours ^ as the rearm period, MAM would rearm it at 8:00.

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