apple_device-management/declarative/status/content-cache.status.yaml

title: Status Content Cache Service
description: The status item that reports the status of the Content Cache service.
payload:
  statusitemtype: content-cache.status
  supportedOS:
    iOS:
      introduced: n/a
    macOS:
      introduced: '27.0'
      allowed-enrollments:
      - supervised
      - local
      allowed-scopes:
      - system
    tvOS:
      introduced: n/a
    visionOS:
      introduced: n/a
    watchOS:
      introduced: n/a
payloadkeys:
- key: content-cache.status
  title: Status of the content cache service
  type: <dictionary>
  presence: required
  content: The basic set of AssetCache status items
  subkeys:
  - key: server-guid
    title: Server GUID
    type: <string>
    presence: required
    content: The unique identifier of the Content Cache.
  - key: activated
    title: Activated
    type: <boolean>
    presence: optional
    default: false
    content: If `true`, the device has enabled the Content Cache. Enabling the Content
      Caching doesn't guarantee service. See the `Active` key for the readiness of
      the Content Cache to serve requests.
  - key: active
    title: Active
    type: <boolean>
    presence: optional
    default: false
    content: If `true`, the Content Cache is ready to serve requests.
  - key: cache-status
    title: Cache status
    type: <string>
    presence: optional
    rangelist:
    - LOWSPACE
    - OK
    content: The level of cache pressure. `LOWSPACE` means cache pressure is high.
  - key: private-addresses
    title: Private addresses
    type: <array>
    presence: optional
    content: An array of the Content Cache's local IP addresses.
    subkeys:
    - key: private-address-item
      title: Private address
      type: <string>
      presence: required
      content: Local IP address at which the Content Cache listens for requests from
        clients, peers, and children.
  - key: public-address
    title: Public address
    type: <string>
    presence: optional
    content: The public IP address of the Content Cache.
  - key: port
    title: Port
    type: <integer>
    presence: optional
    content: The IP port number the Content Cache listens to for requests from clients,
      peers, and children.
  - key: registration-status
    title: Registration status
    type: <integer>
    presence: optional
    rangelist:
    - -1
    - 0
    - 1
    content: |-
      The status of the Content Cache's registration with Apple, which is one of the following values:

      - `-1`: The registration failed.
      - `0`: The registration is pending.
      - `1`: The registration succeeded.
  - key: registration-started
    title: Registration timestamp
    type: <string>
    presence: optional
    content: The RFC 3339 timestamp for when the Content Cache began registering itself
      with Apple. This value is only available during registration attempts.
  - key: registration-response-code
    title: Registration response code
    type: <integer>
    presence: optional
    content: If present, the HTTP response code that the Content Cache received when
      it failed to register itself with Apple.
  - key: registration-error
    title: Registration error
    type: <string>
    presence: optional
    content: If present, the reason the Content Cache failed to register itself with
      Apple.
  - key: startup-status
    title: Startup status
    type: <string>
    presence: optional
    rangelist:
    - FAILED
    - MIGRATING_DATA
    - OK
    - PENDING
    content: The status of the Content Cache's registration with Apple.
  - key: tetherator-status
    title: Tetherator status
    type: <integer>
    presence: optional
    rangelist:
    - -1
    - 0
    - 1
    content: |-
      The status of tethered caching, which is the Content Cache with a shared internet connection, which is one of the following values:
      - '-1' : Unknown
      - '0' : Disabled
      - '1' : Enabled
  - key: sending-reports
    title: Sending metrics reports
    type: <boolean>
    presence: optional
    content: When present, a value of `true` indicates that the cache is sending metrics
      reports to the URL specified in the `ManagementStatusTarget` key in the installed
      `ContentCaching` configuration.
  - key: report-response-code
    title: Metrics report response code
    type: <integer>
    presence: optional
    content: When present, contains the HTTP response code that the Content Cache
      received when it failed to send the metrics report to the target URL.
  - key: report-error
    title: Metrics report error
    type: <string>
    presence: optional
    content: When present, indicates why the Content Cache failed to send the metrics.
  - key: version
    title: Version
    type: <string>
    presence: required
    content: The version number of the Content Cache software.
examples:
  title: Status item example
  files:
  - file: data/docc-examples/remotemanagementmodel/status/content-cache.status/example1.json