Content Caching Payload

The content caching payload configures the content caching service.

Template

Contents

• Content Caching Payload
  • Summary
  • Keys
    • AutoActivation
    • AllowPersonalCaching
    • AllowSharedCaching
    • CacheLimit
    • Port
    • DataPath
    • DenyTetheredCaching
    • LogClientIdentity
    • Parents
    • ParentSelectionPolicy
    • LocalSubnetsOnly
    • ListenRangesOnly
    • ListenRanges
    • PeerLocalSubnetsOnly
    • PeerFilterRanges
    • PeerListenRanges
    • PublicRanges

Summary

Name	Type	Title	Description	Required
AutoActivation	boolean	Automatically activate content caching	Users can’t turn off the content caching service.	always
AllowPersonalCaching	boolean	Caches the user’s iCloud data, such as photos and documents	Clients may take some time (hours, days) to react to changes to this setting; it does not have an immediate effect.	n/a
AllowSharedCaching	boolean	Cache non-iCloud content, such as apps and software updates	Clients may take some time (hours, days) to react to changes to this setting; it does not have an immediate effect.	n/a
CacheLimit	integer	Maximum Cache Size	The maximum number of bytes of disk space that will be used for the content cache. The value of zero allows unlimited space.	n/a
Port	integer	Port	TCP port on which the content caching service accepts requests for uploads or downloads. Set to 0 to pick a random port.	n/a
DataPath	string	Data Path	The path to the directory used to store cached content. Changing this setting manually does not automatically move cached content from the old to the new location. The path must be, or end with, /Library/Application Support/Apple/AssetCache/Data.	n/a
DenyTetheredCaching	boolean	Share Internet Connection	Share this computer’s Internet connection and cached content with iOS devices connected using USB.	n/a
LogClientIdentity	boolean	Log Client Details	Log the IP address and port number of clients that request content.	n/a
Parents	array	Parents IP Addresses	A list of the local IP addresses of other content caches from which this cache should download or upload content instead of downloading from or uploading to Apple directly.	n/a
ParentSelectionPolicy	string	Parent Selection Policy	The policy to use when choosing among more than one configured parent content cache.	n/a
LocalSubnetsOnly	boolean	Restrict Content To Local Network	Content Cache offers content to clients only on the same immediate local network.	n/a
ListenRangesOnly	boolean	Restrict To Listen Ranges	Provide content only to the clients specified by the listen ranges.	n/a
ListenRanges	array	Client Listen Ranges	A range of IPv4 and IPv6 addresses to restrict clients to.	n/a
PeerLocalSubnetsOnly	boolean	Restrict Peers To Local Network	Content Cache will only peer with other Content Caches on the same immediate local network, rather than with Content Caches that use the same public IP address as the device.	n/a
PeerFilterRanges	array	Client Filter Ranges	A range of peer IP addresses that the Content Cache will use to filter its list of peers to query for content.	n/a
PeerListenRanges	array	Client Listen Ranges	A range of peer IP addresses the Content Cache will respond to peer cache queries from.	n/a
PublicRanges	array	Public Ranges	A range of public IP addresses that the cloud servers should use for matching clients to Content Caches.	n/a

Keys

AutoActivation

Automatically activate content caching

Users can’t turn off the content caching service.

Type	Default	Required	Regex	iOS	macOS	Supervised
boolean	True	always	N/A	N/A	N/A	N/A

AllowPersonalCaching

Caches the user’s iCloud data, such as photos and documents

Clients may take some time (hours, days) to react to changes to this setting; it does not have an immediate effect.

Type	Default	Required	Regex	iOS	macOS	Supervised
boolean	True	N/A	N/A	N/A	N/A	N/A

AllowSharedCaching

Cache non-iCloud content, such as apps and software updates

Clients may take some time (hours, days) to react to changes to this setting; it does not have an immediate effect.

Type	Default	Required	Regex	iOS	macOS	Supervised
boolean	True	N/A	N/A	N/A	N/A	N/A

CacheLimit

Maximum Cache Size

The maximum number of bytes of disk space that will be used for the content cache. The value of zero allows unlimited space.

Type	Default	Required	Regex	iOS	macOS	Supervised
integer	0	N/A	N/A	N/A	N/A	N/A

Port

Port

TCP port on which the content caching service accepts requests for uploads or downloads. Set to 0 to pick a random port.

Type	Default	Required	Regex	iOS	macOS	Supervised
integer	0	N/A	N/A	N/A	N/A	N/A

DataPath

Data Path

The path to the directory used to store cached content. Changing this setting manually does not automatically move cached content from the old to the new location. The path must be, or end with, /Library/Application Support/Apple/AssetCache/Data.

Type	Default	Required	Regex	iOS	macOS	Supervised
string	N/A	N/A	N/A	N/A	N/A	N/A

DenyTetheredCaching

Share Internet Connection

Share this computer’s Internet connection and cached content with iOS devices connected using USB.

Type	Default	Required	Regex	iOS	macOS	Supervised
boolean	False	N/A	N/A	N/A	N/A	N/A

LogClientIdentity

Log Client Details

Log the IP address and port number of clients that request content.

Type	Default	Required	Regex	iOS	macOS	Supervised
boolean	False	N/A	N/A	N/A	N/A	N/A

Parents

Parents IP Addresses

A list of the local IP addresses of other content caches from which this cache should download or upload content instead of downloading from or uploading to Apple directly.

Type	Default	Required	Regex	iOS	macOS	Supervised
array	N/A	N/A	N/A	N/A	N/A	N/A

ParentSelectionPolicy

Parent Selection Policy

The policy to use when choosing among more than one configured parent content cache.

Type	Default	Required	Regex	iOS	macOS	Supervised
string	round-robin	N/A	N/A	N/A	N/A	N/A

Valid Choices

• first-available
• random
• round-robin
• sticky-available
• url-path-hash

LocalSubnetsOnly

Restrict Content To Local Network

Content Cache offers content to clients only on the same immediate local network.

Type	Default	Required	Regex	iOS	macOS	Supervised
boolean	True	N/A	N/A	N/A	N/A	N/A

ListenRangesOnly

Restrict To Listen Ranges

Provide content only to the clients specified by the listen ranges.

Type	Default	Required	Regex	iOS	macOS	Supervised
boolean	False	N/A	N/A	N/A	N/A	N/A

ListenRanges

Client Listen Ranges

A range of IPv4 and IPv6 addresses to restrict clients to.

Type	Default	Required	Regex	iOS	macOS	Supervised
array	N/A	N/A	N/A	N/A	N/A	N/A

PeerLocalSubnetsOnly

Restrict Peers To Local Network

Content Cache will only peer with other Content Caches on the same immediate local network, rather than with Content Caches that use the same public IP address as the device.

Type	Default	Required	Regex	iOS	macOS	Supervised
boolean	True	N/A	N/A	N/A	N/A	N/A

PeerFilterRanges

Client Filter Ranges

A range of peer IP addresses that the Content Cache will use to filter its list of peers to query for content.

Type	Default	Required	Regex	iOS	macOS	Supervised
array	N/A	N/A	N/A	N/A	N/A	N/A

PeerListenRanges

Client Listen Ranges

A range of peer IP addresses the Content Cache will respond to peer cache queries from.

Type	Default	Required	Regex	iOS	macOS	Supervised
array	N/A	N/A	N/A	N/A	N/A	N/A

PublicRanges

Public Ranges

A range of public IP addresses that the cloud servers should use for matching clients to Content Caches.

Type	Default	Required	Regex	iOS	macOS	Supervised
array	N/A	N/A	N/A	N/A	N/A	N/A