NMSettingIPTunnel: libnm Reference Manual

## NMSettingIPTunnel NMSettingIPTunnel — Describes connection properties for IP tunnel devices |

## Functions

NMSetting * | nm_setting_ip_tunnel_new ()
const char * | nm_setting_ip_tunnel_get_parent ()
NMIPTunnelMode | nm_setting_ip_tunnel_get_mode ()
const char * | nm_setting_ip_tunnel_get_local ()
const char * | nm_setting_ip_tunnel_get_remote ()
guint | nm_setting_ip_tunnel_get_ttl ()
guint | nm_setting_ip_tunnel_get_tos ()
gboolean | nm_setting_ip_tunnel_get_path_mtu_discovery ()
const char * | nm_setting_ip_tunnel_get_input_key ()
const char * | nm_setting_ip_tunnel_get_output_key ()
guint | nm_setting_ip_tunnel_get_encapsulation_limit ()
guint | nm_setting_ip_tunnel_get_flow_label ()
guint32 | nm_setting_ip_tunnel_get_fwmark ()
guint | nm_setting_ip_tunnel_get_mtu ()
NMIPTunnelFlags | nm_setting_ip_tunnel_get_flags ()

## Types and Values

#define | NM_SETTING_IP_TUNNEL_SETTING_NAME
#define | NM_SETTING_IP_TUNNEL_PARENT
#define | NM_SETTING_IP_TUNNEL_MODE
#define | NM_SETTING_IP_TUNNEL_LOCAL
#define | NM_SETTING_IP_TUNNEL_REMOTE
#define | NM_SETTING_IP_TUNNEL_TTL
#define | NM_SETTING_IP_TUNNEL_TOS
#define | NM_SETTING_IP_TUNNEL_PATH_MTU_DISCOVERY
#define | NM_SETTING_IP_TUNNEL_INPUT_KEY
#define | NM_SETTING_IP_TUNNEL_OUTPUT_KEY
#define | NM_SETTING_IP_TUNNEL_ENCAPSULATION_LIMIT
#define | NM_SETTING_IP_TUNNEL_FLOW_LABEL
#define | NM_SETTING_IP_TUNNEL_FWMARK
#define | NM_SETTING_IP_TUNNEL_MTU
#define | NM_SETTING_IP_TUNNEL_FLAGS
enum | NMIPTunnelFlags

## Object Hierarchy

        GFlags
        ╰── NMIPTunnelFlags

## Description

## Functions

### nm_setting_ip_tunnel_new ()

    NMSetting *
    nm_setting_ip_tunnel_new (void);

Creates a new NMSettingIPTunnel object with default values.

#### Returns

the new empty NMSettingIPTunnel object.

[transfer full]

Since: 1.2

### nm_setting_ip_tunnel_get_parent ()

    const char *
    nm_setting_ip_tunnel_get_parent (NMSettingIPTunnel *setting);

Returns the “parent” property of the setting

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the parent device

Since: 1.2

### nm_setting_ip_tunnel_get_mode ()

    NMIPTunnelMode
    nm_setting_ip_tunnel_get_mode (NMSettingIPTunnel *setting);

Returns the “mode” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the tunnel mode

Since: 1.2

### nm_setting_ip_tunnel_get_local ()

    const char *
    nm_setting_ip_tunnel_get_local (NMSettingIPTunnel *setting);

Returns the “local” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the local endpoint

Since: 1.2

### nm_setting_ip_tunnel_get_remote ()

    const char *
    nm_setting_ip_tunnel_get_remote (NMSettingIPTunnel *setting);

Returns the “remote” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the remote endpoint

Since: 1.2

### nm_setting_ip_tunnel_get_ttl ()

    guint
    nm_setting_ip_tunnel_get_ttl (NMSettingIPTunnel *setting);

Returns the “ttl” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the Time-to-live value

Since: 1.2

### nm_setting_ip_tunnel_get_tos ()

    guint
    nm_setting_ip_tunnel_get_tos (NMSettingIPTunnel *setting);

Returns the “tos” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the TOS value

Since: 1.2

### nm_setting_ip_tunnel_get_path_mtu_discovery ()

    gboolean
    nm_setting_ip_tunnel_get_path_mtu_discovery
                                   (NMSettingIPTunnel *setting);

Returns the “path-mtu-discovery” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

whether path MTU discovery is enabled

Since: 1.2

### nm_setting_ip_tunnel_get_input_key ()

    const char *
    nm_setting_ip_tunnel_get_input_key (NMSettingIPTunnel *setting);

