{ "content": [ { "type": "text", "text": "# NETWORKCTL (man)\n\n## NAME\n\nnetworkctl - Query the status of network links\n\n## SYNOPSIS\n\nnetworkctl [OPTIONS...] COMMAND [LINK...]\n\n## DESCRIPTION\n\nnetworkctl may be used to introspect the state of the network links as seen by\nsystemd-networkd. Please refer to systemd-networkd.service(8) for an introduction to the\nbasic concepts, functionality, and configuration syntax.\n\n## TLDR\n\n> Query the status of network links.\n\n- List existing links with their status:\n `networkctl`\n- Show an overall network status:\n `networkctl status`\n- Bring network devices up:\n `networkctl up {{interface1 interface2 ...}}`\n- Bring network devices down:\n `networkctl down {{interface1 interface2 ...}}`\n- Renew dynamic configurations (e.g. IP addresses received from a DHCP server):\n `networkctl renew {{interface1 interface2 ...}}`\n- Reload configuration files (`.netdev` and `.network`):\n `networkctl reload`\n- Reconfigure network interfaces (if you edited the config, you need to call `networkctl reload` first):\n `networkctl reconfigure {{interface1 interface2 ...}}`\n\n*Source: tldr-pages*\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **COMMANDS** (2 subsections)\n- **OPTIONS** (8 subsections)\n- **EXIT STATUS**\n- **SEE ALSO**\n- **NOTES**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "NETWORKCTL", "section": "", "mode": "man", "summary": "networkctl - Query the status of network links", "synopsis": "networkctl [OPTIONS...] COMMAND [LINK...]", "tldr_summary": "Query the status of network links.", "tldr_examples": [ { "description": "List existing links with their status", "command": "networkctl" }, { "description": "Show an overall network status", "command": "networkctl status" }, { "description": "Bring network devices up", "command": "networkctl up {{interface1 interface2 ...}}" }, { "description": "Bring network devices down", "command": "networkctl down {{interface1 interface2 ...}}" }, { "description": "Renew dynamic configurations (e.g. IP addresses received from a DHCP server)", "command": "networkctl renew {{interface1 interface2 ...}}" }, { "description": "Reload configuration files (`.netdev` and `.network`)", "command": "networkctl reload" }, { "description": "Reconfigure network interfaces (if you edited the config, you need to call `networkctl reload` first)", "command": "networkctl reconfigure {{interface1 interface2 ...}}" } ], "tldr_source": "official", "flags": [ { "flag": "-a", "long": "--all", "arg": null, "description": "Show all links with status." }, { "flag": "-s", "long": "--stats", "arg": null, "description": "Show link statistics with status." }, { "flag": "-l", "long": "--full", "arg": null, "description": "Do not ellipsize the output." }, { "flag": "-n", "long": null, "arg": null, "description": "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. --json=MODE 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)." }, { "flag": "-h", "long": "--help", "arg": null, "description": "Print a short help text and exit." }, { "flag": "", "long": "--version", "arg": null, "description": "Print a short version string and exit." }, { "flag": "", "long": "--no-legend", "arg": null, "description": "Do not print the legend, i.e. column headers and the footer with hints." }, { "flag": "", "long": "--no-pager", "arg": null, "description": "Do not pipe output into a pager." } ], "examples": [], "see_also": [ { "name": "systemd-networkd.service", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/systemd-networkd.service/8/json" }, { "name": "systemd.network", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/systemd.network/5/json" }, { "name": "systemd.netdev", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/systemd.netdev/5/json" }, { "name": "ip", "section": "8", "url": "https://www.chedong.com/phpMan.php/man/ip/8/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 2, "subsections": [] }, { "name": "DESCRIPTION", "lines": 4, "subsections": [] }, { "name": "COMMANDS", "lines": 122, "subsections": [ { "name": "label", "lines": 40 }, { "name": "reload", "lines": 5 } ] }, { "name": "OPTIONS", "lines": 2, "subsections": [ { "name": "-a --all", "lines": 2, "flag": "-a", "long": "--all" }, { "name": "-s --stats", "lines": 2, "flag": "-s", "long": "--stats" }, { "name": "-l --full", "lines": 2, "flag": "-l", "long": "--full" }, { "name": "-n --lines=", "lines": 8, "flag": "-n" }, { "name": "-h --help", "lines": 2, "flag": "-h", "long": "--help" }, { "name": "--version", "lines": 2, "long": "--version" }, { "name": "--no-legend", "lines": 2, "long": "--no-legend" }, { "name": "--no-pager", "lines": 2, "long": "--no-pager" } ] }, { "name": "EXIT STATUS", "lines": 2, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "NOTES", "lines": 6, "subsections": [] } ], "sections": { "NAME": { "content": "networkctl - Query the status of network links\n", "subsections": [] }, "SYNOPSIS": { "content": "networkctl [OPTIONS...] COMMAND [LINK...]\n", "subsections": [] }, "DESCRIPTION": { "content": "networkctl may be used to introspect the state of the network links as seen by\nsystemd-networkd. Please refer to systemd-networkd.service(8) for an introduction to the\nbasic concepts, functionality, and configuration syntax.\n", "subsections": [] }, "COMMANDS": { "content": "The following commands are understood:\n\nlist [PATTERN...]\nShow a list of existing links and their status. If one ore more PATTERNs are specified,\nonly links matching one of them are shown. If no further arguments are specified shows\nall links, otherwise just the specified links. Produces output similar to:\n\nIDX LINK TYPE OPERATIONAL SETUP\n1 lo loopback carrier unmanaged\n2 eth0 ether routable configured\n3 virbr0 ether no-carrier unmanaged\n4 virbr0-nic ether off unmanaged\n\n4 links listed.\n\nThe operational status is one of the following:\n\nmissing\nthe device is missing\n\noff\nthe device is powered down\n\nno-carrier\nthe device is powered up, but it does not yet have a carrier\n\ndormant\nthe device has a carrier, but is not yet ready for normal traffic\n\ndegraded-carrier\nfor bond or bridge master, one of the bonding or bridge slave network interfaces is\nin off, no-carrier, or dormant state\n\ncarrier\nthe link has a carrier, or for bond or bridge master, all bonding or bridge slave\nnetwork interfaces are enslaved to the master\n\ndegraded\nthe link has carrier and addresses valid on the local link configured\n\nenslaved\nthe link has carrier and is enslaved to bond or bridge master network interface\n\nroutable\nthe link has carrier and routable address configured\n\nThe setup status is one of the following:\n\npending\nudev is still processing the link, we don't yet know if we will manage it\n\nfailed\nnetworkd failed to manage the link\n\nconfiguring\nin the process of retrieving configuration or configuring the link\n\nconfigured\nlink configured successfully\n\nunmanaged\nnetworkd is not handling the link\n\nlinger\nthe link is gone, but has not yet been dropped by networkd\n\n\nstatus [PATTERN...]\nShow information about the specified links: type, state, kernel module driver, hardware\nand IP address, configured DNS servers, etc. If one ore more PATTERNs are specified, only\nlinks matching one of them are shown.\n\nWhen no links are specified, an overall network status is shown. Also see the option\n--all.\n\nProduces output similar to:\n\n● State: routable\nOnline state: online\nAddress: 10.193.76.5 on eth0\n192.168.122.1 on virbr0\n169.254.190.105 on eth0\nfe80::5054:aa:bbbb:cccc on eth0\nGateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0\nDNS: 8.8.8.8\n8.8.4.4\n\nIn the overall network status, the online state depends on the individual online state of\nall required links. Managed links are required for online by default. In this case, the\nonline state is one of the following:\n\nunknown\nall links have unknown online status (i.e. there are no required links)\n\noffline\nall required links are offline\n\npartial\nsome, but not all, required links are online\n\nonline\nall required links are online\n\n\nlldp [PATTERN...]\nShow discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more PATTERNs\nare specified only neighbors on those interfaces are shown. Otherwise shows discovered\nneighbors on all interfaces. Note that for this feature to work, LLDP= must be turned on\nfor the specific interface, see systemd.network(5) for details.\n\nProduces output similar to:\n\nLINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION\nenp0s25 00:e0:4c:00:00:00 GS1900 ..b........ 2 Port #2\n\nCapability Flags:\no - Other; p - Repeater; b - Bridge; w - WLAN Access Point; r - Router;\nt - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN;\ns - Service VLAN, m - Two-port MAC Relay (TPMR)\n\n1 neighbors listed.\n", "subsections": [ { "name": "label", "content": "Show numerical address labels that can be used for address selection. This is the same\ninformation that ip-addrlabel(8) shows. See RFC 3484[1] for a discussion of address\nlabels.\n\nProduces output similar to:\n\nPrefix/Prefixlen Label\n::/0 1\nfc00::/7 5\nfec0::/10 11\n2002::/16 2\n3ffe::/16 12\n2001:10::/28 7\n2001::/32 6\n::ffff:0.0.0.0/96 4\n::/96 3\n::1/128 0\n\ndelete DEVICE...\nDeletes virtual netdevs. Takes interface name or index number.\n\nup DEVICE...\nBring devices up. Takes interface name or index number.\n\ndown DEVICE...\nBring devices down. Takes interface name or index number.\n\nrenew DEVICE...\nRenew dynamic configurations e.g. addresses received from DHCP server. Takes interface\nname or index number.\n\nforcerenew DEVICE...\nSend a FORCERENEW message to all connected clients, triggering DHCP reconfiguration.\nTakes interface name or index number.\n\nreconfigure DEVICE...\nReconfigure network interfaces. Takes interface name or index number. Note that this does\nnot reload .netdev or .network corresponding to the specified interface. So, if you edit\nconfig files, it is necessary to call networkctl reload first to apply new settings.\n" }, { "name": "reload", "content": "Reload .netdev and .network files. If a new .netdev file is found, then the corresponding\nnetdev is created. Note that even if an existing .netdev is modified or removed,\nsystemd-networkd does not update or remove the netdev. If a new, modified or removed\n.network file is found, then all interfaces which match the file are reconfigured.\n" } ] }, "OPTIONS": { "content": "The following options are understood:\n", "subsections": [ { "name": "-a --all", "content": "Show all links with status.\n", "flag": "-a", "long": "--all" }, { "name": "-s --stats", "content": "Show link statistics with status.\n", "flag": "-s", "long": "--stats" }, { "name": "-l --full", "content": "Do not ellipsize the output.\n", "flag": "-l", "long": "--full" }, { "name": "-n --lines=", "content": "When used with status, controls the number of journal lines to show, counting from the\nmost recent ones. Takes a positive integer argument. Defaults to 10.\n\n--json=MODE\nShows output formatted as JSON. Expects one of \"short\" (for the shortest possible output\nwithout any redundant whitespace or line breaks), \"pretty\" (for a pretty version of the\nsame, with indentation and line breaks) or \"off\" (to turn off JSON output, the default).\n", "flag": "-n" }, { "name": "-h --help", "content": "Print a short help text and exit.\n", "flag": "-h", "long": "--help" }, { "name": "--version", "content": "Print a short version string and exit.\n", "long": "--version" }, { "name": "--no-legend", "content": "Do not print the legend, i.e. column headers and the footer with hints.\n", "long": "--no-legend" }, { "name": "--no-pager", "content": "Do not pipe output into a pager.\n", "long": "--no-pager" } ] }, "EXIT STATUS": { "content": "On success, 0 is returned, a non-zero failure code otherwise.\n", "subsections": [] }, "SEE ALSO": { "content": "systemd-networkd.service(8), systemd.network(5), systemd.netdev(5), ip(8)\n", "subsections": [] }, "NOTES": { "content": "1. RFC 3484\nhttps://tools.ietf.org/html/rfc3484\n\n\n\nsystemd 249 NETWORKCTL(1)", "subsections": [] } } } }