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
iOS 17.0+

Configuration Keys (7)

KeyTypeTitle
Geofences

A list of up to 1000 geofences for private networks. Geofencing is only used on iPhone.

array
DataSetNamerequired

The name of the private network configuration data set.

string
VersionNumberrequired

The version number of this dataset that the system uses to track updates.

string
CellularDataPreferred

Set to 'true' to prefer this private network over Wi-Fi.

Default: false

boolean
EnableNRStandalone

Set to 'true' if this private network is NR Standalone.

Default: false

boolean
NetworkIdentifier

A 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.

string
CsgNetworkIdentifier

A 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.

string
GeofenceItem

A geofence for a private network.

dict
Longituderequired

The longitude of the geofence.

Range: -180 – 180

real
Latituderequired

The latitude of the geofence.

Range: -90 – 90

real
Radiusrequired

Specifies the radius of the geofence in meters. Set this value slightly greater than the private cellular network coverage area.

Range: 100 – 6500

real
GeofenceIdrequired

A geofence identifier that's unique within a list of geofences.

string