GET /events/monitors/`{monitor_id}`

Use this method to return information about a specific for event forwarder, sample content of a forwarded event for a specific event forwarder, or a description of each field in a specific forwarded event.

Authentication

Authentication with username and password is required.

Request URL

GET https://{management_server_IP}/events/monitors/{monitor_id}

where {monitor_id} is the ID of the for event forwarder. To obtain the filter ID, use the GET /events/monitors method.

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

Table 1. Azure Log Analytics.
Attributes				Type	Description
createdBy				String	Name of the user that created the event forwarder
description				String	Description for the event forwarder
enable				Boolean	Indicates whether the event forwarder is enabled. This can be one of the following values. true. (default) The event forwarder is enabled. false. The event forwarder is disabled.
eventFilter				Object	Information about the types of events to forward
	filter			Object	Information about each event filter
		categories		Array of strings	Event categories. This can be one or more of the following values. BULLETIN. Sends notification about new bulletins. GENERAL. Sends notifications about audit events, based on the selected event classes and severities STATUS_CHANGE. Sends notifications about changes in status. STATUS_UPDATE WARRANTY. Send notifications about warranties.
		componentIDs		Array of strings	List of component IDs. If empty, all components are accepted.
		eventID		String	List of event IDs, separated by a comma, to be included
		eventServices		Array of strings	Service type. This can be one or both of the following values. none support user
		excludedEventIDs		String	List of event IDs, separated by a comma, to be excluded
		negateFilter		Boolean	Indicates whether to exclude events that match the specified filter. This can be one of the following values. true. Excludes (does not forward) events that match the specified filters. false. Includes (forwards) events that match the specified filters.
		resourceGroupsUUIDs		Array of strings	List of resource
		sourceIDs		Array of strings	List of source IDs. If empty, all sources are monitored.
		typeSeverity		Array of objects	Event severity and type. If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter are forwarded.
			severity	String	Event severity. This can be one of the following values. Unknown. The severity is unknown. Informational. Informational Warning. User can decide if action is needed. Minor. Action is needed, but the situation is not serious at this time. Major. Action is needed now. Critical. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result). Fatal. A non-recoverable error has occurred.
			type	String	Event type. This can be one of the following values. Unknown Audit Cooling Power Disks. Storage Memory Processor System. Rack or tower server Test Adaptor. Adapter card Expansion. Expansion board IOModule. Flex System switch Blade. Flex System server Switch Other Backplane Chassis Drive ExtDrive. External drive Fan M2Adapter M2Drive OCP PCIE PSU Retimer Riser 7MMDrive Pump
forwardHidden				Boolean	Specifies whether to forward hidden events. This can be one of the following values. true. Hidden events are forwarded. false. (default) Hidden events are not forwarded.
id				String	Event forwarder ID
ignoreExcluded				Boolean	Specifies whether to disable the forwarding of excluded events. This can be one of the following values. true. Ignores excluded events. false. (default) Forwards excluded events.
ipAddress				String	IPv4 or IPv6 address or hostname of the remote system that is the target to receive the events. For email, this is the SMTP server.
lastEditBy				String	Name of the user that last edited the event forwarder
matchEverything				Boolean	Indicates whether the action is to be run against all managed devices. This can be one of the following values. true. The action is to be run against all managed devices. false. The action is run against only the managed device that is specified by the target attribute.
name				String	User-defined name for the event forwarder. This name must be unique for all event forwarder.
outputFormat				String	Output format of the forwarded event Text between double square brackets are the fields that which are replaced with actual values. For a description of each field, use GET /events/monitors?format=formatKeys.
port				String	TCP/UDP port used for the connection. For Azure Log Analytics, this value is always 443.
primaryKey				String	Primary key of the log-analytics device that is obtained from the Azure portal.
protocol				String	Type of event forwarder. For Azure Log Analytics, this value is always oms_log_analytics.
requestTimeout				Integer	Amount of time, in seconds, that an event forwarder has to forward events before the request times out. By default, the time-out value is 30 seconds.
scheduler				Object	Information about times and days when you want the specified events to be forwarded to this event forwarder
	enabled			Boolean	Indicates whether the schedule is enabled. This can be one of the following values. true. The schedule is enabled. Only events that occur during the specified time slot are forwarded. false. The schedule is disabled. Events are forwarded 24x7.
	events			Array of objects	List of event-fowarding schedules
			calendar	String	Schedule name
			daysOfWeek	Array of strings	Days of the week. This can be one or more of the following values. 1. Monday 2. Tuesday 3. Wednesday 4. Thursday 5. Friday 6. Saturday 7. Sunday
			endingDate	String	Date when the schedule ends
			endTime	String	Time when the schedule ends
			id	Integer	Schedule ID
			initialEndTime	String
			initialStartTime	String
			repeatable	Boolean	Indicates whether the schedule is recurring. This can be one of the following values. true. The schedule is recurring. false. The schedule occurs only once.
			seriesId	Integer	Schedule index
			startingDate	String	Date when the schedule starts
			startTime	String	Time when the schedule starts
			summary	Boolean
	showSummary			String	Indicates whether the schedule summary is enabled. The summary includes the time slot for schedule and which schedules are repeatable. This can be one of the following values. true. The schedule summary is enabled. false. The schedule summary is disabled.
