Date: Fri, 26 Aug 2016 02:18:32 +0200 Subject: Imported Upstream version 1.4.0 --- docs/api/html/nmcli.html | 2105 +++++++++++++++++++++++----------------------- 1 file changed, 1031 insertions(+), 1074 deletions(-) (limited to 'docs/api/html/nmcli.html') diff --git a/docs/api/html/nmcli.html b/docs/api/html/nmcli.html index d66bcb34..4a280e99 100644 --- a/docs/api/html/nmcli.html +++ b/docs/api/html/nmcli.html @@ -8,7 +8,7 @@ - + @@ -47,7 +47,7 @@ terse output format which is better suited for script processing. Note that NetworkManager can also execute scripts, called "dispatcher scripts", in response to network events. See - NetworkManager(8) + NetworkManager(8) for details about these dispatcher scripts.

Servers, headless machines, and terminals: nmcli can be used to control NetworkManager without a GUI, including creating, editing, @@ -113,7 +113,7 @@ to a terminal. The default value is auto.

-f | --fields {[field...] | all | common }

-f | --fields { field1,field2... | all | common }

This option is used to specify what fields (column names) should be printed. Valid field names differ for specific commands. List available fields @@ -149,10 +149,9 @@ also influences echoing passwords typed by user as an input.

[ - -w | --wait - seconds... - ]

-w | --wait + seconds +

This option sets a timeout period for which nmcli will wait for NetworkManager to finish operations. It is @@ -164,6 +163,17 @@ +

--complete-args

+ +

Instead of conducting the desired action, nmcli + will list possible completions for the last argument. This is useful to implement + argument completion in shell.

The exit status will indicate success + or return a code 65 to indicate the last argument is a file name.

NetworkManager ships with command completion support for GNU Bash.

+ + +

-v | --version

Show nmcli version.

@@ -216,13 +226,13 @@

logging [level level] - [domain domains...] + [domains domains...]

Get and change NetworkManager logging level and domains. Without any argument current logging level and domains are shown. In order to change logging state, provide level and, or, domain parameters. See - NetworkManager.conf(5) + NetworkManager.conf(5) for available level and domain values.

@@ -338,7 +348,7 @@

Connection Management Commands

nmcli connection { show | up | down | add | edit | modify | delete | monitor | reload | load } [ARGUMENTS...]

nmcli connection { show | up | down | modify | add | edit | clone | delete | monitor | reload | load | import | export } [ARGUMENTS...]

NetworkManager stores all network configuration as "connections", which are collections of data (Layer2 details, IP addressing, etc.) that describe how to create or connect to a network. A connection is "active" @@ -463,7 +473,7 @@

up [ id | uuid | path ] - ID... + ID [ifname ifname] [ap BSSID] [passwd-file file] @@ -563,36 +573,82 @@ +

+ modify + [--temporary] + [ id | uuid | path ] + ID + + { option value | [+|-]setting.property value } + ... +

+ +

Add, modify or remove properties in the connection profile.

To set the property just specify the property name followed by the + value. An empty value ("") removes the property value.

In addition to the properties, you can also use short names for some of + the properties. Consult the Property Aliases + section for details.

If you want to append an item to the existing value, use + + prefix for the property name. If you want to remove just + one item from container-type property, use - prefix for + the property name and specify a value or an zero-based index of the item to + remove (or option name for properties with named options) as + value. The + and - + modifies only have a real effect for multi-value (container) + properties like ipv4.dns, ipv4.addresses, + bond.options, etc.

See nm-settings(5) for complete reference of setting and property names, their descriptions + and default values. The setting and + property can be abbreviated provided they are unique.

The connection is identified by its name, UUID or D-Bus path. If + ID is ambiguous, a keyword id, + uuid or path can be used.

+ + +

add - ifname ifname - [con-name name] - [ - autoconnect - { yes | no } - ] - [ - save - { yes | no } - ] - [master master] - [slave-type type] - [type type] - [ARGUMENTS...] - [ip4 addr] - [gw4 addr] - [ip6 addr] - [gw6 addr] - [ - -- - - [+|-]setting.property - value - ... - ] + [save { yes | no }] + + { option value | [+|-]setting.property value } + ...

Add a connection for NetworkManager. Arguments differ according to connection types, see below.

Create a new connection using specified properties.

You need to describe the newly created connections with the property and value pairs. + See nm-settings(5) for the complete reference. You can also use the aliases described in + Property Aliases section. The syntax is + the same as of the nmcli connection modify command.

To construct a meaningful connection you at the very least need to set the + connection.type property (or use the type alias) + to one of known NetworkManager connection types:

ethernet
wifi
wimax
pppoe
gsm
cdma
infiniband
bluetooth
vlan
bond
bond-slave
team
team-slave
bridge
bridge-slave
vpn
olpc-mesh
adsl
tun
ip-tunnel
macvlan
vxlan

The most typical uses are described in the Examples section.

Aside from the properties and values two special options are accepted:

@@ -600,1384 +656,1271 @@ - - - - - - - - - - - - - - - - - - - + + - - - + +

