Quest is excited to announce that the On Demand Migration (ODM) PowerShell API module now includes support for common directory sync and device migration functions in ODM for Active Directory (ODMAD).
Detailed instructions for connecting to ODM and selecting your Organization are available in the ODMAD User Guide Appendix A: Using PowerShell. Note that if you are only using ODMAD and do not have any projects configured for content migration, you will get a warning when accessing the OrgID, which you can suppress by using the “SkipProjectCheck” flag.
Example:
- Install-Module OdmApi -Repository PSGallery
- Connect-OdmService
- Select-OdmOrganization -OrganizationId '6a572d6e-e26b-478b-aefc-8b03e9cea431' -SkipProjectCheck
What are the available commands for Directory Sync and Device Migration?
API functionality has been added for viewing environments, managing workflows, and running device migrations. Prior to utilizing the commands below, configure your project settings in the ODMAD UI, including adding environments, creating workflows, and configuring device migration settings.
View environment settings and objects
- Get-OdmAdEnvironment: View details for the environments in your Org, including filters, discovery info, delta tokens, domain details, and password sync settings
- Get-OdmAdServiceAccount: View the names of the auto-created ODMAD service accounts in cloud environments connected to this Org
- Get-OdmADDirectoryObject: View the basic details of objects discovered in an environment; includes the data displayed in the object grid, such as object type, name, DN, CN, sAMAccoutName, UPN, mail, mailnickname, and proxyaddresses
Manage directory sync workflows
- Get-OdmAdWorkflow: View list of workflows including names, descriptions, status, number of environments, and number of steps
- Get-OdmAdWorkflowRun: View the details of the latest run of a given workflow, including start and end time, status, and counts of errors, warnings, objects created, and objects updated
- Get-OdmAdWorkflowLog: View the logs for a specific workflow run; includes the data exported to CSV when selecting Download Logs from the UI
- Start-OdmAdWorkflow: Run a specific workflow
Manage device migrations
- Get-OdmAdDevice: View details of registered devices, including wave, environment, sAMAccountName, assigned profiles (ReACL, Migration, EntraID Join, Self Service, Interactive Client, Credentials, Cred Cache), statuses (Discovery, ReACL, Cutover, Cleanup, Cred Cache, ODJ, Entra ID Cutover), current version, last contact time, and last job message
- Get-OdmAdDeviceJob: View details of a given device job, including time and status for each task within the action
- Get-OdmAdDeviceTask: View details of tasks configured in the project, including name, type, and description
- Start-OdmAdDeviceCacheCredentials: Run the default system Cache Credentials action
- Start-OdmAdDeviceCleanup: Run the default system Cleanup action
- Start-OdmAdDeviceCutover: Run the default system Cutover action
- Start-OdmAdDeviceDiscovery: Run the default system Discovery action
- Start-OdmAdDeviceEntraIDCutover: Run the default system Entra ID Cutover action
- Start-OdmAdDeviceOfflineDomainJoin: Run the default system Offline Domain Join action
- Start-OdmAdDeviceReACL: Run the default system ReACL action
Note: The ODM PowerShell API module is regularly updated to support new features and functionality. Once you have installed the API module, view the complete list of available commands at any time by running: Get-Command -Module OdmApi
What’s next for the ODMAD API?
We will release additional functionality to orchestrate device migrations using PowerShell, including the ability to ReACL file shares, assign waves, and run custom device actions.
Further Information
For more information on this and many other features within On Demand Migration, check out the complete On Demand Migration User Guide. We welcome your feedback and suggestions below and invite you to visit us at Quest.com.