en-US/Get-RMMigration-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-RMMigrations</command:name> <command:verb>Get</command:verb> <command:noun>RMMigrations</command:noun> <maml:description> <maml:para>Get information for a migration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets information for a migration using the provided migration ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-RMMigrations</maml:name> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mid"> <maml:name>MigrationId</maml:name> <maml:description> <maml:para>ID of the migration you want information for.</maml:para> </maml:description> <command:parameterValue required="True">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="False" pipelineInput="False" position="Named" aliases="mid"> <maml:name>MigrationId</maml:name> <maml:description> <maml:para>ID of the migration you want information for.</maml:para> </maml:description> <command:parameterValue required="True">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <maml:description> <maml:para>This cmdlet goes into the interactive mode when no parameters are given.</maml:para> <maml:para>When at least one parameter is specified, the cmdlet runs in the non-interactive mode and validates that all<linebreak/> the required parameters are given. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>RMReturn Object</maml:name> </dev:type> <maml:description> <maml:para>This cmdlet returns a RMMigrationReturn object, which has the following attributes:</maml:para> <maml:para> RMReturn [int] ReturnCode RMError [String] ErrorCode [String] Message [String] Resolution RMWarning [String] ErrorCode [String] Message [String] Resolution [Hashtable] OutputData </maml:para> <maml:para> RMMigrationReturn.ReturnCode = 0, indicates migration started successfully. RMMigrationReturn.ReturnCode = 1, indicates that there was an error in starting the migration. RMMigrationReturn.OutputData, contains any additional data that the cmdlet can return. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> </maml:alertSet> <command:examples> <command:example> <maml:title>----------Example 1: Get migration was successfull----------</maml:title> <dev:code>PS C:\> Get-RMMigrations -mid 50cc3e04-aafb-4707-ab2e-c119be7351f7, b7b43883-4a0f-4edf-9d0a-d77257b7dff4 MigrationId Status Progress ----------- ------ -------- 50cc3e04-aafb-4707-ab2e-c119be7351f7 success 100% b7b43883-4a0f-4edf-9d0a-d77257b7dff4 error N/A ReturnCode RMError RMWarning OutputData ---------- ------- --------- ---------- 0 {Result} </dev:code> </command:example> <command:example> <maml:title>----------Example 2: Get migration is failed----------</maml:title> <dev:code>PS C:\> Get-RMMigrations -mid 50cc3e04-aafb-4707-ab2e-c119be7351f2, b7b43883-4a0f-4edf-9d0a-d77257b7dff2 Could not find migrations with ID(s): 50cc3e04-aafb-4707-ab2e-c119be7351f2, b7b43883-4a0f-4edf-9d0a-d77257b7dff2 ReturnCode RMError RMWarning OutputData ---------- ------- --------- ---------- 1 {RMError} </dev:code> </command:example> </command:examples> <maml:relatedLinks> <!--Add links to related content here--> </maml:relatedLinks> </command:command> </helpItems> |