summaryrefslogtreecommitdiffstats
path: root/upstream/fedora-rawhide/man1/networkctl.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/fedora-rawhide/man1/networkctl.1
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/fedora-rawhide/man1/networkctl.1')
-rw-r--r--upstream/fedora-rawhide/man1/networkctl.1519
1 files changed, 519 insertions, 0 deletions
diff --git a/upstream/fedora-rawhide/man1/networkctl.1 b/upstream/fedora-rawhide/man1/networkctl.1
new file mode 100644
index 00000000..7bdbc0e0
--- /dev/null
+++ b/upstream/fedora-rawhide/man1/networkctl.1
@@ -0,0 +1,519 @@
+'\" t
+.TH "NETWORKCTL" "1" "" "systemd 255" "networkctl"
+.\" -----------------------------------------------------------------
+.\" * 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"
+networkctl \- Query or modify the status of network links
+.SH "SYNOPSIS"
+.HP \w'\fBnetworkctl\fR\ 'u
+\fBnetworkctl\fR [OPTIONS...] COMMAND [LINK...]
+.SH "DESCRIPTION"
+.PP
+\fBnetworkctl\fR
+may be used to query or modify the state of the network links as seen by
+\fBsystemd\-networkd\fR\&. Please refer to
+\fBsystemd-networkd.service\fR(8)
+for an introduction to the basic concepts, functionality, and configuration syntax\&.
+.SH "COMMANDS"
+.PP
+The following commands are understood:
+.PP
+\fBlist\fR [\fIPATTERN\&...\fR]
+.RS 4
+Show a list of existing links and their status\&. If one or more
+\fIPATTERN\fRs are specified, only links matching one of them are shown\&. If no further arguments are specified shows all links, otherwise just the specified links\&. Produces output similar to:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+IDX LINK TYPE OPERATIONAL SETUP
+ 1 lo loopback carrier unmanaged
+ 2 eth0 ether routable configured
+ 3 virbr0 ether no\-carrier unmanaged
+ 4 virbr0\-nic ether off unmanaged
+
+4 links listed\&.
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+The operational status is one of the following:
+.PP
+missing
+.RS 4
+The device is missing\&.
+.sp
+Added in version 245\&.
+.RE
+.PP
+off
+.RS 4
+The device is powered down\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+no\-carrier
+.RS 4
+The device is powered up, but does not yet have a carrier\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+dormant
+.RS 4
+The device has a carrier, but is not yet ready for normal traffic\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+degraded\-carrier
+.RS 4
+One of the bonding or bridge slave network interfaces is in off, no\-carrier, or dormant state, and the master interface has no address\&.
+.sp
+Added in version 242\&.
+.RE
+.PP
+carrier
+.RS 4
+The link has carrier, or for bond or bridge master, all bonding or bridge slave network interfaces are enslaved to the master\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+degraded
+.RS 4
+The link has carrier and addresses valid on the local link configured\&. For bond or bridge master this means that not all slave network interfaces have carrier but at least one does\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+enslaved
+.RS 4
+The link has carrier and is enslaved to bond or bridge master network interface\&.
+.sp
+Added in version 242\&.
+.RE
+.PP
+routable
+.RS 4
+The link has carrier and routable address configured\&. For bond or bridge master it is not necessary for all slave network interfaces to have carrier, but at least one must\&.
+.sp
+Added in version 240\&.
+.RE
+.sp
+The setup status is one of the following:
+.PP
+pending
+.RS 4
+\fBsystemd-udevd\fR(8)
+is still processing the link, we don\*(Aqt yet know if we will manage it\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+initialized
+.RS 4
+\fBsystemd-udevd\fR(8)
+has processed the link, but we don\*(Aqt yet know if we will manage it\&.
+.sp
+Added in version 251\&.
+.RE
+.PP
+configuring
+.RS 4
+Configuration for the link is being retrieved or the link is being configured\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+configured
+.RS 4
+Link has been configured successfully\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+unmanaged
+.RS 4
+\fBsystemd\-networkd\fR
+is not handling the link\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+failed
+.RS 4
+\fBsystemd\-networkd\fR
+failed to configure the link\&.
+.sp
+Added in version 240\&.
+.RE
+.PP
+linger
+.RS 4
+The link is gone, but has not yet been dropped by
+\fBsystemd\-networkd\fR\&.
+.sp
+Added in version 240\&.
+.RE
+.sp
+Added in version 219\&.
+.RE
+.PP
+\fBstatus\fR [\fIPATTERN\&...\fR]
+.RS 4
+Show information about the specified links: type, state, kernel module driver, hardware and IP address, configured DNS servers, etc\&. If one or more
+\fIPATTERN\fRs are specified, only links matching one of them are shown\&.
+.sp
+When no links are specified, an overall network status is shown\&. Also see the option
+\fB\-\-all\fR\&.
+.sp
+Produces output similar to:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+● State: routable
+ Online state: online
+ Address: 10\&.193\&.76\&.5 on eth0
+ 192\&.168\&.122\&.1 on virbr0
+ 169\&.254\&.190\&.105 on eth0
+ fe80::5054:aa:bbbb:cccc on eth0
+ Gateway: 10\&.193\&.11\&.1 (CISCO SYSTEMS, INC\&.) on eth0
+ DNS: 8\&.8\&.8\&.8
+ 8\&.8\&.4\&.4
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+In the overall network status, the online state depends on the individual online state of all required links\&. Managed links are required for online by default\&. In this case, the online state is one of the following:
+.PP
+unknown
+.RS 4
+All links have unknown online status (i\&.e\&. there are no required links)\&.
+.sp
+Added in version 249\&.
+.RE
+.PP
+offline
+.RS 4
+All required links are offline\&.
+.sp
+Added in version 249\&.
+.RE
+.PP
+partial
+.RS 4
+Some, but not all, required links are online\&.
+.sp
+Added in version 249\&.
+.RE
+.PP
+online
+.RS 4
+All required links are online\&.
+.sp
+Added in version 249\&.
+.RE
+.sp
+Added in version 219\&.
+.RE
+.PP
+\fBlldp\fR [\fIPATTERN\&...\fR]
+.RS 4
+Show discovered LLDP (Link Layer Discovery Protocol) neighbors\&. If one or more
+\fIPATTERN\fRs are specified only neighbors on those interfaces are shown\&. Otherwise shows discovered neighbors on all interfaces\&. Note that for this feature to work,
+\fILLDP=\fR
+must be turned on for the specific interface, see
+\fBsystemd.network\fR(5)
+for details\&.
+.sp
+Produces output similar to:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+LINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION
+enp0s25 00:e0:4c:00:00:00 GS1900 \&.\&.b\&.\&.\&.\&.\&.\&.\&.\&. 2 Port #2
+
+Capability Flags:
+o \- Other; p \- Repeater; b \- Bridge; w \- WLAN Access Point; r \- Router;
+t \- Telephone; d \- DOCSIS cable device; a \- Station; c \- Customer VLAN;
+s \- Service VLAN, m \- Two\-port MAC Relay (TPMR)
+
+1 neighbors listed\&.
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Added in version 219\&.
+.RE
+.PP
+\fBlabel\fR
+.RS 4
+Show numerical address labels that can be used for address selection\&. This is the same information that
+\fBip-addrlabel\fR(8)
+shows\&. See
+\m[blue]\fBRFC 3484\fR\m[]\&\s-2\u[1]\d\s+2
+for a discussion of address labels\&.
+.sp
+Produces output similar to:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Prefix/Prefixlen Label
+ ::/0 1
+ fc00::/7 5
+ fec0::/10 11
+ 2002::/16 2
+ 3ffe::/16 12
+ 2001:10::/28 7
+ 2001::/32 6
+::ffff:0\&.0\&.0\&.0/96 4
+ ::/96 3
+ ::1/128 0
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+Added in version 234\&.
+.RE
+.PP
+\fBdelete\fR \fIDEVICE\&...\fR
+.RS 4
+Deletes virtual netdevs\&. Takes interface name or index number\&.
+.sp
+Added in version 243\&.
+.RE
+.PP
+\fBup\fR \fIDEVICE\&...\fR
+.RS 4
+Bring devices up\&. Takes interface name or index number\&.
+.sp
+Added in version 246\&.
+.RE
+.PP
+\fBdown\fR \fIDEVICE\&...\fR
+.RS 4
+Bring devices down\&. Takes interface name or index number\&.
+.sp
+Added in version 246\&.
+.RE
+.PP
+\fBrenew\fR \fIDEVICE\&...\fR
+.RS 4
+Renew dynamic configurations e\&.g\&. addresses received from DHCP server\&. Takes interface name or index number\&.
+.sp
+Added in version 244\&.
+.RE
+.PP
+\fBforcerenew\fR \fIDEVICE\&...\fR
+.RS 4
+Send a FORCERENEW message to all connected clients, triggering DHCP reconfiguration\&. Takes interface name or index number\&.
+.sp
+Added in version 246\&.
+.RE
+.PP
+\fBreconfigure\fR \fIDEVICE\&...\fR
+.RS 4
+Reconfigure network interfaces\&. Takes interface name or index number\&. Note that this does not reload
+\&.netdev
+or
+\&.network
+corresponding to the specified interface\&. So, if you edit config files, it is necessary to call
+\fBnetworkctl reload\fR
+first to apply new settings\&.
+.sp
+Added in version 244\&.
+.RE
+.PP
+\fBreload\fR
+.RS 4
+Reload
+\&.netdev
+and
+\&.network
+files\&. If a new
+\&.netdev
+file is found, then the corresponding netdev is created\&. Note that even if an existing
+\&.netdev
+is modified or removed,
+\fBsystemd\-networkd\fR
+does not update or remove the netdev\&. If a new, modified or removed
+\&.network
+file is found, then all interfaces which match the file are reconfigured\&.
+.sp
+Added in version 244\&.
+.RE
+.PP
+\fBedit\fR \fIFILE\fR|\fI@DEVICE\fR\&...
+.RS 4
+Edit network configuration files, which include
+\&.network,
+\&.netdev, and
+\&.link
+files\&. If no network config file matching the given name is found, a new one will be created under
+/etc/\&. Specially, if the name is prefixed by
+"@", it will be treated as a network interface, and editing will be performed on the network config files associated with it\&. Additionally, the interface name can be suffixed with
+":network"
+(default) or
+":link", in order to choose the type of network config to operate on\&.
+.sp
+If
+\fB\-\-drop\-in=\fR
+is specified, edit the drop\-in file instead of the main configuration file\&. Unless
+\fB\-\-no\-reload\fR
+is specified,
+\fBsystemd\-networkd\fR
+will be reloaded after the edit of the
+\&.network
+or
+\&.netdev
+files finishes\&. The same applies for
+\&.link
+files and
+\fBsystemd-udevd\fR(8)\&. Note that the changed link settings are not automatically applied after reloading\&. To achieve that, trigger uevents for the corresponding interface\&. Refer to
+\fBsystemd.link\fR(5)
+for more information\&.
+.sp
+Added in version 254\&.
+.RE
+.PP
+\fBcat\fR \fIFILE\fR|\fI@DEVICE\fR\&...
+.RS 4
+Show network configuration files\&. This command honors the
+"@"
+prefix in the same way as
+\fBedit\fR\&.
+.sp
+Added in version 254\&.
+.RE
+.SH "OPTIONS"
+.PP
+The following options are understood:
+.PP
+\fB\-a\fR \fB\-\-all\fR
+.RS 4
+Show all links with
+\fBstatus\fR\&.
+.sp
+Added in version 219\&.
+.RE
+.PP
+\fB\-s\fR \fB\-\-stats\fR
+.RS 4
+Show link statistics with
+\fBstatus\fR\&.
+.sp
+Added in version 243\&.
+.RE
+.PP
+\fB\-l\fR, \fB\-\-full\fR
+.RS 4
+Do not ellipsize the output\&.
+.sp
+Added in version 245\&.
+.RE
+.PP
+\fB\-n\fR, \fB\-\-lines=\fR
+.RS 4
+When used with
+\fBstatus\fR, controls the number of journal lines to show, counting from the most recent ones\&. Takes a positive integer argument\&. Defaults to 10\&.
+.sp
+Added in version 245\&.
+.RE
+.PP
+\fB\-\-drop\-in=\fR\fINAME\fR
+.RS 4
+When used with
+\fBedit\fR, edit the drop\-in file
+\fINAME\fR
+instead of the main configuration file\&.
+.sp
+Added in version 254\&.
+.RE
+.PP
+\fB\-\-no\-reload\fR
+.RS 4
+When used with
+\fBedit\fR,
+\fBsystemd-networkd.service\fR(8)
+or
+\fBsystemd-udevd.service\fR(8)
+will not be reloaded after the editing finishes\&.
+.sp
+Added in version 254\&.
+.RE
+.PP
+\fB\-\-json=\fR\fIMODE\fR
+.RS 4
+Shows output formatted as JSON\&. Expects one of
+"short"
+(for the shortest possible output without any redundant whitespace or line breaks),
+"pretty"
+(for a pretty version of the same, with indentation and line breaks) or
+"off"
+(to turn off JSON output, the default)\&.
+.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
+.PP
+\fB\-\-no\-legend\fR
+.RS 4
+Do not print the legend, i\&.e\&. column headers and the footer with hints\&.
+.RE
+.PP
+\fB\-\-no\-pager\fR
+.RS 4
+Do not pipe output into a pager\&.
+.RE
+.SH "EXIT STATUS"
+.PP
+On success, 0 is returned, a non\-zero failure code otherwise\&.
+.SH "SEE ALSO"
+.PP
+\fBsystemd-networkd.service\fR(8),
+\fBsystemd.network\fR(5),
+\fBsystemd.netdev\fR(5),
+\fBip\fR(8)
+.SH "NOTES"
+.IP " 1." 4
+RFC 3484
+.RS 4
+\%https://tools.ietf.org/html/rfc3484
+.RE