Data forwarding
XClarity One can forward data about events that occur in your environment, based on criteria (filters) that you select, to external services that you can then use to monitor and analyze the data. Every event generated is monitored to see if it matches the criteria. If it matches, the event is forwarded to the specified destination using the appropriate protocol.
You can create up to 20 data forwarders. To create a data forwarder, click Data forwarding in the context menu of the Settings view, click the Add icon (
) on the Data forwarding panel, and then follow instructions in the wizard.
For XClarity One in the cloud, you can test the connection to the external service from the Configure tab in the wizard before saving the data forwarder. When you click Test connection, a test event is sent using the provided configuration settings.
Event criteria
Use the advanced search field to choose the events to forward based on the following types of criteria. If you do not provide criteria, data is forwarded for all events that are generated by all resources (managed devices, hubs, and XClarity One portal).
- Anywhere (any event attribute)
- Event code (for example FQXHMDI0101I; see Event messages)
- Event
- Resource
- Description
- Severity (informational, warning, critical)
- Serviceability (none, serviceable, user)
- Event class (analytics, audit, service, system)
To send notifications about all new critical audit events
Event class : audit, Severity : criticalTo send notifications about all new warranty events
Event code : FQXXOWATo send notifications about all new events except warranty and license events
Event code !: FQXXOWA,FQXXOLSTo send notifications about all new events for which a service ticket was created:
Serviceability : serviceable
Trusted certificates
When running XClarity One on premises, you can manage trusted root and intermediate CA certificates that are used by the portal to establish secure TLS communication with external services that rely on privately signed certificates.
Test the connection to the forwarder destination by clicking Test Connection in the Data Forwarder wizard. During the test-connection process, XClarity One imports and validates the certificate chain from the forwarder destination. After the certificate is validated, XClarity One sends a sample event to the forwarder destination.
Click Data forwarding in the context menu of the Settings view, click the Add icon (
) on the Trust store panel, and then follow instructions in the wizard.
Forwarder destinations
Email
You can forward event data to email addresses for one or more users in the organization. You cannot forward event data to external users.
New events that match the selected criteria are forwarded via email every hour. The emails are sent from the specified mail sender with the subject “Buffered Event Forwarding.”
Events are listed in tabular format, one row per event. Up to 3,000 events can be sent in a single email. If more 3,000 events were raised during the last hour, multiple emails are sent.
ImportantWhen running XClarity One on premises, an SMTP email server must be configured and enabled before you can create data forwarder to an email service (see SMTP configuration).
If the SMTP server is not configured correctly or if the credentials fail, the SMTP configuration is automatically disabled. When the SMTP configuration is disabled, you cannot create a new data forwarder and existing SMTP data forwarders cannot forward data.
If you change the filter criteria for the forwarder, events that were buffered before the changes were saved will match the previous filter criteria, and events that were buffered after the changes were saved will match the latest filter criteria. So, the email that is sent after the changes were save might have some events that match the previous filter criteria.
Syslog
When using XClarity One on premises, you can forward event data to a central log server, where native tools can be used to monitor syslog data.
New events that match the selected criteria are forwarded over the network to the central log server as soon as the events are raised.
Event data is forwarded as plain text using the following format by default.
eventID=[[EventID]] eventCode=[[EventCode]] timestamp=[[EventTimestamp]] severity=[[EventSeverity]] class=[[EventClass]] description=[[Description]] message=[[EventMessage]] action=[[UserAction]] deviceName=[[DeviceName]] deviceIP=[[DeviceIPAddress]] deviceSerialNum=[[DeviceSerialNumber]] serviceability=[[EventServiceability]] hubIP=[[HubIPAddress]] sourceType=[[SourceType]] username=[[Username]]
All words between double square brackets are the variables that are replaced with actual values when an event is forwarded.
eventID=207223 eventCode=FQXHMDI0119I timestamp=2026-02-02T08:27:17.551Z severity=informational class=audit description=The unmanagement of the server has been requested by user. message=User hazel@acme.com started unmanagement of server with UUID E1C6AC7A254941A9BBE476B7176A82BC (IP: 192.0.2.13) action=none deviceName=Server-C deviceIP=192.0.2.127 deviceSerialNum=176A82BC serviceability=none hubIP=192.0.2.15 sourceType=server username=hazel@acme.com
You can optionally customize the event data that is sent by defining each custom attribute name and type (surrounded by double square brackets), separated by an equal sign. Separate each attribute name and type pair using a space. You can use the following attribute types.[[EventCode]]. Event code
[[Description]]. Event description
[[DeviceName]]. Target device name that is displayed in the user interface. If the target of the event is not a device, this value is null.
[[DeviceIPAddress]]. Target device IP address. If the target of the event is not a device, this value is null.
[[DeviceSerialNumber]]. Target device serial number. If the target of the event is not a device, this value is null.
[[EventClass]]. Event class
[[EventID]]. Event ID
[[EventMessage]]. Event message
[[EventServiceability]]. Event serviceability
[[EventSeverity]]. Event severity
[[EventTimestamp]]. Timestamp, in ISO-8601 format when the event was raised
[[HubIPAddress]]. Management hub IP address
[[SourceType]]. Source type
[[UserAction]]. User actions that can be taken to recover from the issue
[[Username]]. Name of the user that initiated the request. For audit events, this is the email address of the user account. For non-audit events, this is the name of the service.
Web service
For XClarity One portal in the cloud, you can forward event data to external REST web services hosted on cloud, such as ServiceNow Cloud. Direct communication with web services that are not in the cloud are not permitted. If your cloud-based web service is not supported, open a service ticket using the Submit an eTicket webpage.
For XClarity One on premises, you can forward event data to only ServiceNow Cloud. Other REST web services are not supported.
New events that match the selected criteria are forwarded over the network to the web service as soon as the events are raised, using the HTTPS protocol. Port 443 is used by default.
Attention- Ensure that the trusted certificates for the web server are imported into the XClarity One trust store.
- Ensure that ServiceNow Cloud is configured to accept valid incoming traffic.
- Ensure that ServiceNow Cloud uses a trusted CA-signed certificate. Self-signed certificates are not supported.
- Ensure that you test the connection to the web service by clicking Test Connection in the Data Forwarder wizard. During the test-connection process, XClarity One imports and validates the certificate chain from the web service. After the certificate is validated, XClarity One sends a sample event to the web service.
Event data is forwarded in JSON format. The following example shows event data that is forwarded to the web service.{
"id": 3395,
"action": "new",
"category": "drives",
"description": "When a hardware event is detected by the Lenovo XClarity Controller on the
server, the Lenovo XClarity Controller writes that event in the system-event
log on the server.",
"eventClass": "service",
"eventCode": "FQXSPSD0001L",
"flags": [],
"fruType": "drives",
"manager": {
"id": "B0018518B16549398A088862CAF1F705",
"ipAddress": "10.241.36.230",
"name": "DEV HUB 2757",
"type": "XClarity Management Hub"
},
"message": "Drive Drive 0 in the enclosure has been disabled due to a detected fault.",
"messageArgs": [ "Drive 0" ],
"service": "serviceable",
"severity": "critical",
"source": {
"id": "AE9FBDFA62F911E988453A68DD01A3F7-B0018518B16549398A088862CAF1F705",
"groups": [],
"name": "J100CVZW",
"type": "server"
},
"targetResource": {
"id": "AE9FBDFA62F911E988453A68DD01A3F7-B0018518B16549398A088862CAF1F705",
"groups": [],
"name": "J100CVZW",
"type": "server"
},
"timestamp": "2025-02-18T12:32:06.419Z",
"userAction": "Complete the following steps until the problem is solved: \n1) Reboot the system
and confirm that the drive is still in failed state.\n2) Collect Service Data
log.\n3) Contact Lenovo Support.",
"_links": {
"rel": "self",
"uri": "/api/v1/monitoring/events/3395"
}
}