VMmanager Administrator Guide

https://www.ispsystem.com/docs/vmmanager-admin
Admin
VMmanager is a virtualization management platform for creating and managing virtual machines,...
Tokens:172,780
Snippets:2,638
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and start MySQL

Source: https://www.ispsystem.com/docs/vmmanager-admin/modules/integration-with-powerdns-module

Install the MySQL server and enable/start the service.

```bash
dnf -y install mysql-server mysql__
```

```bash
systemctl enable mysqld.service__
```

```bash
systemctl start mysqld.service__
```

--------------------------------

### Install and start PowerDNS

Source: https://www.ispsystem.com/docs/vmmanager-admin/modules/integration-with-powerdns-module

Install PowerDNS packages and start the service.

```bash
dnf -y install pdns pdns-backend-mysql bind-utils__
```

```bash
systemctl enable pdns.service__
```

```bash
systemctl start pdns.service__
```

--------------------------------

### Run MySQL security installation

Source: https://www.ispsystem.com/docs/vmmanager-admin/modules/integration-with-powerdns-module

Perform the initial MySQL security setup.

```bash
mysql_secure_installation__
```

--------------------------------

### Run installation

Source: https://www.ispsystem.com/docs/vmmanager-admin/installation-and-update/installation

Execute the installation script for regular or stable releases.

```bash
./vm install __
```

```bash
./vm install --stage=stable __
```

--------------------------------

### Start VM

Source: https://www.ispsystem.com/docs/vmmanager-admin/internal-operation-logic/subsystems-used/managing-vms-with-virsh

Starts a virtual machine using its name or ID.

```bash
virsh start <VM_name_or_id> __
```

--------------------------------

### Start VMs

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-almalinux-9-to-almalinux-10

Starts all VMs that are configured to autostart.

```bash
for vm in $(virsh list --all --autostart | awk 'NR>2{print $2}'); do virsh start $vm; done__
```

--------------------------------

### Download and prepare installer

Source: https://www.ispsystem.com/docs/vmmanager-admin/installation-and-update/installation

Download the VMmanager installation script and make it executable.

```bash
curl -O https://download.ispsystem.com/6/installer/vm/vm __
```

```bash
chmod +x vm__
```

--------------------------------

### Installation with optional parameters

Source: https://www.ispsystem.com/docs/vmmanager-admin/installation-and-update/installation

Run the installer with specific configuration flags for versioning, networking, and security.

```bash
./vm install -v=2025.01.1 __
```

```bash
./vm install -n="vmmanager.example.com" __
```

```bash
./vm install --registry-port=5001 __
```

```bash
./vm install --ssl-crt-file="/root/example.crt" --ssl-key-file="/root/example.key" __
```

```bash
./vm install --proxy="http://admin:pass123@192.168.57.1:3128"__
```

```bash
./vm install --proxy="http://192.168.57.1:3128" __
```

```bash
./vm --verbose install __
```

--------------------------------

### Set Installer Permissions

Source: https://www.ispsystem.com/docs/vmmanager-admin/backups/creating-platform-backups

Make the downloaded installer file executable.

```bash
chmod +x vm__
```

--------------------------------

### Start a virtual machine

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/examples-of-how-to-use-api

Power on a suspended VM by sending a POST request to the start endpoint.

```python
url = f"https://vm.example.com/vm/v3/host/{host_id}/start"
data = json.loads('{}')
host = requests.post(url=url, json=data, headers=cookie) __
```

--------------------------------

### Install ELevate and Leapp

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-almalinux-8-to-almalinux-9

Installs the necessary repositories and tools for the OS upgrade process.

```bash
yum install -y http://repo.almalinux.org/elevate/elevate-release-latest-el$(rpm --eval %rhel).noarch.rpm__
```

```bash
yum install -y leapp-upgrade leapp-data-almalinux__
```

--------------------------------

### Download VMmanager Installer

Source: https://www.ispsystem.com/docs/vmmanager-admin/backups/creating-platform-backups

Download the installer script using curl.

```bash
curl -O https://download.ispsystem.com/6/installer/vm/vm__
```

--------------------------------

### ISO Disk Configuration Example

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migration-from-vmmanager-5-to-vmmanager-6

Example XML snippet showing an ISO disk configuration in libvirt.

