VMmanager OVZ API

From ISPWiki
(Redirected from VEmanager API)
Jump to: navigation, search

Contents

Container load

Function: reportvm

Result: report

Container load report

Access level: user+

Cluster resources

Function: reportresources

Result: the list of elements

Cluster resource usage

Access level: admin

  • hostnode - Cluster node
  • ram_usage - RAM, %
  • hdd_usage - Hard drive, %
  • cpu_usage - CPU, %
  • status - Status

Cluster nodes

Function: vmhostnode

Result: the list of elements

Cluster nodes

Access level: admin

  • id - Id
  • name - Name
  • ip - IP address
  • vmcount - Number of containers
  • maxvmcount - Maximum number of containers
  • configuration - Comments
  • status - Status

Allow creation of containers on the selected node

Function: vmhostnode.resume

Allow creation of containers on the selected 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

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:

Create an object:

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):

  • 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 added to the server automatically.
  • passwd - Password. Provide the root password
  • ip - IP address. Provide the IP address for the cluster node
  • name - Name. Enter the name for the cluster node
  • maxvmcount - Maximum number of containers . Provide the maximum number of containers. If this limit is exceeded, containers will not be automatically located on this node
  • configuration - Comments . Provide any information related to the server
  • port - Port. ihttpd port number. When changing the port number, you should manually change ihttpd.conf on the cluster node

Name

Function: vmhostnode.info

Result: the list of elements

Cluster node information

Access level: admin

Name

Function: vmhostnode.info.seltype

Result: the list of elements

Access level: admin

Forbid creation of containers on the selected node

Function: vmhostnode.suspend

Forbid creation of containers on the selected 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

Filter

Function: vmhostnode.filter

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:

Create an object:

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 for the cluster node
  • ip - IP address. Provide the IP address for the cluster node

Update system software

Function: vmhostnode.refresh

Update system software

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 the selected cluster node

Function: vmhostnode.delete

Delete 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

Cluster load

Function: reporthostnode

Result: report

Cluster load report

Access level: admin

Firewall

Function: firewall

Result: the list of elements

Firewall settings

Access level: admin

  • id - File name
  • name - Name
  • proto - Protocol
  • prio - Priority

Delete the selected records

Function: firewall.delete

Delete the selected records

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:

Create an object:

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. Provide the script execution priority. The lower this value, the earlier this script will be executed
  • name - Name. Provide the script name. The file name will be as follows: NN_NAME.rule, where NN - is a priority, NAME - name of the field
  • rule - Rules.

User settings

Function: usrparam

Access level: user

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):

  • name - Username. The username that is used to gain access to the control panel.
  • theme - Theme. Select the theme that will be used to display the control panel
  • lang - Language . Select the language that will be used in the control panel
  • password - Password. Enter a password to access the control panel. If you you do not want to change the password, leave this field blank
  • confirm - Confirmation. Re-type the password to ensure it was entered correctly
  • atype - Access to control panel. Enter the IP addresses that will be allowed to access the control panel.
    Be careful and do not make mistakes, otherwise you won't be able to access the panel
  • addr - List of IP addresses. Provide a list of IP addresses that will be allowed to access the control panel. You can provide a single IP address (123.45.67.89), a mask (123.45.67.0/24) or a range of addresses (123.45.67.89-123.45.67.98)
  • startpage - Start page. Select a page that will be displayed once you log in to the control panel
  • rows - Rows per page. Enter the number of rows per page that will be displayed by default
  • recordlimit - Number of records . Provide the maximum number of records that will be listed on the tables. This will save time on forming the result if a large amount of data is used. We recommend setting a filter rather then waiting for a large list to form.
  • buttonview - Toolbar view. Select a desired way of displaying the icons on the toolbar: icons with captions or icons only
  • hintview - Hints. Active hints are shown when the mouse cursor is put on the input field. Passive are the hints that display only when you move the mouse cursor over the hint sign.
  • checkunsaved - . (Optional parameter. To enable the option click "on".) Unsaved changes notification
  • experience - User experience. Select the level of experience. This will define the number of fields to be displayed, and system settings that will be available to the user
  • developer_mode - . (Optional parameter. To enable the option click "on".) This mode enables you to change elements of the control panel interface using the web-interface.

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

