VMmanager KVM API

For how to work with API functions, see the article Guide to ISPsystem software API.

Recipes 

Function: recipemgr

Result: the list of elements

Recipes management

Access level: admin user

• name - Recipe

• revision - Revision

• state - Status

• tags - Tags

• repo - Repository

• date - Date

• filename - File

Start the update process

Function: recipemgr.update

Start the update process

Access level: admin user

Delete the selected recipes

Function: recipemgr.delete

Delete the selected recipes

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of recipemgr function.

Result: successful operation or error message

Edit recipe

Function: recipemgr.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of recipemgr function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of recipemgr function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• filename - File name . File name where the recipe is kept

• encoding - Encoding. Recipe character encoding. Changing encoding will REMOVE the changes made in the editor!

• fdata - .

• savetime - Saved in. In this field you can see the file save time. Server time is specified here

Repository

Function: recipemgr.repo

Result: the list of elements

Recipe repositories

Access level: admin user

• name - Repository

• location - Link

Delete repository

Function: recipemgr.repo.delete

Delete repository

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of recipemgr.repo function.

Result: successful operation or error message

Edit recipe repository

Function: recipemgr.repo.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of recipemgr function).
  • elid - unique identifier (name element of recipemgr.repo function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of recipemgr function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of recipemgr function).
  • elid - unique identifier (name element of recipemgr.repo function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• name - Repository . Repository name

• location - Link . Link to recipe archive

Recipe properties

Function: recipemgr.props

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of recipemgr function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of recipemgr function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• access - Access to recipe . Recipe access can be denied both for users ('available for administrators') and for all accounts including administrators ('unavailable')

Replicaton

Function: replication

Access level: admin

The function is simultaneously used to view and change form's data

View data:

• Result: <a href="api#param">parameters list</a>

Change the data:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

The list object's parameters or additional query parameters (see above):

• host - Server IP address. Hostname or IP address of MySQL server for replication

• user - User. MySQL user with 'change master', 'start/stop slave' and 'show slave status' permissions granted

• password - Password. MySQL user's password

• ostemplbkpip - Server. Host name or address of backup server for OS tepmlates

• ostemplbkpdir - Directory. Path to directory on server where backup copies are stored

• has_pwd - I have root password. (Optional parameter. To enable the option click "on".) Check connection and get ssh keys using the root password

• ostemplbkppass - Password. Root password on server

• cloudip - License IP address. Specify IP address of VMmanager Cloud license

Cluster nodes

Function: vmhostnode

Result: the list of elements

Cluster nodes

Access level: admin

• id - Id

• name - Name

• ip - IP address

• vmcount - VM count

• storageinfo - Storages usage

• meminfo - RAM usage

• memreserved - Memory reserved, MiB

• stat - Status

• vmminiver - vmmini version

• version_libvirt_str - libvirt version

• version_qemu_str - QEMU version

• priority - Priority

• uptime - Uptime

Edit properties of the selected cluster node

Function: vmhostnode.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of vmhostnode function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of vmhostnode function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name. Enter the name of the cluster node

• addlocal - . (Optional parameter. To enable the option click "on".) Select the check box to add a local server as cluster node

• localip - URL for accessing VMmanager. Select the IP address for connecting the local server

• ip - IP address. Enter the IP address for the cluster node

• port - ihttpd port. Enter the port number through which VMmanager KVM connects to the VMmini service of the cluster node

• sshkey - Public key. Public ssh-key that should be added to the server

• has_pwd - . (Optional parameter. To enable the option click "on".) Enter the root password, if any. The public key will be automatically added to the server

• passwd - Password. Enter the root password

• maxvmcount - VM limit. Virtual machines limit for auto node select

• priority - Priority. Cluster node priority. In case of errors with the master node, a new master node will become the one with the highest priority

• online - . (Optional parameter. To enable the option click "on".) Disabled node is not used in the cluster and is ignored by the control panel. Virtual machines located on a disabled cluster node are displayed in the system with the corresponding icon in the status column. Statuses of such virtual machines are unknown.

• status - Automatic location of virtual machines . Select if this node can be used for automatic location of virtual machines. If you run VMmanager Cloud, 'deny for all' means that the selected cluster node cannot be used for automatic location of virtual machines, including a node, which is out of quorum

• configuration - Comments. Enter any information related to the server

Cluster load

Function: reporttop

Result: report

Cluster load report

Access level: admin

List of virtual machines on the selected cluster node

Function: vmhostnode.vm

List of virtual machines on the selected cluster node

Access level: admin

Name

Function: vmhostnode.info

Result: the list of elements

Cluster node information

Access level: admin

• type - Resource

• info - Information

Name

Function: vmhostnode.pool

Result: the list of elements

List of pools on the cluster node

Access level: admin

• metapool - Storage template

• capacity - Capacity

• available - Available

Update information about disk space occuppied

Function: vmhostnode.pool.refresh

Update information about disk space occuppied

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the metapool element of vmhostnode.pool function.

Result: successful operation or error message

Allow automatic creation of new virtual machines on the selected cluster node

Function: vmhostnode.enable

Allow automatic creation of new virtual machines on the selected cluster node

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vmhostnode function.

Result: successful operation or error message

Forbid creation of virtual machines

Function: vmhostnode.disable

Forbid creation of virtual machines

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vmhostnode function.

Result: successful operation or error message

Name

Function: vmhostnode.net

Result: the list of elements

List of networks on the cluster node

Access level: admin

• name - Name

• type - Type

• bridge - Bridged networking

• forward - Forward

• ipaddr - IP address

Add the cluster node to quorum. Restore the cluster node automatically

Function: vmhostnode.join

Add the cluster node to quorum. Restore the cluster node automatically

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vmhostnode function.

Result: successful operation or error message

Delete

Function: vmhostnode.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vmhostnode function.

Result: successful operation or error message

Cluster node roles

Function: role.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of vmhostnode function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of vmhostnode function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

Firewall

Function: firewall

Result: the list of elements

Firewal settings

Access level: admin

• id - File name

• name - Name

• proto - Protocol

• prio - Priority

Delete

Function: firewall.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of firewall function.

Result: successful operation or error message

Edit rules

Function: firewall.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of firewall function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of firewall function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• proto - Protocol. Select a protocol for packets filtering (IPv4 or IPv6)

• prio - Priority. Script execution priority. The lower this value, the earlier this script will be executed.

• name - Name. Enter the name for the script. The file name will be as follows: NN_NAME.rule, where NN is priority, NAME is the value of that field

• rule - Rules. Each line of the rule will be sent to iptables as paremeter. 

Example: 
-A INPUT -p tcp -m tcp --dport

Virtual machines

Function: vm

Result: the list of elements

Virtual machines

Access level: admin user

• id - Id

• name - Name

• domain - Domain name

• hostnode - Cluster node

• user - Owner

• ip - IPv4 address

• ip6 - IPv6 address

• vmi - OS template

• osname - OS

• mem - RAM, MiB

• vcpu - Number of cores

• vdsize - Disks size, MiB

• status - Status

VM backup copies

Function: vm.backup

VM backup copies

Access level: admin user

Start the selected virtual machine

Function: vm.start

Start the selected virtual machine

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vm function.

Result: successful operation or error message

Name

Function: vm.snapshot

Result: the list of elements

VM snapshots

Access level: admin user

• id - Id

• name - Name

• date - Creation time

• stype - Type

• status - Status

Edit the selected VM snapshot

Function: vm.snapshot.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of vm.snapshot function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of vm.snapshot function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name. Enter the name for the snapshot. It must be unique for each virtual machine

• description - Description . Enter any information related to the snapshot

Delete

Function: vm.snapshot.delete

Delete

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vm.snapshot function.

Result: successful operation or error message

Revert to the selected snapshot

Function: vm.snapshot.revert

Revert to the selected snapshot

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vm.snapshot function.

Result: successful operation or error message

Change password of virtual machine

Function: vm.chpasswd

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of vm function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of vm function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• password - New password. Enter a new root password

• confirm - Re-enter password. Re-type the password to ensure it is correct

Parameter

Function: vm.sysinfo

Result: the list of elements

VM information

Access level: admin user

• name - Parameter

• value - Value

Set filter.

vm.portfilter

Edit properties of the VM

Function: vm.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of vm function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of vm function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• id - VM id. Unique identifier of the virtual machine. It will be applied automatically

• name - Name. The name of the virtual machine. You won't be able to edit this field upon creation

• user - Owner. Select a use who will be the owner of this virtual machine

• hostnode - Cluster node. Cluster node where the virtual machine will be created

• preset - VM template. In this template you can specify the main resources for your VM

• installtype - Installation type. Select an installation type: from OS template or from ISO-disk

• iso - ISO list. Select an ISO image to connect to a new virtual machine

• vmi - OS template. Operating system templates

• recipe - Recipe . Execute the selected recipe (script) on the virtual machine after OS deployment

• osname - Operating system. Enter any name for the operating system installed on this virtual machine

• iptype - IP address type. Public - can be accessed from the Internet, private - cannot be accessed from the Internet, NAT - access behind NAT

• family - IP address. Primary IP address

• ipsource - Allocate IP addresses from. Select a source of IP address

• network - Network name. Enter the name of the NAT network to allocate an IP address

• ip - IP address . Enter the main IP address

• netmask - Network mask. Enter a mask as a prefix (0..32 for IPv4, 0..128 for IPv6) or '255.255.255.0' for IPv4

• gateway - Gateway IP address. Gateway default IP

• add_ipaliases - . (Optional parameter. To enable the option click "on".) You need to add alias IP addresses

• ipaliases - Alias IP addresses in 192.168.0.1/24 192.168.0.254 format. You can enter several alias IP addresses in the format ip/mask gateway. Enter each iP address with a new line

• amount_ipv4 - Number of IPv4. Required number of IPv4

• ipv4_pool - Ipv4 pool. Obtain Ipv4 addresses from the selected pool

• amount_ipv6 - Number of IPv6. Required number of IPv6

• ipv6_pool - Ipv6 pool. Obtain Ipv6 addresses from the selected pool

• special_ipv4 - Special IPv4 addresses . Enter IPv4 space separated. The first IP in the list will be used as primary

• special_ipv6 - Special IPv6 addresses . Enter IPv6 space separated. The first IP in the list will be used as primary

• main_ipv4 - Primary IPv4 address . IPv4 that is shown in the list of virtual machines

• main_ipv6 - Primary IPv6 address . IPv6 that is shown in the list of virtual machines

• domain - Domain. Enter the name for the virtual machine

• vsize - Main disk size. Select the size of the main disk in MiB. You won't be able to edit this field upon creation

• mem - RAM. Enter the amount of memory you want to assign to this virtual machine in MiB. You won't be able to edit this field upon creation

• vcpu - CPU . Select the number of processors you want to allocate to the virtual machine. The virtual machine must be restarted to apply this value.

• password - Password. Enter the superuser password. It can be also used for VNC access (in this case only the first 8 symbols will be used)

• confirm - Confirm password. Re-type the password to ensure it is correct

• blocked - . (Optional parameter. To enable the option click "on".) Select the check box to protect the VM from destructive actions. It cannot be stopped, deleted, started, reinstalled, and its IP address cannot be removed.

• cpu_mode - CPU emulation mode . Virtual QEMU CPU is used by default for CPU emulation. A 'host-model' mode uses CPU description defined by libvirt, based on a cluster node CPU. A 'host-passthrough' mode fully emulates cluster node CPU. Configuration of emulation mode is required for starting Windows 2016. We don't recommend changing the current mode unless necessary.

• custom_cpu - CPU model . The list of models can be found in the /usr/share/libvirt/cpu_map.xml file on the cluster node. You can specify models that correspond to vendor, architecture, and CPU features on a cluster node

• custom_cpu_features - CPU features . CPU features that should be activated. Execute the 'virsh capabilities' command on the cluster node to list all the CPU features.

• mac - MAC-address. MAC-address for the virtual machine

• allowspoof - . (Optional parameter. To enable the option click "on".) Select the check box to disable anti-spoofing for the selected virtual machine

• clock_offset - Time . Time synchronization between the virtual machine and server

• cputune - CPU weight . Enter the cgroups weight for CPU. The VM with a weight of 1024 gets twice as much CPU as a VM with a weight of 512

• blkiotune - I/O usage weight . cgroup weight on group operations. It enables to increase or decrease the priority in comparison with other virtual machines.

• inbound - Incoming traffic, KiB/sec. Incoming traffic bandwidth limit, KiB/sec

• outbound - Outgoing traffic, KiB/sec. Outgoing traffic bandwidth limit, KiB/sec

• snapshot_limit - Snapshots . enter the maximum number of snapshots that a user can create for this virtual machine

• vnchost - Server. IP address of the VNC server

• vncport - Port. Port to access via VNC

• vncpassword - Password. Enter a password to access via VNC. The maximum password length is 8 symbols

• sshpubkey - Public SSH keys. Public SSH keys
• vmnote - Notes. Additional information related to the VM

Open the VNC client in a new browser window

Function: vm.novnc

Open the VNC client in a new browser window

Access level: admin user

Name

Function: vm.bandwidth

Result: report

Bandwidth usage

Access level: user+

Set filter.

vm.filter

OS reinstallation

Function: vm.reinstall

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of vm function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of vm function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• vmi - OS template. Operating system templates

• recipe - Recipe . Execute the selected recipe (script) on the virtual machine after OS deployment

• osname - Operating system. Enter any name for the operating system installed on this virtual machine

• new_password - . (Optional parameter. To enable the option click "on".) Enables to change password when reinstalling the operating system

• password - Password . Enter the root password

• confirm - Re-enter password.

• sshpubkey - Public SSH keys. Public SSH keys

View the history

Function: vm.history

View the history

Access level: admin user

Stop the selected virtual machine

Function: vm.stop

Stop the selected virtual machine

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vm function.

Result: successful operation or error message

Delete virtual machine

Function: vm.extdelete

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of vm function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of vm function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Virtual machine . The name of the virtual machine you want to delete

• confirm - . (Optional parameter. To enable the option click "on".) Selecting the "Ignore error" option will delete a virtual machine in all cases

Name

Function: iplist

Result: the list of elements

List of IP addresses

Access level: admin user

• id - Id

• ip - IP address

• domain - Domain

• gateway - Gateway address

• netmask - Network mask

Back to the previous list

Function: '

Back to the previous list

Access level: admin user

Change IP address

Function: iplist.edit

Access level: new: admin ;edit: admin user ;

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of iplist function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of iplist function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• ipsource - Allocate IP addresses from. Select a source of IP address

• iptype - IP address type. Public - can be accessed from the Internet, private - cannot be accessed from the Internet, NAT - access behind NAT

• family - IP address. Select a desired IP address

• network - Network name. Enter the name of the NAT network to allocate an IP address

• ip - IP address . Enter an IP address

• netmask - Network mask. Enter a mask as a prefix (0..32 for IPv4, 0..128 for IPv6) or '255.255.255.0' for IPv4

• gateway - Gateway IP address. Gateway default IP

• amount_ipv4 - Number of IPv4. Enter a required number of IPv4

• ipv4_pool - Ipv4 pool. Obtain Ipv4 addresses from the selected pool

• amount_ipv6 - Number of IPv6. Enter a required number of IPv6

• ipv6_pool - Ipv6 pool. Obtain Ipv6 addresses from the selected pool

• domain - Domain. The domain name assigned to this IP address

Delete the selected IP-addressees

Function: iplist.delete

Delete the selected IP-addressees

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of iplist function.

Result: successful operation or error message

Name

Function: vm.volume

Result: the list of elements

Virtual disks

Access level: admin user

• id - Id

• name - Name

• metapool - Storage

• bus - Bus

• dev - Device

• size - Size, MiB

• bootorder - Boot priority

• vmstatus - VM status

Edit virtual disk

Function: vm.volume.edit

Access level: new: admin+ ;edit: admin user ;

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of vm.volume function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of vm.volume function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• volume - Virtual disk. This virtual disk is not assigned to any virtual machine

• isoname - ISO-image. Select the file containing ISO-image for connecting to the virtual machine

• bus - Bus. Type of virtual device

• dev - Virtual device. The name of the device that will be shown within the virtual machine

• priority - Boot priority. Set the order to choose a devices for booting the operating system.

• size - Disk size. Virtual disk size, MiB

Unassign the selected disk from the virtual machine. Be sure to disable the virtual machine first.

Function: vm.volume.delete

Unassign the selected disk from the virtual machine. Be sure to disable the virtual machine first.

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vm.volume function.

Result: successful operation or error message

Attach ISO-image

Function: vm.volume.iso

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of vm.volume function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of vm.volume function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• isoname - Image name. Name of the file with image

• bus - Bus. Type of virtual device

• dev - Virtual device. The name of the device within the virtual machine

• priority - Boot priority. Set the order to choose a devices for booting the operating system.

Lower the boot priority

Function: vm.volume.boot.down

Lower the boot priority

Access level: admin user

Increase the boot priority

Function: vm.volume.boot.up

Increase the boot priority

Access level: admin user

VM migration

Function: vm.migrate

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of vm function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of vm function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• destination - Destination server . Select a cluster node to which this virtual machine will be migrated

• live - . (Optional parameter. To enable the option click "on".) The virtual machine will be running during the migration process. It will take a longer time and will consume more resources. Live migration can be used only for importing small and not actively used virtual machines

Hard reboot of the virtual machine

Function: vm.restart

Hard reboot of the virtual machine

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vm function.

Result: successful operation or error message

VM load

Function: reportvm

Result: report

This report shows service consumption by this virtual machine

Access level: user+

Name

Function: vm.netinterface

Result: the list of elements

List of network interfaces

Access level: admin user

• id - Id

• network - Associated network

• mac - MAC-address

• model - Network device model

Edit the selected network interface

Function: vm.netinterface.edit

Access level: new: admin+ ;edit: admin user ;

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of vm.netinterface function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of vm function).
  • elid - unique identifier (id element of vm.netinterface function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• network - Connected network . Select an associated network

• macgenerate - . (Optional parameter. To enable the option click "on".) Selecting the check box will generate (re-generate) a new MAC-address automatically

• mac - MAC-address. MAC-address of the network interface

• model - Network device model. Enter the model of the emulated network device

Delete

Function: vm.netinterface.delete

Delete

Access level: admin+

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vm.netinterface function.

Result: successful operation or error message

Go to the control panel as the owner of the virtual machine

Function: vm.su

Go to the control panel as the owner of the virtual machine

Access level: admin+

Storage templates

Function: metapool

Result: the list of elements

Storage templates

Access level: admin

• id - Id

• name - Name

• type - Type

• status - Status

Edit properties of the selected storage template

Function: metapool.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of metapool function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of metapool function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name. Enter the name for the template

• type - Type. Select a storage type

• srchostname - Network storage. Enter the IP address or host name of the network storage

• srcdevpath - Devices where volume group will be created . Provides the source for pools backed by physical devices (pool types fs, logical, disk, iscsi). May be repeated multiple times depending on backend driver. Contains a single attribute path which is the fully qualified path to the block device node

• srcvolume - Volume name . Volume name on the remote server

• srcdirpath - Directory on the network storage. Enter a directory to store disk images on the network storage server

• srchostport - Port. Enter a port to access the network storage

• sshkey - Public key. Public ssh-key that should be added to the server

• has_pwd - Root password . (Optional parameter. To enable the option click "on".)

• password - Root password. Enter a password for the root server with open-iscsi installed

• srcname - Source name. Enter a name for the network storage on the remote server

• source_format_type - source/format@type. Select a storage format type

• srcvendorname - source/vendor@name. Provides optional information about the vendor of the storage device

• srcfmtname - source/format@name. Provides information about the format of the pool

• srcprodname - source/product@name. Provides an optional product name of the storage device

• tgtpath - Directory on the cluster node. Enter a path to the directory where images of virtual disks will be kept

• format - Disk format. Disk format

• reserved_percent - Reserved, %%. Part of the storage that is reserved for system needs. Its size is specified in % from the total size. . Values from 0 to 100

• reserved_mib - Reserved, MiB. Part of the storage that is reserved for system needs. Its size is specified in MB.

• reserved_gib - Reserved, GiB. Part of the storage that is reserved for system needs. Its size is specified in Gb.

• reserved_unit - Units of measure . Select units of measure used for specifying the place

• cache_mode - Caching type. Cachning method, which is used for virtual machine which disks are located in this storage

• qemu_aio - AIO mode . Asynchronous input-output mode. We recommend using 'threads' for file storages, and 'native' for block. If you run the 'native' mode, you should disable caching on the host-server ( 'none' or 'directsync' caching type)

• description - Description.

Delete storage template

Function: metapool.extdelete

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of metapool function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of metapool function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Storage template. The name of the object you want to delete

• confirm - . (Optional parameter. To enable the option click "on".) Selecting "ignore errors" will delete the object in any case

Backup plans

Function: backup.plan

Result: the list of elements

Backup plans

Access level: admin

• name - Name

• type - Type

• state - Status

• cron - Schedule

Backup module settings

Function: backup.settings

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of backup.plan function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of backup.plan function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• backuptmpdir - Temporary directory. Backup module directory containing the temporary files: archives, listing, etc.

• backuptimeout - Timeout. Set the maximum time out for data preparation (virtual machines)

Delete the selected backup plans

Function: backup.plan.delete

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of backup.plan function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of backup.plan function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• clean_storages - . (Optional parameter. To enable the option click "on".) Select if you want to delete archives and listings from the storages

Run the backup process

Function: backup.plan.run

Run the backup process

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of backup.plan function.

Result: successful operation or error message

Set filter.

backup.plan.datafilter

Set filter.

backup.plan.filter

Backup plan

Function: backup.plan.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of backup.plan function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of backup.plan function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name. Enter the name for the backup plan

• id - Internal name. Name that is used in archive names and for databases

• backup_type - Type. Backup type: Full, Incremental, Differential

• archiver - Archiver. Select an archiver

• storage - Storage. List of storages where backup copies will be stored

• rewrite_today - . (Optional parameter. To enable the option click "on".) Only the last today's copy will be stored

• max_file_size - Max file size. Enter the maximum fie size in MiB. Files of a larger size will be excluded from the backup copy

• max_dir_size - Max. directory file size. Enter the maximum directory file size in MiB. Directories with files of a larger size will be excluded from the backup copy. The number of files influences the directory file size

• autostart - . (Optional parameter. To enable the option click "on".) You can create a cron job to run the backup process automatically. Or you can run the backup manually

• run_every - Run. Select the main time frame this cron job will be executed.

• full_period - Period. Select period for full backup

• full_weekday - Day of week. Select a day of the week to start the backup process

• full_monthday - Day of month. Select a day of the month to start the backup process

• dlimit - Daily backups . One backup copy for n last days will be stored. n is a specified value

• wlimit - Weekly backups . One backup copy for n last weeks will be stored. n is a specified value

• mlimit - Monthly backups . One backup copy for n last months will be stored. n is a specified value

Backup copies

Function: backups

Result: the list of elements

Backup copies

Access level: admin

• plan - Backup plan

• plan_type - Plan type

• date - Date

• size - Size, MiB

• storage - Storage

• backup_type - Copy type

Create a full backup copy

Function: backups.new

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of backups function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of backups function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• storage - Storage. Select a storage

Download the archive containing the backup copy

Function: backups.download

Download the archive containing the backup copy

Access level: admin

Restore

Function: backups.restore

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of backups function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of backups function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• behavior - Behavior. Select how you want to restore data from the backup.
  • Skip data – do not restore data and dependent elements that already exist in the system. Edit existing data – restore all the data from the archive.

E.g. you have a web-domain, which files were deleted from its home directory. If you choose “Skip existing data” while restoring the domain, its files won’t be restored. If you choose “Edit existing data”, domain’s files and settings will be restored.

Saved data

Function: backupdata

Result: the list of elements

Saved data

Access level: admin

• type - Data type

Data name

Function: backupdata.names

Result: the list of elements

Data included into backup copy

Access level: admin

• name - Data name

• owner - Owner

Restore

Function: backupdata.restore

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of backupdata function).
  • elid - unique identifier (id element of backupdata.names function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of backupdata function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of backupdata function).
  • elid - unique identifier (id element of backupdata.names function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• version - Version. Select a backup date

• behavior - Behavior. Select how you want to restore data from the backup.
  • Skip data – do not restore data and dependent elements that already exist in the system. Edit existing data – restore all the data from the archive.

E.g. you have a web-domain, which files were deleted from its home directory. If you choose “Skip existing data” while restoring the domain, its files won’t be restored. If you choose “Edit existing data”, domain’s files and settings will be restored.

Name

Function: backupdata.files

Result: the list of elements

Files

Access level: admin

• dname - Name

Restore

Function: backupdata.files.restore

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of backupdata.names function).
  • elid - unique identifier (name element of backupdata.files function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of backupdata.names function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of backupdata.names function).
  • elid - unique identifier (name element of backupdata.files function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• version - Version. Select a backup date

Upload the backup copy

Function: backups.upload

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of backups function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of backups function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• type - Upload type. Select the upload type you want to use. You can upload files from your local computer or from a remote server. The files will be stored into the current folder.

• url - URL. Enter the URL to the file that you want to upload. For example, http://example.com/dir/file.html .

• name - File name. Enter the name of the file you want to upload. If you leave this field blank, the file name will be extracted from the URL.

• storage - Storage. Select a storage for the backup copy

Delete the backup copy

Function: backups.delete

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of backups function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of backups function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• clean_storages - . (Optional parameter. To enable the option click "on".) Select if you want to delete archives and listings from the storages

Saved data

Function: backupdata

Result: the list of elements

Saved data

Access level: admin

• type - Data type

Location rules

Function: allocationrule

Result: the list of elements

VM location rules

Access level: admin

• id - Identifier

• priority - Priority

• ruletype - Rule type

• operand - Operand

• value - Value

• hostnode - Cluster node

• proc - Action

Edit the selected rule

Function: allocationrule.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of allocationrule function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of allocationrule function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• priority - Priority. Rule execution order. The rule with the smallest value will be executed first

• ruletype - Rule type. In this field you can select a property that will be checked when processing a rule. It can be the name of a VM or OS template

• operand - Operand. Select the operation:

"Contains" - checks that the "value" field is included into the property "Does not contain" - checks that the "Value" field is not included into the property

• value - Value. Enter a value for comparison

• host - Cluster node. Select a cluster node (or all nodes) that will be added or deleted from the list of nodes if the condition is matched (depending on the "action" field)

• action - Operation. Depending on a value in this field the cluster node will be either added or deleted from the list

• stop - . (Optional parameter. To enable the option click "on".) If this rule has been already used, you can stop processing the rules

Delete

Function: allocationrule.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of allocationrule function.

Result: successful operation or error message

Raise the rule priority

Function: allocationrule.up

Raise the rule priority

Access level: admin

Lower the rule priority

Function: allocationrule.down

Lower the rule priority

Access level: admin

User settings

Function: usrparam

Access level: user

The function is simultaneously used to view and change form's data

<b>View data</b>:

• Result: <a href="api#param">parameters list</a>

<b>Change the data</b>:

• Parameters:
  • <b>sok</b> - the parameter must not be empty, generally "ok".
  • additional query parameters ...

     		</li>
  

• Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

       </ul>

The list object's parameters or additional query parameters (see above):

• notify_vm_stop - . (Optional parameter. To enable the option click "on".) Send notifications about unplanned VM stoppage to the specified email

• notify_vm_stop_crashed - . (Optional parameter. To enable the option click "on".) Send notifications about crashed VM to the specified email

• notify_backup_fail - . (Optional parameter. To enable the option click "on".) Send notifications about backup errors to the specified email

• notify_node_locked - . (Optional parameter. To enable the option click "on".) Send notifications about node unavailability to the specified email

• notify_pool_over_space - . (Optional parameter. To enable the option click "on".) Send notifications about lack of storage space to the specified email

VM import

Function: remotenode

Result: the list of elements

Servers or clusters for VM import

Access level: admin

• id - ID

• ip - IP

• vmcount - VM count

• imported - Imported

• fail - Import errors

Delete

Function: remotenode.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of remotenode function.

Result: successful operation or error message

Name

Function: remotenode.vm

Result: the list of elements

List of virtual machines on the server

Access level: admin

• id - Id

• name - Name

• ip - IP address

• vsize - Disk size

• mem - RAM, MiB

• hostname - Cluster node

• externalip - Node IP address

• status - Status

Start VM import

Function: remotenode.vm.import

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of remotenode function).
  • elid - unique identifier (id element of remotenode.vm function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of remotenode function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of remotenode function).
  • elid - unique identifier (id element of remotenode.vm function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• hostnode - Cluster node. Select a target cluster node

• import_owner - . (Optional parameter. To enable the option click "on".) The VM owner will be imported

• user - User. Select an owner

• pool - Storage. Use this storage, if no storages are found during migration

• check_not_exists_pool - . (Optional parameter. To enable the option click "on".) Do not check that there is a storage that matches the storage of the imported virtual machine

• default_network - Default network. If the network of the source server is not found on the target server, this default network will be used

• new_domain - . (Optional parameter. To enable the option click "on".) If you want to change domain name for the main IP address

• domain - Domain. Domain for IP address

• new_ip - . (Optional parameter. To enable the option click "on".) New IP address is provided for the virtual machine during the import

• iptype - IP address type. Public - can be accessed from the Internet, private - cannot be accessed from the Internet, NAT - access behind NAT

• family - IP address. Primary IP address

• ipsource - Allocate IP addresses from. Select a source of IP address

• network - Network name. Enter the name of the NAT network a new IP address will be allocated for

• ip - IP address . Enter an IP address

• netmask - Network mask. Enter a mask as a prefix (0..32 for IPv4, 0..128 for IPv6) or '255.255.255.0' for IPv4

• gateway - Gateway IP address. Gateway default IP

• ipaliases - Alias IP addresses . You can enter several alias IP addresses

• amount_ipv4 - Number of IPv4. Enter a required number of IPv4

• ipv4_pool - Ipv4 pool. Obtain Ipv4 addresses from the selected pool

• amount_ipv6 - Number of IPv6. Enter a required number of IPv6

• ipv6_pool - Ipv6 pool. Obtain Ipv6 addresses from the selected pool

Select IP address of the server with virtual machine

Function: remotenode.fixconnection

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of remotenode function).
  • elid - unique identifier (id element of remotenode.vm function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of remotenode function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of remotenode function).
  • elid - unique identifier (id element of remotenode.vm function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• ip - IP address. Select an external IP address of the source node

Name

Function: remotenode.vm.info

Result: the list of elements

Virtual machine information

Access level: admin

• fieldname - Parameter

• value - Value

Update the list of virtual machines on the remote cluster

Function: remotenode.refresh

Update the list of virtual machines on the remote cluster

Access level: admin

Edit information about the server with libvirt or VMmanager

Function: remotenode.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of remotenode function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of remotenode function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• ip - IP address. Enter IP address of the server with libvirt or VMmanager KVM

• sshkey - .

• has_pwd - Password for user . (Optional parameter. To enable the option click "on".) If you know the user password, enter it into this field. The public key will be automatically added into the server

• login - ssh username . Enter a username to access via ssh

• passwd - . Enter the user password

• port - ssh port . Port number that the panel will be connected to

• type - Server type . Select a server type. Libvirt - libvirt is installed on the serve r libvirt,

VMmanager - VMmanager is installed on the server

• mgrpath - Path to VMmanager . Directory where VMmanager KVM is installed (normally, it is /usr/local/mgr5)

VPS import

Function: import

Result: the list of elements

Servers running VDSmanager

Access level: admin

• ip - IP address

• name - Name

• vdscount - Number of VPS

• status - Status

Stop the import process

Function: import.stop

Stop the import process

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of import function.

Result: successful operation or error message

Edit the server information

Function: import.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of import function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of import function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• sshkey - Public key. Public ssh-key that should be added to the server

• has_pwd - Root password . (Optional parameter. To enable the option click "on".) Enter the root password, if any. The public key will be automatically added to the server

• passwd - Password. passwd

• ip - IP address. Enter the IP address of the server from which the VPS will be imported

• name - Name. Server name

Import VPS

Function: import.start

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of import function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of import function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• user - Owner. Select a user who will own a virtual machine. Selecting auto will create the user automatically

• admin - Administrator . User has privileges for creating virtual disks

• preset - VM template . Select a virtual machine template on which a new VM will be based

• pool - Storage. Select a storage where virtual disks of the VDS that you are importing, will be created

Refresh list of VDS available for import

Function: import.refresh

Refresh list of VDS available for import

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of import function.

Result: successful operation or error message

Delete the selected server from the list

Function: import.delete

Delete the selected server from the list

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of import function.

Result: successful operation or error message

Name

Function: import.vdslist

Result: the list of elements

List of VPS on the server

Access level: admin

• id - Id

• ip - IP address

• name - Name

• status - Status

• mem - RAM

• disk - Disk size

Start VPS import

Function: import.vdslist.start

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of import function).
  • elid - unique identifier (id element of import.vdslist function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of import function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of import function).
  • elid - unique identifier (id element of import.vdslist function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name. You can specify the name for the newly created virtual machine

• user - Owner. Select the VM owner. Selecting auto will automatically create a new user

• admin - Administrator . User has privileges for creating virtual disks

• preset - VM template. Select a VM template, on which a new VM will be based

• pool - Storage. Select a storage where virtual disks of the VPS being imported will be created

• new_ip - . (Optional parameter. To enable the option click "on".) New IP address is provided for the virtual machine during the import

• iptype - IP address type.

• family - IP address. Primary IP address

• ip - IP address.

Update the list of VPSs and their statuses

Function: import.vdslist.check

Update the list of VPSs and their statuses

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of import.vdslist function.

Result: successful operation or error message

Stop import

Function: import.vdslist.stop

Stop import

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of import.vdslist function.

Result: successful operation or error message

Networks

Function: net

Result: the list of elements

Networks

Access level: admin

• id - Id

• name - Name

• type - Network type

• fdev - Interface

Edit the properties of the selected network

Function: net.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of net function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of net function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name. Enter the name for the network. You cannot change this field upon creation

• type - Network type. Network type

• bridge - Bridged networking . Enter the name of the network bridge

• ipaddr - IP address (gateway). Select an address template (IPv4 or IPv6)

• netmask - Network mask . Network mask (e.g. 255.255.255.0 or prefix 24)

• plug_iface - . (Optional parameter. To enable the option click "on".) Select the check box to connect the selected network interface to the networking bridge. You should also enter the name of the interface. All the IP address will be re-assigned to that networking bridge

• fdev - External interface . Select the network interface to which the network will be connected.

auto - auto selection

Delete

Function: net.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of net function.

Result: successful operation or error message

Name

Function: net.mac

Result: the list of elements

Network MAC-addresses

Access level: admin

• id - Identifier

• mac - MAC-address

• type - Allocation type

• value - Value

Delete MAC-address

Function: net.mac.delete

Delete MAC-address

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of net.mac function.

Result: successful operation or error message

Edit assignment of MAC-address

Function: net.mac.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of net function).
  • elid - unique identifier (id element of net.mac function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of net function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of net function).
  • elid - unique identifier (id element of net.mac function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• mac - MAC-address. Enter the MAC-address that will be assigned

• type - Object type. Select an object type for MAC-address assignment

• ipaddress - IP address. IP address that is used for defining MAC

• vmname - Virtual machine. Select a virtual machine this MAC-address will be assigned to

• my_vmname - VM name. Enter the name for the virtual machine or select an existing one from the list. If you enter the name, MAC-address will be selected automatically while creating a virtual machine

VM load

Function: reportvmtop

Result: report

Virtual machines load

Access level: admin

VM load

Function: reportvm

Result: report

This report shows service consumption by this virtual machine

Access level: user+

Virtual disks

Function: volume

Result: the list of elements

Virtual disks

Access level: admin user

• id - Id

• name - Name

• user - Owner

• host - Cluster node

• pool - Storage

• type - Storage type

• size - Size, MiB

• attached - Virtual machine

• state - Status

Move the virtual disk

Function: volume.relocate

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of volume function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of volume function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• host - Cluster node. Select a cluster node where the virtual disk will be created

• pool - Storage. Select the storage that the virtual disk will be transferred to

Modify the virtual disk size

Function: volume.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of volume function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of volume function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• user - Owner. Select an owner of the virtual disk

• host - Cluster node. Select a cluster node to create the virtual disk

• pool - Storage. Select a storage to create the virtual disk

• name - Name. Virtual disk name

• size - Size. Size of the virtual disk in MiB

Delete the virtual disk

Function: volume.extdelete

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of volume function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of volume function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Virtual disk. Enter the name of the virtual disk you want to delete

• confirm - . (Optional parameter. To enable the option click "on".) Selecting "ignore errors" will delete the virtual disk in any case

Set filter.

volume.filter

OS templates

Function: osmgr

Result: the list of elements

OS templates management

Access level: admin

• name - Template

• tags - Tags

• type - Type

• state - Status

• repo - Repository

• date - Date

OS template properties

Function: osmgr.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of osmgr function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of osmgr function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• autoupdate - . (Optional parameter. To enable the option click "on".) Enable/disablle auto-updates for template. With auto-updates enabled, the system will check template version once a day, and update it if needed

• restrict - . (Optional parameter. To enable the option click "on".) Select the check box to enable only administrators to use this template

Update the list of templates

Function: osmgr.fetch

Update the list of templates

Access level: admin

Delete the selected templates

Function: osmgr.delete

Delete the selected templates

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of osmgr function.

Result: successful operation or error message

Repository

Function: osmgr.repo

Result: the list of elements

OS template repository

Access level: admin

• name - Repository

• location - Link

Delete repository

Function: osmgr.repo.delete

Delete repository

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of osmgr.repo function.

Result: successful operation or error message

Edit OS templates repository

Function: osmgr.repo.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of osmgr function).
  • elid - unique identifier (name element of osmgr.repo function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of osmgr function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of osmgr function).
  • elid - unique identifier (name element of osmgr.repo function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• name - Repository . Repository name

• location - URL. Link to repository

Install/Update the selected templates

Function: osmgr.install

Install/Update the selected templates

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of osmgr function.

Result: successful operation or error message

Name

Function: osmgr.macros

Result: the list of elements

OS template parameters

Access level: admin

• name - Name

• value - Value

Template parameter

Function: osmgr.macros.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of osmgr function).
  • elid - unique identifier (name element of osmgr.macros function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of osmgr function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of osmgr function).
  • elid - unique identifier (name element of osmgr.macros function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• value - Value. Parameter value to pass to the OS installation script

Set default value

Function: osmgr.macros.delete

Set default value

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of osmgr.macros function.

Result: successful operation or error message

Update the list of templates

Function: osmgr.update

Update the list of templates

Access level: admin

VM templates

Function: preset

Result: the list of elements

VM templates

Access level: admin

• id - Id

• name - Name

• mem - RAM, MiB

• vcpu - CPU

• cputune - cgroups weight for CPU

Name

Function: preset.resource

Result: the list of elements

Template resources

Access level: admin

• id - Id

• type - Type

• info - Information

Edit resources of the selected template

Function: preset.resource.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of preset function).
  • elid - unique identifier (id element of preset.resource function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of preset function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of preset function).
  • elid - unique identifier (id element of preset.resource function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• type - Type. Resource type

• metapool - Storage. The storage template where virtual disks will be created

• vsize - Disk size. Enter the disk size in MiB

• network - Network . Network

• model - Card model. Select a module of the virtual network card

Delete

Function: preset.resource.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of preset.resource function.

Result: successful operation or error message

Delete

Function: preset.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of preset function.

Result: successful operation or error message

Edit the selected VM template

Function: preset.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of preset function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of preset function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name. Enter the name for the template

• mem - RAM. Enter the amount of RAM in MiB

• cpu_mode - CPU emulation mode . Virtual QEMU CPU is used by default for processor emulation. A 'host-model' mode uses processor description defined by libvirt, based on a cluster node processor. A 'host-passthrough' mode fully emulates cluster node's processor. Configuration of emulation mode is required for starting Windows 2016. We don't recommend changing the current mode unless necessary.

• custom_cpu - CPU model . The list of models can be found in the /usr/share/libvirt/cpu_map.xml file on the cluster node. You can specify the modules that correspond to vendor, architecture, and CPU features on the cluster node

• custom_cpu_features - CPU features . CPU features that should be activated. The list of all CPU features can be found by executing the 'virsh capabilities' command on the cluster node

• vcpu - CPU . The number of virtual processors available to the virtual machine

• cputune - CPU weight . Enter cgroups weight for CPU. The VM with a weight of 2000 gets twice as much CPU as a VM with a weight of 1000. The standard value is 1000

• blkiotune - I/O usage weight . cgroup weight on group operations. It enables to increase or decrease the priority in comparison with other virtual machines. The default value is 500.

• metapool - Storage template. Select a storage template where virtual disks will be created

• vsize - Main disk size. Select the size of the main disk in MiB

• network - Network . Main network

• model - Network card model. Select a model of the network card that will be used by default

• inbound - Incoming bandwidth, KiB/sec. Incoming traffic bandwidth limit, KiB/sec

• outbound - Outgoing bandwidth, KiB/sec. Outgoing traffic bandwidth limit, KiB/sec

• snapshot_limit - Snapshots . Maximum number of snapshots that a user can create for his virtual machine

Users

Function: user

Result: the list of elements

Users

Access level: root admin

• id - Id

• name - Login

• level - User role

• vmcount - VM count

• status - Status

Edit properties of the selected user

Function: user.edit

Access level: admin root

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of user function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of user function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• level - User role . Select a user role

• name - Login . Enter a username

• passwd - Password. Enter a password

• confirm - Confirm password. Re-type the password to ensure it is correct

• allowcreatevm - . (Optional parameter. To enable the option click "on".) Select the check box to enable this user to create and delete virtual machines

• vm_limit - Virtual machines. Enter the number of virtual machine that this user can create

• isolimitsize - ISO size, MiB. Enter the maximum size of ISO-images

• isolimitnum - Number of ISO. Enter the maximum number of ISO-images that this user will be able to upload

• snapshot_limit - Number of VM snapshots. Enter the maximum number of VM snapshots

Set filter.

user.filter

User permissions

Function: userrights

Result: the list of elements

Privileges

Access level: root admin

• caption - Name

• access - User role

Restrict access to list elements

Function: userrights.filter

Restrict access to list elements

Access level: root admin

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Function: userrights.delete

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Access level: root admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights function.

Result: successful operation or error message

Name

Function: userrights.fields

Result: the list of elements

List of fields (columns)

Access level: root admin

• caption - Name

• access - User role

Resume

Function: userrights.fields.resume

Resume

Access level: root admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights.fields function.

Result: successful operation or error message

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Function: userrights.fields.delete

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Access level: root admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights.fields function.

Result: successful operation or error message

Suspend

Function: userrights.fields.suspend

Suspend

Access level: root admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights.fields function.

Result: successful operation or error message

Field privileges

Function: userrights.fields.edit

Access level: admin root

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (name element of userrights function).
  • elid - unique identifier (name element of userrights.fields function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (name element of userrights function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (name element of userrights function).
  • elid - unique identifier (name element of userrights.fields function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• inhereted - . (Optional parameter. To enable the option click "on".) Do not set field permissions. They will be taken from groups to which this user is assigned

• read - . (Optional parameter. To enable the option click "on".) Allow reading the field

• write - . (Optional parameter. To enable the option click "on".) Allow editing the field

• new - . (Optional parameter. To enable the option click "on".) Allow editing the form while creating an object

Access to functions

Function: userrights.edit

Access level: root admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of user function).
  • elid - unique identifier (name element of userrights function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of user function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of user function).
  • elid - unique identifier (name element of userrights function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• inhereted - . (Optional parameter. To enable the option click "on".) Do not set permissions. The will be based on other billing policies

• access - User role . Set access permissions to this function

• inherit - . (Optional parameter. To enable the option click "on".) Apply the access permissions to all of the group functions

Policy

Function: userrights.policy

Access level: root admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • plid - parent list unique identifier (id element of user function).
  • elid - unique identifier (name element of userrights function)
• Result: object parameters list

Create an object:

Parameters:

• sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of user function).
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • plid - parent list unique identifier (id element of user function).
  • elid - unique identifier (name element of userrights function)
  • additional query parameters ...
• Result: successfull operation or error message

The list object's parameters or additional query parameters (see above):

• policy - Default policy settings. Set the user access permissions to the functions. Changing this value will reset the current access permissions. If the user is assigned into any group, the group settings will have higher priority

Resume

Function: userrights.resume

Resume

Access level: root admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights function.

Result: successful operation or error message

Suspend

Function: userrights.suspend

Suspend

Access level: root admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the name element of userrights function.

Result: successful operation or error message

Suspend the selected user

Function: user.disable

Suspend the selected user

Access level: root admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of user function.

Result: successful operation or error message

Delete

Function: user.delete

Delete

Access level: root admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of user function.

Result: successful operation or error message

Resume the selected user

Function: user.enable

Resume the selected user

Access level: root admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of user function.

Result: successful operation or error message

Switch to the User level

Function: user.su

Switch to the User level

Access level: root admin

Cluster load

Function: reporttop

Result: report

Cluster load report

Access level: admin

Policy settings

Function: settings

Access level: admin

The function is simultaneously used to view and change form's data

<b>View data</b>:

• Result: <a href="api#param">parameters list</a>

<b>Change the data</b>:

• Parameters:
  • <b>sok</b> - the parameter must not be empty, generally "ok".
  • additional query parameters ...

     		</li>
  

• Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

       </ul>

The list object's parameters or additional query parameters (see above):

• mainip - Main node IP. Enter the IP address of the main node. It is used to reach other cluster nodes. This IP address must belong to the same network as all other cluster nodes

• oversell_mem - Overselling . The amount of RAM that can be used for virtual machines (50%-500%). Values from 50 to 500

• vmtimezone - VM time zone . Default time zone for newly created guest machines

• vmregion - VM region. Region of the time zone

• vmlocation - VM location . Default location for newly created guest machines

• own_netfilter - . (Optional parameter. To enable the option click "on".) Do not create anti-spoofing rules

• mac_prefix - MAC-address prefix . Enter two first bytes of MAC-addresses of VM network interfaces, in hexadecimal notation. The first octet in binary representation should end with '10' (locally administered, unicast)

• vnc_iface - VNC network interface . Enter a network interface, where VNC-client of the virtual machine will be available. If network interface is defined automatically, this means that a VNC-server will be available on the bridged networking interface, the VM interface is connected to. Warning: changing an interface will also change configuration of all virtual machines in the cluster

• novnc_ssl - . (Optional parameter. To enable the option click "on".) Enable HTTPS protocol for VNC console. <a href="http://doc.ispsystem.com/index.php/VNC" target="_blank">More</a>

• check_unique_ip - . (Optional parameter. To enable the option click "on".) check that a unique IP address is added or allocated to a newly created virtual machine with a specific IP address

• nameservers - Name servers . Enter IP addresses space separated. Name servers on virtual machines will be configured based on this list. If no IP addresses are specified, name servers of cluster nodes where the panel is installed will be used

• http_proxy_v4 - HTTP proxy for IPv4. Used for caching packages during OS template installation

• http_proxy_v6 - HTTP proxy for IPv6. Used for caching packages during OS template installation

• iso_lifetime - ISO lifetime, hours. The number of hours that will pass before the user ISO-image will be deleted. The default value is 24

• globiso_sizelimit - Global size limit, MiB. The maximum size of ISO-images for any user. The default value is 0. In the control panel you can set a larger value, however the maximum value specified in the configuration file will be applied

• globiso_countlimit - Global ISO limit. The maximum number of ISO-images for any user. This value has a higher priority than user limits (if you set a value in user limits, which is higher than the global value, it will be ignored)

• iso_sizelimit - Size limit per user, MiB. Enter the maximum size of ISO-images that can be allocated per user. If the limit is not set when creating a new user, this value will be applied

• iso_countlimit - ISO limit per user. Enter the maximum number of ISO-images allocated to a user. If the limit is not set when creating a new user, this value will applied

• user_history - . (Optional parameter. To enable the option click "on".) select the check box to allow users to view history of their virtual machines

• recipe - Recipe . Execute the selected recipe after VM installation or reinstallation based on OS template. This recipe will be executed even if it was not selected during creation of a virtual machine. A recipe is selected from all available recipes if its name and tag matches OS template tags

• user_recipes - . (Optional parameter. To enable the option click "on".) Allows users to edit recipes

• snapshot_timeout - Snapshot creation timeout. How many seconds VMmanager will wait for virtual machine snapshot creation process to finish

• snapshot_limit - Snapshots limit . Enter the maximum number of snapshots that a user can make. The global limit will be applied if it is less than the limit set for the virtual machine

• health_monitor - . (Optional parameter. To enable the option click "on".) Check network and hard drive activity. Inactive virtual machines will be marked with theicon in the "Status" column in the list of virtual machines. A "Not active" filter will be available in the VM list

• disable_rebootondemand - . (Optional parameter. To enable the option click "on".) Postponed task is registered during the change of virtual machine configuration. The task involves reboot on demand for applying new configuration. Reboot on demand performs after 24 hours, if the virtual machines were not rebooted or stopped from the control panel during these 24 hours. To disable reboot on demand select the check box.

Unknown VM

Function: vm.unknown

Result: the list of elements

Virtual machines that were not found in the database

Access level: admin

• id - Id

• name - Name

• hostnode - Cluster node

• status - Status

VM deletion in progress. Attention! Virtual disks won't be deleted

Function: vm.unknown.delete

VM deletion in progress. Attention! Virtual disks won't be deleted

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vm.unknown function.

Result: successful operation or error message

Stop the selected virtual machine

Function: vm.unknown.stop

Stop the selected virtual machine

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vm.unknown function.

Result: successful operation or error message

Search for unknown virtual machines

Function: vm.unknown.search

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of vm.unknown function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of vm.unknown function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• all_nodes - . (Optional parameter. To enable the option click "on".) Search on all the cluster nodes

• hostnode - Cluster node. Search on the selected cluster node

SSH keys

Function: sshpubkey

Result: the list of elements

SSH keys

Access level: admin user

• name - Key name

SSH keys

Function: sshpubkey.edit

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of sshpubkey function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of sshpubkey function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Key name. Key name

• pubkey - Public SSH key. Public SSH key

Delete

Function: sshpubkey.delete

Delete

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of sshpubkey function.

Result: successful operation or error message

ISO-images

Function: iso

Result: the list of elements

List of ISO-images

Access level: admin user

• id - Id

• name - Image name

• deletetime - Deletion time

• size - Size

• status_col - Status

Delete

Function: iso.delete

Delete

Access level: admin user

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of iso function.

Result: successful operation or error message

Inventory module settings

Function: iso.upload

Access level: admin user

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of iso function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of iso function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• target_vm - Target VM . Select a virtual machine to connect the ISO-image. This operation can be required for optimization purposes

• target_node - Target cluster node . Select a cluster node where the ISO-image will be available after upload

• type - File type. Select if you want to upload the ISO-image from your local computer or provide the URL to the file on remote server

• url - URL. Enter the URL to the ISO-image you want to upload. E.g.: http://example.com/dir/file.iso

• name - File name. Enter the name for the ISO-image. If you leave the field blank, the name from the URL will be used

• shared - . (Optional parameter. To enable the option click "on".) This ISO-image will be availble to all users

• hourstodelete - Time before deletion, hours. Time in hours that will pass before the image will be deleted

• description - Description.

ISO-image

Function: iso.edit

Access level: admin+

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of iso function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of iso function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name. Enter the name for the ISO-image

• shared - . (Optional parameter. To enable the option click "on".) This ISO-image will be availble to all users

• delete - . (Optional parameter. To enable the option click "on".) Creat a cron job to delete the ISO-image automatically

• hourstodelete - New time before deletion, hour. Change the time that will pass before the image will be automatically deleted. Filling out this form will automatically recalculate the time

• description - Description. Enter any text. Users will see this text in the list of ISO-images

Traffic

Function: traffilter

Result: the list of elements

Traffic filter

Access level: admin

• id - Id

• object - Object name

• direction - Traffic type

• ip - IP address

Delete

Function: traffilter.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of traffilter function.

Result: successful operation or error message

Set filter.

traffilter.edit

Storages

Function: backup.storages

Result: the list of elements

Storages

Access level: admin

• name - Name

• destination - Location

• type - Type

Edit storage

Function: backup.storages.edit

Access level: admin

The function is simultaneously used to view object's parameters, to change an object, and create new one.

View object's parameters:

• Parameters:
  • elid - unique identifier (id element of backup.storages function)
• Result: object parameters list

Create an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • additional query parameters ...
• Result: successful operation or error message

Change an object:

• Parameters:
  • sok - the parameter must not be empty, generally "ok".
  • elid - unique identifier (id element of backup.storages function)
  • additional query parameters ...
• Result: successful operation or error message

The list object's parameters or additional query parameters (see above):

• name - Name. Enter the storage name. The name will be shown in the interface

• search_backups - . (Optional parameter. To enable the option click "on".) Search for backup copies in the storage and import the lst files into the panel. The search is performed based on readme-files

• userlevel - . (Optional parameter. To enable the option click "on".) Allow users to use this storage to do their backups

• missed_archives_list - List of missing archives:. List of missing archives in the new storage. You cannot restore data from archives in the this list

• missed_archives_agree - . (Optional parameter. To enable the option click "on".)

Set filter.

backup.storages.filter

Add

Function: backup.storages.add

Add

Access level: admin

Delete

Function: backup.storages.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of backup.storages function.

Result: successful operation or error message

Cluster resources

Function: vmhostnode.resource

Result: the list of elements

Cluster resource consumption

Access level: admin

• name - Name

• memused - RAM, MiB

• capacity - Storages

• cpu - CPU usage

Delete

Function: vmhostnode.resource.delete

Delete

Access level: admin

Parameters:

• elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the id element of vmhostnode.resource function.

Result: successful operation or error message

Add

Function: vmhostnode.resource.edit

Add

Access level: admin