```xml
<disk type='file' device='cdrom'>
<driver name='qemu' type='raw'/>
<source file='/nfsshare/iso/tQVJGvq2bYQNWdvD2xB14xB1J111v11'/>
<backingStore/>
<target dev='hda' bus='ide'/>
<readonly/>
<boot order='2'/>
<alias name='ide0-0-0'/>
<address type='drive' controller='0' bus='0' target='0' unit='0'/>
</disk> __
```

--------------------------------

### Configure installation parameters

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/installation-via-ansible

Define the required variables in the vmmanager6.yml file to customize the platform installation.

```yaml
  vars:
    vmi_first_username: "admin@example.com"
    vmi_first_password: "secret"
    vmmanager6_license_token: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    vmi_stage: "beta"
    vmi_domain: "{{ ansible_ssh_host }}"
    vmi_network: "192.168.0.0/24"
    vmi_network_gateway: "192.168.0.1"
    vmi_network_note: "Network for my VMs"
    vmi_pool_name: "Pool 1"
    vmi_pool_note: "Pool for my VMs"
    vmi_cluster_name: "Cluster 1"
    vmi_cluster_note: "Cluster for my VMs"
    vmi_time_zone: "UTC" 
    vmi_domain_template: ".example.com"
    vmi_node_check_ip: "1.1.1.1"
    vmi_certificate: "-----BEGIN CERTIFICATE-----\nMIIDkTC..............AlS\nldgeq7s=\n-----END CERTIFICATE-----\n"
    vmi_certificate_key: "-----BEGIN PRIVATE KEY-----\nMIIEvg...............XO6HBlXDeTd\n-----END PRIVATE KEY-----\n"
    vmi_certificate_ca: ""
    vmi_backup_ip: "10.3.0.4"
    vmi_backup_user: "root"
    vmi_backup_password: "secret123"
    vmi_backup_path: "/backup"
 __
```

--------------------------------

### Install provider locally on Linux

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/infrastructure-management-via-terraform

Commands to manually download and install the VMmanager provider plugin.

```bash
mkdir -p ~/.terraform.d/plugins/localhost/usaafko/vmmanager6/0.0.34/linux_amd64/__
```

```bash
curl -L https://github.com/usaafko/terraform-provider-vmmanager6/releases/download/v0.0.34/terraform-provider-vmmanager6_0.0.34_linux_amd64.zip -o terraform-provider-vmmanager6.zip__
```

```bash
unzip terraform-provider-vmmanager6.zip__
```

```bash
mv terraform-provider-vmmanager6_v0.0.34 ~/.terraform.d/plugins/localhost/usaafko/vmmanager6/0.0.34/linux_amd64/terraform-provider-vmmanager6__
```

--------------------------------

### Execute VMmanager installation

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/installation-via-ansible

Run the Ansible playbook to install the platform. Ensure the IP address is followed by a comma.

```bash
ansible-playbook -i <IP>, -u root vmmanager6.yml
```

--------------------------------

### Access installation link

Source: https://www.ispsystem.com/docs/vmmanager-admin/installation-and-update/installation

The output provided by the installer upon successful completion.

```text
Link to administrator registration page: https://1.2.3.4/auth/setup?token=C50A0BFA55DEDE3343AABE713022A15F__
```

--------------------------------

### Install curl utility

Source: https://www.ispsystem.com/docs/vmmanager-admin/installation-and-update/installation

Install the curl utility if it is missing on the server.

```bash
dnf install curl__
```

--------------------------------

### Install Terraform on Debian/Ubuntu

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/infrastructure-management-via-terraform

Commands to add the HashiCorp GPG key and repository, then install Terraform.

```bash
apt-get update && apt-get install -y gnupg software-properties-common curl__
```

```bash
curl -fsSL https://apt.releases.hashicorp.com/gpg | apt-key add -__
```

```bash
apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main"__
```

```bash
sudo apt-get update && sudo apt-get install terraform__
```

--------------------------------

### Install Leapp framework

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-almalinux-9-to-almalinux-10

Installs the necessary Leapp packages for the OS upgrade.

```bash
yum install -y leapp-upgrade leapp-data-almalinux__
```

--------------------------------

### Install jq utility

Source: https://www.ispsystem.com/docs/vmmanager-admin/internal-operation-logic/audit-event-logging

Install the jq utility to enable reading logs in JSON format.

