VDSmanager API/Server administrator

From ISPWiki

(Redirected from VDSmanager API)
Jump to: navigation, search

Contents

See also


Server administrator

Main

VPS management

VPS management

Function: vds

Result: the list of elements

  • id - ID.
  • name - Name.
  • ip - IP-address.
  • slave - Slave server.
  • owner - Owner.
  • disabled - VPS is disabled.
  • blocked - Server is protected from destructions .
  • bnone - Backing up is disabled.
  • bday - Daily backup.
  • bweek - Weekly backup.
  • bmonth - Monthly backup.
  • admdown - Suspended by administrator .
  • arrive - This VPS is currently being transferred from another server.
  • backup - Backing up in progress .
  • leave - This VPS is currently being transferred to another server.
  • warning - One or more errors occurred while performing the last operation .
  • note - Notes:.
  • restore - This VPS is currently being restored from the backup copy .
  • resize - Changing disk size.
  • vsnotsend - Messages not sent .
  • vswait - Awaiting response .
  • vslink - Successful connection .
  • vsobsolete - Outdated status.
  • vsnotresponse - Server Not Responding. VDStolls is not installed or does not work .
  • portfilter - Port filtering is active .
  • dtempl - Disk template.
  • cpuinfo - CPU .
  • mem - Memory.
  • disk - Disk. Attributes :
    • used - The used number.
    • limit - Max value limitation
  • traf - Bandwidth . Attributes :
    • used - The used number.
    • limit - Max value limitation


Back up the selected VPS

Function: vds.imgbackup

Parameters:

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

Result: successful operation or error message


Back up the VPS

Function: vds.sbackup

Parameters:

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

Result: successful operation or error message


Restore the selected virtual servers from the latest backup. View. Change

Function: vds.restore

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

View data:

Change the data:

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

  • ip - List of the IP-addresses. (One or more values space-delimited)


Create. Change. VPS properties

