CLI

Usage

usage: ifstatecli [-h] [--version] [-v | -q] [-s] [-c CONFIG]
                  {apply,check,show,showall}

positional arguments:
  {apply,check,show,showall}
                        specifies the action to perform

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit
  -v, --verbose         be more verbose
  -q, --quiet           be more quiet, print only warnings and errors
  -s, --soft-schema     ignore schema validation errors, expect ifstatecli to
                        trigger internal exceptions
  -c CONFIG, --config CONFIG
                        configuration YaML filename

Actions

apply

The apply action will reconfigure the network config of the host to match the state of the config file:

# ifstatecli apply
configuring interface links
 eth0            ok
 eth0.10         add
 wlan0           change
 LOOP            ok
 eth1            orphan
 eth1.20         del

configuring ip addresses...
 eth0.10         198.51.100.3/27
 LOOP            192.0.2.3/32
 LOOP            2001:db8::3/128

check

The check action will parse the config file and does a dry run of the apply action.

show

The show action will print a configuration for the running network config. The ouput might be used as a starting point for writing configurations.

# ifstatecli show
interfaces:
- name: eth0
  addresses: []
  link:
    kind: physical
    address: 8c:16:45:3c:f1:42
    businfo: 0000:00:1f.6
    state: up
- name: wlan0
  addresses: []
  link:
    kind: physical
    address: 8c:16:54:15:aa:21
    businfo: 0000:05:00.0
    state: down
- name: eth0.10
  addresses:
  - 198.51.100.3/27
  link:
    kind: vlan
    state: up
    vlan_flags:
      state:
        flags: 1
        mask: 4294967295
    vlan_id: 10
    vlan_protocol: 33024
- name: LOOP
  addresses:
  - 192.0.2.3
  - 2001:db8::3
  link:
    kind: dummy
    state: up
routing:
  routes:
  - to: 0.0.0.0/0
    table: main
    dev: eno1

You should consider removing any unnecessary options.

showall

The showall action will print a configuration for the running network config including internal default settings from the ignore section.