NMSettingVpn

@@ -37,646 +31,814 @@

NMSettingVpn

NMSettingVpn — Describes connection properties for Virtual Private Networks

- +

Synopsis

#define             NM_SETTING_VPN_SETTING_NAME
-#define             NM_SETTING_VPN_SERVICE_TYPE
-#define             NM_SETTING_VPN_USER_NAME
-#define             NM_SETTING_VPN_PERSISTENT
-#define             NM_SETTING_VPN_DATA
-#define             NM_SETTING_VPN_SECRETS
-struct              NMSettingVpn;
-                    NMSettingVpnClass;
-void                (*NMVpnIterFunc)                    (const char *key,
-                                                         const char *value,
-                                                         gpointer user_data);
-NMSetting *         nm_setting_vpn_new                  (void);
-const char *        nm_setting_vpn_get_service_type     (NMSettingVpn *setting);
-const char *        nm_setting_vpn_get_user_name        (NMSettingVpn *setting);
-gboolean            nm_setting_vpn_get_persistent       (NMSettingVpn *setting);
-guint32             nm_setting_vpn_get_num_data_items   (NMSettingVpn *setting);
-void                nm_setting_vpn_add_data_item        (NMSettingVpn *setting,
-                                                         const char *key,
-                                                         const char *item);
-const char *        nm_setting_vpn_get_data_item        (NMSettingVpn *setting,
-                                                         const char *key);
-gboolean            nm_setting_vpn_remove_data_item     (NMSettingVpn *setting,
-                                                         const char *key);
-void                nm_setting_vpn_foreach_data_item    (NMSettingVpn *setting,
-                                                         NMVpnIterFunc func,
-                                                         gpointer user_data);
-guint32             nm_setting_vpn_get_num_secrets      (NMSettingVpn *setting);
-void                nm_setting_vpn_add_secret           (NMSettingVpn *setting,
-                                                         const char *key,
-                                                         const char *secret);
-const char *        nm_setting_vpn_get_secret           (NMSettingVpn *setting,
-                                                         const char *key);
-gboolean            nm_setting_vpn_remove_secret        (NMSettingVpn *setting,
-                                                         const char *key);
-void                nm_setting_vpn_foreach_secret       (NMSettingVpn *setting,
-                                                         NMVpnIterFunc func,
-                                                         gpointer user_data);
-

Object Hierarchy

-  GObject
-   +----NMSetting
-         +----NMSettingVpn
-

Functions

++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+void +	+(*NMVpnIterFunc) () +
+NMSetting * +	+nm_setting_vpn_new () +
const char * +	+nm_setting_vpn_get_service_type () +
const char * +	+nm_setting_vpn_get_user_name () +
+gboolean +	+nm_setting_vpn_get_persistent () +
+guint32 +	+nm_setting_vpn_get_num_data_items () +
+void +	+nm_setting_vpn_add_data_item () +
const char * +	+nm_setting_vpn_get_data_item () +
+gboolean +	+nm_setting_vpn_remove_data_item () +
+void +	+nm_setting_vpn_foreach_data_item () +
+guint32 +	+nm_setting_vpn_get_num_secrets () +
+void +	+nm_setting_vpn_add_secret () +
const char * +	+nm_setting_vpn_get_secret () +
+gboolean +	+nm_setting_vpn_remove_secret () +
+void +	+nm_setting_vpn_foreach_secret () +

Properties

-  "data"                     GHashTable*           : Read / Write
-  "persistent"               gboolean              : Read / Write
-  "secrets"                  GHashTable*           : Read / Write
-  "service-type"             gchar*                : Read / Write
-  "user-name"                gchar*                : Read / Write
+
+++++
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+




+GHashTable * data Read / Write
gboolean persistent Read / Write

+GHashTable * secrets Read / Write

+gchar * service-type Read / Write

+gchar * user-name Read / Write
+

Types and Values

++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +

