Phoebus alarm server¶

services.phoebus-alarm-server¶

services.phoebus-alarm-server.enable boolean[source]¶

Whether to enable the Phoebus Alarm server

By default this option will also enable the phoebus-alarm-logger service. Set services.phoebus-alarm-logger.enable to false to disable it. .

Default value¶

false

Example¶

true

services.phoebus-alarm-server.createTopics boolean[source]¶

Automatically create missing Kafka topics

Default value¶

true

services.phoebus-alarm-server.openFirewall boolean[source]¶

Open the firewall for all Phoebus Alarm related services.

This uses the port numbers configured in each related NixOS module.

Included services:

Phoebus Alarm Logger (if not disabled)

Warning

This opens the firewall on all network interfaces.

Default value¶

false

services.phoebus-alarm-server.settings attribute set of (string, package, bool, int or float)[source]¶

Configuration for the Phoebus Alarm Server.

These options will be put into a .properties file.

Note that options containing a “.” must be quoted.

Default value¶

{ }

services.phoebus-alarm-server.settings."org.phoebus.applications.alarm/config_names" list of string[source]¶

Names of selectable alarm configurations.

Will be used as the name for the Kafka topic.

Default value¶

[
  "Accelerator"
]

services.phoebus-alarm-server.settings."org.phoebus.applications.alarm/server" string[source]¶: Kafka server host:port

services.phoebus-alarm-server.settings."org.phoebus.email/from" string[source]¶

Default address to be used for the email field From.

If left empty, then the last used from address is used.

Default value¶

""

services.phoebus-alarm-server.settings."org.phoebus.email/mailhost" string[source]¶

The SMTP server host.

If set to "DISABLE" (the default), email support is disabled.

Default value¶

"DISABLE"

services.phoebus-alarm-server.settings."org.phoebus.email/mailport" 16 bit unsigned integer; between 0 and 65535 (both inclusive)[source]¶

The SMTP server port.

Default value¶

services.phoebus-alarm-server.settings."org.phoebus.email/password" string[source]¶

Password for authenticating to the SMTP server.

Note

The password will be put in plaintext, in the world-readable /nix/store.

Default value¶

""

services.phoebus-alarm-server.settings."org.phoebus.email/username" string[source]¶

Username for authenticating to the SMTP server.

Default value¶

""

services.phoebus-alarm-server.settings."org.phoebus.pv.ca/addr_list" list of string[source]¶

Channel Access address list

Default value¶

[ ]

services.phoebus-alarm-server.settings."org.phoebus.pv.ca/auto_addr_list" boolean[source]¶

Derive the CA address list from the available network interfaces

Default value¶

true