Contents

StatusContentCacheServiceContentCacheStatusObject

The basic set of AssetCache status items

Declaration

object StatusContentCacheServiceContentCacheStatusObject

Properties

NameTypeDescription
activatedboolean

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.

activeboolean

If true, the Content Cache is ready to serve requests.

cache-statusstring

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

portinteger

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

private-addresses[string]

An array of the Content Cache’s local IP addresses.

public-addressstring

The public IP address of the Content Cache.

registration-errorstring

If present, the reason the Content Cache failed to register itself with Apple.

registration-response-codeinteger

If present, the HTTP response code that the Content Cache received when it failed to register itself with Apple.

registration-startedstring

The RFC 3339 timestamp for when the Content Cache began registering itself with Apple. This value is only available during registration attempts.

registration-statusinteger

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.

report-errorstring

When present, indicates why the Content Cache failed to send the metrics.

report-response-codeinteger

When present, contains the HTTP response code that the Content Cache received when it failed to send the metrics report to the target URL.

sending-reportsboolean

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.

server-guid Requiredstring

The unique identifier of the Content Cache.

startup-statusstring

The status of the Content Cache’s registration with Apple.

tetherator-statusinteger

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

version Requiredstring

The version number of the Content Cache software.