```bash
apt install jq || dnf install jq__
```

--------------------------------

### Install dependencies

Source: https://www.ispsystem.com/docs/vmmanager-admin/clusters/balancer

Install curl and jq utilities required for API interactions.

```bash
dnf install curl jq || sudo apt install curl jq__
```

--------------------------------

### GET /setting

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Retrieves a list of system settings.

```APIDOC
## GET /setting

### Description
Retrieves a list of system settings.

### Method
GET

### Endpoint
/setting

### Response
#### Success Response (200)
- Settings list is successfully received
```

--------------------------------

### Install ELevate software

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-almalinux-9-to-almalinux-10

Installs the ELevate release repository for the current RHEL version.

```bash
yum install -y http://repo.almalinux.org/elevate/elevate-release-latest-el$(rpm --eval %rhel).noarch.rpm__
```

--------------------------------

### Install ndppd service

Source: https://www.ispsystem.com/docs/vmmanager-admin/clusters/cluster-network-configurations

Commands to enable necessary repositories and install the ndppd service on a cluster node.

```bash
dnf config-manager --set-enabled powertools __
```

```bash
dnf install epel-release__
```

```bash
dnf install ndppd__
```

--------------------------------

### Download Platform Installer

Source: https://www.ispsystem.com/docs/vmmanager-admin/backups/creating-platform-backups

Command to download the specific platform installer version identified in the previous step.

```bash
curl -O https://download.ispsystem.com/6/installer/vm/<installer_version>/vm__
```

--------------------------------

### Example Command Output

Source: https://www.ispsystem.com/docs/vmmanager-admin/backups/creating-platform-backups

Sample output showing the retrieved InstallerVersion value.

```text
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  3329  100  3329    0     0  23609      0 --:--:-- --:--:-- --:--:-- 23609
InstallerVersion = 5.6.19 __
```

--------------------------------

### POST /setup

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Perform the setup of the VM panel.

```APIDOC
## POST /setup

### Description
Setup VM panel.

### Method
POST

### Endpoint
/setup

### Request Body
- **SetupParams** (object) - Required - Setup params
```

--------------------------------

### GET /task/{task_id}/start

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Starts a task and returns notification details.

```APIDOC
## GET /task/{task_id}/start

### Description
Start the task.

### Method
GET

### Endpoint
/task/{task_id}/start

### Parameters
#### Path Parameters
- **task_id** (integer) - Required - Task id

#### Query Parameters
- **name** (string) - Optional - Name of task

### Response
#### Success Response (200)
- **last_notify** (object) - Last notification details
```

--------------------------------

### GET /lang

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/auth-api-v4

Getting language setting.

```APIDOC
## GET /lang

### Description
Getting language setting.

### Method
GET

### Endpoint
/lang
```

--------------------------------

### GET /version

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Gets product version information.

```APIDOC
## GET /version

### Description
Get product information.

### Method
GET

### Endpoint
/version
```

--------------------------------

### POST /host/{host_id}/start

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Starts a virtual machine.

```APIDOC
## POST /host/{host_id}/start

### Description
Runs a virtual machine.

### Method
POST

### Endpoint
/host/{host_id}/start

### Parameters
#### Path Parameters
- **host_id** (integer) - Required - Host ID

### Response
#### Success Response (200)
- **IdTask** (object) - OK
```

--------------------------------

### GET /timesync

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Gets time synchronization configuration.

```APIDOC
## GET /timesync

### Description
Retrieves the current time synchronization settings.

### Method
GET

### Endpoint
/timesync

### Response
#### Success Response (200)
- **TimeSyncSettings** (object) - Current time synchronization configuration
```

--------------------------------

### GET /ldap

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/auth-api-v4

Get full list of integrated LDAP servers.

```APIDOC
## GET /ldap

### Description
Get full list of integrated LDAP servers.

### Method
GET

### Endpoint
/ldap
```

--------------------------------

### GET /sso/group

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/auth-api-v4

Get SSO group bindings to users groups.

```APIDOC
## GET /sso/group

### Description
Get SSO group bindings to users groups.

### Method
GET

### Endpoint
/sso/group
```

--------------------------------

### Start platform

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-centos-8-to-almalinux-8

Restart the platform after migration is complete.

```bash
vm start __
```

--------------------------------

### Start OS upgrade

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-almalinux-9-to-almalinux-10

