iOS and macOS: VPN profile settings

Setting

OS

Depends on

Description

Apply profile to

macOS

—

This setting specifies whether the VPN profile is applied to the user account or the device.

Connection type

iOS

macOS

—

This setting specifies the connection type that a device uses for a VPN gateway. Some connection types also require users to install the appropriate VPN app on the device.

If you select "IKEv2 Always On," many settings have separate values for cellular and Wi-Fi connections.

Allow user to disable automatic connection

iOS

Connection type: IKEv2 Always On

This setting specifies whether users can disable the VPN connection.

Use same tunnel configuration for cellular and Wi-Fi

iOS

Connection type: IKEv2 Always On

This setting specifies whether you want to set separate VPN settings for the device depending on whether the device is sending data over a cellular network or a Wi-Fi network. If this setting is not selected, you can set different cellular and Wi-Fi settings in the same profile.

Remote address

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies the IP address or hostname of the VPN server.

Local ID

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies the identity of the IKEv2 client in one of the following formats: FQDN, UserFQDN, Address, or ASN1DN.

Remote ID

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies the remote identifier of the IKEv2 client using one of the following formats: FQDN, user FQDN, Address, or ASN1DN.

VPN bundle ID

iOS

macOS

Connection type: Custom

This setting specifies the bundle ID of the VPN app for a custom SSL VPN. The bundle ID is in reverse-DNS format (for example, com.example.VPNapp).

Server

iOS

macOS

—

This setting specifies the FQDN or IP address of a VPN server.

Username

iOS

macOS

—

This setting specifies the username that a device uses to authenticate with the VPN gateway. If the profile is for multiple users, you can specify the %UserName% variable.

Custom key-value pairs

iOS

macOS

Connection type: Custom

This setting specifies the keys and associated values for the custom SSL VPN. The configuration information is specific to the vendor's VPN app.

Login group or Domain

iOS

macOS

Connection type: SonicWALL Mobile Connect

This setting specifies the login group or domain that the VPN gateway uses to authenticate a device.

Realm

iOS

macOS

Connection type: Juniper, Pulse Secure

This setting specifies the name of the authentication realm that the VPN gateway uses to authenticate a device.

Role

iOS

macOS

Connection type: Juniper, Pulse Secure

This setting specifies the name of the user role that the VPN gateway uses to verify the network resources that a device can access.

Authentication type

iOS

macOS

—

This setting specifies the authentication type for the VPN gateway.

The "Connection type" setting determines which authentication types are supported and the default value for this setting.

EAP plug-ins

iOS

Connection type: L2TP, PPTP + Authentication type: RSA SecurID

This setting specifies authentication plugins for the VPN.

Authentication protocol

iOS

Connection type: L2TP, PPTP + Authentication type: RSA SecurID

This setting specifies authentication protocols for the VPN.

Password

iOS

macOS

Authentication type: Password

This setting specifies the password that a device uses to authenticate with the VPN gateway.

Group name

iOS

macOS

Connection type: Cisco AnyConnect

Connection type: IPsec + Authentication type: Shared secret/Group name

This setting specifies the group name for the VPN gateway.

Shared secret

iOS

macOS

Connection type: L2TP

Connection type: IPsec + Authentication type: Shared secret/Group name

Connection type: IKEv2, IKEv2 Always On + Authentication type: Shared secret

This setting specifies the shared secret to use for VPN authentication.

Shared certificate

iOS

macOS

Authentication type: Shared certificate

This setting specifies the shared certificate profile with the client certificate that a device uses to authenticate with the VPN gateway.

Associated SCEP profile

iOS

macOS

Authentication type: SCEP

This setting specifies the associated SCEP profile that a device uses to obtain a client certificate to authenticate with the VPN.

Associated ACME profile

iOS

macOS

Authentication type: ACME

This setting specifies the associated ACME profile that a device uses to obtain a client certificate to authenticate with the VPN.

Associated user credential profile

iOS

macOS

Authentication type: User credential

This setting specifies the associated user credential profile that a device uses to obtain a client certificate to authenticate with the VPN.

Certificate type

iOS

macOS

Connection type: IKEv2 + Authentication type: Shared certificate, User credential

