scale_computing.hypercore.vm_export module – Handles export of the virtual machine

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_export.

New in scale_computing.hypercore 1.0.0

Synopsis

  • Use vm_export to export the virtual machine, to a specified location on a SMB server.

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.

smb

dictionary / required

SMB server, access and location data.

file_name

string

Specified xml file name.

If not specified, file name will be the same as directory name from the path parameter.

password

string / required

Password.

path

string / required

Specified location on the SMB server, where the exported virtual machine is to be exported to.

It must start with ‘/’.

server

string / required

Specified SMB server, where the selected virtual machine is to be exported to.

Has to be IP or DNS name.

username

string / required

Username.

vm_name

string / required

Virtual machine name.

Used to identify selected virtual machine by name.

Notes

Note

  • check_mode is not supported.

Examples

- name: Export VM to SMB
  scale_computing.hypercore.vm_export:
    vm_name: demo-vm
    smb:
      server: IP-or-DNS-name-of-SMB-server
      path: /share/path/to/vms/demo-vm-exported-v0
      file_name: my_file.xml
      username: user
      password: pass
  register: output

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

Return message.

Returned: success

Sample: "Virtual machine - VM-TEST - export complete."

Authors

  • Domen Dobnikar (@domen_dobnikar)