Product Documentation

Cmdlet Reference

Jun 04, 2010

Cmdlet Summary

For PowerShell help, type Get-Help cmdlet-name.
  • To see examples, use the -examples option.
  • For detailed information, use the -detailed option.
  • For technical information, use the -full option.
Cmdlet Description
Add-XAServerMapping Adds a server mapping.
Add-XASettingOverride Specifies a value for an object property.
Get-XALegacySettingName Outputs the settings you can use with the Add-XASettingOverride cmdlet.
Get-XAMigrationObjectCount Outputs a count of objects in the legacy and new farms.
Get-XAMigrationOption Outputs the list of migration options.
Get-XAServerMapping Outputs the list of server mappings.
Get-XASettingOverride Outputs the list of object property value overrides.
Remove-XAServerMapping Removes a server mapping.
Remove-XASettingOverride Removes an object property value override.
Set-XAMigrationOption Sets migration options.
Start-XAMigration Starts the migration.

The Migration Tool cmdlets support the PowerShell common parameters. In particular, -Confirm and -Verbose can be helpful in the migration process.

Although the -WhatIf common parameter is supported, using the -PendingReportOnly option with the Start-XAMigration cmdlet provides more detailed information.

Add-XAServerMapping

Adds a mapping between a server in the legacy farm and a worker group in the new farm. You must specify the following options:
Option Description
-ServerName server-name MFCOM name of the server in the legacy farm.
-WorkerGroupName name Name of the worker group in the new farm. If the worker group does not exist, it is created.
For example, the following cmdlet maps the server named OfficeApps5 to the worker group named DenverAcctg.
Add-XAServerMapping -ServerName OfficeApps5  
-WorkerGroupName DenverAcctg

Add-XASettingOverride

Specifies a value for an object property (setting). This value is used for the object property in the new farm, regardless of the value of the property in the legacy farm (it overrides the setting in the legacy farm). To display the names of object properties you can specify with the Add-XASettingOverride cmdlet, use theGet-XALegacySettingName cmdlet.

You can specify the following options:
Option Description

-PropertyName property-name

Property name. You can use wildcards.

-ObjectType object-type

Object type.

Valid values are: Administrator, Application, FarmConfiguration, Folder, LoadEvaluator, Policy, and ServerConfiguration. You can use wildcards.

-Value

New property value.

-MatchValue

Original property value to match before overriding the setting with the new value. If the value does not match, the override is skipped.

If this option is omitted, the override always occurs.

-ObjectName object-name

Object name.

For example, the following cmdlet specifies a CPU priority level of "high" for migrated applications in the new farm.
Add–XASettingOverride CpuPriorityLevel High
The following cmdlet changes the CommandLineExecutable property value to C:\Program Files\Test\Test.exe when its current value is C:\ProrgramFiles (x86)\Test\Test.exe.
Add-XASettingOverride -PropertyName  
CommandLineExecutable -ObjectType Application  
-Value "C:\Program Files\Test\Test.exe"  
-MatchValue "C:\Program Files (x86)\Test\Test.exe"

Get-XALegacySettingName

Outputs the settings you can use with the Add-XASettingOverride cmdlet. You can specify the following options:
Option Description

-PropertyName property-name

Property name. You can use wildcards.

-ObjectType object-type

Object type.

Valid values are: Administrator, Application, FarmConfiguration, Folder, LoadEvaluator, Policy, and ServerConfiguration. You can use wildcards.

For example, the following cmdlet gets a list of valid settings that contain "LicenseServer" in the property name.
Get-XALegacySettingName *LicenseServer*
The following cmdlet gets a list of valid settings for object types that start with "Server" and that contain "LicenseServer" in the property name.
Get-XALegacySettingName *LicenseServer*  
-ObjectType Server*

Get-XAMigrationObjectCount

Outputs counts of objects in the legacy and new farms. Use the -ImportOnly option to generate the differences from an existing snapshot.

Get-XAMigrationOption

Outputs the list of migration options (that is, the migration options previously specified with Set-XAMigrationOption cmdlets).

Get-XAServerMapping

Outputs the list of all server mappings (that is, the mappings previously specified with Add-XAServerMapping cmdlets).

Get-XASettingOverride

Outputs the list of setting overrides (that is, object property values previously specified with Add–XASettingOverride cmdlets).

Remove-XAServerMapping

Removes a server mapping (that is, a mapping previously specified with an Add-XAServerMapping cmdlet).

Remove-XASettingOverride

Removes a setting override (that is, an object property value previously specified with an Add-XASettingOverride cmdlet).

Set-XAMigrationOption

Sets migration options.
Option Description

-RemoteServerName name

Name of the server in the legacy farm from which objects will be exported. This value is used if you do not specify the -RemoteServerName option in the Start-XAMigration cmdlet.

If you do not specify the -RemoteServerName option in the Start-XAMigration or Set-XAMigrationOption cmdlet, the migration ends.

-DataFolderPath path

Path to the folder where exported data from the legacy farm is placed. If the folder does not exist, the Migration Tool will attempt to create it.

If you do not specify this option, exported data is moved to the Data folder located under the Migration Tool installation files.

-ObjectType object-type

Object type. This option is used with the –Include and –Exclude options, which specify object names.

Valid values are: Administrator, Application, FarmConfiguration, Folder, LoadEvaluator, Policy, and ServerConfiguration.

-Include object-name

Object names to include in the migration. This option is used with the –ObjectType option. Separate multiple object names with commas. You can use wildcards.

-Exclude object-name

Object names to exclude from the migration. This option is used with the –ObjectType option. Separate multiple object names with commas. You can use wildcards.

-Enabled $false | $true

Provides an alternative to using the -Exclude * option to exclude all objects specified with the -ObjectType option from the migration.

For example, the following cmdlet uses the -ObjectType and -Exclude options to exclude applications named "A1" and "A2" from the migration.
Set-XAMigrationOption –ObjectType Application  
–Exclude A1, A2
The following cmdlet uses the -ObjectType, -Include, and -Exclude options to include all applications with a name containing "Microsoft" except "Office."
Set-XAMigrationOption –ObjectType Application  
–Include *Microsoft* –Exclude *Office*
The following cmdlet uses the -ObjectType and -Enabled options to disable migration of all applications.
Set-XAMigrationOption –ObjectType Application  
–Enabled $false

Start-XAMigration

Launches the migration. You can specify the following options:
Option Description

-RemoteServerName name

Name of the server in the legacy farm from which objects will be exported.

If you do not specify this option, but you specified a -RemoteServerName option in the Set-XAMigrationOption cmdlet, that name is used.

If you do not specify the -RemoteServerName option in the Start-XAMigration or Set-XAMigrationOption cmdlet, the migration ends.

-PendingReportOnly

Generates records that indicate which objects will be migrated and which values will be changed, but does not actually perform the migration.

This option provides more detail than the standard PowerShell -WhatIf option.

-ExportOnly

Exports objects from the legacy farm to a file, but does not import them to the new farm.

This option is generally used only when MFCOM cannot be used between the legacy farm and the new farm. In this case, use a Start-XAMigration –ExportOnly cmdlet on a server in the legacy farm.

-ImportOnly

Imports objects to the new farm.

This option is generally used only when MFCOM cannot be used between the legacy farm and the new farm. In this case, use a Start-XAMigration –ExportOnly cmdlet on a server in the legacy farm, collecting exported information in a file. Then, use a Start –XAMigration –ImportOnly cmdlet on a server in the new farm to import the objects, using the exported information.