PayloadKit

Network Usage Rules

com.apple.networkusagerules

The payload that configures network-usage rules.

iOS
iOS 9.0+exclusive

Configuration Keys (2)

KeyTypeTitle
ApplicationRules

An array of application rules, that apply to only managed apps.

arrayApplication Network Usage Rules
SIMRules

An array of SIM rules, that apply to all apps.

arrayWi-Fi Assist Policy Rules
ApplicationRulesItem

The application rules dictionary.

dictNetwork Usage Rules
AppIdentifierMatches

A list of managed app identifiers, as strings, that must follow the associated rules. If this key is missing, the rules apply to all managed apps on the device. Each string in the 'AppIdentifierMatches' array may either be an exact app identifier match (for example, 'com.mycompany.myapp') or it may specify a prefix match for the bundle ID by using the \* wildcard character. If used, this character must appear after a period (.) and may only appear once, at the end of the string; for example, 'com.mycompany.*'.

arrayBundle Identifier Matches
AllowCellularData

If 'false', disables cellular data for all matching managed apps.

Default: true

booleanAllow Cellular Data
AllowRoamingCellularData

If 'false', disables cellular data while roaming for all matching managed apps.

Default: true

booleanAllow Data Roaming
AppIdentifierMatchesItemrequired

A managed app identifier.

stringBundle Identifier
SIMRulesItem

The policy for individual SIM cards.

dict
ICCIDsrequired

One or more ICCIDs of SIM cards for which the 'WiFiAssistPolicy' applies. All ICCIDs in all installed Network Usage Rules payloads must be unique. An example ICCID is '89310410106543789301'.

arraySIM ICCIDs
WiFiAssistPolicyrequired

The Wi-Fi Assist policy to apply to the SIM cards specified in the ICCIDs. Allowed values: - '2': Use the default system policy for the specified SIM card(s). - '3': Make Wi-Fi Assist switch more aggressively from a poor Wi-Fi connection to cellular data for the specified SIM card(s). This setting may increase cellular data use and may impact battery life. For more information, see [About Wi-Fi Assist](https://support.apple.com/en-us/HT205296).

Range: Default (2), Allow frequent switching to cellular data (3)

integerPolicy
ICCIDrequired

An ICCID.

string