Contents

ContentCachingInformationResponse.StatusResponse

A dictionary that contains the status of content caching on a device.

Declaration

object ContentCachingInformationResponse.StatusResponse

Properties

NameTypeDescription
Activatedboolean

If true, the device has enabled content caching. Enabling content caching doesn’t guarantee service. See the Active key for the readiness of content caching to serve requests.

Activeboolean

If true, content caching is ready to serve requests.

ActualCacheUsedinteger

The actual amount of disk space, in bytes, that cached content uses. See related values CacheUsed and PersonalCacheUsed.

Alerts[ContentCachingInformationResponse.StatusResponse.AlertsItem]

An array that contains the error conditions the content cache detected that aren’t related to peer filter ranges, parent content caches, or peer content caches.

See AlertsForPeerFilterRanges for errors related to peer filter ranges.

See Parents and Peers for errors related to parent and peer content caches.

To display these alerts on the device, set DisplayAlerts to true in the installed ContentCaching profile.

AlertsForPeerFilterRangesContentCachingInformationResponse.StatusResponse.AlertsForPeerFilterRanges

The error conditions the content cache detected in the PeerFilterRanges in the installed com.apple.AssetCache.managed payload.

To display these alerts on the device, set DisplayAlerts to true in the installed ContentCaching profile.

CacheDetailsContentCachingInformationResponse.StatusResponse.CacheDetails

The amount of disk space that various categories of cached content use. Apple defines these categories and they’re subject to change.

CacheFreeinteger

The amount of disk space, in bytes, available to the content cache.

CacheLimitinteger

The maximum amount of disk space, in bytes, available to the content cache. A value of 0 indicates an unlimited amount. This value corresponds to CacheLimit in the installed ContentCaching profile.

CacheStatusstring

The level of cache pressure. LowSpace means cache pressure is high.

CacheUsedinteger

The amount of disk space, in bytes, cached content uses. Content caching allocates space in its cache for entire files even when it stores only part of those files in its cache.

DataMigrationCompletedboolean

If true, the content cache finished moving from one volume to another.

DataMigrationErrorContentCachingInformationResponse.StatusResponse.DataMigrationError

The error that occurred while the content cache moved from one volume to another.

DataMigrationProgressnumber

A floating-point number between 0.0 and 1.0 that indicates the percentage of progress in moving the content cache from one volume to another. A value of 1.0 indicates that the content cache has fully migrated.

MaxCachePressureLast1Hournumber

A floating-point number between 0.0 and 1.0 that represents how often the cache needed more disk space over the last hour of operation. A lower value is better.

Parents[ContentCachingInformationResponse.StatusResponse.ParentsItem]

An array of dictionaries that describes parent content caches.

Peers[ContentCachingInformationResponse.StatusResponse.PeersItem]

An array of dictionaries that describes peer content caches.

PersonalCacheFreeinteger

The amount of disk space, in bytes, available to the content cache for personal iCloud content.

PersonalCacheLimitinteger

The maximum amount of disk space, in bytes, available to the content cache for personal iCloud content. A value of 0 indicates an unlimited amount.

PersonalCacheUsedinteger

The amount of disk space, in bytes, available to the content cache for personal iCloud content.

Portinteger

The IP port number the content cache listens to for requests from clients, peers, and children.

PrivateAddresses[string]

An array of the content cache’s local IP addresses.

PublicAddressstring

The public IP address of the content cache.

RegistrationErrorstring

If present, the reason the content cache failed to register itself with Apple.

RegistrationResponseCodeinteger

If present, the HTTP response code the content cache received when it failed to register itself with Apple.

RegistrationStarteddate

The date when the content cache began registering itself with Apple. This value is only available during registration attempts.

RegistrationStatusinteger

The status of the content cache’s registration with Apple, which is one of the following values:

  • -1: Failed

  • 0: Pending

  • 1: Succeeded

RestrictedMediaboolean

If true, a restriction prevents caching of certain content types.

ServerGUIDstring

The unique identifier of the content cache.

StartupStatusstring

The status of the content cache’s registration with Apple.

TetheratorStatusinteger

The status of tethered caching, which is content caching with a shared internet connection, which is one of the following values:

  • -1: Unknown

  • 0: Disabled

  • 1: Enabled

TotalBytesAreSincedate

The start date to use when collecting data for the other TotalBytes values.

TotalBytesDroppedinteger

The amount of data, in bytes, that the content cache downloaded, but couldn’t add to its cache, since the TotalBytesAreSince date.

TotalBytesImportedinteger

The amount of data, in bytes, that the content cache received since the TotalBytesAreSince date.

TotalBytesReturnedToChildreninteger

The amount of data, in bytes, that the content cache served to its child content cache since the TotalBytesAreSince date.

TotalBytesReturnedToClientsinteger

The amount of data, in bytes, that the content cache served to client iOS, macOS, and tvOS devices since the TotalBytesAreSince date.

TotalBytesReturnedToPeersinteger

The amount of data, in bytes, that the content cache served to peer content caches since the TotalBytesAreSince date.

TotalBytesStoredFromOrigininteger

The amount of data, in bytes, that the content cache saved from the internet since the TotalBytesAreSince date.

TotalBytesStoredFromParentsinteger

The amount of data, in bytes, that the content cache saved from parent content caches since the TotalBytesAreSince date.

TotalBytesStoredFromPeersinteger

The amount of data, in bytes, that the content cache saved from peer content caches since the TotalBytesAreSince date.

Topics

Objects

See Also

Objects