Saved data

Function: backupdata

Result: the list of elements

Saved data

Access level: admin

  • type - Data type

Data name

Function: backupdata.names


Data included into backup copy

Access level: admin

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:

Create an object:

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 - File type. Select if you want to download the file from your local computer or from the remote server
  • name - File name. Provide the name for the file that you want to save in this directory. Leaving the field blank will use the name from the URL
  • storage - Storage. Select a storage for the backup copy

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:

Create an object:

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 behavior for backup recovery

Download the archive containing the backup copy

Function: backups.download

Download the archive containing the backup copy

Access level: admin

Policy settings

Function: settings

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):

  • tc_enabled - . (Optional parameter. To enable the option click "on".) Select the check box to be able to specify traffic shaping for each container
  • sync_enabled - . (Optional parameter. To enable the option click "on".) Containers' parameters will be synchronized once a day at midnight. The following parameters will be synchronized: amount of RAM, Disk size, CPU, number of CPU
  • oversell_enabled - . (Optional parameter. To enable the option click "on".) Available resources will be checked while creating containers
  • oversell_mem - RAM overselling . The percentage of RAM that can be used for containers (50%-1000%). Values from 50 to 1000
  • oversell_hdd - HDD overselling. The percentage of the hard drive that can be used for containers (50%-1000%). Values from 50 to 500
  • oversell_cpu - CPU overselling. The percentage of CPU that can be used for containers (50%-1000%). Values from 50 to 1000
  • cpulimit - CPU limit for containers . Unlimited mode - the maximum CPU frequency is not limited; limited mode - the maximum CPU is limited by container parameters; adaptive mode - CPU frequency changes dynamically.
  • migratemethod - Migration method. Select a migration method: standard - uses the zmigrate utility, live migration; VEmanager algorithm - internal algorithm is used, not live migration
  • useswaplimit - . (Optional parameter. To enable the option click "on".) Select this check box to be able to specify swap for each container.
  • swapratio - Swap/Ram ratio . Provide the swap file/RAM ratio. We recommend using 200%. This means that twice the amount of swap as RAM will be allocated. . Values from 0 to 300
  • applyexists - . (Optional parameter. To enable the option click "on".) Select the check box to apply the Swap/RAM ratio to all containers.

Containers

Function: vm

Result: the list of elements

Containers

Access level: admin user

  • id - Id
  • name - Name
  • hostnode - Cluster node
  • user - Owner
  • ip - Primary IP address
  • domain - Domain name
  • ostemplate - OS template
  • fstype - File system type
  • mem - RAM, MiB
  • status - Status
  • vmnote - Notes
  • vmnoteu - Notes

Start the selected container

Function: vm.start

Start the selected container

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

Result: successful operation or error message

Delete the selected container

Function: vm.delete

Delete the selected container

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

Result: successful operation or error message

Parameter

Function: vm.sysinfo

Result: the list of elements

System information

Access level: admin user

  • name - Parameter
  • value - Value

Edit properties of the container

Function: vm.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:

