From a54ac63bbf9b2c71026ac9028a8ffaf186cf3c82 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 28 Jun 2020 18:58:14 +0200 Subject: New upstream version 1.25.90 --- docs/api/html/nmcli.html | 894 +---------------------------------------------- 1 file changed, 12 insertions(+), 882 deletions(-) (limited to 'docs/api/html/nmcli.html') diff --git a/docs/api/html/nmcli.html b/docs/api/html/nmcli.html index 9c5099e0..9f808e66 100644 --- a/docs/api/html/nmcli.html +++ b/docs/api/html/nmcli.html @@ -483,7 +483,7 @@

You can also specify particular fields. For static configuration, use setting and property names as described in - nm-settings(5) manual page. For active data use GENERAL, IP4, DHCP4, IP6, + nm-settings-nmcli(5) manual page. For active data use GENERAL, IP4, DHCP4, IP6, DHCP6, VPN.

When no command is given to the nmcli connection, the default action is nmcli connection show.

@@ -608,9 +608,9 @@

To set the property just specify the property name followed by the value. An empty value ("") resets the property value to the default.

-

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

+

See nm-settings-nmcli(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.

If you want to append an item or a flag to the existing value, use + prefix for the property name or alias. If you want to remove items from a container-type or flag property, use - prefix. @@ -621,9 +621,6 @@ These are for example multi-value (container) properties or flags like ipv4.dns, ip4, ipv4.addresses, bond.options, 802-1x.phase1-auth-flags 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.

@@ -650,8 +647,7 @@

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 + See nm-settings-nmcli(5) for the complete reference. 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) @@ -745,7 +741,7 @@

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

@@ -948,11 +944,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.

-

See nm-settings(5) for the list of available properties. Please note that some +

See nm-settings-nmcli(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.

@@ -1242,871 +1235,6 @@
-

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. Some aliases can - affect multiple connection properties at once.

-

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

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AliasPropertyNote
typeconnection.typeThis alias 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.
con-nameconnection.idWhen not provided a default name is generated: <type>[-<ifname>][-<num>]).
autoconnectconnection.autoconnect 
ifnameconnection.interface-nameA 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.
masterconnection.masterValue specified here will be canonicalized. -It can be prefixed with ifname/, uuid/ -or id/ to disambiguate it.
slave-typeconnection.slave-type 
-
-
-

Table 2. PPPoE options

-
---- - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
usernamepppoe.username
passwordpppoe.password
servicepppoe.service
parentpppoe.parent
-
-
-

Table 3. Wired Ethernet options

-
---- - - - - - - - - - - - - - - - - - - -
AliasProperty
mtuwired.mtu
macwired.mac-address
cloned-macwired.cloned-mac-address
-
-
-

Table 4. Infiniband options

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
mtuinfiniband.mtu
macinfiniband.mac-address
transport-modeinfiniband.transport-mode
parentinfiniband.parent
p-keyinfiniband.p-key
-
-
-

Table 5. Wi-Fi options

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
ssidwireless.ssid
modewireless.mode
mtuwireless.mtu
macwireless.mac-address
cloned-macwireless.cloned-mac-address
-
-
-

Table 6. WiMax options

-
---- - - - - - - - - - - - - - - -
AliasProperty
nspwimax.network-name
macwimax.mac-address
-
-
-

Table 7. GSM options

-
---- - - - - - - - - - - - - - - - - - - -
AliasProperty
apngsm.apn
usergsm.username
passwordgsm.password
-
-
-

Table 8. CDMA options

-
---- - - - - - - - - - - - - - - -
AliasProperty
usercdma.username
passwordcdma.password
-
-
-

Table 9. Bluetooth options

-
----- - - - - - - - - - - - - - - - - - -
AliasPropertyNote
addrbluetooth.bdaddr 
bt-typebluetooth.typeApart 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.
-
-
-

Table 10. VLAN options

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
devvlan.parent
idvlan.id
flagsvlan.flags
ingressvlan.ingress-priority-map
egressvlan.egress-priority-map
-
-
-

Table 11. Bonding options

-
----- - - - - - - - - - - - - - - - - - - - -
AliasPropertyNote
modebond.optionsSetting each of these adds the option to bond.options property. -It's equivalent to the +bond.options 'option=value' syntax.
primary
miimon
downdelay
updelay
arp-interval
arp-ip-target
lacp-rate
-
-
-

Table 12. Team options

