diff options
Diffstat (limited to 'src/libnm-client-impl')
| -rw-r--r-- | src/libnm-client-impl/nm-settings-docs-gir.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/src/libnm-client-impl/nm-settings-docs-gir.xml b/src/libnm-client-impl/nm-settings-docs-gir.xml index eef7de67..78dc852c 100644 --- a/src/libnm-client-impl/nm-settings-docs-gir.xml +++ b/src/libnm-client-impl/nm-settings-docs-gir.xml @@ -285,7 +285,7 @@ If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. - Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</description><description-docbook><para> Enable policy routing (source routing) and set the routing table used when adding routes.</para><para> This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para> If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para> Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para></description-docbook></property><property name="routes" name_upper="ROUTES" type="array of legacy IPv6 route struct"><description> Array of IP routes.</description><description-docbook><para> Array of IP routes.</para></description-docbook></property><property name="token" name_upper="TOKEN" type="string"><description> Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</description><description-docbook><para> Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</para></description-docbook></property></setting><setting name="ip-tunnel" description=" IP Tunneling Settings" name_upper="IP_TUNNEL"><property name="encapsulation-limit" name_upper="ENCAPSULATION_LIMIT" type="uint32" default="0"><description> How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</description><description-docbook><para> How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</para></description-docbook></property><property name="flags" name_upper="FLAGS" type="uint32" default="0"><description> Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</description><description-docbook><para> Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</para></description-docbook></property><property name="flow-label" name_upper="FLOW_LABEL" type="uint32" default="0"><description> The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</description><description-docbook><para> The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para></description-docbook></property><property name="input-key" name_upper="INPUT_KEY" type="string"><description> The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</description><description-docbook><para> The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para></description-docbook></property><property name="local" name_upper="LOCAL" type="string"><description> The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</description><description-docbook><para> The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</para></description-docbook></property><property name="mode" name_upper="MODE" type="uint32" default="0"><description> The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</description><description-docbook><para> The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</para></description-docbook></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</description><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para></description-docbook></property><property name="output-key" name_upper="OUTPUT_KEY" type="string"><description> The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</description><description-docbook><para> The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para></description-docbook></property><property name="parent" name_upper="PARENT" type="string"><description> If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</description><description-docbook><para> If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</para></description-docbook></property><property name="path-mtu-discovery" name_upper="PATH_MTU_DISCOVERY" type="boolean" default="TRUE"><description> Whether to enable Path MTU Discovery on this tunnel.</description><description-docbook><para> Whether to enable Path MTU Discovery on this tunnel.</para></description-docbook></property><property name="remote" name_upper="REMOTE" type="string"><description> The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</description><description-docbook><para> The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</para></description-docbook></property><property name="tos" name_upper="TOS" type="uint32" default="0"><description> The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</description><description-docbook><para> The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</para></description-docbook></property><property name="ttl" name_upper="TTL" type="uint32" default="0"><description> The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</description><description-docbook><para> The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</para></description-docbook></property></setting><setting name="macsec" description=" MACSec Settings" name_upper="MACSEC"><property name="encrypt" name_upper="ENCRYPT" type="boolean" default="TRUE"><description> Whether the transmitted traffic must be encrypted.</description><description-docbook><para> Whether the transmitted traffic must be encrypted.</para></description-docbook></property><property name="mka-cak" name_upper="MKA_CAK" type="string"><description> The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.</description><description-docbook><para> The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.</para></description-docbook></property><property name="mka-cak-flags" name_upper="MKA_CAK_FLAGS" type="NMSettingSecretFlags (uint32)"><description> Flags indicating how to handle the "mka-cak" property.</description><description-docbook><para> Flags indicating how to handle the "mka-cak" property.</para></description-docbook></property><property name="mka-ckn" name_upper="MKA_CKN" type="string"><description> The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.</description><description-docbook><para> The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement.</para></description-docbook></property><property name="mode" name_upper="MODE" type="int32" default="0"><description> Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</description><description-docbook><para> Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</para></description-docbook></property><property name="parent" name_upper="PARENT" type="string"><description> If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</description><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para></description-docbook></property><property name="port" name_upper="PORT" type="int32" default="1"><description> The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</description><description-docbook><para> The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</para></description-docbook></property><property name="send-sci" name_upper="SEND_SCI" type="boolean" default="TRUE"><description> Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</description><description-docbook><para> Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</para></description-docbook></property><property name="validation" name_upper="VALIDATION" type="int32" default="2"><description> Specifies the validation mode for incoming frames.</description><description-docbook><para> Specifies the validation mode for incoming frames.</para></description-docbook></property></setting><setting name="macvlan" description=" MAC VLAN Settings" name_upper="MACVLAN"><property name="mode" name_upper="MODE" type="uint32" default="0"><description> The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</description><description-docbook><para> The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</para></description-docbook></property><property name="parent" name_upper="PARENT" type="string"><description> 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.</description><description-docbook><para> 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.</para></description-docbook></property><property name="promiscuous" name_upper="PROMISCUOUS" type="boolean" default="TRUE"><description> Whether the interface should be put in promiscuous mode.</description><description-docbook><para> Whether the interface should be put in promiscuous mode.</para></description-docbook></property><property name="tap" name_upper="TAP" type="boolean" default="FALSE"><description> Whether the interface should be a MACVTAP.</description><description-docbook><para> Whether the interface should be a MACVTAP.</para></description-docbook></property></setting><setting name="match" description=" Match settings" name_upper="MATCH"><property name="driver" name_upper="DRIVER" type="array of string"><description> A list of driver names to match. Each element is a shell wildcard pattern. + Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</description><description-docbook><para> Enable policy routing (source routing) and set the routing table used when adding routes.</para><para> This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para> If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para> Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para></description-docbook></property><property name="routes" name_upper="ROUTES" type="array of legacy IPv6 route struct"><description> Array of IP routes.</description><description-docbook><para> Array of IP routes.</para></description-docbook></property><property name="token" name_upper="TOKEN" type="string"><description> Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</description><description-docbook><para> Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</para></description-docbook></property></setting><setting name="ip-tunnel" description=" IP Tunneling Settings" name_upper="IP_TUNNEL"><property name="encapsulation-limit" name_upper="ENCAPSULATION_LIMIT" type="uint32" default="0"><description> How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</description><description-docbook><para> How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</para></description-docbook></property><property name="flags" name_upper="FLAGS" type="uint32" default="0"><description> Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</description><description-docbook><para> Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</para></description-docbook></property><property name="flow-label" name_upper="FLOW_LABEL" type="uint32" default="0"><description> The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</description><description-docbook><para> The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para></description-docbook></property><property name="input-key" name_upper="INPUT_KEY" type="string"><description> The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</description><description-docbook><para> The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para></description-docbook></property><property name="local" name_upper="LOCAL" type="string"><description> The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</description><description-docbook><para> The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</para></description-docbook></property><property name="mode" name_upper="MODE" type="uint32" default="0"><description> The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</description><description-docbook><para> The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</para></description-docbook></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</description><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para></description-docbook></property><property name="output-key" name_upper="OUTPUT_KEY" type="string"><description> The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</description><description-docbook><para> The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para></description-docbook></property><property name="parent" name_upper="PARENT" type="string"><description> If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</description><description-docbook><para> If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</para></description-docbook></property><property name="path-mtu-discovery" name_upper="PATH_MTU_DISCOVERY" type="boolean" default="TRUE"><description> Whether to enable Path MTU Discovery on this tunnel.</description><description-docbook><para> Whether to enable Path MTU Discovery on this tunnel.</para></description-docbook></property><property name="remote" name_upper="REMOTE" type="string"><description> The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</description><description-docbook><para> The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</para></description-docbook></property><property name="tos" name_upper="TOS" type="uint32" default="0"><description> The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</description><description-docbook><para> The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</para></description-docbook></property><property name="ttl" name_upper="TTL" type="uint32" default="0"><description> The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</description><description-docbook><para> The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</para></description-docbook></property></setting><setting name="macsec" description=" MACSec Settings" name_upper="MACSEC"><property name="encrypt" name_upper="ENCRYPT" type="boolean" default="TRUE"><description> Whether the transmitted traffic must be encrypted.</description><description-docbook><para> Whether the transmitted traffic must be encrypted.</para></description-docbook></property><property name="mka-cak" name_upper="MKA_CAK" type="string"><description> The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</description><description-docbook><para> The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</para></description-docbook></property><property name="mka-cak-flags" name_upper="MKA_CAK_FLAGS" type="NMSettingSecretFlags (uint32)"><description> Flags indicating how to handle the "mka-cak" property.</description><description-docbook><para> Flags indicating how to handle the "mka-cak" property.</para></description-docbook></property><property name="mka-ckn" name_upper="MKA_CKN" type="string"><description> The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</description><description-docbook><para> The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</para></description-docbook></property><property name="mode" name_upper="MODE" type="int32" default="0"><description> Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</description><description-docbook><para> Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</para></description-docbook></property><property name="parent" name_upper="PARENT" type="string"><description> If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</description><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para></description-docbook></property><property name="port" name_upper="PORT" type="int32" default="1"><description> The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</description><description-docbook><para> The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</para></description-docbook></property><property name="send-sci" name_upper="SEND_SCI" type="boolean" default="TRUE"><description> Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</description><description-docbook><para> Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</para></description-docbook></property><property name="validation" name_upper="VALIDATION" type="int32" default="2"><description> Specifies the validation mode for incoming frames.</description><description-docbook><para> Specifies the validation mode for incoming frames.</para></description-docbook></property></setting><setting name="macvlan" description=" MAC VLAN Settings" name_upper="MACVLAN"><property name="mode" name_upper="MODE" type="uint32" default="0"><description> The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</description><description-docbook><para> The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</para></description-docbook></property><property name="parent" name_upper="PARENT" type="string"><description> 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.</description><description-docbook><para> 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.</para></description-docbook></property><property name="promiscuous" name_upper="PROMISCUOUS" type="boolean" default="TRUE"><description> Whether the interface should be put in promiscuous mode.</description><description-docbook><para> Whether the interface should be put in promiscuous mode.</para></description-docbook></property><property name="tap" name_upper="TAP" type="boolean" default="FALSE"><description> Whether the interface should be a MACVTAP.</description><description-docbook><para> Whether the interface should be a MACVTAP.</para></description-docbook></property></setting><setting name="match" description=" Match settings" name_upper="MATCH"><property name="driver" name_upper="DRIVER" type="array of string"><description> 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.</description><description-docbook><para> A list of driver names to match. Each element is a shell wildcard pattern.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para></description-docbook></property><property name="interface-name" name_upper="INTERFACE_NAME" type="array of string"><description> A list of interface names to match. Each element is a shell wildcard pattern. |