nm-online: NetworkManager D-Bus API Reference Manual

The generic family of access technologies the modem supports. Not all capabilities are available at the same time however; some modems require a firmware reload or other reinitialization to switch between eg CDMA/EVDO and GSM/UMTS.

The generic family of access technologies the modem supports. Not all + capabilities are available at the same time however; some modems require a + firmware reload or other reinitialization to switch between eg CDMA/EVDO + and GSM/UMTS. +

Operating-system specific transient device hardware identifier. This is an opaque string representing the underlying hardware for the device, and shouldn't be used to keep track of individual devices. For some device types (Bluetooth, Modems) it is an identifier used by the hardware service (ie bluez or ModemManager) to refer to that device, and client programs use it get additional information from those services which NM does not provide. The Udi is not guaranteed to be consistent across reboots or hotplugs of the hardware. If you're looking for a way to uniquely track each device in your application, use the object path. If you're looking for a way to track a specific piece of hardware across reboot or hotplug, use a MAC address or USB serial number.

Operating-system specific transient device hardware identifier. This is an + opaque string representing the underlying hardware for the device, and + shouldn't be used to keep track of individual devices. For some device + types (Bluetooth, Modems) it is an identifier used by the hardware service + (ie bluez or ModemManager) to refer to that device, and client programs + use it get additional information from those services which NM does not + provide. The Udi is not guaranteed to be consistent across reboots or + hotplugs of the hardware. If you're looking for a way to uniquely track + each device in your application, use the object path. If you're looking + for a way to track a specific piece of hardware across reboot or hotplug, + use a MAC address or USB serial number. +

Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each array are in network byte order. Essentially: [(addr, prefix, gateway), (addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway

Array of arrays of IPv4 address/prefix/gateway. All 3 elements of each + array are in network byte order. Essentially: [(addr, prefix, gateway), + (addr, prefix, gateway), ...] Deprecated: use AddressData and Gateway +

Array of tuples of IPv6 address/prefix/gateway. Deprecated: use AddressData and Gateway.

Array of tuples of IPv6 address/prefix/gateway. Deprecated: use + AddressData and Gateway. +

Method Details

The `NeedSecrets()` method

The NeedSecrets() method

 NeedSecrets (OUT s username,
              OUT s password);
@@ -73,7 +73,7 @@ NeedSecrets (OUT s username,

The `SetIp4Config()` method

The SetIp4Config() method

 SetIp4Config (IN  a{sv} config);

@@ -91,7 +91,7 @@ SetIp4Config (IN a{sv} config);

The `SetIp6Config()` method

The SetIp6Config() method

 SetIp6Config (IN  a{sv} config);

@@ -109,7 +109,7 @@ SetIp6Config (IN a{sv} config);

The `SetState()` method

The SetState() method

 SetState (IN  u state);

diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html index d160c1a1..7899f99b 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.SecretAgent.html @@ -50,12 +50,21 @@

Description

Private D-Bus interface used by secret agents that store and provide secrets to NetworkManager. If an agent provides secrets to NetworkManager as part of connection creation, and the some of those secrets are "agent owned" the agent should store those secrets itself and should not expect its SaveSecrets() method to be called. SaveSecrets() will be called eg if some program other than the agent itself (like a connection editor) changes the secrets out of band. The agent should implement this D-Bus interface on an object with the path /org/freedesktop/NetworkManager/SecretAgent.

Private D-Bus interface used by secret agents that store and provide + secrets to NetworkManager. If an agent provides secrets to NetworkManager + as part of connection creation, and the some of those secrets are "agent + owned" the agent should store those secrets itself and should not expect + its SaveSecrets() method to be called. SaveSecrets() will be called eg if + some program other than the agent itself (like a connection editor) + changes the secrets out of band. The agent should implement this D-Bus + interface on an object with the path + /org/freedesktop/NetworkManager/SecretAgent. +

Method Details

The `GetSecrets()` method

The GetSecrets() method

 GetSecrets (IN  a{sa{sv}} connection,
             IN  o         connection_path,
@@ -64,7 +73,14 @@ GetSecrets (IN  a{sa{sv}} connection,
             IN  u         flags,
             OUT a{sa{sv}} secrets);

Retrieve and return stored secrets, if any, or request new secrets from the agent's user. If user interaction is allowed and the user enters new secrets, the agent is expected to save the new secrets to persistent storage (if the secret's flags include AGENT_OWNED) as NetworkManager will not send these secrets back to the same agent via a SaveSecrets() call. If the user canceled any interaction, the agent should return the UserCanceled error (see below).

Retrieve and return stored secrets, if any, or request new secrets from + the agent's user. If user interaction is allowed and the user enters new + secrets, the agent is expected to save the new secrets to persistent + storage (if the secret's flags include AGENT_OWNED) as NetworkManager will + not send these secrets back to the same agent via a SaveSecrets() call. If + the user canceled any interaction, the agent should return the + UserCanceled error (see below). +

@@ -73,11 +89,11 @@ GetSecrets (IN a{sa{sv}} connection, - + - + @@ -85,27 +101,30 @@ GetSecrets (IN a{sa{sv}} connection, - + - + - +

`IN a{sa{sv}} connection`:	Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction.	Nested settings maps containing the connection for which secrets are being requested. This may contain system-owned secrets if the agent has successfully authenticated to modify system network settings and the GetSecrets request flags allow user interaction.
`IN o connection_path`:	Object path of the connection for which secrets are being requested.	Object path of the connection for which secrets are being requested.
`IN s setting_name`:
`IN as hints`:	Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:".	Array of strings of key names in the requested setting for which NetworkManager thinks a secrets may be required, and/or well-known identifiers and data that may be useful to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends in this request. Some hints have special prefixes that provide information to the agent; for example, VPN requests may send server-specific messages prefixed with "x-vpn-message:".
`IN u flags`:	Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user.	(NMSecretAgentGetSecretsFlags) Flags which modify the behavior of the secrets request. If true, new secrets are assumed to be invalid or incorrect, and the agent should ask the user for new secrets. If false, existing secrets should be retrieved from storage and returned without interrupting the user.
`OUT a{sa{sv}} secrets`:	Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets.	Nested settings maps containing secrets. Each setting MUST contain at least the 'name' field, containing the name of the setting, and one or more secrets.

The `CancelGetSecrets()` method

The CancelGetSecrets() method

 CancelGetSecrets (IN  o connection_path,
                   IN  s setting_name);

Cancel a pending GetSecrets request for secrets of the given connection. Any GetSecrets request with the same 'connection_path' and 'setting_name' that are given in a CancelGetSecrets request should be canceled.

Cancel a pending GetSecrets request for secrets of the given connection. + Any GetSecrets request with the same 'connection_path' and 'setting_name' + that are given in a CancelGetSecrets request should be canceled. +

@@ -114,23 +133,24 @@ CancelGetSecrets (IN o connection_path, - + - +

`IN o connection_path`:	Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled.	Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled.
`IN s setting_name`:	Setting name for which secrets for this connection were originally being requested.	Setting name for which secrets for this connection were originally being requested.

The `SaveSecrets()` method

The SaveSecrets() method

 SaveSecrets (IN  a{sa{sv}} connection,
              IN  o         connection_path);

Save given secrets to backing storage.

Save given secrets to backing storage. +

@@ -139,23 +159,24 @@ SaveSecrets (IN a{sa{sv}} connection, - + - +

`IN a{sa{sv}} connection`:	Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already.	Nested settings maps containing the entire connection (including secrets), for which the agent should save the secrets to backing storage. This method will not be called when the agent itself is the process creating or updating a connection; in that case the agent is assumed to have already saved those secrets since it had them already.
`IN o connection_path`:	Object path of the connection for which the agent should save secrets to backing storage.	Object path of the connection for which the agent should save secrets to backing storage.

The `DeleteSecrets()` method

The DeleteSecrets() method

 DeleteSecrets (IN  a{sa{sv}} connection,
                IN  o         connection_path);

Delete secrets from backing storage.

Delete secrets from backing storage. +

@@ -164,11 +185,11 @@ DeleteSecrets (IN a{sa{sv}} connection, - + - +

`IN a{sa{sv}} connection`:	Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage.	Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage.
`IN o connection_path`:	Object path of the connection for which the agent should delete secrets from backing storage.	Object path of the connection for which the agent should delete secrets from backing storage.

diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html index db2a7d57..b985416f 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html @@ -62,16 +62,22 @@

Description

Represents a single network connection configuration.

Represents a single network connection configuration. +

Method Details

The `Update()` method

The Update() method

 Update (IN  a{sa{sv}} properties);

Update the connection with new settings and properties (replacing all previous settings and properties) and save the connection to disk. Secrets may be part of the update request, and will be either stored in persistent storage or sent to a Secret Agent for storage, depending on the flags associated with each secret.

Update the connection with new settings and properties (replacing all + previous settings and properties) and save the connection to disk. Secrets + may be part of the update request, and will be either stored in persistent + storage or sent to a Secret Agent for storage, depending on the flags + associated with each secret. +

@@ -85,11 +91,19 @@ Update (IN a{sa{sv}} properties);

The `UpdateUnsaved()` method

The UpdateUnsaved() method

 UpdateUnsaved (IN  a{sa{sv}} properties);

Update the connection with new settings and properties (replacing all previous settings and properties) but do not immediately save the connection to disk. Secrets may be part of the update request and may sent to a Secret Agent for storage, depending on the flags associated with each secret. Use the 'Save' method to save these changes to disk. Note that unsaved changes will be lost if the connection is reloaded from disk (either automatically on file change or due to an explicit ReloadConnections call).

Update the connection with new settings and properties (replacing all + previous settings and properties) but do not immediately save the + connection to disk. Secrets may be part of the update request and may sent + to a Secret Agent for storage, depending on the flags associated with each + secret. Use the 'Save' method to save these changes to disk. Note that + unsaved changes will be lost if the connection is reloaded from disk + (either automatically on file change or due to an explicit + ReloadConnections call). +

@@ -103,19 +117,24 @@ UpdateUnsaved (IN a{sa{sv}} properties);

The `Delete()` method

The Delete() method

 Delete ();

Delete the connection.

Delete the connection. +

The `GetSettings()` method

The GetSettings() method

 GetSettings (OUT a{sa{sv}} settings);

Get the settings maps describing this network configuration. This will never include any secrets required for connection to the network, as those are often protected. Secrets must be requested separately using the GetSecrets() call.

Get the settings maps describing this network configuration. This will + never include any secrets required for connection to the network, as those + are often protected. Secrets must be requested separately using the + GetSecrets() call. +

@@ -129,12 +148,16 @@ GetSettings (OUT a{sa{sv}} settings);

The `GetSecrets()` method

The GetSecrets() method

 GetSecrets (IN  s         setting_name,
             OUT a{sa{sv}} secrets);

Get the secrets belonging to this network configuration. Only secrets from persistent storage or a Secret Agent running in the requestor's session will be returned. The user will never be prompted for secrets as a result of this request.

Get the secrets belonging to this network configuration. Only secrets from + persistent storage or a Secret Agent running in the requestor's session + will be returned. The user will never be prompted for secrets as a result + of this request. +

@@ -143,7 +166,7 @@ GetSecrets (IN s setting_name, - + @@ -154,19 +177,22 @@ GetSecrets (IN s setting_name,

The `ClearSecrets()` method

The ClearSecrets() method

 ClearSecrets ();

Clear the secrets belonging to this network connection profile.

Clear the secrets belonging to this network connection profile. +

The `Save()` method

The Save() method

 Save ();

Saves a "dirty" connection (that had previously been updated with UpdateUnsaved) to persistent storage.

Saves a "dirty" connection (that had previously been updated with + UpdateUnsaved) to persistent storage. +

@@ -176,7 +202,11 @@ Save ();

 Updated ();

Emitted when any settings or permissions change. When handling this signal, clients should re-read the connection using the GetSettings method to get the changes and to ensure the client still has permission to access the connection.

Emitted when any settings or permissions change. When handling this + signal, clients should re-read the connection using the GetSettings method + to get the changes and to ensure the client still has permission to access + the connection. +

@@ -184,7 +214,11 @@ Updated ();

 Removed ();

Emitted when this connection is no longer available. This happens when the connection is deleted or if it is no longer accessible by any of the system's logged-in users. After receipt of this signal, the object no longer exists. Also see the Settings.ConnectionRemoved signal.

Emitted when this connection is no longer available. This happens when the + connection is deleted or if it is no longer accessible by any of the + system's logged-in users. After receipt of this signal, the object no + longer exists. Also see the Settings.ConnectionRemoved signal. +

@@ -212,7 +246,11 @@ PropertiesChanged (a{sv} properties);

 Unsaved  readable   b

If set, indicates that the in-memory state of the connection does not match the on-disk state. This flag will be set when UpdateUnsaved() is called or when any connection details change, and cleared when the connection is saved to disk via Save() or from internal operations.

If set, indicates that the in-memory state of the connection does not + match the on-disk state. This flag will be set when UpdateUnsaved() is + called or when any connection details change, and cleared when the + connection is saved to disk via Save() or from internal operations. +

diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html index d4b243dc..e2064236 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html @@ -68,16 +68,19 @@

Description

The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.

The Settings interface allows clients to view and administrate the + connections stored and used by NetworkManager. +

Method Details

The `ListConnections()` method

The ListConnections() method

 ListConnections (OUT ao connections);

List the saved network connections known to NetworkManager.

List the saved network connections known to NetworkManager. +

`IN s setting_name`:	Name of the setting to return secrets for. If empty, all all secrets will be returned.	Name of the setting to return secrets for. If empty, all all secrets will be returned.
`OUT a{sa{sv}} secrets`:

@@ -91,12 +94,13 @@ ListConnections (OUT ao connections);

The `GetConnectionByUuid()` method

The GetConnectionByUuid() method

 GetConnectionByUuid (IN  s uuid,
                      OUT o connection);

Retrieve the object path of a connection, given that connection's UUID.

Retrieve the object path of a connection, given that connection's UUID. +

@@ -116,12 +120,16 @@ GetConnectionByUuid (IN s uuid,

The `AddConnection()` method

The AddConnection() method

 AddConnection (IN  a{sa{sv}} connection,
                OUT o         path);

Add new connection and save it to disk. This operation does not start the network connection unless (1) device is idle and able to connect to the network described by the new connection, and (2) the connection is allowed to be started automatically.

Add new connection and save it to disk. This operation does not start the + network connection unless (1) device is idle and able to connect to the + network described by the new connection, and (2) the connection is allowed + to be started automatically. +

@@ -141,12 +149,19 @@ AddConnection (IN a{sa{sv}} connection,

The `AddConnectionUnsaved()` method

The AddConnectionUnsaved() method

 AddConnectionUnsaved (IN  a{sa{sv}} connection,
                       OUT o         path);

Add new connection but do not save it to disk immediately. This operation does not start the network connection unless (1) device is idle and able to connect to the network described by the new connection, and (2) the connection is allowed to be started automatically. Use the 'Save' method on the connection to save these changes to disk. Note that unsaved changes will be lost if the connection is reloaded from disk (either automatically on file change or due to an explicit ReloadConnections call).

Add new connection but do not save it to disk immediately. This operation + does not start the network connection unless (1) device is idle and able + to connect to the network described by the new connection, and (2) the + connection is allowed to be started automatically. Use the 'Save' method + on the connection to save these changes to disk. Note that unsaved changes + will be lost if the connection is reloaded from disk (either automatically + on file change or due to an explicit ReloadConnections call). +

@@ -166,13 +181,19 @@ AddConnectionUnsaved (IN a{sa{sv}} connection,

The `LoadConnections()` method

The LoadConnections() method

 LoadConnections (IN  as filenames,
                  OUT b  status,
                  OUT as failures);

Loads or reloads the indicated connections from disk. You should call this after making changes directly to an on-disk connection file to make sure that NetworkManager sees the changes. (If "monitor-connection-files" in NetworkManager.conf is "true", then this will have no real effect, but is harmless.) As with AddConnection(), this operation does not necessarily start the network connection.

Loads or reloads the indicated connections from disk. You should call this + after making changes directly to an on-disk connection file to make sure + that NetworkManager sees the changes. (If "monitor-connection-files" in + NetworkManager.conf is "true", then this will have no real effect, but is + harmless.) As with AddConnection(), this operation does not necessarily + start the network connection. +

@@ -181,11 +202,11 @@ LoadConnections (IN as filenames, - + - + @@ -196,11 +217,16 @@ LoadConnections (IN as filenames,

The `ReloadConnections()` method

The ReloadConnections() method

 ReloadConnections (OUT b status);

Tells NetworkManager to reload all connection files from disk, including noticing any added or deleted connection files. By default, connections are re-read automatically any time they change, so you only need to use this command if you have set "monitor-connection-files=false" in NetworkManager.conf.

Tells NetworkManager to reload all connection files from disk, including + noticing any added or deleted connection files. By default, connections + are re-read automatically any time they change, so you only need to use + this command if you have set "monitor-connection-files=false" in + NetworkManager.conf. +

`IN as filenames`:	Array of paths to on-disk connection profiles in directories monitored by NetworkManager.	Array of paths to on-disk connection profiles in directories monitored by NetworkManager.
`OUT b status`:	Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied).	Success or failure of the operation as a whole. True if NetworkManager at least tried to load the indicated connections, even if it did not succeed. False if an error occurred before trying to load the connections (eg, permission denied).
`OUT as failures`:

@@ -214,11 +240,12 @@ ReloadConnections (OUT b status);

The `SaveHostname()` method

The SaveHostname() method

 SaveHostname (IN  s hostname);

Save the hostname to persistent configuration.

Save the hostname to persistent configuration. +

@@ -226,7 +253,7 @@ SaveHostname (IN s hostname); - +

IN s hostname:

The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.

@@ -256,7 +283,15 @@ PropertiesChanged (a{sv} properties);

 NewConnection (o connection);

Emitted when a new connection has been added after NetworkManager has started up and initialized. This signal is not emitted for connections read while starting up, because NetworkManager's D-Bus service is only available after all connections have been read, and to prevent spamming listeners with too many signals at one time. To retrieve the initial connection list, call the ListConnections() method once, and then listen for individual Settings.NewConnection and Settings.Connection.Deleted signals for further updates.

Emitted when a new connection has been added after NetworkManager has + started up and initialized. This signal is not emitted for connections + read while starting up, because NetworkManager's D-Bus service is only + available after all connections have been read, and to prevent spamming + listeners with too many signals at one time. To retrieve the initial + connection list, call the ListConnections() method once, and then listen + for individual Settings.NewConnection and Settings.Connection.Deleted + signals for further updates. +

@@ -274,7 +309,12 @@ NewConnection (o connection);

 ConnectionRemoved (o connection);

Emitted when a connection is no longer available. This happens when the connection is deleted or if it is no longer accessible by any of the system's logged-in users. After receipt of this signal, the connection no longer exists and cannot be used. Also see the Settings.Connection.Removed signal.

Emitted when a connection is no longer available. This happens when the + connection is deleted or if it is no longer accessible by any of the + system's logged-in users. After receipt of this signal, the connection no + longer exists and cannot be used. Also see the Settings.Connection.Removed + signal. +

@@ -294,7 +334,8 @@ ConnectionRemoved (o connection);

 Connections  readable   ao

List of object paths of available network connection profiles.

List of object paths of available network connection profiles. +

@@ -302,7 +343,8 @@ Connections readable ao

 Hostname  readable   s

The machine hostname stored in persistent configuration.

The machine hostname stored in persistent configuration. +

@@ -310,7 +352,8 @@ Hostname readable s

 CanModify  readable   b

If true, adding and modifying connections is supported.

If true, adding and modifying connections is supported. +

diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html index ea6bd031..331d3a5e 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Connection.html @@ -50,7 +50,8 @@

Description

Represents an active connection to a Virtual Private Network.

Represents an active connection to a Virtual Private Network. +

Signal Details

@@ -78,7 +79,8 @@ PropertiesChanged (a{sv} properties); VpnStateChanged (u state, u reason); -

Emitted when the state of the VPN connection has changed.

Emitted when the state of the VPN connection has changed. +

@@ -87,11 +89,11 @@ VpnStateChanged (u state, - + - +

`u state`:	The new state of the VPN connection.	(NMVpnConnectionState) The new state of the VPN connection.
`u reason`:	Reason code describing the change to the new state.	(NMVpnConnectionStateReason) Reason code describing the change to the new state.

@@ -104,7 +106,10 @@ VpnStateChanged (u state,

 VpnState  readable   u

The VPN-specific state of the connection.

The VPN-specific state of the connection. +

Returns: NMVpnConnectionState +

@@ -112,7 +117,8 @@ VpnState readable u

 Banner  readable   s

The banner string of the VPN connection.

The banner string of the VPN connection. +

Version 1.1.92 +

Version 1.1.93

@@ -156,6 +156,15 @@

UNIX Manual Pages

+nmcli — command-line tool for controlling NetworkManager +
+nmtui — Text User Interface for controlling NetworkManager +
+nm-online — ask NetworkManager whether the network is connected +
NetworkManager — network management daemon
diff --git a/docs/api/html/index.sgml b/docs/api/html/index.sgml index dc84d959..583682f2 100644 --- a/docs/api/html/index.sgml +++ b/docs/api/html/index.sgml @@ -422,13 +422,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/api/html/manpages.html b/docs/api/html/manpages.html index 27015a54..36b8e931 100644 --- a/docs/api/html/manpages.html +++ b/docs/api/html/manpages.html @@ -7,7 +7,7 @@ - + @@ -17,13 +17,22 @@ - +

UNIX Manual Pages

+nmcli — command-line tool for controlling NetworkManager +
+
+nmtui — Text User Interface for controlling NetworkManager +
+
+nm-online — ask NetworkManager whether the network is connected +
+
NetworkManager — network management daemon

diff --git a/docs/api/html/nm-online.html b/docs/api/html/nm-online.html new file mode 100644 index 00000000..90d3ecb5 --- /dev/null +++ b/docs/api/html/nm-online.html @@ -0,0 +1,120 @@ + + + + +nm-online: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + +
+
+
+
+ + +
+
nm-online
+
nm-online — ask NetworkManager whether the network is connected
+
+
+
Synopsis
+
nm-online [OPTIONS...]
+
+
+
Description
+
nm-online is a utility to find out whether we are + online. It is done by asking NetworkManager about its status. When run, + nm-online waits until NetworkManager reports an active + connection, or specified timeout expires. On exit, the returned status code + should be checked (see the return codes below).
+
By default NetworkManager waits for IPv4 dynamic addressing to complete + but does not wait for the auto IPv6 dynamic addressing. To + wait for IPv6 addressing to complete, either (1) change the network + connection's IPv6 may-fail setting to no, + and/or (2) change the IPv6 addressing method to manual or + dhcp, to indicate that IPv6 connectivity is expected.
+
+
+
Options
+
++++ + + + + + + + + + + + + + + + + + + +

+ -t | --timeout + seconds +
Time to wait for a connection, in seconds. If the option is not provided, + the default timeout is 30 seconds.
-x | --exit
Exit immediately if NetworkManager is not running or connecting.
-q | --quiet
Don't print anything.
-s | --wait-for-startup
Wait for NetworkManager startup to complete, rather than waiting for + network connectivity specifically. Startup is considered complete once + NetworkManager has activated (or attempted to activate) every auto-activate + connection which is available given the current network state. (This is + generally only useful at boot time; after startup has completed, + nm-online -s will just return immediately, regardless of the + current network state.)
+
+
+
Exit Status
+
nm-online exits with status 0 if it succeeds, a value + greater than 0 is returned if an error occurs.
+
++++ + + + + + + + + + + + + + + +

0
Success – already online or connection established within given timeout.
1
Offline or not online within given timeout.
2
Unknown or unspecified error.
+
+
+
See Also
+
nmcli(1), + NetworkManager(8).
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/nm-settings-ifcfg-rh.html b/docs/api/html/nm-settings-ifcfg-rh.html index 7a92c0f9..7323d808 100644 --- a/docs/api/html/nm-settings-ifcfg-rh.html +++ b/docs/api/html/nm-settings-ifcfg-rh.html @@ -29,7 +29,7 @@

-
DESCRIPTION
+
Description

NetworkManager is based on the concept of connection profiles that contain network configuration (see nm-settings(5) for details). The profiles can be @@ -53,7 +53,7 @@

-
File Format
+
File Format

The ifcfg-rh config format is a simple text file containing VARIABLE="value" lines. The format is described in sysconfig.txt @@ -178,7 +178,7 @@ DEVICETYPE=TeamPort

-
Differences against initscripts
+
Differences against initscripts

The main differences of NetworkManager ifcfg-rh plugin and traditional initscripts are: @@ -240,16 +240,16 @@ DEVICETYPE=TeamPort
See the next section for detailed mapping of NetworkManager properties and ifcfg-rh variables. Variable names, format and usage - differences in NetworkManager and initscripts are documented in the tables bellow. + differences in NetworkManager and initscripts are documented in the tables below.

-
DETAILS
+
Details

ifcfg-rh plugin variables marked with (+) are NetworkManager specific extensions not understood by traditional initscripts.

-
Table 69. 802-1x setting
+
Table 69. 802-1x setting

@@ -524,7 +524,7 @@ Example: IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12

-
Table 70. bond setting
+
Table 70. bond setting

@@ -549,7 +549,7 @@ Example: BONDING_OPTS="miimon=100 mode=broadcast"

-
Table 71. bridge-port setting
+
Table 71. bridge-port setting

@@ -590,7 +590,7 @@ Allowed values: 1 - 65535

-
Table 72. bridge setting
+
Table 72. bridge setting

@@ -670,7 +670,7 @@ Allowed values: 0 or 1

-
Table 73. connection setting
+
Table 73. connection setting

@@ -809,7 +809,7 @@ Allowed values: boolean value or 'rx'

-
Table 74. dcb setting
+
Table 74. dcb setting

@@ -944,7 +944,7 @@ Example: DCB_PG_UP2TC=01623701 used explicitly to enable DCB so that the rest of the DCB_* variables can apply.
-
Table 75. infiniband setting
+
Table 75. infiniband setting

@@ -999,7 +999,7 @@ Example: PHYSDEV=ib0

-
Table 76. ip-tunnel setting
+
Table 76. ip-tunnel setting

@@ -1017,7 +1017,7 @@ Example: PHYSDEV=ib0

-
Table 77. ipv4 setting
+
Table 77. ipv4 setting

@@ -1160,7 +1160,7 @@ Example: DHCP_FQDN=foo.bar.com

-
Table 78. ipv6 setting
+
Table 78. ipv6 setting

@@ -1280,7 +1280,7 @@ Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacy

-
Table 79. macvlan setting
+
Table 79. macvlan setting

@@ -1298,7 +1298,7 @@ Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacy

-
Table 80. team-port setting
+
Table 80. team-port setting

@@ -1321,7 +1321,7 @@ Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacy

-
Table 81. team setting
+
Table 81. team setting

@@ -1344,7 +1344,7 @@ Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacy

-
Table 82. tun setting
+
Table 82. tun setting

@@ -1362,7 +1362,7 @@ Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacy

-
Table 83. vlan setting
+
Table 83. vlan setting

@@ -1425,7 +1425,7 @@ Example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12

-
Table 84. vxlan setting
+
Table 84. vxlan setting

@@ -1443,7 +1443,7 @@ Example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12

-
Table 85. 802-3-ethernet setting
+
Table 85. 802-3-ethernet setting

@@ -1537,7 +1537,7 @@ Allowed values: "qeth", "lcs" or "ctc"

-
Table 86. 802-11-wireless-security setting
+
Table 86. 802-11-wireless-security setting

@@ -1689,7 +1689,7 @@ Example: KEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysuperse

-
Table 87. 802-11-wireless setting
+
Table 87. 802-11-wireless setting

@@ -1853,11 +1853,7 @@ Allowed values: default, never, always
-
AUTHOR
-
NetworkManager developers
-
-
-
FILES
+
Files

/etc/sysconfig/network-scripts/ifcfg-*

/etc/sysconfig/network-scripts/keys-*

/etc/sysconfig/network-scripts/route-*
@@ -1865,9 +1861,13 @@ Allowed values: default, never, always
/usr/share/doc/initscripts/sysconfig.txt

-
SEE ALSO
-
https://developer.gnome.org/NetworkManager/unstable/ref-settings.html
-
nm-settings(5), nm-settings-keyfile(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5)
+
See Also
+
nm-settings(5), + nm-settings-keyfile(5), + NetworkManager(8), + NetworkManager.conf(5), + nmcli(1), + nmcli-examples(7)

diff --git a/docs/api/html/nm-settings-keyfile.html b/docs/api/html/nm-settings-keyfile.html index 35135634..428f8bd2 100644 --- a/docs/api/html/nm-settings-keyfile.html +++ b/docs/api/html/nm-settings-keyfile.html @@ -29,7 +29,7 @@

-
DESCRIPTION
+
Description

NetworkManager is based on the concept of connection profiles that contain network configuration (see nm-settings(5) for details). The profiles can be @@ -48,7 +48,7 @@

-
File Format
+
File Format

The keyfile config format is a simple .ini-style format. It consists of sections (groups) of key-value pairs. Each section @@ -58,7 +58,7 @@ specification. The majority of properties of the specification is written in the same format into the keyfile too. However some values are inconvenient for people to use. These are stored in the - files in more readable ways. These properties are described bellow. + files in more readable ways. These properties are described below. An example could be IP addresses that are not written as integer arrays, but more reasonably as "1.2.3.4/12 1.2.3.254". More information of the generic key file format can be found at @@ -167,13 +167,13 @@ id=4

-
DETAILS
+
Details

keyfile plugin variables for the majority of NetworkManager properties have one-to-one mapping. It means a NetworkManager property is stored in the keyfile as a variable of the same name and in the same format. There are several exceptions to this rule, mainly for making keyfile syntax easier for humans. The exceptions handled specially by keyfile - plugin are listed bellow. Refer to + plugin are listed below. Refer to nm-settings(5) for all available settings and properties and their description.
@@ -188,7 +188,7 @@ id=4 802-11-wireless-security = wifi-security
-
Table 61. bridge setting (section)
+
Table 61. bridge setting (section)

@@ -205,7 +205,7 @@ id=4 - + @@ -213,7 +213,7 @@ Example: mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;1

mac-address mac-address ususal hex-digits-and-colons notation usual hex-digits-and-colons notation MAC address in traditional hex-digits-and-colons notation, or semicolon separated list of 6 decimal bytes (obsolete) Example: mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;162;

-
Table 62. infiniband setting (section)
+
Table 62. infiniband setting (section)

@@ -230,7 +230,7 @@ Example: mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;1 - + @@ -238,7 +238,7 @@ Example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:

mac-address mac-address ususal hex-digits-and-colons notation usual hex-digits-and-colons notation MAC address in traditional hex-digits-and-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete) Example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01

-
Table 63. ipv4 setting (section)
+
Table 63. ipv4 setting (section)

@@ -289,7 +289,7 @@ Example: route1=8.8.8.0/24,10.1.1.1,77 route2=7.7.0.0/16

-
Table 64. ipv6 setting (section)
+
Table 64. ipv6 setting (section)

@@ -340,7 +340,7 @@ Example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11

-
Table 65. serial setting (section)
+
Table 65. serial setting (section)

@@ -365,7 +365,7 @@ Example: parity=n

-
Table 66. vpn setting (section)
+
Table 66. vpn setting (section)

@@ -400,7 +400,7 @@ Example: password=Popocatepetl

-
Table 67. 802-3-ethernet setting (section)
+
Table 67. 802-3-ethernet setting (section)

@@ -418,13 +418,13 @@ Example: password=Popocatepetl - + - + @@ -439,7 +439,7 @@ Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79

mac-address mac-address ususal hex-digits-and-colons notation usual hex-digits-and-colons notation MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162)

cloned-mac-address cloned-mac-address ususal hex-digits-and-colons notation usual hex-digits-and-colons notation Cloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).

-
Table 68. 802-11-wireless setting (section)
+
Table 68. 802-11-wireless setting (section)

@@ -465,13 +465,13 @@ Example: ssid=Quick Net - + - + @@ -506,17 +506,17 @@ Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79
-
AUTHOR
-
NetworkManager developers
-
-
-
FILES
+
Files

/etc/NetworkManager/system-connections/*

-
SEE ALSO
-
https://developer.gnome.org/NetworkManager/unstable/ref-settings.html
-
nm-settings(5), nm-settings-ifcfg-rh(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5)
+
See Also
+
nm-settings(5), + nm-settings-ifcfg-rh(5), + NetworkManager(8), + NetworkManager.conf(5), + nmcli(1), + nmcli-examples(7)

diff --git a/docs/api/html/nm-settings.html b/docs/api/html/nm-settings.html index 7a9b75e9..3a540262 100644 --- a/docs/api/html/nm-settings.html +++ b/docs/api/html/nm-settings.html @@ -29,7 +29,7 @@

mac-address mac-address ususal hex-digits-and-colons notation usual hex-digits-and-colons notation MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).

cloned-mac-address cloned-mac-address ususal hex-digits-and-colons notation usual hex-digits-and-colons notation Cloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).

-
DESCRIPTION
+
Description

NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When @@ -94,7 +94,7 @@

-
Table 31. 802-1x setting
+
Table 31. 802-1x setting

@@ -257,13 +257,13 @@ - + - + @@ -293,13 +293,13 @@ - + - + @@ -323,7 +323,7 @@

phase2-private-key byte array Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS12 format private keys and the blob scheme, this property should be set to the PKCS12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS12 certificate and key. When using PKCS12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS12 private key and certificate. Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.

phase2-private-key-password string The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS12 format key. The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.

phase2-private-key-password-flags private-key byte array Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS12 format private keys and the blob scheme, this property should be set to the PKCS12 data and the "private-key-password" property must be set to password used to decrypt the PKCS12 certificate and key. When using PKCS12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data. Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.

private-key-password string The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS12 format key. The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.

private-key-password-flags

-
Table 32. adsl setting
+
Table 32. adsl setting

@@ -390,7 +390,7 @@

-
Table 33. bluetooth setting
+
Table 33. bluetooth setting

@@ -427,7 +427,7 @@

-
Table 34. bond setting
+
Table 34. bond setting

@@ -464,7 +464,7 @@

-
Table 35. bridge setting
+
Table 35. bridge setting

@@ -543,7 +543,7 @@

-
Table 36. bridge-port setting
+
Table 36. bridge-port setting

@@ -586,7 +586,7 @@

-
Table 37. cdma setting
+
Table 37. cdma setting

@@ -611,7 +611,7 @@ - + @@ -635,7 +635,7 @@

number string The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (777) is used when required. The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.

password

-
Table 38. connection setting
+
Table 38. connection setting

@@ -762,7 +762,7 @@

-
Table 39. dcb setting
+
Table 39. dcb setting

@@ -877,7 +877,7 @@

-
Table 40. generic setting
+
Table 40. generic setting

@@ -900,7 +900,7 @@

-
Table 41. gsm setting
+
Table 41. gsm setting

@@ -997,7 +997,7 @@

-
Table 42. infiniband setting
+
Table 42. infiniband setting

@@ -1052,7 +1052,7 @@

-
Table 43. ipv4 setting
+
Table 43. ipv4 setting

@@ -1197,7 +1197,7 @@

-
Table 44. ipv6 setting
+
Table 44. ipv6 setting

@@ -1342,7 +1342,7 @@

-
Table 45. ip-tunnel setting
+
Table 45. ip-tunnel setting

@@ -1439,7 +1439,7 @@

-
Table 46. macvlan setting
+
Table 46. macvlan setting

@@ -1488,7 +1488,7 @@

-
Table 47. 802-11-olpc-mesh setting
+
Table 47. 802-11-olpc-mesh setting

@@ -1531,7 +1531,7 @@

-
Table 48. ppp setting
+
Table 48. ppp setting

@@ -1664,7 +1664,7 @@

-
Table 49. pppoe setting
+
Table 49. pppoe setting

@@ -1713,7 +1713,7 @@

-
Table 50. serial setting
+
Table 50. serial setting

@@ -1768,7 +1768,7 @@

-
Table 51. team setting
+
Table 51. team setting

@@ -1805,7 +1805,7 @@

-
Table 52. team-port setting
+
Table 52. team-port setting

@@ -1836,7 +1836,7 @@

-
Table 53. tun setting
+
Table 53. tun setting

@@ -1897,7 +1897,7 @@

-
Table 54. vlan setting
+
Table 54. vlan setting

@@ -1958,7 +1958,7 @@

-
Table 55. vpn setting
+
Table 55. vpn setting

@@ -2019,7 +2019,7 @@

-
Table 56. vxlan setting
+
Table 56. vxlan setting

@@ -2140,7 +2140,7 @@

-
Table 57. wimax setting
+
Table 57. wimax setting

@@ -2177,7 +2177,7 @@

-
Table 58. 802-3-ethernet setting
+
Table 58. 802-3-ethernet setting

@@ -2280,7 +2280,7 @@

-
Table 59. 802-11-wireless setting
+
Table 59. 802-11-wireless setting

@@ -2401,7 +2401,7 @@

-
Table 60. 802-11-wireless-security setting
+
Table 60. 802-11-wireless-security setting

@@ -2547,18 +2547,15 @@
-
AUTHOR
-
NetworkManager developers
+
Files
+
/etc/NetworkManager/system-connections or distro plugin-specific location

-
FILES
-
/etc/NetworkManager/system-connections
-
or distro plugin-specific location
-
-
-
SEE ALSO
-
https://wiki.gnome.org/Projects/NetworkManager/ConfigurationSpecification
-
NetworkManager(8), nmcli(1), nmcli-examples(5), NetworkManager.conf(5)
+
See Also
+
NetworkManager(8), + nmcli(1), + nmcli-examples(7), + NetworkManager.conf(5)

diff --git a/docs/api/html/nmcli-examples.html b/docs/api/html/nmcli-examples.html index e7ac079b..e903cd68 100644 --- a/docs/api/html/nmcli-examples.html +++ b/docs/api/html/nmcli-examples.html @@ -33,7 +33,7 @@
nmcli [OPTIONS...]

-
Description
+
Description

nmcli is a command-line client for NetworkManager. It allows controlling NetworkManager and reporting its status. For more information @@ -47,14 +47,11 @@
Note: this page has "work-in-progress" status.

-
Examples
+
Examples

-
Example 1. Listing available Wi-Fi APs
+
Example 1. Listing available Wi-Fi APs

-
-$ nmcli device wifi list -
-
+
$ nmcli device wifi list * SSID MODE CHAN RATE SIGNAL BARS SECURITY netdatacomm_local Infra 6 54 Mbit/s 37 ▂▄__ WEP * F1 Infra 11 54 Mbit/s 98 ▂▄▆█ WPA1 @@ -66,67 +63,60 @@ $ nmcli device wifi list MARTINA Infra 4 54 Mbit/s 32 ▂▄__ WPA2 N24PU1 Infra 7 11 Mbit/s 22 ▂___ -- alfa Infra 1 54 Mbit/s 67 ▂▄▆_ WPA2 - bertnet Infra 5 54 Mbit/s 20 ▂___ WPA1 WPA2 -
+ bertnet Infra 5 54 Mbit/s 20 ▂___ WPA1 WPA2
+
+ This command shows how to list available Wi-Fi networks (APs). You can also use + --fields option for displaying different columns. + nmcli -f all dev wifi list will show all of them. +

-
- This command shows how to list available Wi-Fi networks (APs). You can also use - --fields option for displaying different columns. - nmcli -f all dev wifi list will show all of them. -
-
-
Example 2. Showing general information and properties for a Wi-Fi interface
+
+
Example 2. Showing general information and properties for a Wi-Fi interface

-
-$ nmcli -p -f general,wifi-properties device show wlan0 -
-
-=============================================================================== - Device details (wlan0) -=============================================================================== -GENERAL.DEVICE: wlan0 -GENERAL.TYPE: wifi -GENERAL.VENDOR: Intel Corporation -GENERAL.PRODUCT: PRO/Wireless 5100 AGN [Shiloh] Network Connection -GENERAL.DRIVER: iwlwifi -GENERAL.DRIVER-VERSION: 3.8.13-100.fc17.x86_64 -GENERAL.FIRMWARE-VERSION: 8.83.5.1 build 33692 -GENERAL.HWADDR: 00:1E:65:37:A1:D3 -GENERAL.MTU: 1500 -GENERAL.STATE: 100 (connected) -GENERAL.REASON: 0 (No reason given) -GENERAL.UDI: /sys/devices/pci0000:00/0000:00:1c.1/0000:03:00.0/net/wlan0 -GENERAL.IP-IFACE: wlan0 -GENERAL.IS-SOFTWARE: no -GENERAL.NM-MANAGED: yes -GENERAL.AUTOCONNECT: yes -GENERAL.FIRMWARE-MISSING: no -GENERAL.CONNECTION: My Alfa WiFi -GENERAL.CON-UUID: 85194f4c-d496-4eec-bae0-d880b4cbcf26 -GENERAL.CON-PATH: /org/freedesktop/NetworkManager/ActiveConnection/10 -------------------------------------------------------------------------------- -WIFI-PROPERTIES.WEP: yes -WIFI-PROPERTIES.WPA: yes -WIFI-PROPERTIES.WPA2: yes -WIFI-PROPERTIES.TKIP: yes -WIFI-PROPERTIES.CCMP: yes -WIFI-PROPERTIES.AP: no -WIFI-PROPERTIES.ADHOC: yes -------------------------------------------------------------------------------- -
+
$ nmcli -p -f general,wifi-properties device show wlan0 +=========================================================================== + Device details (wlan0) +=========================================================================== +GENERAL.DEVICE: wlan0 +GENERAL.TYPE: wifi +GENERAL.VENDOR: Intel Corporation +GENERAL.PRODUCT: PRO/Wireless 5100 AGN [Shiloh] Network Connection +GENERAL.DRIVER: iwlwifi +GENERAL.DRIVER-VERSION: 3.8.13-100.fc17.x86_64 +GENERAL.FIRMWARE-VERSION: 8.83.5.1 build 33692 +GENERAL.HWADDR: 00:1E:65:37:A1:D3 +GENERAL.MTU: 1500 +GENERAL.STATE: 100 (connected) +GENERAL.REASON: 0 (No reason given) +GENERAL.UDI: /sys/devices/pci0000:00/0000:00:1c.1/net/wlan0 +GENERAL.IP-IFACE: wlan0 +GENERAL.IS-SOFTWARE: no +GENERAL.NM-MANAGED: yes +GENERAL.AUTOCONNECT: yes +GENERAL.FIRMWARE-MISSING: no +GENERAL.CONNECTION: My Alfa WiFi +GENERAL.CON-UUID: 85194f4c-d496-4eec-bae0-d880b4cbcf26 +GENERAL.CON-PATH: /org/freedesktop/NetworkManager/ActiveConnection/ +10 +--------------------------------------------------------------------------- +WIFI-PROPERTIES.WEP: yes +WIFI-PROPERTIES.WPA: yes +WIFI-PROPERTIES.WPA2: yes +WIFI-PROPERTIES.TKIP: yes +WIFI-PROPERTIES.CCMP: yes +WIFI-PROPERTIES.AP: no +WIFI-PROPERTIES.ADHOC: yes +---------------------------------------------------------------------------
+
+ This command shows information about a Wi-Fi device. +

-
- This command shows information about a Wi-Fi device. -
-
-
Example 3. Listing NetworkManager polkit permissions
+
+
Example 3. Listing NetworkManager polkit permissions

-
-$ nmcli general permissions -
-
+
$ nmcli general permissions PERMISSION VALUE org.freedesktop.NetworkManager.enable-disable-network yes org.freedesktop.NetworkManager.enable-disable-wifi yes @@ -138,229 +128,192 @@ org.freedesktop.NetworkManager.wifi.share.protected yes org.freedesktop.NetworkManager.wifi.share.open yes org.freedesktop.NetworkManager.settings.modify.system yes org.freedesktop.NetworkManager.settings.modify.own yes -org.freedesktop.NetworkManager.settings.modify.hostname auth -
-
-
-
- This command shows configured polkit permissions for various NetworkManager - operations. These permissions or actions (using polkit language) are configured - by a system administrator and are not meant to be changed by users. The usual - place for the polkit configuration is /usr/share/polkit-1/actions/org.freedesktop.NetworkManager.policy. - pkaction command can display description for polkit actions. -
+org.freedesktop.NetworkManager.settings.modify.hostname auth +
+ This command shows configured polkit permissions for various NetworkManager + operations. These permissions or actions (using polkit language) are configured + by a system administrator and are not meant to be changed by users. The usual + place for the polkit configuration is /usr/share/polkit-1/actions/org.freedesktop.NetworkManager.policy. + pkaction command can display description for polkit actions. +

-pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose -
+ pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose +
- More information about polkit can be found at http://www.freedesktop.org/wiki/Software/polkit. -
-
-
Example 4. Listing NetworkManager log level and domains
+ More information about polkit can be found at http://www.freedesktop.org/wiki/Software/polkit. +
+
+
+
+
Example 4. Listing NetworkManager log level and domains

-
-$ nmcli general logging -
-
+
$ nmcli general logging LEVEL DOMAINS -INFO PLATFORM,RFKILL,ETHER,WIFI,BT,MB,DHCP4,DHCP6,PPP,WIFI_SCAN,IP4,IP6,AUTOIP4,DNS,VPN,SHARING,SUPPLICANT,AGENTS,SETTINGS,SUSPEND,CORE,DEVICE,OLPC,WIMAX,INFINIBAND,FIREWALL,ADSL,BOND,VLAN,BRIDGE,DBUS_PROPS,TEAM,CONCHECK,DCB,DISPATCH -
+INFO PLATFORM,RFKILL,ETHER,WIFI,BT,MB,DHCP4,DHCP6,PPP,WIFI_SCAN,IP4,IP6,A +UTOIP4,DNS,VPN,SHARING,SUPPLICANT,AGENTS,SETTINGS,SUSPEND,CORE,DEVICE,OLPC, +WIMAX,INFINIBAND,FIREWALL,ADSL,BOND,VLAN,BRIDGE,DBUS_PROPS,TEAM,CONCHECK,DC +B,DISPATCH
+
+ This command shows current NetworkManager logging status. +

-
- This command shows current NetworkManager logging status. -
-
-
Example 5. Changing NetworkManager logging
-
-$ nmcli g log level DEBUG domains CORE,ETHER,IP -$ nmcli g log level INFO domains DEFAULT -
+
+
Example 5. Changing NetworkManager logging
+
+
$ nmcli g log level DEBUG domains CORE,ETHER,IP +$ nmcli g log level INFO domains DEFAULT
+
+ The first command makes NetworkManager log in DEBUG level, and only for CORE, ETHER and + IP domains. The second command restores the default logging state. Please refer to the + NetworkManager.conf(5) manual page + for available logging levels and domains. +

-
- The first command makes NetworkManager log in DEBUG level, and only for CORE, ETHER and - IP domains. The second command restores the default logging state. Please refer to the - NetworkManager.conf(5) manual page - for available logging levels and domains. -
-
-
Example 6. Adding a bonding master and two slave connection profiles
-
-$ nmcli con add type bond ifname mybond0 mode active-backup -$ nmcli con add type ethernet ifname eth1 master mybond0 -$ nmcli con add type ethernet ifname eth2 master mybond0 -

-
- This example demonstrates adding a bond master connection and two slaves. The - first command adds a master bond connection, naming the bonding interface - mybond0 and using active-backup mode. - The next two commands add slaves connections, both enslaved to mybond0. - The first slave will be bound to eth1 interface, the second to - eth2. -
-
-
Example 7. Adding a team master and two slave connection profiles
-
-$ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf -$ nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1 -$ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1 -
+
+
Example 6. Adding a bonding master and two slave connection profiles
+
+
$ nmcli con add type bond ifname mybond0 mode active-backup +$ nmcli con add type ethernet ifname eth1 master mybond0 +$ nmcli con add type ethernet ifname eth2 master mybond0
+
+ This example demonstrates adding a bond master connection and two slaves. The + first command adds a master bond connection, naming the bonding interface + mybond0 and using active-backup mode. + The next two commands add slaves connections, both enslaved to mybond0. + The first slave will be bound to eth1 interface, the second to + eth2. +

-
- This example demonstrates adding a team master connection profile and two slaves. It is - very similar to the bonding example. The first command adds a master team profile, naming - the team interface and the profile Team1. The team configuration - for the master is read from team1-master-json.conf file. Later, you can - change the configuration with modify command - (nmcli con modify Team1 team.config team1-master-another-json.conf). - The last two commands add slaves profiles, both enslaved to Team1. - The first slave will be bound to em1 interface, the second to - em2. The slaves don't specify config and thus - teamd will use its default configuration. You will activate the whole setup - by activating both slaves: +
+
+
Example 7. Adding a team master and two slave connection profiles
+
+
$ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf +$ nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1 +$ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1
+
+ This example demonstrates adding a team master connection profile and two slaves. It is + very similar to the bonding example. The first command adds a master team profile, naming + the team interface and the profile Team1. The team configuration + for the master is read from team1-master-json.conf file. Later, you can + change the configuration with modify command + (nmcli con modify Team1 team.config team1-master-another-json.conf). + The last two commands add slaves profiles, both enslaved to Team1. + The first slave will be bound to em1 interface, the second to + em2. The slaves don't specify config and thus + teamd will use its default configuration. You will activate the whole setup + by activating both slaves: +
+
$ nmcli con up Team1-slave1 + $ nmcli con up Team1-slave2
+
+ By default, the created profiles are marked for auto-activation. But if another + connection has been activated on the device, the new profile won't activate + automatically and you need to activate it manually.
-
-$ nmcli con up Team1-slave1 -$ nmcli con up Team1-slave2 -
+
+
+
+
Example 8. Adding a bridge and two slave profiles
+
+
$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge +$ nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge +$ nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge +$ nmcli con modify TowerBridge bridge.stp no

- By default, the created profiles are marked for auto-activation. But if another - connection has been activated on the device, the new profile won't activate - automatically and you need to activate it manually. -
-
-
Example 8. Adding a bridge and two slave profiles
-
-$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge -$ nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge -$ nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge -$ nmcli con modify TowerBridge bridge.stp no -
+ This example demonstrates adding a bridge master connection and two slaves. The + first command adds a master bridge connection, naming the bridge interface and + the profile as TowerBridge. + The next two commands add slaves profiles, both will be enslaved to + TowerBridge. + The first slave will be tied to ens3 interface, the second to + ens4. + The last command will disable 802.1D STP for the TowerBridge profile. +

-
- This example demonstrates adding a bridge master connection and two slaves. The - first command adds a master bridge connection, naming the bridge interface and - the profile as TowerBridge. - The next two commands add slaves profiles, both will be enslaved to - TowerBridge. - The first slave will be tied to ens3 interface, the second to - ens4. - The last command will disable 802.1D STP for the TowerBridge profile. -
-
-
Example 9. Adding an ethernet connection profile with manual IP configuration
-
- -$ nmcli con add con-name my-con-em1 ifname em1 type ethernet ip4 192.168.100.100/24 gw4 192.168.100.1 ip4 1.2.3.4 ip6 abbe::cafe -$ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4" -$ nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4 -$ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844" -$ nmcli -p con show my-con-em1 - -

-
- The first command adds an Ethernet connection profile named my-con-em1 - that is bound to interface name em1. The profile is configured - with static IP addresses. Three addresses are added, two IPv4 addresses and one IPv6. - The first IP 192.168.100.100 has a prefix of 24 (netmask equivalent of 255.255.255.0). - Gateway entry will become the default route if this profile is activated on em1 interface - (and there is no connection with higher priority). The next two addresses do not - specify a prefix, so a default prefix will be used, i.e. 32 for IPv4 and 128 for IPv6. - The second, third and fourth commands modify DNS parameters of the new connection profile. - The last con show command displays the profile so that all - parameters can be reviewed. -
-
-
Example 10. Escaping colon characters in tabular mode
+
+
Example 9. Adding an ethernet connection profile with manual IP configuration

-
- -$ nmcli -t -f general -e yes -m tab dev show eth0 - -
-
-GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection:e1000e:2.1.4-k:1.8-3:00\:22\:68\:15\:29\:21:1500:100 (connected):0 (No reason given):/sys/devices/pci0000\:00/0000\:00\:19.0/net/eth0:eth0:yes:yes:no:ethernet-13:89cbcbc6-dc85-456c-9c8b-bd828fee3917:/org/freedesktop/NetworkManager/ActiveConnection/9 -
+
$ nmcli con add con-name my-con-em1 ifname em1 type ethernet \ + ip4 192.168.100.100/24 gw4 192.168.100.1 ip4 1.2.3.4 ip6 abbe::cafe +$ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4" +$ nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4 +$ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844" +$ nmcli -p con show my-con-em1
+
+ The first command adds an Ethernet connection profile named my-con-em1 + that is bound to interface name em1. The profile is configured + with static IP addresses. Three addresses are added, two IPv4 addresses and one IPv6. + The first IP 192.168.100.100 has a prefix of 24 (netmask equivalent of 255.255.255.0). + Gateway entry will become the default route if this profile is activated on em1 interface + (and there is no connection with higher priority). The next two addresses do not + specify a prefix, so a default prefix will be used, i.e. 32 for IPv4 and 128 for IPv6. + The second, third and fourth commands modify DNS parameters of the new connection profile. + The last con show command displays the profile so that all + parameters can be reviewed. +

-
- This example shows escaping colon characters in tabular mode. It may be - useful for script processing, because ':' is used as a field separator. -
-
-
Example 11. nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive
+
+
Example 10. Escaping colon characters in tabular mode

-

- - - - - - -
1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20
#!/bin/bash -export LC_ALL=C +
$ nmcli -t -f general -e yes -m tab dev show eth0 +GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection: +e1000e:2.1.4-k:1.8-3:00\:22\:68\:15\:29\:21:1500:100 (connected):0 (No reas +on given):/sys/devices/pci0000\:00/0000\:00\:19.0/net/eth0:eth0:yes:yes:no: +ethernet-13:89cbcbc6-dc85-456c-9c8b-bd828fee3917:/org/freedesktop/NetworkMa +nager/ActiveConnection/9
+
+ This example shows escaping colon characters in tabular mode. It may be + useful for script processing, because ':' is used as a field separator. +
+ + +
+
Example 11. nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive
+
+
+#!/bin/bash +export LC_ALL=C -enable_disable_wifi () -{ - result=$(nmcli dev | grep "ethernet" | grep -w "connected") - if [ -n "$result" ]; then - nmcli radio wifi off - else - nmcli radio wifi on - fi -} +enable_disable_wifi () +{ + result=$(nmcli dev | grep "ethernet" | grep -w "connected") + if [ -n "$result" ]; then + nmcli radio wifi off + else + nmcli radio wifi on + fi +} -if [ "$2" = "up" ]; then - enable_disable_wifi -fi +if [ "$2" = "up" ]; then + enable_disable_wifi +fi -if [ "$2" = "down" ]; then - enable_disable_wifi -fi
+if [ "$2" = "down" ]; then + enable_disable_wifi +fi + +
+ This dispatcher script makes Wi-Fi mutually exclusive with wired + networking. When a wired interface is connected, Wi-Fi will be set + to airplane mode (rfkilled). When the wired interface is disconnected, + Wi-Fi will be turned back on. + Name this script e.g. 70-wifi-wired-exclusive.sh and put it into /etc/NetworkManager/dispatcher.d/ + directory. + See NetworkManager(8) + manual page for more information about NetworkManager dispatcher scripts. +

-
-
- This dispatcher script makes Wi-Fi mutually exclusive with wired - networking. When a wired interface is connected, Wi-Fi will be set - to airplane mode (rfkilled). When the wired interface is disconnected, - Wi-Fi will be turned back on. - Name this script e.g. 70-wifi-wired-exclusive.sh and put it into /etc/NetworkManager/dispatcher.d/ - directory. - See NetworkManager(8) - manual page for more information about NetworkManager dispatcher scripts. -
-
Example sessions of interactive connection editor
+
Example sessions of interactive connection editor

-
Example 12. Adding an ethernet connection profile in interactive editor (a)
+
Example 12. Adding an ethernet connection profile in interactive editor (a)

-
- -$ nmcli connection edit type ethernet - -
-
+
$ nmcli connection edit type ethernet ===| nmcli interactive connection editor |=== @@ -369,72 +322,75 @@ Adding a new '802-3-ethernet' connection Type 'help' or '?' for available commands. Type 'describe [<setting>.<prop>]' for detailed property description. -You may edit the following settings: connection, 802-3-ethernet (ethernet), 802-1x, ipv4, ipv6, dcb -nmcli> print -=============================================================================== - Connection details -=============================================================================== -connection.id: ethernet-4 -connection.uuid: de89cdeb-a3e1-4d53-8fa0-c22546c775f4 -connection.interface-name: -- -connection.type: 802-3-ethernet -connection.autoconnect: yes -connection.autoconnect-priority: 0 -connection.timestamp: 0 -connection.read-only: no -connection.permissions: -connection.zone: -- -connection.master: -- -connection.slave-type: -- -connection.secondaries: -connection.gateway-ping-timeout: 0 -------------------------------------------------------------------------------- -802-3-ethernet.port: -- -802-3-ethernet.speed: 0 -802-3-ethernet.duplex: -- -802-3-ethernet.auto-negotiate: yes -802-3-ethernet.mac-address: -- -802-3-ethernet.cloned-mac-address: -- -802-3-ethernet.mac-address-blacklist: -802-3-ethernet.mtu: auto -802-3-ethernet.s390-subchannels: -802-3-ethernet.s390-nettype: -- -802-3-ethernet.s390-options: -------------------------------------------------------------------------------- -ipv4.method: auto -ipv4.dns: -ipv4.dns-search: -ipv4.addresses: -ipv4.gateway: -- -ipv4.routes: -ipv4.route-metric: -1 -ipv4.ignore-auto-routes: no -ipv4.ignore-auto-dns: no -ipv4.dhcp-client-id: -- -ipv4.dhcp-send-hostname: yes -ipv4.dhcp-hostname: -- -ipv4.never-default: no -ipv4.may-fail: yes -------------------------------------------------------------------------------- -ipv6.method: auto -ipv6.dns: -ipv6.dns-search: -ipv6.addresses: -ipv6.gateway: -- -ipv6.routes: -ipv6.route-metric: -1 -ipv6.ignore-auto-routes: no -ipv6.ignore-auto-dns: no -ipv6.never-default: no -ipv6.may-fail: yes -ipv6.ip6-privacy: -1 (unknown) -ipv6.dhcp-hostname: -- -------------------------------------------------------------------------------- -nmcli> goto ethernet -You may edit the following properties: port, speed, duplex, auto-negotiate, mac-address, cloned-mac-address, mac-address-blacklist, mtu, s390-subchannels, s390-nettype, s390-options +You may edit the following settings: connection, 802-3-ethernet (ethernet), +802-1x, ipv4, ipv6, dcb +nmcli> print +=========================================================================== + Connection details +=========================================================================== +connection.id: ethernet-4 +connection.uuid: de89cdeb-a3e1-4d53-8fa0-c22546c775f4 +connection.interface-name: -- +connection.type: 802-3-ethernet +connection.autoconnect: yes +connection.autoconnect-priority: 0 +connection.timestamp: 0 +connection.read-only: no +connection.permissions: +connection.zone: -- +connection.master: -- +connection.slave-type: -- +connection.secondaries: +connection.gateway-ping-timeout: 0 +--------------------------------------------------------------------------- +802-3-ethernet.port: -- +802-3-ethernet.speed: 0 +802-3-ethernet.duplex: -- +802-3-ethernet.auto-negotiate: yes +802-3-ethernet.mac-address: -- +802-3-ethernet.cloned-mac-address: -- +802-3-ethernet.mac-address-blacklist: +802-3-ethernet.mtu: auto +802-3-ethernet.s390-subchannels: +802-3-ethernet.s390-nettype: -- +802-3-ethernet.s390-options: +--------------------------------------------------------------------------- +ipv4.method: auto +ipv4.dns: +ipv4.dns-search: +ipv4.addresses: +ipv4.gateway: -- +ipv4.routes: +ipv4.route-metric: -1 +ipv4.ignore-auto-routes: no +ipv4.ignore-auto-dns: no +ipv4.dhcp-client-id: -- +ipv4.dhcp-send-hostname: yes +ipv4.dhcp-hostname: -- +ipv4.never-default: no +ipv4.may-fail: yes +--------------------------------------------------------------------------- +ipv6.method: auto +ipv6.dns: +ipv6.dns-search: +ipv6.addresses: +ipv6.gateway: -- +ipv6.routes: +ipv6.route-metric: -1 +ipv6.ignore-auto-routes: no +ipv6.ignore-auto-dns: no +ipv6.never-default: no +ipv6.may-fail: yes +ipv6.ip6-privacy: -1 (unknown) +ipv6.dhcp-hostname: -- +--------------------------------------------------------------------------- +nmcli> goto ethernet +You may edit the following properties: port, speed, duplex, auto-negotiate, + mac-address, cloned-mac-address, mac-address-blacklist, mtu, s390-subchann +els, s390-nettype, s390-options nmcli 802-3-ethernet> set mtu 1492 nmcli 802-3-ethernet> b -nmcli> goto ipv4.addresses +nmcli> goto ipv4.addresses nmcli ipv4.addresses> desc === [addresses] === @@ -455,144 +411,145 @@ nmcli ipv4.addresses> print addresses: 192.168.1.100/24 nmcli ipv4.addresses> back nmcli ipv4> b -nmcli> set ipv4.gateway 192.168.1.1 -nmcli> verify +nmcli> set ipv4.gateway 192.168.1.1 +nmcli> verify Verify connection: OK -nmcli> print -=============================================================================== - Connection details -=============================================================================== -connection.id: ethernet-4 -connection.uuid: de89cdeb-a3e1-4d53-8fa0-c22546c775f4 -connection.interface-name: -- -connection.type: 802-3-ethernet -connection.autoconnect: yes -connection.autoconnect-priority: 0 -connection.timestamp: 0 -connection.read-only: no -connection.permissions: -connection.zone: -- -connection.master: -- -connection.slave-type: -- -connection.secondaries: -connection.gateway-ping-timeout: 0 -------------------------------------------------------------------------------- -802-3-ethernet.port: -- -802-3-ethernet.speed: 0 -802-3-ethernet.duplex: -- -802-3-ethernet.auto-negotiate: yes -802-3-ethernet.mac-address: -- -802-3-ethernet.cloned-mac-address: -- -802-3-ethernet.mac-address-blacklist: -802-3-ethernet.mtu: 1492 -802-3-ethernet.s390-subchannels: -802-3-ethernet.s390-nettype: -- -802-3-ethernet.s390-options: -------------------------------------------------------------------------------- -ipv4.method: manual -ipv4.dns: -ipv4.dns-search: -ipv4.addresses: 192.168.1.100/24 -ipv4.gateway: 192.168.1.1 -ipv4.routes: -ipv4.route-metric: -1 -ipv4.ignore-auto-routes: no -ipv4.ignore-auto-dns: no -ipv4.dhcp-client-id: -- -ipv4.dhcp-send-hostname: yes -ipv4.dhcp-hostname: -- -ipv4.never-default: no -ipv4.may-fail: yes -------------------------------------------------------------------------------- -ipv6.method: auto -ipv6.dns: -ipv6.dns-search: -ipv6.addresses: -ipv6.routes: -ipv6.route-metric: -1 -ipv6.ignore-auto-routes: no -ipv6.ignore-auto-dns: no -ipv6.never-default: no -ipv6.may-fail: yes -ipv6.ip6-privacy: -1 (unknown) -ipv6.dhcp-hostname: -- -------------------------------------------------------------------------------- -nmcli> set ipv4.dns 8.8.8.8 8.8.4.4 -nmcli> print -=============================================================================== - Connection details -=============================================================================== -connection.id: ethernet-4 -connection.uuid: de89cdeb-a3e1-4d53-8fa0-c22546c775f4 -connection.interface-name: -- -connection.type: 802-3-ethernet -connection.autoconnect: yes -connection.autoconnect-priority: 0 -connection.timestamp: 0 -connection.read-only: no -connection.permissions: -connection.zone: -- -connection.master: -- -connection.slave-type: -- -connection.secondaries: -connection.gateway-ping-timeout: 0 -------------------------------------------------------------------------------- -802-3-ethernet.port: -- -802-3-ethernet.speed: 0 -802-3-ethernet.duplex: -- -802-3-ethernet.auto-negotiate: yes -802-3-ethernet.mac-address: -- -802-3-ethernet.cloned-mac-address: -- -802-3-ethernet.mac-address-blacklist: -802-3-ethernet.mtu: 1492 -802-3-ethernet.s390-subchannels: -802-3-ethernet.s390-nettype: -- -802-3-ethernet.s390-options: -------------------------------------------------------------------------------- -ipv4.method: manual -ipv4.dns: 8.8.8.8,8.8.4.4 -ipv4.dns-search: -ipv4.addresses: 192.168.1.100/24 -ipv4.gateway: 192.168.1.1 -ipv4.routes: -ipv4.route-metric: -1 -ipv4.ignore-auto-routes: no -ipv4.ignore-auto-dns: no -ipv4.dhcp-client-id: -- -ipv4.dhcp-send-hostname: yes -ipv4.dhcp-hostname: -- -ipv4.never-default: no -ipv4.may-fail: yes -------------------------------------------------------------------------------- -ipv6.method: auto -ipv6.dns: -ipv6.dns-search: -ipv6.addresses: -ipv6.gateway: -- -ipv6.routes: -ipv6.route-metric: -1 -ipv6.ignore-auto-routes: no -ipv6.ignore-auto-dns: no -ipv6.never-default: no -ipv6.may-fail: yes -ipv6.ip6-privacy: -1 (unknown) -ipv6.dhcp-hostname: -- -------------------------------------------------------------------------------- -nmcli> verify +nmcli> print +=========================================================================== + Connection details +=========================================================================== +connection.id: ethernet-4 +connection.uuid: de89cdeb-a3e1-4d53-8fa0-c22546c775f4 +connection.interface-name: -- +connection.type: 802-3-ethernet +connection.autoconnect: yes +connection.autoconnect-priority: 0 +connection.timestamp: 0 +connection.read-only: no +connection.permissions: +connection.zone: -- +connection.master: -- +connection.slave-type: -- +connection.secondaries: +connection.gateway-ping-timeout: 0 +--------------------------------------------------------------------------- +802-3-ethernet.port: -- +802-3-ethernet.speed: 0 +802-3-ethernet.duplex: -- +802-3-ethernet.auto-negotiate: yes +802-3-ethernet.mac-address: -- +802-3-ethernet.cloned-mac-address: -- +802-3-ethernet.mac-address-blacklist: +802-3-ethernet.mtu: 1492 +802-3-ethernet.s390-subchannels: +802-3-ethernet.s390-nettype: -- +802-3-ethernet.s390-options: +--------------------------------------------------------------------------- +ipv4.method: manual +ipv4.dns: +ipv4.dns-search: +ipv4.addresses: 192.168.1.100/24 +ipv4.gateway: 192.168.1.1 +ipv4.routes: +ipv4.route-metric: -1 +ipv4.ignore-auto-routes: no +ipv4.ignore-auto-dns: no +ipv4.dhcp-client-id: -- +ipv4.dhcp-send-hostname: yes +ipv4.dhcp-hostname: -- +ipv4.never-default: no +ipv4.may-fail: yes +--------------------------------------------------------------------------- +ipv6.method: auto +ipv6.dns: +ipv6.dns-search: +ipv6.addresses: +ipv6.routes: +ipv6.route-metric: -1 +ipv6.ignore-auto-routes: no +ipv6.ignore-auto-dns: no +ipv6.never-default: no +ipv6.may-fail: yes +ipv6.ip6-privacy: -1 (unknown) +ipv6.dhcp-hostname: -- +--------------------------------------------------------------------------- +nmcli> set ipv4.dns 8.8.8.8 8.8.4.4 +nmcli> print +=========================================================================== + Connection details +=========================================================================== +connection.id: ethernet-4 +connection.uuid: de89cdeb-a3e1-4d53-8fa0-c22546c775f4 +connection.interface-name: -- +connection.type: 802-3-ethernet +connection.autoconnect: yes +connection.autoconnect-priority: 0 +connection.timestamp: 0 +connection.read-only: no +connection.permissions: +connection.zone: -- +connection.master: -- +connection.slave-type: -- +connection.secondaries: +connection.gateway-ping-timeout: 0 +--------------------------------------------------------------------------- +802-3-ethernet.port: -- +802-3-ethernet.speed: 0 +802-3-ethernet.duplex: -- +802-3-ethernet.auto-negotiate: yes +802-3-ethernet.mac-address: -- +802-3-ethernet.cloned-mac-address: -- +802-3-ethernet.mac-address-blacklist: +802-3-ethernet.mtu: 1492 +802-3-ethernet.s390-subchannels: +802-3-ethernet.s390-nettype: -- +802-3-ethernet.s390-options: +--------------------------------------------------------------------------- +ipv4.method: manual +ipv4.dns: 8.8.8.8,8.8.4.4 +ipv4.dns-search: +ipv4.addresses: 192.168.1.100/24 +ipv4.gateway: 192.168.1.1 +ipv4.routes: +ipv4.route-metric: -1 +ipv4.ignore-auto-routes: no +ipv4.ignore-auto-dns: no +ipv4.dhcp-client-id: -- +ipv4.dhcp-send-hostname: yes +ipv4.dhcp-hostname: -- +ipv4.never-default: no +ipv4.may-fail: yes +--------------------------------------------------------------------------- +ipv6.method: auto +ipv6.dns: +ipv6.dns-search: +ipv6.addresses: +ipv6.gateway: -- +ipv6.routes: +ipv6.route-metric: -1 +ipv6.ignore-auto-routes: no +ipv6.ignore-auto-dns: no +ipv6.never-default: no +ipv6.may-fail: yes +ipv6.ip6-privacy: -1 (unknown) +ipv6.dhcp-hostname: -- +--------------------------------------------------------------------------- +nmcli> verify Verify connection: OK -nmcli> save -Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully saved. -nmcli> quit -
+nmcli> save +Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully + saved. +nmcli> quit
+
+ Example session in the nmcli interactive connection editor. + The scenario creates an Ethernet connection profile with static addressing (IPs and DNS). +

-
- Example session in the nmcli interactive connection editor. - The scenario creates an Ethernet connection profile with static addressing (IPs and DNS). -
+

-
See Also
+
See Also

nmcli(1), NetworkManager(8), diff --git a/docs/api/html/nmcli.html b/docs/api/html/nmcli.html new file mode 100644 index 00000000..ef756f49 --- /dev/null +++ b/docs/api/html/nmcli.html @@ -0,0 +1,2282 @@ + + + + +nmcli: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + +
+
+
+
+ + +
+
nmcli
+
nmcli — command-line tool for controlling NetworkManager
+
+
+
Synopsis
+
nmcli [OPTIONS...] { help | general | networking | radio | connection | device | agent | monitor } [COMMAND] [ARGUMENTS...]
+
+
+
Description
+
nmcli is a command-line tool for controlling + NetworkManager and reporting network status. It can be utilized as a + replacement for nm-applet or other graphical clients. + nmcli is used to create, display, edit, delete, activate, + and deactivate network connections, as well as control and display network + device status.
+
Typical uses include:
+
+
Scripts: Utilize NetworkManager via nmcli instead of + managing network connections manually. nmcli supports a + 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) + for details about these dispatcher scripts.
+
Servers, headless machines, and terminals: nmcli can + be used to control NetworkManager without a GUI, including creating, editing, + starting and stopping network connections and viewing network status.
+
+
+
+
Options
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

-t | --terse
Output is terse. This mode is designed and suitable for computer (script) + processing.
-p | --pretty
Output is pretty. This causes nmcli to produce easily + readable outputs for humans, i.e. values are aligned, headers are printed, + etc.
-m | --mode { tabular | multiline }
+
Switch between tabular and multiline output:
+
++++ + + + + + + + + + + +

tabular
Output is a table where each line describes a single entry. + Columns define particular properties of the entry.
multiline
Each entry comprises multiple lines, each property on its + own line. The values are prefixed with the property name.
+
If omitted, default is tabular for most commands. + For the commands producing more structured information, that cannot be + displayed on a single line, default is multiline. + Currently, they are:
+
+
nmcli connection show ID
+
nmcli device show
+
+
-c | --colors { yes | no | auto }
This option controls color output (using terminal escape sequences). + yes enables colors, no disables them, + auto only produces colors when standard output is directed + to a terminal. The default value is auto.
-f | --fields {[field...] | 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 + by providing an invalid value to the --fields option. + all is used to print all valid field values of the + command. common is used to print common field values of + the command.
+
If omitted, default is common. The option is + mandatory when --terse is used. In this case, generic values + all and common cannot be used. This + is to maintain compatibility when new fields are added in the future.
+
-e | --escape { yes | no }
+
Whether to escape : and \ characters in terse tabular mode. The + escape character is \.
+
If omitted, default is yes.
+
-n | --nocheck
This option can be used to force nmcli to skip + checking nmcli and NetworkManager + version compatibility. Use it with care, because using incompatible versions + may produce incorrect results.
-a | --ask
When using this option nmcli will stop and ask for any + missing required arguments, so do not use this option for non-interactive + purposes like scripts. This option controls, for example, whether you will be + prompted for a password if it is required for connecting to a network.
-s | --show-secrets
When using this option nmcli will display passwords + and secrets that might be present in an output of an operation. This option + also influences echoing passwords typed by user as an input.
[ + -w | --wait + seconds... + ]
+
This option sets a timeout period for which nmcli will + wait for NetworkManager to finish operations. It is + especially useful for commands that may take a longer time to complete, e.g. + connection activation.
+
Specifying a value of 0 instructs + nmcli not to wait but to exit immediately with a status of + success. The default value depends on the executed command.
+
-v | --version
Show nmcli version.
-h | --help
Print help information.
+
+
+
General Commands
+
nmcli general { status | hostname | permissions | logging } [ARGUMENTS...]
+
Use this command to show NetworkManager status and permissions. You can also get + and change system hostname, as well as NetworkManager logging level and domains.
+
++++ + + + + + + + + + + + + + + + + + + +

status
Show overall status of NetworkManager. This is the default action, when + no additional command is provided for nmcli general.
+ hostname + [hostname] +
+
Get and change system hostname. With no arguments, this prints currently + configured hostname. When you pass a hostname, it will be handed over to + NetworkManager to be set as a new system hostname.
+
Note that the term "system" hostname may also be referred to as + "persistent" or "static" by other programs or tools. The hostname is stored + in /etc/hostname file in most distributions. For example, + systemd-hostnamed service uses the term "static" hostname and it only reads + the /etc/hostname file when it starts.
+
permissions
Show the permissions a caller has for various authenticated operations + that NetworkManager provides, like enable and disable networking, changing + Wi-Fi and WWAN state, modifying connections, etc.
+ logging + [level level] + [domain 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) + for available level and domain values.
+
+
+
Networking Control Commands
+
nmcli networking { on | off | connectivity } [ARGUMENTS...]
+
Query NetworkManager networking status, enable and disable networking. +
+
++++ + + + + + + + + + + +

on, off
Enable enable or disable networking control by NetworkManager. + All interfaces managed by NetworkManager are deactivated when networking + is disabled.
+ connectivity + [check] +
+
Get network connectivity state. The optional check + argument tells NetworkManager to re-check the connectivity, else the most + recent known connectivity state is displayed without re-checking.
+
Possible states are:
+
++++ + + + + + + + + + + + + + + + + + + + + + + +

none
the host is not connected to any network.
portal
the host is behind a captive portal and cannot reach the full Internet.
limited
the host is connected to a network, but it has no access to the Internet.
full
the host is connected to a network and has full access to the Internet.
unknown
the connectivity status cannot be found out.
+
+
+
+
Radio Transmission Control Commands
+
nmcli radio { all | wifi | wwan } [ARGUMENTS...]
+
Show radio switches status, or enable and disable the switches.
+
++++ + + + + + + + + + + + + + + +

+ wifi + [ on | off ] +
Show or set status of Wi-Fi in NetworkManager. If no arguments are + supplied, Wi-Fi status is printed; on enables Wi-Fi; + off disables Wi-Fi.
+ wwan + [ on | off ] +
Show or set status of WWAN (mobile broadband) in NetworkManager. If no + arguments are supplied, mobile broadband status is printed; + on enables mobile broadband, off + disables it.
+ all + [ on | off ] +
Show or set all previously mentioned radio switches at the same time.
+
+
+
Activity Monitor
+
nmcli monitor
+
Observe NetworkManager activity. Watches for changes + in connectivity state, devices or connection profiles.
+
See also nmcli connection monitor + and nmcli device monitor to watch + for changes in certain devices or connections.
+
+
+
Connection Management Commands
+
nmcli connection { show | up | down | add | edit | modify | delete | monitor | reload | load } [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" + when a device uses that connection's configuration to create or connect to + a network. There may be multiple connections that apply to a device, but only + one of them can be active on that device at any given time. The additional + connections can be used to allow quick switching between different networks + and configurations.
+
Consider a machine which is usually connected to a DHCP-enabled network, + but sometimes connected to a testing network which uses static IP addressing. + Instead of manually reconfiguring eth0 each time the network is changed, the + settings can be saved as two connections which both apply to eth0, one for DHCP + (called default) and one with the static addressing details (called + testing). When connected to the DHCP-enabled network the user would run + nmcli con up default , and when connected to the static network the user + would run nmcli con up testing.
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ show + [--active] + [ + --order + [+-]category:... + ] +
+
List in-memory and on-disk connection profiles, some of which may also be + active if a device is using that connection profile. Without a parameter, all + profiles are listed. When --active option is specified, only + the active profiles are shown.
+
The --order option can be used to get custom + ordering of connections. The connections can be ordered by active status + (active), name (name), type + (type) or D-Bus path (path). If + connections are equal according to a sort order category, an additional + category can be specified. The default sorting order is equivalent to + --order active:name:path. + or no + prefix means sorting in ascending order (alphabetically or in numbers), + - means reverse (descending) order. The category names + can be abbreviated (e.g. --order -a:na).
+
+ show + [--active] + [ id | uuid | path | apath ] + ID... +
+
Show details for specified connections. By default, both static + configuration and active connection data are displayed. When + --active option is specified, only the active profiles are + taken into account. Use global --show-secrets option to + display secrets associated with the profile.
+
id, uuid, + path and apath keywords can be used + if ID is ambiguous. Optional + ID-specifying keywords are:
+
++++ + + + + + + + + + + + + + + + + + + +

id
the ID denotes a connection name.
uuid
the ID denotes a connection UUID.
path
the ID denotes a D-Bus + static connection path in the format of + /org/freedesktop/NetworkManager/Settings/num + or just num.
apath
the ID denotes a D-Bus active connection path in the format of + /org/freedesktop/NetworkManager/ActiveConnection/num or just + num.
+
It is possible to filter the output using the global + --fields option. Use the following values:
+
++++ + + + + + + + + + + +

profile
only shows static profile configuration.
active
only shows active connection data (when the profile is active).
+
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, + DHCP6, VPN.
+
When no command is given to the nmcli connection, + the default action is nmcli connection show.
+
+ up + [ id | uuid | path ] + ID... + [ifname ifname] + [ap BSSID] + [passwd-file file] +
+
Activate a connection. 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. When + requiring a particular device to activate the connection on, the + ifname option with interface name should be given. If the + ID is not given an ifname is required, and + NetworkManager will activate the best available connection for the given + ifname. In case of a VPN connection, the + ifname option specifies the device of the base connection. + The ap option specify what particular AP should be used in + case of a Wi-Fi connection.
+
If --wait option is not specified, the default timeout will be 90 + seconds.
+
See connection show above for the description of the + ID-specifying keywords.
+
Available options are:
+
++++ + + + + + + + + + + + + + + +

ifname
interface that will be used for activation.
ap
BSSID of the AP which the command should connect to (for Wi-Fi connections).
passwd-file
+
some networks may require credentials during activation. You can give + these credentials using this option. Each line of the file should contain one + password in the form: + +
+
setting_name.property_name:the password
+
+ + For example, for WPA Wi-Fi with PSK, the line would be + +
+
802-11-wireless-security.psk:secret12345
+
+ + For 802.1X password, the line would be + +
+
802-1x.password:my 1X password
+
+ + nmcli also accepts wifi-sec and wifi strings instead of + 802-11-wireless-security. When NetworkManager requires a password and it is + not given, nmcli will ask for it when run with --ask. + If --ask was not passed, NetworkManager can ask another secret + agent that may be running (typically a GUI secret agent, such as nm-applet or + gnome-shell).
+
+
+ down + [ id | uuid | path | apath ] + ID... +
+
Deactivate a connection from a device without preventing the device from + further auto-activation. Multiple connections can be passed to the + command.
+
Be aware that this command deactivates the specified active connection, + but the device on which the connection was active, is still ready to connect + and will perform auto-activation by looking for a suitable connection that has + the 'autoconnect' flag set. This includes the just deactivated connection. So + if the connection is set to auto-connect, it will be automatically started on + the disconnected device again.
+
In most cases you may want to use device disconnect + command instead.
+
The connection is identified by its name, UUID or D-Bus path. If + ID is ambiguous, a keyword id, + uuid, path or + apath 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.
+
+ 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 + ... + ] +
+
Add a connection for NetworkManager. Arguments differ according to connection types, see below.
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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 + 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).
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] +
++++ + + + + + + + + + + + + + + +

mac
MAC address of the device this connection is locked to.
cloned-mac
cloned MAC.
mtu
MTU.
+ type wifi + ssid SSID + [mac addr] + [cloned-mac addr] + [ + mode + { infrastructure | ap | adhoc } + ] + [mtu mtu] +
++++ + + + + + + + + + + + + + + + + + + + + + + +

ssid
SSID.
mac
MAC address of the device this connection is locked to.
cloned-mac
cloned MAC.
mode
Wi-Fi network mode. If blank, infrastructure + is assumed.
mtu
MTU.
+ type wimax + [mac addr] + [nsp nsp] +
++++ + + + + + + + + + + +

mac
MAC address of the device this connection is locked to.
nsp
Network Service Provider name.
+ type pppoe + username user + [password passwd] + [service name] + [mtu mtu] + [mac addr] +
++++ + + + + + + + + + + + + + + + + + + + + + + +

username
PPPoE username.
password
Password for the PPPoE username.
service
PPPoE service name (if required by concentrator).
mtu
MTU.
mac
MAC address of the device this connection is locked to.
+ type gsm + [apn APN] + [username user] + [password passwd] +
++++ + + + + + + + + + + + + + + +

apn
APN - GSM Access Point Name.
user
user name.
password
password.
+ type cdma + [username user] + [password passwd] +
++++ + + + + + + + + + + +

user
user name.
password
password.
+ type infiniband + [mac addr] + [mtu mtu] + [ + transport-mode + { datagram | connected } + ] + [parent device] + [p-key key] +
++++ + + + + + + + + + + + + + + + + + + + + + + +

mac
MAC address of the device this connection is locked to + (InfiniBand MAC is 20 bytes).
mtu
MTU.
transport-mode
InfiniBand transport mode.
parent
the interface name of the parent device (if any).
p-key
the InfiniBand P_Key (16-bit unsigned integer).
+ type bluetooth + [addr addr] + [ + bt-type + { panu | dun-gsm | dun-cdma } + ] +
++++ + + + + + + + + + + +

addr
Bluetooth device address (MAC).
bt-type
Bluetooth connection type.
+ type vlan + dev device + id id + [flags flags] + [ingress mapping] + [egress mapping] + [mtu mtu] +
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

dev
parent device this VLAN is on.
id
VLAN ID in range 0-4095.
flags
flags.
ingress
VLAN ingress priority mapping.
egress
VLAN egress priority mapping.
mtu
MTU.
+ 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] +
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

mode
bonding mode (default: balance-rr).
primary
primary interface name (for active-backup mode).
miimon
miimon (default: 100).
downdelay
downdelay (default: 0).
updelay
updelay (default: 0).
arp-interval
ARP interval (default: 0).
arp-ip-target
ARP IP target.
+ type bond-slave + [master master] +
++++ + + + + +

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 + ] +
++++ + + + + + + + + + + +

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.
config
JSON configuration for team.
+ 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] +
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

stp
controls whether Spanning Tree Protocol (STP) is enabled for this bridge + (default: yes).
priority
sets STP priority (default: 128).
forward-delay
STP forwarding delay, in seconds (default: 15).
hello-time
STP hello time, in seconds (default: 2).
max-age
STP maximum message age, in seconds (default: 20).
ageing-time
the Ethernet MAC address aging time, in seconds (default: 300).
multicast-snooping
controls whether IGMP snooping is enabled (default: yes).
mac
MAC address of the bridge (note: this requires a recent kernel feature, + originally introduced in 3.15 upstream kernel).
+ type bridge-slave + [master master] + [priority num] + [path-cost 1-65535] + [ + hairpin + { yes | no } + ] +
++++ + + + + + + + + + + + + + + + + + + +

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.
priority
STP priority of this slave (default: 32).
path-cost
STP port cost for destinations via this slave (default: 100).
hairpin
'hairpin mode' for the slave, which allows frames to be sent back out + through the slave the frame was received on (default: yes).
+ type vpn + [type type] + [user username] +
++++ + + + + + + + + + + +

vpn-type
VPN type.
user
VPN username.
+ type olpc-mesh + ssid SSID + [channel 1-13] + [dhcp-anycast MAC] +
++++ + + + + + + + + + + + + + + +

ssid
SSID.
channel
channel to use for the network.
dhcp-anycast
anycast DHCP MAC address used when requesting an IP address via DHCP.
+ type adsl + username username + + protocol + { pppoa | pppoe | ipoatm } + + [password passwd] + [ + encapsulation + { vcmux | llc } + ] +
++++ + + + + + + + + + + + + + + + + + + +

username
ADSL user name.
protocol
ADSL protocol.
password
ADSL password.
encapsulation
ADSL encapsulation.
+ type tun + + mode + { tun | tap } + + [owner UID] + [group GID] + [ + pi + { yes | no } + ] + [ + vnet-hdr + { yes | no } + ] + [ + multi-queue + { yes | no } + ] +
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

mode
Mode for the device.
owner
UID of the owner.
group
GID of the group.
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).
+ type ip-tunnel + + mode + { ipip | gre | sit | isatap | vti | ip6ip6 | ipip6 | ip6gre | vti6 | tun } + + remote addr + [local addr] + [dev device] +
++++ + + + + + + + + + + + + + + + + + + +

mode
tunnel mode.
remote
IPv4 or IPv6 address of the remote tunnel endpoint.
local
IPv4 or IPv6 address of the local tunnel endpoint.
dev
device to use for tunnel endpoint communication.
+ type macvlan + dev device + + mode + { vepa | bridge | private | passthru | source } + + [ + tap + { yes | no } + ] +
++++ + + + + + + + + + + + + + + +

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).
+ 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] +
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

id
VXLAN Network Identifer to use.
remote
unicast destination IP address or multicast IP address to join.
dev
device to use for tunnel endpoint communication.
local
source IP address.
source-port-min
minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.
source-port-max
maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.
destination-port
UDP destination port to communicate to the remote VXLAN tunnel endpoint.
ip4, gw4
IPv4 addresses.
ip6, gw6
IPv6 addresses.
--
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.
+
+ 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:
+
++++ + + + + + + + + + + +

type
type of the new connection; valid types are the same as for + connection add command.
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.
+
+
+
+
Device Management Commands
+
nmcli device { status | show | set | connect | reapply | disconnect | delete | monitor | wifi | lldp } [ARGUMENTS...]
+
Show and manage network interfaces.
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

status
+
Print status of devices.
+
This is the default action if no command is specified to + nmcli device.
+
+ 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.
+ set + [ifname] + ifname + [ + autoconnect + { yes | no } + ] + [ + managed + { yes | no } + ] +
Set device properties.
+ 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.
+
+ reapply + [ifname] +
Attempt to update device with changes to the currently active connection + made since it was last applied.
+ 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.
+
+ 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.
+
+ 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.
+ 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:
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

password
password for secured networks (WEP or WPA).
wep-key-type
type of WEP secret, either key for ASCII/HEX key or + phrase for passphrase.
ifname
interface that will be used for activation.
bssid
if specified, the created connection will be restricted just for the + BSSID.
name
if specified, the connection will use the name (else NM creates a name + itself).
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.
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.
+
+ 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:
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

ifname
what Wi-Fi device is used.
con-name
name of the created hotspot connection profile.
ssid
SSID of the hotspot.
band
Wi-Fi band to use.
channel
Wi-Fi channel to use.
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.
+
+ 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.
+
+
+
Secret Agent
+
nmcli agent { secret | polkit | all }
+
Run nmcli as a NetworkManager secret agent, or polkit agent.
+
++++ + + + + + + + + + + + + + + +

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).
+ 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.
+ all +
Runs nmcli as both NetworkManager secret and a polkit agent.
+
+
+
Environment Variables
+
nmcli's behavior is affected by the following + environment variables.
+
++++ + + + + + + + + + + + + + + +

LC_ALL
If set to a non-empty string value, it overrides the values of all the + other internationalization variables.
LC_MESSAGES
Determines the locale to be used for internationalized messages.
LANG
Provides a default value for the internationalization variables that are + unset or null.
+
+
+
Internationalization notes
+
Be aware that nmcli is localized and that is why the + output depends on your environment. This is important to realize especially + when you parse the output.
+
Call nmcli as LC_ALL=C nmcli to + be sure the locale is set to C while executing in a script.
+
LC_ALL, LC_MESSAGES, LANG + variables specify the LC_MESSAGES locale category (in that + order), which determines the language that nmcli uses for + messages. The C locale is used if none of these variables are set, and this + locale uses English messages.
+
+
+
Exit Status
+
nmcli exits with status 0 if it succeeds, a value + greater than 0 is returned if an error occurs.
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

0
Success – indicates the operation succeeded.
1
Unknown or unspecified error.
2
Invalid user input, wrong nmcli + invocation.
3
Timeout expired (see --wait option).
4
Connection activation failed.
5
Connection deactivation failed.
6
Disconnecting device failed.
7
Connection deletion failed.
8
NetworkManager is not running.
9
nmcli and NetworkManager + versions mismatch.
10
Connection, device, or access point does not exist.
+
+
+
Examples
+
This section presents various examples of nmcli usage. If you want even + more, please refer to + nmcli-examples(7) + manual page.
+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

nmcli -t -f RUNNING general
tells you whether NetworkManager is running or not.
nmcli -t -f STATE general
shows the overall status of NetworkManager.
nmcli radio wifi off
switches Wi-Fi off.
nmcli connection show
lists all connections NetworkManager has.
nmcli -p -m multiline -f all con show
shows all configured connections in multi-line mode.
nmcli connection show --active
lists all currently active connections.
nmcli -f name,autoconnect c s
shows all connection profile names and their auto-connect property.
nmcli -p connection show "My default em1"
shows details for "My default em1" connection profile.
nmcli --show-secrets connection show "My Home WiFi"
shows details for "My Home WiFi" connection profile with all passwords. + Without --show-secrets option, secrets would not be + displayed.
nmcli -f active connection show "My default em1"
shows details for "My default em1" active connection, like IP, DHCP + information, etc.
nmcli -f profile con s "My wired connection"
shows static configuration details of the connection profile with "My + wired connection" name.
nmcli -p con up "My wired connection" ifname eth0
activates the connection profile with name "My wired connection" on + interface eth0. The -p option makes nmcli show progress of the + activation.
nmcli con up 6b028a27-6dc9-4411-9886-e9ad1dd43761 ap 00:3A:98:7C:42:D3
connects the Wi-Fi connection with UUID + 6b028a27-6dc9-4411-9886-e9ad1dd43761 to the AP with BSSID + 00:3A:98:7C:42:D3.
nmcli device status
shows the status for all devices.
nmcli dev disconnect em2
disconnects a connection on interface em2 and marks the device as + unavailable for auto-connecting. As a result, no connection will automatically + be activated on the device until the device's 'autoconnect' is set to TRUE or + the user manually activates a connection.
nmcli -f GENERAL,WIFI-PROPERTIES dev show wlan0
shows details for wlan0 interface; only GENERAL and WIFI-PROPERTIES + sections will be shown.
nmcli -f CONNECTIONS device show wlp3s0
shows all available connection profiles for your Wi-Fi interface + wlp3s0.
nmcli dev wifi
lists available Wi-Fi access points known to NetworkManager.
nmcli dev wifi con "Cafe Hotspot 1" password caffeine name "My cafe"
creates a new connection named "My cafe" and then connects it to "Cafe + Hotspot 1" SSID using password "caffeine". This is mainly useful when + connecting to "Cafe Hotspot 1" for the first time. Next time, it is better to + use nmcli con up id "My cafe" so that the + existing connection profile can be used and no additional is created.
nmcli -s dev wifi hotspot con-name QuickHotspot
creates a hotspot profile and connects it. Prints the hotspot password + the user should use to connect to the hotspot from other devices.
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 + flag.
nmcli c a ifname Maxipes-fik type vlan dev eth0 id 55
non-interactively adds a VLAN connection with ID 55. The connection will + 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
non-interactively adds a connection that will use eth0 Ethernet interface + and only have an IPv6 link-local address configured.
nmcli connection edit ethernet-em1-2
edits existing "ethernet-em1-2" connection in the interactive + editor.
nmcli connection edit type ethernet con-name "yet another Ethernet connection"
adds a new Ethernet connection in the interactive editor.
nmcli con mod ethernet-2 connection.autoconnect no
modifies 'autoconnect' property in the 'connection' setting of + 'ethernet-2' connection.
nmcli con mod "Home Wi-Fi" wifi.mtu 1350
modifies 'mtu' property in the 'wifi' setting of 'Home Wi-Fi' + connection.
nmcli con mod em1-1 ipv4.method manual ipv4.addr "192.168.1.23/24 192.168.1.1, 10.10.1.5/8, 10.0.0.11"
sets manual addressing and the addresses in em1-1 profile.
nmcli con modify ABC +ipv4.dns 8.8.8.8
appends a Google public DNS server to DNS servers in ABC profile.
nmcli con modify ABC -ipv4.addresses "192.168.100.25/24 192.168.1.1"
removes the specified IP address from (static) profile ABC.
nmcli con import type openvpn file ~/Downloads/frootvpn.ovpn
imports an OpenVPN configuration to NetworkManager.
nmcli con export corp-vpnc /home/joe/corpvpn.conf
exports NetworkManager VPN profile corp-vpnc as standard Cisco (vpnc) + configuration.
+
+
+
Notes
+
nmcli accepts abbreviations, as long as they are a unique prefix in the set + of possible options. As new options get added, these abbreviations are not guaranteed + to stay unique. For scripting and long term compatibility it is therefore strongly + advised to spell out the full option names.
+
+
+
Bugs
+
There are probably some bugs. If you find a bug, please report it to + https://bugzilla.gnome.org/ — product NetworkManager.
+
+
+
See Also
+
nmcli-examples(7), + nm-online(1), + NetworkManager(8), + NetworkManager.conf(5), + nm-settings(5), + nm-applet(1), + nm-connection-editor(1).
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file diff --git a/docs/api/html/nmtui.html b/docs/api/html/nmtui.html new file mode 100644 index 00000000..ca11c834 --- /dev/null +++ b/docs/api/html/nmtui.html @@ -0,0 +1,88 @@ + + + + +nmtui: NetworkManager D-Bus API Reference Manual + + + + + + + + + + + + + + + +
+
+
+
+ + +
+
nmtui
+
nmtui — Text User Interface for controlling NetworkManager
+
+
+
Synopsis
+
nmtui-edit | nmtui edit + { name | id } +
+
nmtui-connect | nmtui connect + { name | uuid | device | SSID } +
+
nmtui-hostname | nmtui hostname
+
+
+
Description
+
nmtui is a curses‐based TUI application for + interacting with NetworkManager. When starting nmtui, the + user is prompted to choose the activity to perform unless it was specified as + the first argument.
+
The supported activities are:
+
++++ + + + + + + + + + + + + + + +

edit
Show a connection editor that supports adding, modifying, viewing and + deleting connections. It provides similar functionality as + nm-connection-editor.
connect
Show a list of available connections, with the option to activate or + deactivate them. It provides similar functionality as + nm-applet.
hostname
Set the system hostname.
+
Corresponding to above activities, nmtui also comes + with binaries named nmtui-edit, + nmtui-connect, and nmtui-hostname to skip + the selection of the activities.
+
+
+
See Also
+
nmcli(1), + nm-applet(1), + nm-connection-editor(1), + NetworkManager(8).
+
+
+
+
Generated by GTK-Doc V1.24
+ + \ No newline at end of file -- cgit 1.3.0-6-gf8a5

`IN s identifier`:	See the `Register()` method's identifier argument.	See the Register() method's identifier argument.
`IN u capabilities`:	Indicates various agent capabilities to NetworkManager.	(NMSecretAgentCapabilities) Indicates various agent capabilities to NetworkManager.

`IN a{sa{sv}} connection`:	The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarly differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses.	The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarly differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses.
`IN t version_id`:	If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply.	If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply.
`IN u flags`:	Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0.	Flags which would modify the behavior of the Reapply call. There are no flags defined currently and the users should use the value of 0.

`IN u flags`:	Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0.	Flags which would modify the behavior of the GetAppliedConnection call. There are no flags defined currently and the users should use the value of 0.
`OUT a{sa{sv}} connection`:
`OUT t version_id`:	The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail.	The version-id of the currently applied connection. This can be specified during Reapply to avoid races where you first fetch the applied connection, modify it and try to reapply it. If the applied connection is modified in the meantime, the version_id gets incremented and Reapply will fail.

`s message`:	Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN.	Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN.
`as secrets`:	Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end.	Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end.

`IN o connection`:	The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path.	The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path.
`IN o device`:	The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use.	The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use.
`IN o specific_object`:	The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device.	The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device.
`OUT o active_connection`:

`IN a{sa{sv}} connection`:	Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.	Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.
`IN o device`:
`IN o specific_object`:	The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection.	The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection.
`OUT o path`:

`IN s level`:	One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain.	One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain.
`IN s domains`:	A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged.	A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged.

+ `-t` \| `--timeout` + `seconds` +	Time to wait for a connection, in seconds. If the option is not provided, + the default timeout is 30 seconds.
`-x` \| `--exit`	Exit immediately if NetworkManager is not running or connecting.
`-q` \| `--quiet`	Don't print anything.
`-s` \| `--wait-for-startup`	Wait for NetworkManager startup to complete, rather than waiting for + network connectivity specifically. Startup is considered complete once + NetworkManager has activated (or attempted to activate) every auto-activate + connection which is available given the current network state. (This is + generally only useful at boot time; after startup has completed, + nm-online -s will just return immediately, regardless of the + current network state.)

0	Success – already online or connection established within given timeout.
1	Offline or not online within given timeout.
2	Unknown or unspecified error.

mac-address	mac-address	ususal hex-digits-and-colons notation	usual hex-digits-and-colons notation	MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162)
cloned-mac-address	cloned-mac-address	ususal hex-digits-and-colons notation	usual hex-digits-and-colons notation	Cloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).

phase2-private-key	byte array		Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS12 format private keys and the blob scheme, this property should be set to the PKCS12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS12 certificate and key. When using PKCS12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS12 private key and certificate.	Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.
phase2-private-key-password	string		The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS12 format key.	The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.
phase2-private-key-password-flags	private-key	byte array		Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS12 format private keys and the blob scheme, this property should be set to the PKCS12 data and the "private-key-password" property must be set to password used to decrypt the PKCS12 certificate and key. When using PKCS12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.	Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.
private-key-password	string		The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS12 format key.	The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.
private-key-password-flags

number	string		The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (777) is used when required.	The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.
password

status	Show overall status of NetworkManager. This is the default action, when + no additional command is provided for nmcli general.
+ hostname + [`hostname`] +	+ Get and change system hostname. With no arguments, this prints currently + configured hostname. When you pass a hostname, it will be handed over to + NetworkManager to be set as a new system hostname. + Note that the term "system" hostname may also be referred to as + "persistent" or "static" by other programs or tools. The hostname is stored + in `/etc/hostname` file in most distributions. For example, + systemd-hostnamed service uses the term "static" hostname and it only reads + the `/etc/hostname` file when it starts. +
permissions	Show the permissions a caller has for various authenticated operations + that NetworkManager provides, like enable and disable networking, changing + Wi-Fi and WWAN state, modifying connections, etc.
+ logging + [`level` `level`] + [`domain` `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) + for available level and domain values.

+ wifi + [ on \| off ] +	Show or set status of Wi-Fi in NetworkManager. If no arguments are + supplied, Wi-Fi status is printed; `on` enables Wi-Fi; + `off` disables Wi-Fi.
+ wwan + [ on \| off ] +	Show or set status of WWAN (mobile broadband) in NetworkManager. If no + arguments are supplied, mobile broadband status is printed; + `on` enables mobile broadband, `off` + disables it.
+ all + [ on \| off ] +	Show or set all previously mentioned radio switches at the same time.

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).
+ 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.
+ all +	Runs nmcli as both NetworkManager secret and a polkit agent.

`LC_ALL`	If set to a non-empty string value, it overrides the values of all the + other internationalization variables.
`LC_MESSAGES`	Determines the locale to be used for internationalized messages.
`LANG`	Provides a default value for the internationalization variables that are + unset or null.

0	Success – indicates the operation succeeded.
1	Unknown or unspecified error.
2	Invalid user input, wrong nmcli + invocation.
3	Timeout expired (see `--wait` option).
4	Connection activation failed.
5	Connection deactivation failed.
6	Disconnecting device failed.
7	Connection deletion failed.
8	NetworkManager is not running.
9	nmcli and NetworkManager + versions mismatch.
10	Connection, device, or access point does not exist.

`nmcli -t -f RUNNING general`	tells you whether NetworkManager is running or not.
`nmcli -t -f STATE general`	shows the overall status of NetworkManager.
`nmcli radio wifi off`	switches Wi-Fi off.
`nmcli connection show`	lists all connections NetworkManager has.
`nmcli -p -m multiline -f all con show`	shows all configured connections in multi-line mode.
`nmcli connection show --active`	lists all currently active connections.
`nmcli -f name,autoconnect c s`	shows all connection profile names and their auto-connect property.
`nmcli -p connection show "My default em1"`	shows details for "My default em1" connection profile.
`nmcli --show-secrets connection show "My Home WiFi"`	shows details for "My Home WiFi" connection profile with all passwords. + Without `--show-secrets` option, secrets would not be + displayed.
`nmcli -f active connection show "My default em1"`	shows details for "My default em1" active connection, like IP, DHCP + information, etc.
`nmcli -f profile con s "My wired connection"`	shows static configuration details of the connection profile with "My + wired connection" name.
`nmcli -p con up "My wired connection" ifname eth0`	activates the connection profile with name "My wired connection" on + interface eth0. The -p option makes nmcli show progress of the + activation.
`nmcli con up 6b028a27-6dc9-4411-9886-e9ad1dd43761 ap 00:3A:98:7C:42:D3`	connects the Wi-Fi connection with UUID + 6b028a27-6dc9-4411-9886-e9ad1dd43761 to the AP with BSSID + 00:3A:98:7C:42:D3.
`nmcli device status`	shows the status for all devices.
`nmcli dev disconnect em2`	disconnects a connection on interface em2 and marks the device as + unavailable for auto-connecting. As a result, no connection will automatically + be activated on the device until the device's 'autoconnect' is set to TRUE or + the user manually activates a connection.
`nmcli -f GENERAL,WIFI-PROPERTIES dev show wlan0`	shows details for wlan0 interface; only GENERAL and WIFI-PROPERTIES + sections will be shown.
`nmcli -f CONNECTIONS device show wlp3s0`	shows all available connection profiles for your Wi-Fi interface + wlp3s0.
`nmcli dev wifi`	lists available Wi-Fi access points known to NetworkManager.
`nmcli dev wifi con "Cafe Hotspot 1" password caffeine name "My cafe"`	creates a new connection named "My cafe" and then connects it to "Cafe + Hotspot 1" SSID using password "caffeine". This is mainly useful when + connecting to "Cafe Hotspot 1" for the first time. Next time, it is better to + use nmcli con up id "My cafe" so that the + existing connection profile can be used and no additional is created.
`nmcli -s dev wifi hotspot con-name QuickHotspot`	creates a hotspot profile and connects it. Prints the hotspot password + the user should use to connect to the hotspot from other devices.
`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` + flag.
`nmcli c a ifname Maxipes-fik type vlan dev eth0 id 55`	non-interactively adds a VLAN connection with ID 55. The connection will + 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`	non-interactively adds a connection that will use eth0 Ethernet interface + and only have an IPv6 link-local address configured.
`nmcli connection edit ethernet-em1-2`	edits existing "ethernet-em1-2" connection in the interactive + editor.
`nmcli connection edit type ethernet con-name "yet another Ethernet connection"`	adds a new Ethernet connection in the interactive editor.
`nmcli con mod ethernet-2 connection.autoconnect no`	modifies 'autoconnect' property in the 'connection' setting of + 'ethernet-2' connection.
`nmcli con mod "Home Wi-Fi" wifi.mtu 1350`	modifies 'mtu' property in the 'wifi' setting of 'Home Wi-Fi' + connection.
`nmcli con mod em1-1 ipv4.method manual ipv4.addr "192.168.1.23/24 192.168.1.1, 10.10.1.5/8, 10.0.0.11"`	sets manual addressing and the addresses in em1-1 profile.
`nmcli con modify ABC +ipv4.dns 8.8.8.8`	appends a Google public DNS server to DNS servers in ABC profile.
`nmcli con modify ABC -ipv4.addresses "192.168.100.25/24 192.168.1.1"`	removes the specified IP address from (static) profile ABC.
`nmcli con import type openvpn file ~/Downloads/frootvpn.ovpn`	imports an OpenVPN configuration to NetworkManager.
`nmcli con export corp-vpnc /home/joe/corpvpn.conf`	exports NetworkManager VPN profile corp-vpnc as standard Cisco (vpnc) + configuration.

`edit`	Show a connection editor that supports adding, modifying, viewing and + deleting connections. It provides similar functionality as + nm-connection-editor.
`connect`	Show a list of available connections, with the option to activate or + deactivate them. It provides similar functionality as + nm-applet.
`hostname`	Set the system hostname.

Description

Description

File Format

File Format

+

main section

+

keyfile section

+

ifupdown section

+

logging section

+

connection section

Supported Properties

Supported Properties

Sections

Sections

+

connectivity section

+

global-dns section

+

global-dns-domain sections

+

.config sections

Plugins

Plugins

Appendix

Appendix

Device List Format

See Also

See Also

Description

Description

Dispatcher scripts

Dispatcher scripts

Options

Options

UDEV PROPERTIES

UDEV PROPERTIES

SIGNALS

SIGNALS

DEBUGGING

DEBUGGING

See Also

See Also

Method Details

The Register() method

The Register() method

The RegisterWithCapabilities() method

The RegisterWithCapabilities() method

The Unregister() method

The Unregister() method

Description

Signal Details

Description

Signal Details

Description

Signal Details

Method Details

The GetNspList() method

The GetNspList() method

Method Details

The GetAccessPoints() method

The GetAccessPoints() method

The GetAllAccessPoints() method

The GetAllAccessPoints() method

The RequestScan() method

The RequestScan() method

Method Details

The Reapply() method

The Reapply() method

The GetAppliedConnection() method

The GetAppliedConnection() method

The Disconnect() method

The Disconnect() method

The Delete() method

The Delete() method

Method Details

`main` section

`keyfile` section

`ifupdown` section

`logging` section

`connection` section

`connectivity` section

`global-dns` section

`global-dns-domain` sections

`.config` sections

The `Register()` method

The `RegisterWithCapabilities()` method

The `Unregister()` method

The `GetNspList()` method

The `GetAccessPoints()` method

The `GetAllAccessPoints()` method

The `RequestScan()` method

The `Reapply()` method

The `GetAppliedConnection()` method

The `Disconnect()` method

The `Delete()` method

The `NeedSecrets()` method

The `SetIp4Config()` method

The `SetIp6Config()` method

The `SetState()` method

The `GetSecrets()` method

The `CancelGetSecrets()` method

The `SaveSecrets()` method

The `DeleteSecrets()` method

The `Update()` method

The `UpdateUnsaved()` method

The `Delete()` method

The `GetSettings()` method

The `GetSecrets()` method

The `ClearSecrets()` method

The `Save()` method

The `ListConnections()` method

The `GetConnectionByUuid()` method

The `AddConnection()` method

The `AddConnectionUnsaved()` method

The `LoadConnections()` method

The `ReloadConnections()` method

The `SaveHostname()` method

The `Connect()` method

The `ConnectInteractive()` method

The `NeedSecrets()` method

The `Disconnect()` method

The `SetConfig()` method

The `SetIp4Config()` method

The `SetIp6Config()` method

The `SetFailure()` method