#define	NM_SETTING_VPN_SETTING_NAME
#define	NM_SETTING_VPN_SERVICE_TYPE
#define	NM_SETTING_VPN_USER_NAME
#define	NM_SETTING_VPN_PERSISTENT
#define	NM_SETTING_VPN_DATA
#define	NM_SETTING_VPN_SECRETS

Object Hierarchy

    GObject
+    ╰── NMSetting
+        ╰── NMSettingVpn

Description

-The NMSettingVpn object is a NMSetting subclass that describes properties +

The NMSettingVpn object is a NMSetting subclass that describes properties necessary for connection to Virtual Private Networks. NetworkManager uses a plugin architecture to allow easier use of new VPN types, and this setting abstracts the configuration for those plugins. Since the configuration options are only known to the VPN plugins themselves, the VPN configuration options are stored as key/value pairs of strings rather than GObject -properties. -

+properties.

Details

NM_SETTING_VPN_SETTING_NAME

#define NM_SETTING_VPN_SETTING_NAME "vpn"
-

NM_SETTING_VPN_SERVICE_TYPE

#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
-

NM_SETTING_VPN_USER_NAME

#define NM_SETTING_VPN_USER_NAME    "user-name"
-

NM_SETTING_VPN_PERSISTENT

#define NM_SETTING_VPN_PERSISTENT   "persistent"
-

NM_SETTING_VPN_DATA

#define NM_SETTING_VPN_DATA         "data"
-

NM_SETTING_VPN_SECRETS

#define NM_SETTING_VPN_SECRETS      "secrets"
-

struct NMSettingVpn

struct NMSettingVpn;

NMSettingVpnClass

typedef struct {
-	NMSettingClass parent;
-} NMSettingVpnClass;
-

Functions

NMVpnIterFunc ()

void                (*NMVpnIterFunc)                    (const char *key,
-                                                         const char *value,
-                                                         gpointer user_data);

NMVpnIterFunc ()

void
+(*NMVpnIterFunc) (const char *key,
+                  const char *value,
+                  gpointer user_data);

Parameters

--+++ - - + + + - - + + + - - + + +

`key` :	the name of the data or secret item	key	the name of the data or secret item
`value` :	the value of the data or secret item	value	the value of the data or secret item
`user_data` :	User data passed to `nm_setting_vpn_foreach_data_item()` or -`nm_setting_vpn_foreach_secret()` -	user_data	User data passed to `nm_setting_vpn_foreach_data_item()` or +`nm_setting_vpn_foreach_secret()`

nm_setting_vpn_new ()

NMSetting *         nm_setting_vpn_new                  (void);

-Creates a new NMSettingVpn object with default values. -

---- - - - - -

Returns :

the new empty NMSettingVpn object. [transfer full] -

nm_setting_vpn_new ()

NMSetting *
+nm_setting_vpn_new (void);

Creates a new NMSettingVpn object with default values.

Returns

the new empty NMSettingVpn object.

[transfer full]

nm_setting_vpn_get_service_type ()

const char *        nm_setting_vpn_get_service_type     (NMSettingVpn *setting);

-Returns the service name of the VPN, which identifies the specific VPN -plugin that should be used to connect to this VPN. -

nm_setting_vpn_get_service_type ()

const char *
+nm_setting_vpn_get_service_type (NMSettingVpn *setting);

Returns the service name of the VPN, which identifies the specific VPN +plugin that should be used to connect to this VPN.

Parameters

--+++ - - - - - - - - - - + + + + +

`setting` :	the NMSettingVpn -
Returns :	the VPN plugin's service name
setting	the NMSettingVpn

Returns

the VPN plugin's service name

nm_setting_vpn_add_data_item ()

void                nm_setting_vpn_add_data_item        (NMSettingVpn *setting,
-                                                         const char *key,
-                                                         const char *item);

-Establishes a relationship between key and item internally in the +

nm_setting_vpn_add_data_item ()

void
+nm_setting_vpn_add_data_item (NMSettingVpn *setting,
+                              const char *key,
+                              const char *item);

