PVA gateway

List of NixOS option for deploying the pvAccess Gateway.

See also

The PVA gateway user guide for how to use these options.

services.pva-gateway.enable boolean

Whether to enable the PVA gateway.

Default value

false

Example

true

services.pva-gateway.settings open submodule of (JSON value)

Configuration for the PVA gateway.

See the PVA gateway configuration file documentation for a complete list of available settings.

services.pva-gateway.settings.clients list of (open submodule of (JSON value))

List of pvAccess clients.

Example

[
  {
    name = "broadcast-client";
  }
]

services.pva-gateway.settings.clients.*.addrlist string or (list of string) convertible to it

Sets EPICS_PVA_ADDR_LIST for this client.

Default value

[ ]

Example

[
  "192.168.0.255"
]

services.pva-gateway.settings.clients.*.autoaddrlist boolean

Sets EPICS_PVA_AUTO_ADDR_LIST for this client.

Default value

true

services.pva-gateway.settings.clients.*.name string

Name for the pvAccess client.

Example

"client192"

services.pva-gateway.settings.servers list of (open submodule of (JSON value))

List of pvAccess servers.

Example

[
  {
    name = "any-server";
  }
]

services.pva-gateway.settings.servers.*.addrlist string or (list of string) convertible to it

List of IP addresses where to send beacons.

Sets the EPICS_PVAS_BEACON_ADDR_LIST environment variable.

Default value

[ ]

Example

[
  "10.1.1.255"
]

services.pva-gateway.settings.servers.*.autoaddrlist boolean

Whether to populate the beacon address list automatically. (recommended)

Sets EPICS_PVAS_AUTO_BEACON_ADDR_LIST for this client.

Default value

true

services.pva-gateway.settings.servers.*.clients list of string

This server serves PVs that are obtained from the given clients.

Example

[
  "client192"
]

services.pva-gateway.settings.servers.*.interface list of string

Which local IP addresses this server listens on.

Sets the EPICS_PVAS_INTF_ADDR_LIST environment variable.

Default value

[
  "0.0.0.0"
]

Example

[
  "10.1.1.4"
]

services.pva-gateway.settings.servers.*.name string

Name for the pvAccess server.

Example

"server10"

services.pva-gateway.settings.servers.*.pvlist absolute path or string

PVList file used to restrict access to certain PVs through this server

Default value

""

Example

pkgs.writeText "gateway.pvlist" ''
  EVALUATION ORDER ALLOW, DENY

  .* ALLOW

  MY_PV1 DENY
  MY_PV2 DENY

  # Or:

  MY_PV[0-9]+ DENY
''

services.pva-gateway.settings.servers.*.statusprefix null or string

Prefix for the gateway status PVs.

Default value

null

Example

"GW:STS:"

services.pva-gateway.settings.version signed integer

Version of the configuration.

Default value

2