`ifname`	interface to bind the connection to. The connection will only be - applicable to this interface name. A special value of `` - can be used for interface-independent connections. The - `ifname` argument is mandatory for all connection types - except bond, team, bridge and vlan. Note: use quotes around - `` to suppress shell expansion.
`con-name`	connection name (when not provided a default name is generated: - <type>[-<ifname>][-<num>]).
`autoconnect`	whether the connection profile can be automatically activated (default: - yes).
`save`	whether the connection should be persistent, i.e. NetworkManager should +	Controls whether the connection should be persistent, i.e. NetworkManager should store it on disk (default: `yes`).
`master`	master interface name, or connection UUID or ID of master connection - profile. The value can be prefixed with `ifname/`, - `uuid/` or `id/` to disambiguate it.
`slave-type`	type of master connection. Only required when it can not be inferred - (i.e. the master connection does - not exist yet).	`--`	If a single `--` argument is encountered it is ignored. + This is for compatibility with older versions on nmcli.
`type`	connection type; see below for allowed values. Note that types - `bond-slave`, `team-slave` and - `bridge-slave` create `ethernet` connection - profiles. Their use is discouraged in favor of using a specific type with - `master` option.

- type ethernet - [mac addr] - [cloned-mac addr] - [mtu mtu] -

+ edit + { + [ id | uuid | path ] + ID + | + [typetype] + [con-namename] + } +

+ +

Edit an existing connection or add a new one, using an interactive editor.

The existing connection is identified by its name, UUID or D-Bus path. If + ID is ambiguous, a keyword id, + uuid, or path can be used. See + connection show above for the description of the + ID-specifying keywords. Not providing an + ID means that a new connection will be added.

The interactive editor will guide you through the connection editing and + allow you to change connection parameters according to your needs by means of + a simple menu-driven interface. The editor indicates what settings and + properties can be modified and provides in-line help.

Available options:

- - - - - - + + - - + + -

`mac`	MAC address of the device this connection is locked to.
`cloned-mac`	cloned MAC.	`type`	type of the new connection; valid types are the same as for + connection add command.
`mtu`	MTU.	`con-name`	name for the new connection. It can be changed later in the editor.

See also + nm-settings(5) for all NetworkManager settings and property names, and their + descriptions; and + nmcli-examples(7) + for sample editor sessions.

- type wifi - ssid SSID - [mac addr] - [cloned-mac addr] - [ - mode - { infrastructure | ap | adhoc } - ] - [mtu mtu] -

---- - - - - + clone + [--temporary] + [ id | uuid | path ] + ID + new_name +

+ - - + + - - + + - - + + - - - - -

`ssid`	SSID.	+ Clone a connection. The connection to be cloned is identified by its + name, UUID or D-Bus path. If `ID` is ambiguous, a keyword + `id`, `uuid` or `path` + can be used. See connection show above for the description + of the `ID`-specifying keywords. `new_name` is + the name of the new cloned connection. The new connection will be the exact + copy except the connection.id (`new_name`) and + connection.uuid (generated) properties. + The new connection profile will be saved as persistent unless + `--temporary` option is specified, in which case the new profile + won't exist after NetworkManager restart. +
`mac`	MAC address of the device this connection is locked to.	+ delete + [ `id` \| `uuid` \| `path` ] + `ID`... +	+ Delete a configured connection. The connection to be deleted is + identified by its name, UUID or D-Bus path. If `ID` is ambiguous, a + keyword `id`, `uuid` or `path` can be used. + See connection show above for the description of + the `ID`-specifying keywords. + If `--wait` option is not specified, the default timeout will be 10 + seconds. +
`cloned-mac`	cloned MAC.	+ monitor + [ `id` \| `uuid` \| `path` ] + `ID`... +	+ Monitor connection profile activity. This command prints a line whenever + the specified connection changes. The connection to be monitored is identified + by its name, UUID or D-Bus path. If `ID` is ambiguous, a keyword + `id`, `uuid` or `path` + can be used. See connection show above for the description of the + `ID`-specifying keywords. + Monitors all connection profiles in case none is specified. The command + terminates when all monitored connections disappear. If you want to monitor + connection creation consider using the global monitor with nmcli + monitor command. +
`mode`	Wi-Fi network mode. If blank, `infrastructure` - is assumed.	+ reload +	Reload all connection files from disk. + NetworkManager does not monitor changes to connection + files by default. So you need to use this command in order to tell + NetworkManager to re-read the connection profiles from + disk when a change was made to them. However, the auto-loading feature can be + enabled and then NetworkManager will reload connection + files any time they change (monitor-connection-files=true in + NetworkManager.conf(5)). +
`mtu`	MTU.

+ load + filename... +

Load/reload one or more connection files from disk. Use this after + manually editing a connection file to ensure that + NetworkManager is aware of its latest state.

- type wimax - [mac addr] - [nsp nsp] -

---- - - - - + import + [--temporary] + typetype + filefile +

+ - - + + -

mac

MAC address of the device this connection is locked to.

Import an external/foreign configuration as a NetworkManager connection + profile. The type of the input file is specified by type + option.

Only VPN configurations are supported at the moment. The configuration is + imported by NetworkManager VPN plugins. type values are + the same as for vpn-type option in nmcli + connection add. VPN configurations are imported by VPN plugins. + Therefore the proper VPN plugin has to be installed so that nmcli could import + the data.

The imported connection profile will be saved as persistent unless + --temporary option is specified, in which case the new profile + won't exist after NetworkManager restart.

nsp

Network Service Provider name.

+ export + [ id | uuid | path ] + ID + [file] +

Export a connection.