Initiates the OS upgrade process.

```bash
leapp upgrade __
```

--------------------------------

### GET /user/{user_id}

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/auth-api-v4

Getting user details by user identifier.

```APIDOC
## GET /user/{user_id}

### Description
Getting user details by user identifier.

### Method
GET

### Endpoint
/user/{user_id}

### Parameters
#### Path Parameters
- **user_id** (string) - Required - User identifier
```

--------------------------------

### Install epel-release repository

Source: https://www.ispsystem.com/docs/vmmanager-admin/modules/integration-with-powerdns-module

Add the EPEL repository to the system.

```bash
dnf -y install epel-release__
```

--------------------------------

### GET /host/{host_id}/ptr

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Gets a list of PTR-records for a virtual machine.

```APIDOC
## GET /host/{host_id}/ptr

### Description
Getting list of PTR-records of a virtual machine

### Method
GET

### Endpoint
/host/{host_id}/ptr

### Parameters
#### Path Parameters
- **host_id** (integer) - Required - Host ID

### Response
#### Success Response (200)
- Successfully got
```

--------------------------------

### POST /setting

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Creates a new VM setting.

```APIDOC
## POST /setting

### Description
Creates a new VM setting.

### Method
POST

### Endpoint
/setting

### Response
#### Success Response (200)
- VM setting created successfully
```

--------------------------------

### GET /storage/{storage_id}/node

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Gets the node list for a specific storage.

```APIDOC
## GET /storage/{storage_id}/node

### Description
Get node list for the storage.

### Method
GET

### Endpoint
/storage/{storage_id}/node

### Parameters
#### Path Parameters
- **storage_id** (integer) - Required - Storage ID
```

--------------------------------

### POST /node/{node_id}/vgpu/init

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Starts the vGPU initialization task on vGPU-mode PCI devices for a specific node.

```APIDOC
## POST /node/{node_id}/vgpu/init

### Description
Start vGPU initialization task on vGPU-mode PCI devices.

### Method
POST

### Endpoint
/node/{node_id}/vgpu/init

### Parameters
#### Path Parameters
- **node_id** (integer) - Required - Node ID

### Response
#### Success Response (200)
- Task started successfully
```

--------------------------------

### Example block device output

Source: https://www.ispsystem.com/docs/vmmanager-admin/clusters/lxd

Sample output showing disk partitions and loop devices.

```text
NAME   MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
loop0    7:0    0  91.9M  1 loop /snap/lxd/32662
loop1    7:1    0  40.9M  1 loop /snap/snapd/20290
loop2    7:2    0  49.3M  1 loop /snap/snapd/24792
loop3    7:3    0  63.3M  1 loop /snap/core20/1828
loop5    7:5    0  73.9M  1 loop /snap/core22/2045
loop6    7:6    0 114.4M  1 loop /snap/lxd/33110
sr0     11:0    1  1024M  0 rom 
vda    252:0    0    50G  0 disk
├─vda1 252:1    0     1M  0 part
└─vda2 252:2    0    50G  0 part /
vdb    252:16   0    50G  0 disk __
```

--------------------------------

### Creating the Initial Administrator

Source: https://www.ispsystem.com/docs/vmmanager-admin/installation-and-update/installation

Command to manually create the first user account with a specified email and password.

```bash
/usr/local/bin/vm create-admin -u 'user@example.com' -p 'password' __
```

--------------------------------

### Install mdevctl

Source: https://www.ispsystem.com/docs/vmmanager-admin/clusters/using-vgpu

Commands to install the mdevctl utility on supported Linux distributions.

```bash
sudo dnf -y install mdevctl
```

```bash
sudo apt -y install mdevctl
```

--------------------------------

### Handle system requirement warnings

Source: https://www.ispsystem.com/docs/vmmanager-admin/installation-and-update/installation

View resource check failures and force installation on underspecified hardware.

```bash
Checking available resources of the machine ... fail
Resources of the machine don't match with minimal requirements

  RESOURCE  | MACHINE  | REQUIRED  
------------+----------+-----------
  CPU Speed | 3.60 GHz |  2 GHz    
  CPU Cores |    1     |    2      
  RAM       | 0.47 Gb  |   2 Gb    
  Storage   | 6.94 Gb  |  40 Gb __
```

```bash
./vm install -f __
```

