### Run Regular Installation

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

Execute the installation script to install the regular release version of the platform.

```bash
./vm install

```

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

### Run Stable Installation

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

Execute the installation script to install the stable release version of the platform.

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

```

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

### Install VMmanager Platform

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

Initiates the installation process for the VMmanager platform. This command is used after stopping and removing the previous installation.

```bash
vm install__
```

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

### Install MySQL server

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

Installs the MySQL server and client packages.

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

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

### Start Host

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

Starts a virtual machine host. Requires the host ID.

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

### Description
Starts a virtual machine host.

### Method
POST

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

### Parameters
#### Path Parameters
- **host_id** (integer) - Required - The ID of the host to start.

### Response
#### Success Response (200)
- **id** (integer) - The ID of the task initiated to start the host.

#### Response Example
```json
{
  "id": 123
}
```
```

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

### Perform initial MySQL security setup

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

Runs the script to secure the MySQL installation by setting root passwords, removing anonymous users, and disallowing remote root login.

```bash
mysql_secure_installation__
```

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

### Install on Under-Spec Server (Regular)

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

Install the regular version of the platform on a server with specifications below the minimum requirements using the -f parameter.

```bash
./vm install -f

```

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

### Make Installation Script Executable

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

Grant execute permissions to the downloaded installation script.

```bash
chmod +x vm

```

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

### Enable and start MySQL service

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

Enables the MySQL service to start automatically on boot and then starts the service.

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

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

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

### Install with Specific Version

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

Install a specific version of the platform using the -v parameter.

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

```

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

### Install with Domain Name

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

Specify the domain name for the server during installation using the -n parameter.

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

```

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

### Start Migrated VMs

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

After updating the VM configurations, use this command to start all VMs that are set to autostart.

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

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

### 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. Ensure the VM name or ID is correct before executing.

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

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

### Install on Under-Spec Server (Stable)

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

Install the stable version of the platform on a server with specifications below the minimum requirements using the -f parameter.

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

```

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

### Install PowerDNS with MySQL backend

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

Installs the PowerDNS server, the MySQL backend, and BIND utilities.

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

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

### Setup VM Panel

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

Initializes or configures the VMmanager panel. This endpoint is used for the initial setup or reconfiguration of the system.

```APIDOC
## POST /setup

### Description
Sets up the VM panel.

### Method
POST

### Endpoint
/setup

### Parameters
#### Request Body
- **SetupParams** (object) - Required - Setup parameters.
  - **AnyProperties** (object)

### Response
#### Success Response (200)
- Description: Setup is successful.
- Content: application/json

### Request Example
```json
{
  "example": "SetupParams object"
}
```

### Response Example
```json
{
  "example": "Empty JSON object for success"
}
```
```

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

### Receive Information About VM by ID

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

This example shows how to retrieve information about a specific VM using its unique host ID. The URL structure is for a GET request to a specific element.

```http
domain.com/vm/v3/host/host_id
```

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

### Make Installer Executable

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

Set execute permissions on the downloaded VMmanager installer script.

```bash
chmod +x vm__
```

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

### Install curl

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

Install the curl utility if it is not already present on the server.

```bash
dnf install curl

```

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

### Download VMmanager Installer

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

Use curl to download the VMmanager installer script. Ensure curl is installed on your system.

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

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

### Start Virtual Machine

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

Starts a suspended virtual machine identified by its host ID. Requires admin authentication.

```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) __
```

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

### Example SCP Command

Source: https://www.ispsystem.com/docs/vmmanager-admin/about-platform/workstation-setup

An example demonstrating how to copy a local file to a specific path on the remote server.

```bash
scp my_local_file.txt root@192.0.2.1:/root/my_dir/my_remote_file.txt
```

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

### Install Cloud-Init Package (CentOS 7)

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

Installs the cloud-init package, which is used for cloud instance initialization. This is a prerequisite for certain network configuration steps.

```bash
yum install cloud-init__
```

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

### Install Cloud-init Packages

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

Installs the downloaded cloud-init .deb packages. This command may need to be run multiple times to resolve dependencies.

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

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

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

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

### Install mdevctl on Ubuntu

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

Install the mdevctl utility, which is used for vGPU management, on Ubuntu systems using apt.

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

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

### Install Leapp Framework

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

Install the Leapp framework and its data for AlmaLinux, which is the primary tool for performing the OS upgrade.

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

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

### Install Disk Resize Utilities

Source: https://www.ispsystem.com/docs/vmmanager-admin/migration/moving-platform-to-vm

Installs the 'cloud-utils-growpart' package, which provides utilities for resizing disk partitions on Linux systems.

```bash
dnf install cloud-utils-growpart __
```

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

### Example: Update VMmanager to Specific Version

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

An example command demonstrating how to update VMmanager to a specific version, such as '2025.01.1'.

```bash
vm update -v=2025.01.1
```

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

### Example Output of Verified Time Sync Variables

Source: https://www.ispsystem.com/docs/vmmanager-admin/getting-started/time-synchronization

Example output showing the updated TIME_SYNC_INTERVAL and TIME_SYNC_MAX_OFFSET values after applying a patch.

```text
TIME_SYNC_INTERVAL: 30
TIME_SYNC_MAX_OFFSET: 1000
```

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

### Install with Verbose Output

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

Enable verbose output during installation to see detailed information about Docker image downloads and command execution.

```bash
./vm --verbose install

