From 55944e5e40b1be2afc4855d8d2baf4b73d1876b5 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 22:49:52 +0200 Subject: Adding upstream version 255.4. Signed-off-by: Daniel Baumann --- man/networkctl.xml | 570 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 570 insertions(+) create mode 100644 man/networkctl.xml (limited to 'man/networkctl.xml') diff --git a/man/networkctl.xml b/man/networkctl.xml new file mode 100644 index 0000000..68b1d97 --- /dev/null +++ b/man/networkctl.xml @@ -0,0 +1,570 @@ + + + + + + + + networkctl + systemd + + + + networkctl + 1 + + + + networkctl + Query or modify the status of network links + + + + + networkctl + OPTIONS + COMMAND + LINK + + + + + Description + + networkctl may be used to query or modify the + state of the network links as seen by + systemd-networkd. Please refer to + systemd-networkd.service8 + for an introduction to the basic concepts, functionality, and + configuration syntax. + + + + Commands + + The following commands are understood: + + + + + list + PATTERN… + + + + Show a list of existing links and their status. If one or more + PATTERNs 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: + + 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. + + The operational status is one of the following: + + + missing + + The device is missing. + + + + + + off + + The device is powered down. + + + + + + no-carrier + + The device is powered up, but does not yet have a carrier. + + + + + + dormant + + The device has a carrier, but is not yet ready for normal traffic. + + + + + + degraded-carrier + + One of the bonding or bridge slave network interfaces is in off, no-carrier, or + dormant state, and the master interface has no address. + + + + + + carrier + + The link has carrier, or for bond or bridge master, all bonding or bridge slave + network interfaces are enslaved to the master. + + + + + + degraded + + 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. + + + + + + enslaved + + The link has carrier and is enslaved to bond or bridge master network interface. + + + + + + + routable + + 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. + + + + + + + + The setup status is one of the following: + + + pending + + systemd-udevd8 + is still processing the link, we don't yet know if we will manage it. + + + + + + initialized + + systemd-udevd8 + has processed the link, but we don't yet know if we will manage it. + + + + + + configuring + + Configuration for the link is being retrieved or the link is being configured. + + + + + + configured + + Link has been configured successfully. + + + + + + unmanaged + + systemd-networkd is not handling the link. + + + + + + failed + + systemd-networkd failed to configure the link. + + + + + + linger + + The link is gone, but has not yet been dropped by systemd-networkd. + + + + + + + + + + + + + + status + PATTERN… + + + + Show information about the specified links: type, state, kernel module driver, hardware and + IP address, configured DNS servers, etc. If one or more PATTERNs are + specified, only links matching one of them are shown. + + When no links are specified, an overall network status is shown. Also see the option + . + + Produces output similar to: + +● 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 + + 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: + + + unknown + + All links have unknown online status (i.e. there are no required links). + + + + + + offline + + All required links are offline. + + + + + + partial + + Some, but not all, required links are online. + + + + + + online + + All required links are online. + + + + + + + + + + + + + + + lldp + PATTERN… + + + + Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more + PATTERNs are specified only neighbors on those interfaces are shown. + Otherwise shows discovered neighbors on all interfaces. Note that for this feature to work, + LLDP= must be turned on for the specific interface, see + systemd.network5 for + details. + + Produces output similar to: + 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. + + + + + + + + label + + + Show numerical address labels that can be used for address selection. + This is the same information that + ip-addrlabel8 + shows. See RFC 3484 + for a discussion of address labels. + + Produces output similar to: + 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 + + + + + + + + delete + DEVICE… + + Deletes virtual netdevs. Takes interface name or index number. + + + + + + + up + DEVICE… + + Bring devices up. Takes interface name or index number. + + + + + + + down + DEVICE… + + Bring devices down. Takes interface name or index number. + + + + + + + renew + DEVICE… + + Renew dynamic configurations e.g. addresses received from DHCP server. + Takes interface name or index number. + + + + + + + forcerenew + DEVICE… + + Send a FORCERENEW message to all connected clients, triggering DHCP reconfiguration. + Takes interface name or index number. + + + + + + + reconfigure + DEVICE… + + 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 + networkctl reload first to apply new settings. + + + + + + + reload + + 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, + systemd-networkd 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. + + + + + + + edit + FILE|@DEVICE… + + 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. + + If is specified, edit the drop-in file instead of + the main configuration file. Unless is specified, + systemd-networkd will be reloaded after the edit of the + .network or .netdev files finishes. + The same applies for .link files and + systemd-udevd8. + Note that the changed link settings are not automatically applied after reloading. + To achieve that, trigger uevents for the corresponding interface. Refer to + systemd.link5 + for more information. + + + + + + + cat + FILE|@DEVICE… + + Show network configuration files. This command honors + the @ prefix in the same way as edit. + + + + + + + + Options + + The following options are understood: + + + + + + + + + + Show all links with status. + + + + + + + + + + + + + Show link statistics with status. + + + + + + + + + + + Do not ellipsize the output. + + + + + + + + + + + When used with status, controls the number of journal lines to show, + counting from the most recent ones. Takes a positive integer argument. Defaults to 10. + + + + + + + NAME + + + When used with edit, edit the drop-in file NAME + instead of the main configuration file. + + + + + + + + + + When used with edit, + systemd-networkd.service8 + or + systemd-udevd.service8 + will not be reloaded after the editing finishes. + + + + + + + + + + + + + + + + Exit status + + On success, 0 is returned, a non-zero failure code otherwise. + + + + See Also + + systemd-networkd.service8, + systemd.network5, + systemd.netdev5, + ip8 + + + -- cgit v1.2.3