Returns the “input-key” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the input key

Since: 1.2

### nm_setting_ip_tunnel_get_output_key ()

    const char *
    nm_setting_ip_tunnel_get_output_key (NMSettingIPTunnel *setting);

Returns the “output-key” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the output key

Since: 1.2

### nm_setting_ip_tunnel_get_encapsulation_limit ()

    guint
    nm_setting_ip_tunnel_get_encapsulation_limit
                                   (NMSettingIPTunnel *setting);

Returns the “encapsulation-limit” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the encapsulation limit value

Since: 1.42

### nm_setting_ip_tunnel_get_flow_label ()

    guint
    nm_setting_ip_tunnel_get_flow_label (NMSettingIPTunnel *setting);

Returns the “flow-label” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the flow label value

Since: 1.42

### nm_setting_ip_tunnel_get_fwmark ()

    guint32
    nm_setting_ip_tunnel_get_fwmark (NMSettingIPTunnel *setting);

Returns the “fwmark” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the fwmark value

Since: 1.42

### nm_setting_ip_tunnel_get_mtu ()

    guint
    nm_setting_ip_tunnel_get_mtu (NMSettingIPTunnel *setting);

Returns the “mtu” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the MTU

Since: 1.2

### nm_setting_ip_tunnel_get_flags ()

    NMIPTunnelFlags
    nm_setting_ip_tunnel_get_flags (NMSettingIPTunnel *setting);

Returns the “flags” property of the setting.

#### Parameters

setting | the NMSettingIPTunnel |

#### Returns

the tunnel flags

Since: 1.12

## Types and Values

### NM_SETTING_IP_TUNNEL_SETTING_NAME

    #define NM_SETTING_IP_TUNNEL_SETTING_NAME "ip-tunnel"

### NM_SETTING_IP_TUNNEL_PARENT

    #define NM_SETTING_IP_TUNNEL_PARENT              "parent"

### NM_SETTING_IP_TUNNEL_MODE

    #define NM_SETTING_IP_TUNNEL_MODE                "mode"

### NM_SETTING_IP_TUNNEL_LOCAL

    #define NM_SETTING_IP_TUNNEL_LOCAL               "local"

### NM_SETTING_IP_TUNNEL_REMOTE

    #define NM_SETTING_IP_TUNNEL_REMOTE              "remote"

### NM_SETTING_IP_TUNNEL_TTL

    #define NM_SETTING_IP_TUNNEL_TTL                 "ttl"

### NM_SETTING_IP_TUNNEL_TOS

    #define NM_SETTING_IP_TUNNEL_TOS                 "tos"

### NM_SETTING_IP_TUNNEL_PATH_MTU_DISCOVERY

    #define NM_SETTING_IP_TUNNEL_PATH_MTU_DISCOVERY  "path-mtu-discovery"

### NM_SETTING_IP_TUNNEL_INPUT_KEY

    #define NM_SETTING_IP_TUNNEL_INPUT_KEY           "input-key"

### NM_SETTING_IP_TUNNEL_OUTPUT_KEY

    #define NM_SETTING_IP_TUNNEL_OUTPUT_KEY          "output-key"

### NM_SETTING_IP_TUNNEL_ENCAPSULATION_LIMIT

    #define NM_SETTING_IP_TUNNEL_ENCAPSULATION_LIMIT "encapsulation-limit"

### NM_SETTING_IP_TUNNEL_FLOW_LABEL

    #define NM_SETTING_IP_TUNNEL_FLOW_LABEL          "flow-label"

### NM_SETTING_IP_TUNNEL_FWMARK

    #define NM_SETTING_IP_TUNNEL_FWMARK              "fwmark"

### NM_SETTING_IP_TUNNEL_MTU

    #define NM_SETTING_IP_TUNNEL_MTU                 "mtu"

### NM_SETTING_IP_TUNNEL_FLAGS

    #define NM_SETTING_IP_TUNNEL_FLAGS               "flags"

### enum NMIPTunnelFlags

IP tunnel flags.

#### Members

NM_IP_TUNNEL_FLAG_NONE | no flag |
NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT | don't add encapsulation limit if one isn't present in inner packet |
NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS | copy the traffic class field from the inner packet |
NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL | copy the flowlabel from the inner packet |
NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV | used for Mobile IPv6 |
NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY | copy DSCP from the outer packet |
NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK | copy fwmark from inner packet |

Since: 1.12