This setting specifies the type of certificate payload used for IKEv2 authentication. You must populate the “Common name of the server certificate issuer” field (do not use the deprecated field under the “Enable xAuth” setting).

Encryption level

iOS

macOS

Connection type: PPTP

This setting specifies the level of data encryption for the VPN connection. If this setting is set to "Automatic," all available encryption strengths are allowed. If this setting is set to "Maximum," only the maximum encryption strength is allowed.

Do not allow user to disable VPN On Demand

iOS

Connection type: L2TP, IPsec, Cisco AnyConnect, Juniper, Pulse Secure, F5, SonicWALL Mobile Connect, Aruba VIA, Check Point Mobile, OpenVPN, Custom, IKEv2, IKEv2 Always On

This setting specifies whether iOS device users can turn off VPN On Demand.

Route network traffic through VPN

iOS

macOS

Connection type: L2TP, PPTP

This setting specifies whether to send all network traffic through the VPN connection.

Use hybrid authentication

iOS

macOS

Connection type: IPsec + Authentication type: Shared secret/Group name

This setting specifies whether to use a server-side certificate for authentication.

Prompt for password

iOS

macOS

Connection type: IPsec + Authentication type: Shared secret/Group name

This setting specifies whether a device prompts the user for a password.

Prompt for user PIN

iOS

macOS

Connection type: IPsec + Authentication type: Shared certificate, SCEP, User credential, ACME

This setting specifies whether the device prompts the user for a PIN.

Enable VPN on demand

iOS

macOS

Connection type: IPsec, Cisco AnyConnect, Juniper, Pulse Secure, F5, SonicWALL Mobile Connect, Aruba VIA, Check Point Mobile, OpenVPN, Custom + Authentication type: Shared certificate, SCEP, User credential, ACME

Connection type: IKEv2 + Authentication type: Shared certificate, SCEP, User credential, ACME

This setting specifies whether a device can start a VPN connection automatically when it accesses certain domains.

For iOS and iPadOS devices, this setting applies to work apps.

Domain or host names that can use VPN on demand

iOS

macOS

Enable VPN on demand

This setting specifies the domains and the associated actions for VPN on demand.

VPN on demand rules for iOS 7.0 and later

iOS

Enable VPN on demand

This setting specifies the connection requirements for VPN on demand. You must use one or more keys from the payload format example.

This setting overrides the "Domain or host names that can use VPN on demand" setting.

Disconnect on idle

iOS

Connection type: Cisco AnyConnect, Juniper, Pulse Secure, F5, SonicWALL Mobile Connect, Aruba VIA, Check Point Mobile, OpenVPN, Custom + Authentication type: Shared certificate, SCEP, User credential, ACME + Enable VPN on demand

This setting specifies whether the VPN connection disconnects if it is idle for a specified period of time.

Disconnect on idle timer

iOS

Disconnect on idle

This setting specifies the idle time in seconds after which the VPN disconnects.

Exclude local network

iOS

Connection type: Cisco AnyConnect, Juniper, Pulse Secure, F5, SonicWALL Mobile Connect, Aruba VIA, Check Point Mobile, OpenVPN, Custom

This setting specifies whether to exclude local network traffic from using the VPN connection. If the "Include all networks" setting is also selected, no local network traffic is routed through the VPN.

All non-default routes take precedence over any locally defined routes

iOS

Connection type: Cisco AnyConnect, Juniper, Pulse Secure, F5, SonicWALL Mobile Connect, Aruba VIA, Check Point Mobile, OpenVPN, Custom

This setting specifies whether the non-default routes for the VPN take precedence over any locally defined routes. If the "Include all networks" setting is also selected, this setting is ignored.

Include all networks

iOS

Connection type: Cisco AnyConnect, Juniper, Pulse Secure, F5, SonicWALL Mobile Connect, Aruba VIA, Check Point Mobile, OpenVPN, Custom

This setting specifies whether to route all traffic through the VPN. If "Exclude local network" is also selected, local network traffic is not routed through the VPN.

Provider designated requirement

iOS

Connection type: Cisco AnyConnect, Juniper, Pulse Secure, F5, SonicWALL Mobile Connect, Aruba VIA, Check Point Mobile, OpenVPN, Custom