workspaceID				String	Workspace ID of the log-analytics device that is obtained from the Azure portal.

The following example is returned if the request is successful for event forwarders to Azure Log Analytics recipients.

{
   "createdBy": "ADMIN",
   "description": "",
   "enable": "true",
   "eventFilter": {
      "filter": {
         "categories": ["WARRANTY", "GENERAL"],
         "componentIDs": [],
         "eventID": "",
         "eventServices": [],
         "excludedEventIDs": "",
         "negateFilter": false,
         "resourceGroupsUUIDs": [],
         "sourceIDs": [],
         "typeSeverity": [{
            "severity": "INFORMATIONAL",
            "type": "AUDIT"
         },
         ...,
         {
            "severity": "FATAL",
            "type": "AUDIT"
         }]
      }
   },
   "forwardHidden": false,
   "id": "1520009819404",
   "ignoreExcluded": false,
   "ipAddress": "3268497b-7842-4a00-a9b8-8128e125e916.ods.opinsights.azure.com",
   "lastEditBy": "ADMIN",
   "matchEverything": true,
   "name": "ALA_forwarder",
   "outputFormat": "{\"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]]\"}",
   "port": "58443",
   "primaryKey": "BA7qbCEy7tsTVJ0S3LMATXKXeoHrdPvOx4CfzcnsgM3qKYjZgph64oIKWH9FuSO1xakjmasW0VGeNAUiGSomuQ==",
   "protocol": "oms_log_analytics",
   "requestTimeout": 30,
   "scheduler": {
      "showSummary": false,
      "enabled": false,
      "events": []
   },
   "workspaceID": "3268497b-7842-4a00-a9b8-8128e125e916"
}

Table 2. Email service using SMTP.
Attributes				Type	Description
authenticationEmail				String	Authentication type. This can be one of the following values. Regular. Authenticates to the specified SMTP server using the specified user ID and password. NTLM. Uses the NT LAN Manager (NTLM) protocol to authentication to the specified SMTP server using the specified user ID, password, and domain name. OAUTH2. Uses the Simple Authentication and Security Layer (SASL) protocol to authenticate to the specified SMTP server using the specified user name and security token. Typically, the user name is your email address. Attention The security token expires after a short time. It is your responsibility to refresh the security token. None. No authentication is used.
connectionEmail				Array of strings	Connection type to secure connection to the SMTP server. This can be one of the following values. SSL. Use the SSL protocol while communicating. TLS. Uses TLS to form a secure communication over an unsecure channel.
createdBy				String	Name of the user that created the event forwarder
description				String	Description for the event forwarder.
enable				Boolean	Indicates whether the event forwarder is enabled. This can be one of the following values. true. (default) The event forwarder is enabled. false. The event forwarder is disabled.
eventFilter				Object	Information about the types of events to forward
	filter			Object	Information about each event filter
		categories		Array of strings	Event categories. This can be one or more of the following values. BULLETIN. Sends notification about new bulletins. GENERAL. Sends notifications about audit events, based on the selected event classes and severities STATUS_CHANGE. Sends notifications about changes in status. STATUS_UPDATE WARRANTY. Send notifications about warranties.
		componentIDs		Array of strings	List of component IDs. If empty, all components are accepted.
		eventID		String	List of event IDs, separated by a comma, to be included
		eventServices		Array of strings	Service type. This can be one or both of the following values. none support user
		excludedEventIDs		String	List of event IDs, separated by a comma, to be excluded
		negateFilter		Boolean	Indicates whether to exclude events that match the specified filter. This can be one of the following values. true. Excludes (does not forward) events that match the specified filters. false. Includes (forwards) events that match the specified filters.
		resourceGroupsUUIDs		Array of strings	List of resource
		sourceIDs		Array of strings	List of source IDs. If empty, all sources are monitored.
		typeSeverity		Array of objects	Event severity and type If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter are forwarded.
			severity	String	Event severity. This can be one of the following values. Unknown. The severity is unknown. Informational. Informational Warning. User can decide if action is needed. Minor. Action is needed, but the situation is not serious at this time. Major. Action is needed now. Critical. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result). Fatal. A non-recoverable error has occurred.
			type	String	Event type. This can be one of the following values. Unknown Audit Cooling Power Disks. Storage Memory Processor System. Rack or tower server Test Adaptor. Adapter card Expansion. Expansion board IOModule. Flex System switch Blade. Flex System server Switch Other Backplane Chassis Drive ExtDrive. External drive Fan M2Adapter M2Drive OCP PCIE PSU Retimer Riser 7MMDrive Pump
