diff options
| author | Michael Biebl <biebl@debian.org> | 2017-12-12 15:53:07 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2017-12-12 15:53:07 +0100 |
| commit | afcd268ea7b1149fbfb66bce4eca659b675da0a2 (patch) | |
| tree | c3fca2203ad17434daf3ccf576582bd66aa41ab2 /docs/api/settings-spec.xml | |
| parent | 417f6015c3dc8c47cf27daa59f64e0e36c521b9c (diff) | |
New upstream version 1.10.2 upstream/1.10.2
Diffstat (limited to 'docs/api/settings-spec.xml')
| -rw-r--r-- | docs/api/settings-spec.xml | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index 45954f0b..7f238460 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -378,18 +378,46 @@ <row><entry><screen>send-delay<indexterm zone="settings-serial"><primary sortas="send-delay">send-delay</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry>Time to delay between each byte sent to the modem, in microseconds.</entry></row> <row><entry><screen>stopbits<indexterm zone="settings-serial"><primary sortas="stopbits">stopbits</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> + <refentry id="settings-tc"><refnamediv><refname>tc</refname><refpurpose>Linux Traffic Contril Settings.</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-tc.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>name<indexterm zone="settings-tc"><primary sortas="name">name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen>tc</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>qdiscs<indexterm zone="settings-tc"><primary sortas="qdiscs">qdiscs</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen>[]</screen></entry><entry>Array of TC queuening disciplines.</entry></row> + <row><entry><screen>tfilters<indexterm zone="settings-tc"><primary sortas="tfilters">tfilters</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen>[]</screen></entry><entry>Array of TC traffic filters.</entry></row> + </tbody></tgroup></table></para></refsect1></refentry> <refentry id="settings-team"><refnamediv><refname>team</refname><refpurpose>Teaming Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-team.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>config<indexterm zone="settings-team"><primary sortas="config">config</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row> <row><entry><screen>interface-name<indexterm zone="settings-team"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</entry></row> + <row><entry><screen>link-watchers<indexterm zone="settings-team"><primary sortas="link-watchers">link-watchers</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen>[]</screen></entry><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-incative', 'send-always'. See teamd.conf man for more details.</entry></row> + <row><entry><screen>mcast-rejoin-count<indexterm zone="settings-team"><primary sortas="mcast-rejoin-count">mcast-rejoin-count</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd mcast_rejoin.count.</entry></row> + <row><entry><screen>mcast-rejoin-interval<indexterm zone="settings-team"><primary sortas="mcast-rejoin-interval">mcast-rejoin-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd mcast_rejoin.interval.</entry></row> <row><entry><screen>name<indexterm zone="settings-team"><primary sortas="name">name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen>team</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>notify-peers-count<indexterm zone="settings-team"><primary sortas="notify-peers-count">notify-peers-count</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd notify_peers.count.</entry></row> + <row><entry><screen>notify-peers-interval<indexterm zone="settings-team"><primary sortas="notify-peers-interval">notify-peers-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd notify_peers.interval.</entry></row> + <row><entry><screen>runner<indexterm zone="settings-team"><primary sortas="runner">runner</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen>"roundrobin"</screen></entry><entry>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp".</entry></row> + <row><entry><screen>runner-active<indexterm zone="settings-team"><primary sortas="runner-active">runner-active</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Corresponds to the teamd runner.active.</entry></row> + <row><entry><screen>runner-agg-select-policy<indexterm zone="settings-team"><primary sortas="runner-agg-select-policy">runner-agg-select-policy</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Corresponds to the teamd runner.agg_select_policy.</entry></row> + <row><entry><screen>runner-fast-rate<indexterm zone="settings-team"><primary sortas="runner-fast-rate">runner-fast-rate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Corresponds to the teamd runner.fast_rate.</entry></row> + <row><entry><screen>runner-hwaddr-policy<indexterm zone="settings-team"><primary sortas="runner-hwaddr-policy">runner-hwaddr-policy</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Corresponds to the teamd runner.hwaddr_policy.</entry></row> + <row><entry><screen>runner-min-ports<indexterm zone="settings-team"><primary sortas="runner-min-ports">runner-min-ports</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd runner.min_ports.</entry></row> + <row><entry><screen>runner-sys-prio<indexterm zone="settings-team"><primary sortas="runner-sys-prio">runner-sys-prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd runner.sys_prio.</entry></row> + <row><entry><screen>runner-tx-balancer<indexterm zone="settings-team"><primary sortas="runner-tx-balancer">runner-tx-balancer</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Corresponds to the teamd runner.tx_balancer.name.</entry></row> + <row><entry><screen>runner-tx-balancer-interval<indexterm zone="settings-team"><primary sortas="runner-tx-balancer-interval">runner-tx-balancer-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd runner.tx_balancer.interval.</entry></row> + <row><entry><screen>runner-tx-hash<indexterm zone="settings-team"><primary sortas="runner-tx-hash">runner-tx-hash</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>Corresponds to the teamd runner.tx_hash.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> <refentry id="settings-team-port"><refnamediv><refname>team-port</refname><refpurpose>Team Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-team-port.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>config<indexterm zone="settings-team-port"><primary sortas="config">config</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row> + <row><entry><screen>lacp-key<indexterm zone="settings-team-port"><primary sortas="lacp-key">lacp-key</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</entry></row> + <row><entry><screen>lacp-prio<indexterm zone="settings-team-port"><primary sortas="lacp-prio">lacp-prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>255</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</entry></row> + <row><entry><screen>link-watchers<indexterm zone="settings-team-port"><primary sortas="link-watchers">link-watchers</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen>[]</screen></entry><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-incative', 'send-always'. See teamd.conf man for more details.</entry></row> <row><entry><screen>name<indexterm zone="settings-team-port"><primary sortas="name">name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen>team-port</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry><screen>prio<indexterm zone="settings-team-port"><primary sortas="prio">prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.prio.</entry></row> + <row><entry><screen>queue-id<indexterm zone="settings-team-port"><primary sortas="queue-id">queue-id</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</entry></row> + <row><entry><screen>sticky<indexterm zone="settings-team-port"><primary sortas="sticky">sticky</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.sticky.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> <refentry id="settings-tun"><refnamediv><refname>tun</refname><refpurpose>Tunnel Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-tun.properties"> Properties |