Only VPN connections are supported at the moment. A proper VPN plugin has + to be installed so that nmcli could export a connection. If no + file is provided, the VPN configuration + data will be printed to standard output.

- - -

- type pppoe - username user - [password passwd] - [service name] - [mtu mtu] - [mac addr] -

Device Management Commands

nmcli device { status | show | set | connect | reapply | modify | disconnect | delete | monitor | wifi | lldp } [ARGUMENTS...]

Show and manage network interfaces.

- - - - - - + + - - + + - - + + - - - - -

`username`	PPPoE username.
`password`	Password for the PPPoE username.	status	+ Print status of devices. + This is the default action if no command is specified to + nmcli device. +
`service`	PPPoE service name (if required by concentrator).	+ show + [`ifname`] +	Show detailed information about devices. Without an argument, all + devices are examined. To get information for a specific device, the interface + name has to be provided.
`mtu`	MTU.	+ set + [ifname] + `ifname` + [ + `autoconnect` + { yes \| no } + ] + [ + `managed` + { yes \| no } + ] +	Set device properties.
`mac`	MAC address of the device this connection is locked to.

+ connect + ifname +

+ +

Connect the device. NetworkManager will try to find a suitable connection + that will be activated. It will also consider connections that are not set to + auto connect.

If --wait option is not specified, the default timeout will be 90 + seconds.

- type gsm - [apn APN] - [username user] - [password passwd] -

---- - - - - + reapply + ifname +

+ - - + + - - - - -

apn

APN - GSM Access Point Name.

Attempt to update device with changes to the currently active connection + made since it was last applied.

user

user name.

+ modify + ifname + + { option value | [+|-]setting.property value } + ... +

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.

See nm-settings(5) for the list of available properties. Please note that some + properties can't be changed on an already connected device.

You can also use the aliases described in + Property Aliases section. The syntax is + the same as of the nmcli connection modify command.

password

password.

+ disconnect + ifname... +

+ +

Disconnect a device and prevent the device from automatically activating + further connections without user/manual intervention. Note that disconnecting + software devices may mean that the devices will disappear.

If --wait option is not specified, the default timeout + will be 10 seconds.

- type cdma - [username user] - [password passwd] -

---- - - - - + delete + ifname... +

+ - - + + - -

user

user name.

Delete a device. The command removes the interface from the system. Note + that this only works for software devices like bonds, bridges, teams, etc. + Hardware devices (like Ethernet) cannot be deleted by the command.

If --wait option is not specified, the default timeout will be 10 + seconds.

password

password.

+ monitor + [ifname...] +

Monitor device activity. This command prints a line whenever the + specified devices change state.

Monitors all devices in case no interface is specified. The monitor + terminates when all specified devices disappear. If you want to monitor device + addition consider using the global monitor with nmcli + monitor command.

+ +

+ wifi + [ + list + [ifname ifname] + [bssid BSSID] + ] +

List available Wi-Fi access points. The ifname and + bssid options can be used to list APs for a particular + interface or with a specific BSSID, respectively.

- type infiniband - [mac addr] - [mtu mtu] - [ - transport-mode - { datagram | connected } - ] - [parent device] - [p-key key] -

+ wifi + connect + (B)SSID + [passwordpassword] + [ + wep-key-type + { key | phrase } + ] + [ifnameifname] + [bssidBSSID] + [namename] + [ + private + { yes | no } + ] + [ + hidden + { yes | no } + ] +

+ + + - - +

Connect to a Wi-Fi network specified by SSID or BSSID. The command + creates a new connection and then activates it on a device. This is a + command-line counterpart of clicking an SSID in a GUI client. The command + always creates a new connection and thus it is mainly useful for connecting to + new Wi-Fi networks. If a connection for the network already exists, it is + better to bring up (activate) the existing connection as follows: + nmcli con up id name. Note that + only open, WEP and WPA-PSK networks are supported at the moment. It is also + supposed that IP configuration is obtained via DHCP.

If --wait option is not specified, the default timeout will be 90 + seconds.

Available options are:

- - + + - - + + - - + + - - + + - - - - -

`mac`	MAC address of the device this connection is locked to - (InfiniBand MAC is 20 bytes).	`password`	password for secured networks (WEP or WPA).
`mtu`	MTU.	`wep-key-type`	type of WEP secret, either `key` for ASCII/HEX key or + `phrase` for passphrase.
`transport-mode`	InfiniBand transport mode.	`ifname`	interface that will be used for activation.
`parent`	the interface name of the parent device (if any).	`bssid`	if specified, the created connection will be restricted just for the + BSSID.
`p-key`	the InfiniBand P_Key (16-bit unsigned integer).

name

if specified, the connection will use the name (else NM creates a name + itself).

- type bluetooth - [addr addr] - [ - bt-type - { panu | dun-gsm | dun-cdma } - ] -

---- - - - - + + - - + + -

`addr`	Bluetooth device address (MAC).	`private`	if set to `yes`, the connection will only be visible + to the user who created it. Otherwise the connection is system-wide, which is + the default.
`bt-type`	Bluetooth connection type.	`hidden`	set to `yes` when connecting for the first time to an + AP not broadcasting its SSID. Otherwise the SSID would not be found and the + connection attempt would fail.

- type vlan - dev device - id id - [flags flags] - [ingress mapping] - [egress mapping] - [mtu mtu] -

