NMSettingPpp

NMSettingPpp — Describes connection properties for devices/networks that require PPP to deliver IP capability

Properties

guint baud Read / Write
gboolean crtscts Read / Write
guint lcp-echo-failure Read / Write
guint lcp-echo-interval Read / Write
gboolean mppe-stateful Read / Write
guint mru Read / Write
guint mtu Read / Write
gboolean no-vj-comp Read / Write
gboolean noauth Read / Write
gboolean nobsdcomp Read / Write
gboolean nodeflate Read / Write
gboolean refuse-chap Read / Write
gboolean refuse-eap Read / Write
gboolean refuse-mschap Read / Write
gboolean refuse-mschapv2 Read / Write
gboolean refuse-pap Read / Write
gboolean require-mppe Read / Write
gboolean require-mppe-128 Read / Write

Object Hierarchy

    GObject
    ╰── NMSetting
        ╰── NMSettingPpp

Description

The NMSettingPpp object is a NMSetting subclass that describes properties necessary for connection to networks that require PPP transport, like PPPoE cable and DSL modems and some mobile broadband devices.

Functions

nm_setting_ppp_new ()

NMSetting *
nm_setting_ppp_new (void);

Creates a new NMSettingPpp object with default values.

Returns

the new empty NMSettingPpp object.

[transfer full]


nm_setting_ppp_get_noauth ()

