scale_computing.hypercore.vm_replication module – Handles VM replications
Note
This module is part of the scale_computing.hypercore collection (version 1.6.0).
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install scale_computing.hypercore
.
To use it in a playbook, specify: scale_computing.hypercore.vm_replication
.
New in scale_computing.hypercore 1.0.0
Synopsis
Use vm_replication to perform actions regarding the replication of a specified virtual machine (VM) such as start, pause amd unpause replication of the VM.
Parameters
Parameter |
Comments |
---|---|
Scale Computing HyperCore instance information. |
|
Select login method. If not set, the value of the Value local - username/password is verified by the HyperCore server (the local users). Value oidc - username/password is verified by the configured OIDC provider. Choices:
|
|
The HyperCore instance URL. If not set, the value of the For example “https://10.1.2.3:443”. |
|
Password used for authentication. If not set, the value of the |
|
Timeout in seconds for the connection with the Scale Computing HyperCore API instance. If not set, the value of the |
|
Username used for authentication. If not set, the value of the |
|
Remote cluster name, used to identify the selected remote cluster by name. |
|
State defines the desired state of the VM replication - Use Use Use Choices:
|
|
Virtual machine name. Used to identify selected virtual machine by name. |
Notes
Note
check_mode
is not supported.
Examples
- name: Replicate demo-vm VM to DC2
scale_computing.hypercore.vm_replication:
vm_name: demo-vm
remote_cluster: PUB4
state: enabled
- name: Pause replication for demo-vm
scale_computing.hypercore.vm_replication:
vm_name: demo-vm
state: disabled
- name: Reenable replication for demo-vm
scale_computing.hypercore.vm_replication:
vm_name: demo-vm
state: reenabled
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The created or changed record for replication on a specified virtual machine. Returned: success |
|
Remote cluster name Returned: success Sample: |
|
The desired state of the VM replication Returned: success Sample: |
|
Virtual machine name identifier Returned: success Sample: |