+ wifi + hotspot + [ifnameifname] + [con-namename] + [ssidSSID] + [ + band + { a | bg } + ] + [channelchannel] + [passwordpassword] +

+ +

Create a Wi-Fi hotspot. The command creates a hotspot connection profile + according to Wi-Fi device capabilities and activates it on the device. The + hotspot is secured with WPA if device/driver supports that, otherwise WEP is + used. Use connection down or device + disconnect to stop the hotspot.

Parameters of the hotspot can be influenced by the optional + parameters:

- - + + - - + + - - + + - - + + - - + + - - + + -

`dev`	parent device this VLAN is on.	`ifname`	what Wi-Fi device is used.
`id`	VLAN ID in range 0-4095.	`con-name`	name of the created hotspot connection profile.
`flags`	flags.	`ssid`	SSID of the hotspot.
`ingress`	VLAN ingress priority mapping.	`band`	Wi-Fi band to use.
`egress`	VLAN egress priority mapping.	`channel`	Wi-Fi channel to use.
`mtu`	MTU.	`password`	+ password to use for the created hotspot. If not provided, nmcli will + generate a password. The password is either WPA pre-shared key or WEP + key. + Note that `--show-secrets` global option can be used to + print the hotspot password. It is useful especially when the password was + generated. +

+ + + +

+ wifi + rescan + [ifname ifname] + [ssid SSID...] +

+ +

Request that NetworkManager immediately re-scan for + available access points. NetworkManager scans Wi-Fi networks periodically, but + in some cases it can be useful to start scanning manually (e.g. after resuming + the computer). By using ssid, it is possible to scan for a + specific SSID, which is useful for APs with hidden SSIDs. You can provide + multiple ssid parameters in order to scan more + SSIDs.

This command does not show the APs, use nmcli device wifi list + for that.

- type bond - [ - mode - { active-backup | balance-xor | broadcast | 802.3ad | balance-tlb | balance-alb | num } - ] - [primary ifname] - [miimon num] - [downdelay num] - [updelay num] - [arp-interval num] - [arp-ip-target num] -

+ lldp + [ + list + [ifnameifname] + ] +

+ + + +

Display information about neighboring devices learned through the Link + Layer Discovery Protocol (LLDP). The ifname option can be + used to list neighbors only for a given interface. The protocol must be enabled + in the connection settings.

Secret Agent

nmcli agent { secret | polkit | all }

Run nmcli as a NetworkManager secret agent, or polkit agent.

- - + + - - + + - - + + + +

`mode`	bonding mode (default: `balance-rr`).	secret	Register nmcli as a NetworkManager secret agent and listen for secret + requests. You do usually not need this command, because nmcli can handle + secrets when connecting to networks. However, you may find the command useful + when you use another tool for activating connections and you do not have a + secret agent available (like nm-applet).
`primary`	primary interface name (for `active-backup` mode).	+ polkit +	Register nmcli as a polkit agent for the user session and listen for + authorization requests. You do not usually need this command, because nmcli can + handle polkit actions related to NetworkManager operations (when run with + `--ask`). However, you may find the command useful when you want + to run a simple text based polkit agent and you do not have an agent of a desktop + environment. Note that running this command makes nmcli handle all polkit requests, + not only NetworkManager related ones, because only one polkit agent can run for the + session.
`miimon`	miimon (default: `100`).	+ all +	Runs nmcli as both NetworkManager secret and a polkit agent.

Property Aliases

Apart from the property-value pairs, connection add, + connection modify and device modify also + accept short forms of some properties. They exist for convenience and compatiblity + with older versions of nmcli that could not accept the raw + properties.

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 mtu).

Table 1. Options for all connections

+++++ + + + + + + - - + + + - - + + + - - + + + - - + + + - -

Alias	Property	Note
`downdelay`	downdelay (default: `0`).	type	connection.type	This option also accepts values of `bond-slave`, +`team-slave` and `bridge-slave`. They create +`ethernet` connection profiles. Their use is discouraged in +favor of using a specific type with `master` option.
`updelay`	updelay (default: `0`).	con-name	connection.id	When not provided a default name is generated: <type>[-<ifname>][-<num>]).
`arp-interval`	ARP interval (default: `0`).	autoconnect	connection.autoconnect
`arp-ip-target`	ARP IP target.	ifname	connection.interface-name	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.

+ +master +connection.master +Value specified here will be canonicalized. +It can be prefixed with ifname/, uuid/ +or id/ to disambiguate it. -

- type bond-slave - [master master] -

+ + + + + +

slave-type

connection.slave-type

Table 2. PPPoE options

-- - - - - -

master

master bond interface name, or connection UUID or - ID of bond master connection profile. The value can be - prefixed with ifname/, - uuid/ or id/ to - disambiguate it.

- - -

- type team - [ - config - { file | JSON } - ] -

---- - - - - -

config

JSON configuration for team.

- - -

- type team-slave - [ - config - JSON - ] -

-- + + + + - - + + - - - - -

Alias	Property
`master`	master team interface name, or connection UUID or - ID of team master connection profile. The value can be - prefixed with `ifname/`, - `uuid/` or `id/`to - disambiguate it.	username	pppoe.username
`config`	JSON configuration for team.

+password +pppoe.password -

- type bridge - [ - stp - { yes | no } - ] - [priority num] - [forward-delay 2-30] - [hello-time 1-10] - [max-age 6-42] - [ageing-time 0-1000000] - [ - multicast-snooping - { yes | no } - ] - [mac addr] -

