DSmanager API/DS administrator

From ISPWiki

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

Contents

See also


DS administrator

Main Features

Server management

Dedicated server management

Function: ds

Result: the list of elements

  • id - Id.
  • mac - MAC.
  • type - Type.
  • location - Location .
  • rack - Rack.
  • owner - Owner.
  • poweron - Power switch port is active - .
  • poweroff - Power switch port is disabled - .
  • powererr - Power switch port status error - .
  • ineton - Network switch port is active - .
  • inetoff - Network switch port is disabled - .
  • ineterr - Network switch port status error - .
  • kvm - KVM - .
  • disabled - Server is disabled by administrator.
  • ipmi - IPMI - .
  • note - .
  • install - Installation in progress:.
  • prerecovery - Preparing for recovery with from the template .
  • recovery_error - Error. Unable to boot this server in the recovery mode.
  • recovery - Recovery in progress....
  • install_second - Trying to boot for the second time.
  • install_disk - No hard disk detected.
  • install_template - OS template not found.
  • hardware_error - Non-conformances identified when verifying the hardware.
  • ip - IP-addresses.
  • iplimit - Alias IP-addresses. Attributes :
    • used - The used number.
    • limit - Max value limitation
  • hostname - Server name.
  • os - Operating system .
  • info - Configuration .


Order a new server. View. Change

Function: ds.order

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 - Type.
  • hostname - Server name .
  • owner - Owner.


Create. Change. Server settings

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

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

  • id - Id.
  • mac - MAC. (One or more values space-delimited)
  • owner - Owner.
  • type - Type.
  • rack - Rack.
  • info - Configuration . (One or more values space-delimited)
  • location - Number in the rack.
  • stat - Statistics collection.
  • ip - IP-address.
  • iplimit - IP-addresses limit .
  • hostname - Host name.
  • os - OS version.
  • note - Notes.
  • hddinfo - Hard drives: .


Delete the selected servers

Function: ds.delete

Parameters:

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

Result: successful operation or error message


System recovery . View. Change

Function: ds.recovery

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

View object's parameters:

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

Change an object:

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

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

  • recovery - Recover the system. (Optional parameter. To enable the option click "on".)
    Active parameter allows the use of the following parameters: 'os','passwd','confirm','keys'
  • os - Operating system.
  • passwd - Password.
  • confirm - Re-type password .
  • keys - Set up keys. (Optional parameter. To enable the option click "on".)


'

Function: ds.diag

Parameters:

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

Result: successful operation or error message


Reinstall server. View. Change

Function: ds.reinstall

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

View object's parameters:

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

Change an object:

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

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

  • hostname - Host name.
  • os - Operating system.
  • passwd - Password.
  • confirm - Re-type password .
  • disk - Partitions table.
  • keys - Install keys. (Optional parameter. To enable the option click "on".)


Reboot the selected servers

Function: ds.reboot

Parameters:

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

Result: successful operation or error message


Allow access to the selected server

Function: ds.enable

Parameters:

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

Result: successful operation or error message


Disconnect the selected servers

Function: ds.disable

Parameters:

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

Result: successful operation or error message


Assigned IP-addresses

Function: ds.ip

Parameters:

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

Result: elements list

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


Create. Change. IP-address

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

