systemd/man/networkctl.1
2015-02-17 11:22:16 +01:00

122 lines
3.1 KiB
Groff

'\" t
.TH "NETWORKCTL" "1" "" "systemd 219" "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 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 introspect 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 the basic concepts, functionality, and configuration syntax\&.
.SH "OPTIONS"
.PP
The following options are understood:
.PP
\fB\-a\fR \fB\-\-all\fR
.RS 4
Show all links with
\fBstatus\fR\&.
.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\-pager\fR
.RS 4
Do not pipe output into a pager\&.
.RE
.SH "COMMANDS"
.PP
The following commands are understood:
.PP
\fBlist\fR
.RS 4
Show a list of existing links and their status\&. 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
.\}
.RE
.PP
\fBstatus\fR [\fILINK\&.\&.\&.\fR]
.RS 4
Show information about the specified links: type, state, kernel module driver, hardware and IP address, configured DNS servers, etc\&.
.sp
When no links are specified, routable links are shown\&. See also option
\fB\-\-all\fR\&.
.sp
Produces output similar to
.sp
.if n \{\
.RS 4
.\}
.nf
● State: routable
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
.\}
.RE
.PP
\fBlldp\fR
.RS 4
Show LLDP (Link Layer Discovery Protocol) status\&.
.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)