.. _scale_computing.hypercore.vm_replication_info_module:

vm_replication_info -- Returns info about replication of a specific VM
======================================================================

Returns information about replication of a specific virtual machine, if replication is configured.


.. versionadded:: 0.0.1



Examples
--------

.. code-block:: yaml+jinja

   
   - name: Module vm_replication_info sample output
     scale_computing.hypercore.vm_replication_info:
       cluster_instance:
           host: 'host address'
           username: 'username'
           password: 'password'
       vm_name: XLAB-demo-vm-clone
     register: records








Parameters
----------

cluster_instance (optional)
  Scale Computing HyperCore instance information.

  | **type**: dict

  host (required)
    The HyperCore instance URL.

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

    For example "https://10.1.2.3:443".

    | **type**: str

  password (required)
    Password used for authentication.

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

    | **type**: str

  timeout (optional)
    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.

    | **type**: float

  username (required)
    Username used for authentication.

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

    | **type**: str


vm_name (optional)
  Virtual machine name

  Used to identify selected virtual machine by name

  | **type**: str



Return Values
-------------

records
   The replication records.

   **sample**:

   .. code-block:: yaml

      - remote_cluster: PUB4
        state: enabled
        vm_name: demo-vm