<?xml version='1.0'?>
<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<refentry id="nm-vpn-dbus-types">
  <refmeta>
    <refentrytitle role="top_of_page" id="nm-vpn-dbus-types.top_of_page">VPN Plugin D-Bus API Types</refentrytitle>
    <manvolnum>3</manvolnum>
    <refmiscinfo>VPN Plugin D-Bus API Types</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>VPN Plugin D-Bus API Types</refname>
    <refpurpose></refpurpose>
  </refnamediv>

  <refsect2 id="NMVpnServiceState" role="enum">
    <title>enum NMVpnServiceState</title>
    <indexterm zone="NMVpnServiceState">
      <primary>NMVpnServiceState</primary>
    </indexterm>
    <para><para>VPN daemon states</para><para></para></para>
    <refsect3 role="enum_members">
      <title>Values</title>
      <informaltable role="enum_members_table" pgwide="1" frame="none">
        <tgroup cols="4">
          <colspec colname="enum_members_name" colwidth="300px" />
          <colspec colname="enum_members_value" colwidth="100px"/>
          <colspec colname="enum_members_description" />
          <tbody>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_SERVICE_STATE_UNKNOWN</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>0</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The state of the VPN plugin is unknown.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_SERVICE_STATE_INIT</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>1</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN plugin is initialized.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_SERVICE_STATE_SHUTDOWN</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>2</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>Not used.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_SERVICE_STATE_STARTING</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>3</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The plugin is attempting to connect to a VPN server.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_SERVICE_STATE_STARTED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>4</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The plugin has connected to a VPN server.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_SERVICE_STATE_STOPPING</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>5</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The plugin is disconnecting from the VPN server.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_SERVICE_STATE_STOPPED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>6</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The plugin has disconnected from the VPN server.</para><para></para></entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
    </refsect3>
  </refsect2>

  <refsect2 id="NMVpnConnectionState" role="enum">
    <title>enum NMVpnConnectionState</title>
    <indexterm zone="NMVpnConnectionState">
      <primary>NMVpnConnectionState</primary>
    </indexterm>
    <para><para>VPN connection states</para><para></para></para>
    <refsect3 role="enum_members">
      <title>Values</title>
      <informaltable role="enum_members_table" pgwide="1" frame="none">
        <tgroup cols="4">
          <colspec colname="enum_members_name" colwidth="300px" />
          <colspec colname="enum_members_value" colwidth="100px"/>
          <colspec colname="enum_members_description" />
          <tbody>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_UNKNOWN</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>0</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The state of the VPN connection is unknown.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_PREPARE</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>1</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN connection is preparing to connect.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_NEED_AUTH</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>2</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN connection needs authorization credentials.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_CONNECT</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>3</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN connection is being established.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_IP_CONFIG_GET</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>4</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN connection is getting an IP address.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_ACTIVATED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>5</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN connection is active.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_FAILED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>6</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN connection failed.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_DISCONNECTED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>7</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN connection is disconnected.</para><para></para></entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
    </refsect3>
  </refsect2>

  <refsect2 id="NMVpnConnectionStateReason" role="enum">
    <title>enum NMVpnConnectionStateReason</title>
    <indexterm zone="NMVpnConnectionStateReason">
      <primary>NMVpnConnectionStateReason</primary>
    </indexterm>
    <para><para>VPN connection state reasons</para><para></para></para>
    <refsect3 role="enum_members">
      <title>Values</title>
      <informaltable role="enum_members_table" pgwide="1" frame="none">
        <tgroup cols="4">
          <colspec colname="enum_members_name" colwidth="300px" />
          <colspec colname="enum_members_value" colwidth="100px"/>
          <colspec colname="enum_members_description" />
          <tbody>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_UNKNOWN</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>0</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The reason for the VPN connection state change is unknown.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_NONE</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>1</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>No reason was given for the VPN connection state change.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_USER_DISCONNECTED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>2</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN connection changed state because the user disconnected it.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_DEVICE_DISCONNECTED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>3</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The VPN connection changed state because the device it was using was disconnected.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_SERVICE_STOPPED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>4</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The service providing the VPN connection was stopped.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_IP_CONFIG_INVALID</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>5</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The IP config of the VPN connection was invalid.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_CONNECT_TIMEOUT</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>6</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The connection attempt to the VPN service timed out.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_TIMEOUT</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>7</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>A timeout occurred while starting the service providing the VPN connection.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_SERVICE_START_FAILED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>8</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>Starting the service starting the service providing the VPN connection failed.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_NO_SECRETS</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>9</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>Necessary secrets for the VPN connection were not provided.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_LOGIN_FAILED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>10</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>Authentication to the VPN server failed.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_CONNECTION_STATE_REASON_CONNECTION_REMOVED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>11</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>The connection was deleted from settings.</para><para></para></entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
    </refsect3>
  </refsect2>

  <refsect2 id="NMVpnPluginFailure" role="enum">
    <title>enum NMVpnPluginFailure</title>
    <indexterm zone="NMVpnPluginFailure">
      <primary>NMVpnPluginFailure</primary>
    </indexterm>
    <para><para>VPN plugin failure reasons</para><para></para></para>
    <refsect3 role="enum_members">
      <title>Values</title>
      <informaltable role="enum_members_table" pgwide="1" frame="none">
        <tgroup cols="4">
          <colspec colname="enum_members_name" colwidth="300px" />
          <colspec colname="enum_members_value" colwidth="100px"/>
          <colspec colname="enum_members_description" />
          <tbody>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>0</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>Login failed.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_PLUGIN_FAILURE_CONNECT_FAILED</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>1</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>Connect failed.</para><para></para></entry>
            </row>
            <row role="constant">
              <entry role="enum_member_name"><para>NM_VPN_PLUGIN_FAILURE_BAD_IP_CONFIG</para><para></para></entry>
              <entry role="enum_member_value"><para>= <literal>2</literal></para><para></para></entry>
              <entry role="enum_member_description"><para>Invalid IP configuration returned from the VPN plugin.</para><para></para></entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
    </refsect3>
  </refsect2>

</refentry>