Create an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "yes".
    • plid - parent list unique identifier ("id" element of "ds" 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 ("id" element of "ds" function).
    • elid - unique identifier ("ip" element of "ds.ip" function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • type - IP-address type.
    If the alias value is selected the parameters are allowed to use: 'ip','name' and the parameters are denied: 'ips'
If the group value is selected the parameters are allowed to use: 'ips' and the parameters are denied: 'ip','name'
  • ip - IP-address.
  • name - Domain name.
  • ips - IP address group.


Delete the selected IP-address

Function: ds.ip.delete

Parameters:

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

Result: successful operation or error message


Server connections list

Function: ds.conn

Parameters:

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

Result: elements list

  • type - Type .
  • id - Device .
  • ip - IP-address.
  • info - Information .
  • main - Main connection. It will be used to enable/disable servers and restrict access .
  • stat - This connection will be used to collect traffic statistics .
  • status_on - Active connection .
  • status_off - Disabled connection .
  • status_err - Unknown connection status .


Create. Change. Edit the selected connection properties

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

Create an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "yes".
    • plid - parent list unique identifier ("id" element of "ds" 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 ("id" element of "ds" function).
    • elid - unique identifier ("id" element of "ds.conn" function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • type - Device type.
    If the Ipmi value is selected the parameters are allowed to use: 'ipmitype','ip','user','password' and the parameters are denied: 'device','port','info','speed','private','manual','devport'
If the Switch value is selected the parameters are allowed to use: 'device','devport','manual','speed','private' and the parameters are denied: 'info','port','ipmitype','ip','user','password'
  • ipmitype - IPMI device type .
  • device - Device .
  • manual - Type the port manually . (Optional parameter. To enable the option click "on".)
    Active parameter allows the use of the following parameters: 'port','info'
Active parameter denies the following parameters: 'devport'
  • devport - Port.
  • port - Port.
  • speed - Port speed.
  • ip - IP-address.
  • user - User .
  • password - Password .
  • info - Notes .
  • main - Basic . (Optional parameter. To enable the option click "on".)
  • private - Private . (Optional parameter. To enable the option click "on".)


Delete the connection information

Function: ds.conn.delete

Parameters:

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

Result: successful operation or error message


Enable the selected ports

Function: ds.conn.enable

Parameters:

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

Result: successful operation or error message


Disable the selected ports

Function: ds.conn.disable

Parameters:

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

Result: successful operation or error message


Switch to User panel

Function: ds.su


NAC servers

NAC servers

Function: nac

Result: the list of elements

  • id - Id.
  • type - Type.
  • owner - Owner.
  • name - Name.
  • ip - IP-address.


Create. Change. NAC server

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

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

  • id - Id.
  • owner - Owner.
  • type - Type.
  • info - Information. (One or more values space-delimited)
  • ip - IP-address.
  • name - Name.
  • reboot - URL for server reboot .
  • stat - Statistics URL.


'

Function: nac.delete

Parameters:

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

Result: successful operation or error message


'

Function: nac.reboot

Parameters:

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

Result: successful operation or error message


Administrator management

Administrator management

Function: admin

Result: the list of elements

  • name - Username.
  • disabled - The account is disabled .


Create. Change. Administrator

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

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

  • name - Login.
  • passwd - Password.
  • confirm - Re-type password .


Delete the selected administrator

Function: admin.delete

Parameters:

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

Result: successful operation or error message


Enable the selected administrator

Function: admin.enable

Parameters:

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

Result: successful operation or error message


Disable the selected administrator

Function: admin.disable

Parameters:

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

Result: successful operation or error message


User management

User management

Function: user

Result: the list of elements

  • name - Username.
  • reseller - Reseller.
  • ds - Servers.
  • disabled - The account is disabled .


Create. Change. User

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 - Login.
  • passwd - Password.
  • confirm - Re-type password .


Delete the selected accounts

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

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 account

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


Reseller management

Reseller management

Function: reseller

Result: the list of elements

  • name - Reseller name.
  • iplimit - IP-addresses. Attributes :
    • used - The used number.
    • limit - Max value limitation
  • dslimit - Servers. Attributes :
    • used - The used number.
    • limit - Max value limitation
  • users - Users.
  • disabled - The account is disabled .


Create. Change. Reseller

Function: reseller.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 "reseller" 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 - Re-type password .
  • iplimit - IP-addresses limit.


Delete the selected accounts

Function: reseller.delete

Parameters:

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

Result: successful operation or error message


Dedicated servers limit

Function: reseller.limit

Parameters:

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

Result: elements list

  • type - Server type.
  • limit - Number. Attributes :
    • used - The used number.
    • limit - Max value limitation


Dedicated server limit . View. Change

Function: reseller.limit.edit

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

View objects parameters:

  • Parameters:
    • plid - parent list unique identifier ("name" element of "reseller" function).
    • elid - unique identifier ("type" element of "reseller.limit" function)
  • Result: parameters list

Change an object:

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

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

  • limit - Dedicated server limit .


'

Function: reseller.enable

Parameters:

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

Result: successful operation or error message


'

Function: reseller.disable

Parameters:

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

Result: successful operation or error message


Switch to Reseller panel

Function: reseller.su


Equipment management

Equipment

Function: device

Result: the list of elements

  • type - Type.
  • api - Template .
  • name - Name.
  • online - A connection was successfully established with this device .
  • unknown - No connection with this device .
  • offline - Connection failed.
  • error_on_last_exec - One or several errors occurred while executing the last operation. .
  • lasterror - .
  • working - Operation in progress... .
  • ip - IP-address.
  • rack - Rack.
  • ds - Servers.


Get information from the selected devices (collect information about ports)

Function: device.getinfo

Parameters:

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

Result: successful operation or error message


Create. Change. Add device

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

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

  • type - Type.
    If the Switch value is selected the parameters are allowed to use: 'collectstat'
  • api - Template .
  • name - Name.
  • ip - IP-address.
  • user - User .
  • password - Password/Community.
  • rack - Rack .
  • collectstat - Collect statistics from the selected equipment . (Optional parameter. To enable the option click "on".)
  • telnet_user - User .
  • telnet_password - Password .


Delete the selected device

Function: device.delete

Parameters:

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

Result: successful operation or error message


Ports usage

Function: device.connection

Parameters:

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

Result: elements list

  • port - Port.
  • id - Server ID.
  • ip - IP-address.
  • hostname - Server name.
  • info - Description.
  • status_on - This port is enabled.
  • status_off - This port is disabled.
  • oper_on - Enabled .
  • oper_off - Disabled .
  • status_err - Unknown status .


Create. Change. Port information

Function: device.connection.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 ("name" element of "device" function).
    • elid - unique identifier ("port" element of "device.connection" function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "yes".
    • plid - parent list unique identifier ("name" element of "device" 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 ("name" element of "device" function).
    • elid - unique identifier ("port" element of "device.connection" function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • port - Port number .
  • info - Information .


Delete the selected ports

Function: device.connection.delete

Parameters:

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

Result: successful operation or error message


Connect to the network

Function: device.connection.enable

Parameters:

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

Result: successful operation or error message


Disconnect from the network

Function: device.connection.disable

Parameters:

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

Result: successful operation or error message


Rack

Racks

Function: rack

Result: the list of elements

  • name - Name .
  • descr - Description .
  • servercnt - Number of servers .


Create. Change.

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

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

  • name - Name .
  • descr - Description .


'

Function: rack.delete

Parameters:

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

Result: successful operation or error message


'

Function: rack.details


Server Statistics

ATTENTION: your statistical information must be converted

. View. Change

Function: tconv

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

  • warning - Please note: the way how traffic usage statistics is collected and kept has been greatly modified in the current version of DSmanager. That's why your existing data should be reprocessed. This operation may take from several minutes to 2-3 hours depending on the bb.log. file size. .
  • warning2 - If you used NetFlow to collect traffic statistics, you may configure it in "Settings" -> "Global settings" -> Collect statistics using NetFlow/IPFIX.
  • noimport - Do not import old data (see the hint!) . (Optional parameter. To enable the option click "on".)


Active sessions

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.


Traffic

Traffic usage

Function: statds

Result: the list of elements

  • id - Id.
  • name - Name.
  • ip - IP-address.
  • in - Incoming.
  • out - Outgoing.
  • burstin - Bandwidth usage (incoming) .
  • burstout - Bandwidth usage (outgoing) .


Report period . View. Change

Function: statparam

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 .
  • unit - Unit of measure .
  • group - Group by date. (Optional parameter. To enable the option click "on".)


Traffic statistics

Function: statds.detail

Parameters:

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

Result: elements list

  • dat - Date.
  • in - Incoming.
  • out - Outgoing.


Report period

Function: statparam

  • from - Start date .
  • to - End date .
  • unit - Unit of measure .
  • group - Group by date. (Optional parameter. To enable the option click "on".)


Traffic usage (IP-addresses)

Function: statds.ipdetail

Parameters:

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

Result: elements list

  • dat - The list element unique identifier
  • ip - IP address .
  • in - Incoming .
  • out - Outgoing .


Report period

Function: statparam

  • from - Start date .
  • to - End date .
  • unit - Unit of measure .
  • group - Group by date. (Optional parameter. To enable the option click "on".)


Power consumption

Power consumption

Function: powerstat

Result: the list of elements

  • id - ID.
  • name - Name.
  • ip - IP address.
  • power - Watt-hour.


Report period. View. Change

Function: pstatparam

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.


Power consumption

Function: powerstat.details

Parameters:

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

Result: elements list

  • dat - Date .
  • power - per hour.


Report period

Function: pstatparam

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


Traffic (new)

Traffic usage

Function: tstat


Tools

Server search

Server search

Function: serversearch

Result: the list of elements

  • id - ID.
  • mac - MAC.
  • type - Type .
  • rack - Rack.
  • poweron - The power switch port is enabled - .
  • poweroff - The power switch port is disabled - .
  • powererr - Problem identifying the status of the power switch .
  • ineton - The network switch port is enabled - .
  • inetoff - The network switch port is disabled - .
  • ineterr - Error in defining the status of the network switch port .
  • kvm - .
  • disabled - .
  • ipmi - IPMI - .
  • note - .
  • install - Installation:.
  • prerecovery - Prepare to recover using the template .
  • recovery_error - Error. Unable to boot the server in the recovery mode.
  • recovery - The recovery using template is enabled .
  • hardware_error - Non-conformances identified when verifying the hardware.
  • install_second - The second boot attempt .
  • install_disk - Hard drives not found on the server .
  • install_template - OS template not found.
  • ip - IP address .
  • hostname - Server name .
  • info - Configuration .


Search for new servers connected to the supported equipment

Function: serversearch.startsearch


Exclude MAC-address

Function: serversearch.addexcludemac

Parameters:

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

Result: successful operation or error message

  • descr - Description .
  • addexcludemac - Delete server . (Optional parameter. To enable the option click "on".)


Delete the selected servers

Function: serversearch.delete

Parameters:

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

Result: successful operation or error message


Start using the selected servers

Function: serversearch.approve

Parameters:

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

Result: successful operation or error message


Other Settings

Operating system images

Operating systems

Function: os

Result: the list of elements

  • name - Name.
  • type - Recovery template .
  • status - Status.
  • version - Version.
  • isaccessible - This OS can be installed by users .
  • notaccessible - This OS can be installed ONLY BY ADMINISTRATORS!.


Allows/Forbid users to install the selected OS

Function: os.hideshow


Add an operating system. View. Change

Function: os.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):

  • netosname - Template .
  • name - Operating system .


Update the selected operating system image

Function: os.update

Parameters:

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

Result: successful operation or error message


Delete the selected operating systems

Function: os.delete

Parameters:

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

Result: successful operation or error message


Recovery template

Recovery template

Function: netos

Result: the list of elements

  • name - Name.
  • status - Status.
  • version - Version.


Installing a new recovery template. View. Change

Function: netos.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):

  • netosname - Name.


Update the selected templates on your server

Function: netos.update

Parameters:

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

Result: successful operation or error message


Delete the selected recovery templates

Function: netos.delete

Parameters:

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

Result: successful operation or error message


Local networks

Local networks

Function: network

Result: the list of elements

  • group - Group.
  • ip - Network IP-address.
  • mask - Network mask.
  • gateway - Gateway.
  • nextserver - NFS server.


Create. Change. Edit the network properties

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

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

  • group - Group .
    If the new value is selected the parameters are allowed to use: 'groupname'
  • groupname - Group name .
  • ip - Network IP-address.
  • mask - Network mask.
  • gateway - Gateway.
  • nextserver - NFS server.


Delete the selected network from dhcp settings

Function: network.delete

Parameters:

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

Result: successful operation or error message


Server types

Dedicated server types

Function: type

Result: the list of elements

  • name - Name.


Shared OS. View. Change

Function: type.commonos

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


List supported OS

Function: type.proclist

Parameters:

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

Result: elements list

  • cpuname - CPU.
  • corecnt - Number of kernels .


Create. Change.

Function: type.proclist.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 ("name" element of "type" function).
    • elid - unique identifier ("cpuname" element of "type.proclist" function)
  • Result: object parameters list

Create an object:

  • Parameters:
    • sok - the parameter must not be empty, generally "yes".
    • plid - parent list unique identifier ("name" element of "type" 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 ("name" element of "type" function).
    • elid - unique identifier ("cpuname" element of "type.proclist" function)
    • additional query parameters ...
  • Result: successfull operation or error message

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

  • cpuname - CPU name .
  • corecnt - Number of kernels.


'

Function: type.proclist.delete

Parameters:

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

Result: successful operation or error message


Supported OS

Function: type.supportedos

Parameters:

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

Result: elements list

  • os - Operating system .
  • status - Status .
  • time - OS installation time (hours:minutes).


Check supported OS for the selected type of servers

Function: type.testos

Parameters:

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

Result: successful operation or error message


Create. Change. Properties

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

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

  • name - Name.
  • cpucnt - CPU number:.
  • ram - RAM: .
  • hddsize - Hard drives size:.
  • hddcnt - Number of hard drives: .
  • raid - Hard drives are in RAID:.
  • cpuperfmin - CPU productivity (min-max) .
  • cpuperfmax - CPU productivity (min-max) .
  • ramperfmin - RAM productivity (min-max) .
  • ramperfmax - RAM productivity (min-max) .
  • hddperfmin - Hard drives productivity (min-max) .
  • hddperfmax - Hard drives productivity (min-max) .
  • lanperfmin - Network adapters productivity (min-max) .
  • lanperfmax - Network adapters productivity (min-max) .


Delete the selected types

Function: type.delete

Parameters:

  • elid - one or more object's unique identifiers comma-delimited with space ", ". The unique identifiers is the "name" element of "type" 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


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 .


Excluded MAC addresses

Excluded MAC addresses

Function: excludemac

Result: the list of elements

  • mac - MAC-address.
  • descr - Description .


Create. Change.

Function: excludemac.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 ("mac" element of "excludemac" function)
    • additional query parameters ...
  • Result: successful operation or error message

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

  • mac - MAC.
  • descr - Description .


'

Function: excludemac.delete

Parameters:

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

Result: successful operation or error message


Device templates

Equipment templates

Function: template

Result: the list of elements

  • Name - Name.
  • Author - Author .
  • Type - Type.
  • Description - Description .
  • status_on - Can be used to find out the port status .
  • on_off_on - Can be used to enable/disable the ports .
  • speed_on - Can be used to manage port speed .
  • mac_table_on - Can be used to search for new servers on the device ports .
  • statistics_on - Enables to collect information on traffic/power consumption .


Services

Services

Function: service

Result: the list of elements

  • name - Service name .
  • info - Last response .
  • srv_on - .
  • srv_off - .
  • srv_err - .


'

Function: service.start

Parameters:

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

Result: successful operation or error message


'

Function: service.stop

Parameters:

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

Result: successful operation or error message


'

Function: service.restart

Parameters:

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

Result: successful operation or error message


Temporary IP-addresses

'

Function: privateip


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


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


Global settings

Global settings. View. Change

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

  • tstatperiod - Switch ping time (in min) .
  • pstatperiod - Power switch ping time (in min) .
  • flowperiod - Period (in min) to process traffic statistics from NetFlow/IPFIX.
  • statpolicy - Traffic statistics collection policy .
  • statistic - Collect statistics using NetFlow/IPFIX. (Optional parameter. To enable the option click "on".)
  • nfpath - Path to nfacctd.
  • nfport - Port.
  • statpath - Save statistics into:.
  • tftproot - TFTP root directory .
  • nfstimeout - Server reboot time (sec) .


Help

License

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