```bash
./vm install -f --stage=stable __
```

--------------------------------

### API response example

Source: https://www.ispsystem.com/docs/vmmanager-admin/clusters/balancer

Example of a successful authentication response containing the token.

```json
{
  "confirmed": true,
  "expires_at": null,
  "id": "6",
  "token": "4-e9726dd9-61d9-2940-add3-914851d2cb8a"
} __
```

--------------------------------

### GET /cluster/{cluster_id}/pci/info

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Gets information about PCI device usage on a cluster.

```APIDOC
## GET /cluster/{cluster_id}/pci/info

### Description
Get information about pci device usage on cluster.

### Method
GET

### Endpoint
/cluster/{cluster_id}/pci/info

### Parameters
#### Path Parameters
- **cluster_id** (integer) - Required - Cluster ID
```

--------------------------------

### POST /host

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Creates a new virtual machine.

```APIDOC
## POST /host

### Description
Creates a new virtual machine.

### Method
POST

### Endpoint
/host

### Parameters
#### Request Body
- **HostParams** (object) - Required - Parameters of the created VM

### Response
#### Success Response (200)
- **id** (integer) - VM ID
- **task** (integer) - Task ID
- **recipe_task_list** (array) - List of recipe tasks
- **recipe_task** (integer) - Recipe task ID
- **spice_task** (integer) - SPICE task ID
```

--------------------------------

### POST /host/{host_id}/protect_setup

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Edit the protection settings for a virtual machine.

```APIDOC
## POST /host/{host_id}/protect_setup

### Description
VM protect setup editing.

### Method
POST

### Endpoint
/host/{host_id}/protect_setup

### Parameters
#### Path Parameters
- **host_id** (integer) - Required - ID of the VM being protect setup editing

### Request Body
- **is_protected** (boolean) - Required - Protection status
- **extended_protection** (boolean) - Required - Extended protection status
```

--------------------------------

### Install Homebrew on macOS

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/infrastructure-management-via-terraform

Command to install the Homebrew package manager if not already present.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"__
```

--------------------------------

### Configure AlmaLinux Bond Interface

Source: https://www.ispsystem.com/docs/vmmanager-admin/clusters/server-requirements-for-the-cluster

Example configuration for a bonding master interface in AlmaLinux.

```bash
DEVICE="bond0"
TYPE="Bond"
BONDING_MASTER="yes"
ONBOOT="yes"
BOOTPROTO="none"
BONDING_OPTS="mode=active-backup"
```

--------------------------------

### DBMS Check Output Example

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migration-from-vmmanager-5-to-vmmanager-6

Example output indicating the presence of a PostgreSQL container.

```text
CONTAINER ID   IMAGE         COMMAND                  CREATED      STATUS      PORTS      NAMES
3213c5dc94d0   postgres:12   "docker-entrypoint.s…"   5 days ago   Up 4 days   5432/tcp   pgsql __
```

--------------------------------

### Example of Multiple Notification Conditions

Source: https://www.ispsystem.com/docs/vmmanager-admin/monitoring/grafana/grafana-configuring-notifications

An example using the AND operator to combine multiple conditions.

```text
WHEN avg() OF query(A, 15m, now) IS ABOVE 90
AND max() OF query(A, 15m, now) IS ABOVE 95 __
```

--------------------------------

### Apply infrastructure changes

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/infrastructure-management-via-terraform

Executes the plan to create or update resources.

```bash
terraform apply__
```

--------------------------------

### Migration error example

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-centos-8-to-almalinux-8

Example of an error message indicating a signature verification failure.

```text
Verify almalinux-release-latest.rpm package                           ERROR
    /root/.alma.X46iDx/almalinux-release-latest.rpm: digests SIGNATURES NOT OK __
