Blame docs/libnm/html/NMSettingPppoe.html

Packit 5756e2
Packit 5756e2
<html>
Packit 5756e2
<head>
Packit 5756e2
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 5756e2
<title>NMSettingPppoe: libnm Reference Manual</title>
Packit 5756e2
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 5756e2
<link rel="home" href="index.html" title="libnm Reference Manual">
Packit 5756e2
<link rel="up" href="ch03.html" title="Connection and Setting API Reference">
Packit 5756e2
<link rel="prev" href="NMSettingPpp.html" title="NMSettingPpp">
Packit 5756e2
<link rel="next" href="NMSettingProxy.html" title="NMSettingProxy">
Packit Service 5ffa24
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
Packit 5756e2
<link rel="stylesheet" href="style.css" type="text/css">
Packit 5756e2
</head>
Packit 5756e2
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 5756e2
Packit 5756e2
Packit 5756e2
Top  | 
Packit 5756e2
                  Description  | 
Packit 5756e2
                  Object Hierarchy  | 
Packit 5756e2
                  Properties
Packit 5756e2
Packit 5756e2
Home
Packit 5756e2
Up
Packit 5756e2
Prev
Packit 5756e2
Next
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

NMSettingPppoe

Packit 5756e2

NMSettingPppoe — Describes PPPoE connection properties

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Functions

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
NMSetting *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_pppoe_new ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
const char *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_pppoe_get_parent ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
const char *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_pppoe_get_service ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
const char *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_pppoe_get_username ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
const char *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_pppoe_get_password ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
NMSettingSecretFlags
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_setting_pppoe_get_password_flags ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Properties

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service a1bd4f
char *
Packit 5756e2
parent
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service a1bd4f
char *
Packit 5756e2
password
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
NMSettingSecretFlags
Packit 5756e2
password-flags
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service a1bd4f
char *
Packit 5756e2
service
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service a1bd4f
char *
Packit 5756e2
username
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Types and Values

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_PPPOE_SETTING_NAME
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_PPPOE_PARENT
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_PPPOE_SERVICE
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_PPPOE_USERNAME
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_PPPOE_PASSWORD
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_SETTING_PPPOE_PASSWORD_FLAGS
Packit 5756e2
Packit 5756e2
Packit 5756e2
 
Packit 5756e2
NMSettingPppoe
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Object Hierarchy

Packit 5756e2
    GObject
Packit 5756e2
    ╰── NMSetting
Packit 5756e2
        ╰── NMSettingPppoe
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Description

Packit 5756e2

The NMSettingPppoe object is a NMSetting subclass that describes

Packit 5756e2
properties necessary for connection to networks that require PPPoE connections
Packit 5756e2
to provide IP transport, for example cable or DSL modems.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Functions

Packit 5756e2
Packit 5756e2

nm_setting_pppoe_new ()

Packit 5756e2
NMSetting *
Packit 5756e2
nm_setting_pppoe_new (void);
Packit 5756e2

Creates a new NMSettingPppoe object with default values.

Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the new empty NMSettingPppoe object.

Packit Service 5ffa24

[transfer full]

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_pppoe_get_parent ()

Packit 5756e2
const char *
Packit 5756e2
nm_setting_pppoe_get_parent (NMSettingPppoe *setting);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingPppoe

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the “parent” property of the setting

Packit 5756e2
Packit 5756e2

Since: 1.10

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_pppoe_get_service ()

Packit 5756e2
const char *
Packit 5756e2
nm_setting_pppoe_get_service (NMSettingPppoe *setting);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingPppoe

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the “service” property of the setting

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_pppoe_get_username ()

Packit 5756e2
const char *
Packit 5756e2
nm_setting_pppoe_get_username (NMSettingPppoe *setting);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingPppoe

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the “username” property of the setting

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_pppoe_get_password ()

Packit 5756e2
const char *
Packit 5756e2
nm_setting_pppoe_get_password (NMSettingPppoe *setting);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingPppoe

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the “password” property of the setting

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_setting_pppoe_get_password_flags ()

Packit 5756e2
NMSettingSecretFlags
Packit 5756e2
nm_setting_pppoe_get_password_flags (NMSettingPppoe *setting);
Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

setting

Packit 5756e2

the NMSettingPppoe

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the NMSettingSecretFlags pertaining to the “password”

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Types and Values

Packit 5756e2
Packit 5756e2

NM_SETTING_PPPOE_SETTING_NAME

Packit 5756e2
#define NM_SETTING_PPPOE_SETTING_NAME "pppoe"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_PPPOE_PARENT

Packit 5756e2
#define NM_SETTING_PPPOE_PARENT         "parent"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_PPPOE_SERVICE

Packit 5756e2
#define NM_SETTING_PPPOE_SERVICE        "service"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_PPPOE_USERNAME

Packit 5756e2
#define NM_SETTING_PPPOE_USERNAME       "username"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_PPPOE_PASSWORD

Packit 5756e2
#define NM_SETTING_PPPOE_PASSWORD       "password"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_SETTING_PPPOE_PASSWORD_FLAGS

Packit 5756e2
#define NM_SETTING_PPPOE_PASSWORD_FLAGS "password-flags"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NMSettingPppoe

Packit 5756e2
typedef struct _NMSettingPppoe NMSettingPppoe;
Packit 5756e2

PPP-over-Ethernet Settings

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Property Details

Packit 5756e2
Packit 5756e2

The “parent” property

Packit Service a1bd4f
  “parent”                   char *
Packit 5756e2

If given, specifies the parent interface name on which this PPPoE

Packit 5756e2
connection should be created.  If this property is not specified,
Packit 5756e2
the connection is activated on the interface specified in
Packit 5756e2
“interface-name” of NMSettingConnection.

Packit 5756e2

Owner: NMSettingPppoe

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: NULL

Packit 5756e2

Since: 1.10

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “password” property

Packit Service a1bd4f
  “password”                 char *
Packit 5756e2

Password used to authenticate with the PPPoE service.

Packit 5756e2

Owner: NMSettingPppoe

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: NULL

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “password-flags” property

Packit 5756e2
  “password-flags”           NMSettingSecretFlags
Packit 5756e2

Flags indicating how to handle the “password” property.

Packit 5756e2

Owner: NMSettingPppoe

Packit 5756e2

Flags: Read / Write

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “service” property

Packit Service a1bd4f
  “service”                  char *
Packit 5756e2

If specified, instruct PPPoE to only initiate sessions with access

Packit 5756e2
concentrators that provide the specified service.  For most providers,
Packit 5756e2
this should be left blank.  It is only required if there are multiple
Packit 5756e2
access concentrators or a specific service is known to be required.

Packit 5756e2

Owner: NMSettingPppoe

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: NULL

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “username” property

Packit Service a1bd4f
  “username”                 char *
Packit 5756e2

Username used to authenticate with the PPPoE service.

Packit 5756e2

Owner: NMSettingPppoe

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: NULL

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service 5ffa24

Generated by GTK-Doc V1.33.1
Packit 5756e2
</body>
Packit 5756e2
</html>