public class

VpnAdminProfile

extends Object
implements Parcelable
java.lang.Object
   ↳ com.samsung.android.knox.net.vpn.VpnAdminProfile

Deprecated From API level 30 on, please refer to GenericVpnPolicy for VPN profile configuration.

Class Overview

This class contains information required to set up an Android VPN profile on the device. When creating a VPN profile of a particular type, leave fields associated with other types blank.

Since
API level 2
MDM 2.0

Summary

Constants
String VPN_TYPE_IPSEC_HYBRID_RSA VPN type to be used to fill up the vpnType field when creating a IPSEC_HYBRID_RSA profile
String VPN_TYPE_IPSEC_IKEV2_PSK VPN type to be used to fill up the vpnType field when creating a IPSEC_IKEV2_PSK profile
String VPN_TYPE_IPSEC_IKEV2_RSA VPN type to be used to fill up the vpnType field when creating a IPSEC_IKEV2_RSA profile
String VPN_TYPE_IPSEC_XAUTH_PSK VPN type to be used to fill up the vpnType field when creating a IPSEC_XAUTH_PSK profile
String VPN_TYPE_IPSEC_XAUTH_RSA VPN type to be used to fill up the vpnType field when creating a IPSEC_XAUTH_RSA profile
String VPN_TYPE_L2TP_IPSEC_CRT VPN type to be used to fill up the vpnType field when creating a L2TP-IPSEC-CRT profile.
String VPN_TYPE_L2TP_IPSEC_PSK VPN type to be used to fill up the vpnType field when creating a L2TP-IPSEC-PSK VPN profile
String VPN_TYPE_PPTP VPN type to be used to fill up the vpnType field when creating a PPTP VPN profile
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public List<String> dnsServers DNS server addresses of the VPN profile.
public boolean enablePPTPEncryption Enable the encryption for PPTP profile
public List<String> forwardRoutes Forward routes of the VPN profile.
public String ipsecCaCertificate Name of the CA certificate to be used in a L2TP-IPSEC-CRT profile.
public String ipsecIdentifier IPSec identifier of the VPN profile.
public String ipsecPreSharedKey Pre-shared key to be used in a L2TP-IPSEC-PSK profile
public String ipsecUserCertificate Name of the User certificate to be used in a L2TP-IPSEC-CRT profile.
public String l2tpSecret Secret to be used in a L2TP profile
public String ocspServerUrl Online Certificate Status Protocol (OCSP) URL of the VPN profile.
public String profileName User-friendly display name of the VPN profile
public List<String> searchDomains DNS search domains of the VPN profile.
public String serverName VPN server hostname
public String userName Username used for login
public String userPassword Password used for login
public String vpnType One of VPN_TYPE_PPTP VPN_TYPE_L2TP_IPSEC_PSK, or VPN_TYPE_L2TP_IPSEC_CRT
Public Constructors
VpnAdminProfile()
Default Constructor
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Constants

public static final String VPN_TYPE_IPSEC_HYBRID_RSA

Since: API level 5

VPN type to be used to fill up the vpnType field when creating a IPSEC_HYBRID_RSA profile

Since
API level 5
MDM 3.0
Constant Value: "IPSEC_HYBRID_RSA"

public static final String VPN_TYPE_IPSEC_IKEV2_PSK

Since: API level 11

VPN type to be used to fill up the vpnType field when creating a IPSEC_IKEV2_PSK profile

Since
API level 11
MDM 5.0
Constant Value: "IPSEC_IKEV2_PSK"

public static final String VPN_TYPE_IPSEC_IKEV2_RSA

Since: API level 11

VPN type to be used to fill up the vpnType field when creating a IPSEC_IKEV2_RSA profile

Since
API level 11
MDM 5.0
Constant Value: "IPSEC_IKEV2_RSA"

public static final String VPN_TYPE_IPSEC_XAUTH_PSK