forwardHidden				Boolean	Specifies whether to forward hidden events. This can be one of the following values. true. Hidden events are forwarded. false. (default) Hidden events are not forwarded.
id				String	Event forwarder ID
ignoreExcluded				Boolean	Specifies whether to disable the forwarding of excluded events. This can be one of the following values. true. Ignores excluded events. false. (default) Forwards excluded events.
ipAddress				String	IPv4 or IPv6 address or hostname of the remote system that is the target to receive the events. For email, this is the SMTP server.
lastEditBy				String	Name of the user that last edited the event forwarder
matchEverything				Boolean	Indicates whether the action is to be run against all managed devices. This can be one of the following values. true. The action is to be run against all managed devices. false. The action is run against only the managed device that is specified by the target attribute.
name				String	User-defined name for the event forwarder. This name must be unique for all event forwarder.
outputFormat				String	Output format of the forwarded event Text between double square brackets are the fields that which are replaced with actual values. For a description of each field, use GET /events/monitors?format=formatKeys.
port				String	TCP/UDP port used for the connection. For email, this value is always 25.
protocol				String	Type of event forwarder. For email, this value is always email_alert.
recipients				Array of strings	List of email addresses for the event forwarder, in the format `userid@domain` (for example, `XClarity1@company.com`)
requestTimeout				Integer	The amount of time, in seconds, that an event forwarder has to forward events before the request times out. By default, the time-out value is 30 seconds.
scheduler				Object	Information about times and days when you want the specified events to be forwarded to this event forwarder recipient
	enabled			Boolean	Indicates whether the schedule is enabled. This can be one of the following values. true. The schedule is enabled. Only events that occur during the specified time slot are forwarded. false. The schedule is disabled. Events are forwarded 24x7.
	events			Array of objects	List of event-fowarding schedules
			calendar	String	Schedule name
			daysOfWeek	Array of strings	Days of the week. This can be one or more of the following values. 1. Monday 2. Tuesday 3. Wednesday 4. Thursday 5. Friday 6. Saturday 7. Sunday
			endingDate	String	Date when the schedule ends
			endTime	String	Time when the schedule ends
			id	Integer	Schedule ID
			initialEndTime	String
			initialStartTime	String
			repeatable	Boolean	Indicates whether the schedule is recurring. This can be one of the following values. true. The schedule is recurring. false. The schedule occurs only once.
			seriesId	Integer	Schedule index
			startingDate	String	Date when the schedule starts
			startTime	String	Time when the schedule starts
			summary	Boolean
	showSummary			String	Indicates whether the schedule summary is enabled. The summary includes the time slot for schedule and which schedules are repeatable. This can be one of the following values. true. The schedule summary is enabled. false. The schedule summary is disabled.
senderDomain				String	Sender domain (for example, company.com) If you do not specify the senderDomain or senderUserName, this is `LXCA.{source_identifier}@{smtp_host}` by default. If you specify the senderDomain but not senderUserName, the format of the sender address is `{LXCA_host_name}`@`{sender_domain}` (for example, XClarity1@company.com).
senderUserName				String	Sender name
subjectFormat				String	Email subject For a description of fields that can be specified in the subject format, use GET /events/monitors?format=defaultFormat.
useSupportContact				Boolean	Indicates to use the email address that is defined for the support contact that is assigned to the device. This can be one of the following values. true. Email forwarder uses the email address for the support contact. false. (default) Email forwarder uses the email addresses that are specified in the recipients attribute.

The following example is returned if the request is successful for event forwarders to email recipients.

{
   "authenticationEmail": "none",
   "connectionEmail": ["SSL"],
   "createdBy": "ADMIN",
   "description": "",
   "enable": "true",
   "eventFilter": {
      "filter": {
         "categories": ["WARRANTY","STATUS_CHANGE","STATUS_UPDATE","GENERAL"],
         "componentIDs": [],
         "eventID": "",
         "eventServices": ["none","support","user"],
         "excludedEventIDs": "",
         "negateFilter": false,
         "sourceIDs": [],
         "resourceGroupsUUIDs": [],
         "typeSeverity": [{
            "severity": "INFORMATIONAL",
            "type": "UNKNOWN"
         },
         {
            "severity": "WARNING",
            "type": "UNKNOWN"
         },
         {
            "severity": "MINOR",
            "type": "UNKNOWN"
         },
         ...,
         {
            "severity": "FATAL",
            "type": "AUDIT"
         }]
      }
   },
   "forwardHidden": false,
   "id": "1520009765759",
   "ignoreExcluded": false,
   "ipAddress": "192.0.2.20",
   "lastEditBy": "ADMIN",
   "matchEverything": true,
   "name": "email forwarder",
   "outputFormat": "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",
   "port": "25",
   "protocol": "email_alert",
   "recipients": "user1@company.com",
   "requestTimeout": 30,
   "scheduler": {
      "enabled": false,
      "events": [],
      "showSummary": false
   },
   "senderDomain": "company.com",
   "senderUserName": "LXCA1",
   "subjectFormat": "[[DeviceName]]-[[EventMessage]]",
   "useSupportContact": false
}

