VPN¶
Summary¶
VPN¶
VPN
VPN Settings
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| dictionary | {‘AuthenticationMethod’: ‘Password’} | N/A | N/A | N/A | N/A | N/A |
| Name | Type | Title | Description | Required |
|---|---|---|---|---|
| AuthName | string | Account Username | The VPN account username | n/a |
| AuthPassword | string | Account Password | The VPN user password | n/a |
| AuthenticationMethod | string | Authentication Method | Authentication method. Either shared secret or certificate | n/a |
| PayloadCertificateUUID | string | Certificate UUID | The UUID of the certificate to use for account credentials | n/a |
| OnDemandEnabled | integer | Enable VPN On Demand | Enable VPN On Demand | n/a |
| OnDemandMatchDomainsAlways | array | On Demand Match Domains Always | n/a | |
| OnDemandMatchDomainsNever | array | On Demand Match Domains Never | n/a | |
| OnDemandMatchDomainsOnRetry | array | On Demand Match Domains On Retry | n/a | |
| OnDemandRules | array | On Demand Rules | An array of dictionaries defining On Demand Rules | n/a |
| DisconnectOnIdle | integer | Enable Disconnect on Idle | Disconnect after an on demand connection idles | n/a |
| DisconnectOnIdleTimer | integer | Disconnect on Idle time | Length of time to wait before disconnecting an on demand connection | n/a |
| RemoteAddress | string | Server | Hostname or IP address for server | n/a |
Keys¶
AuthName¶
Account Username
The VPN account username
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
AuthPassword¶
Account Password
The VPN user password
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
AuthenticationMethod¶
Authentication Method
Authentication method. Either shared secret or certificate
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
Valid Choices¶
- Password
- Certificate
- Password+Certificate
PayloadCertificateUUID¶
Certificate UUID
The UUID of the certificate to use for account credentials
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| string | N/A | N/A | N/A | N/A | N/A | N/A |
OnDemandEnabled¶
Enable VPN On Demand
Enable VPN On Demand
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| integer | N/A | N/A | N/A | N/A | N/A | N/A |
Valid Choices¶
- 0
- 1
OnDemandMatchDomainsAlways¶
On Demand Match Domains Always
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| array | N/A | N/A | N/A | N/A | N/A | N/A |
OnDemandMatchDomainsNever¶
On Demand Match Domains Never
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| array | N/A | N/A | N/A | N/A | N/A | N/A |
OnDemandMatchDomainsOnRetry¶
On Demand Match Domains On Retry
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| array | N/A | N/A | N/A | N/A | N/A | N/A |
OnDemandRules¶
On Demand Rules
An array of dictionaries defining On Demand Rules
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| array | N/A | N/A | N/A | N/A | N/A | N/A |
DisconnectOnIdle¶
Enable Disconnect on Idle
Disconnect after an on demand connection idles
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| integer | N/A | N/A | N/A | N/A | N/A | N/A |
Valid Choices¶
- 0
- 1
DisconnectOnIdleTimer¶
Disconnect on Idle time
Length of time to wait before disconnecting an on demand connection
| Type | Default | Required | Regex | iOS | macOS | Supervised |
|---|---|---|---|---|---|---|
| integer | N/A | N/A | N/A | N/A | N/A | N/A |