VDSmanager API/VDS Owner

From ISPWiki

Jump to: navigation, search

Contents

See also


VDS Owner

Main

System information

System information

Function: vds.sysinfo

Result: the list of elements

  • name - Parameter.
  • value - Value.


IP-addresses

Reverse DNS

Function: vdsip

Result: the list of elements

  • ip - IP-address.
  • name - Domain name.


IP-address . View. Change

Function: vdsip.edit

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

View object's parameters:

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

Change an object:

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

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

  • ip - IP-address.
  • name - Domain name.


Running processes

List of processes

Function: vdsproc

Result: the list of elements

  • pid - PID.
  • uid - UID.
  • cpu - CPU %.
  • mem - Memory (kb).
  • time - Uptime .
  • cmd - Command.


Terminate the selected processes

Function: vdsproc.delete

Parameters:

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

Result: successful operation or error message


Private files

VPS private files

Function: vdsfiles

Result: the list of elements

  • name - Name.
  • size - Size.
  • time - Modified.
  • state - Status.


Delete the selected VPS private files

Function: vdsfiles.delete

Parameters:

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

Result: successful operation or error message


Upload a file. View. Change

Function: vdsfiles.upload

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

  • type - File type.
    If the link value is selected the parameters are allowed to use: 'url','name' and the parameters are denied: 'file'
If the data value is selected the parameters are allowed to use: 'file' and the parameters are denied: 'url','name'
  • url - URL.
  • name - File name.
  • filename - Local file.


Pre-installed software

Pre-installed software

Function: vdspkg

Result: the list of elements

  • name - Name.
  • state - Status.


Restore the package from the pre-installed disk template

Function: vdspkg.delete

Parameters:

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

Result: successful operation or error message


Backups

VPS backup copies

Function: vdsbackup

Result: the list of elements

  • name - Name.
  • restoring - .


Restore

Function: vdsbackup.restore

Parameters:

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

Result: successful operation or error message


Make an archive and give a link to download

Function: vdsbackup.mkdownload

Parameters:

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

Result: successful operation or error message


Tools

Rebooting VPS

Reboot VPS. View. Change

Function: reboot

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


Reinstalling VPS

Reinstall VPS . View. Change

Function: reinstall

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

  • disktempl - Disk template.


Connect ISO

Connecting the virtual CD . View. Change

Function: vds.attachcd

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

  • iso - List of the ISO images .


Boot priority

Connecting the virtual CD . View. Change

Function: vds.bootprio

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

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


Switch to ISPmanager

'

Function: vdsispmgr


Statistics

Resource allocation problems

Resource allocation problems

Function: statrejects

Result: the list of elements

  • name - Date.
  • rejp - Processes .
  • rejf - File descriptors .
  • rejm - Memory .
  • rejs - Swap .


System usage report

VPS usage report

Function: statusage

Result: the list of elements

  • name - Date.
  • cpuu - CPU, %.
  • memu - Memory,  %.
  • procu - Processes, %.
  • fileu - File descriptors, %.
  • io_block - Disk operations.


VPS current usage

VPS current usage

Function: currentusage

Result: the list of elements

  • name - Date/Time.
  • cpuu - CPU %.
  • memu - Memory %.
  • procu - Processes %.
  • fileu - File descriptors %.


Current resource allocation problems

Current allocation problems

Function: currentreject

Result: the list of elements

  • name - Date/time .
  • memr - Memory .
  • procr - Processes .
  • filer - File descriptors .



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