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

glsevent

Synopsis

glsevent [-s <start_time>] [-e <end_time>] [--full] [--show <attribute_name>,...] [--format <output_type>] [--debug] [--site <site_name>] [--help] [--man] [--quiet] [--version] [[-E] <event_id>]

Overview

glsevent displays event information.

You can customize the fields this command displays by default by setting the event.show configuration parameter in gold.conf.

Options

-e
Format	-e <end_time>
Default	---
Description	Displays events with a prospective fire time occurring before the specified time in the format YYYY-MM-DD[ hh:mm:ss]\|-Infinity\|Infinity\|Now

-E
Format	[-E] <event_id>
Default	---
Description	Displays only the event with the specified ID.

-s
Format	-s <start_time>
Default	---
Description	Displays events with a prospective fire time occurring after the specified time in the format YYYY-MM-DD[ hh:mm:ss]\|-Infinity\|Infinity\|Now

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

--format
Format	--format <output_format>
Default	standard
Description	Specifies a data output format. Valid values include standard and csv.

--full
Format	--full
Default	---
Description	Displays all attributes.

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

--show
Format	--show <attribute_name>[,<attribute_name>...]
Default	---
Description	Displays only the specified attributes in the order specified. Valid attributes include the following: ArmTime – Time the event was last armed or fired. This field is used as a reference time to be able to derive how long the event has been waiting to happen. This field will be initially set to mark the moment the first FireTime is set and updated thereafter to indicate the last time the event was fired. In the case where an event does not have a FireTime set, this field may be set manually and used in a similar manner. If we consider the time between event firings as "laps," this could be thought of as the Lap Start Time. CatchUp – If set to True and Gold was down during the time this event should have fired, Gold will attempt to make up for the past due events by progressively firing them (rearming based on previous arm time) until catching 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 Gold is brought back up after an outage, Gold will still fire immediately for a past due event, but it will only fire once and then rearm relative to the current time. CreationTime – Time this event was created. Deleted – Boolean indicating whether this event is deleted or not. Description – Event description. EndTime – Time after which an event having a rearm period will be deleted. FailureCommand – Serialized Gold request string to be executed if the fired command results in an unsuccessful response status. They syntax is the same as used to invoke commands within the goldsh prompt. FireCommand – Serialized Gold request string to be executed when the event is fired. They syntax is the same as used to invoke commands within the goldsh prompt. FireTime – Target time for the event to be triggered. 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. Id – Event ID. ModificationTime – Time this event was last modified. Notify – Expression specifying where to send a notification of the response for the fire command and the failure command. The notification expression is of the form: [+-=][delivery_method:][recipient][,[+-=][delivery_method:][recipient]]* (For example, -store:amy). 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. There can be multiple notify expressions separated by a comma. RearmPeriod – Time period expression specifying when the event will be rearmed. 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 or minute, etc.), or relative to the start of the first (^) designator (month or minute, etc.). RearmOnFailure – If set to False, the event will not be rearmed if the command was unsuccessful. If set to True, the event will be evaluated for rearming even if the command response has a status of Failure. The standard default value for this boolean is False. RequestId – ID of the last modifying request. TransactionId – ID of the last modifying transaction.

--show

Format

--show <attribute_name>[,<attribute_name>...]

Default

---

Description

Displays only the specified attributes in the order specified. Valid attributes include the following:

ArmTime – Time the event was last armed or fired. This field is used as a reference time to be able to derive how long the event has been waiting to happen. This field will be initially set to mark the moment the first FireTime is set and updated thereafter to indicate the last time the event was fired. In the case where an event does not have a FireTime set, this field may be set manually and used in a similar manner. If we consider the time between event firings as "laps," this could be thought of as the Lap Start Time.
CatchUp – If set to True and Gold was down during the time this event should have fired, Gold will attempt to make up for the past due events by progressively firing them (rearming based on previous arm time) until catching 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 Gold is brought back up after an outage, Gold will still fire immediately for a past due event, but it will only fire once and then rearm relative to the current time.
CreationTime – Time this event was created.
Deleted – Boolean indicating whether this event is deleted or not.
Description – Event description.
EndTime – Time after which an event having a rearm period will be deleted.
FailureCommand – Serialized Gold request string to be executed if the fired command results in an unsuccessful response status. They syntax is the same as used to invoke commands within the goldsh prompt.
FireCommand – Serialized Gold request string to be executed when the event is fired. They syntax is the same as used to invoke commands within the goldsh prompt.
FireTime – Target time for the event to be triggered. 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.
Id – Event ID.
ModificationTime – Time this event was last modified.
Notify – Expression specifying where to send a notification of the response for the fire command and the failure command. The notification expression is of the form: [+-=][delivery_method:][recipient][,[+-=][delivery_method:][recipient]]* (For example, -store:amy). 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. There can be multiple notify expressions separated by a comma.
RearmPeriod – Time period expression specifying when the event will be rearmed. 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 or minute, etc.), or relative to the start of the first (^) designator (month or minute, etc.).
RearmOnFailure – If set to False, the event will not be rearmed if the command was unsuccessful. If set to True, the event will be evaluated for rearming even if the command response has a status of Failure. The standard default value for this boolean is False.
RequestId – ID of the last modifying request.
TransactionId – ID of the last modifying transaction.

--site
Format	--site <site_name>
Default	---
Description	Obtains a response from specified site.

--version
Format	--version
Default	---
Description	Displays the product version.