The declaration to configure a connection to a screen-sharing host.
| Setting | Type | Required | Default | Manual Install | Supported OS |
|---|---|---|---|---|---|
Unique Identifier ConnectionUUID A unique identifier for this connection when it's in a connection group. | string | required | — | ✓Yes | macOS (14.0+) |
The name of the connection. DisplayName The name of the connection. | string | required | — | ✓Yes | macOS (14.0+) |
Host Name HostName The host name or IP address of the Mac that hosts the screen-sharing connection. | string | required | — | ✓Yes | macOS (14.0+) |
TCP Port Port The TCP port number on the host to initiate the connection. | integer | optional | — | ✓Yes | macOS (14.0+) |
Display Configuration DisplayConfiguration The display configuration for this connection. 1 subkey | dictionary | required | — | ✓Yes | macOS (14.0+) |
└─ DisplayType DisplayType The type of display for the connection, which has these allowed values:
- `Virtual1`: Create one virtual display.
- `Virtual2`: Create two virtual displays. | string | required | — | ✓Yes | macOS (14.0+) |
Authentication Credentials Asset Reference AuthenticationCredentialsAssetReference The identifier of an asset declaration that contains the required credentials for this connection to authenticate with the screen-sharing server. Set the corresponding asset type to `com.apple.asset.credential.userpassword`. | string | optional | — | ✓Yes | macOS (14.0+) |
