diff options
Diffstat (limited to 'man/nmcli.1')
| -rw-r--r-- | man/nmcli.1 | 1203 |
1 files changed, 16 insertions, 1187 deletions
diff --git a/man/nmcli.1 b/man/nmcli.1 index 04d4ee78..69ab97f1 100644 --- a/man/nmcli.1 +++ b/man/nmcli.1 @@ -2,12 +2,12 @@ .\" Title: nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/29/2020 +.\" Date: 06/15/2020 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.24.2 +.\" Source: NetworkManager 1.25.90 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.24\&.2" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.25\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -455,7 +455,7 @@ only shows active connection data (when the profile is active)\&. .RE .sp You can also specify particular fields\&. For static configuration, use setting and property names as described in -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) manual page\&. For active data use GENERAL, IP4, DHCP4, IP6, DHCP6, VPN\&. .sp When no command is given to the @@ -596,9 +596,13 @@ Add, modify or remove properties in the connection profile\&. .sp To set the property just specify the property name followed by the value\&. An empty value ("") resets the property value to the default\&. .sp -In addition to the properties, you can also use short names for some of the properties\&. Consult the -PROPERTY ALIASES -section for details\&. +See +\fBnm-settings-nmcli\fR(5) +for complete reference of setting and property names, their descriptions and default values\&. The +\fIsetting\fR +and +\fIproperty\fR +can be abbreviated provided they are unique\&. .sp If you want to append an item or a flag to the existing value, use + @@ -616,14 +620,6 @@ bond\&.options, 802\-1x\&.phase1\-auth\-flags etc\&. .sp -See -\fBnm-settings\fR(5) -for complete reference of setting and property names, their descriptions and default values\&. The -\fIsetting\fR -and -\fIproperty\fR -can be abbreviated provided they are unique\&. -.sp The connection is identified by its name, UUID or D\-Bus path\&. If \fIID\fR is ambiguous, a keyword @@ -644,10 +640,8 @@ Removes a setting from the connection profile\&. Create a new connection using specified properties\&. .sp You need to describe the newly created connections with the property and value pairs\&. See -\fBnm-settings\fR(5) -for the complete reference\&. You can also use the aliases described in -PROPERTY ALIASES -section\&. The syntax is the same as of the +\fBnm-settings-nmcli\fR(5) +for the complete reference\&. The syntax is the same as of the \fBnmcli connection modify\fR command\&. .sp @@ -965,7 +959,7 @@ name for the new connection\&. It can be changed later in the editor\&. .RE .sp See also -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) for all NetworkManager settings and property names, and their descriptions; and \fBnmcli-examples\fR(7) for sample editor sessions\&. @@ -1120,14 +1114,8 @@ Modify the settings currently active on the device\&. This command lets you do temporary changes to a configuration active on a particular device\&. The changes are not preserved in the connection profile\&. .sp See -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) for the list of available properties\&. Please note that some properties can\*(Aqt be changed on an already connected device\&. -.sp -You can also use the aliases described in -PROPERTY ALIASES -section\&. The syntax is the same as of the -\fBnmcli connection modify\fR -command\&. .RE .PP \fBdisconnect\fR \fIifname\fR... @@ -1331,1165 +1319,6 @@ Runs \fBnmcli\fR as both NetworkManager secret and a polkit agent\&. .RE -.SH "PROPERTY ALIASES" -.PP -Apart from the property\-value pairs, -\fBconnection add\fR, -\fBconnection modify\fR -and -\fBdevice modify\fR -also accept short forms of some properties\&. They exist for convenience\&. Some aliases can affect multiple connection properties at once\&. -.PP -The overview of the aliases is below\&. An actual connection type is used to disambiguate these options from the options of the same name that are valid for multiple connection types (such as -\fBmtu\fR)\&. -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&1.\ \&Options for all connections -.TS -allbox tab(:); -lB lB lB. -T{ -Alias -T}:T{ -Property -T}:T{ -Note -T} -.T& -l l lt -l l lt -l l l -l l lt -l l lt -l l l. -T{ -type -T}:T{ -connection\&.type -T}:T{ -This alias also accepts values of \fBbond\-slave\fR, -\fBteam\-slave\fR and \fBbridge\-slave\fR\&. They create -\fBethernet\fR connection profiles\&. Their use is discouraged in -favor of using a specific type with \fBmaster\fR option\&. -T} -T{ -con\-name -T}:T{ -connection\&.id -T}:T{ -When not provided a default name is generated: <type>[\-<ifname>][\-<num>])\&. -T} -T{ -autoconnect -T}:T{ -connection\&.autoconnect -T}:T{ -\ \& -T} -T{ -ifname -T}:T{ -connection\&.interface\-name -T}:T{ -A value of * will be interpreted as -no value, making the connection profile interface\-independent\&. -Note: use quotes around * to suppress shell expansion\&. -For bond, team and bridge connections a default name will be generated if not set\&. -T} -T{ -master -T}:T{ -connection\&.master -T}:T{ -Value specified here will be canonicalized\&. -It can be prefixed with ifname/, uuid/ -or id/ to disambiguate it\&. -T} -T{ -slave\-type -T}:T{ -connection\&.slave\-type -T}:T{ -\ \& -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&2.\ \&PPPoE options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l. -T{ -username -T}:T{ -pppoe\&.username -T} -T{ -password -T}:T{ -pppoe\&.password -T} -T{ -service -T}:T{ -pppoe\&.service -T} -T{ -parent -T}:T{ -pppoe\&.parent -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&3.\ \&Wired Ethernet options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l. -T{ -mtu -T}:T{ -wired\&.mtu -T} -T{ -mac -T}:T{ -wired\&.mac\-address -T} -T{ -cloned\-mac -T}:T{ -wired\&.cloned\-mac\-address -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&4.\ \&Infiniband options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l -l l. -T{ -mtu -T}:T{ -infiniband\&.mtu -T} -T{ -mac -T}:T{ -infiniband\&.mac\-address -T} -T{ -transport\-mode -T}:T{ -infiniband\&.transport\-mode -T} -T{ -parent -T}:T{ -infiniband\&.parent -T} -T{ -p\-key -T}:T{ -infiniband\&.p\-key -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&5.\ \&Wi\-Fi options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l -l l. -T{ -ssid -T}:T{ -wireless\&.ssid -T} -T{ -mode -T}:T{ -wireless\&.mode -T} -T{ -mtu -T}:T{ -wireless\&.mtu -T} -T{ -mac -T}:T{ -wireless\&.mac\-address -T} -T{ -cloned\-mac -T}:T{ -wireless\&.cloned\-mac\-address -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&6.\ \&WiMax options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l. -T{ -nsp -T}:T{ -wimax\&.network\-name -T} -T{ -mac -T}:T{ -wimax\&.mac\-address -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&7.\ \&GSM options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l. -T{ -apn -T}:T{ -gsm\&.apn -T} -T{ -user -T}:T{ -gsm\&.username -T} -T{ -password -T}:T{ -gsm\&.password -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&8.\ \&CDMA options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l. -T{ -user -T}:T{ -cdma\&.username -T} -T{ -password -T}:T{ -cdma\&.password -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&9.\ \&Bluetooth options -.TS -allbox tab(:); -lB lB lB. -T{ -Alias -T}:T{ -Property -T}:T{ -Note -T} -.T& -l l l -l l lt. -T{ -addr -T}:T{ -bluetooth\&.bdaddr -T}:T{ -\ \& -T} -T{ -bt\-type -T}:T{ -bluetooth\&.type -T}:T{ -Apart from the usual panu, -nap and dun options, the values of -dun\-gsm and dun\-cdma can be used for compatibility -with older versions\&. They are equivalent to using dun and setting -appropriate gsm\&.* or cdma\&.* properties\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&10.\ \&VLAN options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l -l l. -T{ -dev -T}:T{ -vlan\&.parent -T} -T{ -id -T}:T{ -vlan\&.id -T} -T{ -flags -T}:T{ -vlan\&.flags -T} -T{ -ingress -T}:T{ -vlan\&.ingress\-priority\-map -T} -T{ -egress -T}:T{ -vlan\&.egress\-priority\-map -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&11.\ \&Bonding options -.TS -allbox tab(:); -lB lB lB. -T{ -Alias -T}:T{ -Property -T}:T{ -Note -T} -.T& -l l lt -l ^ ^ -l ^ ^ -l ^ ^ -l ^ ^ -l ^ ^ -l ^ ^ -l ^ ^. -T{ -mode -T}:T{ -bond\&.options -T}:T{ -Setting each of these adds the option to bond\&.options property\&. -It\*(Aqs equivalent to the +bond\&.options \*(Aqoption=value\*(Aq syntax\&. -T} -T{ -primary -T}:: -T{ -miimon -T}:: -T{ -downdelay -T}:: -T{ -updelay -T}:: -T{ -arp\-interval -T}:: -T{ -arp\-ip\-target -T}:: -T{ -lacp\-rate -T}:: -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&12.\ \&Team options -.TS -allbox tab(:); -lB lB lB. -T{ -Alias -T}:T{ -Property -T}:T{ -Note -T} -.T& -l l l. -T{ -config -T}:T{ -team\&.config -T}:T{ -Either a filename or a team configuration in JSON format\&. To enforce one or the other, the value can be prefixed with "file://" or "json://"\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&13.\ \&Team port options -.TS -allbox tab(:); -lB lB lB. -T{ -Alias -T}:T{ -Property -T}:T{ -Note -T} -.T& -l l l. -T{ -config -T}:T{ -team\-port\&.config -T}:T{ -Either a filename or a team configuration in JSON format\&. To enforce one or the other, the value can be prefixed with "file://" or "json://"\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&14.\ \&Bridge options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l -l l. -T{ -stp -T}:T{ -bridge\&.stp -T} -T{ -priority -T}:T{ -bridge\&.priority -T} -T{ -forward\-delay -T}:T{ -bridge\&.forward\-delay -T} -T{ -hello\-time -T}:T{ -bridge\&.hello\-time -T} -T{ -max\-age -T}:T{ -bridge\&.max\-age -T} -T{ -ageing\-time -T}:T{ -bridge\&.ageing\-time -T} -T{ -group\-forward\-mask -T}:T{ -bridge\&.group\-forward\-mask -T} -T{ -multicast\-snooping -T}:T{ -bridge\&.multicast\-snooping -T} -T{ -mac -T}:T{ -bridge\&.mac\-address -T} -T{ -priority -T}:T{ -bridge\-port\&.priority -T} -T{ -path\-cost -T}:T{ -bridge\-port\&.path\-cost -T} -T{ -hairpin -T}:T{ -bridge\-port\&.hairpin\-mode -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&15.\ \&VPN options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l. -T{ -vpn\-type -T}:T{ -vpn\&.service\-type -T} -T{ -user -T}:T{ -vpn\&.user\-name -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&16.\ \&OLPC Mesh options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l. -T{ -ssid -T}:T{ -olpc\-mesh\&.ssid -T} -T{ -channel -T}:T{ -olpc\-mesh\&.channel -T} -T{ -dhcp\-anycast -T}:T{ -olpc\-mesh\&.dhcp\-anycast\-address -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&17.\ \&ADSL options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l. -T{ -username -T}:T{ -adsl\&.username -T} -T{ -protocol -T}:T{ -adsl\&.protocol -T} -T{ -password -T}:T{ -adsl\&.password -T} -T{ -encapsulation -T}:T{ -adsl\&.encapsulation -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&18.\ \&MACVLAN options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l. -T{ -dev -T}:T{ -macvlan\&.parent -T} -T{ -mode -T}:T{ -macvlan\&.mode -T} -T{ -tap -T}:T{ -macvlan\&.tap -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&19.\ \&MACsec options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l -l l -l l. -T{ -dev -T}:T{ -macsec\&.parent -T} -T{ -mode -T}:T{ -macsec\&.mode -T} -T{ -encrypt -T}:T{ -macsec\&.encrypt -T} -T{ -cak -T}:T{ -macsec\&.cak -T} -T{ -ckn -T}:T{ -macsec\&.ckn -T} -T{ -port -T}:T{ -macsec\&.port -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&20.\ \&VxLAN options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l -l l -l l -l l. -T{ -id -T}:T{ -vxlan\&.id -T} -T{ -remote -T}:T{ -vxlan\&.remote -T} -T{ -dev -T}:T{ -vxlan\&.parent -T} -T{ -local -T}:T{ -vxlan\&.local -T} -T{ -source\-port\-min -T}:T{ -vxlan\&.source\-port\-min -T} -T{ -source\-port\-max -T}:T{ -vxlan\&.source\-port\-max -T} -T{ -destination\-port -T}:T{ -vxlan\&.destination\-port -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&21.\ \&Tun options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l -l l -l l. -T{ -mode -T}:T{ -tun\&.mode -T} -T{ -owner -T}:T{ -tun\&.owner -T} -T{ -group -T}:T{ -tun\&.group -T} -T{ -pi -T}:T{ -tun\&.pi -T} -T{ -vnet\-hdr -T}:T{ -tun\&.vnet\-hdr -T} -T{ -multi\-queue -T}:T{ -tun\&.multi\-queue -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&22.\ \&IP tunneling options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l -l l. -T{ -mode -T}:T{ -ip\-tunnel\&.mode -T} -T{ -local -T}:T{ -ip\-tunnel\&.local -T} -T{ -remote -T}:T{ -ip\-tunnel\&.remote -T} -T{ -dev -T}:T{ -ip\-tunnel\&.parent -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&23.\ \&WPAN options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l -l l -l l. -T{ -mac -T}:T{ -wpan\&.mac -T} -T{ -short\-addr -T}:T{ -wpan\&.short\-addr -T} -T{ -pan\-id -T}:T{ -wpan\&.pan\-id -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&24.\ \&6LoWPAN options -.TS -allbox tab(:); -lB lB. -T{ -Alias -T}:T{ -Property -T} -.T& -l l. -T{ -dev -T}:T{ -6lowpan\&.parent -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&25.\ \&IPv4 options -.TS -allbox tab(:); -lB lB lB. -T{ -Alias -T}:T{ -Property -T}:T{ -Note -T} -.T& -l l lt -l l l. -T{ -ip4 -T}:T{ -ipv4\&.addresses ipv4\&.method -T}:T{ -The alias is equivalent to the +ipv4\&.addresses syntax and also sets ipv4\&.method to manual\&. It can be specified multiple times\&. -T} -T{ -gw4 -T}:T{ -ipv4\&.gateway -T}:T{ -\ \& -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&26.\ \&IPv6 options -.TS -allbox tab(:); -lB lB lB. -T{ -Alias -T}:T{ -Property -T}:T{ -Note -T} -.T& -l l lt -l l l. -T{ -ip6 -T}:T{ -ipv6\&.addresses ipv6\&.method -T}:T{ -The alias is equivalent to the +ipv6\&.addresses syntax and also sets ipv6\&.method to manual\&. It can be specified multiple times\&. -T} -T{ -gw6 -T}:T{ -ipv6\&.gateway -T}:T{ -\ \& -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&27.\ \&Proxy options -.TS -allbox tab(:); -lB lB lB. -T{ -Alias -T}:T{ -Property -T}:T{ -Note -T} -.T& -l l l -l l l -l l l -l l lt. -T{ -method -T}:T{ -proxy\&.method -T}:T{ -\ \& -T} -T{ -browser\-only -T}:T{ -proxy\&.browser\-only -T}:T{ -\ \& -T} -T{ -pac\-url -T}:T{ -proxy\&.pac\-url -T}:T{ -\ \& -T} -T{ -pac\-script -T}:T{ -proxy\&.pac\-script -T}:T{ -Read the JavaScript PAC (proxy auto\-config) script from file or pass it directly on the command line\&. Prefix the value with "file://" or "js://" to force one or the other\&. -T} -.TE -.sp 1 .SH "COLORS" .PP Implicit coloring can be disabled by an empty file @@ -2988,10 +1817,10 @@ https://gitlab\&.freedesktop\&.org/NetworkManager/NetworkManager\&. .SH "SEE ALSO" .PP \fBnmcli-examples\fR(7), +\fBnm-settings-nmcli\fR(5), \fBnm-online\fR(1), \fBNetworkManager\fR(8), \fBNetworkManager.conf\fR(5), -\fBnm-settings\fR(5), \fBnm-applet\fR(1), \fBnm-connection-editor\fR(1), \fBterminal-colors.d\fR(5)\&. |