Function: vds.edit

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 "yes".
    • elid - unique identifier ("ip" element of "vds" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • slave - Slave server.
  • id - Server identifier. The parameter may vary depending on feature vdsid.
  • name - Server name.
  • ip - IP-address.
  • billmask - Subnetwork mask.
  • billgw - Gateway.
  • passwd - Administrator password.
  • confirm - Confirm password.
  • owner - Owner.
  • vdspreset - VPS template .
  • disktempl - Disk template.
  • pvtdisk - Storage disk . The parameter may vary depending on feature multidisk.
  • extns - External names server.
  • ispmgr - ISPmanager license.
  • disk - Disk space.
  • mem - Memory.
  • swap - Swap file . The parameter may vary depending on feature swap.
  • bmem - Burstable RAM. The parameter may vary depending on feature burstable.
  • cpu - CPU.
  • ncpu - CPU number . The parameter may vary depending on feature ncpu.
  • proc - Processes .
  • desc - File descriptors .
  • traf - Monthly traffic.
  • chrate - Channel rate. The parameter may vary depending on feature enablets.
  • backup - Backups.
  • ipcount - Alias IP-addresses.
  • ip6count - Alias IPv6. The parameter may vary depending on feature ip6count.
  • vnet - Virtual network environment . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature vnet.
  • kvmnet - Network for KVM. The parameter may vary depending on feature kvmnet.
  • blocked - Blocked . (Optional parameter. To enable the option click "on".)
  • limitpvtdns - Private DNS limit . The parameter may vary depending on feature DnsLimits.
  • limitpubdns - Hosted DNS limit. The parameter may vary depending on feature DnsLimits.
  • cpushares - cpu.shares limit .
  • blkioweight - blkio.weight limit .
  • note - .
  • enablefirewall - Enable port filtering . (Optional parameter. To enable the option click "on".)
  • disabledport - Filter ports . (One or more values space-delimited)


Delete all the selected servers

Function: vds.delete

Parameters:

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

Result: successful operation or error message


VPS re-installation

Function: vds.reinstall

  • disktempl - Disk template .


Create. Change. Move the VPS to a server

Function: vds.move

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 "yes".
    • elid - unique identifier ("ip" element of "vds" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • ip - IP-address of the virtual server .
  • host - Server IP-address.
  • user - Login.
  • passwd - Password.
  • pvtdisk - Private disk.
  • sshport - SSH port .
  • newip - Allocate new IP. (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature bsdvps.


Enable the selected servers

Function: vds.enable

Parameters:

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

Result: successful operation or error message


Disable the selected servers

Function: vds.disable

Parameters:

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

Result: successful operation or error message


Reboot the selected servers

Function: vds.reboot

Parameters:

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

Result: successful operation or error message


Soft off

Function: vds.softpoweroff

Parameters:

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

Result: successful operation or error message


Soft reboot

Function: vds.softreboot

Parameters:

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

Result: successful operation or error message


Connecting the virtual CD

Function: vds.attachcd

  • iso - List of the ISO images .


Disable the selected CD

Function: vds.detachcd

Parameters:

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

Result: successful operation or error message


Connecting the virtual CD

Function: vds.bootprio

  • priority - Boot priority . (One or more values space-delimited)


IP-addresses management

Function: vds.ip

Parameters:

  • elid - unique identifier ("ip" element of "vds" function).

Result: elements list

  • ip - IP-address.
  • name - Reverse DNS name.


Create. Change. IP-address properties

Function: vds.ip.edit

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 ("ip" element of "vds" function).
    • elid - unique identifier ("ip" element of "vds.ip" function)
  • Result: object parameters list

Create an object:

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

Change an object:

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

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

  • ip - IP-address.
    If the other value is selected the parameters are allowed to use: 'oip' and the parameters are denied: 'ipcount','ip6count'
If the count value is selected the parameters are allowed to use: 'ipcount','ip6count' and the parameters are denied: 'oip'
  • ip - IP-address.
  • otherip - Exact IP-address.
  • ipcount - Number of IP-addresses .
  • ip6count - Number of IPv6 addresses .
  • name - Reverse domain name.


Delete the selected IP-addresses

Function: vds.ip.delete

Parameters:

  • plid - parent list unique identifier ("ip" element of "vds" function).
  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "ip" element of "vds.ip" function.

Result: successful operation or error message


Switch to VDS administrator panel

Function: vds.su


Access the ISPmanager control panel using privileges of the selected server administrator

Function: vds.isp


Remove the error status

Function: vds.removest

Parameters:

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

Result: successful operation or error message


User management

User management

Function: user

Result: the list of elements

  • name - Username.
  • level - Access level.
  • disabled - User account is disabled.
  • note - Notes:.


Create. Change. Edit the selected user's properties

Function: user.edit

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 "yes".
    • elid - unique identifier ("name" 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 - Username.
  • passwd - Password.
  • confirm - Confirmation.
  • alevel - Access level.
    If the admin value is selected the parameters are denied: 'l0','l1', 'l2', 'l3', 'l4', 'l5', 'l6', 'll6', 'l7', 'l8', 'l9', 'l10', 'maxdesc'
  • rslrtempl - Resellers template.
  • vdslimit - VPS limit .
  • cpulimit - CPU limit .
  • memlimit - Memory limit .
  • disklimit - Disk space .
  • maxcpu - VPS CPU limit .
  • maxmem - VPS memory limit .
  • maxswap - VPS swap limit . The parameter may vary depending on feature swap.
  • maxdesc - VPS files limit .
  • ipalias - Additional IP-addresses .
  • allowdns - External DNS . (Optional parameter. To enable the option click "on".)
  • allowlic - ISPmanager licenses . (Optional parameter. To enable the option click "on".)
  • allowbak - Allow backups . (Optional parameter. To enable the option click "on".)
  • note - .


Delete the selected users

Function: user.delete

Parameters:

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

Result: successful operation or error message


Enable the selected user and his virtual servers

Function: user.enable

Parameters:

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

Result: successful operation or error message


Disable the selected user and his virtual servers

Function: user.disable

Parameters:

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

Result: successful operation or error message


Switch to User panel

Function: user.su


Statistics

Bandwidth usage

Bandwidth usage

Function: statvds

Result: the list of elements

  • name - Hostname.
  • ip - IP-address.
  • in - incoming.
  • out - outgoing.


Bandwidth usage per days

Function: statvdsgraph

Parameters:

  • elid - unique identifier ("ip" element of "statvds" function).

Result: elements list

  • date - Date .
  • in - incoming .
  • out - outgoing.


Rejects report

Resource allocation problems

Function: vdsrejects

Result: the list of elements

  • name - Domain name.
  • ip - IP-address.
  • rejp - Start process .
  • rejf - File descriptors .
  • rejm - Allocated memory .
  • rejs - Swap .


Report period. View. Change

Function: rejectsparam

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

View data:

Change the data:

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

  • from - Start date .
  • to - End date .


Resources usage

VPS usage report

Function: vdsusage

Result: the list of elements

  • name - Name.
  • ip - IP-address.
  • cpuu - CPU, %.
  • memu - Memory, %.
  • procu - Processes, %.
  • fileu - File descriptors %.
  • ioblock - Disk operations .


Report period . View. Change

Function: usageparam

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

View data:

Change the data:

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

  • from - Start date .
  • to - End date .


Main system usage

Current usage of the main system resources

Function: mainusage

Result: the list of elements

  • name - Date/Time.
  • cpuu - CPU (% used).
  • memu - RAM (% used).
  • swapu - Swap (% used).
  • disk0 - Disk #1 (% used).


Current activity

Active sessions

Function: session

Result: the list of elements

  • id - Session id.
  • name - User name.
  • lv_12 - .
  • lv_11 - .
  • lv_10 - .
  • lv_7 - Server administrator.
  • lv_6 - Reseller.
  • lv_5 - User.
  • lv_4 - User with access to shell.
  • lv_3 - User with access to FTP.
  • lv_2 - Mailbox.
  • ip - IP-address.
  • idle - Idle.


Terminate the selected session(s)

Function: session.delete

Parameters:

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

Result: successful operation or error message


Log in to the control panel with the same access privileges

Function: session.su


Action log

Action log

Function: journal

Result: the list of elements

  • id - The list element unique identifier
  • time - Time.
  • user - User.
  • ip - Remote IP-address.
  • funcname - Function.


Action log . View. Change

Function: journal.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

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

Change an object:

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

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

  • time - Time.
  • user - User.
  • ip - Remote IP-address.
  • funcname - Function.
  • params - Parameters.


Network interfaces load

Primary network interface load

Function: ifaceusage

Result: the list of elements

  • name - VPS name .
  • ip - Main IP-address .


VS partitions

Private disk partitions

Function: pvtdiskusage

Result: the list of elements

  • path - VS path.
  • device - Device name.
  • disk - Disk usage. Attributes :
    • used - The used number.
    • limit - Max value limitation
  • vscount - Number of VSs.


Path properties for the private disks. View. Change

Function: pvtdiskusage.edit

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

View data:

Change the data:

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

  • path - VS path.


Delete the unused private disks partition

Function: pvtdiskusage.delete

Parameters:

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

Result: successful operation or error message


System information

System information

Function: sysinfo

Result: the list of elements

  • name - Parameter.
  • value - Value.


Integration

Integration with IPmanager

Integration with IPmanager. View. Change

Function: ipmgr

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

View data:

Change the data:

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

  • server - URL to IPmanager .
  • user - Login .
  • passwd - Password .


Remote DNS

Remote DNS

Function: dnsmgr

Result: the list of elements

  • name - Control panel URL .
  • allowprivate - .
  • allowprovider - .


Create. Change. DNSmanager remote server

Function: dnsmgr.edit

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 "yes".
    • elid - unique identifier ("name" element of "dnsmgr" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • name - Control panel URL .
  • username - Username.
  • passwd - Password.
  • allowprivate - . (Optional parameter. To enable the option click "on".)
  • allowprovider - . (Optional parameter. To enable the option click "on".)
    Active parameter allows the use of the following parameters: 'providername'
  • providername - Name server domain .


Delete the selected name server

Function: dnsmgr.delete

Parameters:

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

Result: successful operation or error message


Remote DNS properties. View. Change

Function: dnsmgr.prop

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

View data:

Change the data:

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

  • domain - Provider's domain.
  • limitown - Private DNS limit.
  • limitpub - Provider DNS limit.
  • pvtserver - Server IP-address.


ISPmanager licenses

ISPmanager licenses. View. Change

Function: licmgr

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

View data:

Change the data:

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

  • servertype - License server .
    If the none value is selected the parameters are denied: 'server','username','passwd','autotype','l1','l2','p1','p2'
If the ispsystem value is selected the parameters are allowed to use: 'username','passwd','autotype' and the parameters are denied: 'server','l1','l2','p1','p2'
If the other value is selected the parameters are allowed to use: 'username','passwd','server','l1','l2','p1','p2' and the parameters are denied: 'autotype'
  • server - BILLmanager address .
  • username - Username.
  • passwd - Password.
  • autotype - License type.
  • litepriceid - ISPmanager-Lite package ID .
  • liteperiodid - ISPmanager-Lite period ID .
  • propriceid - ISPmanager-Pro package ID .
  • properiodid - ISPmanager-Pro period ID .


Slave servers

Slave servers

Function: slave

Result: the list of elements

  • name - Control panel URL .


Create. Change. Slave server parameters

Function: slave.edit

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 "yes".
    • elid - unique identifier ("name" element of "slave" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • name - Control panel URL .
  • user - Login.
  • passwd - Password.


Delete

Function: slave.delete

Parameters:

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

Result: successful operation or error message


Switch to the slave server's control panel

Function: slave.su


Settings

Policy

Server Policy. View. Change

Function: policy

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

View data:

Change the data:

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

  • overtaff - . (Optional parameter. To enable the option click "on".)
  • pingip - Check IP-address with ping . (Optional parameter. To enable the option click "on".)
  • useswaplimit - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature bsdvps.
    Active parameter denies the following parameters: 'swapratio'
  • swapratio - SwapRatio. The parameter may vary depending on feature bsdvps.
  • shdtimeout - JailShutdownTimeout. The parameter may vary depending on feature bsdvps.
  • virtualcd - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature virtualcd.
  • softreboot - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature softreboot.
  • disablelinkdiscover - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature disablelinkdiscover.
  • antispoof - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature antispoof.
  • enablets - Enable shaping . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature enablets.
  • presetchangeresource - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature presetchangeresource.
  • forceorderlicense - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature forceorderlicense.
  • enableportfiltering - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature enableportfiltering.
  • oversellmem - OversellMem. The parameter may vary depending on feature oversellmem.
  • cpufreq - CpuFreq. The parameter may vary depending on feature cpufreq.
  • cpucount - CpuCount. The parameter may vary depending on feature cpucount.
  • bram - BRamM. The parameter may vary depending on feature bram.
  • vgn - VolumeGroupName. The parameter may vary depending on feature vgn.
  • vdsinterface - VdsInterface. The parameter may vary depending on feature vdsinterface.
  • devfs - DevfsRuleset. The parameter may vary depending on feature devfs.
  • devfsvnet - DevfsVnetRuleset. The parameter may vary depending on feature devfsvnet.
  • cgroups - CGroups. The parameter may vary depending on feature cgroups.
  • trustip - TrustIP. The parameter may vary depending on feature trustip.
  • altmirror - AltTplMirror. The parameter may vary depending on feature altmirror.
  • dnslimits - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature dnslimits.
  • limitpvtdns - Private DNS limit . The parameter may vary depending on feature limitpvtdns.
  • limitpubdns - Hosted DNS limit. The parameter may vary depending on feature limitpubdns.
  • humanfilesize - . (Optional parameter. To enable the option click "on".) The parameter may vary depending on feature humanfilesize.
  • privatediskdir - PrivateDiskDir. The parameter may vary depending on feature privatediskdir.
  • mountdir - MountDir. The parameter may vary depending on feature mountdir.
  • tmpdir - TmpDir. The parameter may vary depending on feature tmpdir.
  • bridge - Bridge. The parameter may vary depending on feature bridge.
  • dgate - DefaultGateway. The parameter may vary depending on feature dgate.


Brand settings

Brand settings . View. Change

Function: brand

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

View data:

Change the data:

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

  • site - Link to your web site (e.g. http://my-hosting-company.com).
  • project - Link to your web site (e.g. http://my-hosting-company.com).
  • mainlogo - .
  • loginlogo - .
  • favicon - .
  • reset - Reset all the branding settings . (Optional parameter. To enable the option click "on".)
  • h - Hue .
  • s - Saturation .
  • l - Brightness .
  • headinclude - Add to HEAD.
  • customstring - Your copyright notice . (Optional parameter. To enable the option click "on".)
    Active parameter allows the use of the following parameters: 'customstringvalue'
Active parameter denies the following parameters: 'companyname','foundationyear'
  • customstringvalue - Copyright .
  • companyname - Company name .
  • foundationyear - Year of foundation .
  • companyurl - Web-site URL.
  • noaddlang - Remove the locale parameter from URL . (Optional parameter. To enable the option click "on".)


VPS templates

VPS templates

Function: vdspreset

Result: the list of elements

  • name - Name.
  • resource - Resources.
  • traf - Monthly traffic.


Create. Change. Template parameters

Function: vdspreset.edit

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 "yes".
    • elid - unique identifier ("name" element of "vdspreset" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • name - Name .
  • disk - Disk space .
  • mem - Memory.
  • swap - Swap file . The parameter may vary depending on feature swap.
  • bmem - Burstable RAM. The parameter may vary depending on feature burstable.
  • cpu - CPU.
  • ncpu - Number of CPU . The parameter may vary depending on feature ncpu.
  • proc - Processes .
  • desc - File descriptors .
  • traf - Monthly traffic.
  • chrate - Channel bandwidth . The parameter may vary depending on feature enablets.
  • disktempl - Disk template.
  • config - Configuration template . The parameter may vary depending on feature openvz.
  • limitpvtdns - Private DNS limit. The parameter may vary depending on feature DnsLimits.
  • limitpubdns - Hosted DNS limit. The parameter may vary depending on feature DnsLimits.


Delete the selected VPS template

Function: vdspreset.delete

Parameters:

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

Result: successful operation or error message


Importing VPS templates . View. Change

Function: vdspreset.import

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

View data:

Change the data:

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

  • host - Server.
  • user - Login.
  • passwd - Password.


Reseller templates

Reseller template

Function: rslrtempl

Result: the list of elements

  • name - Name.
  • resource - Resources.


Create. Change. Reseller template parameters

Function: rslrtempl.edit

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 "yes".
    • elid - unique identifier ("name" element of "rslrtempl" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • name - Name.
  • vds - Number of VPSs.
  • mem - Memory limit.
  • cpu - CPU limit.
  • maxmem - VDS memory limit .
  • maxswap - VPS swap limit . The parameter may vary depending on feature swap.
  • maxcpu - VPS CPU limit.
  • maxdesc - VPS files limit .
  • disk - Disk limit.
  • ipalias - Additional IP-addresses limit.
  • allowdns - . (Optional parameter. To enable the option click "on".)
  • allowlic - . (Optional parameter. To enable the option click "on".)
  • allowbak - . (Optional parameter. To enable the option click "on".)


Delete the selected reseller templates

Function: rslrtempl.delete

Parameters:

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

Result: successful operation or error message


Disk templates

Disk templates

Function: disktempl

Result: the list of elements

  • name - Name.
  • path - Path.
  • state - Status.
  • autoupoff - Auto-update is not active .
  • version - Version.
  • lastupdate - Last update .


Enable auto-update

Function: disktempl.autoupenable

Parameters:

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

Result: successful operation or error message


disable auto-update

Function: disktempl.autoupdisable

Parameters:

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

Result: successful operation or error message


Installing the disk template . View. Change

Function: disktempl.install

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

View data:

Change the data:

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

  • remotetmp - Use a template.
  • localname - Local name.


Update the selected disk templates

Function: disktempl.update

Parameters:

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

Result: successful operation or error message


Updates

Function: disktempl.changelog

Parameters:

  • elid - unique identifier ("name" element of "disktempl" function).

Result: elements list

  • item - Changes .


Delete the selected disk templates

Function: disktempl.delete

Parameters:

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

Result: successful operation or error message


IP-addresses

IP-addresses management

Function: iplist

Result: the list of elements

  • name - IP-address .
  • usedby - In use .
  • access - Access level .


Create. Change. Edit level of access for the selected IP-address

Function: iplist.edit

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 "yes".
    • elid - unique identifier ("name" element of "iplist" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • name - IP-addresses .
  • atype - Access level .
    If the allow value is selected the parameters are denied: 'memb'
If the deny value is selected the parameters are denied: 'memb'
If the denypartial value is selected the parameters are allowed to use: 'memb'
If the allowpartial value is selected the parameters are allowed to use: 'memb'
  • members - Resellers . (One or more values space-delimited)


Delete the selected IP-addressees

Function: iplist.delete

Parameters:

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

Result: successful operation or error message


KVM networks

Network settings for KVM

Function: kvmnet

Result: the list of elements

  • name - Name.
  • priority - Priority.
  • network - Network .
  • iface - Network interface name.
  • mac - MAC address template.
  • model - Model.


Create. Change. Add new network

Function: kvmnet.edit

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 "yes".
    • elid - unique identifier ("name" element of "kvmnet" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • name - Name.
  • iface - Interface .
  • mac - MAC address template .
  • model - Network card model.
  • priority - Network priority.
  • network - Network.
  • script - .
  • downscript - .


Delete the selcted network

Function: kvmnet.delete

Parameters:

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

Result: successful operation or error message


Network parameters

Network properties

Function: netlist

Result: the list of elements

  • addr - IP-address .
  • mask - Network mask .
  • gateway - Gateway address .


Create. Change. Network properties

Function: netlist.edit

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 "yes".
    • elid - unique identifier ("addr" element of "netlist" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • addr - IP-address.
  • mask - Network mask .
  • gateway - Gateway address .


Delete the selected networks

Function: netlist.delete

Parameters:

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

Result: successful operation or error message


Backup

Backup. View. Change

Function: backup

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

View data:

Change the data:

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

  • btype - Storage type.
    If the none value is selected the parameters are denied: 'ftphost','ftpuser','ftppasswd','ldir','c5','c6','local'
If the dir value is selected the parameters are allowed to use: 'ldir','c5','c6','local' and the parameters are denied: 'ftphost','ftpuser','ftppasswd'
If the ftp value is selected the parameters are allowed to use: 'ftphost','ftpuser','ftppasswd','c5','c6','local' and the parameters are denied: 'ldir'
  • local - Backup. (Optional parameter. To enable the option click "on".)
  • dir - Local directory.
  • ftphost - FTP-server.
  • ftpuser - Login.
  • ftppasswd - Password.
  • count - Number of backups.
  • modern - Use ISPbackup. (Optional parameter. To enable the option click "on".)


Access to modules

Access to modules

Function: access

Result: the list of elements

  • name - Function name.
  • ftitle - Module name.
  • lv_12 - The module is available for administrators .
  • lv_11 - The module is available for resellers .
  • lv_10 - The module is available for users .
  • lv_7 - The module is available for server administrator .
  • lv_6 - The module is available for resellers .
  • lv_5 - The module is available for site administrators .
  • lv_4 - The module is available for shell users .
  • lv_3 - The module is available for FTP users .
  • lv_2 - The module is available for mail users .
  • status - Status.


Access to the module . View. Change

Function: access.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

  • Parameters:
    • elid - unique identifier ("name" element of "access" function)
  • Result: parameters list

Change an object:

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

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

  • name - Module name.
  • ftype - Access type.

Possible values :

    • allow - Allowed for all
    • deny - Denied for all
    • allow_partial - Allowed for
    • deny_partial - Denied for
If the allow_partial value is selected the parameters are allowed to use: 'userlist'
If the deny_partial value is selected the parameters are allowed to use: 'userlist'
  • userlist - The list of users. (One or more values space-delimited)


Favourites

Favourites

Function: usermenu

Result: the list of elements

  • name - The list element unique identifier
  • ntitle - Name .
  • favorite - The menu item is in your Favourites .
  • popular - This menu item is often used .


Add to Favourites

Function: usermenu.enable

Parameters:

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

Result: successful operation or error message


Delete from Favourites

Function: usermenu.disable

Parameters:

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

Result: successful operation or error message


Control panel settings

General settings. View. Change

Function: usrparam

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

View data:

Change the data:

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

  • name - Username.
  • email - E-mail for notifications .
  • email - E-mail for notifications . The parameter may vary depending on feature billmgr.
  • changed - Theme.
  • theme - Theme.
  • lang - Language.
  • timezone - Time zone.
  • passwd - Password.
  • confirm - Re-enter password.
  • atype - Access to the control panel.
    If the atany value is selected the parameters are denied: 'addr'
  • addr - Allowed IP-addresses. (One or more values space-delimited)
  • startpage - Start page.
  • rows - Rows per page.
  • recordlimit - Number of records .
  • buttonview - Toolbar view.
  • ticketsound - . (Optional parameter. To enable the option click "on".)
  • ticketnoconfirm - . (Optional parameter. To enable the option click "on".)
  • useavatar - . (Optional parameter. To enable the option click "on".)
    Active parameter allows the use of the following parameters: 'avatardfield','avatarfield','avatarview'
  • filename - .


Help

Software information

License. View. Change

Function: softinfo

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

View data:

Change the data:

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

  • os - OS version.
  • mgrver - Current version.
  • mgrbuild - Build date.
  • licid - License ID.
  • licip - License IP.
  • licname - License name.
  • licdate - Valid until .


Updates

Updates

Function: updatelist

Result: the list of elements

  • id - The list element unique identifier
  • version - Version.
  • release - Release date.
  • lines - Number of changes.
  • backup - Backup date.


Version changes

Function: updatelist.changelog

Parameters:

  • elid - unique identifier ("id" element of "updatelist" function).

Result: elements list

  • id - The list element unique identifier
  • description - Description.
  • isp1 - ISPmanager Lite.
  • isp2 - ISPmanager Pro.
  • isp3 - ISPmanager Cluster.
  • bill1 - BILLmanager Standard.
  • bill2 - BILLmanager Advanced.
  • bill3 - BILLmanager Corparate.
  • changetype - Type.


Roll back the selected version to . View. Change

Function: updatelist.restore

The function is simultaneously used to view and change object's parameters.

View object's parameters:

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

Change an object:

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

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


Customize update parameters. View. Change

Function: updatelist.settings

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

View data:

Change the data:

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

  • os - Operating system.
  • mgrver - Current version.
  • mgrbuild - Compilation date.
  • vertype - Version type.
  • srvver - Latest version.
  • mirror - Mirror.
  • autoupdate - Automatic update. (Optional parameter. To enable the option click "on".)


Start updating

Function: updatelist.updatenow


Wish list

Wish list

Function: wishlist

Result: the list of elements

  • id - ID .
  • name - Name.
  • created - Date .
  • vote - Votes .
  • jobeval - Labour intensity .
  • prio - Priority .
  • status - Status .


Create. Change. Feature request

Function: wishlist.edit

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 "yes".
    • elid - unique identifier ("id" element of "wishlist" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • name - Name.
  • desc - Description .
  • myvote - Available votes .
  • vote - Add my vote.


Vote

Function: wishlist.vote

  • myvote - Available votes .
  • vote - Add my votes (for each feature) .


Refresh the wish list

Function: wishlist.refresh


Error log

Error log

Function: errorjournal

Result: the list of elements

  • date - Date .
  • funcname - Function .
  • lv_12 - .
  • lv_11 - .
  • lv_10 - .
  • lv_7 - Administrator .
  • lv_6 - Reseller .
  • lv_5 - User .
  • lv_4 - User with shell access .
  • lv_3 - FTP account .
  • lv_2 - Mailbox .
  • user - User .
  • status - Status .


Logging settings . View. Change

Function: errorjournal.settings

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

View data:

Change the data:

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

  • level - Logging level .


Error from . View. Change

Function: errorjournal.edit

The function is simultaneously used to view and change object's parameters.

View object's parameters:

  • Parameters:
    • elid - unique identifier ("date" element of "errorjournal" function)
  • Result: parameters list

Change an object:

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

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

  • email - Email .
  • drop - Delete the report once it is sent . (Optional parameter. To enable the option click "on".)
  • data - .


Delete the selected reports

Function: errorjournal.delete

Parameters:

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

Result: successful operation or error message



  • Use the "featurelist" API function to get the list of active features.
Was this helpful? Yes | No
Personal tools