This setting specifies a designated VPN provider. If the VPN provider is implemented as a system extension, this setting is required.

Use OpenVPN client 1.2.5 and later

iOS

Connection type: OpenVPN

This setting specifies whether to use the VPN profile with OpenVPN client version 1.2.5 or later. OpenVPN client 1.2.5 and later uses a new bundle ID, so this setting must be selected to use the profile with these client versions.

Enable xAuth

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies whether the VPN supports extended authentication.

Authentication type (Enable xAuth)

iOS

macOS

Enable xAuth

This setting specifies the authentication type for xAuth: Username and password or Certificate.

Username (Enable xAuth)

iOS

macOS

Enable xAuth + Authentication type: Username and password

This setting specifies the username that a device uses to authenticate with the VPN. If the profile is for multiple users, you can use the %UserName% variable.

Password (Enable xAuth)

iOS

macOS

Enable xAuth + Authentication type: Username and password

This setting specifies the password that a device uses to authenticate with the VPN.

Shared certificate (Enable xAuth)

iOS

macOS

Enable xAuth + Authentication type: Certificate

This setting specifies the type of certificate used for IKEv2 machine authentication.

Minimum TLS version

iOS

macOS

Enable xAuth + Authentication type: Certificate

This setting specifies the minimum TLS version that devices use for EAP-TLS authentication.

Maximum TLS version

iOS

macOS

Enable xAuth + Authentication type: Certificate

This setting specifies the maximum TLS version that devices use for EAP-TLS authentication.

Keepalive interval

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies how often a device sends a keepalive packet.

Common name of the server certificate

iOS

macOS

Connection type: IKEv2

This setting specifies the common name in the certificate that the IKE server sends to the iOS or macOS device.

For iOS, the previous implementation of this setting under "Enable xAuth" (with "Authentication type" set to Certificate) is deprecated. If the deprecated setting is configured, you must clear that setting and use this one instead. You can configure this setting without turning on "Enable xAuth."

Common name of the server certificate issuer

iOS

macOS

Connection type: IKEv2

This setting specifies the common name of the CA that issued the server certificate that the IKE server sends to the iOS or macOS device.

For iOS, the previous implementation of this setting under "Enable xAuth" (with "Authentication type" set to Certificate) is deprecated. If the deprecated setting is configured, you must clear that setting and use this one instead. You can configure this setting without turning on "Enable xAuth".

For iOS devices, if you turn on "Enable xAuth" and set the "Authentication type" to Certificate, this setting is required.

Disable MOBIKE

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies whether MOBIKE is disabled.

Disable IKEv2 redirect

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies whether IKEv2 redirect is disabled. If this setting is not selected, the IKEv2 connection is redirected if a redirect request is received from the server.

Enable perfect forward secrecy

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies whether the VPN supports PFS.

Enable NAT keepalive

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies whether the VPN supports NAT keepalive packets. Keepalive packets are used to maintain NAT mappings for IKEv2 connections.

Use IPv4 and IPv6 IKEv2 internal subnets

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies whether the VPN can use the IKEv2 configuration attributes INTERNAL_IP4_SUBNET and INTERNAL_IP6_SUBNET.

Enable certificate revocation check

iOS

Connection type: IKEv2, IKEv2 Always On

This setting specifies whether a certificate revocation check is attempted for the server certificate. The check does not fail if there is no response.

Enable fallback

iOS

Connection type: IKEv2, IKEv2 Always On

This setting specifies whether the device can establish a VPN tunnel over the mobile network when Wi-Fi Assist is enabled.

Apply Child Security Association parameters

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies whether to apply child security association parameters.

Apply IKE Security Association parameters

iOS

macOS

Connection type: IKEv2

Connection type: IKEv2 Always On (iOS only)

This setting specifies whether to apply IKE security association parameters.

DH group

iOS

macOS

Apply Child Security Association parameters

Apply IKE Security Association parameters

This setting specifies the DH group that a device uses to generate key material.

Encryption algorithm

iOS

macOS

Apply Child Security Association parameters

Apply IKE Security Association parameters

This setting specifies the encryption algorithm.

Integrity algorithm

iOS

macOS

Apply Child Security Association parameters

Apply IKE Security Association parameters

