|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
<html>
|
|
Packit |
5756e2 |
<head>
|
|
Packit |
5756e2 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
5756e2 |
<title>org.freedesktop.NetworkManager.VPN.Plugin: NetworkManager Reference Manual</title>
|
|
Packit |
5756e2 |
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
|
Packit |
5756e2 |
<link rel="home" href="index.html" title="NetworkManager Reference Manual">
|
|
Packit |
5756e2 |
<link rel="up" href="dbus-vpn-plugin.html" title="VPN services">
|
|
Packit |
5756e2 |
<link rel="prev" href="dbus-vpn-plugin.html" title="VPN services">
|
|
Packit |
5756e2 |
<link rel="next" href="dbus-vpn-types.html" title="Types">
|
|
Packit Service |
018b0a |
<meta name="generator" content="GTK-Doc V1.33.0 (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 |
Properties |
|
|
Packit |
5756e2 |
Signals
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
org.freedesktop.NetworkManager.VPN.Plugin
|
|
Packit |
5756e2 |
org.freedesktop.NetworkManager.VPN.Plugin — VPN Service
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Methods
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Connect (IN a{sa{sv}} connection);
|
|
Packit |
5756e2 |
ConnectInteractive (IN a{sa{sv}} connection,
|
|
Packit |
5756e2 |
IN a{sv} details);
|
|
Packit |
5756e2 |
NeedSecrets (IN a{sa{sv}} settings,
|
|
Packit |
5756e2 |
OUT s setting_name);
|
|
Packit |
5756e2 |
Disconnect ();
|
|
Packit |
5756e2 |
SetConfig (IN a{sv} config);
|
|
Packit |
5756e2 |
SetIp4Config (IN a{sv} config);
|
|
Packit |
5756e2 |
SetIp6Config (IN a{sv} config);
|
|
Packit |
5756e2 |
SetFailure (IN s reason);
|
|
Packit |
5756e2 |
NewSecrets (IN a{sa{sv}} connection);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Signals
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
StateChanged (u state);
|
|
Packit |
5756e2 |
SecretsRequired (s message,
|
|
Packit |
5756e2 |
as secrets);
|
|
Packit |
5756e2 |
Config (a{sv} config);
|
|
Packit |
5756e2 |
Ip4Config (a{sv} ip4config);
|
|
Packit |
5756e2 |
Ip6Config (a{sv} ip6config);
|
|
Packit |
5756e2 |
LoginBanner (s banner);
|
|
Packit |
5756e2 |
Failure (u reason);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Properties
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
State readable u
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Description
|
|
Packit |
5756e2 |
This interface is provided by plugins providing VPN services to the
|
|
Packit |
5756e2 |
NetworkManager daemon.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Method Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The Connect() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Connect (IN a{sa{sv}} connection);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Tells the plugin to connect. Interactive secrets requests (eg, emitting
|
|
Packit |
5756e2 |
the SecretsRequired signal) are not allowed.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sa{sv}} connection:
|
|
Packit |
5756e2 |
Describes the connection to be established.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The ConnectInteractive() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
ConnectInteractive (IN a{sa{sv}} connection,
|
|
Packit |
5756e2 |
IN a{sv} details);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Tells the plugin to connect, allowing interactive secrets requests (eg the
|
|
Packit |
5756e2 |
plugin is allowed to emit the SecretsRequired signal if the VPN service
|
|
Packit |
5756e2 |
indicates that it needs additional secrets during the connect process).
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sa{sv}} connection:
|
|
Packit |
5756e2 |
Describes the connection to be established.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sv} details:
|
|
Packit |
5756e2 |
Additional details about the Connect process.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The NeedSecrets() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NeedSecrets (IN a{sa{sv}} settings,
|
|
Packit |
5756e2 |
OUT s setting_name);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Asks the plugin whether the provided connection will require secrets to
|
|
Packit |
5756e2 |
connect successfully.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sa{sv}} settings:
|
|
Packit |
5756e2 |
Describes the connection that may need secrets.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
OUT s setting_name:
|
|
Packit |
5756e2 |
The setting name within the provided connection that requires secrets, if any.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The Disconnect() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Disconnect ();
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Disconnect the plugin.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The SetConfig() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
SetConfig (IN a{sv} config);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Set generic connection details on the connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sv} config:
|
|
Packit |
5756e2 |
Generic configuration details for the connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The SetIp4Config() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
SetIp4Config (IN a{sv} config);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Set IPv4 details on the connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sv} config:
|
|
Packit |
5756e2 |
Ip4Config details for the connection. You must call SetConfig() before calling this.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The SetIp6Config() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
SetIp6Config (IN a{sv} config);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Set IPv6 details on the connection.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sv} config:
|
|
Packit |
5756e2 |
Ip6Config details for the connection. You must call SetConfig() before calling this.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The SetFailure() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
SetFailure (IN s reason);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Indicate a failure to the plugin.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN s reason:
|
|
Packit |
5756e2 |
The reason for the failure.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The NewSecrets() method
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NewSecrets (IN a{sa{sv}} connection);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Called in response to a SecretsRequired signal to deliver updated secrets
|
|
Packit |
5756e2 |
or other information to the plugin.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
IN a{sa{sv}} connection:
|
|
Packit |
5756e2 |
Describes the connection including the new secrets.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Signal Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "StateChanged" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
StateChanged (u state);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Emitted when the plugin state changes.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
u state:
|
|
Packit |
5756e2 |
(NMVpnServiceState) The new state of the plugin.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "SecretsRequired" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
SecretsRequired (s message,
|
|
Packit |
5756e2 |
as secrets);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Emitted during an ongoing ConnectInteractive() request when the plugin has
|
|
Packit |
5756e2 |
determined that new secrets are required. NetworkManager will then call
|
|
Packit |
5756e2 |
the NewSecrets() method with a connection hash including the new secrets.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
s message:
|
|
Packit |
5756e2 |
Informational message, if any, about the request. For example, if a second PIN is required, could indicate to the user to wait for the token code to change until entering the next PIN.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
as secrets:
|
|
Packit |
5756e2 |
Array of strings of VPN secret names which the plugin thinks secrets may be required for, or other VPN-specific data to be processed by the VPN's front-end.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Config" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Config (a{sv} config);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The plugin obtained generic configuration information.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
a{sv} config:
|
|
Packit |
5756e2 |
The configuration information.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Ip4Config" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Ip4Config (a{sv} ip4config);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The plugin obtained an IPv4 configuration.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
a{sv} ip4config:
|
|
Packit |
5756e2 |
The IPv4 configuration.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Ip6Config" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Ip6Config (a{sv} ip6config);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The plugin obtained an IPv6 configuration.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
a{sv} ip6config:
|
|
Packit |
5756e2 |
The IPv6 configuration.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "LoginBanner" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
LoginBanner (s banner);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Emitted when the plugin receives a login banner from the VPN service.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
s banner:
|
|
Packit |
5756e2 |
The login banner string.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "Failure" signal
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Failure (u reason);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Emitted when a failure in the VPN plugin occurs.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
u reason:
|
|
Packit |
5756e2 |
(NMVpnPluginFailure) Reason code for the failure.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Property Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The "State" property
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
State readable u
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The state of the plugin.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns: NMVpnServiceState
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
018b0a |
Generated by GTK-Doc V1.33.0
|
|
Packit |
5756e2 |
</body>
|
|
Packit |
5756e2 |
</html>
|