Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jamf/JamfMigrator
A tool to migrate data granularly between Jamf Pro servers
https://github.com/jamf/JamfMigrator
Last synced: 3 months ago
JSON representation
A tool to migrate data granularly between Jamf Pro servers
- Host: GitHub
- URL: https://github.com/jamf/JamfMigrator
- Owner: jamf
- License: mit
- Created: 2017-07-18T16:16:57.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-01-25T15:29:56.000Z (10 months ago)
- Last Synced: 2024-04-18T19:37:52.268Z (7 months ago)
- Language: Swift
- Size: 30.7 MB
- Stars: 130
- Watchers: 21
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-macadmin-tools - https://github.com/jamf/JamfMigrator
README
# Jamf Migrator
  
   
Download the current release: [Jamf Migrator](https://github.com/jamf/JamfMigrator/releases/latest/download/jamf-migrator.zip)
A tool to migrate data granularly between Jamf Pro servers
Migrate items from one Jamf server, or XML file(s), to another. If an item (based on name) within a category exists on both source and destination, the destination item will be updated with values from the source server.
Username and password fields can be hidden/shown using the disclosure tringle on the left.
When migrating files be sure to open the 'raw' folder.
Devices (computers and iOS), Groups, Policies, and Configuration Profiles can be targeted to a particular site.
Servers can be removed from the (source/destination) list by holding down the option key while selecting the server. A warning will be presented to verify the removal.
**Limitations/requirements to be aware of:**
* Passwords can not be extracted through the API which impacts migrating distribution points, computer management account, account used for LDAP. A password can be supplied for each service account, but credentials may need to be reset on the destination server for more complex configurations.
* Certificate used for LDAPS does not migrate.
* Icons associated with Mac App Store apps are not migrated as the API does not support it.
* Only AFP and SMB shares can be migrated.
* Patch management is not available through the API impacting smart groups dependent on patch management extension attributes.
* If endpoints (computers, policies, configuration profiles...) have duplicate names on the source server issues will arise if the app is used to update those items from the source to destination server. As each item is migrited it will overwrite the previous item with the same name.
* Migrating smart/static groups with criteria containing groups will fail if the parent group tries to migrate before the group in the criteria. Migrating groups several times should allow all the nested groups to migrate before the parent group.
* Institutional disk encryptions that contain the private key cannot be migrated.
* Approved System/Kernel Extension payloads do not migrate properly. Display names are dropped and additional keys/values are added by the Jamf API that results in a corrupt profile and failure in profile deployment.
* Policies - The Software Update payload does not migrate. Also, within the packages payload, setting for the distribution point will not migrate.
* Objects with trailing spaces in the name will migrate once but the process of uploading through the API removes those spaces. This causes issues re-migrating those objects as the names no longer match.
* Users and usergroups used in policy limitations/exclusions do not migrate as the API does not provide that information.
* Packages
- Only package metadata (display name, file name, size, ...) is migrated. To migrate the actual package either use your browser, Jamf Admin, or [jamfcpr](https://github.com/BIG-RAT/jamfcpr)
- The API allows for the creation of multiple packages, with different display names, to reference the same package file name. The Jamf Pro console prevents this as there should be a one to one mapping.
* Saving of objects whos name contains a : (colon) will be saved using a ; (semi-colon).
* Enabled state of mobile device applications is not handled in the API, as a result all migrated mobile device applications will be enabled on the destination server whether it is enabled or disabled on the source.
* Configuration Profiles -> Applications & Custom Settings -> External Applications settings will not migrate/export properly. The form generated by the custom schema is not migrated/exported, rather the current settings from the form are migrated/exported. The migrated profile will show the current setting for the external applicaton under the 'Upload' section within Application & Custom Settings.
The Selective tab provides the ability to select a subset of (or all) items within a collection of objects. For example you might only want to transfer 4 scripts from a larger pool of existing scripts.
Also, policies may have their dependencies checked/migrated using the Migrate Dependencies button. Only 'top-level' dependencies are checked. i.e. if the scope is being migrated and contains nested computer groups or groups assigned to a site that doesn't exist on the destination server the policy migration will likely fail.
Note: The ID of any object can be seen my hovering the mouse over the object.
Files exported using jamf-migrator can be imported into another Jamf Pro server. Be sure to open the 'raw' folder when importing.
**Important:** Trimmed XML files cannot be used as they are missing data required for the migration.
**Preferences:**
* macOS Configuration Profiles
* macOS Applications
* Restrictions
* Policies
* Mobile Device Configuration Profiles
* Mobile Device Applications
* Static Computer Groups
* Static Mobile Device Groups
* Static User Groups
In addition to scoping options the following are available:
* Policies can be copied in a disabled state
* Able to copy only items missing from the destination server - create only
* Able to copy only items currently on the destination server - update only
** object name is used to determine whether or not it is on the destination server **
Options to export XML from the source server are also available.
* Raw Source XML gives you the XML from the source server before any modifications, like removing the id tag(s) and value(s).
* Trimmed Source XML give you the XML that is sent to the destination server.
* Save only saves the XML files and does not send them to the destination server.
* Save the object XML either with or without its scope. Unchecked removes the scope.
* Note Save only and Raw Source XML options should not be selected when File Import is being used.
Options for migrating object(s) (groups, policies, and configuration profiles) to a particular site can be set.
* When copying an object to a site, the site name is appended to the object name.
* Groups with groups as a criteria will not copy properly, moving them should be fine.
The number of concurrent API operations (from 1 to 5), sticky sessions (when available), forcing basic authentication, color scheme, number of log files to retain, and number of servers can be remembered.
Migrated computers can show as managed by setting the management account.
Set a password for following migrated service accounts; bind, ldap, file share Read/Write, and file share Read-only.
Note, the same password will be applied if you have multiple binds, or ldap servers, or file shares coonfigured.
**Migration Summary:**
* To get details on how many items were created/updated or failed to migrate type ⌘S, or select Show Summary under the File menu.
* Additional information about each count can be obtained by clicking on the number. For example, if we want to see a list of the 28 failed scripts, click on the 28.
Information about successes/failures can be found in the log, located in
```
~/Library/Containers/com.jamf.jamf-migrator/Data/Library/Logs/jamf-migrator/_
If you have used jamf-migrator and saved passwords you will see the following after launching a new version.
If you'd like the new version to access existing credentials select the desired option.
**Important:**
* There are many dependencies between items, if they are not met transfers fail. For example, if a policy is site specific the site must be migrated before the policy; if a distribution point has a building and/or department defined those need to migrate first... If everything is migrated the order of sections is already taken care of, if you choose not to move some items that's where you can have issues.
* Summary window doesn't seem to be the most responsive. May need to click the window or give the cursor some extra motion before the detailed summary appears.
**Note:** the app can also be used to clear out a Jamf server. Typing the following after launching the app will set it into removal mode. Items from the destination server are deleted once Go is clicked.
```
touch ~/Library/Containers/com.jamf.jamf-migrator/Data/Library/Application\ Support/jamf-migrator/delete
```
* You can also toggle the mode using ⌘D or select Toggle Mode from View in the menu bar.
## Running from the command line
Help is available by running:
```
/path/to/jamf-migrator.app/Contents/MacOS/jamf-migrator -help
```
Running the following in Terminal will export all objects (full XML) that can be migrated:
```
/path/to/jamf-migrator.app/Contents/MacOS/jamf-migrator -source your.jamfPro.fqdn -export -objects allobjects
```
In the event you have multiple entries in the keychain for a server you'll need to specify which username to use. For example:
```
/path/to/jamf-migrator.app/Contents/MacOS/jamf-migrator -source dev.jamfcloud.com -destination prod.jamfcloud.com -objects "categories,buildings" -migrate -sourceUser devadmin -destUser prodadmin
```
Before running an export via command line at least one export from the app must be manually run saving the source username and password or client ID and secret.
To migrate object(s) using the command line, something like the following can be used:
```
/path/to/jamf-migrator.app/Contents/MacOS/jamf-migrator -source your.jamfPro.fqdn -destination dest.jamfPro.fqdn -objects categories,buildings -migrate
```
If importing files, the import folder must be selected in the UI before the command line can be successfully run.
To set an ldap id of 3 on jamf user accounts and force that id (also converts local accounts to ldap) use the following:
```
/path/to/jamf-migrator.app/Contents/MacOS/jamf-migrator -ldapid 3 -source /Users/admin/Desktop/export/raw -migrate -objects jamfusers
```
This can also be accomplished using the UI by launching jamf-migrator from Terminal:
```
/path/to/jamf-migrator.app/Contents/MacOS/jamf-migrator -ldapid 3
```
## History
**v7.4.2**
Resolve authentication impacting command line usage (issue #100) and initial token generation (issue #101).
**v7.4.1**
Resolve issue with token renewal. Resolve issue when running from the command line. Resolve issue removing policies. Resolve issue migrating self service icons.
**v7.4.0**
Resolve scrolling issue with selective migrations. Better handling of computers/mobile devices with duplicate names. Minor layout changes. Ability to sort ascending or descending object list in selective migration.
**v7.3.1**
Work to resolve issue (#91), logging in with API clients.
Add option to copy only items not on the destination server - create only.
Add option to copy only items currently on both source and destination servers - update only.
Add option to set the number of servers/folders saved.
**v7.2.2**
Fix version lookup with Jamf Pro 11, background threading issue.
**v7.2.1**
Fix issue logging into Jamf Pro 11, issue #91. Update token refresh method.
**v7.2.0**
Add support for API client in both the UI and command line.
**v7.1.1**
Prevent configuration profiles that include a Filevault payload from migrating. Fix export of smart comuter/device groups. Fix color mismatch (issue #88)
**v7.1.0**
Command line functionality. Note, -backup has been renamed -export and allows for specific types of objects to be exported. Exported scripts no longer have characters XML encoded. Expire tokens when quitting app.
**v7.0.2**
Make disclosure triangle more visible in light mode with default color scheme
Fix counter when deleting items
better handling of access to previously selected folders
better handling of preferences as they are changed
**v7.0.1**
prevent sleep while migrating
fix token refresh
**v7.0.0**
Redesigned UI. Add ability to show/hide username and password fields. Migrate locally created classes and delete any class. Add ability to force basic authentication.
**v6.3.0**
Add ability to utilize selective migration while using exported files as the source. Fix crash (issue #80) when Site is selected. Show text while icons are being uploaded for self service policies and iOS apps. Fix issue with selective migration of policies.
**v6.2.7**
Fix crash when running on a machine for the first time (#79). Invalidate tokens when switching servers and stop token refresh once migration competes. Better user experience when working with export options and the disable export only button.
**v6.2.6**
Fix issues #77 (self service display name) and #78 (crash when checking for updates)
**v6.2.5**
Better handling of package filename/display name lookups.
**v6.2.4**
* Fix credentials/servers not being saved.
* Fix token not refreshing.
* Disable destination server/credential fields if export only is detected at launch.
* Add disable export only button if setting is detected at app launch. Button does not disable xml export, only the export only option.
**v6.2.2**
* Better visual response when changing source/destination server.
* Fix authentication issue that resulted when the Jamf Pro web app was disabled.
**v6.2.1**
* Fix site lookups (migrating to a site) when using bearer token.
* Fix issue where categories were not created when need be during dependency migration (policies).
* Update version check alert to focus on new version if available.
* Add warning about not being able to use Save Only while in delete mode.
* Add ability to migrate iOS devices to a site on the same server.
**v6.2.0**
* Fix filenames that get characters xml encoded when importing files.
* Improved icon handling, determine appropriate location for the upload. If cloud servicers connection is enable self service icons will update within the policy.
* Add support for Bearer authentication to the classic API.
* Fix issues on importing files from previously selected folder.
* Misc code cleanup.
**v6.0.1**
* Allow migration of computers to a site.
* Moved show summary under View in the menu bar. Add ability to toggle delete mode under View in the menu bar.
* Progress bar changes color as failurs occur.
* Provide a warning if a single package filename is referenced by multiple package display names. Will not create duplicate references on the destination server.
* Buildings are migrated with full address information.
* Selective migration of multiple policies with migrate dependencies selected is more reliable.
* Handle netboot servers being removed from Jamf Pro.
* Fix issue with some buttons used with bulk migrations.
**v5.9.3**
* Fixed issue saving files with names that contain a / (forward slash). Noted the : (colon) is a reserved character and cannot be used in a file name, ; (semi-colon) will be subtituted for it. This does not impact the name that appears in Jamf Pro.
**v5.9.2**
* Fixed issue with self service icons when cloud services connector is not referenced.
**v5.9.1**
* Fixed issue self service icon migrations.
**v5.9.0**
* With great sadness (computer) configurations have been removed as an object that can be migrated.
* Added ability to select the location of exported files.
* Fixed crash that would occur when importing files while on the Selective tab.
* Add command line options for setting an ldap id on jamf user accounts and converting standard jamf accounts to ldap accounts.
**v5.8.3**
* Fix animation not stopping under certain conditions when no objects are found to migrate.
* Fix issue where policies would list multiple times in selective mode.
**v5.8.2**
* Change filter, add button to clear filter
* Remember permissions on folder selected for file imports.
* Add browse button for selecting folder of import files.
* Resolve crashes when application is first run on a machine.
**v5.8.0**
* Chasing down miscellaneous crashes.
* Test authentication against the restrictedsoftware API endpoint (instead of buildings), allowing site admins to use the app.
* Add ability to filter objects listed when doing a selective migration.
**v5.7.0**
* Better handling of Help window.
* Better results when hitting the STOP button
* Interface clean-up.
* Miscellaneous code fixes.
**v5.6.2**
* Resolve crash when importing files located outside the ~/Downloads folder.
* Resolved issue related to migrating the computer as managed.
* Added option to remove conditional acccess ID from computer reccord.
* Better handling of preferences window when it is in the backcground.
**v5.6.0**
* Ability to move users to a particular site.
* Ability to set computer management account.
* Ability to set a password for service accounts associated with bind, ldap, and file share resources.
**v5.4.0**
* Resolve fix issue (#57), app crashing when copy preferences are changed.
* Removed select all/none checkbox. Toggle all/none by holding the option key down when selecting a class of objects to migrate.
* Add ability to set concurrent API operations (from 1 to 20) and set the number of log files to keep.
* Update readme and help.
**v5.3.2**
* Resolve issue migrating self service icons when using files as the source.
**v5.3.1**
* Replaced use of curl to upload icons with native Swift functions. If the same Self Service icon is used on more then one policy, download icon only once.
* Fixed jamf user/group lookups and counter status/labeling.
* Clear current list of objects on the selective tab if the source server changes.
* Fix issue migrating computers where their inventory contains a volume of size 0 or negative partition size.
**v5.2.9**
* Prevent icon from being deleted before it is saved when using save only. Note, if saving both raw and trimmed XML the icon will only be saved under the raw folder. If saving only trimmed XML it will be saved under the trimmed folder.
**v5.2.8**
* Tweaked icon download routine.
**v5.2.7**
* Changes on icon migration, where they're cached and check for a successful upload, retry if it failed.
* Resolved issue where query would hang when looking to delete policies (and there were none) and saving xml was enabled.
**v5.2.5**
* Resolve issue (#53) when using LDAP groups in limitations/exclusions.
* Resolve miscelaneous 404 errors in the log.
**v5.2.3**
* Added code to prevent the UUID of macOS configuration profiles from potentially being changed during an update. Credit to @grahampugh for identifying (and blogging about) the issue.
**v5.2.2**
* Code cleanup and fix issue (#50) where app would crash if preference for saveRawXmlScope was missing.
**v5.2.1**
* Fixed smart/static group lookups giving 404 responses.
**v5.2.0**
* Exporting (saving) raw or trimmed XML now has the to include/exclude the scope.
* Updated help.
* Better handleing in bringing the preferences window to the foreground when it is already open, but behind another window.
**v5.1.0**
* Addressed several issues around GET and POST counters, including issues #43 and #48.
* Updated UI. Replaced POST with either POST/PUT (for migrations) or DELETE (for removals), issue #47.
* Fixed issue where user/iOS device/computer groups would not migrate if they were the last item to migrate.
* Allow resizing of summary window.
* Resolved issues around migrating policies along with their dependencies in the proper order.
* Added summary for items removed.
**v5.0.3**
* Provide additional logging around icon migration. Slight change in process (issue #46).
* Better handling of Jamf Pro API (UAPI) calls.
* Use encoding different than what the Jamf server uses for the ampersand in the name of a macOS configuration profile (issue #45).
**v5.0.1**
* Fix app crashes during XML export.
**v5.0.0**
* Introduce smart selective migrations for policies. When migrating a policy dependent items (scripts, packages, printers, computer groups, ...) will also be migrated/updated, if desired. Only 'top-level' dependencies are checked. i.e. if the scope of a policy is being migrated and contains nested computer groups or groups assigned to a site that doesn't exist on the destination server the policy migration will likely fail. Adding smart migrations is planned for other items.
* Resolve problem of migrating LDAP Jamf User Groups to Jamf Pro v10.17+ (issue #42).
**v4.1.3**
* Resolved app crash when doing a selective migration on groups.
**v4.1.2**
* Added site None to list of available sites to migrate to.
* Increased concurrent threads for post/put/delete from 1 to 3.
* Speedier listing of objects when using selective migration.
**v4.1.0**
* Added the ability to migrate disk encryption configurations. Since passwords cannot be migrated Institutional configurations containing the private key will not migrate.
**v4.0.0**
* Added the ability to migrate objects (groups, policies, and configuration profiles) to a particular site, either on the source server or another server.
* Re-added button to bring up preferences.
**v3.3.5**
* Resovled script parameter issue (#34)
**v3.3.4**
* Resovled display issue with High Sierra (issue #31)
* Resovled issue where blank lines were removed from scripts when migrated (issue #33)
**v3.3.3**
* Markdown formatting and spelling corrections. Thanks @homebysix
**v3.3.2**
* Fixed issue where icons were not migrating
* Fixed app crash issue (#28) that resulted when running in removal mode and no credentials were entered for the source server.
**v3.3.0**
* Adjustment to the GUI for Dark Mode
* App is now sandboxed, hardened, and notarized
* Updated help with new images and file paths
**v3.2.2**
* Fixed issue #24, group and policy selective removal broken.
* Changed arrangement of drop-downs on selective to align with suggested migration order.
* Split selective migration/removal or group items into smart and static.
* Fixed issue where the listing of items in selective mode would not refresh as desired.
**v3.2.0**
* Tabs reordered, General tab is now first to align with suggested migration order.
* Updated tabs/buttons used for navigating between General, macOS, iOS, and Selective sections.
* Buttons for items to migrate are off by default when the app is launched.
* You can now switch back and forth between removal and migration modes using ⌘D.
* When using the Selective tab, items are removed from the list as they are deleted from the server. Once all selected items are removed the list is grayed out.
* Fixed an issue with Policies and Selective migration where the app could become unresponsive. Policies should be listed much more quickly.
* Fixed an issue where groups would not be listed when working with the Selective tab.
* Fixed potential crash when importing a software update server from an XML file.
* Fixed issue where xxxgroup would be displayed along with staticxxxgroup and smartxxxgroup in the summary.
* Fixed an issue where a computer record would get resubmitted indefinitely.
* Fixed issued with log file names.
* Fixed issue where migration order might not go as designed.
**v3.1.0**
* Resolved app crashes when exporting XML and destination server field is blank.
* Resolved potential app hanging when migrating extension attributes that include patch policy EAs.
* Re-tool preferences.
* Removed preferences button and help button to prevent duplicate windows from opening.
* Resolved issue where scripts could get corrupted when migration.
**v3.0.6**
* Items will now migrate if category, building, or department is missing on the destination server. The field will be blanked out to allow the migration.
**v3.0.5**
* Policies with the Account payload can now be migrated. **Note:** Account password is set to `jamfchangeme`.
* Resolved an issue where a smart group with thousands of computers would not get cleared.
* Resolved issue migrating machines with duplicate serial numbers or MAC addresses. Duplicate addresses are cleared.
* Resolved issue trying to copy computers with no serial number.
* Resolved issue where a policy name starting with a space would lose the leading space when it was posted to the new server.
* References to the source server in the App Config are now updated to the destination server.
**v3.0.0**
* Added ability to use locally stored XML files as a source rather than a server.
* Added ability to migrate macOS and iOS Mac App Store apps.
**v2.8.0**
* Moved text manipulation to main thread, fixing issues where the endpoint URL was incorrect.
* **Changed tab order** - tabs through server to username to password.
* Updated migration order to address issue #18.
* Removed forced debug mode accidentally left in the previous beta.
* Lightly grayed out GET/POST related fields to indicate they are not for user input.
* Added button for quick access to preferences and help.
* Help window can now be displayed while running migrations.
* Changes to the GUI, moved tabs to top of section and added arrows to selective migration subjects.
* Added removing the scope from static computer groups/mobile device groups/user groups, addressing issue #19.
* Grayed out source server when doing removals to make it more clear from which server items get removed.
* Updated Help.
* Added 'check for updates...' under jamf-migrator in the menu bar.
* Added additional logging, in debug mode. Minor code adjustments.
* Added ability to export xml. Added cache clearing to authentication / server availability check in an effort to resolve 503 errors when the api is actually available.
**v2.7.2**
* Corrected encoding issue (#17) of special characters that caused authentication failures.
**v2.6.3**
* Corrected an issued with self service icons not migrating if the icon name contained a space.
**v2.6.2**
* Resolve issue #14, items not migrating in the proper order.
**v2.6.0**
* Deferrals no longer stripped from policies.
* Only log xml from failed items when in debug mode.
* More informative logging, give reason of failure along with http status code.
* Move history files to ~/Library/Logs/jamf-migrator and change extension to log. Refer to them as log files now.
* Added summary to provide count of items created, updated, and failed (⌘S) after a migration run.
* Patch Extension Attributes are no longer migrated.
* Log file naming has been corrected, for future logging. Current logs named incorrectly need to be manually deleted or renamed. Issue#13
* Added recommended migration and dependencies to help. Issue#12
* Migration of icons used in self service for newly created policies. Updating an existing policy will not update the existing icon on the destination server.
**v2.2.5**
* Added migration of computer configurations. Note, it is possible to delete the parent of a smart configuration, thus orphaning the 'child' config. An orphaned child configuration is not accessible through the API, as a result it cannot be migrated. In the event the orphaned child configuration(s) also has child configuration(s), those child configuration(s) are turned into parent configuration(s).
* Added ability to select frequently used source/destination servers from the user interface. Up to 10 server are selectable by using the up/down arrows to the right of the URL text box.
**v2.1.5**
* Added migration of dock items.
* Added stop button to stop the migration in progress.
**v2.1.4**
* Added migration of directory bindings.
**v2.1.3**
* Fixed smart group migration failures when done selectively.
* Fixed advanced computer search duplication if migrated more then once, they should update now if changed.
* Fixed authentication verification when Jamf Server utilizes SSO (thanks @ftiff).
**v2.1.0**
* Added the ability to migrate Jamf server accounts (users and groups). Newly created accounts on the destination server will be created without a password (can't migrate passwords). The account being used to authenticate to the destination server is not migrated if it also exists on the source server. The migration of accounts depends on the existence of related sites and LDAP servers in order to be successful.
**v2.0.0**
* Change to the user interface. Grouped similar categories together.
* Added iOS items.
* Selective migration now allows the selection of multiple items, using control and/or shift key.
* Added selective removal of items within a category.
**v1.2.1**
* fixed issue where app would hang if last/only item migrated had no endpoints.
* credentials no longer needed for source server when removing data.
* UI button improvements for select all/none (thanks @jdhovaland).
**v1.2.0**
* Fixed the issue migrating computers with the xprotect tag having no value.
* Selective migration now lists endpoints alpha-numeric.
* Added debug logging. To enable, launch the app from terminal:
```
…/jamf-migrator.app/Contents/MacOS/jamf-migrator –debug
```
* Debug info is added to the history file
* Easily open the history folder from View on the menu bar, or ⌘L