Table 3. FTP servers.
Attributes				Type	Description
authUser				Boolean	Authentication user ID if authentication is used
characterEncoding				String	Character set. This can be one of the following values. UTF-8. (default) Big5
charactersToRemove				String	Sequence of characters to be removed from the file content
createdBy				String	Name of the user that created the event forwarder
description				String	Description for the event forwarder
enable				Boolean	Indicates whether the event forwarder is enabled. This can be one of the following values. true. (default) The event forwarder is enabled. false. The event forwarder is disabled.
eventFilter				Object	Information about the types of events to forward
	filter			Object	Information about each event filter
		categories		Array of strings	Event categories. This can be one or more of the following values. BULLETIN. Sends notification about new bulletins. GENERAL. Sends notifications about audit events, based on the selected event classes and severities STATUS_CHANGE. Sends notifications about changes in status. STATUS_UPDATE WARRANTY. Send notifications about warranties.
		componentIDs		Array of strings	List of component IDs. If empty, all components are accepted.
		eventID		String	List of event IDs, separated by a comma, to be included
		eventServices		Array of strings	Service type. This can be one or both of the following values. none support user
		excludedEventIDs		String	List of event IDs, separated by a comma, to be excluded
		negateFilter		Boolean	Indicates whether to exclude events that match the specified filter. This can be one of the following values. true. Excludes (does not forward) events that match the specified filters. false. Includes (forwards) events that match the specified filters.
		resourceGroupsUUIDs		Array of strings	List of resource
		sourceIDs		Array of strings	List of source IDs. If empty, all sources are monitored.
		typeSeverity		Array of objects	Event severity and type. If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter are forwarded.
			severity	String	Event severity. This can be one of the following values. Unknown. The severity is unknown. Informational. Informational Warning. User can decide if action is needed. Minor. Action is needed, but the situation is not serious at this time. Major. Action is needed now. Critical. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result). Fatal. A non-recoverable error has occurred.
			type	String	Event type. This can be one of the following values. Unknown Audit Cooling Power Disks. Storage Memory Processor System. Rack or tower server Test Adaptor. Adapter card Expansion. Expansion board IOModule. Flex System switch Blade. Flex System server Switch Other Backplane Chassis Drive ExtDrive. External drive Fan M2Adapter M2Drive OCP PCIE PSU Retimer Riser 7MMDrive Pump
forwardHidden				Boolean	Specifies whether to forward hidden events. This can be one of the following values. true. Hidden events are forwarded. false. (default) Hidden events are not forwarded.
ftpAuthentication				String	Authentication type. This can be one of the following values. Regular. Authenticates to the specified SMTP server using the specified user ID and password. This is the same as basic authentication. None. (default) No authentication is used. This is the same as anonymous authentication.
ftpFileName				String	File-name format to use for the file that contains the forwarded event. The default format is event_[[EventSequenceID]].txt. Note Each file contains information for a single event.
ftpPath				String	Path on the remote FTP server where the file is to be uploaded
id				String	Event forwarder ID
ignoreExcluded				Boolean	Specifies whether to disable the forwarding of excluded events. This can be one of the following values. true. Ignores excluded events. false. (default) Forwards excluded events.
ipAddress				String	IPv4 or IPv6 address or hostname of the remote system that is the target to receive the events. For email, this is the SMTP server.
lastEditBy				String	Name of the user that last edited the event forwarder
matchEverything				Boolean	Indicates whether the action is to be run against all managed devices. This can be one of the following values. true. The action is to be run against all managed devices. false. The action is run against only the managed device that is specified by the target attribute.
name				String	User-defined name for the event forwarder. This name must be unique for all event forwarders.
outputFormat				String	Output format of the forwarded event Text between double square brackets are the fields that which are replaced with actual values. For a description of each field, use GET /events/monitors?format=formatKeys.
port				String	TCP/UDP port used for the connection. For FTP, this value is always 21.
protocol				String	Type of event forwarder. For FTP, this value is always ftp.
requestTimeout				Integer	Amount of time, in seconds, that an event forwarder has to forward events before the request times out By default, the time-out value is 30 seconds.
scheduler				Object	Information about times and days when you want the specified events to be forwarded to this event forwarder
	enabled			Boolean	Indicates whether the schedule is enabled. This can be one of the following values. true. The schedule is enabled. Only events that occur during the specified time slot are forwarded. false. The schedule is disabled. Events are forwarded 24x7.
	events			Array of objects	List of event-forwarding schedules
			calendar	String	Schedule name
			daysOfWeek	Array of strings	Days of the week. This can be one or more of the following values. 1. Monday 2. Tuesday 3. Wednesday 4. Thursday 5. Friday 6. Saturday 7. Sunday
			endingDate	String	Date when the schedule ends
			endTime	String	Time when the schedule ends
			id	Integer	Schedule ID
			initialEndTime	String
			initialStartTime	String
			repeatable	Boolean	Indicates whether the schedule is recurring. This can be one of the following values. true. The schedule is recurring. false. The schedule occurs only once.
			seriesId	Integer	Schedule index
			startingDate	String	Date when the schedule starts
			startTime	String	Time when the schedule starts
			summary	Boolean
	showSummary			String	Indicates whether the schedule summary is enabled. The summary includes the time slot for schedule and which schedules are repeatable. This can be one of the following values. true. The schedule summary is enabled. false. The schedule summary is disabled.

The following example is returned if the request is successful for event forwarders to FTP recipients.

