diff options
Diffstat (limited to 'docs/api/settings-spec.xml')
| -rw-r--r-- | docs/api/settings-spec.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index f0d457da..a2a3e056 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -42,7 +42,7 @@ Properties </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mode<indexterm zone="settings-macvlan"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row><row><entry><screen>parent<indexterm zone="settings-macvlan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry><screen>promiscuous<indexterm zone="settings-macvlan"><primary sortas="promiscuous">promiscuous</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether the interface should be put in promiscuous mode.</entry></row><row><entry><screen>tap<indexterm zone="settings-macvlan"><primary sortas="tap">tap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Whether the interface should be a MACVTAP.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-match"><refnamediv><refname>match</refname><refpurpose>Match settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-match.properties"> Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>driver<indexterm zone="settings-match"><primary sortas="driver">driver</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of driver names to match. Each element is a shell wildcard pattern. When an element is prefixed with exclamation mark (!) the condition is inverted. A candidate driver name is considered matching when both these conditions are satisfied: (a) any of the elements not prefixed with '!' matches or there aren't such elements; (b) none of the elements prefixed with '!' match.</entry></row><row><entry><screen>interface-name<indexterm zone="settings-match"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of interface names to match. Each element is a shell wildcard pattern. When an element is prefixed with exclamation mark (!) the condition is inverted. A candidate interface name is considered matching when both these conditions are satisfied: (a) any of the elements not prefixed with '!' matches or there aren't such elements; (b) none of the elements prefixed with '!' match.</entry></row><row><entry><screen>kernel-command-line<indexterm zone="settings-match"><primary sortas="kernel-command-line">kernel-command-line</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or if prefixed with the exclamation mark unset). The argument must either be a single word, or an assignment (i.e. two words, separated "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching.</entry></row><row><entry><screen>path<indexterm zone="settings-match"><primary sortas="path">path</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). Each element of the list is a shell wildcard pattern. When an element is prefixed with exclamation mark (!) the condition is inverted. A candidate path is considered matching when both these conditions are satisfied: (a) any of the elements not prefixed with '!' matches or there aren't such elements; (b) none of the elements prefixed with '!' match.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-11-olpc-mesh"><refnamediv><refname>802-11-olpc-mesh</refname><refpurpose>OLPC Wireless Mesh Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-olpc-mesh.properties"> + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>driver<indexterm zone="settings-match"><primary sortas="driver">driver</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of driver names to match. Each element is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</entry></row><row><entry><screen>interface-name<indexterm zone="settings-match"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of interface names to match. Each element is a shell wildcard pattern. An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</entry></row><row><entry><screen>kernel-command-line<indexterm zone="settings-match"><primary sortas="kernel-command-line">kernel-command-line</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or if prefixed with the exclamation mark unset). The argument must either be a single word, or an assignment (i.e. two words, separated "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</entry></row><row><entry><screen>path<indexterm zone="settings-match"><primary sortas="path">path</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). Each element of the list is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-11-olpc-mesh"><refnamediv><refname>802-11-olpc-mesh</refname><refpurpose>OLPC Wireless Mesh Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-olpc-mesh.properties"> Properties </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>channel<indexterm zone="settings-802-11-olpc-mesh"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Channel on which the mesh network to join is located.</entry></row><row><entry><screen>dhcp-anycast-address<indexterm zone="settings-802-11-olpc-mesh"><primary sortas="dhcp-anycast-address">dhcp-anycast-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</entry></row><row><entry><screen>ssid<indexterm zone="settings-802-11-olpc-mesh"><primary sortas="ssid">ssid</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>SSID of the mesh network to join.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-bridge"><refnamediv><refname>ovs-bridge</refname><refpurpose>OvsBridge Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-bridge.properties"> Properties |