Replication VM Enable Replication
This Automation Manager object enables replication of a virtual machine to a specified Replica server.
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Virtual Machine Name | String | No | Specifies the virtual machine you want to configure for replication. |
| Destination Host | String | No | Specifies the name of the Replica server to which this virtual machine will be replicated. |
| Destination Host Port Number | Number | No | Specifies the port on the Replica server to use for replication traffic. Make sure you specify a port that is configured on the Replica server to support the same authentication type you specify using the AuthenticationType parameter in this cmdlet. Run the Get-VMReplicationServer cmdlet on the Replica server to check the configuration of the port, or contact the administrator of the specified Replica server. |
| Compression Enabled | Boolean | No | Specifies compress replication data for this virtual machine when it is sent over the network. |
| Bypass Proxy Server | Boolean | No | Specifies whether to bypass a proxy server while replicating data to the Replica server. |
| Enable Write Preservation Across Disks | Boolean | No | Determines if all virtual hard disks selected for replication are replicated to the same point in time. This is useful if the virtual machine runs an application that saves data across virtual hard disks (for example, one virtual hard disk dedicated for application data, and another virtual hard disk dedicated for application log files). |
| Replicate Host Kvp Items | Boolean | No | Specifies whether to replicate host-only key value pairs (KVP) for this virtual machine. |
| Autoresynchronization If Required | Boolean | No |
Enables replicating virtual machines that require resynchronization to be resynchronized automatically (for example, a virtual machine requires resynchronization if the primary server shuts down abruptly). Resynchronization requires significant storage and processing resources.
We recommend scheduling resynchronization during off-peak hours to reduce the impact to the host and other virtual machines running on the host. Use the AutoResynchronizeIntervalStart and AutoResynchronizeIntervalEnd parameters to specify an off-peak time to start the automatic resynchronization. |
Output Parameters
| Name | Type | Description |
|---|---|---|
| Result | Number | Returns a success value of zero or any value other than zero to indicate failure. |
Example Input Parameters
| Name | Type | Required | Example |
|---|---|---|---|
| Virtual Machine Name | String | Yes | Guest001 |
| Destination Host | String | Yes | server01.domain01.contoso.com |
| Destination Host Port Number | Number | Yes | 80 |
| Compression Enabled | Boolean | No | Optionally, you can enable compression during replication. |
| Bypass Proxy Server | Boolean | No | Optionally, you can bypass the proxy server during replication. |
| Enable Write Protection Across Disks | Boolean | No | Optionally, you can enable "write protection across" during replication. |
| Replicate Host Kvp Items | Boolean | No | Optionally, you can replicate host Kvp items during replication. |
| Autoresynchronization If Required | Boolean | No | Optionally, you can auto resynchronize (if required) during replication. |