Field Name
|
Description
|
##event##
|
A string representation of all the event fields.
|
##eventType##
|
The type of event that occurred
|
##eventTimestamp##
|
The UTC date and time indicating when the reported event ocurred
|
##eventUserLogin##
|
The login of the user that triggered the event.
(NOTE: This may be different that the user that created a reservation originally)
|
##eventSource##
|
The OSCARS component that caused the event.
Currently the value may be API, WBUI, or SCHEDULER>
|
##errorCode##
|
An error code identifying an error, if one occurred.
|
##errorMessage##
|
A description of an error, if one occurred.
|
##reservation##
|
A string representation of the reservation the event affects.
|
##gri##
|
The global reservation identifier of the affected reservation
|
##startTime##
|
The UTC start time of the affected reservation
|
##endTime##
|
The UTC end time of the affected reservation
|
##createdTime##
|
The UTC time that the affected reservation was created
|
##bandwidth##
|
The bandwidth of the affected reservation
|
##resvUserLogin##
|
The login of the user that created the affected reservation
|
##status##
|
The status of the affected reservation
|
##description##
|
The description field of the affected reservation
|
##pathSetupMode##
|
The path setup mode (timer-automatic or signal-xml) of the affected reservation
|
##isExplicitPath##
|
A flag ndicating whether the reservation path was explicitly set by the user
|
##nextDomain##
|
The next domain a reservation traverses beyond the current domain
|
##l2Source##
|
For layer 2 reservations, the URN of the reservation source
|
##l2Dest##
|
For layer 2 reservations, the URN of the reservation destination
|
##l3Source##
|
For layer 3 reservations, the hostname/IP address of the reservation source
|
##l3Dest##
|
For layer 3 reservations, the hostname/IP address of the reservation destination
|
##l3SrcPort##
|
For layer 3 reservations, the TCP/UDP port of the source
|
##l3DestPort##
|
For layer 3 reservations, the TCP/UDP port of the destination
|
##protocol##
|
For layer 3 reservations, the transport protocol (i.e. TCP or UDP)
|
##dscp##
|
For layer 3 reservations, the differentiated services code point
|
##dscp##
|
For MPLS reservations, the burst limit of the reservation
|
##lspClass##
|
For MPLS reservations, the LSP class of the reservation
|
##TAG:TAG_NAME##
|
A special dynamic field for including
user-defined tags identified by
TAG_NAME in email messages.
User-defined tags may be included in the reservation description at creation
between square brackets[]. This field is useful for triggering the OSCARS
email module to search for tags and include them in other areas of the message,
such as the subject. For example, including the dynamic field
##TAG:PRODUCTION CIRCUIT## in a template will search each reservation description
for the tag [PRODUCTION CIRCUIT]. If present in the reservation description,
the string [PRODUCTION CIRCUIT] will be included in the
resulting email message at the location of this field in the template. If not
found, this field will be replaced with an empty string in the email message.
|