+ + + + +

service

pppoe.service

Table 3. Wired Ethernet options

-+ + + + + - - + + - - + + - - + + + +

Alias	Property
`stp`	controls whether Spanning Tree Protocol (STP) is enabled for this bridge - (default: `yes`).	mtu	wired.mtu
`priority`	sets STP priority (default: `128`).	mac	wired.mac-address
`forward-delay`	STP forwarding delay, in seconds (default: `15`).	cloned-mac	wired.cloned-mac-address

Table 4. Infiniband options

++++ + + + + + - - + + - - + + - - + + - - + + - - + + -

Alias	Property
`hello-time`	STP hello time, in seconds (default: `2`).	mtu	infiniband.mtu
`max-age`	STP maximum message age, in seconds (default: `20`).	mac	infiniband.mac-address
`ageing-time`	the Ethernet MAC address aging time, in seconds (default: `300`).	transport-mode	infiniband.transport-mode
`multicast-snooping`	controls whether IGMP snooping is enabled (default: `yes`).	parent	infiniband.parent
`mac`	MAC address of the bridge (note: this requires a recent kernel feature, - originally introduced in 3.15 upstream kernel).	p-key	infiniband.p-key

- - -

- type bridge-slave - [master master] - [priority num] - [path-cost 1-65535] - [ - hairpin - { yes | no } - ] -

Table 5. Wi-Fi options

-+ + + + + - - + + - - + + - - + + - - - - -

Alias	Property
`master`	master bridge interface name, or connection UUID - or ID of bridge master connection profile. The value - can be prefixed with `ifname/`, - `uuid/` or `id/` - to disambiguate it.	ssid	wireless.ssid
`priority`	STP priority of this slave (default: `32`).	mode	wireless.mode
`path-cost`	STP port cost for destinations via this slave (default: `100`).	mtu	wireless.mtu
`hairpin`	'hairpin mode' for the slave, which allows frames to be sent back out - through the slave the frame was received on (default: `yes`).

+mac +wireless.mac-address -

- type vpn - [type type] - [user username] -

+ + + + +

cloned-mac

wireless.cloned-mac-address

Table 6. WiMax options

-+ + + + + - - + + - - + + -

Alias	Property
`vpn-type`	VPN type.	nsp	wimax.network-name
`user`	VPN username.	mac	wimax.mac-address

- - -

- type olpc-mesh - ssid SSID - [channel 1-13] - [dhcp-anycast MAC] -

Table 7. GSM options

-+ + + + + - - + + - - + + - - + + -

Alias	Property
`ssid`	SSID.	apn	gsm.apn
`channel`	channel to use for the network.	user	gsm.username
`dhcp-anycast`	anycast DHCP MAC address used when requesting an IP address via DHCP.	password	gsm.password

- - -

- type adsl - username username - - protocol - { pppoa | pppoe | ipoatm } - - [password passwd] - [ - encapsulation - { vcmux | llc } - ] -

Table 8. CDMA options

-+ + + + + - - + + - - - - - - - - - - + + -

Alias	Property
`username`	ADSL user name.	user	cdma.username
`protocol`	ADSL protocol.
`password`	ADSL password.
`encapsulation`	ADSL encapsulation.	password	cdma.password

- - -

- type tun - - mode - { tun | tap } - - [owner UID] - [group GID] - [ - pi - { yes | no } - ] - [ - vnet-hdr - { yes | no } - ] - [ - multi-queue - { yes | no } - ] -

Table 9. Bluetooth options

-++ + + + + + - - - - - - - - - - + + + - - - - - - - - - - + + + -

Alias	Property	Note
`mode`	Mode for the device.
`owner`	UID of the owner.
`group`	GID of the group.	addr	bluetooth.bdaddr
`pi`	include packet information (~IFF_NO_PI flag).
`vnet-hdr`	send and receive large (i.e. GSO) packets and packets with partial - checksums (IFF_VNET_HDR flag).
`multi-queue`	multi-queue support for tun/tap device (IFF_MULTI_QUEUE flag).	bt-type	bluetooth.type	Apart from the usual `dun` and +`panu` 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.

- - -

- type ip-tunnel - - mode - { ipip | gre | sit | isatap | vti | ip6ip6 | ipip6 | ip6gre | vti6 | tun } - - remote addr - [local addr] - [dev device] -

Table 10. VLAN options

-+ + + + + - - + + - - + + - - + + - - - - -

Alias	Property
`mode`	tunnel mode.	dev	vlan.parent
`remote`	IPv4 or IPv6 address of the remote tunnel endpoint.	id	vlan.id
`local`	IPv4 or IPv6 address of the local tunnel endpoint.	flags	vlan.flags
`dev`	device to use for tunnel endpoint communication.

+ingress +vlan.ingress-priority-map -

- type macvlan - dev device - - mode - { vepa | bridge | private | passthru | source } - - [ - tap - { yes | no } - ] -

+ + + + +

egress

vlan.egress-priority-map

Table 11. Bonding options

-++ + + + + + - - - - - - - - - - - + + + + + + + + + + + -