{
   "authUser": "admin",
   "characterEncoding": "UTF-8",
   "charactersToRemove": null,
   "createdBy": "ADMIN",
   "description": "",
   "enable": "false",
   "eventFilter": {
      "filter": { 
         "categories": ["WARRANTY", "GENERAL"],
         "componentIDs": [],
         "eventID": "",
         "eventServices": [],
         "excludedEventIDs": "",
         "negateFilter": false,
         "sourceIDs": [],
         "typeSeverity": [{
            "severity": "INFORMATIONAL",
            "type": "AUDIT"
         },
         ...,
         {
            "severity": "FATAL",
            "type": "AUDIT"
         }],
      }
   },
   "forwardHidden": false,
   "ftpAuthentication": "REGULAR",
   "ftpFileName": "event_[[EventSequenceID]].txt",
   "ftpPath": "lxca_events",
   "id": "1534862502642",
   "ignoreExcluded": false,
   "ipAddress": "192.0.2.30",
   "lastEditBy": "ADMIN",
   "matchEverything": true,
   "name": "FTP_forwarder",
   "outputFormat": "Alert: [[EventDate]] [[EventMessage]]\n\nHardware 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",
   "port": "21",
   "protocol": "ftp",
   "requestTimeout": 30,
   "scheduler": {
      "showSummary": false,
      "enabled": false,
      "events": []
   }
}

Table 4. REST Web Services.
Attributes				Type	Description
createdBy				String	Name of the user that created the event forwarder
description				String	Description for the event forwarder
enable				Boolean	Indicates whether the event forwarder is enabled. This can be one of the following values. true. (default) The event forwarder is enabled. false. The event forwarder is disabled.
eventFilter				Object	Information about the types of events to forward
	filter			Object	Information about each event filter
		categories		Array of strings	Event categories. This can be one or more of the following values. BULLETIN. Sends notification about new bulletins. GENERAL. Sends notifications about audit events, based on the selected event classes and severities STATUS_CHANGE. Sends notifications about changes in status. STATUS_UPDATE WARRANTY. Send notifications about warranties.
		componentIDs		Array of strings	List of component IDs. If empty, all components are accepted.
		eventID		String	List of event IDs, separated by a comma, to be included
		eventServices		Array of strings	Service type. This can be one or both of the following values. none support user
		excludedEventIDs		String	List of event IDs, separated by a comma, to be excluded
		negateFilter		Boolean	Indicates whether to exclude events that match the specified filter. This can be one of the following values. true. Excludes (does not forward) events that match the specified filters. false. Includes (forwards) events that match the specified filters.
		resourceGroupsUUIDs		Array of strings	List of resource
		sourceIDs		Array of strings	List of source IDs. If empty, all sources are monitored.
		typeSeverity		Array of objects	Event severity and type If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter are forwarded.
			severity	String	Event severity. This can be one of the following values. Unknown. The severity is unknown. Informational. Informational Warning. User can decide if action is needed. Minor. Action is needed, but the situation is not serious at this time. Major. Action is needed now. Critical. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result). Fatal. A non-recoverable error has occurred.
			type	String	Event type. This can be one of the following values. Unknown Audit Cooling Power Disks. Storage Memory Processor System. Rack or tower server Test Adaptor. Adapter card Expansion. Expansion board IOModule. Flex System switch Blade. Flex System server Switch Other Backplane Chassis Drive ExtDrive. External drive Fan M2Adapter M2Drive OCP PCIE PSU Retimer Riser 7MMDrive Pump
forwardHidden				Boolean	Specifies whether to forward hidden events. This can be one of the following values. true. Hidden events are forwarded. false. (default) Hidden events are not forwarded.
id				String	Event forwarderID
ignoreExcluded				Boolean	Specifies whether to disable the forwarding of excluded events. This can be one of the following values. true. Ignores excluded events. false. (default) Forwards excluded events.
ipAddress				String	IPv4 or IPv6 address or hostname of the remote system that is the target to receive the events. For email, this is the SMTP server.
lastEditBy				String	Name of the user that last edited the event forwarder
matchEverything				Boolean	Indicates whether the action is to be run against all managed devices. This can be one of the following values. true. The action is to be run against all managed devices. false. The action is run against only the managed device that is specified by the target attribute.
name				String	User-defined name for the event forwarder. This name must be unique for all event forwarders.
outputFormat				String	Output format of the forwarded event Text between double square brackets are the fields that which are replaced with actual values. For a description of each field, use GET /events/monitors?format=formatKeys.
port				String	TCP/UDP port used for the connection. For REST Web Services, this value is always 80.
protocol				String	Type of event forwarder. For REST Web Services, this value is always rest.
requestTimeout				Integer	Amount of time, in seconds, that an event forwarder has to forward events before the request times out By default, the time-out value is 30 seconds.
restAuthentication				String	Authentication type. This can be one of the following values. basic. Authenticates to the specified server using the specified user ID and password. none. No authentication is used.
restMethod				String	REST method to use for forwarding events. This can be one of the following values. POST PUT
restPath				String	Resource path on which the forwarder is to post the events (for example, /rest/test)
restProtocol				String	Protocol to use for forwarding events. This can be one of the following values. HTTP HTTPS
restRequestHeaders				Array of strings	REST header to use for forwarding events
scheduler				Object	Information about times and days when you want the specified events to be forwarded to this event forwarder
	enabled			Boolean	Indicates whether the schedule is enabled. This can be one of the following values. true. The schedule is enabled. Only events that occur during the specified time slot are forwarded. false. The schedule is disabled. Events are forwarded 24x7.
	events			Array of objects	List of event-forwarding schedules
			calendar	String	Schedule name
			daysOfWeek	Array of strings	Days of the week. This can be one or more of the following values. 1. Monday 2. Tuesday 3. Wednesday 4. Thursday 5. Friday 6. Saturday 7. Sunday
			endingDate	String	Date when the schedule ends
			endTime	String	Time when the schedule ends
			id	Integer	Schedule ID
			initialEndTime	String
			initialStartTime	String
			repeatable	Boolean	Indicates whether the schedule is recurring. This can be one of the following values. true. The schedule is recurring. false. The schedule occurs only once.
			seriesId	Integer	Schedule index
			startingDate	String	Date when the schedule starts
			startTime	String	Time when the schedule starts
			summary	Boolean
	showSummary			String	Indicates whether the schedule summary is enabled. The summary includes the time slot for schedule and which schedules are repeatable. This can be one of the following values. true. The schedule summary is enabled. false. The schedule summary is disabled.

