en-US/Stop-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>Stop-RMMigration</command:name> <command:verb>Stop</command:verb> <command:noun>RMMigration</command:noun> <maml:description> <maml:para>Stops a running migration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Stops a migration that is in progress with the provided migration ID.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Stop-RMMigration</maml:name> <command:parameter required="True" pipelineInput="False" position="Named" aliases="mid"> <maml:name>MigrationId</maml:name> <maml:description> <maml:para>ID of the migration that you want to stop.</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="True" pipelineInput="False" position="Named" aliases="mid"> <maml:name>MigrationId</maml:name> <maml:description> <maml:para>ID of the migration that you want to stop.</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>RMMigrationReturn 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: Migration is stopped----------</maml:title> <dev:code>C:\> Stop-RMMigration -mid ea290e85-1858-4663-afab-7d86a9a56222 Migration with ID ea290e85-1858-4663-afab-7d86a9a56222 is stopped ReturnCode RMError RMWarning OutputData ---------- ------- --------- ---------- 0 {Result} </dev:code> </command:example> <command:example> <maml:title>----------Example 2: Migration can't stopped----------</maml:title> <dev:code>C:\> Stop-RMMigration -mid af78d577-81a4-40d7-9d00-df2e556519b9 Migration is in final state 'cancelled', cannot be stopped. ReturnCode RMError RMWarning OutputData 1 {RMError} </dev:code> </command:example> </command:examples> </command:command> </helpItems> |