Alias	Property	Note
`dev`	parent device this MACVLAN is on.
`mode`	MACVLAN mode, which specifies the communication mechanism between - multiple MACVLANs on the same lower device.
`tap`	controls the device type. If set to 'yes' a MACVTAP will be created - (default: `no`).
mode	bond.options	Setting each of these adds the option to `bond.options` property. +It's equivalent of using the `+bond.options 'option=value'` syntax.
primary
miimon
downdelay
updelay
arp-interval
arp-ip-target
lacp-rate

- - -

- type vxlan - id id - remote addr - [dev parent device (ifname or connection UUID)] - [local addr] - [source-port-min 0-65535] - [source-port-max 0-65535] - [destination-port 0-65535] -

Table 12. Team options

++++ + + + + + + + + +

Alias	Property
config	team.config

Table 13. Team port options

++++ + + + + + + + + +

Alias	Property
config	team-port.config

Table 14. Bridge options

-+ + + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - -

Alias	Property
`id`	VXLAN Network Identifer to use.	stp	bridge.stp
`remote`	unicast destination IP address or multicast IP address to join.	priority	bridge.priority
`dev`	device to use for tunnel endpoint communication.	forward-delay	bridge.forward-delay
`local`	source IP address.	hello-time	bridge.hello-time
`source-port-min`	minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.	max-age	bridge.max-age
`source-port-max`	maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.	ageing-time	bridge.ageing-time
`destination-port`	UDP destination port to communicate to the remote VXLAN tunnel endpoint.	multicast-snooping	bridge.multicast-snooping

+ +mac +bridge.mac-address -

ip4, gw4

IPv4 addresses.

+priority +bridge-port.priority -

ip6, gw6

IPv6 addresses.

+path-cost +bridge-port.path-cost -

--

If a -- argument is encountered, the rest of command - line is interpreted as property list in the same format as connection - modify command accepts. This makes it possible to adjust the - connection properties before it's added.

+hairpin +bridge-port.hairpin-mode

- - - -

- edit - { - [ id | uuid | path ] - ID... - | - [type type] - [con-name name] - } -

- -

Edit an existing connection or add a new one, using an interactive editor.

The existing connection is identified by its name, UUID or D-Bus path. If - ID is ambiguous, a keyword id, - uuid, or path can be used. See - connection show above for the description of the - ID-specifying keywords. Not providing an - ID means that a new connection will be added.

The interactive editor will guide you through the connection editing and - allow you to change connection parameters according to your needs by means of - a simple menu-driven interface. The editor indicates what settings and - properties can be modified and provides in-line help.

Available options:

+ +

Table 15. VPN options

-+ + + + + - - + + - - - - -

Alias	Property
`type`	type of the new connection; valid types are the same as for - connection add command.	vpn-type	vpn.service-type
`con-name`	name for the new connection. It can be changed later in the editor.

See also - nm-settings(5) for all NetworkManager settings and property names, and their - descriptions; and - nmcli-examples(7) - for sample editor sessions.

- - - -

- modify - [--temporary] - [ id | uuid | path ] - ID - - [+|-]setting.property - value - ... -

- -

Modify one or more properties in the connection profile.

The connection is identified by its name, UUID or D-Bus path. If - ID is ambiguous, a keyword id, - uuid or path can be used. See - nm-settings(5) for setting and property names, their descriptions and default - values. This command supports abbreviations for setting - and property provided they are unique. Empty - value ("") removes the property value (sets - the property to the default value). The provided value overwrites the existing - property value.

If you want to append an item to the existing value, use - + prefix for the property name. If you want to remove just - one item from container-type property, use - prefix for - the property name and specify a value or an zero-based index of the item to - remove (or option name for properties with named options) as - value. Of course, + and - - only have a real effect for multi-value (container) - properties like ipv4.dns, ipv4.addresses, - bond.options, etc.

- - - -

- clone - [--temporary] - [ id | uuid | path ] - ID... - new name -

- -

Clone a connection. The connection to be cloned is identified by its - name, UUID or D-Bus path. If ID is ambiguous, a keyword - id, uuid or path - can be used. See connection show above for the description - of the ID-specifying keywords. name is - the name of the new cloned connection. The new connection will be the exact - copy except the connection.id (name) and - connection.uuid (generated) properties.

The new connection profile will be saved as persistent unless - --temporary option is specified, in which case the new profile - won't exist after NetworkManager restart.

- - - -

- delete - [ id | uuid | path ] - ID... -

- -

Delete a configured connection. The connection to be deleted is - identified by its name, UUID or D-Bus path. If ID is ambiguous, a - keyword id, uuid or path can be used. - See connection show above for the description of - the ID-specifying keywords.

If --wait option is not specified, the default timeout will be 10 - seconds.

- - - -

- monitor - [ id | uuid | path ] - ID... -

- -

Monitor connection profile activity. This command prints a line whenever - the specified connection changes. The connection to be monitored is identified - by its name, UUID or D-Bus path. If ID is ambiguous, a keyword - id, uuid or path - can be used. See connection show above for the description of the - ID-specifying keywords.

Monitors all connection profiles in case none is specified. The command - terminates when all monitored connections disappear. If you want to monitor - connection creation consider using the global monitor with nmcli - monitor command.

- - - -

- reload -

Reload all connection files from disk. - NetworkManager does not monitor changes to connection - files by default. So you need to use this command in order to tell - NetworkManager to re-read the connection profiles from - disk when a change was made to them. However, the auto-loading feature can be - enabled and then NetworkManager will reload connection - files any time they change (monitor-connection-files=true in - NetworkManager.conf(5)). -

