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

cluster_instance

dictionary

Scale Computing HyperCore instance information.

auth_method

string

Select login method. If not set, the value of the SC_AUTH_METHOD environment variable will be used.

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:

  • "local" ← (default)

  • "oidc"

host

string / required

The HyperCore instance URL.

If not set, the value of the SC_HOST environment variable will be used.

For example “https://10.1.2.3:443”.

password

string / required

Password used for authentication.

If not set, the value of the SC_PASSWORD environment variable will be used.

timeout

float

Timeout in seconds for the connection with the Scale Computing HyperCore API instance.

If not set, the value of the SC_TIMEOUT environment variable will be used.

username

string / required

Username used for authentication.

If not set, the value of the SC_USERNAME environment variable will be used.

remote_cluster

string

Remote cluster name, used to identify the selected remote cluster by name.

state

string / required

State defines the desired state of the VM replication - enabled, disabled, reenabled.

Use enabled for initial replication setup.

Use disabled to pause a configured replication.

Use reenabled to unpause a configured replication. remote_cluster is optional in this case.

Choices:

  • "enabled"

  • "disabled"

  • "reenabled"

vm_name

string / required

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

record

dictionary

The created or changed record for replication on a specified virtual machine.

Returned: success

remote_cluster

string

Remote cluster name

Returned: success

Sample: "PUB4"

state

string

The desired state of the VM replication

Returned: success

Sample: "enabled"

vm_name

string

Virtual machine name identifier

Returned: success

Sample: "demo-vm"

Authors

  • Domen Dobnikar (@domen_dobnikar)