```

--------------------------------

### Plan resource creation

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/infrastructure-management-via-terraform

Previews the changes that will be applied to the infrastructure.

```bash
terraform plan__
```

--------------------------------

### Configure and run Leapp

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-almalinux-8-to-almalinux-9

Configures the Leapp framework, performs pre-upgrade checks, and initiates the OS upgrade.

```bash
leapp answer --section check_vdo.confirm=True__
```

```bash
leapp preupgrade __
```

```bash
leapp upgrade __
```

--------------------------------

### Install vdagent on Linux

Source: https://www.ispsystem.com/docs/vmmanager-admin/internal-operation-logic/subsystems-used/spice

Commands to install the spice-vdagent utility for clipboard sharing and resolution features.

```bash
apt -y install spice-vdagent __
```

```bash
yum -y install spice-vdagent __
```

--------------------------------

### Execute IP address import

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migration-from-vmmanager-5-to-vmmanager-6

Run the migration tool with database connection parameters to import IP addresses.

```bash
docker exec -it ipmgr /opt/ispsystem/ipmgr/bin/mgr5import --dbhost <db_ip> --dbname <db_name> --dbuser <db_user> --dbpassword <db_pass> --user <ipmgr_user>
```

--------------------------------

### Install Terraform on AlmaLinux/CentOS

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/infrastructure-management-via-terraform

Commands to add the HashiCorp repository and install Terraform on RHEL-based systems.

```bash
yum install -y yum-utils__
```

```bash
yum-config-manager --add-repo https://rpm.releases.hashicorp.com/RHEL/hashicorp.repo__
```

```bash
yum -y install terraform__
```

--------------------------------

### Create a virtual machine

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/examples-of-how-to-use-api

Send a POST request to the host endpoint with the required VM configuration parameters.

```python
url = "https://vm.example.com/vm/v3/host"
new_host = requests.post(url=url, json=vm_params, headers=cookie) __
```

--------------------------------

### Create installation directory

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/installation-via-ansible

Create a dedicated directory for the Ansible playbooks.

```bash
mkdir vm6_ansible__
```

--------------------------------

### Prepare Debian 9 VM for migration

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/moving-an-ovz-container-to-lxd-cluster

Commands to update packages and install cloud-init on a Debian 9 source VM.

```bash
apt update && apt upgrade__
```

```bash
apt install acl__
```

```bash
curl -O https://download.ispsystem.com/external/cloud-init/stretch/cloud-guest-util_0.29-1_all.deb -O https://download.ispsystem.com/external/cloud-init/stretch/cloud-image-utils_0.29-1_all.deb -O https://download.ispsystem.com/external/cloud-init/stretch/cloud-init_20.2-2~deb10u1_all.deb -O https://download.ispsystem.com/external/cloud-init/stretch/cloud-utils-euca_0.29-1_all.deb -O https://download.ispsystem.com/external/cloud-init/stretch/cloud-utils_0.29-1_all.deb __
```

```bash
dpkg -i cloud-*
__
```

```bash
apt --fix-broken install -y__
```

```bash
dpkg -i cloud-*__
```

--------------------------------

### Install Terraform on macOS via Homebrew

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/infrastructure-management-via-terraform

Commands to tap the HashiCorp repository and install or update Terraform.

```bash
brew tap hashicorp/tap__
```

```bash
brew install hashicorp/tap/terraform__
```

```bash
brew update__
```

```bash
brew upgrade hashicorp/tap/terraform__
```

--------------------------------

### Execute OS Upgrade

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-centos-7-to-almalinux-8

Start the OS upgrade process and verify the version after the subsequent reboot.

```bash
leapp upgrade__
```

```bash
reboot__
```

```bash
cat /etc/os-release__
```

--------------------------------

### Create backup via console

Source: https://www.ispsystem.com/docs/vmmanager-admin/backups/creating-platform-backups

Execute this command on the VMmanager server via SSH to initiate a manual backup.

```bash
vm backup__
```

--------------------------------

### Install zfsutils-linux

Source: https://www.ispsystem.com/docs/vmmanager-admin/clusters/lxd

Installs the ZFS utility package required for managing ZFS pools on the cluster node.

```bash
sudo apt install zfsutils-linux__
```

--------------------------------

### Example GPU device output

Source: https://www.ispsystem.com/docs/vmmanager-admin/clusters/gpu-passthrough

Sample output showing detected VGA compatible controllers.

```text
00:02.0 VGA compatible controller: Intel Corporation UHD Graphics 630 (rev 0c)
01:00.0 VGA compatible controller: Advanced Micro Devices, Inc. [AMD/ATI] Ellesmere [Radeon RX 470/480]
02:00.0 VGA compatible controller: NVIDIA Corporation TU106 [GeForce RTX 2060 SUPER] (rev a1) __
```

--------------------------------

### Example PostgreSQL container check output

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migration-from-vmmanager-5-to-vmmanager-6

Sample output indicating the presence of the PostgreSQL container.

```text
CONTAINER ID   IMAGE         COMMAND                  CREATED      STATUS      PORTS      NAMES
3213c5dc94d0   postgres:12   "docker-entrypoint.s…"   5 days ago   Up 4 days   5432/tcp   pgsql
```

--------------------------------

### Example of a Single Notification Condition

Source: https://www.ispsystem.com/docs/vmmanager-admin/monitoring/grafana/grafana-configuring-notifications

A basic example checking if the average value of a query exceeds a threshold.

```text
WHEN avg() OF query(A, 15m, now) IS ABOVE 90 __
```

--------------------------------

### Run pre-upgrade check

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-almalinux-9-to-almalinux-10

Checks system readiness for the OS upgrade and generates a report.

```bash
leapp preupgrade __
```

--------------------------------

### POST /host/{host_id}/lxd/console

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Starts the LXD console backend for a host.

```APIDOC
## POST /host/{host_id}/lxd/console

