Alert options

Configuration options for the different types of alert.

Properties

PCRE pattern

A PCRE pattern to match against serial input on the selected ports.

A details description of the PCRE format can be found at https://www.pcre.org/original/doc/html/pcrepattern.html and a quick reference summary at https://www.pcre.org/original/doc/html/pcresyntax.html . For simple use cases, a sequence of words and be entered and will match that same sequence of words.

  • Data type: string
  • Configuration
  • Required

CLI: (cli)> config alerting serial-alert <key> alert-options pattern-match

Control line

Alert on the status of an input control line changing.

The DCD signal is only available on ports in rolled mode.

OptionLabelDescription
ctsCTSClear To Send (CTS)
dsrDSRData Set Ready (DSR)
dcdDCDData Carrier Detect (DCD)
  • Data type: string select
  • Default: dsr
  • Configuration
  • Required

CLI: (cli)> config alerting serial-alert <key> alert-options control-line

User event

Alert on the connected status of a user.

OptionLabelDescription
connectUser connectAlert when a user connects to the serial port.
disconnectUser disconnectAlert when a user disconnects from the serial port.
eitherEitherAlert when a user connects or disconnects from the serial port.
  • Data type: string select
  • Default: either
  • Configuration
  • Required

CLI: (cli)> config alerting serial-alert <key> alert-options user-event