doc/advanced-configuration.txt

   1 Advanced configuration interface
   2 ********************************
   3
   4
   5 Configuration basics
   6 ====================
   7
   8 The default configuration method for all services is automatic or something
   9 like DHCP. In almost every case that should be just good enough, but if it
  10 is not, Connection Manager supports manual configuration for Ethernet and
  11 IP settings.
  12
  13
  14 Configuration interface
  15 =======================
  16
  17 Every service contains two properties. One represents the current active
  18 configuration and the other one allows manual configuration via the user.
  19
  20 For IPv4 they are named "IPv4" and IPv4.Configuration".
  21
  22 [ /profile/default/wifi_001122334455_42696720696e204a6170616e_managed_psk ]
  23     Type = wifi
  24     Name = Big in Japan
  25     Mode = managed
  26     Strength = 82
  27     Security = rsn
  28     Favorite = true
  29     State = ready
  30     IPv4.Configuration = { Method=dhcp }
  31     IPv4 = { Netmask=255.255.255.0 Method=dhcp Address=192.168.1.198 }
  32
  33 The above WiFi network shows how the default configuration would look like
  34 with a connected service. The configuration method is DHCP and the current
  35 IP address is 192.168.1.198.
  36
  37 The "IPv4" property is read-only and will emit PropertyChanged signals in
  38 case the IP address of this interface changes. The "IPv4.Configuration"
  39 property is read-write and allows changes. For example to use a static IP
  40 configuration this call could be used:
  41
  42     service.SetProperty("IPv4.Configuration", { "Method": "manual",
  43                                                 "Address": "192.168.1.100",
  44                                                 "Netmask": "255.255.255.0" })
  45
  46 The configuration itself is a dictionary with various fields. Not all of
  47 them need to be present. A lot of combinations are valid.
  48
  49 For example the "Method" field has valid settings of "off", "fixed", "manual"
  50 and "dhcp". The "fixed" value however can not be set by any user program. It
  51 is an internal value that some 3G cards require. Switching to "off" will
  52 remove any IP configuration from the interface. The "manual" method allows
  53 for static address configuration. And "dhcp" will use DHCP to retrieve all
  54 required information automatically.
  55
  56 With a manual configuration, the fields "Address" and "Netmask" should be
  57 given. In case "Netmask" is left out, the best netmask will be calculated.
  58
  59 The "Gateway" field can be used to indicate the default route/gateway for
  60 this interface.
  61