From ISPWiki

Contents 1 Administrator 1.1 Main Features 1.1.1 User management 1.1.2 Network management 1.2 Server Statistics 1.2.1 IP-address usage 1.2.2 IP-address allocation 1.2.3 Active sessions 1.2.4 Action log 1.3 Other Settings 1.3.1 IPmanager parameters 1.3.2 Plug-ins 1.3.3 Access to modules 1.3.4 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

• IPmanager API/User

Administrator

Main Features

User management

Function: user

Result: the list of elements

• name - User name.
• owner - Owner.
• level - Login level.

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.
• level - Access level.
• passwd - Password.
• confirm - Confirm 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.perm

Parameters:

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

Result: elements list

• key - The list element unique identifier
• type - Pool type .
• range - IP-address pool .

Function: user.perm.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 "user" function).
  • elid - unique identifier ("key" element of "user.perm" 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 "user" 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 "user" function).
  • elid - unique identifier ("key" element of "user.perm" function)
  • additional query parameters ...
• Result: successfull operation or error message

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

• type - IP-address pool type.
• range - IP-address pool .

Function: user.perm.delete

Parameters:

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

Result: successful operation or error message

Function: user.su

Network management

Function: net

Result: the list of elements

• name - Network.
• file - File.
• used - IP-addresses usage. Attributes :
  • used - The used number.
  • limit - Max value limitation

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

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

• family - Network type .
  If the ip4 value is selected the parameters are allowed to use: 'mask' and the parameters are denied: 'prefix'

• name - Network.
• gateway - Gateway address.
• mask - Network mask.
• prefix - Prefix length .
• file - File.
• genfile - . (Optional parameter. To enable the option click "on".)
  Active parameter allows the use of the following parameters: 'email','ns'

• email - Administrator e-mail .
• ns - Name servers.

Function: net.delete

Parameters:

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

Result: successful operation or error message

Function: net.addr

Parameters:

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

Result: elements list

• ip - IP-address.
• name - Domain name.
• owner - Owner.
• type - Type.
• note - Notes .

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

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

• ip - IP-address.
• name - Domain name.
• type - Type .
• owner - Owner .
• note - Notes .

Function: net.addr.delete

Parameters:

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

Result: successful operation or error message

Server Statistics

IP-address usage

Function: ipusagestat

Result: the list of elements

• name - User.
• primary - Primary.
• alias - Alias.
• ds - DS.
• dns - DNS.
• total - Total.

IP-address allocation

Function: ipblockstat

Result: the list of elements

• range - Pool .
• who - Assigned to.
• usage - Usage. Attributes :
  • used - The used number.
  • limit - Max value limitation

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.

Other Settings

IPmanager parameters

Function: param

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

• freename - Unassigned domain name.
• viewname - DNS name space.
• pingip - Check IP address availability using ping . (Optional parameter. To enable the option click "on".)

Plug-ins

Function: plugin

Result: the list of elements

• name - Plug-in name .
• desc - Brief description .
• version - Version .
• bad - The plug-in failed due to errors in its description. .
• newver - .

Function: plugin.collection

Result: the list of elements

• name - Plug-in name .
• desc - Description .
• version - Version .
• author - Author .

Function: plugin.install

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

View object's parameters:

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

Change an object:

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

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

• agree - I was warned about consequences of my actions . (Optional parameter. To enable the option click "on".)

Function: plugin.info

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

View object's parameters:

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

Change an object:

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

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

• description - Detailed description .
• interpretator - Programming language .
• require - Required modules .
• author - Author .
• contact - Contact information .

Function: plugin.info

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

View object's parameters:

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

Change an object:

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

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

• description - Detailed description .
• interpretator - Programming language .
• require - Required modules .
• author - Author .
• contact - Contact information .

Function: plugin.update

Function: plugin.delete

Parameters:

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

Result: successful operation or error message

Function: plugin.source

Result: the list of elements

• url - Source URL .

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

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

• url - Source URL .

Function: plugin.source.delete

Parameters:

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

Result: successful operation or error message

Function: plugin.source.refresh

Parameters:

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

Result: successful operation or error message

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)

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 - Confirm.
• 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 - Lines 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 - .
• created - Creation 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.