Create an object:

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 - Id. Unique identifier
  • name - Name. Enter the name for the container
  • user - Owner. Select a use who will be the owner of this container
  • hostnode - Cluster node. Select a cluster node where a new container will be created
  • preset - Container template. In this template you can specify the main resources for your container
  • ostemplate - OS template. Operating system templates
  • fstype - File system type. simfs - the container's file system is a part of the file system of the cluster node, ploop - for locating the container's file system a special disk image is created.
  • iptype - IP address type. Public - can be accessed from the Internet, private - cannot be accessed from the Internet
  • family - IP address. Primary IP address
  • ip - Certain IP address. Enter the main IP address
  • domain - Domain name. Enter the name for the container
  • hdd - Main disk size. Select the size of the main disk in MB
  • mem - RAM. Provide the amount of RAM in MiB
  • swapratio - Swap/Ram ratio . Provide the swap file/RAM ratio. We recommend using 200%. This means that twice the amount of swap as RAM will be allocated. . Values from 0 to 300
  • cpu - CPU. The number of virtual processes available to the container
  • cpufreq - CPU frequency . CPU frequency. For more information consult our Documentation
  • numfile - File descriptors. The maximum number of open file descriptors.
  • numproc - Processes . The maximum number of processor per container.
  • chratein - Incoming. Incoming traffic bandwidth limit
  • chrateout - Outgoing. Outgoing traffic bandwidth limit
  • iolimit - I/O limit (iolimit). Provide the maximum data exchange rate with disk unit
  • iopslimit - I/O-operations per second (iopslimit). Provide the maximum number of input/output operations per second
  • password - Password. Enter the superuser password
  • confirm - Confirmation. Confirm the password to ensure it is correct
  • blocked - . (Optional parameter. To enable the option click "on".) With this check box selected the container is blocked. It cannot be stopped, started, deleted, reinstalled, and its IP addresses cannot be removed.
  • sshpubkey - Public SSH keys. Public SSH keys
  • vmnote - Notes. Additional information related to the container
  • vmnoteu - User notes.

Container 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:

Create an object:

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):

  • hostnode - Destination server . Select a server to which the selected container will be migrated
  • live - . (Optional parameter. To enable the option click "on".) The container will be running during the migration process. It will take a longer time and will consume more resources

Switch to ISPmanager with privileges of administrator of the selected server

Function: vm.isp

Switch to ISPmanager with privileges of administrator of the selected server

Access level: admin user

Filter

Function: vm.filter

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:

Create an object:

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 - Id. Unique identifier
  • name - Name. Enter the name for the container
  • hostnode - Cluster node. Select a cluster node where a new container will be created
  • user - Owner. Select a use who will be the owner of this container
  • ip - IP address. Enter the main IP address
  • domain - Domain name. Enter the name for the container
  • ostemplate - OS template. Operating system templates
  • fstype - File system type. simfs - the container's file system is a part of the file system of the cluster node, ploop - for locating the container's file system a special disk image is created.
  • status - Status.
  • mem - RAM. Provide the amount of RAM in MiB
  • note - Notes.
  • noteu - Notes.

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:

Create an object:

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):

  • ostemplate - OS template. Operating system templates
  • sshpubkey - Public SSH keys. Public SSH keys
  • passwd - Password. Enter the superuser password
  • confirm - Confirmation. Confirm the password to ensure it is correct

Stop the selected container

Function: vm.stop

Stop the selected container

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

Result: successful operation or error message

Go to the control panel as the owner of the container

Function: vm.su

Go to the control panel as the owner of the container

Access level: admin

Name

Function: vm.snapshot

Result: the list of elements

Container snapshots

Access level: admin user

  • id - Id
  • guid - UID
  • name - Name
  • date - Creation date
  • status - Status

Switch to the selected snapshot

Function: vm.snapshot.switch

Switch to the selected snapshot

Access level: admin user

Make container snapshot

Function: vm.snapshot.edit

Access level: user 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 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. Provide the name for the snapshot
  • description - Description. Provide any information related to the snapshot
  • memdump - . (Optional parameter. To enable the option click "on".) Container must be on. If the option is disabled, switching to this snapshot will suspend the container

Delete the selected records

Function: vm.snapshot.delete

Delete the selected records

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

Name

Function: iplist

Result: the list of elements

List of IP addresses

Access level: admin user

  • id - Id
  • ip - IP address
  • domain - Domain

Back to the previous page

Function: '

Back to the previous page

Access level: admin user

Edit 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):

  • iptype - IP address type. Public - can be accessed from the Internet, private - cannot be accessed from the Internet
  • family - IP address. Select a desired IP address
  • ip - IP address. Provide an IP address
  • 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

Reboot of the container

Function: vm.restart

Reboot of the container

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

Convert into ploop

Function: vm.convert

Convert into ploop

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

Result: successful operation or error message

Saved data

Function: backupdata

Result: the list of elements

Saved data

Access level: admin

  • type - Data type

OS templates

Function: osmgr