This setting specifies the integrity algorithm.

Rekey interval

iOS

macOS

Apply Child Security Association parameters

Apply IKE Security Association parameters

This setting specifies the lifetime of the connection.

MTU

iOS

Connection type: IKEv2 Always On

This setting specifies the Maximum Transmission Unit in bytes.

VoiceMail

iOS

Connection type: IKEv2 Always On (Wi-Fi only)

This setting specifies whether connections to the voice mail service are sent through the VPN tunnel, sent outside of the VPN tunnel, or are blocked.

AirPrint

iOS

Connection type: IKEv2 Always On (Wi-Fi only)

This setting specifies whether AirPrint connections are sent through the VPN tunnel, sent outside of the VPN tunnel, or are blocked.

Allow traffic from captive web sheet outside the VPN tunnel

iOS

Connection type: IKEv2 Always On (Wi-Fi only)

This setting specifies whether traffic from captive web sheets can be sent outside of the VPN tunnel.

Allow traffic from all captive networking apps outside VPN tunnel

iOS

Connection type: IKEv2 Always On (Wi-Fi only)

This setting specifies whether traffic from all captive networking apps can be sent outside of the VPN tunnel. If this setting is not selected, you can specify individual apps for which traffic can be sent outside the tunnel.

Traffic from these apps is allowed outside VPN tunnel

iOS

Connection type: IKEv2 Always On (Wi-Fi only)

This setting specifies individual captive networking apps for which traffic can be sent outside the tunnel.

Allow app traffic outside the VPN tunnel

iOS

Connection type: IKEv2 Always On (Wi-Fi only)

This setting specifies apps whose traffic can be sent outside the tunnel.

Enable per-app VPN

iOS

macOS

Connection type: Cisco AnyConnect, Juniper, Pulse Secure, F5 (iOS only), SonicWALL Mobile Connect, Aruba VIA, Check Point Mobile, OpenVPN, Custom, IKEv2 (iOS only)

This setting specifies whether the VPN gateway supports per-app VPN. This feature helps decrease the load on an organization’s VPN. For example, you can enable only certain work traffic to use the VPN, such as accessing application servers or webpages behind the firewall.

Safari domains

iOS

macOS

Enable per-app VPN

This setting specifies the domains that can start the VPN connection in Safari.

Associated domains

iOS

macOS

Enable per-app VPN

This setting specifies domains that can start the VPN connection on the device. The domains must also be included in the apple-app-site-association file.

Allow apps to connect automatically

iOS

macOS

Enable per-app VPN

This setting specifies whether apps associated with per-app VPN can start the VPN connection automatically.

Traffic tunneling

iOS

macOS

Enable per-app VPN

This setting specifies whether the VPN tunnels traffic at the application layer or the IP layer.

DNS protocol

iOS

macOS

—

This setting specifies the transport protocol that devices use to communicate with the DNS server.

Server URL

iOS

macOS

DNS protocol: HTTPS

This setting specifies the URL of the DNS server over HTTPS, as defined in RFC 8484. The URL must use the https:// scheme.

Server name

iOS

macOS

DNS protocol: TLS

This setting specifies the hostname of the DNS server over TLS, as defined in RFC 7858.

DNS server addresses

iOS

macOS

—

This setting specifies the IP addresses of DNS servers. The addresses can be IPv4 and IPv6 addresses.

DNS search domains

iOS

macOS

—

This setting specifies the domain names that are used to fully qualify single-label hostnames.

Domain name

iOS

macOS

—

This setting specifies the primary domain of the VPN tunnel.

Supplemental match domains

iOS

macOS

—

This setting specifies the domains that use the DNS servers that are configured in the VPN profile. Hosts that are not in any of the specified domains are resolved using the system default resolver. If the VPN tunnel becomes the default route, these domains are ignored.

Supplemental match domains no search

iOS

macOS

—

This setting specifies whether the supplemental match domains are added to the resolver’s list of search domains.

Shared certificate (DNS)

iOS

macOS

—

This setting specifies the shared certificate that devices use to authenticate with the DNS resolver.

Associated proxy profile

iOS

macOS

—

This setting specifies the associated proxy profile that a device uses to connect to a proxy server when the device is connected to the VPN.