NetworkManager Documentation

https://networkmanager.dev/docs/api/latest/
Admin
Documentation for NetworkManager, covering its configuration, services, command-line tools, and...
Tokens:254,548
Snippets:1,900
Trust Score:9.2
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example 9: Adding a team controller and two port connection profiles

Source: https://networkmanager.dev/docs/api/latest/nmcli-examples.html

Adds a team controller profile named 'Team1' with configuration from 'team1-controller-json.conf', then adds two ethernet port profiles (em1 and em2) attached to Team1. The ports use default teamd configuration. Activate the setup by bringing up both ports. The profiles are marked for auto-activation by default, but manual activation may be needed if another connection is active on the device.

```bash
$ **nmcli con add type team con-name Team1 ifname Team1 config team1-controller-json.conf**
```

```bash
$ **nmcli con add type ethernet con-name Team1-port1 ifname em1 controller Team1**
```

```bash
$ **nmcli con add type ethernet con-name Team1-port2 ifname em2 controller Team1**
```

```bash
  $ **nmcli con up Team1-port1**
  $ **nmcli con up Team1-port2**
```

--------------------------------

### Keyfile connection profile example

Source: https://networkmanager.dev/docs/api/latest/nm-settings-keyfile.html

Example of a keyfile connection profile in .ini-style format. The file is stored in /etc/NetworkManager/system-connections/ and contains sections corresponding to settings names with key-value pairs.

```ini
[connection]
id=MyDemoConnection
uuid=2f9e2d0e-7e6e-4e5f-9c8e-3b2a1d0c5f6e
type=ethernet

[ethernet]
mac-address=00:11:22:33:44:55

[ipv4]
method=auto

[ipv6]
method=auto

```

--------------------------------

### Example [device] section configuration

Source: https://networkmanager.dev/docs/api/latest/NetworkManager.conf.html

Shows a minimal [device] section that matches interface eth3 and sets managed=1.

```ini
[device]
match-device=interface-name:eth3
managed=1

```

--------------------------------

### Property: Startup

Source: https://networkmanager.dev/docs/api/latest/gdbus-org.freedesktop.NetworkManager.html

Indicates whether NM is still starting up.

```APIDOC
## Property: Startup

### Description
Indicates whether NM is still starting up; this becomes FALSE when NM has finished attempting to activate every connection that it might be able to activate at startup.

### Type
- **Type**: boolean (b)
- **Access**: readable
```

--------------------------------

### no-auto-default examples

Source: https://networkmanager.dev/docs/api/latest/NetworkManager.conf.html

Examples of specifying devices by MAC address, interface name, or wildcard to inhibit default wired connections.

```ini
no-auto-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee
no-auto-default=eth0,eth1
no-auto-default=*

```

--------------------------------

### Device List Format Example

Source: https://networkmanager.dev/docs/api/latest/NetworkManager.conf.html

Example of a device list using the format described above. It shows matching by interface name, MAC address, globbing, and negative matches.

```text
interface-name:em4
mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2
interface-name:vboxnet*,except:interface-name:vboxnet2
*,except:mac:00:22:68:1c:59:b1
```

--------------------------------

### unmanaged-devices example

Source: https://networkmanager.dev/docs/api/latest/NetworkManager.conf.html

Example of setting unmanaged devices using interface-name and MAC address specifiers. Devices listed are strictly unmanaged and cannot be overruled via the API.

```ini
unmanaged-devices=interface-name:em4
unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2

```

--------------------------------

### StartFind

Source: https://networkmanager.dev/docs/api/latest/gdbus-org.freedesktop.NetworkManager.Device.WifiP2P.html

Starts a find operation for Wi-Fi P2P peers. Accepts an options dictionary with a timeout key.

```APIDOC
## StartFind

### Description
Starts a find operation for Wi-Fi P2P peers. The `options` argument accepts the following keys: `timeout` (int) - Timeout value in the range of 1-600 seconds. The default is 30 seconds.

### Method
StartFind

### Parameters
#### IN a{sv} options
- **options** (a{sv}) - Required - Options of find. Accepts key `timeout` (int) with range 1-600 seconds, default 30.

### Since
1.16
```

--------------------------------

### Multiple connection sections example in NetworkManager.conf

Source: https://networkmanager.dev/docs/api/latest/NetworkManager.conf.html

Shows how to define multiple connection sections with different match-device rules. The [connection] section is always considered last. Properties are searched in order of appearance, so wlan0 gets ipv4.route-metric=50 and ipv6.ip6-privacy=1 from the later section.

```ini
[connection]
ipv6.ip6-privacy=0
connection.autoconnect-ports=1
vpn.timeout=120

[connection-wifi-wlan0]
match-device=interface-name:wlan0
ipv4.route-metric=50

[connection-wifi-other]
match-device=type:wifi
ipv4.route-metric=55
ipv6.ip6-privacy=1

```