Result: the list of elements

OS templates management

Access level: admin

  • name - Template
  • type - Type
  • state - Status
  • repo - Source
  • date - Date

Edit properties of the OS template

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:

Create an object:

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".) Activate/disable autoupdate for the selected template. If the autoupdate is on, the system will check the template version once a day and update it, if needed
  • restrict - . (Optional parameter. To enable the option click "on".) If the restriction is on, only administrator can install 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: repo

Result: the list of elements

OS templates repository

Access level: admin

  • name - Repository
  • location - Link

Delete the selected repository

Function: repo.delete

Delete the selected 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 repo function.

Result: successful operation or error message

Edit properties of the OS templates repository

Function: 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 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 repo function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • name - Repository. Provide the name for the repository
  • location - Link. Link to the 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

Update the list of templates

Function: osmgr.update

Update the list of templates

Access level: admin

Containers templates

Function: preset

Result: the list of elements

Containers templates

Access level: admin

  • id - Id
  • name - Name
  • hdd - Disk space, MB
  • mem - RAM, MB
  • swapratio - Swap/Ram ratio, %
  • cpu - CPU, pcs
  • cpufreq - CPU frequency, MHz
  • numfile - File descriptors
  • numproc - Processes

Filter

Function: preset.filter

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:

Create an object:

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 - Container template name. Template name
  • hdd - Main disk size. Select the size of the main disk in MB
  • mem - RAM. Select RAM in MB
  • cpu - CPU. Select the number of processes that will be available to this container
  • cpufreq - CPU frequency . Select CPU frequency. For more information consult our Documentation
  • numfile - File descriptors. The maximum number of open file descriptors.
  • numproc - Processes . The maximum number of processor per container.

Delete the selected container template

Function: preset.delete

Delete the selected container template

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 container 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:

Create an object:

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 - Container template name. Template name
  • mem - RAM. Select RAM in MB
  • swapratio - Swap/Ram ratio . This parameter is calculated only with the "Private swap limits" check box selected. Specify the Swap file/Ram ratio. We recommend using 200%, i.e. twice the amount of Swap space as Ram will be used. . Values from 0 to 300
  • cpu - CPU. Select the number of processes that will be available to this container
  • cpufreq - CPU frequency . Select CPU frequency. For more information consult our Documentation
  • hdd - Main disk size. Select the size of the main disk in MB
  • numfile - File descriptors. The maximum number of open file descriptors.
  • numproc - Processes . The maximum number of processor per container.
  • chratein - Incoming. Incoming traffic bandwidth limit
  • chrateout - Outgoing. Outgoing traffic bandwidth limit
  • iolimit - I/O limit (iolimit). Provide the maximum data exchange rate with disk unit
  • iopslimit - I/O-operations per second (iopslimit). Provide the maximum number of input/output operations per second

Users

Function: user

Result: the list of elements

Users

Access level: 29+

  • id - Id
  • name - Login
  • level - User role
  • ctcount - Number of containers
  • status - Status

Edit properties of the selected user

Function: user.edit

Access level: 29+

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

View object's parameters:

Create an object:

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
  • snapshot_limit - Snapshots limit. The maximum number of containers snapshots that a user can create
  • passwd - Password. Enter a password
  • confirm - Confirmation. Retype the password to ensure it is correct

Edit properties of the selected user

Function: user.filter

Access level: 29+

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

View object's parameters:

Create an object:

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):

  • name - Login . Enter a username
  • level - User role . Select a user role

Suspend the selected user

Function: user.suspend

Suspend the selected user

Access level: 29+

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 the selected user

Function: user.delete

Delete the selected user

Access level: 29+

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: 29+

Enable the selected user

Function: user.resume

Enable the selected user

Access level: 29+

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

VPS import

Function: import

Result: the list of elements

Servers running VDSmanager

Access level: 29+

  • id - Id
  • ip - IP address
  • name - Name
  • vdscount - Number of VPS
  • status - Status

Filter

Function: import.filter

Access level: 29+

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

View object's parameters:

Create an object:

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):

  • ip - IP address. Provide the IP address of the server from which the VPS will be imported
  • name - Name. Server name

