PayloadKit

Cellular Private Network

com.apple.cellularprivatenetwork.managed

The payload that provides device info on private network deployments, including geographical location, preference over Wi-Fi, and network deployment type.

iOS 17.0+
Apple schema

Not available with User Enrollment

Configuration Keys (7)

KeyTypeDescriptionDefaultRange
arrayA list of up to 1000 geofences for private networks. Geofencing is only used on iPhone.Default: —Range: —
dictA geofence for a private network.Default: —Range: —
required
realThe longitude of the geofence.Default: —Range: -180 – 180
required
realThe latitude of the geofence.Default: —Range: -90 – 90
Radiusreal
required
realSpecifies the radius of the geofence in meters. Set this value slightly greater than the private cellular network coverage area.Default: —Range: 100 – 6500
required
stringA geofence identifier that's unique within a list of geofences.Default: —Range: —
required
stringThe name of the private network configuration data set.Default: —Range: —
required
stringThe version number of this dataset that the system uses to track updates.Default: —Range: —
booleanSet to 'true' to prefer this private network over Wi-Fi.Default: falseRange: —
booleanSet to 'true' if this private network is NR Standalone.Default: falseRange: —

iOS 18.0+

stringA string using the 3GPP "Coordinated NID" (option 1 or option 2) format (defined in 3GPP 31.102, Section 12.7.1). The device uses this value to match a SIM present on the device. All combinations of 'NetworkIdentifier' and 'CsgNetworkIdentifier' must be unique across all profiles installed on the device.Default: —Range: —

iOS 18.0+

stringA string using the 3GPP "CSG_ID" format (defined in 3GPP 23.003, Section 4.7). The device uses this value to match a SIM present on the device. All combinations of 'NetworkIdentifier' and 'CsgNetworkIdentifier' must be unique across all profiles installed on the device.Default: —Range: —