Skip to main content
Version: 2.12

leafnodes

Aliases: leaf
Hot Reloadable
Changing a remote fails the reload, as do changes to the leafnode host, port, advertise or authorization.

Configuration for setting up leaf node connections.

Properties

Incoming Connections

A server that has been configured to accept connections from one or more leaf nodes. This would be the hub in a hub-and-spoke topology, for example.

NameDescriptionTypeDefaultReloadable
hostHost name the server will listen on for incoming leaf node connections.string0.0.0.0No
portPort the server will listen for incoming leaf node connections.integer7422No*
listenstring-No
tlsTLS configuration for securing leaf node connections.object-Yes*
advertiseHostport to advertise how this sever be contacted by leaf nodes. This is useful for setups with a NAT.string-No
no_advertiseIf true, the server will not be advertised to leaf nodes.booleanfalseNo
authorizationAuthorization scoped to accepting leaf node connections.object-No
isolate_leafnode_interestDo not propagate subscription interest learned from one leaf node to the others attached to this server.booleanfalseNo
write_deadlineHow long a leaf node write may block before the connection is treated as stalled.duration10sNo
write_timeoutWhat to do when a leaf node connection misses its write_deadline.stringdefaultNo
min_versionThe minimum server version required of the connecting leaf node. This must be at least version 2.8.0.string-No
compressionDefines the compression mode to use for an incoming leafnode connection. If set to on, it will use the s2_auto.(multiple)-Yes*

* See the property page for reload caveats.

Outgoing Connections

A server that has been configured to connect to another server configured to accept leaf node connections. In a hub-and-spoke topology, this would be the spoke, typically in a remote location or on an edge device.

NameDescriptionTypeDefaultReloadable
remotesList of entries specifiying servers where the leaf node client connection can be made.object-No
reconnectInterval in seconds at which reconnect attempts to a remote server are made.integer-No