apple_device-management/mdm/profiles/com.apple.cellular.yaml

title: Cellular
description: The payload that configures cellular settings.
payload:
  payloadtype: com.apple.cellular
  supportedOS:
    iOS:
      introduced: '7.0'
      multiple: false
      supervised: false
      allowmanualinstall: true
      sharedipad:
        mode: allowed
        devicechannel: true
        userchannel: false
      userenrollment:
        mode: forbidden
    macOS:
      introduced: n/a
    tvOS:
      introduced: n/a
    visionOS:
      introduced: n/a
    watchOS:
      introduced: '3.2'
      multiple: false
      allowmanualinstall: true
  content: |-
    This payload cannot be installed if an APN payload is already installed.
    This payload only applies to the preferred data SIM. There is no way to have a cellular payload affect a different SIM.
    This payload replaces the com.apple.managedCarrier payload. The latter payload is supported, but deprecated.
payloadkeys:
- key: AttachAPN
  title: AttachAPN
  type: <dictionary>
  presence: optional
  content: A configuration dictionary.
  subkeys:
  - key: Name
    title: Name
    type: <string>
    presence: required
    content: The name for this configuration.
  - key: AuthenticationType
    title: Authentication type
    type: <string>
    presence: optional
    rangelist:
    - CHAP
    - PAP
    default: PAP
    content: The authentication type.
  - key: Username
    title: User name
    type: <string>
    presence: optional
    content: The user name.
  - key: Password
    title: Password
    type: <string>
    presence: optional
    content: The password for the user.
  - key: AllowedProtocolMask
    title: Supported IP versions
    supportedOS:
      iOS:
        introduced: '10.3'
    type: <integer>
    presence: optional
    rangelist:
    - 1
    - 2
    - 3
    content: |-
      The Internet Protocol versions that the system supports. Allowed values:

      - `1`: IPv4
      - `2`: IPv6
      - `3`: Both
- key: APNs
  title: APNs
  type: <array>
  presence: optional
  content: An array of access point name (APN) dictionaries.
  subkeys:
  - key: APNsItem
    type: <dictionary>
    content: A dictionary that contains details about an access point name (APN) configuration.
    subkeys:
    - key: Name
      title: Name
      type: <string>
      presence: required
      content: The name for this configuration.
    - key: AuthenticationType
      title: Authentication type
      type: <string>
      presence: optional
      rangelist:
      - CHAP
      - PAP
      default: PAP
      content: The authentication type for logging in.
    - key: Username
      title: User name
      type: <string>
      presence: optional
      content: The user name for the APN.
    - key: Password
      title: Password
      type: <string>
      presence: optional
      content: The user's password for the APN.
    - key: ProxyServer
      title: Proxy server
      supportedOS:
        macOS:
          introduced: n/a
      type: <string>
      presence: optional
      content: The proxy server's address.
    - key: ProxyPort
      title: Proxy port
      type: <integer>
      presence: optional
      content: The proxy server's port number.
    - key: DefaultProtocolMask
      supportedOS:
        iOS:
          introduced: '10.3'
          deprecated: '11.0'
      type: <integer>
      presence: optional
      rangelist:
      - 1
      - 2
      - 3
      content: |-
        The default Internet Protocol versions. Allowed values:

        - `1`: IPv4
        - `2`: IPv6
        - `3`: Both
    - key: AllowedProtocolMask
      title: Supported IP versions
      supportedOS:
        iOS:
          introduced: '10.3'
      type: <integer>
      presence: optional
      rangelist:
      - 1
      - 2
      - 3
      content: |-
        The Internet Protocol versions that the system supports. Allowed values:

        - `1`: IPv4
        - `2`: IPv6
        - `3`: Both
    - key: AllowedProtocolMaskInRoaming
      title: Supported roaming IP versions
      supportedOS:
        iOS:
          introduced: '10.3'
      type: <integer>
      presence: optional
      rangelist:
      - 1
      - 2
      - 3
      content: |-
        The Internet Protocol versions that the system supports while roaming. Allowed values:

        - `1`: IPv4
        - `2`: IPv6
        - `3`: Both
    - key: AllowedProtocolMaskInDomesticRoaming
      title: Supported roaming IP versions
      supportedOS:
        iOS:
          introduced: '10.3'
      type: <integer>
      presence: optional
      rangelist:
      - 1
      - 2
      - 3
      content: |-
        The Internet Protocol versions that the system supports while roaming. Allowed values:

        - `1`: IPv4
        - `2`: IPv6
        - `3`: Both
    - key: EnableXLAT464
      title: Enable XLAT464
      supportedOS:
        iOS:
          introduced: '16.0'
        watchOS:
          introduced: '9.0'
      type: <boolean>
      presence: optional
      default: false
      content: If `true`, the system enables XLAT464.
examples:
- title: Profile example
  files:
  - file: examples/mdm/profiles/com.apple.cellular/example1.plist