Config::Model::models::Systemd::Section::Socket (3)
Leading comments
Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) Standard preamble: ========================================================================
NAME
Config::Model::models::Systemd::Section::Socket - Configuration class Systemd::Section::SocketDESCRIPTION
Configuration classes used by Config::ModelA unit configuration file whose name ends in ".socket" encodes information about an
This man page lists the configuration options specific to this unit type. See systemd.unit(5) for the common options of all unit configuration files. The common configuration items are configured in the generic [Unit] and [Install] sections. The socket specific configuration options are configured in the [Socket] section.
Additional options are listed in systemd.exec(5), which define the execution environment the "ExecStartPre", "ExecStartPost", "ExecStopPre" and "ExecStopPost" commands are executed in, and in systemd.kill(5), which define the way the processes are terminated, and in systemd.resource-control(5), which configure resource control settings for the processes of the socket.
For each socket file, a matching service file must exist, describing the service to start on incoming traffic on the socket (see systemd.service(5) for more information about .service files). The name of the .service unit is by default the same as the name of the .socket unit, but can be altered with the "Service" option described below. Depending on the setting of the "Accept" option described below, this .service unit must either be named like the .socket unit, but with the suffix replaced, unless overridden with "Service"; or it must be a template unit named the same way. Example: a socket file foo.socket needs a matching service foo.service if "Accept=false" is set. If "Accept=true" is set, a service template file foo@.service must exist from which services are instantiated for each incoming connection.
Unless "DefaultDependencies" in the "[Unit]" section is set to "false", socket units will implicitly have dependencies of type "Requires" and "After" on sysinit.target as well as dependencies of type "Conflicts" and "Before" on shutdown.target. These ensure that socket units pull in basic system initialization, and are terminated cleanly prior to system shutdown. Only sockets involved with early boot or late system shutdown should disable this option.
Socket units will have a "Before" dependency on the service which they trigger added implicitly. No implicit "WantedBy" or "RequiredBy" dependency from the socket to the service is added. This means that the service may be started without the socket, in which case it must be able to open sockets by itself. To prevent this, an explicit "Requires" dependency may be added.
Socket units may be used to implement on-demand starting of services, as well as parallelized starting of services. See the blog stories linked at the end for an introduction.
Note that the daemon software configured for socket activation with socket units needs to be able to accept sockets from systemd, either via systemd's native socket passing interface (see sd_listen_fds(3) for details) or via the traditional inetd(8)-style socket passing (i.e. sockets passed in via standard input and output, using "StandardInput=socket" in the service file). This configuration class was generated from systemd documentation. by parse-man.pl <github.com/dod38fr/config-model-systemd/contrib/parse-man.pl>
Elements
ListenStream
Specifies an address to listen on for a stream ("SOCK_STREAM"), datagram ("SOCK_DGRAM"), or sequential packet ("SOCK_SEQPACKET") socket, respectively. The address can be written in various formats:If the address starts with a slash ("/"), it is read as file system socket in the "AF_UNIX" socket family.
If the address starts with an at symbol ("@"), it is read as abstract namespace socket in the "AF_UNIX" family. The "@" is replaced with a "NUL" character before binding. For details, see unix(7).
If the address string is a single number, it is read as port number to listen on via IPv6. Depending on the value of "BindIPv6Only" (see below) this might result in the service being available via both IPv6 and IPv4 (default) or just via IPv6.
If the address string is a string in the format v.w.x.y:z, it is read as IPv4 specifier for listening on an address v.w.x.y on a port z.
If the address string is a string in the format [x]:y, it is read as IPv6 address x on a port y. Note that this might make the service available via IPv4, too, depending on the "BindIPv6Only" setting (see below).
Note that "SOCK_SEQPACKET" (i.e. "ListenSequentialPacket") is only available for "AF_UNIX" sockets. "SOCK_STREAM" (i.e. "ListenStream") when used for
These options may be specified more than once, in which case incoming traffic on any of the sockets will trigger service activation, and all listed sockets will be passed to the service, regardless of whether there is incoming traffic on them or not. If the empty string is assigned to any of these options, the list of addresses to listen on is reset, all prior uses of any of these options will have no effect.
It is also possible to have more than one socket unit for the same service when using "Service", and the service will receive all the sockets configured in all the socket units. Sockets configured in one unit are passed in the order of configuration, but no ordering between socket units is specified.
If an
ListenDatagram
Specifies an address to listen on for a stream ("SOCK_STREAM"), datagram ("SOCK_DGRAM"), or sequential packet ("SOCK_SEQPACKET") socket, respectively. The address can be written in various formats:If the address starts with a slash ("/"), it is read as file system socket in the "AF_UNIX" socket family.
If the address starts with an at symbol ("@"), it is read as abstract namespace socket in the "AF_UNIX" family. The "@" is replaced with a "NUL" character before binding. For details, see unix(7).
If the address string is a single number, it is read as port number to listen on via IPv6. Depending on the value of "BindIPv6Only" (see below) this might result in the service being available via both IPv6 and IPv4 (default) or just via IPv6.
If the address string is a string in the format v.w.x.y:z, it is read as IPv4 specifier for listening on an address v.w.x.y on a port z.
If the address string is a string in the format [x]:y, it is read as IPv6 address x on a port y. Note that this might make the service available via IPv4, too, depending on the "BindIPv6Only" setting (see below).
Note that "SOCK_SEQPACKET" (i.e. "ListenSequentialPacket") is only available for "AF_UNIX" sockets. "SOCK_STREAM" (i.e. "ListenStream") when used for
These options may be specified more than once, in which case incoming traffic on any of the sockets will trigger service activation, and all listed sockets will be passed to the service, regardless of whether there is incoming traffic on them or not. If the empty string is assigned to any of these options, the list of addresses to listen on is reset, all prior uses of any of these options will have no effect.
It is also possible to have more than one socket unit for the same service when using "Service", and the service will receive all the sockets configured in all the socket units. Sockets configured in one unit are passed in the order of configuration, but no ordering between socket units is specified.
If an
ListenSequentialPacket
Specifies an address to listen on for a stream ("SOCK_STREAM"), datagram ("SOCK_DGRAM"), or sequential packet ("SOCK_SEQPACKET") socket, respectively. The address can be written in various formats:If the address starts with a slash ("/"), it is read as file system socket in the "AF_UNIX" socket family.
If the address starts with an at symbol ("@"), it is read as abstract namespace socket in the "AF_UNIX" family. The "@" is replaced with a "NUL" character before binding. For details, see unix(7).
If the address string is a single number, it is read as port number to listen on via IPv6. Depending on the value of "BindIPv6Only" (see below) this might result in the service being available via both IPv6 and IPv4 (default) or just via IPv6.
If the address string is a string in the format v.w.x.y:z, it is read as IPv4 specifier for listening on an address v.w.x.y on a port z.
If the address string is a string in the format [x]:y, it is read as IPv6 address x on a port y. Note that this might make the service available via IPv4, too, depending on the "BindIPv6Only" setting (see below).
Note that "SOCK_SEQPACKET" (i.e. "ListenSequentialPacket") is only available for "AF_UNIX" sockets. "SOCK_STREAM" (i.e. "ListenStream") when used for
These options may be specified more than once, in which case incoming traffic on any of the sockets will trigger service activation, and all listed sockets will be passed to the service, regardless of whether there is incoming traffic on them or not. If the empty string is assigned to any of these options, the list of addresses to listen on is reset, all prior uses of any of these options will have no effect.
It is also possible to have more than one socket unit for the same service when using "Service", and the service will receive all the sockets configured in all the socket units. Sockets configured in one unit are passed in the order of configuration, but no ordering between socket units is specified.
If an
ListenFIFO
Specifies a file systemListenSpecial
Specifies a special file in the file system to listen on. This expects an absolute file system path as argument. Behavior otherwise is very similar to the "ListenFIFO" directive above. Use this to open character device nodes as well as special files in /proc and /sys. Optional. Type list of uniline.ListenNetlink
Specifies a Netlink family to create a socket for to listen on. This expects a short string referring to the "AF_NETLINK" family name (such as "audit" or "kobject-uevent") as argument, optionally suffixed by a whitespace followed by a multicast group integer. Behavior otherwise is very similar to the "ListenDatagram" directive above. Optional. Type list of uniline.ListenMessageQueue
Specifies aListenUSBFunction
Specifies aSocketProtocol
Takes a one of "udplite" or "sctp". Specifies a socket protocol ("IPPROTO_UDPLITE") UDP-Lite ("IPPROTO_SCTP")BindIPv6Only
Takes a one of "default", "both" or "ipv6-only". Controls theBacklog
Takes an unsigned integer argument. Specifies the number of connections to queue that have not been accepted yet. This setting matters only for stream and sequential packet sockets. See listen(2) for details. Defaults toBindToDevice
Specifies a network interface name to bind this socket to. If set, traffic will only be accepted from the specified network interfaces. This controls theSocketUser
Takes aSocketGroup
Takes aSocketMode
If listening on a file system socket orDirectoryMode
If listening on a file system socket orAccept
Takes a boolean argument. If true, a service instance is spawned for each incoming connection and only the connection socket is passed to it. If false, all listening sockets themselves are passed to the started service unit, and only one service unit is spawned for all connections (also see above). This value is ignored for datagram sockets and FIFOs where a single service unit unconditionally handles all incoming traffic. Defaults to "false". For performance reasons, it is recommended to write new daemons only in a way that is suitable for "Accept=false". A daemon listening on an "AF_UNIX" socket may, but does not need to, call close(2) on the received socket before exiting. However, it must not unlink the socket from a file system. It should not invoke shutdown(2) on sockets it got with "Accept=false", but it may do so for sockets it got with "Accept=true" set. Setting "Accept=true" is mostly useful to allow daemons designed for usage with inetd(8) to work unmodified with systemd socket activation.For IPv4 and IPv6 connections, the "REMOTE_ADDR" environment variable will contain the remote
Writable
Takes a boolean argument. May only be used in conjunction with "ListenSpecial". If true, the specified special file is opened in read-write mode, if false, in read-only mode. Defaults to false. Optional. Type boolean.MaxConnections
The maximum number of connections to simultaneously run services instances for, when "Accept=true" is set. If more concurrent connections are coming in, they will be refused until at least one existing connection is terminated. This setting has no effect on sockets configured with "Accept=false" or datagram sockets. Defaults to 64. Optional. Type uniline.MaxConnectionsPerSource
The maximum number of connections for a service per sourceKeepAlive
Takes a boolean argument. If true, theKeepAliveTimeSec
Takes time (in seconds) as argument. The connection needs to remain idle beforeKeepAliveIntervalSec
Takes time (in seconds) as argument between individual keepalive probes, if the socket optionKeepAliveProbes
Takes an integer as argument. It is the number of unacknowledged probes to send before considering the connection dead and notifying the application layer. This controls theNoDelay
Takes a boolean argument.Priority
Takes an integer argument controlling the priority for all traffic sent from this socket. This controls theDeferAcceptSec
Takes time (in seconds) as argument. If set, the listening process will be awakened only when data arrives on the socket, and not immediately when connection is established. When this option is set, the "TCP_DEFER_ACCEPT" socket option will be used (see tcp(7)), and the kernel will ignore initialIf the client also uses the "TCP_DEFER_ACCEPT" option, the latency of the initial connection may be reduced, because the kernel will send data in the final packet establishing the connection (the third packet in the ``three-way handshake'').
Disabled by default. Optional. Type integer.
ReceiveBuffer
Takes an integer argument controlling the receive or send buffer sizes of this socket, respectively. This controls theSendBuffer
Takes an integer argument controlling the receive or send buffer sizes of this socket, respectively. This controls theIPTOS
Takes an integer argument controlling the IPTTL
Takes an integer argument controlling the IPv4
Time-To-Live/IPv6 Hop-Count field for packets generated from
this socket. This sets the Mark
Takes an integer value. Controls the firewall mark of packets generated by this socket. This can be used in the firewall logic to filter packets from this socket. This sets theReusePort
Takes a boolean value. If true, allows multiple bind(2)s to thisSmackLabel
Takes a string value. Controls the extended attributes "security.SMACK64", "security.SMACK64IPIN" and "security.SMACK64IPOUT", respectively, i.e. the security label of theSmackLabelIPIn
Takes a string value. Controls the extended attributes "security.SMACK64", "security.SMACK64IPIN" and "security.SMACK64IPOUT", respectively, i.e. the security label of theSmackLabelIPOut
Takes a string value. Controls the extended attributes "security.SMACK64", "security.SMACK64IPIN" and "security.SMACK64IPOUT", respectively, i.e. the security label of theSELinuxContextFromNet
Takes a boolean argument. When true, systemd will attempt to figure out the SELinux label used for the instantiated service from the information handed by the peer over the network. Note that only the security level is used from the information provided by the peer. Other parts of the resulting SELinux context originate from either the target binary that is effectively triggered by socket unit or from the value of the "SELinuxContext" option. This configuration option only affects sockets with "Accept" mode set to "true". Also note that this option is useful only whenPipeSize
Takes a size in bytes. Controls the pipe buffer size of FIFOs configured in this socket unit. See fcntl(2) for details. The usual suffixes K, M, G are supported and are understood to the base of 1024. Optional. Type uniline.MessageQueueMaxMessages
These two settings take integer values and control the mq_maxmsg field or the mq_msgsize field, respectively, when creating the message queue. Note that either none or both of these variables need to be set. See mq_setattr(3) for details. Optional. Type uniline.FreeBind
Takes a boolean value. Controls whether the socket can be bound to non-localTransparent
Takes a boolean value. Controls theBroadcast
Takes a boolean value. This controls thePassCredentials
Takes a boolean value. This controls thePassSecurity
Takes a boolean value. This controls theTCPCongestion
Takes a string value. Controls theExecStartPre
Takes one or more command lines, which are executed before or after the listening sockets/FIFOs are created and bound, respectively. The first token of the command line must be an absolute filename, then followed by arguments for the process. Multiple command lines may be specified following the same scheme as used for "ExecStartPre" of service unit files. Optional. Type list of uniline.ExecStartPost
Takes one or more command lines, which are executed before or after the listening sockets/FIFOs are created and bound, respectively. The first token of the command line must be an absolute filename, then followed by arguments for the process. Multiple command lines may be specified following the same scheme as used for "ExecStartPre" of service unit files. Optional. Type list of uniline.ExecStopPre
Additional commands that are executed before or after the listening sockets/FIFOs are closed and removed, respectively. Multiple command lines may be specified following the same scheme as used for "ExecStartPre" of service unit files. Optional. Type list of uniline.ExecStopPost
Additional commands that are executed before or after the listening sockets/FIFOs are closed and removed, respectively. Multiple command lines may be specified following the same scheme as used for "ExecStartPre" of service unit files. Optional. Type list of uniline.TimeoutSec
Configures the time to wait for the commands specified in "ExecStartPre", "ExecStartPost", "ExecStopPre" and "ExecStopPost" to finish. If a command does not exit within the configured time, the socket will be considered failed and be shut down again. All commands still running will be terminated forcibly via "SIGTERM", and after another delay of this time with "SIGKILL". (See "KillMode" in systemd.kill(5).) Takes a unit-less value in seconds, or a time span value such as ``5min 20s''. Pass 0 to disable the timeout logic. Defaults to "DefaultTimeoutStartSec" from the manager configuration file (see systemd-system.conf(5)). Optional. Type uniline.Service
Specifies the service unit name to activate on incoming traffic. This setting is only allowed for sockets with "Accept=no". It defaults to the service that bears the same name as the socket (with the suffix replaced). In most cases, it should not be necessary to use this option. Note that setting this parameter might result in additional dependencies to be added to the unit (see above). Optional. Type uniline.RemoveOnStop
Takes a boolean argument. If enabled, any file nodes created by this socket unit are removed when it is stopped. This applies toSymlinks
Takes a list of file system paths. The specified paths will be created as symlinks to theFileDescriptorName
Assigns a name to all file descriptors this socket unit encapsulates. This is useful to help activated services identify specific file descriptors, if multiple fds are passed. Services may use the sd_listen_fds_with_names(3) call to acquire the names configured for the received file descriptors. Names may contain anyTriggerLimitIntervalSec
Configures a limit on how often this socket unit my be activated within a specific time interval. The "TriggerLimitIntervalSec" may be used to configure the length of the time interval in the usual time units "us", "ms", "s", "min", "h", X and defaults to 2s (See systemd.time(7) for details on the various time units understood). The "TriggerLimitBurst" setting takes a positive integer value and specifies the number of permitted activations per time interval, and defaults to 200 for "Accept=yes" sockets (thus by default permitting 200 activations per 2s), and 20 otherwise (20 activations per 2s). Set either to 0 to disable any form of trigger rate limiting. If the limit is hit, the socket unit is placed into a failure mode, and will not be connectible anymore until restarted. Note that this limit is enforced before the service activation is enqueued. Optional. Type uniline.TriggerLimitBurst
Configures a limit on how often this socket unit my be activated within a specific time interval. The "TriggerLimitIntervalSec" may be used to configure the length of the time interval in the usual time units "us", "ms", "s", "min", "h", X and defaults to 2s (See systemd.time(7) for details on the various time units understood). The "TriggerLimitBurst" setting takes a positive integer value and specifies the number of permitted activations per time interval, and defaults to 200 for "Accept=yes" sockets (thus by default permitting 200 activations per 2s), and 20 otherwise (20 activations per 2s). Set either to 0 to disable any form of trigger rate limiting. If the limit is hit, the socket unit is placed into a failure mode, and will not be connectible anymore until restarted. Note that this limit is enforced before the service activation is enqueued. Optional. Type uniline.SEE ALSO
- *
- cme
COPYRIGHT
- 2010-2016 Lennart Poettering and others
- 2016 Dominique Dumont
LICENSE
- LGPLv2.1+
-