# PermittedPeer

Restricts connections to listed peer identities.

This parameter applies to imtcp: TCP Syslog Input Module.

Name:

  PermittedPeer

Scope:

  module, input

Type:

  array

Default:

  module=none, input=module parameter

Required?:

  no

Introduced:

  at least 5.x, possibly earlier

## Description

Sets permitted peer IDs. Only these peers are able to connect to the listener. <id-string> semantics depend on the currently selected AuthMode and network stream driver. PermittedPeer may not be set in anonymous modes. PermittedPeer may be set either to a single peer or an array of peers either of type IP or name, depending on the tls certificate.

Single peer: PermittedPeer=”127.0.0.1”

Array of peers: PermittedPeer=[“test1.example.net”,”10.1.2.3”,”test2.example.net”,”…”]

The same-named input parameter can override this module setting.

## Module usage

    module(load="imtcp" permittedPeer="127.0.0.1")

## Input usage

    input(type="imtcp" port="514" permittedPeer="127.0.0.1")

### Legacy names (for reference)

Historic names/directives for compatibility. Do not use in new configs.

- $InputTCPServerStreamDriverPermittedPeer — maps to PermittedPeer (status: legacy)

## See also

See also imtcp: TCP Syslog Input Module.

Support: rsyslog Assistant | GitHub Discussions | GitHub Issues: rsyslog source project

Contributing: Source & docs: rsyslog source project

© 2008–2025 Rainer Gerhards and others. Licensed under the Apache License 2.0.