Get a Quote     (408) 943-4100   TrueNAS Discord VendOp_Icon_15x15px Commercial Support
TrueNAS.com Software Systems Company Community Security iX Portal Download
TrueNAS CORE TrueNAS Enterprise TrueNAS SCALE Compare Editions TrueCommand Software Status FreeNAS
Compare Systems F-Series M-Series X-Series R-Series Mini Series
About iXsystems Our Clients Reviews Careers Awards iX Blog & News iX Website Contact Us
Community Forum Discord TrueNAS GitHub TrueNAS Merch Store
Application Analytics Backup and Archival Cloud Data Mobility File Sharing iX Storj Media Creation Video Surveillance Virtualization
Industry Automotive Education Gaming Government Healthcare MSP Manufacturing Research & AI Media & Entertainment
Download TrueNAS CORE Download TrueNAS SCALE Get TrueNAS Enterprise Compare TrueNAS Editions Where to Buy
  1. Documentation Hub
  2. /
  3. TrueNAS CORE
  4. /
  5. UI Reference Guide
  6. /
  7. System
  8. /
  9. Alert Services
Edit page
TrueNAS CORETrueNAS CORE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

Alert Services

  2 minute read.

Last Modified 2024-03-15 13:07 EDT

SystemAlertServicesAdd

Name and Type

NameDescription
NameName of the new alert service.
EnabledUnset to disable this service without deleting it.
TypeChoose an alert service to display options for that service.
LevelSelect the level of severity.

Authentication

AWS
NameDescription
AWS RegionEnter the AWS account region.
ARNTopic Amazon Resource Name (ARN) for publishing. Example: arn:aws:sns:us-west-2:111122223333:MyTopic.
Key IDAccess Key ID for the linked AWS account.
Secret KeySecret Access Key for the linked AWS account.
Email
NameDescription
Email AddressEnter a valid email address to receive alerts from this system.
InfluxDB
NameDescription
HostEnter the InfluxDB hostname.
UsernameUsername for this service.
PasswordEnter password.
DatabaseName of the InfluxDB database.
SeriesInfluxDB time series name for collected points.
Mattermost
NameDescription
Webhook URLEnter or paste the incoming webhook URL associated with this service.
UsernameMattermost username.
ChannelName of the channel to receive notifications. This overrides the default channel in the incoming webhook settings.
Icon UrlIcon file to use as the profile picture for new messages. Example: https://mattermost.org/wp-content/uploads/2016/04/icon.png. Requires configuring Mattermost to override profile picture icons.
OpsGenie
NameDescription
API KeyEnter or paste the API key. Find the API key by signing into the OpsGenie web interface and going to Integrations/Configured Integrations. Click the desired integration, Settings, and read the API Key field.
API URLLeave empty for default OpsGenie API.
PagerDuty
NameDescription
Service KeyEnter or paste the “integration/service” key for this system to access the PagerDuty API.
Client NamePagerDuty client name.
Slack
NameDescription
Webhook URLPaste the incoming webhook URL associated with this service.
SNMP Trap
NameDescription
HostnameHostname or IP address of the system to receive SNMP trap notifications.
PortUDP port number on the system receiving SNMP trap notifications. The default is 162.
SNMPv3 Security ModelEnable the SNMPv3 security model.
SNMP CommunityNetwork community string. The community string acts like a user ID or password. A user with the correct community string has access to network information. The default is public. For more information, see this helpful SNMP Community Strings tutorial.
VictorOps
NameDescription
API KeyEnter or paste the VictorOps API key.
Routing KeyEnter or paste the VictorOps routing key.

Related Content

CORE UI Reference
CORE Tutorials

Have more questions?

For further discussion or assistance, see these resources:

Found content that needs an update?  You can suggest content changes directly! To request changes to this content, click the Feedback button located on the middle-right side of the page (might require disabling ad blocking plugins).