Stop the import process

Function: import.stop

Stop the import process

Access level: 29+

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: 29+

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

View object's parameters:

Create an object:

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. Provide the IP address of the server from which the VPS will be imported
  • name - Name. Server name

Import VPS

Function: import.start

Access level: 29+

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

View object's parameters:

Create an object:

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 be the owner of this container. Selecting "Add new" will automatically create a new user for each container
  • fstype - File system type. simfs - the container's file system is a part of the file system of the cluster node, ploop - for locating the container's file system a special disk image is created.

Update the list of VPS

Function: import.refresh

Update the list of VPS

Access level: 29+

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: 29+

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: 29+

  • id - Id
  • ctid - Id VDSmgr
  • vectid - Id VEmgr
  • ip - IP address
  • name - Name
  • mem - RAM
  • disk - Disk size
  • cpufreq - CPU frequency
  • cpucount - CPU
  • ostemplate - OS template
  • status - Status

Start VPS import

Function: import.vdslist.start

Access level: 29+

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):

  • changename - Edit the VPS name . (Optional parameter. To enable the option click "on".)
  • name - Name. You can specify the name for the newly created virtual machine
  • user - Owner. Select a user who will be the owner of this container. Selecting "Add new user" will create a new user automatically
  • fstype - File system type. simfs - the container's file system is a part of the file system of the cluster node, ploop - for locating the container's file system a special disk image is created.

Update the list of VPSs and their statuses

Function: import.vdslist.check

Update the list of VPSs and their statuses

Access level: 29+

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: 29+

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

Filter

Function: import.vdslist.filter

Access level: 29+

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):

  • ctid - Id VDSmgr.
  • vectid - Id VEmgr.
  • ip - IP address.
  • name - Name.

Backup plans

Function: backup.plan

Result: the list of elements

Backup plans

Access level: admin

  • name - Name
  • cron - Schedule
  • type - Type
  • state - Status

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:

Create an object:

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. Enter the maximum time out for data preparation (virtual machines)

The string will be commented out in crontab that starts the task. If the string is missing in crontab, a new one containing default value will be created

Function: backup.plan.enable

The string will be commented out in crontab that starts the task. If the string is missing in crontab, a new one containing default value will be created

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

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

The string will be commented in crontab that starts the task.You still will be able to start the plan manually

Function: backup.plan.disable

The string will be commented in crontab that starts the task.You still will be able to start the plan manually

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

Data name

Function: backup.plan.datafilter

Result: the list of elements

Backup filter settings

Access level: admin

  • num - Number
  • type - Data type
  • owner - Owner
  • name - Data name
  • filename - Files
  • comment - Comments
  • include - Status

Edit filter

Function: backup.plan.datafilter.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 backup.plan function).
    • elid - unique identifier (id element of backup.plan.datafilter 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 backup.plan 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 backup.plan function).
    • elid - unique identifier (id element of backup.plan.datafilter function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • include - Status. Include or exclude data from backup copy
  • comment - Comments. Detailed information about this filter
  • type - Data type. Select data for backup
  • owner - Owner. Select the user who owns these data
  • allnames - Data. Select data based on their names
  • pattern - Template. Filter template based on data name. You can use the * and ? characters
  • name - Select data. Select data based on their names
  • ft_files - . (Optional parameter. To enable the option click "on".)
  • filename - File or directory. Enter a relative path to the file or directory for which you want to set this filter

Delete the selected records

Function: backup.plan.datafilter.delete

Delete the selected records

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.datafilter function.

Result: successful operation or error message

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:

Create an object:

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. Provide 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. Provide 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. Provide 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
  • run_every - Run. cron execution period
  • 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

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:

Create an object:

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 the selected records

Function: sshpubkey.delete

Delete the selected records

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

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:

Create an object:

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. Provide 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
  • 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".)

Add

Function: backup.storages.add

Add

Access level: admin

Delete the selected records

Function: backup.storages.delete

Delete the selected records

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 load

Function: reporthostnode

Result: report

Cluster load report

Access level: admin