The following example is returned if the request is successful for event forwarders to REST recipients.

{
   "createdBy": "ADMIN",
   "description": "",
   "enable": "true",
   "eventFilter": {
      "filter": {
         "categories": ["WARRANTY", "GENERAL"],
         "componentIDs": [],
         "eventID": "",
         "excludedEventIDs": "",
         "eventServices": [],
         "negateFilter": false,
         "sourceIDs": [],
         "typeSeverity": [{
            "severity": "INFORMATIONAL",
            "type": "AUDIT"
         },
         ...,
         {
            "severity": "FATAL",
            "type": "AUDIT"
         }]
      }
   },
   "forwardHidden": false,
   "id": "1520009679583",
   "ignoreExcluded": false,
   "ipAddress": "192.0.2.40",
   "lastEditBy": "ADMIN",
   "matchEverything": true,
   "name": "REST_forwarder",
   "outputFormat": "{\"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]]\"}",
   "port": "80",
   "protocol": "rest",
   "requestTimeout": 30,
   "restAuthentication": "NONE",
   "restMethod": "POST",
   "restPath": "lxca_events",
   "restProtocol": "HTTP",
   "restRequestHeaders": [],
   "scheduler": {
      "enabled": false,
      "events": [],
      "showSummary": false
   }
}

Table 5. Remote SNMPv1 or SNMPv3 manager.
Attributes				Type	Description
authPasswordSet				String	Password string. This attribute is required if you specify authUser.
authProtocol				String	Authentication protocol. This can be one of the following. MD5 SHA This attribute is required if you specify authUser.
authUser				String	Authentication user ID if authentication is used
community				String	(SNMPv1 only) The community password that is sent with every SNMP request to the device.
contactName				String	The user-defined contact name for XClarity Administrator traps
createdBy				String	Name of the user that created the event forwarder
description				String	Description for the event forwarder
enable				Boolean	Indicates whether the event forwarder is enabled. This can be one of the following values. true. (default) The event forwarder is enabled. false. The event forwarder is disabled.
eventFilter				Object	Information about the types of events to forward
	filter			Object	Information about each event filter
		categories		Array of strings	Event categories. This can be one or more of the following values. BULLETIN. Sends notification about new bulletins. GENERAL. Sends notifications about audit events, based on the selected event classes and severities STATUS_CHANGE. Sends notifications about changes in status. STATUS_UPDATE WARRANTY. Send notifications about warranties.
		componentIDs		Array of strings	List of component IDs. If empty, all components are accepted.
		eventID		String	List of event IDs, separated by a comma, to be included
		eventServices		Array of strings	Service type. This can be one or both of the following values. none support user
		excludedEventIDs		String	List of event IDs, separated by a comma, to be excluded
		negateFilter		Boolean	Indicates whether to exclude events that match the specified filter. This can be one of the following values. true. Excludes (does not forward) events that match the specified filters. false. Includes (forwards) events that match the specified filters.
		resourceGroupsUUIDs		Array of strings	List of resource
		sourceIDs		Array of strings	List of source IDs. If empty, all sources are monitored.
		typeSeverity		Array of objects	Event severity and type If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter are forwarded.
			severity	String	Event severity. This can be one of the following values. Unknown. The severity is unknown. Informational. Informational Warning. User can decide if action is needed. Minor. Action is needed, but the situation is not serious at this time. Major. Action is needed now. Critical. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result). Fatal. A non-recoverable error has occurred.
			type	String	Event type. This can be one of the following values. Unknown Audit Cooling Power Disks. Storage Memory Processor System. Rack or tower server Test Adaptor. Adapter card Expansion. Expansion board IOModule. Flex System switch Blade. Flex System server Switch Other Backplane Chassis Drive ExtDrive. External drive Fan M2Adapter M2Drive OCP PCIE PSU Retimer Riser 7MMDrive Pump