### Description
Run lxd console backend.

### Method
POST

### Endpoint
/host/{host_id}/lxd/console

### Parameters
#### Path Parameters
- **host_id** (integer) - Required - Host ID

### Response
#### Success Response (200)
- **socket** (string) - Lxd console backend started successfully
```

--------------------------------

### POST /host/{host_id}/reinstall

Source: https://www.ispsystem.com/docs/vmmanager-admin/developer-section/api/vmmanager-api

Reinstalls the virtual machine.

```APIDOC
## POST /host/{host_id}/reinstall

### Description
Initiates a reinstallation process for the specified virtual machine.

### Method
POST

### Endpoint
/host/{host_id}/reinstall

### Parameters
#### Path Parameters
- **host_id** (integer) - Required - Host ID

### Response
#### Success Response (200)
- **id** (integer) - ID
- **task** (integer) - Task ID
- **recipe_task_list** (array) - List of recipe task IDs
- **recipe_task** (integer) - Recipe task ID
- **spice_task** (integer) - Spice task ID
```

--------------------------------

### JSON response example

Source: https://www.ispsystem.com/docs/vmmanager-admin/modules/health-checker-module

Example of the structured JSON output returned when using the --format json parameter.

```json
{
  "check_id": "f5485278",
  "summary": {
    "has_problems": false,
    "problems_count": 0,
    "total_containers": 1,
    "running_containers": 1,
    "stopped_containers": 0,
    "total_services": 3,
    "healthy_services": 3,
    "unhealthy_services": 0,
    "total_orphans": 2,
    "problems": []
  },
  "containers": [
    {
      "name": "auth",
      "short_id": "fb6151ceed1d",
      "state": "running",
      "status": "Up 3 days",
      "ip": "172.18.0.10",
      "services": [
        {
          "name": "auth_reader",
          "status": "running",
          "config": {
            "consul_service_name": "auth_v4",
            "mode": "reader",
            "port": 200,
            "expected_in_consul": true
          },
          "consul": {
            "consul_status": "passing",
            "consul_id": "auth_v4_reader_fb6151ceed1d"
          }
        }
      ],
      "container_orphans": []
    }
  ],
  "orphans": []
}
```

--------------------------------

### Determine Installer Version

Source: https://www.ispsystem.com/docs/vmmanager-admin/backups/creating-platform-backups

Commands to retrieve the required installer version for Stable or Regular platform releases using curl and jq.

```bash
curl https://download.ispsystem.com/6/vm/stable/vm/stable.json | jq -r '[.Releases[] | select(.Version ==     "<version>") | "InstallerVersion = \(.Require.InstallerVersion)"] | .[0] // "Not found"' __
```

```bash
curl https://download.ispsystem.com/6/vm/beta.json | jq -r '[.Releases[] | select(.Version == "<version>") |           "InstallerVersion = \(.Require.InstallerVersion)"] | .[0] // "Not found"' __
```

--------------------------------

### Run migration script

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/migrating-from-centos-8-to-almalinux-8

Execute the deployment script to begin the migration process.

```bash
sudo bash almalinux-deploy.sh__
```

--------------------------------

### Initialize Terraform project

Source: https://www.ispsystem.com/docs/vmmanager-admin/iac-solutions/infrastructure-management-via-terraform

Initializes the configuration directory.

```bash
terraform init__
```
Tokens:
Raw