PayloadKit

Cellular

com.apple.cellular

The payload that configures cellular settings.

iOS 7.0+watchOS 3.2+
Apple schemaexclusive

Only one instance per profile

Configuration Keys (2)

KeyTypeTitle
APNs

An array of access point name (APN) dictionaries.

Range: — – 1

arrayData APN
APNsItem

A dictionary that contains details about an access point name (APN) configuration.

dict—
Namerequired

The name for this configuration.

stringData APN name
AuthenticationType

The authentication type for logging in.

Default: "PAP"

Range: CHAP, PAP

stringData APN authentication type
Username

The user name for the APN.

stringData APN user name
Password

The user's password for the APN.

stringData APN password
ProxyServer

not on macOS

The proxy server's address.

stringData APN proxy server
ProxyPort

The proxy server's port number.

integerData APN proxy port
DefaultProtocolMaskdeprecated

iOS 10.3+ · deprecated 11.0

The default Internet Protocol versions. Allowed values: '1': IPv4 '2': IPv6 '3': Both

Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)

integerData APN default IP versions
AllowedProtocolMask

iOS 10.3+

The Internet Protocol versions that the system supports. Allowed values: '1': IPv4 '2': IPv6 '3': Both

Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)

integerData APN supported IP versions
AllowedProtocolMaskInRoaming

iOS 10.3+

The Internet Protocol versions that the system supports while roaming. Allowed values: '1': IPv4 '2': IPv6 '3': Both

Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)

integerData APN supported roaming IP versions
AllowedProtocolMaskInDomesticRoaming

iOS 10.3+

The Internet Protocol versions that the system supports while roaming. Allowed values: '1': IPv4 '2': IPv6 '3': Both

Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)

integerData APN supported domestic roaming IP versions
EnableXLAT464

iOS 16.0+ · watchOS 9.0+

If 'true', the system enables XLAT464.

Default: false

booleanEnable 464XLAT IPv6 and IPv4 Interoperability
AttachAPN

A configuration dictionary.

Default: {}

dictDefault APN
Namerequired

The name for this configuration.

stringDefault APN name
AuthenticationType

The authentication type.

Default: "PAP"

Range: CHAP, PAP

stringDefault APN authentication type
Username

The user name.

stringDefault APN user name
Password

The password for the user.

stringDefault APN password
AllowedProtocolMask

iOS 10.3+

The Internet Protocol versions that the system supports. Allowed values: '1': IPv4 '2': IPv6 '3': Both

Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)

integerDefault APN supported IP versions