2.2.1.12.2 VPN Element

  • Article

This element refers to a VPN connection on the client

Attribute name

Description

action

(optional) If specified, the value MUST be C, D, R, or U, corresponding to Create, Delete, Replace, and Update. If unspecified, the default value is U.

  • Create: This action MUST be used to create a new VPN connection. If a connection with the same name exists, then it MUST NOT be modified.

  • Delete: This action MUST be used to remove a VPN or VPN connection with the same name. If the connection does not exist, then the client MUST NOT perform an action, and an error MUST NOT be returned.

  • Replace: This action MUST be used to delete and re-create the virtual private connection. The net result of the Replace action MUST be to overwrite all existing settings associated with the connection. If the connection does not exist, then the Replace action MUST create a new connection.

  • Update: This action MUST be used to rename or modify a VPN connection. The action differs from Replace in that it MUST update the settings defined within the preference item. All other settings MUST remain as previously configured. If the connection does not exist, then the Update action MUST create a new connection.

user

MUST be set to 1 to make a VPN connection visible only to the applied user. MUST be set to 0 to make a VPN connection visible to all users.

name

MUST be text used to name the connection.

ipAddress

MUST be the IPv4 address of the connection or the fully qualified domain name (FQDN) of the connection.<12>

useDNS

(optional) MUST be set to 1 if ipAddress contains an FQDN.

dialFirst

(optional) MUST be set to the name of the DUN connection that the client MUST establish prior to connecting to the VPN.

trayIcon

(optional) MUST be set to 1 to show an icon in notification area when connected.

showProgress

(optional) MUST be set to 1 to show connection-setup progress.

showPassword

(optional) MUST be set to 1 to indicate whether the initial connection setup dialogue box prompts for the user's password.

showDomain

(optional) MUST be set to 1 to indicate that the initial connection setup dialogue box MUST prompt for the user's domain.

redialCount

(optional) MUST be set to an integer redial count if unable to connect at first try.

redialPause

(optional) MUST be set to number of seconds to wait before redial attempt.

idleDisconnect

(optional) MUST be set to 1 to disconnect if idle.

reconnect

(optional) MUST be set to 1 to reconnect automatically.

customSettings

(optional) MUST be set to 1 to use custom VPN settings.

securePassword

(optional) MUST be set to 1 to require a secure password prompt.

secureData

(optional) MUST be set to 1 to require an encrypted connection.

useLogon

(optional) MUST be set to 1 to connect using current logged on user credentials.

vpnStrategy

(optional) MUST be VS_Default, VS_PptpOnly, VS_PptpFirst, VS_L2tpOnly or VS_L2tpFirst to select the VPN connection protocol. For more information on values allowed, see RASENTRY in [MSDN-RAS].

encryptionType

(optional) MUST be ET_None, ET_Optional, ET_Require, or ET_RequireMax to select the VPN encryption type. For more information about values allowed, see RASENTRY in [MSDN-RAS].

eap

(optional) MUST be set to 1 to connect using Extensible Authentication Protocol (EAP).

pap

(optional) MUST be set to 1 to connect using an unencrypted password.

spap

(optional) MUST be set to 1 to connect using Shiva Password Authentication Protocol.

chap

(optional) MUST be set to 1 to connect using Challenge-Handshake Authentication Protocol (CHAP).

msChap

(optional) MUST be set to 1, to connect using CHAP.

oldMsChap

(optional) MAY<13> be set to 1.

msChapV2

(optional) MUST be set to 1 to connect using CHAP version 2.