-
----- - - - - - - - - - - -
AliasPropertyNote
configteam.configEither a filename or a team configuration in JSON format. To enforce one or the other, the value can be prefixed with "file://" or "json://".
-
-
-

Table 13. Team port options

-
----- - - - - - - - - - - -
AliasPropertyNote
configteam-port.configEither a filename or a team configuration in JSON format. To enforce one or the other, the value can be prefixed with "file://" or "json://".
-
-
-

Table 14. Bridge options

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
stpbridge.stp
prioritybridge.priority
forward-delaybridge.forward-delay
hello-timebridge.hello-time
max-agebridge.max-age
ageing-timebridge.ageing-time
group-forward-maskbridge.group-forward-mask
multicast-snoopingbridge.multicast-snooping
macbridge.mac-address
prioritybridge-port.priority
path-costbridge-port.path-cost
hairpinbridge-port.hairpin-mode
-
-
-

Table 15. VPN options

-
---- - - - - - - - - - - - - - - -
AliasProperty
vpn-typevpn.service-type
uservpn.user-name
-
-
-

Table 16. OLPC Mesh options

-
---- - - - - - - - - - - - - - - - - - - -
AliasProperty
ssidolpc-mesh.ssid
channelolpc-mesh.channel
dhcp-anycastolpc-mesh.dhcp-anycast-address
-
-
-

Table 17. ADSL options

-
---- - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
usernameadsl.username
protocoladsl.protocol
passwordadsl.password
encapsulationadsl.encapsulation
-
-
-

Table 18. MACVLAN options

-
---- - - - - - - - - - - - - - - - - - - -
AliasProperty
devmacvlan.parent
modemacvlan.mode
tapmacvlan.tap
-
-
-

Table 19. MACsec options

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
devmacsec.parent
modemacsec.mode
encryptmacsec.encrypt
cakmacsec.cak
cknmacsec.ckn
portmacsec.port
-
-
-

Table 20. VxLAN options

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
idvxlan.id
remotevxlan.remote
devvxlan.parent
localvxlan.local
source-port-minvxlan.source-port-min
source-port-maxvxlan.source-port-max
destination-portvxlan.destination-port
-
-
-

Table 21. Tun options

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
modetun.mode
ownertun.owner
grouptun.group
pitun.pi
vnet-hdrtun.vnet-hdr
multi-queuetun.multi-queue
-
-
-

Table 22. IP tunneling options

-
---- - - - - - - - - - - - - - - - - - - - - - - -
AliasProperty
modeip-tunnel.mode
localip-tunnel.local
remoteip-tunnel.remote
devip-tunnel.parent
-
-
-

Table 23. WPAN options

-
---- - - - - - - - - - - - - - - - - - - -
AliasProperty
macwpan.mac
short-addrwpan.short-addr
pan-idwpan.pan-id
-
-
-

Table 24. 6LoWPAN options

-
---- - - - - - - - - -
AliasProperty
dev6lowpan.parent
-
-
-

Table 25. IPv4 options

-
----- - - - - - - - - - - - - - - - - - -
AliasPropertyNote
ip4 -ipv4.addresses ipv4.method -The alias is equivalent to the +ipv4.addresses syntax and also sets ipv4.method to manual. It can be specified multiple times.
gw4ipv4.gateway 
-
-
-

Table 26. IPv6 options

-
----- - - - - - - - - - - - - - - - - - -
AliasPropertyNote
ip6 -ipv6.addresses ipv6.method -The alias is equivalent to the +ipv6.addresses syntax and also sets ipv6.method to manual. It can be specified multiple times.
gw6ipv6.gateway 
-
-
-

Table 27. Proxy options

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
AliasPropertyNote
methodproxy.method 
browser-onlyproxy.browser-only 
pac-urlproxy.pac-url 
pac-scriptproxy.pac-scriptRead 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.
-
-
-
-

Colors

Implicit coloring can be disabled by an empty file /etc/terminal-colors.d/nmcli.disable.

@@ -2561,14 +1689,16 @@ It's equivalent to the +bond.options 'option=value'

See Also

-

nmcli-examples(7), +

+ nmcli-examples(7), + nm-settings-nmcli(5), nm-online(1), NetworkManager(8), NetworkManager.conf(5), - nm-settings(5), nm-applet(1), nm-connection-editor(1), - terminal-colors.d(5).

+ terminal-colors.d(5). +

-- cgit 1.3.0-6-gf8a5