- - -

- load - filename... -

Load/reload one or more connection files from disk. Use this after - manually editing a connection file to ensure that - NetworkManager is aware of its latest state.

- - -

- import - [--temporary] - [type type] - [file file] -

- -

Import an external/foreign configuration as a NetworkManager connection - profile. The type of the input file is specified by type - option.

Only VPN configurations are supported at the moment. The configuration is - imported by NetworkManager VPN plugins. type values are - the same as for vpn-type option in nmcli - connection add. VPN configurations are imported by VPN plugins. - Therefore the proper VPN plugin has to be installed so that nmcli could import - the data.

The imported connection profile will be saved as persistent unless - --temporary option is specified, in which case the new profile - won't exist after NetworkManager restart.

- - - -

- export - [ id | uuid | path ] - ID - [file] -

- -

Export a connection.

Only VPN connections are supported at the moment. A proper VPN plugin has - to be installed so that nmcli could export a connection. If no - file is provided, the VPN configuration - data will be printed to standard output.

- +user +vpn.user-name

Device Management Commands

nmcli device { status | show | set | connect | reapply | disconnect | delete | monitor | wifi | lldp } [ARGUMENTS...]

Show and manage network interfaces.

Table 16. OLPC Mesh options

-+ + + + + - - + + - - + + - - + + - - - + +

Alias	Property
status	- Print status of devices. - This is the default action if no command is specified to - nmcli device. -	ssid	olpc-mesh.ssid
- show - [`ifname`] -	Show detailed information about devices. Without an argument, all - devices are examined. To get information for a specific device, the interface - name has to be provided.	channel	olpc-mesh.channel
- set - [ifname] - `ifname` - [ - `autoconnect` - { yes \| no } - ] - [ - `managed` - { yes \| no } - ] -	Set device properties.	dhcp-anycast	olpc-mesh.dhcp-anycast-address
- connect - [`ifname`] -	- Connect the device. NetworkManager will try to find a suitable connection - that will be activated. It will also consider connections that are not set to - auto connect. - If `--wait` option is not specified, the default timeout will be 90 - seconds. -

Table 17. ADSL options

++++ + + + + + + + + - - + + - - + + - - + + + +

Alias	Property
username	adsl.username
- reapply - [`ifname`] -	Attempt to update device with changes to the currently active connection - made since it was last applied.	protocol	adsl.protocol
- disconnect - [`ifname`...] -	- Disconnect a device and prevent the device from automatically activating - further connections without user/manual intervention. Note that disconnecting - software devices may mean that the devices will disappear. - If `--wait` option is not specified, the default timeout - will be 10 seconds. -	password	adsl.password
- delete - [`ifname`...] -	- Delete a device. The command removes the interface from the system. Note - that this only works for software devices like bonds, bridges, teams, etc. - Hardware devices (like Ethernet) cannot be deleted by the command. - If `--wait` option is not specified, the default timeout will be 10 - seconds. -	encapsulation	adsl.encapsulation

Table 18. MACVLAN options

++++ + + + + + - - + + - - + + - - - - - - + +

Table 21. IP tunneling options

Alias Property

- monitor - [ifname...] -

Monitor device activity. This command prints a line whenever the - specified devices change state.

Monitors all devices in case no interface is specified. The monitor - terminates when all specified devices disappear. If you want to monitor device - addition consider using the global monitor with nmcli - monitor command.

dev

macvlan.parent

- wifi - [ - list - [ifname ifname] - [bssid BSSID] - ] -

List available Wi-Fi access points. The ifname and - bssid options can be used to list APs for a particular - interface or with a specific BSSID, respectively.

mode

macvlan.mode

- wifi - connect - (B)SSID - [password password] - [ - wep-key-type - { key | phrase } - ] - [ifname ifname] - [bssid BSSID] - [name name] - [ - private - { yes | no } - ] - [ - hidden - { yes | no } - ] -

Connect to a Wi-Fi network specified by SSID or BSSID. The command - creates a new connection and then activates it on a device. This is a - command-line counterpart of clicking an SSID in a GUI client. The command - always creates a new connection and thus it is mainly useful for connecting to - new Wi-Fi networks. If a connection for the network already exists, it is - better to bring up (activate) the existing connection as follows: - nmcli con up id name. Note that - only open, WEP and WPA-PSK networks are supported at the moment. It is also - supposed that IP configuration is obtained via DHCP.

If --wait option is not specified, the default timeout will be 90 - seconds.

Available options are:

+ + + + +

tap	macvlan.tap

+ +

Table 19. VxLAN options

-+ + + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +

Alias	Property
`password`	password for secured networks (WEP or WPA).	id	vxlan.id
`wep-key-type`	type of WEP secret, either `key` for ASCII/HEX key or - `phrase` for passphrase.	remote	vxlan.remote
`ifname`	interface that will be used for activation.	dev	vxlan.parent
`bssid`	if specified, the created connection will be restricted just for the - BSSID.	local	vxlan.local
`name`	if specified, the connection will use the name (else NM creates a name - itself).	source-port-min	vxlan.source-port-min
`private`	if set to `yes`, the connection will only be visible - to the user who created it. Otherwise the connection is system-wide, which is - the default.	source-port-max	vxlan.source-port-max
`hidden`	set to `yes` when connecting for the first time to an - AP not broadcasting its SSID. Otherwise the SSID would not be found and the - connection attempt would fail.	destination-port	vxlan.destination-port

