Contents

Relay

The payload that configures relay settings.

Declaration

object Relay

Properties

NameTypeDescription
AllowDNSFailoverboolean

If true, the device allows the relay to failover to the default system DNS resolver.

ExcludedDomains[string]

A list of domain strings to exclude from routing through the servers in Relays. Any connection that matches a domain in the list exactly or is a subdomain of the listed domain won’t use the relay server.

ExcludedFQDNs[string]

A list of Fully Qualified Domain Names (FQDNs) to exclude from routing through the servers contained in Relays. Any connection that matches an FQDN in the list exactly won’t use the relay server. When MatchDomains is also present, any FQDN listed in the list should be a subdomain of at least one MatchDomain value, otherwise it will not have any effect.

MatchDomains[string]

A list of domain strings that the system uses to determine which connection to route through the servers in Relays.

Any connection that matches a domain in the list exactly or is a subdomain of the listed domain uses the relay servers, unless it matches a domain in ExcludedDomains.

If this list and MatchFQDNs are empty, the system routes traffic to all domains to the relay servers, except those that match an excluded domain or excluded FQDN.

MatchFQDNs[string]

A list of Fully Qualified Domain Names (FQDNs) to be routed through the servers contained in Relays. Any connection that matches an FQDN in the list exactly uses the relay servers. If this list and MatchDomains are empty, the system routes traffic to all domains to the relay servers, except those that match an excluded domain or excluded FQDN.

Relays Required[Relay.Relay]

An array of dictionaries that describe one or more relay servers that the system can chain together.

RelayUUIDstring

A globally unique identifier for this relay configuration. The system uses this UUID to route managed apps through the servers in Relays. This key is required for user enrollment.

UIToggleEnabledboolean

If true, the device allows the user to disable this network relay configuration.

Discussion

Specify com.apple.relay.managed as the payload type.

Profile availability

Device channel

iOS, macOS, Shared iPad, tvOS, visionOS

User channel

macOS

Allow manual install

iOS, macOS, tvOS, visionOS

Requires supervision

NA

Requires user-approved MDM

NA

Allowed in user enrollment

iOS, visionOS

Allow multiple payloads

iOS, macOS, Shared iPad, tvOS, visionOS

Topics

Objects

See Also

Networking