GET /events/monitors?format=defaultFormat

Use this method to return the default output format for each type of event forwarder.

For the default output (forwarded event) format for email recipients, see GET /events/monitors?format=defaultSubjectFormat.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/events/monitors?format=defaultFormat

Query parameters

None

Request body

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401 Unauthorized The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Description
defaultFormats Object Information about the output format for each type of event forwarder

Text between double square brackets are the attributes that which are replaced with actual values. For a description of each attribute, use GET /events/monitors?format=formatKeys.

  email_alert String Output format for email recipients
  ftp String Output format for FTP recipients
  oms_log_analytics String Output format for Azure Log Analytics recipients
  rest String Output format for REST recipients
  syslog String Output format for syslog recipients
The following example is returned if the request is successful.
{
   "defaultFormats": {
      "email_alert": "Alert: [[EventDate]] [[EventMessage]]\n
                      \n
                      Hardware Information:\n
                       Managed Endpoint    : [[DeviceHardwareType]] at [[DeviceIPAddress]]\n
                       Device name         : [[DeviceName]]\n
                       Product name        : [[DeviceProductName]]\n
                       Host name           : [[DeviceHostName]]\n
                       Machine Type        : [[DeviceMachineType]]\n
                       Machine Model       : [[DeviceMachineModel]]\n
                       Serial Number       : [[DeviceSerialNumber]]\n
                       DeviceHealthStatus  : [[DeviceHealthStatus]]\n
                       IPv4 addresses      : [[DeviceIPV4Addresses]]\n
                       IPv6 addresses      : [[DeviceIPV6Addresses]]\n
                       Chassis             : [[DeviceChassisName]]\n
                       DeviceBays          : [[DeviceBays]]\n
                      \n
                      LXCA is: [[ManagementServerIP]]\n
                      \n
                      Event Information:\n
                        Event ID        : [[EventID]]\n
                        Common Event ID : [[CommonEventID]]\n
                        EventSeverity   : [[EventSeverity]]\n
                        Event Class     : [[EventClass]]\n
                        Sequence ID     : [[EventSequenceID]]\n
                        Event Source ID : [[EventSourceUUID]]\n
                        Component ID    : [[EventComponentUUID]]\n
                        Serial Num      : [[EventSerialNumber]]\n
                        MTM             : [[EventMachineTypeModel]]\n
                        EventService    : [[EventService]]\n
                        Console link    : [[ConsoleLink]]\n
                        iOS link        : [[iOSLink]]\n
                        Android link    : [[AndroidLink]]\n
                        System Name     : [[DeviceFullPathName]]\n",
      "ftp": "Alert: [[EventDate]] [[EventMessage]]\n
              \n
               Hardware Information:\n
               Managed Endpoint    : [[DeviceHardwareType]] at [[DeviceIPAddress]]\n
               Device name         : [[DeviceName]]\n
               Product name        : [[DeviceProductName]]\n
               Host name           : [[DeviceHostName]]\n
               Machine Type        : [[DeviceMachineType]]\n
               Machine Model       : [[DeviceMachineModel]]\n
               Serial Number       : [[DeviceSerialNumber]]\n
               DeviceHealthStatus  : [[DeviceHealthStatus]]\n
               IPv4 addresses      : [[DeviceIPV4Addresses]]\n
               IPv6 addresses      : [[DeviceIPV6Addresses]]\n
               Chassis             : [[DeviceChassisName]]\n
               DeviceBays          : [[DeviceBays]]\n
              \n
              LXCA is: [[ManagementServerIP]]\n
              \n
              Event Information:\n
                Event ID        : [[EventID]]\n
                Common Event ID : [[CommonEventID]]\n
                EventSeverity   : [[EventSeverity]]\n
                Event Class     : [[EventClass]]\n
                Sequence ID     : [[EventSequenceID]]\n
                Event Source ID : [[EventSourceUUID]]\n
                Component ID    : [[EventComponentUUID]]\n
                Serial Num      : [[EventSerialNumber]]\n
                MTM             : [[EventMachineTypeModel]]\n
                EventService    : [[EventService]]\n
                Console link    : [[ConsoleLink]]\n
                iOS link        : [[iOSLink]]\n
                Android link    : [[AndroidLink]]\n
                System Name     : [[DeviceFullPathName]]\n",
      "oms_log_analytics": "{\"Msg\":\"[[EventMessage]]\",\"EventID\":\"[[EventID]]\",
                            \"Serialnum\":\"[[EventSerialNumber]]\",\"SenderUUID\":
                            \"[[EventSenderUUID]]\",\"Flags\":\"[[EventFlags]]\",\"Userid\":
                            \"[[EventUserName]]\",\"LocalLogID\":\"[[EventLocalLogID]]\",
                            \"DeviceName\":\"[[DeviceFullPathName]]\",\"SystemName\":
                            \"[[SystemName]]\",\"Action\":\"[[EventAction]]\",\"FailFRUs\":
                            \"[[EventFailFRUs]]\",\"Severity\":\"[[EventSeverity]]\",
                            \"SourceID\":\"[[EventSourceUUID]]\",\"SourceLogSequence\":
                            [[EventSourceLogSequenceNumber]],\"FailSNs\":
                            \"[[EventFailSerialNumbers]]\",\"FailFRUUUIDs\":
                            \"[[EventFailFRUUUIDs]]\",\"EventClass\":\"[[EventClass]]\",
                            \"ComponentID\":\"[[EventComponentUUID]]\",\"Mtm\":
                            \"[[EventMachineTypeModel]]\",\"MsgID\":\"[[EventMessageID]]\",
                            \"SequenceNumber\":\"[[EventSequenceID]]\",\"TimeStamp\":
                            \"[[EventTimeStamp]]\",\"Args\":[[EventMessageArguments]],
                            \"Service\":\"[[EventService]]\",\"CommonEventID\":
                            \"[[CommonEventID]]\",\"EventDate\":\"[[EventDate]]\",
                            \"EventSource\":\"[[EventSource]]\",\"DeviceSerialNumber\":
                            \"[[DeviceSerialNumber]]\",\"DeviceIPAddress\":
                            \"[[DeviceIPAddress]]\",\"LXCA\":\"[[LXCA_IP]]\"}",
      "rest": "{\"msg\":\"[[EventMessage]]\",\"eventID\":\"[[EventID]]\",\"serialnum\":
               \"[[EventSerialNumber]]\",\"senderUUID\":\"[[EventSenderUUID]]\",\"flags\":
               \"[[EventFlags]]\",\"userid\":\"[[EventUserName]]\",\"localLogID\":
               \"[[EventLocalLogID]]\",\"systemName\":\"[[DeviceFullPathName]]\",\"action\":
               [[EventActionNumber]],\"failFRUNumbers\":\"[[EventFailFRUs]]\",\"severity\":
               [[EventSeverityNumber]],\"sourceID\":\"[[EventSourceUUID]]\",
               \"sourceLogSequence\":[[EventSourceLogSequenceNumber]],\"failFRUSNs\":
               \"[[EventFailSerialNumbers]]\",\"failFRUUUIDs\":\"[[EventFailFRUUUIDs]]\",
               \"eventClass\":[[EventClassNumber]],\"componentID\":\"[[EventComponentUUID]]\",
               \"mtm\":\"[[EventMachineTypeModel]]\",\"msgID\":\"[[EventMessageID]]\",
               \"sequenceNumber\":\"[[EventSequenceID]]\",\"timeStamp\":\"[[EventTimeStamp]]\",
               \"args\":[[EventMessageArguments]],\"service\":[[EventServiceNumber]],
               \"commonEventID\":\"[[CommonEventID]]\",\"eventDate\":\"[[EventDate]]\"}",
      "syslog": "<8[[SysLogSeverity]]> [[EventTimeStamp]] [appl=LXCA service=[[EventService]] 
                 severity=[[EventSeverity]] class=[[EventClass]] appladdr=[[LXCA_IP]] 
                 user=[[EventUserName]] src=[[SysLogSource]] uuid=[[UUID]] 
                 me=[[DeviceSerialNumber]] resourceIP=[[DeviceIPAddress]] 
                 systemName=[[DeviceFullPathName]] seq=[[EventSequenceID]] EventID=[[EventID]] 
                 CommonEventID=[[CommonEventID]] [[EventMessage]]"
   }
}