| 1 |
'\" t |
| 2 |
.TH "SYSTEMD\-NETWORKD\-WAIT\-ONLINE\&.SERVICE" "8" "" "systemd 261~rc3" "systemd-networkd-wait-online.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-networkd-wait-online.service, [email protected], systemd-networkd-wait-online \- Wait for network to come online |
| 24 |
.SH "SYNOPSIS" |
| 25 |
.PP |
| 26 |
systemd\-networkd\-wait\-online\&.service |
| 27 |
.PP |
| 28 |
systemd\-networkd\-wait\-online@\&.service |
| 29 |
.PP |
| 30 |
/usr/lib/systemd/systemd\-networkd\-wait\-online |
| 31 |
.SH "DESCRIPTION" |
| 32 |
.PP |
| 33 |
\fBsystemd\-networkd\-wait\-online\fR |
| 34 |
is a oneshot system service (see |
| 35 |
\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 |
| 36 |
\fBsystemd-networkd.service\fR(8) |
| 37 |
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 |
| 38 |
"degraded"\&. The threshold can be configured by |
| 39 |
\fB\-\-operational\-state=\fR |
| 40 |
option\&. |
| 41 |
.PP |
| 42 |
The service |
| 43 |
systemd\-networkd\-wait\-online\&.service |
| 44 |
invokes |
| 45 |
\fBsystemd\-networkd\-wait\-online\fR |
| 46 |
without any options\&. Thus, it waits for all managed interfaces to be configured or failed, and for at least one to be online\&. |
| 47 |
.PP |
| 48 |
The service |
| 49 |
systemd\-networkd\-wait\-online@\&.service |
| 50 |
takes an interface name, and invokes |
| 51 |
\fBsystemd\-networkd\-wait\-online\fR |
| 52 |
with |
| 53 |
\fB\-i\fR |
| 54 |
and the specified interface name\&. Thus, wait for the specified interface to be configured and online\&. For example, |
| 55 |
systemd\-networkd\-wait\-online@eth0\&.service |
| 56 |
waits for |
| 57 |
eth0 |
| 58 |
to be configured by |
| 59 |
\fBsystemd\-networkd\fR |
| 60 |
and online\&. |
| 61 |
.SH "OPTIONS" |
| 62 |
.PP |
| 63 |
The following options are understood: |
| 64 |
.PP |
| 65 |
\fB\-i\fR \fIINTERFACE\fR[:\fIMIN_OPERSTATE\fR[:\fIMAX_OPERSTATE\fR]], \fB\-\-interface=\fR\fB\fIINTERFACE\fR\fR\fB[:\fIMIN_OPERSTATE\fR[:\fIMAX_OPERSTATE\fR]]\fR |
| 66 |
.RS 4 |
| 67 |
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 |
| 68 |
\fBsystemd\-networkd\-wait\-online\fR |
| 69 |
waits for all specified interfaces to be online\&. Optionally, required minimum and maximum operational states can be specified after a colon |
| 70 |
":"\&. Please see |
| 71 |
\fBnetworkctl\fR(1) |
| 72 |
for possible operational states\&. If the operational state is not specified here, then the value from |
| 73 |
\fIRequiredForOnline=\fR |
| 74 |
in the corresponding |
| 75 |
\&.network |
| 76 |
file is used if present, and |
| 77 |
"degraded" |
| 78 |
otherwise\&. |
| 79 |
.sp |
| 80 |
Added in version 213\&. |
| 81 |
.RE |
| 82 |
.PP |
| 83 |
\fB\-\-ignore=\fR\fB\fIINTERFACE\fR\fR |
| 84 |
.RS 4 |
| 85 |
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\&. |
| 86 |
.sp |
| 87 |
Added in version 219\&. |
| 88 |
.RE |
| 89 |
.PP |
| 90 |
\fB\-o\fR \fIMIN_OPERSTATE\fR[:\fIMAX_OPERSTATE\fR], \fB\-\-operational\-state=\fR\fB\fIMIN_OPERSTATE\fR\fR\fB[:\fIMAX_OPERSTATE\fR]\fR |
| 91 |
.RS 4 |
| 92 |
Takes a minimum operational state and an optional maximum operational state\&. Please see |
| 93 |
\fBnetworkctl\fR(1) |
| 94 |
for possible operational states\&. If set, the specified value overrides |
| 95 |
\fIRequiredForOnline=\fR |
| 96 |
settings in |
| 97 |
\&.network |
| 98 |
files\&. But this does not override operational states specified in |
| 99 |
\fB\-\-interface=\fR |
| 100 |
option\&. |
| 101 |
.sp |
| 102 |
Added in version 242\&. |
| 103 |
.RE |
| 104 |
.PP |
| 105 |
\fB\-4\fR, \fB\-\-ipv4\fR |
| 106 |
.RS 4 |
| 107 |
Waiting for an IPv4 address of each network interface to be configured\&. If this option is specified with |
| 108 |
\fB\-\-any\fR, then |
| 109 |
\fBsystemd\-networkd\-wait\-online\fR |
| 110 |
exits with success when at least one interface becomes online and has an IPv4 address\&. If the required minimum operational state is below |
| 111 |
"routable", then each link (or at least one link with |
| 112 |
\fB\-\-any\fR) must have an IPv4 link\-local or routable address\&. If the required minimum operational state is |
| 113 |
"routable", then each link must have an IPv4 routable address\&. |
| 114 |
.sp |
| 115 |
If neither |
| 116 |
\fB\-\-ipv4\fR |
| 117 |
nor |
| 118 |
\fB\-\-ipv6\fR |
| 119 |
is specified, then the value from |
| 120 |
\fIRequiredFamilyForOnline=\fR |
| 121 |
in the corresponding |
| 122 |
\&.network |
| 123 |
file is used if present\&. |
| 124 |
.sp |
| 125 |
Added in version 249\&. |
| 126 |
.RE |
| 127 |
.PP |
| 128 |
\fB\-6\fR, \fB\-\-ipv6\fR |
| 129 |
.RS 4 |
| 130 |
Waiting for an IPv6 address of each network interface to be configured\&. If this option is specified with |
| 131 |
\fB\-\-any\fR, then |
| 132 |
\fBsystemd\-networkd\-wait\-online\fR |
| 133 |
exits with success when at least one interface becomes online and has an IPv6 address\&. If the required minimum operational state is below |
| 134 |
"routable", then each link (or at least one link with |
| 135 |
\fB\-\-any\fR) must have an IPv6 link\-local or routable address\&. If the required minimum operational state is |
| 136 |
"routable", then each link must have an IPv6 routable address\&. |
| 137 |
.sp |
| 138 |
If neither |
| 139 |
\fB\-\-ipv4\fR |
| 140 |
nor |
| 141 |
\fB\-\-ipv6\fR |
| 142 |
is specified, then the value from |
| 143 |
\fIRequiredFamilyForOnline=\fR |
| 144 |
in the corresponding |
| 145 |
\&.network |
| 146 |
file is used if present\&. |
| 147 |
.sp |
| 148 |
Added in version 249\&. |
| 149 |
.RE |
| 150 |
.PP |
| 151 |
\fB\-\-dns\fR |
| 152 |
.RS 4 |
| 153 |
Waiting for DNS servers to be accessible on each interface\&. If this option is specified with |
| 154 |
\fB\-\-any\fR, then |
| 155 |
\fBsystemd\-networkd\-wait\-online\fR |
| 156 |
exits with success when at least one interface becomes online and has an accessible DNS server\&. |
| 157 |
.sp |
| 158 |
If a link has the property |
| 159 |
\fIDefaultRoute=yes\fR |
| 160 |
(either because the |
| 161 |
\fIDNSDefaultRoute=\fR |
| 162 |
network property is explicitly configured, or because the link does not have any "routing\-only" domains), or if the search domain "\&." is configured, then wait for link\-specific DNS servers to be accessible\&. Otherwise, allow global DNS servers to satisfy the condition\&. |
| 163 |
.sp |
| 164 |
Added in version 258\&. |
| 165 |
.RE |
| 166 |
.PP |
| 167 |
\fB\-\-any\fR |
| 168 |
.RS 4 |
| 169 |
Even if several interfaces are in configuring state, |
| 170 |
\fBsystemd\-networkd\-wait\-online\fR |
| 171 |
exits with success when at least one interface becomes online\&. When this option is specified with |
| 172 |
\fB\-\-interface=\fR, then |
| 173 |
\fBsystemd\-networkd\-wait\-online\fR |
| 174 |
waits for one of the specified interfaces to be online\&. This option is useful when some interfaces may not have carrier on boot\&. |
| 175 |
.sp |
| 176 |
Added in version 242\&. |
| 177 |
.RE |
| 178 |
.PP |
| 179 |
\fB\-\-timeout=\fR\fB\fISECS\fR\fR |
| 180 |
.RS 4 |
| 181 |
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\&. |
| 182 |
.sp |
| 183 |
Added in version 219\&. |
| 184 |
.RE |
| 185 |
.PP |
| 186 |
\fB\-q\fR, \fB\-\-quiet\fR |
| 187 |
.RS 4 |
| 188 |
Suppress log messages\&. |
| 189 |
.sp |
| 190 |
Added in version 242\&. |
| 191 |
.RE |
| 192 |
.PP |
| 193 |
\fB\-h\fR, \fB\-\-help\fR |
| 194 |
.RS 4 |
| 195 |
Print a short help text and exit\&. |
| 196 |
.RE |
| 197 |
.PP |
| 198 |
\fB\-\-version\fR |
| 199 |
.RS 4 |
| 200 |
Print a short version string and exit\&. |
| 201 |
.RE |
| 202 |
.SH "SEE ALSO" |
| 203 |
.PP |
| 204 |
\fBsystemd\fR(1), \fBsystemd.service\fR(5), \fBsystemd-networkd.service\fR(8), \fBnetworkctl\fR(1) |