| libnm Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | ||||
#define NM_DBUS_PATH_VPN #define NM_DBUS_INTERFACE_VPN #define NM_DBUS_PATH_VPN_CONNECTION #define NM_DBUS_INTERFACE_VPN_CONNECTION #define NM_VPN_DBUS_PLUGIN_PATH #define NM_VPN_DBUS_PLUGIN_INTERFACE #define NM_DBUS_NO_ACTIVE_VPN_CONNECTION #define NM_DBUS_NO_VPN_CONNECTIONS #define NM_DBUS_INVALID_VPN_CONNECTION #define NM_DBUS_VPN_ERROR_PREFIX #define NM_DBUS_VPN_STARTING_IN_PROGRESS #define NM_DBUS_VPN_ALREADY_STARTED #define NM_DBUS_VPN_STOPPING_IN_PROGRESS #define NM_DBUS_VPN_ALREADY_STOPPED #define NM_DBUS_VPN_WRONG_STATE #define NM_DBUS_VPN_BAD_ARGUMENTS #define NM_DBUS_VPN_INTERACTIVE_NOT_SUPPORTED #define NM_DBUS_VPN_SIGNAL_LOGIN_BANNER #define NM_DBUS_VPN_SIGNAL_LOGIN_FAILED #define NM_DBUS_VPN_SIGNAL_LAUNCH_FAILED #define NM_DBUS_VPN_SIGNAL_CONNECT_FAILED #define NM_DBUS_VPN_SIGNAL_VPN_CONFIG_BAD #define NM_DBUS_VPN_SIGNAL_IP_CONFIG_BAD #define NM_DBUS_VPN_SIGNAL_STATE_CHANGE #define NM_DBUS_VPN_SIGNAL_IP4_CONFIG enum NMVpnServiceState; enum NMVpnConnectionState; enum NMVpnConnectionStateReason; enum NMVpnPluginFailure; #define NM_VPN_PLUGIN_CONFIG_TUNDEV #define NM_VPN_PLUGIN_CONFIG_BANNER #define NM_VPN_PLUGIN_CONFIG_EXT_GATEWAY #define NM_VPN_PLUGIN_CONFIG_MTU #define NM_VPN_PLUGIN_CONFIG_HAS_IP4 #define NM_VPN_PLUGIN_CONFIG_HAS_IP6 #define NM_VPN_PLUGIN_CAN_PERSIST #define NM_VPN_PLUGIN_IP4_CONFIG_INT_GATEWAY #define NM_VPN_PLUGIN_IP4_CONFIG_ADDRESS #define NM_VPN_PLUGIN_IP4_CONFIG_PTP #define NM_VPN_PLUGIN_IP4_CONFIG_PREFIX #define NM_VPN_PLUGIN_IP4_CONFIG_DNS #define NM_VPN_PLUGIN_IP4_CONFIG_NBNS #define NM_VPN_PLUGIN_IP4_CONFIG_MSS #define NM_VPN_PLUGIN_IP4_CONFIG_DOMAIN #define NM_VPN_PLUGIN_IP4_CONFIG_DOMAINS #define NM_VPN_PLUGIN_IP4_CONFIG_ROUTES #define NM_VPN_PLUGIN_IP4_CONFIG_NEVER_DEFAULT #define NM_VPN_PLUGIN_IP4_CONFIG_GATEWAY #define NM_VPN_PLUGIN_IP4_CONFIG_BANNER #define NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY #define NM_VPN_PLUGIN_IP4_CONFIG_MTU #define NM_VPN_PLUGIN_IP4_CONFIG_TUNDEV #define NM_VPN_PLUGIN_IP6_CONFIG_INT_GATEWAY #define NM_VPN_PLUGIN_IP6_CONFIG_ADDRESS #define NM_VPN_PLUGIN_IP6_CONFIG_PTP #define NM_VPN_PLUGIN_IP6_CONFIG_PREFIX #define NM_VPN_PLUGIN_IP6_CONFIG_DNS #define NM_VPN_PLUGIN_IP6_CONFIG_MSS #define NM_VPN_PLUGIN_IP6_CONFIG_DOMAIN #define NM_VPN_PLUGIN_IP6_CONFIG_DOMAINS #define NM_VPN_PLUGIN_IP6_CONFIG_ROUTES #define NM_VPN_PLUGIN_IP6_CONFIG_NEVER_DEFAULT
GEnum +----NMVpnServiceState
GEnum +----NMVpnConnectionState
GEnum +----NMVpnConnectionStateReason
GEnum +----NMVpnPluginFailure
#define NM_DBUS_PATH_VPN_CONNECTION "/org/freedesktop/NetworkManager/VPN/Connection"
#define NM_DBUS_INTERFACE_VPN_CONNECTION "org.freedesktop.NetworkManager.VPN.Connection"
#define NM_VPN_DBUS_PLUGIN_PATH "/org/freedesktop/NetworkManager/VPN/Plugin"
#define NM_VPN_DBUS_PLUGIN_INTERFACE "org.freedesktop.NetworkManager.VPN.Plugin"
#define NM_DBUS_NO_ACTIVE_VPN_CONNECTION "org.freedesktop.NetworkManager.VPNConnections.NoActiveVPNConnection"
#define NM_DBUS_NO_VPN_CONNECTIONS "org.freedesktop.NetworkManager.VPNConnections.NoVPNConnections"
#define NM_DBUS_INVALID_VPN_CONNECTION "org.freedesktop.NetworkManager.VPNConnections.InvalidVPNConnection"
#define NM_DBUS_VPN_ERROR_PREFIX "org.freedesktop.NetworkManager.VPN.Error"
#define NM_DBUS_VPN_INTERACTIVE_NOT_SUPPORTED "InteractiveNotSupported"
typedef enum {
NM_VPN_SERVICE_STATE_UNKNOWN = 0,
NM_VPN_SERVICE_STATE_INIT,
NM_VPN_SERVICE_STATE_SHUTDOWN,
NM_VPN_SERVICE_STATE_STARTING,
NM_VPN_SERVICE_STATE_STARTED,
NM_VPN_SERVICE_STATE_STOPPING,
NM_VPN_SERVICE_STATE_STOPPED
} NMVpnServiceState;
VPN daemon states
(Corresponds to the NM_VPN_SERVICE_STATE type in nm-vpn-connection.xml.)
| The state of the VPN plugin is unknown. | |
| The VPN plugin is initialized. | |
| Not used. | |
| The plugin is attempting to connect to a VPN server. | |
| The plugin has connected to a VPN server. | |
| The plugin is disconnecting from the VPN server. | |
| The plugin has disconnected from the VPN server. |
typedef enum {
NM_VPN_CONNECTION_STATE_UNKNOWN = 0,
NM_VPN_CONNECTION_STATE_PREPARE,
NM_VPN_CONNECTION_STATE_NEED_AUTH,
NM_VPN_CONNECTION_STATE_CONNECT,
NM_VPN_CONNECTION_STATE_IP_CONFIG_GET,
NM_VPN_CONNECTION_STATE_ACTIVATED,
NM_VPN_CONNECTION_STATE_FAILED,
NM_VPN_CONNECTION_STATE_DISCONNECTED
} NMVpnConnectionState;
VPN connection states
(Corresponds to the NM_VPN_CONNECTION_STATE type in nm-vpn-connection.xml.)
| The state of the VPN connection is unknown. | |
| The VPN connection is preparing to connect. | |
| The VPN connection needs authorization credentials. | |
| The VPN connection is being established. | |
| The VPN connection is getting an IP address. | |
| The VPN connection is active. | |
| The VPN connection failed. | |
| The VPN connection is disconnected. |
typedef enum {
NM_VPN_CONNECTION_STATE_REASON_UNKNOWN = 0,
NM_VPN_CONNECTION_STATE_REASON_NONE,
NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED,
NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED,
NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED,
NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID,
NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT,
NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT,
NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED,
NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS,
NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED,
NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED
} NMVpnConnectionStateReason;
VPN connection state reasons
(Corresponds to the NM_VPN_CONNECTION_STATE_REASON type in nm-vpn-connection.xml.)
| The reason for the VPN connection state change is unknown. | |
| No reason was given for the VPN connection state change. | |
| The VPN connection changed state because the user disconnected it. | |
| The VPN connection changed state because the device it was using was disconnected. | |
| The service providing the VPN connection was stopped. | |
| The IP config of the VPN connection was invalid. | |
| The connection attempt to the VPN service timed out. | |
| A timeout occurred while starting the service providing the VPN connection. | |
| Starting the service starting the service providing the VPN connection failed. | |
| Necessary secrets for the VPN connection were not provided. | |
| Authentication to the VPN server failed. | |
| The connection was deleted from settings. |
typedef enum {
NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED,
NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED,
NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG
} NMVpnPluginFailure;
VPN plugin failure reasons
(Corresponds to the NM_VPN_PLUGIN_FAILURE type in nm-vpn-plugin.xml.)
#define NM_VPN_PLUGIN_IP4_CONFIG_INT_GATEWAY "internal-gateway"
#define NM_VPN_PLUGIN_IP4_CONFIG_NEVER_DEFAULT "never-default"
#define NM_VPN_PLUGIN_IP4_CONFIG_GATEWAY NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY
#define NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY NM_VPN_PLUGIN_CONFIG_EXT_GATEWAY
#define NM_VPN_PLUGIN_IP6_CONFIG_INT_GATEWAY "internal-gateway"