```

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

### Install curl and jq

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

Installs the curl and jq utilities on the server if they are not already present. Use dnf for Fedora/RHEL-based systems or apt for Debian/Ubuntu-based systems.

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

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

### Restore VMmanager (Existing Installation)

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

Initiate the VMmanager recovery process for an existing installation. Specify the absolute path to your backup file.

```bash
vm restore -b=<backup_file>__
```

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

### Install mdevctl on AlmaLinux

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

Install the mdevctl utility, which is used for vGPU management, on AlmaLinux systems using dnf.

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

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

### Package Manager Proxy Configuration Example (DNF)

Source: https://www.ispsystem.com/docs/vmmanager-admin/getting-started/using-a-proxy

An example of a DNF configuration parameter specifying the HTTP proxy URL and port.

```ini
proxy=http://192.168.0.10:3128 __
```

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

### Install Leapp Framework

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

Installs the Leapp framework and necessary data for AlmaLinux, required for the pre-upgrade check and the OS change process.

```bash
yum install -y leapp-upgrade leapp-data-almalinux __
```

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

### Example Backup Name

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

An example of a VM backup name following the default format, including a specific VM name and Unix timestamp.

```text
misty_dichroite_backup_1590457814782
```

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

### Get the cluster with ID 1

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

Example of retrieving a specific cluster by its ID using a GET request with a filter.

```APIDOC
## GET /vm/v3/cluster?where=(id+EQ+1)

### Description
Retrieve a specific cluster by its ID.

### Method
GET

### Endpoint
`https://domain.com/vm/v3/cluster`

### Parameters
#### Query Parameters
- **where** (string) - Required - Filter to select the cluster by ID. Format: `(id+EQ+1)`.
```

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

### Get the task by ID in consul and name

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

Example of retrieving a task based on its consul ID and name using a GET request with combined filters.

```APIDOC
## GET /vm/v3/task?where=(consul_id+EQ+'1341774670')+AND+(name+EQ+'host_create')

### Description
Retrieve a task by its consul ID and name.

### Method
GET

### Endpoint
`https://domain.com/vm/v3/task`

### Parameters
#### Query Parameters
- **where** (string) - Required - Filter to select the task by consul ID and name. Format: `(consul_id+EQ+'1341774670')+AND+(name+EQ+'host_create')`.
```

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

### Get a list of 50 VMs in descending order by name

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

Example of retrieving a list of 50 VMs, sorted in descending order by their names, using GET request with orderby and limit filters.

```APIDOC
## GET /vm/v3/host?orderby=cluster.name+desc&limit=0,50

### Description
Retrieve a list of 50 VMs sorted in descending order by name.

### Method
GET

### Endpoint
`https://domain.com/vm/v3/host/`

### Parameters
#### Query Parameters
- **orderby** (string) - Optional - Sort the list by cluster name in descending order. Format: `cluster.name+desc`.
- **limit** (string) - Optional - Limit the output to the first 50 elements, starting from index 0. Format: `0,50`.
```

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

### List AlmaLinux 8 Packages

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

Get a list of installed AlmaLinux 8 packages. This is the first step before removing them to clean up the system.

```bash
rpm -qa | grep el8__
```

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

### Install with HTTP Proxy (Authorization)

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

Configure HTTP proxy settings with username and password for authorization.

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

```

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

### List AlmaLinux 9 Packages

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

Get a list of all installed packages that are part of the AlmaLinux 9 distribution. This is a preparatory step before removing old packages.

```bash
rpm -qa | grep el9__
```

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

### Reset current SSO configuration

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

Resets the Single Sign-On (SSO) configuration to its default state. This is useful for troubleshooting or starting fresh with SSO setup.

```APIDOC
## DELETE /sso

### Description
Resets the current Single Sign-On (SSO) configuration to its default settings.

### Method
DELETE

### Endpoint
/sso

### Responses
#### Success Response (200)
- **200Ok** (object) - Indicates successful reset.
```

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

### Install with SSL Certificates

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

Provide paths to SSL certificate files for configuring the web server.

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

```

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

### Enable and start PowerDNS service

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

Enables the PowerDNS service to start automatically on boot and then starts the service.

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

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

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

### Install with HTTP Proxy (No Authorization)

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

Configure HTTP proxy settings without requiring authorization.

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

```

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