Establishes a relationship between key + and item + internally in the setting which may be retrieved later. Should not be used to store passwords -or other secrets, which is what nm_setting_vpn_add_secret() is for. -

+or other secrets, which is what nm_setting_vpn_add_secret() is for.

Parameters

--+++ - - + + + - - + + + - - + + +

`setting` :	the NMSettingVpn -	setting	the NMSettingVpn
`key` :	a name that uniquely identifies the given value `item` -	key	a name that uniquely identifies the given value `item` +
`item` :	the value to be referenced by `key` -	item	the value to be referenced by `key` +

nm_setting_vpn_foreach_data_item ()

void                nm_setting_vpn_foreach_data_item    (NMSettingVpn *setting,
-                                                         NMVpnIterFunc func,
-                                                         gpointer user_data);

-Iterates all data items stored in this setting. It is safe to add, remove, -and modify data items inside func, though any additions or removals made -during iteration will not be part of the iteration. -

nm_setting_vpn_foreach_data_item ()

void
+nm_setting_vpn_foreach_data_item (NMSettingVpn *setting,
+                                  NMVpnIterFunc func,
+                                  gpointer user_data);

Iterates all data items stored in this setting. It is safe to add, remove, +and modify data items inside func +, though any additions or removals made +during iteration will not be part of the iteration.

Parameters

--+++ - - + + + - - + + + - - + + +

`setting` :	a NMSettingVpn -	setting	a NMSettingVpn
`func` :	an user provided function. [scope call] -	func	an user provided function.	[scope call]
`user_data` :	data to be passed to `func` -	user_data	data to be passed to `func` +

nm_setting_vpn_add_secret ()

void                nm_setting_vpn_add_secret           (NMSettingVpn *setting,
-                                                         const char *key,
-                                                         const char *secret);

-Establishes a relationship between key and secret internally in the -setting which may be retrieved later. -

nm_setting_vpn_add_secret ()

void
+nm_setting_vpn_add_secret (NMSettingVpn *setting,
+                           const char *key,
+                           const char *secret);

Establishes a relationship between key + and secret + internally in the +setting which may be retrieved later.

Parameters

--+++ - - + + + - - + + + - - + + +

`setting` :	the NMSettingVpn -	setting	the NMSettingVpn
`key` :	a name that uniquely identifies the given secret `secret` -	key	a name that uniquely identifies the given secret `secret` +
`secret` :	the secret to be referenced by `key` -	secret	the secret to be referenced by `key` +

nm_setting_vpn_foreach_secret ()

void                nm_setting_vpn_foreach_secret       (NMSettingVpn *setting,
-                                                         NMVpnIterFunc func,
-                                                         gpointer user_data);

-Iterates all secrets stored in this setting. It is safe to add, remove, -and modify secrets inside func, though any additions or removals made during -iteration will not be part of the iteration. -

nm_setting_vpn_foreach_secret ()

void
+nm_setting_vpn_foreach_secret (NMSettingVpn *setting,
+                               NMVpnIterFunc func,
+                               gpointer user_data);

Iterates all secrets stored in this setting. It is safe to add, remove, +and modify secrets inside func +, though any additions or removals made during +iteration will not be part of the iteration.

Parameters

--+++ - - + + + - - + + + - - + + +

`setting` :	a NMSettingVpn -	setting	a NMSettingVpn
`func` :	an user provided function. [scope call] -	func	an user provided function.	[scope call]
`user_data` :	data to be passed to `func` -	user_data	data to be passed to `func` +

Property Details

Types and Values

The `"data"` property

  "data"                     GHashTable*           : Read / Write

NM_SETTING_VPN_SETTING_NAME

#define NM_SETTING_VPN_SETTING_NAME "vpn"
+

-Dictionary of key/value pairs of VPN plugin specific data. Both keys and -values must be strings.

NM_SETTING_VPN_SERVICE_TYPE

#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
+

-Type: GHashTable(utf8,utf8)