forwardHidden				Boolean	Specifies whether to forward hidden events. This can be one of the following values. true. Hidden events are forwarded. false. (default) Hidden events are not forwarded.
id				String	Event forwarder ID
ignoreExcluded				Boolean	Specifies whether to disable the forwarding of excluded events. This can be one of the following values. true. Ignores excluded events. false. (default) Forwards excluded events.
ipAddress				String	IPv4 or IPv6 address or hostname of the remote system that is the target to receive the events. For email, this is the SMTP server.
lastEditBy				String	Name of the user that last edited the event forwarder
location				String	Location information, such as site, address, and geography
matchEverything				Boolean	Indicates whether the action is to be run against all managed devices. This can be one of the following values. true. The action is to be run against all managed devices. false. The action is run against only the managed device that is specified by the target attribute.
name				String	User-defined name for the event forwarder. This name must be unique for all event forwarders.
port				String	TCP/UDP port used for the connection. For SNMP, this value is always 162.
privacyPasswordSet				String	Privacy password. This attribute is required if encryption is used.
privacyProtocol				String	Privacy protocol. This can be one of the following values. AES DES This attribute is required if you specify privacyPassword.
protocol				String	Type of event forwarder. For SNMP, this can be one of the following values. snmpv1. Events are forwarded to a remote SNMP manager using SNMPv1. snmpv3. Events are forwarded to a remote SNMP manager using SNMPv3. The trap formats for each event are defined in the lenovoMgrAlert.mib file.
requestTimeout				Integer	Amount of time, in seconds, that an event forwarder has to forward events before the request times out By default, the time-out value is 30 seconds.
scheduler				Object	Information about times and days when you want the specified events to be forwarded to this event forwarder
	enabled			Boolean	Indicates whether the schedule is enabled. This can be one of the following values. true. The schedule is enabled. Only events that occur during the specified time slot are forwarded. false. The schedule is disabled. Events are forwarded 24x7.
	events			Array of objects	List of event-fowarding schedules
			calendar	String	Schedule name
			daysOfWeek	Array of strings	Days of the week. This can be one or more of the following values. 1. Monday 2. Tuesday 3. Wednesday 4. Thursday 5. Friday 6. Saturday 7. Sunday
			endingDate	String	Date when the schedule ends
			endTime	String	Time when the schedule ends
			id	Integer	Schedule ID
			initialEndTime	String
			initialStartTime	String
			repeatable	Boolean	Indicates whether the schedule is recurring. This can be one of the following values. true. The schedule is recurring. false. The schedule occurs only once.
			seriesId	Integer	Schedule index
			startingDate	String	Date when the schedule starts
			startTime	String	Time when the schedule starts
			summary	Boolean
	showSummary			String	Indicates whether the schedule summary is enabled. The summary includes the time slot for schedule and which schedules are repeatable. This can be one of the following values. true. The schedule summary is enabled. false. The schedule summary is disabled.

The following example is returned if the request is successful for event forwarders to SNMPv3 recipients.

{
   "authPasswordSet": "false",
   "authProtocol": "NONE",
   "authUser": "",
   "contactName": "",
   "createdBy": "ADMIN",
   "description": "",
   "enable": "true",
   "eventFilter": {
      "filter": {
         "categories": ["GENERAL"],
         "componentIDs": [],
         "eventID": "",
         "eventServices": [],
         "excludedEventIDs": "",
         "negateFilter": false,
         "sourceIDs": [],
         "typeSeverity": [{
            "severity": "INFORMATIONAL",
            "type": "AUDIT"
         },
         ...,
         {
            "severity": "FATAL",
            "type": "AUDIT"
         }]
      }
   },
   "forwardHidden": false,
   "id": "1520009466990",
   "ignoreExcluded": false,
   "ipAddress": "192.0.2.50",
   "lastEditBy": "ADMIN",
   "location": "",
   "matchEverything": true,
   "name": "SNMP_forwarder",
   "port": "162",
   "privacyPasswordSet": "false",
   "privacyProtocol": "NONE",
   "protocol": "snmpv3",
   "requestTimeout": 30,
   "scheduler": {
      "enabled": true,
      "events": [{
         "calendar": "Calendar1",
         "daysOfWeek": ["1", "2", "3", "4", "5"],
         "endingDate": "2017-12-31T22:00:00.000Z",
         "endTime": "2017-10-06T21:00:00.000Z",
         "id": 0,
         "initialEndTime": "2017-10-06T21:00:00.000Z",
         "initialStartTime": "2017-10-06T12:00:00.000Z",
         "repeatable": true,
         "seriesId": 1
         "startingDate": "2017-10-06T12:00:00.000Z",
         "startTime": "2017-10-06T12:00:00.000Z",
         "summary": "Forwarder (repeatable)",
      }],
      "showSummary": false
   }
}

