Suspend-VMReplication
Suspend-VMReplication
Suspends replication of a virtual machine.
構文
Parameter Set: VMName
Suspend-VMReplication [-VMName] <String[]> [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [-Passthru] [-ReplicationRelationshipType <Nullable [Microsoft.HyperV.PowerShell.VMReplicationRelationshipType]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMObject
Suspend-VMReplication [-VM] <VirtualMachine[]> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: VMReplication
Suspend-VMReplication [-VMReplication] <VMReplication[]> [-Passthru] [-Confirm] [-WhatIf] [ <CommonParameters>]
詳細説明
The Suspend-VMReplication cmdlet suspends, or pauses, replication of a virtual machine. To resume replication, use the Resume-VMReplication cmdlet to resume replication. When replication is resumed, all changes made since replication was suspended will be replicated.
パラメーター
-CimSession<Microsoft.Management.Infrastructure.CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。コンピューター名またはセッション オブジェクト (New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など) を入力します。既定値は、ローカル コンピューター上の現在のセッションです。
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-ComputerName<String[]>
Specifies one or more Hyper-V hosts on which replication of a virtual machine is to be suspended. NetBIOS names, IP addresses, and fully qualified domain names are allowable. The default is the local computer. Use localhost or a dot (.) to specify the local computer explicitly.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Credential<System.Management.Automation.PSCredential[]>
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-Passthru
Specifies that a VMReplication object is to be passed through to the pipeline representing the replication to be suspended.
Aliases |
none |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-ReplicationRelationshipType<Nullable [Microsoft.HyperV.PowerShell.VMReplicationRelationshipType]>
Specifies the replication relationship type of the virtual machine. Specify whether the replication relationship is a simple primary to replica or is an extended replication chain. The cmdlet suspends replication of the virtual machines that have the replication type that you specify.
Aliases |
Relationship |
必須/オプション |
false |
位置 |
named |
既定値 |
none |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-VM<VirtualMachine[]>
Specifies the virtual machine whose replication is to be suspended.
Aliases |
none |
必須/オプション |
true |
位置 |
1 |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByValue) |
ワイルドカード文字の受け入れ |
false |
-VMName<String[]>
Specifies the name of the virtual machine whose replication is to be suspended.
Aliases |
none |
必須/オプション |
true |
位置 |
1 |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByValue) |
ワイルドカード文字の受け入れ |
false |
-VMReplication<VMReplication[]>
Specifies the virtual machine replication to be suspended.
Aliases |
none |
必須/オプション |
true |
位置 |
1 |
既定値 |
none |
パイプライン入力の受け入れ |
True (ByValue) |
ワイルドカード文字の受け入れ |
false |
-Confirm
コマンドレットを実行する前に確認メッセージを表示します。
必須/オプション |
false |
位置 |
named |
既定値 |
false |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
-WhatIf
コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。
必須/オプション |
false |
位置 |
named |
既定値 |
false |
パイプライン入力の受け入れ |
false |
ワイルドカード文字の受け入れ |
false |
<CommonParameters>
このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットが出力するオブジェクトの型です。
- None by default; VMReplication if –PassThru is specified.
使用例
Example 1
Suspends replication of virtual machine VM01.
PS C:\> Suspend-VMReplication VM01
Example 2
Suspends replication of all virtual machines on the local Hyper-V host.
PS C:\> Suspend-VMReplication *