Contents

VPN.TransparentProxy

The dictionary to use for a transparent proxy VPN type.

Declaration

object VPN.TransparentProxy

Properties

NameTypeDescription
AuthenticationMethodstring

The type of authentication method to use: Password, Certificate, or Password+Certificate.

Available in macOS 14 and later.

DisconnectOnIdleinteger

If 1, the VPN disconnects automatically disconnect after a period defined by DisconnectOnIdleTimer.

Available in macOS 14 and later.

DisconnectOnIdleTimerinteger

The number of seconds before the VPN disconnects. This value is only used if DisconnectOnIdle is 1.

Available in macOS 14 and later.

EnforceRoutesinteger

If 1, then all the VPN’s non-default routes take precedence over any locally-defined routes. If IncludeAllNetworks is 1, the system ignores the value of EnforceRoutes.

Available in macOS 14 and later.

OnDemandEnabledinteger

If 1, the system brings up the VPN on demand.

Available in macOS 14 and later.

OnDemandRules[VPN.VPN.OnDemandRulesElement]

Determines when and how the system uses an OnDemand VPN.

Available in macOS 14 and later.

Orderinteger

A positive integer.

Available in macOS 14 and later.

Passwordstring

The password to use for the account credentials. Only used if AuthenticationMethod is Password.

Available in macOS 14 and later.

PayloadCertificateUUIDstring

The UUID of the identity certificate as the account credential. If AuthenticationMethod is Certificate, and extended authentication (EAP) isn’t used, this certificate is sent out for IKE client authentication. If extended authentication is used, this certificate can be used for EAP-TLS.

Available in macOS 14 and later.

ProviderBundleIdentifierstring

If the VPNSubType field contains the bundle identifier of an app that contains multiple VPN providers of the same type (app-proxy or packet-tunnel), then the system uses this field to choose which provider to use for this configuration. If the VPN provider is implemented as a System Extension, then this field is required.

Available in macOS 14 and later.

ProviderDesignatedRequirementstring

If the VPN provider is implemented as a System Extension, then this field is required.

Available in macOS 14 and later.

ProviderTypestring

If the value of this key is app-proxy, the VPN service tunnels traffic at the application layer. If the value of this key is packet-tunnel, the VPN service tunnels traffic at the IP layer.

Available in macOS 14 and later.

See Also

Objects