summaryrefslogtreecommitdiffstats
path: root/upstream/fedora-rawhide/man8/systemd-networkd-wait-online.service.8
blob: a1eafa54019d285cc8025bd4c8270f1a88d8dbdc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
'\" t
.TH "SYSTEMD\-NETWORKD\-WAIT\-ONLINE\&.SERVICE" "8" "" "systemd 255" "systemd-networkd-wait-online.service"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
systemd-networkd-wait-online.service, systemd-networkd-wait-online@.service, systemd-networkd-wait-online \- Wait for network to come online
.SH "SYNOPSIS"
.PP
systemd\-networkd\-wait\-online\&.service
.PP
systemd\-networkd\-wait\-online@\&.service
.PP
/usr/lib/systemd/systemd\-networkd\-wait\-online
.SH "DESCRIPTION"
.PP
\fBsystemd\-networkd\-wait\-online\fR
is a oneshot system service (see
\fBsystemd.service\fR(5)), that waits for the network to be configured\&. By default, it will wait for all links it is aware of and which are managed by
\fBsystemd-networkd.service\fR(8)
to be fully configured or failed, and for at least one link to be online\&. Here, online means that the link\*(Aqs operational state is equal or higher than
"degraded"\&. The threshold can be configured by
\fB\-\-operational\-state=\fR
option\&.
.PP
The service
systemd\-networkd\-wait\-online\&.service
invokes
\fBsystemd\-networkd\-wait\-online\fR
without any options\&. Thus, it waits for all managed interfaces to be configured or failed, and for at least one to be online\&.
.PP
The service
systemd\-networkd\-wait\-online@\&.service
takes an interface name, and invokes
\fBsystemd\-networkd\-wait\-online\fR
with
\fB\-i\fR
and the specified interface name\&. Thus, wait for the specified interface to be configured and online\&. For example,
systemd\-networkd\-wait\-online@eth0\&.service
waits for
eth0
to be configured by
\fBsystemd\-networkd\fR
and online\&.
.SH "OPTIONS"
.PP
The following options are understood:
.PP
\fB\-i\fR \fIINTERFACE\fR[:\fIMIN_OPERSTATE\fR[:\fIMAX_OPERSTATE\fR]], \fB\-\-interface=\fR\fIINTERFACE\fR[:\fIMIN_OPERSTATE\fR[:\fIMAX_OPERSTATE\fR]]
.RS 4
Network interface to wait for before deciding if the system is online\&. This is useful when a system has several interfaces which will be configured, but a particular one is necessary to access some network resources\&. When used, all other interfaces are ignored\&. This option may be used more than once to wait for multiple network interfaces\&. When this option is specified multiple times, then
\fBsystemd\-networkd\-wait\-online\fR
waits for all specified interfaces to be online\&. Optionally, required minimum and maximum operational states can be specified after a colon
":"\&. Please see
\fBnetworkctl\fR(1)
for possible operational states\&. If the operational state is not specified here, then the value from
\fIRequiredForOnline=\fR
in the corresponding
\&.network
file is used if present, and
"degraded"
otherwise\&.
.sp
Added in version 213\&.
.RE
.PP
\fB\-\-ignore=\fR\fIINTERFACE\fR
.RS 4
Network interfaces to be ignored when deciding if the system is online\&. By default, only the loopback interface is ignored\&. This option may be used more than once to ignore multiple network interfaces\&.
.sp
Added in version 219\&.
.RE
.PP
\fB\-o\fR \fIMIN_OPERSTATE\fR[:\fIMAX_OPERSTATE\fR], \fB\-\-operational\-state=\fR\fIMIN_OPERSTATE\fR[:\fIMAX_OPERSTATE\fR]
.RS 4
Takes a minimum operational state and an optional maximum operational state\&. Please see
\fBnetworkctl\fR(1)
for possible operational states\&. If set, the specified value overrides
\fIRequiredForOnline=\fR
settings in
\&.network
files\&. But this does not override operational states specified in
\fB\-\-interface=\fR
option\&.
.sp
Added in version 242\&.
.RE
.PP
\fB\-4\fR, \fB\-\-ipv4\fR
.RS 4
Waiting for an IPv4 address of each network interface to be configured\&. If this option is specified with
\fB\-\-any\fR, then
\fBsystemd\-networkd\-wait\-online\fR
exits with success when at least one interface becomes online and has an IPv4 address\&. If the required minimum operational state is below
"routable", then each link (or at least one link with
\fB\-\-any\fR) must have an IPv4 link\-local or routable address\&. If the required minimum operational state is
"routable", then each link must have an IPv4 routable address\&.
.sp
If neither
\fB\-\-ipv4\fR
nor
\fB\-\-ipv6\fR
is specified, then the value from
\fIRequiredFamilyForOnline=\fR
in the corresponding
\&.network
file is used if present\&.
.sp
Added in version 249\&.
.RE
.PP
\fB\-6\fR, \fB\-\-ipv6\fR
.RS 4
Waiting for an IPv6 address of each network interface to be configured\&. If this option is specified with
\fB\-\-any\fR, then
\fBsystemd\-networkd\-wait\-online\fR
exits with success when at least one interface becomes online and has an IPv6 address\&. If the required minimum operational state is below
"routable", then each link (or at least one link with
\fB\-\-any\fR) must have an IPv6 link\-local or routable address\&. If the required minimum operational state is
"routable", then each link must have an IPv6 routable address\&.
.sp
If neither
\fB\-\-ipv4\fR
nor
\fB\-\-ipv6\fR
is specified, then the value from
\fIRequiredFamilyForOnline=\fR
in the corresponding
\&.network
file is used if present\&.
.sp
Added in version 249\&.
.RE
.PP
\fB\-\-any\fR
.RS 4
Even if several interfaces are in configuring state,
\fBsystemd\-networkd\-wait\-online\fR
exits with success when at least one interface becomes online\&. When this option is specified with
\fB\-\-interface=\fR, then
\fBsystemd\-networkd\-wait\-online\fR
waits for one of the specified interfaces to be online\&. This option is useful when some interfaces may not have carrier on boot\&.
.sp
Added in version 242\&.
.RE
.PP
\fB\-\-timeout=\fR\fISECS\fR
.RS 4
Fail the service if the network is not online by the time the timeout elapses\&. A timeout of 0 disables the timeout\&. Defaults to 120 seconds\&.
.sp
Added in version 219\&.
.RE
.PP
\fB\-q\fR, \fB\-\-quiet\fR
.RS 4
Suppress log messages\&.
.sp
Added in version 242\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print a short help text and exit\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Print a short version string and exit\&.
.RE
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsystemd.service\fR(5),
\fBsystemd-networkd.service\fR(8),
\fBnetworkctl\fR(1)