Table 6. Syslog.
Attributes				Type	Description
communicationProtocol				String	Identifies the type of protocol that the syslog monitor uses to send messages. This can be one of the following values. TCP UDP. (default)
createdBy				String	Name of the user that created the event forwarder
dateFormat				String	Format for the timestamp in the syslog. This can be one of the following values. Default_Format. The default format using local time, for example `Fri Mar 31 05:57:18 EDT 2017`. GMT. International standard (ISO8601) for dates and times, for example `2017-03-31T05:58:20-04:00`.
description				String	Description for the event forwarder
enable				Boolean	Indicates whether the event forwarder is enabled. This can be one of the following values. true. (default) The event forwarder is enabled. false. The event forwarder is disabled.
eventFilter				Object	Information about the types of events to forward
	filter			Object	Information about each event filter
		categories		Array of strings	Event categories. This can be one or more of the following values. BULLETIN. Sends notification about new bulletins. GENERAL. Sends notifications about audit events, based on the selected event classes and severities STATUS_CHANGE. Sends notifications about changes in status. STATUS_UPDATE WARRANTY. Send notifications about warranties.
		componentIDs		Array of strings	List of component IDs. If empty, all components are accepted.
		eventID		String	List of event IDs, separated by a comma, to be included
		eventServices		Array of strings	Service type. This can be one or both of the following values. none support user
		excludedEventIDs		String	List of event IDs, separated by a comma, to be excluded
		negateFilter		Boolean	Indicates whether to exclude events that match the specified filter. This can be one of the following values. true. Excludes (does not forward) events that match the specified filters. false. Includes (forwards) events that match the specified filters.
		resourceGroupsUUIDs		Array of strings	List of resource
		sourceIDs		Array of strings	List of source IDs. If empty, all sources are monitored.
		typeSeverity		Array of objects	Event severity and type. If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter are forwarded.
			severity	String	Event severity. This can be one of the following values. Unknown. The severity is unknown. Informational. Informational Warning. User can decide if action is needed. Minor. Action is needed, but the situation is not serious at this time. Major. Action is needed now. Critical. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result). Fatal. A non-recoverable error has occurred.
			type	String	Event type. This can be one of the following values. Unknown Audit Cooling Power Disks. Storage Memory Processor System. Rack or tower server Test Adaptor. Adapter card Expansion. Expansion board IOModule. Flex System switch Blade. Flex System server Switch Other Backplane Chassis Drive ExtDrive. External drive Fan M2Adapter M2Drive OCP PCIE PSU Retimer Riser 7MMDrive Pump
forwardHidden				Boolean	Specifies whether to forward hidden events. This can be one of the following values. true. Hidden events are forwarded. false. (default) Hidden events are not forwarded.
id				String	Event forwarder ID
ignoreExcluded				Boolean	Specifies whether to disable the forwarding of excluded events. This can be one of the following values. true. Ignores excluded events. false. (default) Forwards excluded events.
ipAddress				String	IPv4 or IPv6 address or hostname of the remote system that is the target to receive the events. For email, this is the SMTP server.
lastEditBy				String	Name of the user that last edited the event forwarder
matchEverything				Boolean	Indicates whether the action is to be run against all managed devices. This can be one of the following values. true. The action is to be run against all managed devices false. The action is run against only the managed device that is specified by the target attribute.
name				String	User-defined name for the event forwarder. This name must be unique for all event forwarders.
outputFormat				String	Output format of the forwarded event Text between double square brackets are the fields that which are replaced with actual values. For a description of each field, use GET /events/monitors?format=formatKeys.
port				String	TCP/UDP port used for the connection. For syslog, this value is always 514.
protocol				String	Type of event forwarder. For syslog, this value is always syslog.
requestTimeout				Integer	Amount of time, in seconds, that an event forwarder has to forward events before the request times out By default, the time-out value is 30 seconds.
scheduler				Object	Information about times and days when you want the specified events to be forwarded to this event forwarder
	enabled			Boolean	Indicates whether the schedule is enabled. This can be one of the following values. true. The schedule is enabled. Only events that occur during the specified time slot are forwarded. false. The schedule is disabled. Events are forwarded 24x7.
	events			Array of objects	List of event-fowarding schedules
			calendar	String	Schedule name
			daysOfWeek	Array of strings	Days of the week. This can be one or more of the following values. 1. Monday 2. Tuesday 3. Wednesday 4. Thursday 5. Friday 6. Saturday 7. Sunday
			endingDate	String	Date when the schedule ends
			endTime	String	Time when the schedule ends
			id	Integer	Schedule ID
			initialEndTime	String
			initialStartTime	String
			repeatable	Boolean	Indicates whether the schedule is recurring. This can be one of the following values. true. The schedule is recurring. false. The schedule occurs only once.
			seriesId	Integer	Schedule index
			startingDate	String	Date when the schedule starts
			startTime	String	Time when the schedule starts
			summary	Boolean
	showSummary			String	Indicates whether the schedule summary is enabled. The summary includes the time slot for schedule and which schedules are repeatable. This can be one of the following values. true. The schedule summary is enabled. false. The schedule summary is disabled.

The following example is returned if the request is successful for event forwarders to syslog recipients.

{
   "communicationProtocol": "UDP",
   "createdBy": "ADMIN",
   "dateFormat": "Default_Format",
   "description": "",
   "enable": "true",
   "eventFilter": {
      "filter": {
         "categories": ["WARRANTY", "GENERAL"],
         "componentIDs": [],
         "eventID": "",
         "eventServices": [],
         "excludedEventIDs": "",
         "negateFilter": false,
         "sourceIDs": [],
         "typeSeverity": [{
            "severity": "INFORMATIONAL",
            "type": "AUDIT"
         },
         ...,
         {
            "severity": "FATAL",
            "type": "AUDIT"
         }]
      }
   },
   "forwardHidden": false,
   "id": "1520009382682",
   "ignoreExcluded": true,
   "ipAddress": "192.0.2.60",
   "lastEditBy": "ADMIN",
   "matchEverything": true,
   "name": "syslog_forwarder",
   "outputFormat": "&lt;8[[SysLogSeverity]]&gt; [[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]]",
   "port": "514",
   "protocol": "syslog",
   "requestTimeout": 30,
   "scheduler": {
      "showSummary": false,
      "enabled": false,
      "events": []
   },
}

Give documentation feedback

GET /events/monitors/{monitor_id}

Authentication​

Request URL​

Query parameters​

Request body​

Response codes​

Response body​