Network

Interfaces

Specifies how the server should listen for incoming connections.

Interfaces |=|INTERFACE {
    |Service |Protocol |Interface |Port  |
    |Api     |Tls      |Any       |38690 |
}

API

Specifies how the server restricts API subsets.

Client

Client—standard command set; system commands permitted if user is server administrator with group escalation.

System

System—permits privileged commands without session validation; disallows unprivileged commands.

Protocols

Protocol
`Udp`
`Tcp`
`Http`

Secure

Whether or not to wrap protocol in security layer.

Interfaces

Sequence specifying the network interface to bind.

Key	Value
Any	`::`
Local	`127.0.0.1`

Any

Accepts connections from any source.

Valid for IPv6 and dual-stack systems; use 0.0.0.0 for IPv4.

IPv4 and IPv6 need to be bound separately on some systems.

Local

Accepts connections only from the local machine. This interface should be used for all unencrypted protocols.

Firewall

List of rules describing access control for incoming connections.

Firewall |=|FIREWALL {
    |Access  |Type  |Value        |Action   |
    | Client | Addr | "127.0.0.1" |[ deny  ]|
    | Any    | Any  |             |[ allow ]|
}

Access

Specifies the API subset that the rule regulates.

Key	Description
Client	Authenticate as client.
Domain	Authenticate as domain.
App	Authenticate as application.

Type

Type of data provided in Value.

Key	Description
Addr	IP address of the client.
Subnet	IP subnet of the client.
Domain	Client's host domain.
Inf	Interface of the client's connection.
Port	Local port of the client's connection.

Value

Value to match against connection properties.

Action

Actions to take if rule matches.