Device Management Profile

VPN.VPN

A dictionary used to specify a VPN when VPNType is set to VPN, IPSec, or IKEv2.

Properties

AuthenticationMethod
string

The authentication method to use.

DisconnectOnIdle
integer

If true, disconnects after an on-demand connection idles.

DisconnectOnIdleTimer
integer

The length of time to wait before disconnecting an on-demand connection

OnDemandEnabled
integer

If true, enables VPN On Demand.

OnDemandMatchDomainsAlways
[string]

A list of domain names. The associated domain names are treated as though they were associated with the OnDemandMatchDomainsOnRetry key.

This behavior can be overridden by OnDemandRules.

OnDemandMatchDomainsNever
[string]

A list of domain names. If the host name ends with one of these domain names, the VPN isn't started automatically. This is used to exclude a subdomain within an included domain.

In iOS 7 and later, this key is deprecated (but still supported) in favor of EvaluateConnection actions in the OnDemandRules dictionaries.

OnDemandMatchDomainsOnRetry
[string]

A list of domain names. If the host name ends with one of these domain names and a DNS query for that domain name fails, the VPN is started automatically.

In iOS 7 and later, this key is deprecated (but still supported) in favor of EvaluateConnection actions in the OnDemandRules dictionaries.

An array of dictionaries defining On Demand Rules.

Password
string

The VPN user password.

PayloadCertificateUUID
string

The UUID of the certificate payload within the same profile to use for account credentials.

ProviderBundleIdentifier
string

The bundle identifier for the VPN provider.

ExcludeLocalNetworks
integer

If true and includeAllNetworks is true, routes all local network traffic outside the VPN.

IncludeAllNetworks
integer

If true, routes all traffic through the VPN.

ProviderDesignatedRequirement
string

If the VPN provider is implemented as a system extension, then this field is required.

ProviderType
string

The type of VPN service. If it is app-proxy, the service will tunnel traffic at the application level. If it is packet-tunnel, the service will tunnel traffic at the IP layer.

Topics

Objects

object VPN.VPN.OnDemandRulesElement

A dictionary of settings for On Demand connections.

object VPN.VPN.OnDemandRulesElement.ActionParameters

A dictionary of settings for On Demand connects, evaluated per connection.