<!--
{
  "availability" : [
    "macOS: 26.4.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "DeviceManagement",
  "identifier" : "/documentation/DeviceManagement/MigrationAssistantSettings",
  "metadataVersion" : "0.1.0",
  "role" : "Object",
  "symbol" : {
    "kind" : "Object",
    "modules" : [
      "Device Management"
    ],
    "preciseIdentifier" : "rmdm-declarations:MigrationAssistantSettings"
  },
  "title" : "MigrationAssistantSettings"
}
-->

# MigrationAssistantSettings

The declaration to configure Migration Assistant settings.

```
object MigrationAssistantSettings
```

## Discussion

Specify `com.apple.configuration.migration-assistant.settings` as the declaration type.

This declaration allows the device management service to configure Migration Assistant when it runs during Setup Assistant on a Mac. This makes it easy for users to do Mac-to-Mac migrations of enterprise devices when they setup a new Mac.

Configure the device to use the `AwaitingConfiguration` state after it enrolls with the server. The server needs to send the configuration and verify the configuration as both active and valid using the Declarative Device Management status, before it sends the [`DeviceConfiguredCommand`](/documentation/DeviceManagement/DeviceConfiguredCommand) command to exit that state.

The device reports Migration Assistant progress using the [`StatusMigrationAssistantState`](/documentation/DeviceManagement/StatusMigrationAssistantState) status item, and provides a report when migration completes using the [`StatusMigrationAssistantReport`](/documentation/DeviceManagement/StatusMigrationAssistantReport) status item.

### Configuration availability

|||
|--------------------------------|------------------------------------------------------------------------------------|
|Allowed in supervised enrollment|macOS                                                                               |
|Allowed in device enrollment    |N/A                                                                                 |
|Allowed in user enrollment      |N/A                                                                                 |
|Allowed in local enrollment     |N/A                                                                                 |
|Allowed in system scope         |macOS                                                                               |
|Allowed in user scope           |N/A                                                                                 |
|Apply                           |Multiple configurations are combined and applied as a single effective configuration|

### Configuration example

This configuration provides settings for a Mac to Mac migration.

```json
{
    "Type": "com.apple.configuration.migration-assistant.settings",
    "Identifier": "F3CD2AD7-85AA-4FF3-9264-A737259FB55E",
    "ServerToken": "5AB2B98C-FCE9-4A33-88B3-ADB05F081F77",
    "Payload": {
        "ShouldDoManagedMigration": true,
        "ExcludedAccounts": [
            "admin"
        ],
        "ExcludedPaths": [
            "Documents/Personal Items/"
        ],
        "RequiredPaths": [
            "Documents/Work Items/"
        ],
        "ShouldMigrateSecurityPrivacySettings": false
    }
}
```

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)