Since: API level 5

VPN type to be used to fill up the vpnType field when creating a IPSEC_XAUTH_PSK profile

Since
API level 5
MDM 3.0
Constant Value: "IPSEC_XAUTH_PSK"

public static final String VPN_TYPE_IPSEC_XAUTH_RSA

Since: API level 5

VPN type to be used to fill up the vpnType field when creating a IPSEC_XAUTH_RSA profile

Since
API level 5
MDM 3.0
Constant Value: "IPSEC_XAUTH_RSA"

public static final String VPN_TYPE_L2TP_IPSEC_CRT

Since: API level 2

VPN type to be used to fill up the vpnType field when creating a L2TP-IPSEC-CRT profile.

NOTE:
Android has been handling vpnType L2TP-IPSEC-RSA as L2TP-IPSEC-CRT

Since
API level 2
MDM 2.0
Constant Value: "L2TP_IPSEC"

public static final String VPN_TYPE_L2TP_IPSEC_PSK

Since: API level 2

VPN type to be used to fill up the vpnType field when creating a L2TP-IPSEC-PSK VPN profile

Since
API level 2
MDM 2.0
Constant Value: "L2TP_IPSEC_PSK"

public static final String VPN_TYPE_PPTP

Since: API level 2

VPN type to be used to fill up the vpnType field when creating a PPTP VPN profile

Since
API level 2
MDM 2.0
Constant Value: "PPTP"

Fields

public List<String> dnsServers

Since: API level 5

DNS server addresses of the VPN profile.

Since
API level 5
MDM 3.0

public boolean enablePPTPEncryption

Since: API level 2

Enable the encryption for PPTP profile

Since
API level 2
MDM 2.0

public List<String> forwardRoutes

Since: API level 5

Forward routes of the VPN profile.

Since
API level 5
MDM 3.0

public String ipsecCaCertificate

Since: API level 2

Name of the CA certificate to be used in a L2TP-IPSEC-CRT profile. This certificate is picked up from the Android Keystore, hence this certificate must be installed on the device for the VPN connection to function properly.

Since
API level 2
MDM 2.0

public String ipsecIdentifier

Since: API level 5

IPSec identifier of the VPN profile.

Since
API level 5
MDM 3.0

public String ipsecPreSharedKey

Since: API level 2

Pre-shared key to be used in a L2TP-IPSEC-PSK profile

Since
API level 2
MDM 2.0

public String ipsecUserCertificate

Since: API level 2

Name of the User certificate to be used in a L2TP-IPSEC-CRT profile. This certificate is picked up from the Android Keystore, hence this certificate must be installed on the device for the VPN connection to function properly.

Since
API level 2
MDM 2.0

public String l2tpSecret

Since: API level 2

Secret to be used in a L2TP profile

Since
API level 2
MDM 2.0

public String ocspServerUrl

Since: API level 11

Online Certificate Status Protocol (OCSP) URL of the VPN profile. Used only if the connection type is IKEV2_RSA

Since
API level 11
MDM 5.0

public String profileName

Since: API level 2

User-friendly display name of the VPN profile

Since
API level 2
MDM 2.0

public List<String> searchDomains

Since: API level 5

DNS search domains of the VPN profile.

Since
API level 5
MDM 3.0

public String serverName

Since: API level 2

VPN server hostname

Since
API level 2
MDM 2.0

public String userName

Since: API level 2

Username used for login

Since
API level 2
MDM 2.0

public String userPassword

Since: API level 2

Password used for login

Since
API level 2
MDM 2.0

public String vpnType

Since: API level 2

One of VPN_TYPE_PPTP VPN_TYPE_L2TP_IPSEC_PSK, or VPN_TYPE_L2TP_IPSEC_CRT

Since
API level 2
MDM 2.0

Public Constructors

public VpnAdminProfile ()

Since: API level 2

Default Constructor

Since
API level 2
MDM 2.0