Debian Codegraph @

upstream/debian-unstable/man8/systemd-network-generator.service.8

raw
1 '\" t
2 .TH "SYSTEMD\-NETWORK\-GENERATOR\&.SERVICE" "8" "" "systemd 261~rc3" "systemd-network-generator.service"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 systemd-network-generator.service, systemd-network-generator \- Generate network configuration from the kernel command line
24 .SH "SYNOPSIS"
25 .PP
26 systemd\-network\-generator\&.service
27 .PP
28 /usr/lib/systemd/systemd\-network\-generator
29 .SH "DESCRIPTION"
30 .PP
31 systemd\-network\-generator\&.service
32 is a system service that translates
33 \fIip=\fR
34 and related settings on the kernel command line (see below) into
35 \fBsystemd.network\fR(5),
36 \fBsystemd.netdev\fR(5), and
37 \fBsystemd.link\fR(5)
38 configuration files understood by
39 \fBsystemd-networkd.service\fR(8)
40 and
41 \fBsystemd-udevd.service\fR(8)\&.
42 .PP
43 Files are generated in
44 /run/systemd/network/\&.
45 .PP
46 Note: despite the name, this generator executes as a normal systemd service and is
47 \fInot\fR
48 an implementation of the
49 \fBsystemd.generator\fR(7)
50 concept\&.
51 .SH "KERNEL COMMAND LINE OPTIONS"
52 .PP
53 This tool understands the following options:
54 .PP
55 \fIip=\fR, \fInameserver=\fR, \fIrd\&.route=\fR, \fIrd\&.peerdns=\fR
56 .RS 4
57 Translated into
58 \fBsystemd.network\fR(5)
59 files\&.
60 .sp
61 In addition to the parameters
62 \fBdracut.cmdline\fR(7)
63 defines the
64 \fIip=\fR
65 option accepts the special value
66 "link\-local"\&. If selected, the network interfaces will be configured for link\-local addressing (IPv4LL, IPv6LL) only, DHCP or IPv6RA will not be enabled\&.
67 .sp
68 Added in version 245\&.
69 .RE
70 .PP
71 \fIifname=\fR, \fInet\&.ifname_policy=\fR
72 .RS 4
73 Translated into
74 \fBsystemd.link\fR(5)
75 files\&.
76 .sp
77 Added in version 245\&.
78 .RE
79 .PP
80 \fIvlan=\fR, \fIbond=\fR, \fIbridge=\fR, \fIbootdev=\fR
81 .RS 4
82 Translated into
83 \fBsystemd.netdev\fR(5)
84 files\&.
85 .sp
86 Added in version 245\&.
87 .RE
88 .PP
89 \fIBOOTIF=\fR, \fIrd\&.bootif=\fR
90 .RS 4
91 When
92 \fIBOOTIF\fR
93 is specified in the interface field of
94 \fIip=\fR, it is treated as a special placeholder rather than a real interface name\&. Then, in combination with the MAC address provided by
95 \fIBOOTIF=\fR, this is translated into a
96 \fBsystemd.network\fR(5)
97 file which matches on the the provided MAC address\&. When
98 \fIrd\&.bootif=0\fR
99 is passed, this functionality is disabled, and the
100 \fIBOOTIF=\fR
101 option is ignored\&.
102 .sp
103 See
104 \fBdracut.cmdline\fR(7)
105 for details on the usage of these options\&.
106 .sp
107 Added in version 261\&.
108 .RE
109 .PP
110 See
111 \fBdracut.cmdline\fR(7)
112 and
113 \fBsystemd-udevd.service\fR(8)
114 for option syntax and details\&.
115 .SH "CREDENTIALS"
116 .PP
117 \fBsystemd\-network\-generator\fR
118 supports the service credentials logic as implemented by
119 \fIImportCredential=\fR/\fILoadCredential=\fR/\fISetCredential=\fR
120 (see
121 \fBsystemd.exec\fR(5)
122 for details)\&. The following credentials are used when passed in:
123 .PP
124 \fInetwork\&.conf\&.*\fR, \fInetwork\&.link\&.*\fR, \fInetwork\&.netdev\&.*\fR, \fInetwork\&.network\&.*\fR
125 .RS 4
126 These credentials should contain valid
127 \fBnetworkd.conf\fR(5),
128 \fBsystemd.link\fR(5),
129 \fBsystemd.netdev\fR(5),
130 \fBsystemd.network\fR(5)
131 configuration data\&. From each matching credential a separate file is created\&. Example: a passed credential
132 network\&.link\&.50\-foobar
133 will be copied into a configuration file
134 50\-foobar\&.link\&.
135 .sp
136 Note that the resulting files are created world\-readable, it is hence recommended to not include secrets in these credentials, but to supply them via separate credentials directly to
137 \fBsystemd-networkd.service\fR(8)\&.
138 .sp
139 Added in version 256\&.
140 .RE
141 .PP
142 Note that by default the
143 \fBsystemd-networkd.service\fR(8)
144 service is set up to inherit the these credentials from the service manager\&.
145 .SH "SEE ALSO"
146 .PP
147 \fBsystemd\fR(1), \fBsystemd-networkd.service\fR(8), \fBdracut\fR(8)