NetworkRelay
The declaration to configure Network Relay settings.
Declaration
object NetworkRelayProperties
| Name | Type | Description |
|---|---|---|
AllowDNSFailover | boolean | If |
ExcludedDomains | [string] | A list of domain strings to exclude from routing through the servers in |
ExcludedFQDNs | [string] | A list of Fully Qualified Domain Names (FQDNs) to exclude from routing through the servers contained in |
MatchDomains | [string] | A list of domain strings that the system uses to determine which connection to route through the servers in 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 If this list and |
MatchFQDNs | [string] | A list of Fully Qualified Domain Names (FQDNs) to route through the servers contained in |
Relays Required | [NetworkRelayRelayObject] | An array of dictionaries that describe one or more relay servers that the system can chain together. |
RelayUUID | string | A globally unique identifier for this relay configuration. The system uses this UUID to route managed apps through the servers in Available: iOS 27+ | iPadOS 27+ | visionOS 27+ |
UIToggleEnabled | boolean | If |
VisibleName Required | string | The name of the network relays that the system displays on the device. |
Discussion
Specify com.apple.configuration.network.relay as the declaration type.
Configuration availability
Allowed in supervised enrollment | iOS, macOS, Shared iPad, visionOS |
Allowed in device enrollment | iOS, Shared iPad, visionOS |
Allowed in user enrollment | iOS, Shared iPad, visionOS |
Allowed in local enrollment | iOS, macOS, Shared iPad, visionOS |
Allowed in system scope | iOS, macOS, Shared iPad, visionOS |
Allowed in user scope | macOS |
Apply | Multiple configurations are applied separately |