title: Content Caching description: The declaration to configure the Content Caching service. payload: declarationtype: com.apple.configuration.content-cache.settings 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 apply: single payloadkeys: - key: AllowCacheDelete title: Allow cache delete type: presence: optional default: true content: If `true`, the system purges content from the cache automatically when it needs disk space for other apps when free disk space runs low on the computer. Set to `false` to maximize effectiveness of Content Caching. - key: AllowPersonalCaching title: Allow personal caching type: presence: optional default: true content: |- If `true`, the system caches the user's iCloud data. Changes to this value don't have an immediate effect. Clients may take some time to react to changes. > Note: > At least one of the `AllowPersonalCaching` or `AllowSharedCaching` keys need to be `true`. - key: AllowSharedCaching title: Allow shared caching type: presence: optional default: true content: |- If `true`, the system caches non-iCloud content, such as apps and software updates. Changes to this value don't have an immediate effect. Clients may take some time to react to changes. > Note: > At least one of the `AllowPersonalCaching` or `AllowSharedCaching` keys need to be `true`. - key: AutoActivation title: Auto activation type: presence: optional default: false content: |- If `true`, the system automatically activates the content cache when possible and prevents disabling it. If `allowContentCaching` is `false`, `AutoActivation` is also `false`. Removing a profile that set `AutoActivation` to `true` doesn't deactivate the Content Cache. - key: AutoEnableTetheredCaching title: Auto enable tethered caching type: presence: optional default: false content: If `true`, the system automatically enables Internet connection sharing when possible and prevent disabling Internet connection sharing. `DenyTetheredCaching` overrides `AutoEnableTetheredCaching`. Tethered caching requires Content Caching. - key: CacheLimit title: Cache limit type: presence: optional default: 0 content: The maximum number of bytes of disk space to use for the content cache. Set to `0` for unlimited disk space. Also serves as the upper bound to the `PersonalCacheLimit`. - key: DataPath title: Data path type: presence: optional default: /Library/Application Support/Apple/AssetCache/Data content: |- The path to the directory used to store cached content. Changing this setting manually doesn't automatically move cached content from the old location to the new one. To move content automatically, use the Sharing preference's Content Caching pane. The value must be (or end with) `/Library/Application Support/Apple/AssetCache/Data`. The system creates a directory and its intermediates for the given data path if it doesn't already exist. The directory is owned by `_assetcache:_assetcache` and has mode 0750. Its immediate parent directory (`.../Library/Application Support/Apple/AssetCache`) is owned by `_assetcache:_assetcache` and has mode `0755`. - key: DenyActivation title: Deny activation type: presence: optional default: false content: If `true`, the system disables Content Caching. This is the inverse of the `allowContentCaching` restriction in MDM. It overrides the `AutoActivation` key. Use this key to prevent launching the Content Caching service. - key: DenyTetheredCaching title: Deny tethered caching type: presence: optional default: false content: If `true`, the system disables tethered caching. - key: DeclarativeStatusInterval title: Declarative status interval type: presence: optional range: min: 300 max: 86400 default: 0 content: The time interval in seconds the system uses to update the `StatusContentCacheInfo` declarative status item. The reporting interval can't be less than 60 (1 per minute) or larger than 86400 (1 per day), defaults to 0 (off) - key: DisplayAlerts title: Display alerts type: presence: optional default: false content: If `true`, Content Caching displays exceptional conditions (alerts) as system notifications in the upper corner of the screen. - key: KeepAwake title: Keep awake type: presence: optional default: false content: If `true`, the system prevents the computer from sleeping as long as Content Caching is on (System Preferences > Sharing > Content Caching is on). Customers who want Content Caching to be as available as much as possible should turn this setting on. - key: ListenRanges title: Listen ranges type: presence: optional content: An array of dictionaries that describe a range of client IP addresses to serve. subkeytype: RangesItem subkeys: &id001 - key: RangesItem title: Ranges item type: content: A range of IP addresses to cache. subkeys: - key: type title: Type type: presence: optional rangelist: - IPv4 - IPv6 default: IPv4 content: The IP address type. - key: first title: First type: presence: required content: The first IP address in the range. - key: last title: Last type: presence: required content: The last IP address in the range. - key: ListenRangesOnly title: Listen ranges only type: presence: optional default: false content: If `true`, the content cache provides content to the clients in the `ListenRanges`. - key: ListenWithPeersAndParents title: Listen with peers and parents type: presence: optional default: true content: If `true`, the content cache provides content to the clients in the union of the `ListenRanges`, `PeerListenRanges` and `Parents`. - key: LocalSubnetsOnly title: Local subnets only type: presence: optional default: true content: If `true`, the content cache offers content to clients only on the same immediate local network only. The content cache offers no content to clients on other networks reachable by the content cache. If `LocalSubnetsOnly` is `true`, the system ignores `ListenRanges`. - key: LogClientIdentity title: Log client identity type: presence: optional default: false content: If `true`, the Content Cache logs the IP address and port number of the clients that request content. - key: Parents title: Parents type: presence: optional content: An array of the local IP addresses of other content caches that this cache should download from or upload to, instead of downloading from or uploading to Apple directly. The system ignores invalid addresses and addresses of computers that aren't content caches. The system skips Parent caches that become unavailable. If all parent content caches become unavailable, the content cache downloads from or uploads to Apple directly, until a parent content cache becomes available again. subkeys: - key: ParentsItem type: presence: required content: An IP address. - key: ParentSelectionPolicy title: Parent selection policy type: presence: optional rangelist: - first-available - url-path-hash - random - round-robin - sticky-available default: round-robin content: |- The policy to implement when choosing among more than one configured parent content cache. With every policy, the system skips parent caches that are temporarily unavailable. Allowed values: - `first-available`: Always use the first available parent in the Parents list. Use this policy to designate permanent primary, secondary, and subsequent parents. - `url-path-hash`: Hash the path part of the requested URL so that the same parent is always used for the same URL. This is useful for maximizing the size of the combined caches of the parents. - `random`: Choose a parent at random. Use this policy for load balancing. - `round-robin`: Rotate through the parents in order. Use this policy for load balancing. - `sticky-available`: Use the first available parent in the Parents list until it becomes unavailable, then advance to the next one. Use this policy for designating floating primary, secondary, and subsequent parents. - key: PeerFilterRanges title: Peer filter ranges type: presence: optional content: An array of dictionaries describing a range of peer IP addresses that the content cache uses to filter its list of peers to query for content. The content cache only queries peers in `PeerFilterRanges`. When `PeerFilterRanges` is an empty array, the content cache doesn't query any peers. subkeytype: RangesItem subkeys: *id001 - key: PeerListenRanges title: Peer listen ranges type: presence: optional content: An array of dictionaries describing a range of peer IP addresses the content cache responds to. When `PeerListenRanges` is an empty array, the content cache responds with an error to all cache queries. subkeytype: RangesItem subkeys: *id001 - key: PeerLocalSubnetsOnly title: Peer local subnets only type: presence: optional default: true content: If `true`, the content cache only peers 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. When `PeerLocalSubnetsOnly` is `true`, it overrides the configuration of `PeerFilterRanges` and `PeerListenRanges`. If the network changes, the local network peering restrictions update appropriately. If `false`, the content cache defers to `PeerFilterRanges` and `PeerListenRanges` for configuring the peering restrictions. - key: PersonalCacheLimit title: Personal cache limit type: presence: optional default: 0 content: The maximum number of bytes of disk space to use for the personal content cache. The content cache limits the maximum value to the `CacheLimit` value. Set to `0` to use the overall `CacheLimit`. - key: Port title: Port type: presence: optional default: 0 content: The TCP port number on which the content cache accepts requests for uploads or downloads. Set to `0` to pick a random, available port. - key: PublicRanges title: Public ranges type: presence: optional content: An array of dictionaries describing a range of public IP addresses that the cloud servers should use for matching clients to content caches. subkeytype: RangesItem subkeys: *id001 - key: ManagementStatusTarget title: Management status target type: presence: optional content: The target URL the system uses to send management statistics using an HTTP PUT request with a json dictionary as the payload. If the URL is an https URL (recommended) the `ManagementSecurityConfig` defines how the system secures the connection. The system sends the management statistics report to the target URL at an interval set by the `ManagementReportingInterval` value. - key: ManagementSecurityConfig title: Management security config type: presence: optional rangelist: - no-cert - signedByCACert - specificServerCert default: no-cert content: |- If the `ManagementStatusTarget` is an https URL, the system uses this field to determine how the connection is secured. - `no-cert`: The system uses regular https processing using the built-in anchor certificates. - `signedByCACert`: The system requires the https connection's certificate to be signed by the certificate provided in the `ManagementStatusCertificateReference` field. If your organization has a CA infrastructure this is the best choice. - `specificServerCert`: The system requires the https connection's certificate to match the certificate provided in the `ManagementStatusCertificateReference` field. - key: ManagementReportingInterval title: Management reporting interval type: presence: optional range: min: 60 max: 86400 default: 300 content: The reporting interval in seconds the system uses when `ManagementStatusTarget` is present. The reporting interval can't be less than 60 (1 per minute) or larger than 86400 (1 per day), and defaults to 300 (1 per 5 min). - key: ManagementStatusCertificateReference title: Management status certificate reference type: assettypes: - com.apple.asset.credential.certificate presence: optional content: The identifier of an asset declaration that contains the certificate the system uses to verify the security of the status reporting https connection. Required when `ManagementSecurityConfig` is set to `signedByCACert` or `specificServerCert`. examples: - title: Configuration examples files: - tab: Basic caching description: This configuration enables content caching for both personal and shared content with automatic activation. file: examples/declarative/declarations/configurations/content-cache.settings/example1.json - tab: Advanced caching description: This configuration sets up content caching with a parent cache server, a restricted listen range, and a fixed port. file: examples/declarative/declarations/configurations/content-cache.settings/example2.json