--- title: VPN.IKEv2 framework: devicemanagement role: symbol role_heading: Device Management Profile path: devicemanagement/vpn/ikev2-data.dictionary --- # VPN.IKEv2 The dictionary to use for an IKEv2 VPN type. ## Declaration ```data object VPN.IKEv2 ``` ## Properties AllowPostQuantumKeyExchangeFallback: If set to 0, the VPN doesn’t establish a connection if the server does not support or doesn’t allow post-quantum key exchanges. Thd device ignores this key if PostQuantumKeyExchangeMethods is not present in IKESecurityAssociationParameters or ChildSecurityAssociationParameters. Available: iOS 26+ | iPadOS 26+ | macOS 26+ | tvOS 26+ | visionOS 26+ | watchOS 26+ AuthenticationMethod: The type of authentication method for the VPN. To enable EAP-only authentication, set this to None and ExtendedAuthEnabled to 1. If this is None and the ExtendedAuthEnabled key isn’t set, the authentication configuration defaults to SharedSecret. AuthName: The user name to use for authentication. AuthPassword: The password to use for authentication. CertificateType: The type of PayloadCertificateUUID to use for IKEv2 machine authentication. If this key is included, the system requires a value for ServerCertificateIssuerCommonName. ChildSecurityAssociationParameters: The ChildSecurityAssociationParameters dictionaries. DeadPeerDetectionRate: One of the following: None: No keepalive. Low: Send keepalive every 30 minutes. Medium: Send keepalive every 10 minutes. High: Send keepalive every 1 minute. Not available in watchOS. Available: iOS 4+ | iPadOS 4+ | macOS 10.7+ | tvOS 17+ | visionOS 1+ DisableMOBIKE: If 1, the system disables MOBIKE. Available: iOS 9+ | iPadOS 9+ | macOS 10.7+ | tvOS 17+ | visionOS 1+ | watchOS 10+ DisableRedirect: If 1, the system disables IKEv2 redirect. If not set, the system redirects an IKEv2 connection when it receives a redirect request from the server. Available: iOS 9+ | iPadOS 9+ | macOS 10.7+ | tvOS 17+ | visionOS 1+ | watchOS 10+ DisconnectOnIdle: If 1, the VPN disconnects automatically after a period defined by DisconnectOnIdleTimer. DisconnectOnIdleTimer: Only used if DisconnectOnIdle is 1. The number of seconds before the VPN disconnects. On watchOS, maximum allowed value is 15 seconds EnableCertificateRevocationCheck: If 1, the system performs a certificate revocation check for IKEv2 connections. This is a best-effort revocation check and server response timeouts won’t cause it to fail. Available: iOS 9+ | iPadOS 9+ | macOS 10.7+ | tvOS 17+ | visionOS 1+ | watchOS 10+ EnableFallback: If 1, the system enables a tunnel over cellular data to carry traffic that’s eligible for Wi-Fi Assist and also requires VPN. Enabling fallback requires that the server support multiple tunnels for a single user. Not available in watchOS. Available: iOS 13+ | iPadOS 13+ | tvOS 17+ | visionOS 1+ EnablePFS: If 1, enables Perfect Forward Secrecy (PFS) for IKEv2 Connections. Available: iOS 9+ | iPadOS 9+ | macOS 10.7+ | tvOS 17+ | visionOS 1+ | watchOS 10+ EnforceRoutes: If 1, all the VPN’s non-default routes take precedence over any locally-defined routes. If IncludeAllNetworks is 1, the system ignores EnforceRoutes. Available: iOS 14.2+ | iPadOS 14.2+ | macOS 11+ | tvOS 17+ | visionOS 1+ EnforceStrictAlgorithmSelection: If set to 1, the device doesn’t allow DES, 3DES, and Diffie-Hellman groups less than 14. Also the device requires the encryption algorithm specified for the IKE SA to be at least as cryptographically strong as the algorithm specified for the child SA. The device rejects this profile payload if these requirements are not met. Available: iOS 18.5+ | iPadOS 18.5+ | macOS 15.5+ | tvOS 18.5+ | visionOS 2.5+ | watchOS 11.5+ ExcludeAPNs: If 1 and IncludeAllNetworks is 1, the system excludes network traffic for the Apple Push Notification service (APNs) from the tunnel. Available: iOS 16.4+ | iPadOS 16.4+ | macOS 13.3+ | visionOS 1+ ExcludeCellularServices: If 1 and IncludeAllNetworks is 1, the system excludes internet-routable network traffic for cellular services (VoLTE, Wi-Fi Calling, IMS, MMS, Visual Voicemail, etc.) from the tunnel. Note that some cellular carriers route cellular services traffic directly to the carrier network, bypassing the internet. Such cellular services traffic is always excluded from the tunnel. Available: iOS 16.4+ | iPadOS 16.4+ | macOS 13.3+ | visionOS 1+ ExcludeDeviceCommunication: If set to 1 and IncludeAllNetworks is set to 1, the device excludes network traffic used for communicating with devices connected via USB or Wi-Fi from the tunnel. Available: iOS 17.4+ | iPadOS 17.4+ | macOS 14.4+ | visionOS 1.1+ ExcludeLocalNetworks: If 1 and either IncludeAllNetworks or EnforceRoutes are 1, then the system routes local network traffic outside of the VPN. The default for this value is 0 on macOS and 1 on iOS. Available: iOS 14.2+ | iPadOS 14.2+ | macOS 10.15+ | visionOS 1+ ExtendedAuthEnabled: If 1, enables EAP-only authentication. IKESecurityAssociationParameters: These parameters apply to Child Security Association unless ChildSecurityAssociationParameters is specified. IncludeAllNetworks: If 1, then the system routes all network traffic through the VPN, with some controllable exclusions, such as ExcludeLocalNetworks, ExcludeCellularServices, and ExcludeAPNs properties. The system always excludes the following traffic from the tunnel: Traffic necessary for connecting and maintaining the device’s network connection, such as DHCP. Traffic necessary for connecting to captive networks. Certain cellular services traffic that’s not routable over the internet and is instead directly routed to the cellular network. See the ExcludeCellularServices field for more information. Network communication with a companion device such as a watchOS device. Available: iOS 14+ | iPadOS 14+ | macOS 10.15+ | visionOS 1+ LocalIdentifier: Identifier of the IKEv2 client. MTU: The Maximum Transmission Unit (MTU) specifies the maximum size in bytes of each packet that the system sends over the IKEv2 VPN interface. Available: iOS 14+ | iPadOS 14+ | macOS 11+ | tvOS 17+ | visionOS 1+ | watchOS 10+ NATKeepAliveInterval: The NAT Keepalive interval for Always On VPN IKEv2 connections. This value controls the interval that the device sends keepalive offload packets. The minimum value is 20 seconds. If no key is specified, the default is 20 seconds over Wi-Fi and 110 seconds over a cellular interface. Available: iOS 9+ | iPadOS 9+ | macOS 10.7+ | tvOS 17+ | visionOS 1+ | watchOS 10+ NATKeepAliveOffloadEnable: If 1, enables NAT keepalive offload for Always On VPN IKEv2 connections. The device sends keepalive packets to maintain NAT mappings for IKEv2 connections that have a NAT on the path. It sends keepalive packets at regular intervals when the device is awake. If NATKeepAliveOffloadEnable is 1, the system offloads keepalive packets to hardware while the device is asleep. NAT keepalive offload has an impact on the battery life due to the extra workload during sleep. The default interval for the keepalive offload packets is 20 seconds over Wi-Fi and 110 seconds over Cellular interface. The default NAT keepalive works well on networks with small NAT mapping timeouts but imposes a potential battery impact. If a network has larger NAT mapping timeouts, larger keepalive intervals may be safely used to minimize battery impact. Modify the keepalive interval through the NATKeepAliveInterval key. Available: iOS 9+ | iPadOS 9+ | macOS 10.7+ | tvOS 17+ | visionOS 1+ | watchOS 10+ OnDemandEnabled: If 1, enables VPN up on demand. OnDemandRules: A list of rules that determine when and how to use an OnDemand VPN. OnDemandUserOverrideDisabled: If 1, the system disables the Connect On Demand toggle in Settings for this configuration. Available: iOS 14+ | iPadOS 14+ | tvOS 17+ | visionOS 1+ | watchOS 10+ Password: The password to use for the account credentials. Only used if AuthenticationMethod is Password. PayloadCertificateUUID: The UUID of the certificate payload within the same profile to use as the account credential. If the value of AuthenticationMethod is Certificate, the system sends this certificate out for IKEv2 machine authentication. If extended authentication (EAP) is used, the system sends this certificate out for EAP-TLS authentication. PPK: The Post-quantum Pre-shared key (PPK) the device uses for this VPN. This key is is used with VPN servers that support RFC 8784. If this key is present PPKIdentifier must also be present. Available: iOS 18+ | iPadOS 18+ | macOS 15+ | tvOS 18+ | visionOS 2+ | watchOS 11+ PPKIdentifier: The identifier for the Post-quantum Pre-shared key (PPK) the device uses for this VPN. This key is is used with VPN servers that support RFC 8784. If this key is present PPK must also be present. Available: iOS 18+ | iPadOS 18+ | macOS 15+ | tvOS 18+ | visionOS 2+ | watchOS 11+ PPKMandatory: If set to 1, the VPN doesn’t establish a connection if the server doesn’t support RFC 8784 or doesn’t accept the PPK identifier specified in PPKIdentifier. The device ignores this key if PPK and PPKIdentifier are not present. Available: iOS 18+ | iPadOS 18+ | macOS 15+ | tvOS 18+ | visionOS 2+ | watchOS 11+ ProviderBundleIdentifier: If the VPNSubType field contains the bundle identifier of an app that contains multiple VPN providers of the same type (app-proxy or packet-tunnel), then the system uses this field to choose which provider to use for this configuration. If the VPN provider is implemented as a System Extension, then this field is required. ProviderDesignatedRequirement: If the VPN provider is implemented as a System Extension, then this field is required. Available: macOS 10.15+ | tvOS 17+ | watchOS 10+ ProviderType: If the value of this key is app-proxy, the VPN service tunnels traffic at the application layer. If the value of this key is packet-tunnel, the VPN service tunnels traffic at the IP layer. RemoteAddress: The IP address or host name of the VPN server. RemoteIdentifier: The remote identifier. ServerCertificateCommonName: The common name of the server certificate. The system uses this name to validate the certificate sent by the IKE server. If not set, the system uses the remote identifier to validate the certificate. ServerCertificateIssuerCommonName: Common Name of the server certificate issuer. If set, this field causes IKE to send a certificate request based on this certificate issuer to the server. This key is required if the CertificateType key is included and the ExtendedAuthEnabled key is 1. SharedSecret: If AuthenticationMethod is SharedSecret, the device uses this value for IKE authentication. TLSMaximumVersion: The maximum TLS version to use with EAP-TLS authentication. Available: iOS 11+ | iPadOS 11+ | macOS 10.13+ | tvOS 17+ | visionOS 1+ | watchOS 10+ TLSMinimumVersion: The minimum TLS version to use with EAP-TLS authentication. Available: iOS 11+ | iPadOS 11+ | macOS 10.13+ | tvOS 17+ | visionOS 1+ | watchOS 10+ UseConfigurationAttributeInternalIPSubnet: If 1, negotiations should use IKEv2 Configuration Attribute INTERNAL_IP4_SUBNET and INTERNAL_IP6_SUBNET. Available: iOS 9+ | iPadOS 9+ | macOS 10.7+ | tvOS 17+ | visionOS 1+ | watchOS 10+ ## Topics ### Objects - [VPN.IKEv2.ChildSecurityAssociationParameters](devicemanagement/vpn/ikev2-data.dictionary/childsecurityassociationparameters-data.dictionary.md) - [VPN.IKEv2.IKESecurityAssociationParameters](devicemanagement/vpn/ikev2-data.dictionary/ikesecurityassociationparameters-data.dictionary.md) ## See Also ### Objects - [VPN.AlwaysOn](devicemanagement/vpn/alwayson-data.dictionary.md) - [VPN.DNS](devicemanagement/vpn/dns-data.dictionary.md) - [VPN.IPSec](devicemanagement/vpn/ipsec-data.dictionary.md) - [VPN.IPv4](devicemanagement/vpn/ipv4-data.dictionary.md) - [VPN.PPP](devicemanagement/vpn/ppp-data.dictionary.md) - [VPN.Proxies](devicemanagement/vpn/proxies-data.dictionary.md) - [VPN.TransparentProxy](devicemanagement/vpn/transparentproxy-data.dictionary.md) - [VPN.VPN](devicemanagement/vpn/vpn-data.dictionary.md) - [VPN.VendorConfig](devicemanagement/vpn/vendorconfig-data.dictionary.md)