Get a Quote   (408) 943-4100               TrueNAS Discord      VendOp_Icon_15x15px   Commercial Support Toggle between Light and Dark mode

Alert Services

  2 minute read.

Last Modified 2022-05-06 16:31 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

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.
NameDescription
Email AddressEnter a valid email address to receive alerts from this system.
NameDescription
HostEnter the InfluxDB hostname.
UsernameUsername for this service.
PasswordEnter password.
DatabaseName of the InfluxDB database.
SeriesInfluxDB time series name for collected points.
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.
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.
NameDescription
Service KeyEnter or paste the “integration/service” key for this system to access the PagerDuty API.
Client NamePagerDuty client name.
NameDescription
Webhook URLPaste the incoming webhook URL associated with this service.
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.
NameDescription
API KeyEnter or paste the VictorOps API key.
Routing KeyEnter or paste the VictorOps routing key.