- wifi - hotspot - [ifname ifname] - [con-name name] - [ssid SSID] - [ - band - { a | bg } - ] - [channel channel] - [password password] -

Create a Wi-Fi hotspot. The command creates a hotspot connection profile - according to Wi-Fi device capabilities and activates it on the device. The - hotspot is secured with WPA if device/driver supports that, otherwise WEP is - used. Use connection down or device - disconnect to stop the hotspot.

Parameters of the hotspot can be influenced by the optional - parameters:

+ +

Table 20. Tun options

-+ + + + + - - + + - - + + - - + + - - + + - - + + - - + +

Alias	Property
`ifname`	what Wi-Fi device is used.	mode	tun.mode
`con-name`	name of the created hotspot connection profile.	owner	tun.owner
`ssid`	SSID of the hotspot.	group	tun.group
`band`	Wi-Fi band to use.	pi	tun.pi
`channel`	Wi-Fi channel to use.	vnet-hdr	tun.vnet-hdr
`password`	- password to use for the created hotspot. If not provided, nmcli will - generate a password. The password is either WPA pre-shared key or WEP - key. - Note that `--show-secrets` global option can be used to - print the hotspot password. It is useful especially when the password was - generated. -	multi-queue	tun.multi-queue

++++ + + + + + + + + - - + + - - + + + + + +

Alias	Property
mode	ip-tunnel.mode
- wifi - rescan - [`ifname` `ifname`] - [`ssid` `SSID`...] -	- Request that NetworkManager immediately re-scan for - available access points. NetworkManager scans Wi-Fi networks periodically, but - in some cases it can be useful to start scanning manually (e.g. after resuming - the computer). By using `ssid`, it is possible to scan for a - specific SSID, which is useful for APs with hidden SSIDs. You can provide - multiple `ssid` parameters in order to scan more - SSIDs. - This command does not show the APs, use nmcli device wifi list - for that. -	local	ip-tunnel.local
- lldp - [ - list - [`ifname` `ifname`] - ] -	Display information about neighboring devices learned through the Link - Layer Discovery Protocol (LLDP). The `ifname` option can be - used to list neighbors only for a given interface. The protocol must be enabled - in the connection settings.	remote	ip-tunnel.remote
dev	ip-tunnel.parent

Secret Agent

nmcli agent { secret | polkit | all }

Run nmcli as a NetworkManager secret agent, or polkit agent.

Table 22. IPv4 options

-++ + + + + + - - + + + - - + + + + + +

Alias	Property	Note
secret	Register nmcli as a NetworkManager secret agent and listen for secret - requests. You do usually not need this command, because nmcli can handle - secrets when connecting to networks. However, you may find the command useful - when you use another tool for activating connections and you do not have a - secret agent available (like nm-applet).	ip4	ipv4.addresses	This option can be specified multiple times. +It's equivalent of using `+ipv4.addresses` syntax.
- polkit -	Register nmcli as a polkit agent for the user session and listen for - authorization requests. You do not usually need this command, because nmcli can - handle polkit actions related to NetworkManager operations (when run with - `--ask`). However, you may find the command useful when you want - to run a simple text based polkit agent and you do not have an agent of a desktop - environment. Note that running this command makes nmcli handle all polkit requests, - not only NetworkManager related ones, because only one polkit agent can run for the - session.	gw4	ipv4.gateway

Table 23. IPv6 options

+++++ + + + + + + + + + + - - + + +

Alias	Property	Note
ip6	ipv6.addresses	This option can be specified multiple times. +It's equivalent of using `+ipv6.addresses` syntax.
- all -	Runs nmcli as both NetworkManager secret and a polkit agent.	gw6	ipv6.gateway

+
+

Environment Variables

nmcli's behavior is affected by the following @@ -2069,6 +2012,10 @@

Connection, device, or access point does not exist.

+ +

When used with --complete-args option, a file name is expected to follow.

@@ -2076,7 +2023,7 @@

Examples

This section presents various examples of nmcli usage. If you want even more, please refer to - nmcli-examples(7) + nmcli-examples(7) manual page.

@@ -2183,6 +2130,16 @@ the user should use to connect to the hotspot from other devices.

+ + + + + + + + - + @@ -2255,16 +2212,16 @@

`nmcli dev modify em1 ipv4.method shared`	starts IPv4 connection sharing using em1 device. The sharing will be active + until the device is disconnected.
`nmcli dev modify em1 ipv6.address 2001:db8::a:bad:c0de`	temporarily adds an IP address to a device. The address will be removed + when the same connection is activated again.
`nmcli connection add type ethernet autoconnect no ifname eth0`	non-interactively adds an Ethernet connection tied to eth0 interface with automatic IP configuration (DHCP), and disables the connection's `autoconnect` @@ -2194,7 +2151,7 @@ use eth0 and the VLAN interface will be named Maxipes-fik.
`nmcli c a ifname eth0 type ethernet -- ipv4.method disabled ipv6.method link-local`	`nmcli c a ifname eth0 type ethernet ipv4.method disabled ipv6.method link-local`	non-interactively adds a connection that will use eth0 Ethernet interface and only have an IPv6 link-local address configured.

Connection Management Commands

Device Management Commands

Secret Agent

Property Aliases

Device Management Commands

Secret Agent

Environment Variables

Examples

See Also