Reference

YAML configuration

Netplan’s configuration files use the YAML (v1.1) format. All files in /{lib,etc,run}/netplan/*.yaml are considered and are supposed to use restrictive file permissions (600 / rw-------), i.e. owner (root) read-write only.

The top-level node in a netplan configuration file is a network: mapping that contains version: 2 (the YAML currently being used by curtin, MaaS, etc. is version 1), and then device definitions grouped by their type, such as ethernets:, modems:, wifis:, or bridges:. These are the types that our renderer can understand and are supported by our backends.

• YAML configuration

libnetplan API

libnetplan is a component of the Netplan project that contains the logic for data parsing, validation and generation. It is build as a dynamic .so library that can be used from different binaries (like Netplan’s generate, netplan-dbus, the netplan apply/try/get/set/... CLI or via the corresponding Python bindings or external applications like the NetworkManager, using the Netplan backend).

• libnetplan API
  • Public headers
    • netplan.h
    • parse-nm.h
    • parse.h
    • types.h
      • NetplanParser
      • NetplanNetDefinition
      • NetplanState
      • NetplanError
      • NetplanStateIterator
      • NetplanDefType
        • NetplanDefType::NETPLAN_DEF_TYPE_NONE
        • NetplanDefType::NETPLAN_DEF_TYPE_ETHERNET
        • NetplanDefType::NETPLAN_DEF_TYPE_WIFI
        • NetplanDefType::NETPLAN_DEF_TYPE_MODEM
        • NetplanDefType::NETPLAN_DEF_TYPE_VIRTUAL
        • NetplanDefType::NETPLAN_DEF_TYPE_BRIDGE
        • NetplanDefType::NETPLAN_DEF_TYPE_BOND
        • NetplanDefType::NETPLAN_DEF_TYPE_VLAN
        • NetplanDefType::NETPLAN_DEF_TYPE_TUNNEL
        • NetplanDefType::NETPLAN_DEF_TYPE_PORT
        • NetplanDefType::NETPLAN_DEF_TYPE_VRF
        • NetplanDefType::NETPLAN_DEF_TYPE_NM
        • NetplanDefType::NETPLAN_DEF_TYPE_DUMMY
        • NetplanDefType::NETPLAN_DEF_TYPE_VETH
        • NetplanDefType::NETPLAN_DEF_TYPE_NM_PLACEHOLDER_
        • NetplanDefType::NETPLAN_DEF_TYPE_MAX_
      • NetplanBackend
        • NetplanBackend::NETPLAN_BACKEND_NONE
        • NetplanBackend::NETPLAN_BACKEND_NETWORKD
        • NetplanBackend::NETPLAN_BACKEND_NM
        • NetplanBackend::NETPLAN_BACKEND_OVS
        • NetplanBackend::NETPLAN_BACKEND_MAX_
      • NETPLAN_ERROR_DOMAINS
        • NETPLAN_ERROR_DOMAINS::NETPLAN_PARSER_ERROR
        • NETPLAN_ERROR_DOMAINS::NETPLAN_VALIDATION_ERROR
        • NETPLAN_ERROR_DOMAINS::NETPLAN_FILE_ERROR
        • NETPLAN_ERROR_DOMAINS::NETPLAN_BACKEND_ERROR
        • NETPLAN_ERROR_DOMAINS::NETPLAN_EMITTER_ERROR
        • NETPLAN_ERROR_DOMAINS::NETPLAN_FORMAT_ERROR
      • NETPLAN_PARSER_ERRORS
        • NETPLAN_PARSER_ERRORS::NETPLAN_ERROR_INVALID_YAML
        • NETPLAN_PARSER_ERRORS::NETPLAN_ERROR_INVALID_CONFIG
      • NETPLAN_VALIDATION_ERRORS
        • NETPLAN_VALIDATION_ERRORS::NETPLAN_ERROR_CONFIG_GENERIC
        • NETPLAN_VALIDATION_ERRORS::NETPLAN_ERROR_CONFIG_VALIDATION
      • NETPLAN_BACKEND_ERRORS
        • NETPLAN_BACKEND_ERRORS::NETPLAN_ERROR_UNSUPPORTED
        • NETPLAN_BACKEND_ERRORS::NETPLAN_ERROR_VALIDATION
      • NETPLAN_EMITTER_ERRORS
        • NETPLAN_EMITTER_ERRORS::NETPLAN_ERROR_YAML_EMITTER
      • NETPLAN_FORMAT_ERRORS
        • NETPLAN_FORMAT_ERRORS::NETPLAN_ERROR_FORMAT_INVALID_YAML
      • _NetplanStateIterator
        • _NetplanStateIterator::placeholder
    • util.h

Netplan CLI

Netplan’s manpages describe the usage of the different command line interface tools available. Those are also installed on a system running Netplan and can be accessed, using the man utility.

• Netplan CLI

Netplan D-Bus

Netplan provides a daemon that can be run to provide the io.netplan.Netplan D-Bus API, to control certain aspects of a system’s Netplan configuration programmatically. See also: DBus config API.

• Netplan D-Bus