Files
SVMU/README.md

50 lines
1.8 KiB
Markdown
Raw Normal View History

2025-04-25 11:17:32 +03:00
# SpaceVM_VM_Utility
Utility to manage Virtual Machines in SpaceVM.
2025-04-25 11:48:38 +03:00
2025-05-12 17:40:08 +03:00
Written in python, uses [SpaceVM API](https://spacevm.ru/docs/6.5/api/) to collect and manage existing Virtual Machines in your SpaceVM cluster.
2025-05-21 15:13:41 +03:00
>[!NOTE]
>_For now, this utility is focused on managing virtual disks_<br>
>_Works with SpaceVM 6.5.5+_
# Requirements
- Fully setup SpaceVM cluster with VMs
- SpaceVM Utility and SpaceVM cluster should be in LAN
- Obtain your [API Key](https://spacevm.ru/docs/latest/base/operator_guide/security/users/#_14)
>[!WARNING]
> Utility is only tested on Windows 10
- For Windows 10 - [New Microsoft Terminal](https://github.com/microsoft/terminal) is highly recommended (correct colors, menus, etc)
2025-05-12 17:40:08 +03:00
2025-05-13 14:02:42 +03:00
# Utility usage
2025-05-21 15:13:41 +03:00
Clone repository or use compiled .exe from [Releases Tab](https://github.com/OVERLORD7F/SpaceVM_VM_Utility/releases)
2025-05-13 14:02:42 +03:00
2025-05-21 15:13:41 +03:00
Fill in the config file as stated below.
2025-05-13 14:02:42 +03:00
2025-05-28 17:09:53 +03:00
## Config File (SpaceVM_Utility.conf)
_SpaceVM_Utility.conf_ contains all necessary data for utility and has to be placed in the same directory as Utility itself.
2025-05-12 17:40:08 +03:00
2025-05-28 17:09:53 +03:00
You can create config and specify/change specific options within the Utility.
2025-05-12 17:40:08 +03:00
```
2025-05-28 17:09:53 +03:00
[General]
#Master Controller IP of your cluster
#Has to be accessible for a machine, which will be executing this Utility
controller_ip =
#Integration API Key (how to get your key - https://spacevm.ru/docs/latest/base/operator_guide/security/users/#_14 )
# do not specify JWT tag with your key!
api_key =
[Data_Pool]
#Data pool which will be used for utility operations
#(Targeted storage for new vDisks)
data_pool_uuid =
[VM_List]
#Selected VMs which will be used for utility operations
#How to find UUID:
#List all available VMs in Utility Main Menu (Option 6)
#Use https://spacevm.ru/docs/latest/cli/space/vm/info/ or copy UUID from web panel
uuid_1 =
uuid_2 =
2025-05-12 17:40:08 +03:00
```