--------------------------------

### Enable nm-cloud-setup for Amazon EC2 (shell commands)

Source: https://networkmanager.dev/docs/api/latest/nm-cloud-setup.html

Installs NetworkManager-cloud-setup and configures systemd to enable the service and timer for EC2. Creates a drop-in file to set NM_CLOUD_SETUP_EC2=yes, then creates symlinks to enable the service and timer, followed by a daemon-reload.

```bash
dnf install -y NetworkManager-cloud-setup

mkdir -p /etc/systemd/system/nm-cloud-setup.service.d
cat > /etc/systemd/system/nm-cloud-setup.service.d/10-enable-ec2.conf << EOF
[Service]
Environment=NM_CLOUD_SETUP_EC2=yes
EOF

# systemctl enable nm-cloud-setup.service
mkdir -p /etc/systemd/system/NetworkManager.service.wants/
ln -s /usr/lib/systemd/system/nm-cloud-setup.service /etc/systemd/system/NetworkManager.service.wants/nm-cloud-setup.service

# systemctl enable nm-cloud-setup.timer
mkdir -p /etc/systemd/system/timers.target.wants/
ln -s /etc/systemd/system/timers.target.wants/nm-cloud-setup.timer /usr/lib/systemd/system/nm-cloud-setup.timer

# systemctl daemon-reload
```

--------------------------------

### Create and connect to a Wi-Fi hotspot

Source: https://networkmanager.dev/docs/api/latest/nmcli.html

Creates a hotspot profile named 'QuickHotspot' and connects to it, printing the hotspot password for other devices to use.

```bash
nmcli -s dev wifi hotspot con-name QuickHotspot
```

--------------------------------

### Example 8: Adding a bonding controller and two port connection profiles

Source: https://networkmanager.dev/docs/api/latest/nmcli-examples.html

Adds a bond controller connection named 'mybond0' in active-backup mode, then adds two ethernet port connections (eth1 and eth2) attached to that controller. The ports are bound to the specified interfaces.

```bash
$ **nmcli con add type bond ifname mybond0 mode active-backup**
```

```bash
$ **nmcli con add type ethernet ifname eth1 controller mybond0**
```

```bash
$ **nmcli con add type ethernet ifname eth2 controller mybond0**
```

--------------------------------

### Example 5: Listing NetworkManager log level and domains

Source: https://networkmanager.dev/docs/api/latest/nmcli-examples.html

Use this command to display the current NetworkManager logging level and the list of enabled logging domains. The output shows the level (e.g., INFO) and the domains (e.g., PLATFORM, RFKILL, ETHER, WIFI).

```bash
$ **nmcli general logging**
LEVEL  DOMAINS
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
```

--------------------------------

### state

Source: https://networkmanager.dev/docs/api/latest/gdbus-org.freedesktop.NetworkManager.html

Gets the overall networking state as determined by the NetworkManager daemon.

```APIDOC
## state

### Description
The overall networking state as determined by the NetworkManager daemon, based on the state of network devices under its management.

### Method
state

### Parameters
#### Output Parameters
- **state** (u) - NMState

### Request Example
```
state (OUT u state);
```

### Response
Returns the overall networking state.
```

--------------------------------

### GetLogging

Source: https://networkmanager.dev/docs/api/latest/gdbus-org.freedesktop.NetworkManager.html

Gets the current logging verbosity level and operation domains.

```APIDOC
## GetLogging

### Description
Get current logging verbosity level and operations domains.

### Method
GetLogging

### Parameters
#### Output Parameters
- **level** (s) - One of [ERR, WARN, INFO, DEBUG, TRACE].
- **domains** (s) - For available domains see SetLogging() call.

### Request Example
```
GetLogging (OUT s level,
            OUT s domains);
```

### Response
Returns the current logging level and domains.
```

--------------------------------

### Simple NetworkManager configuration file

Source: https://networkmanager.dev/docs/api/latest/NetworkManager.conf.html

A minimal keyfile configuration with a [main] section and the plugins key set to keyfile.

```ini
[main]
plugins=keyfile

```

--------------------------------

### GetDevices

Source: https://networkmanager.dev/docs/api/latest/gdbus-org.freedesktop.NetworkManager.html

Gets the list of realized network devices. This list does not include device placeholders.

```APIDOC
## GetDevices

### Description
Get the list of realized network devices.

### Method
GetDevices

### Parameters
#### OUT Parameters
- **devices** (ao) - Output - List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()).

### Response
Returns an array of object paths (ao).
```

--------------------------------

### Edit an existing connection in the interactive editor

Source: https://networkmanager.dev/docs/api/latest/nmcli.html

Starts the interactive editor for the existing 'ethernet-em1-2' connection.

```bash
nmcli connection edit ethernet-em1-2
```
Tokens:
Raw