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)

KeyTypeDescriptionDefaultRange
APNsarray

Data APN

arrayAn array of access point name (APN) dictionaries.Default: —Range: — – 1
dictA dictionary that contains details about an access point name (APN) configuration.Default: —Range: —
Namestring

Data APN name

required
stringThe name for this configuration.Default: —Range: —

Data APN authentication type

stringThe authentication type for logging in.Default: "PAP"Range: CHAP, PAP
Usernamestring

Data APN user name

stringThe user name for the APN.Default: —Range: —
Passwordstring

Data APN password

stringThe user's password for the APN.Default: —Range: —

Data APN proxy server

not on macOS

stringThe proxy server's address.Default: —Range: —
ProxyPortinteger

Data APN proxy port

integerThe proxy server's port number.Default: —Range: —

Data APN default IP versions

iOS 10.3+ · deprecated 11.0

deprecated
integerThe default Internet Protocol versions. Allowed values: '1': IPv4 '2': IPv6 '3': BothDefault: —Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)

Data APN supported IP versions

iOS 10.3+

integerThe Internet Protocol versions that the system supports. Allowed values: '1': IPv4 '2': IPv6 '3': BothDefault: —Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)

Data APN supported roaming IP versions

iOS 10.3+

integerThe Internet Protocol versions that the system supports while roaming. Allowed values: '1': IPv4 '2': IPv6 '3': BothDefault: —Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)

Data APN supported domestic roaming IP versions

iOS 10.3+

integerThe Internet Protocol versions that the system supports while roaming. Allowed values: '1': IPv4 '2': IPv6 '3': BothDefault: —Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)

Enable 464XLAT IPv6 and IPv4 Interoperability

iOS 16.0+ · watchOS 9.0+

booleanIf 'true', the system enables XLAT464.Default: falseRange: —

Default APN

dictA configuration dictionary.Default: {}Range: —
Namestring

Default APN name

required
stringThe name for this configuration.Default: —Range: —

Default APN authentication type

stringThe authentication type.Default: "PAP"Range: CHAP, PAP
Usernamestring

Default APN user name

stringThe user name.Default: —Range: —
Passwordstring

Default APN password

stringThe password for the user.Default: —Range: —

Default APN supported IP versions

iOS 10.3+

integerThe Internet Protocol versions that the system supports. Allowed values: '1': IPv4 '2': IPv6 '3': BothDefault: —Range: IPv4 (1), IPv6 (2), IPv4 and IPv6 (3)