From ISPWiki

Contents 1 DS administrator 1.1 Main Features 1.1.1 Server management 1.1.2 NAC servers 1.1.3 Administrator management 1.1.4 User management 1.1.5 Reseller management 1.1.6 Equipment management 1.1.7 Rack 1.2 Server Statistics 1.2.1 Active sessions 1.2.2 Action log 1.2.3 Traffic 1.2.4 Power consumption 1.3 Other Settings 1.3.1 Operating system images 1.3.2 Recovery template 1.3.3 Local networks 1.3.4 Server types 1.3.5 IP-addresses 1.3.6 Integration with IPmanager 1.3.7 Excluded MAC addresses 1.3.8 Device templates 1.3.9 Temporary IP-addresses 1.3.10 Access to modules 1.3.11 Favourites 1.3.12 General settings 1.4 Help 1.4.1 License 1.4.2 Updates 1.4.3 Wish list 1.4.4 Error log

See also

DS administrator

Main Features

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.
• ip - IP-addresses.
• iplimit - Alias IP-addresses. Attributes :
  • used - The used number.
  • limit - Max value limitation
• hostname - Server name.
• os - Operating system .
• info - Configuration .

Function: ds.addexcludemac

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

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

Function: ds.servsearch

Function: ds.order

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

View data:

• Result: parameters list

Change the data:

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

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

• type - Type.
• hostname - Server name .
• owner - Owner.

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:

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

Create an object:

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

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.
• ip - IP-address.
• iplimit - IP-addresses limit .
• hostname - Host name.
• os - OS version.
• note - Notes.

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

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

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

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

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

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.

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'

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

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

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 .

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'

• 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'

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

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

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

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

Function: ds.su

NAC servers

Function: nac

Result: the list of elements

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

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:

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

Create an object:

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

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

Function: admin

Result: the list of elements

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

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:

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

Create an object:

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

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 .

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

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

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

Function: user

Result: the list of elements

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

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:

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

Create an object:

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

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 .

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

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

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

Function: user.su

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 .

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:

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

Create an object:

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

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.

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

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

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

Function: reseller.su

Equipment management

Function: device

Result: the list of elements

• type - Type.
• api - Manufacturer.
• name - Name.
• ip - IP-address.
• rack - Rack.
• ds - Servers.

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

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:

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

Create an object:

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

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.
• api - Manufacturer .
• name - Name.
• ip - IP-address.
• user - User .
• password - Password/Community.
• rack - Rack .
• telnet_user - User .
• telnet_password - Password .

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

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 - Port is enabled.
• status_off - Port is disabled.
• status_err - Unknown status .

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 .

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

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

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

Function: rack

Result: the list of elements

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

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:

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

Create an object:

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

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

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.

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

Function: session.su

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.

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

Function: statds

Result: the list of elements

• id - Id.
• name - Name.
• ip - IP-address.
• in - Incoming.
• out - Outgoing.
• burst - Bandwidth.

Function: statparam

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

View data:

• Result: parameters list

Change the data:

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

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

Function: statds.detail

Parameters:

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

Result: elements list

• dat - Date.
• ip - IP-address.
• in - Incoming.
• out - Outgoing.

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

Function: powerstat

Result: the list of elements

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

Function: pstatparam

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

View data:

• Result: parameters list

Change the data:

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

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

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

Function: powerstat.details

Parameters:

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

Result: elements list

• dat - Date .
• power - per hour.

Function: pstatparam

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

Other Settings

Operating system images

Function: os

Result: the list of elements

• name - Name.
• type - Recovery template .
• status - Status.
• version - Version.

Function: os.install

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

View data:

• Result: parameters list

Change the data:

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

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

• netosname - Template .
• name - Operating system .

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

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

Function: netos

Result: the list of elements

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

Function: netos.install

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

View data:

• Result: parameters list

Change the data:

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

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

• netosname - Name.

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

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

Function: network

Result: the list of elements

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

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:

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

Create an object:

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

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.

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

Function: type

Result: the list of elements

• name - Name.

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:

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

Create an object:

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

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.

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

Function: iplist

Result: the list of elements

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

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:

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

Create an object:

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

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'

• members - Resellers . (One or more values space-delimited)

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

Function: ipmgr

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

View data:

• Result: parameters list

Change the data:

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

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

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

Excluded MAC addresses

Function: excludemac

Result: the list of elements

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

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:

• Parameters:
  • elid - unique identifier ("mac" element of "excludemac" function)
• Result: object parameters list

Create an object:

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

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

Function: template

Result: the list of elements

• Name - Name.
• Author - Author .
• Type - Type.
• Num - Version .
• Date - Last updated .
• OnServer_on - .
• OnServer_off - .
• status_on - .
• status_off - .
• on_off_on - .
• on_off_off - .
• mac_table_on - .
• mac_table_off - .
• arp_table_on - .
• arp_table_off - .
• statistics_on - .
• statistics_off - .
• speed_on - .
• speed_off - .

Function: template.install

Parameters:

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

Result: successful operation or error message

Function: template.delete

Parameters:

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

Result: successful operation or error message

Temporary IP-addresses

Function: privateip

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.

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

• userlist - The list of users. (One or more values space-delimited)

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 .

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

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

Function: usrparam

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

View data:

• Result: parameters list

Change the data:

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

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.

Help

License

Function: softinfo

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

View data:

• Result: parameters list

Change the data:

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

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

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.

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.

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

Function: updatelist.settings

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

View data:

• Result: parameters list

Change the data:

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

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

Function: updatelist.updatenow

Wish list

Function: wishlist

Result: the list of elements

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

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:

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

Create an object:

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

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.

Function: wishlist.vote

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

Function: wishlist.refresh

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 .

Function: errorjournal.settings

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

View data:

• Result: parameters list

Change the data:

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

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

• level - Logging level .

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

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.