gboolean
nm_setting_ppp_get_noauth (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “noauth” property of the setting


nm_setting_ppp_get_refuse_eap ()

gboolean
nm_setting_ppp_get_refuse_eap (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “refuse-eap” property of the setting


nm_setting_ppp_get_refuse_pap ()

gboolean
nm_setting_ppp_get_refuse_pap (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “refuse-pap” property of the setting


nm_setting_ppp_get_refuse_chap ()

gboolean
nm_setting_ppp_get_refuse_chap (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “refuse-chap” property of the setting


nm_setting_ppp_get_refuse_mschap ()

gboolean
nm_setting_ppp_get_refuse_mschap (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “refuse-mschap” property of the setting


nm_setting_ppp_get_refuse_mschapv2 ()

gboolean
nm_setting_ppp_get_refuse_mschapv2 (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “refuse-mschapv2” property of the setting


nm_setting_ppp_get_nobsdcomp ()

gboolean
nm_setting_ppp_get_nobsdcomp (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “nobsdcomp” property of the setting


nm_setting_ppp_get_nodeflate ()

gboolean
nm_setting_ppp_get_nodeflate (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “nodeflate” property of the setting


nm_setting_ppp_get_no_vj_comp ()

gboolean
nm_setting_ppp_get_no_vj_comp (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “no-vj-comp” property of the setting


nm_setting_ppp_get_require_mppe ()

gboolean
nm_setting_ppp_get_require_mppe (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “require-mppe” property of the setting


nm_setting_ppp_get_require_mppe_128 ()

gboolean
nm_setting_ppp_get_require_mppe_128 (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “require-mppe-128” property of the setting


nm_setting_ppp_get_mppe_stateful ()

gboolean
nm_setting_ppp_get_mppe_stateful (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “mppe-stateful” property of the setting


nm_setting_ppp_get_crtscts ()

gboolean
nm_setting_ppp_get_crtscts (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “crtscts” property of the setting


nm_setting_ppp_get_baud ()

guint32
nm_setting_ppp_get_baud (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “baud” property of the setting


nm_setting_ppp_get_mru ()

guint32
nm_setting_ppp_get_mru (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “mru” property of the setting


nm_setting_ppp_get_mtu ()

guint32
nm_setting_ppp_get_mtu (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “mtu” property of the setting


nm_setting_ppp_get_lcp_echo_failure ()

guint32
nm_setting_ppp_get_lcp_echo_failure (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “lcp-echo-failure” property of the setting


nm_setting_ppp_get_lcp_echo_interval ()

guint32
nm_setting_ppp_get_lcp_echo_interval (NMSettingPpp *setting);

Parameters

setting

the NMSettingPpp

 

Returns

the “lcp-echo-interval” property of the setting

Types and Values

NM_SETTING_PPP_SETTING_NAME

#define NM_SETTING_PPP_SETTING_NAME "ppp"

NM_SETTING_PPP_NOAUTH

#define NM_SETTING_PPP_NOAUTH            "noauth"

NM_SETTING_PPP_REFUSE_EAP

#define NM_SETTING_PPP_REFUSE_EAP        "refuse-eap"

NM_SETTING_PPP_REFUSE_PAP

#define NM_SETTING_PPP_REFUSE_PAP        "refuse-pap"

NM_SETTING_PPP_REFUSE_CHAP

#define NM_SETTING_PPP_REFUSE_CHAP       "refuse-chap"

NM_SETTING_PPP_REFUSE_MSCHAP

#define NM_SETTING_PPP_REFUSE_MSCHAP     "refuse-mschap"

NM_SETTING_PPP_REFUSE_MSCHAPV2

#define NM_SETTING_PPP_REFUSE_MSCHAPV2   "refuse-mschapv2"

NM_SETTING_PPP_NOBSDCOMP

#define NM_SETTING_PPP_NOBSDCOMP         "nobsdcomp"

NM_SETTING_PPP_NODEFLATE

#define NM_SETTING_PPP_NODEFLATE         "nodeflate"

NM_SETTING_PPP_NO_VJ_COMP

#define NM_SETTING_PPP_NO_VJ_COMP        "no-vj-comp"

NM_SETTING_PPP_REQUIRE_MPPE

#define NM_SETTING_PPP_REQUIRE_MPPE      "require-mppe"

NM_SETTING_PPP_REQUIRE_MPPE_128

#define NM_SETTING_PPP_REQUIRE_MPPE_128  "require-mppe-128"

NM_SETTING_PPP_MPPE_STATEFUL

#define NM_SETTING_PPP_MPPE_STATEFUL     "mppe-stateful"

NM_SETTING_PPP_CRTSCTS

#define NM_SETTING_PPP_CRTSCTS           "crtscts"

NM_SETTING_PPP_BAUD

#define NM_SETTING_PPP_BAUD              "baud"

NM_SETTING_PPP_MRU

#define NM_SETTING_PPP_MRU               "mru"

NM_SETTING_PPP_MTU

#define NM_SETTING_PPP_MTU               "mtu"

NM_SETTING_PPP_LCP_ECHO_FAILURE

#define NM_SETTING_PPP_LCP_ECHO_FAILURE  "lcp-echo-failure"

NM_SETTING_PPP_LCP_ECHO_INTERVAL

#define NM_SETTING_PPP_LCP_ECHO_INTERVAL "lcp-echo-interval"

NMSettingPpp

typedef struct _NMSettingPpp NMSettingPpp;

Point-to-Point Protocol Settings

Property Details

The “baud” property

  “baud”                     guint

If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.

Owner: NMSettingPpp

Flags: Read / Write

Default value: 0


The “crtscts” property

  “crtscts”                  gboolean

If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “lcp-echo-failure” property

  “lcp-echo-failure”         guint

If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.

Owner: NMSettingPpp

Flags: Read / Write

Default value: 0


The “lcp-echo-interval” property

  “lcp-echo-interval”        guint

If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.

Owner: NMSettingPpp

Flags: Read / Write

Default value: 0


The “mppe-stateful” property

  “mppe-stateful”            gboolean

If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “mru” property

  “mru”                      guint

If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.

Owner: NMSettingPpp

Flags: Read / Write

Allowed values: <= 16384

Default value: 0


The “mtu” property

  “mtu”                      guint

If non-zero, instruct pppd to send packets no larger than the specified size.

Owner: NMSettingPpp

Flags: Read / Write

Default value: 0


The “no-vj-comp” property

  “no-vj-comp”               gboolean

If TRUE, Van Jacobsen TCP header compression will not be requested.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “noauth” property

  “noauth”                   gboolean

If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.

Owner: NMSettingPpp

Flags: Read / Write

Default value: TRUE


The “nobsdcomp” property

  “nobsdcomp”                gboolean

If TRUE, BSD compression will not be requested.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “nodeflate” property

  “nodeflate”                gboolean

If TRUE, "deflate" compression will not be requested.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “refuse-chap” property

  “refuse-chap”              gboolean

If TRUE, the CHAP authentication method will not be used.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “refuse-eap” property

  “refuse-eap”               gboolean

If TRUE, the EAP authentication method will not be used.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “refuse-mschap” property

  “refuse-mschap”            gboolean

If TRUE, the MSCHAP authentication method will not be used.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “refuse-mschapv2” property

  “refuse-mschapv2”          gboolean

If TRUE, the MSCHAPv2 authentication method will not be used.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “refuse-pap” property

  “refuse-pap”               gboolean

If TRUE, the PAP authentication method will not be used.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “require-mppe” property

  “require-mppe”             gboolean

If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE


The “require-mppe-128” property

  “require-mppe-128”         gboolean

If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.

Owner: NMSettingPpp

Flags: Read / Write

Default value: FALSE