The `"persistent"` property

  "persistent"               gboolean              : Read / Write

NM_SETTING_VPN_USER_NAME

#define NM_SETTING_VPN_USER_NAME    "user-name"
+

-If the VPN service supports persistence, and this property is TRUE, -the VPN will attempt to stay connected across link changes and outages, -until explicitly disconnected.

Default value: FALSE

The `"secrets"` property

  "secrets"                  GHashTable*           : Read / Write

NM_SETTING_VPN_PERSISTENT

#define NM_SETTING_VPN_PERSISTENT   "persistent"
+

-Dictionary of key/value pairs of VPN plugin specific secrets like -passwords or private keys. Both keys and values must be strings.

NM_SETTING_VPN_DATA

#define NM_SETTING_VPN_DATA         "data"
+

-Type: GHashTable(utf8,utf8)

The `"service-type"` property

  "service-type"             gchar*                : Read / Write

NM_SETTING_VPN_SECRETS

#define NM_SETTING_VPN_SECRETS      "secrets"
+

-D-Bus service name of the VPN plugin that this setting uses to connect to -its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc -plugin.

			libnm Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Properties -

+GHashTable *	data	Read / Write
gboolean	persistent	Read / Write
+GHashTable *	secrets	Read / Write
+gchar *	service-type	Read / Write
+gchar *	user-name	Read / Write

NMSettingVpn

Synopsis

Object Hierarchy

Functions

Properties

Types and Values

Object Hierarchy

Description

Details

NM_SETTING_VPN_SETTING_NAME

NM_SETTING_VPN_SERVICE_TYPE

NM_SETTING_VPN_USER_NAME

NM_SETTING_VPN_PERSISTENT

NM_SETTING_VPN_DATA

NM_SETTING_VPN_SECRETS

struct NMSettingVpn

NMSettingVpnClass

Functions

NMVpnIterFunc ()

NMVpnIterFunc ()

Parameters

nm_setting_vpn_new ()

nm_setting_vpn_new ()

Returns

nm_setting_vpn_get_service_type ()

nm_setting_vpn_get_service_type ()

Parameters

Returns

nm_setting_vpn_get_user_name ()

nm_setting_vpn_get_user_name ()

Parameters

Returns

nm_setting_vpn_get_persistent ()

nm_setting_vpn_get_persistent ()

Parameters

Returns

nm_setting_vpn_get_num_data_items ()

nm_setting_vpn_get_num_data_items ()

Parameters

Returns

nm_setting_vpn_add_data_item ()

nm_setting_vpn_add_data_item ()

Parameters

nm_setting_vpn_get_data_item ()

nm_setting_vpn_get_data_item ()

Parameters

Returns

nm_setting_vpn_remove_data_item ()

nm_setting_vpn_remove_data_item ()

Parameters

Returns

nm_setting_vpn_foreach_data_item ()

nm_setting_vpn_foreach_data_item ()

Parameters

nm_setting_vpn_get_num_secrets ()

nm_setting_vpn_get_num_secrets ()

Parameters

Returns

nm_setting_vpn_add_secret ()

nm_setting_vpn_add_secret ()

Parameters

nm_setting_vpn_get_secret ()

nm_setting_vpn_get_secret ()

Parameters

Returns

nm_setting_vpn_remove_secret ()

nm_setting_vpn_remove_secret ()

Parameters

Returns

nm_setting_vpn_foreach_secret ()

nm_setting_vpn_foreach_secret ()

Parameters

Property Details

Types and Values

The "data" property

NM_SETTING_VPN_SETTING_NAME

NM_SETTING_VPN_SERVICE_TYPE

The "persistent" property

NM_SETTING_VPN_USER_NAME

The "secrets" property

The `"data"` property

The `"persistent"` property

The `"secrets"` property

The `"service-type"` property

The `“data”` property

The `“persistent”` property

The `“secrets”` property

The `“service-type”` property

The `"user-name"` property

The `“user-name”` property