### Receive Information About All VMs

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

This example demonstrates how to fetch a complete list of all VMs. The URL targets the general VM endpoint, implying a full collection retrieval.

```http
domain.com/vm/v3/host/
```

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

### Install Feature on Node

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

Installs necessary packages and settings to support features on a specific node. This can be forced to ensure installation.

```APIDOC
## POST /node/{node_id}/install_feature

### Description
Installs necessary packages and settings to support features on a node.

### Method
POST

### Endpoint
/node/{node_id}/install_feature

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

#### Request Body
- **force** (boolean) - Optional - Default: false. Forces the installation.

### Response
#### Success Response (200)
- Description: Installation successful.
- Content: application/json
- **IdTask** (object) - Contains the ID and task information.

### Request Example
```json
{
  "force": true
}
```

### Response Example
```json
{
  "example": "IdTask object"
}
```
```

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

### Install epel-release repository

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

Installs the Extra Packages for Enterprise Linux repository, which is required for installing PowerDNS on AlmaLinux 8.

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

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

### Install Prerequisites for Terraform (Debian/Ubuntu)

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

Installs necessary packages like gnupg, software-properties-common, and curl on Debian/Ubuntu systems for Terraform installation.

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

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

### Download Cloud-init Packages

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

Downloads the necessary .deb packages for cloud-init from a specified URL. Ensure the URLs are correct and accessible.

```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 __
```

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

### Install EPEL Release

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

Installs the Extra Packages for Enterprise Linux (EPEL) repository, which is often a prerequisite for installing other packages like ndppd.

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

dnf install epel-release__
```

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

### Verify AlmaLinux Installation

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

Confirm that AlmaLinux has been successfully installed by checking the release file.

```bash
cat /etc/redhat-release__
```

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

### Install VMmanager Platform (Stable Stage)

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

Installs the stable version of VMmanager. Use this command when you need to recover the login link and the first user was not created.

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

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

### Initial Network Configuration for VLAN

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

Example of initial network interface configuration for a VLAN connection on AlmaLinux. Sets up IP address, subnet mask, gateway, and DNS servers.

```bash
DEVICE="bond0.4"
VLAN="yes"
ONBOOT="yes"
BOOTPROTO="none"
IPADDR=10.3.0.62
PREFIX=24
NETMASK=255.255.255.0
GATEWAY=10.3.0.1
DNS1=8.8.8.8
DNS2=8.8.4.4
```

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

```bash
TYPE=Ethernet
DEVICE=enp1s0f0
UUID=b47d0044-55ca-40d2-be0c-3d4a65a9985d
ONBOOT=yes
DEFROUTE=yes
IPV6_AUTOCONF=yes
IPV6_DEFROUTE=yes
NAME="System enp1s0f0"
SLAVE=yes
MASTER=bond0
```

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

### Start VMmanager Platform

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

Restart the VMmanager platform services after the migration is complete.

```bash
vm start __
```

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

### setup_timesync

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

Sets up the time synchronization for the system. This allows configuring how time is synchronized across the environment.

```APIDOC
## POST /timesync

### Description
Sets up the time synchronization for the system.

### Method
POST

### Endpoint
/timesync

### Request Body
- **TimeSyncParams** (object) - Required - Parameters for setup timesync

#### Response
#### Success Response (200)
- **Id** (object) - Description of the ID
```

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

### Initialize Terraform Configuration

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

Run this command in your configuration directory to download and install necessary providers.

```bash
terraform init
```

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

### Install Terraform (RHEL-based)

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

Installs Terraform on AlmaLinux and CentOS systems after adding the HashiCorp repository.

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

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

### Install yum-utils

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

Installs yum-utils on AlmaLinux and CentOS systems, a prerequisite for adding the HashiCorp repository.

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

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

### Start vGPU Initialization

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

Initiates the vGPU initialization task on a specified node. This is used for setting up virtual GPU devices.

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

### Description
Starts the vGPU initialization task on vGPU-mode PCI devices for a given node.

### Method
POST

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

### Parameters
#### Path Parameters
- **node_id** (integer) - Required - The ID of the node where vGPU initialization should start.
```

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

### CloudFront Request ID Example

Source: https://www.ispsystem.com/docs/vmmanager-admin/monitoring/dashboard

This is an example of a request ID generated by CloudFront, which can be useful for debugging.

```text
Generated by cloudfront (CloudFront)
Request ID: rGyBSVop8Ky3ItAIuiFa--A1b7zLRbPBvJ7ANg9cpSNFQlSR8rWtUA==

```

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

### Install ELevate Software

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

Installs the ELevate software, which is essential for performing the OS migration from CentOS to AlmaLinux.

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