DCImanager API

From ISPWiki
Jump to: navigation, search

On this page you can see automatically generated description of panel’s functions and their parameters.

For more information on how to work with API and call its functions, please refer to the article Working_with_ISPsystem's_API.

This page is generated automatically, that’s why the information it contains may vary depending on configuration. You can find a certain function or parameter name in the control panel’s configuration file by executing the function in the web-interface.

Function name and its parameters will be shown in the log.== Purchased equipment ==

Function: purchases

Result: report

Purchased equipment

Access level: admin

Contents

Network

Function: new_net

Result: report

Network

Access level: admin user

SSH keys

Function: sshpubkey

Result: the list of elements

SSH keys

Access level: admin user

  • name - Key name

SSH keys

Function: sshpubkey.edit

Access level: admin user

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

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

  • name - Key name. Key name
  • pubkey - Public SSH key. Public SSH key

Delete

Function: sshpubkey.delete

Delete

Access level: admin user

Parameters:

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

Result: successful operation or error message

Server types

Function: servertype

Result: the list of elements

Server types

Access level: admin

  • name - Name
  • servers - Servers
  • freeservers - Servers (available)
  • oscnt - Supported OS
  • hddperf - Hard drive performance
  • ramperf - RAM performance
  • notes - Notes

Name

Function: servertype.oslist

Result: the list of elements

List of OS supported by this type

Access level: admin

  • os - Operating system

Add OS

Function: servertype.oslist.edit

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • os - OS. Select an OS template

Delete

Function: servertype.oslist.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Delete the selected server type

Function: servertype.delete

Delete the selected server type

Access level: admin

Parameters:

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

Result: successful operation or error message

Edit properties of the selected server type

Function: servertype.edit

Access level: admin

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

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

  • name - Name. Enter the name, e.g. E3-1230-8G-2x1000SATA
  • chassis_type - Platform type. Select platform type
  • corecnt - Number of cores. Number of cores on the server including all the processors
  • ram - RAM. The amount of RAM allocated to the server
  • ramperf - RAM performance (oper./sec). Performance of RAM allocated to the server must be larger than the specified value
  • hddcnt - Number of hard drives . The number of hard drives installed on the sever
  • hddsize - Hard drive size (Gb) . The size of each hard drive on the server must be larger than the specified value, but not larger than by 20%
  • hddperf - Hard drive benchmark . Performance of each hard drive on the server must be larger than that value.
  • raid - . (Optional parameter. To enable the option click "on".) Hardware RAID is used on such servers
  • srvsize - Size in the rack . Size of the server of this type (in units)
  • blade_count - Number of blades. Number of blades
  • localspeed - Local connection speed (Mib/s) . To test local speed, a 512 Mb file will be downloaded from the server running DCImanager to the server being tested. Actual speed less or greater by 20% than the value specified in the type, may indicate equipment issues.
  • allow_netflow - Statistics collection . Select how you want to collect statistics for server of this type
  • disable_ipmi_autoadd - . (Optional parameter. To enable the option click "on".) IPMI cannot be added automatically during diagnostics from servers of this type (the check box "Add IPMI automatically must be selected)
  • smart_params - Analyse SMART parameters . Selected parameters of the SMART hard drives will be analyzed
  • notes - Notes. Enter additional information related to this type

Name

Function: servertype.cpulist

Result: the list of elements

List of processors

Access level: admin

  • name - Name

Delete

Function: servertype.cpulist.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Add processor to this type

Function: servertype.cpulist.edit

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • cpu - Name. Select a processor for this server type. New processors will be added into the list when running server diagnostics

Copy the server type

Function: servertype.copy

Access level: admin

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

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

  • name - Name. Enter the name, e.g. E3-1230-8G-2x1000SATA
  • chassis_type - Platform type. Select platform type
  • corecnt - Number of cores. Number of cores on the server including all the processors
  • ram - RAM. The amount of RAM allocated to the server
  • ramperf - RAM performance (oper./sec). Performance of RAM allocated to the server must be larger than the specified value
  • hddcnt - Number of hard drives . The number of hard drives installed on the sever
  • hddsize - Hard drive size (Gb) . The size of each hard drive on the server must be larger than the specified value, but not larger than by 20%
  • hddperf - Hard drive benchmark . Performance of each hard drive on the server must be larger than that value.
  • raid - . (Optional parameter. To enable the option click "on".) Hardware RAID is used on such servers
  • srvsize - Size in the rack . Size of the server of this type (in units)
  • blade_count - Number of blades. Number of blades
  • localspeed - Local connection speed (Mib/s) . To test local speed, a 512 Mb file will be downloaded from the server running DCImanager to the server being tested. Actual speed less or greater by 20% than the value specified in the type, may indicate equipment issues.
  • allow_netflow - Statistics collection . Select how you want to collect statistics for server of this type
  • disable_ipmi_autoadd - . (Optional parameter. To enable the option click "on".) IPMI cannot be added automatically during diagnostics from servers of this type (the check box "Add IPMI automatically must be selected)
  • smart_params - Analyse SMART parameters . Selected parameters of the SMART hard drives will be analyzed
  • notes - Notes. Enter additional information related to this type

Test the OS templates for the selected type

Function: servertype.checktype

Test the OS templates for the selected type

Access level: admin

Parameters:

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

Result: successful operation or error message

HDDs

Function: hddtype

Result: the list of elements

HDDs

Access level: admin

  • id - Id
  • name - Name
  • size - Size (Gb)
  • type - Type

Delete

Function: hddtype.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Name

Function: hddtype.types

Result: the list of elements

Hard disk types

Access level: admin

  • id - Id
  • name - Name
  • perfomance - Read rate, Mb/sec

Delete

Function: hddtype.types.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Hard disk type editing

Function: hddtype.types.edit

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Name. Title of hard disk type
  • smart - SMART parameters. SMART parameters, which are used for by server diagnostics. If empty, then SMART will not be checked
  • perfomance - Read rate, Mb/sec. The lowest read rate. If by diagnostics a server has a less read rate then this value, this server will be marked as a problematic one.

Editing HDD

Function: hddtype.edit

Access level: admin 17

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

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

  • type - Type. HDD interface for data exchange
  • size - Size (Gb). HDD size

Global settings

Function: globalsettings

Access level: admin

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • clearhdd - . (Optional parameter. To enable the option click "on".) All your hard drives will be cleaned up while running diagnostics. Note: diagnostics templates must support this feature
  • fullhddclear - . (Optional parameter. To enable the option click "on".) All your hard drives will be cleaned up while running diagnostics. This process may take several hours depending on your hard drives' size and speed. Note: diagnostics templates must support this feature
  • diagonfreetemplate - Diagnostics template . Select a diagnostics template that will be used when releasing servers
  • allowmixrack - . (Optional parameter. To enable the option click "on".) Server can be connected to a switch or PDU from any rack
  • connections_auto_fix - . (Optional parameter. To enable the option click "on".) DCImanager will try to automatically fix issues with servers' connections. MAC-addresses from switches will be used
  • default_server_ip_type - Standard type of IP addresses . IP addresses of the selected type will be allocated to servers if no IP address is specified in the "IP block" field on the server configuration form
  • DefaulServerIpPool - IP pool . IP addresses will be allocated from this pool by default. You can modify these settings in the server configuration form
  • dcitimezone - Time zone. The selected time zone will be set in OS templates for new servers.
  • dciregion - Region . Region corresponding to this time zone
  • dcilocation - Location . Geographical location

Leave the field blank if you don't want to use a proxy-server

  • recipe - Recipe . Select a recipe that will run after server deployment from OS template. This recipe will be executed even if it was not selected when starting the operation. A recipe is selected from all available recipes if its name and tag match the OS template tags
  • timeout_os_install - OS installation timeout. Time in which OS installation will be stopped if not finished yet, in minutes
  • timeout_serv_diag - Server diagnostics timeout. Time in which server diagnostics will be stopped if not finished yet, in minutes
  • timeout_serv_restore - Server restore timeout. Time in which server restoration will be stopped if not finished yet, in minutes
  • timeout_iso_load - ISO boot timeout. Time in which ISO loading will be stopped if not finished yet, in minutes
  • nameservers - Name servers. Enter IP addresses of name servers that will be set up on the server after OS template. You can use IPv4 or IPv6. Leave the field blank if you do not want to create additional name servers. In this case the name servers that DCImanager uses, will be set up on the target server after OS template.
  • hdd_size_difference - Difference in hard drive size, % . To create a software RAID you will need HDD of the same size. Depending on manufacturer, disk size can differ by several dozens of megabytes. This parameter allows ignoring difference in size and creating the software RAID. Enter the permissible error (in %) in HDD size.
  • dhcp_iface - Interfaces. Add or delete the interface into the configuration file of the DHCP-service. The DHCP-service will be working based on these interfaces
  • allow_snmp_trap - . (Optional parameter. To enable the option click "on".) DCImanager will get notifications (traps) and update equipment statuses based on the information from the trap.
  • trap_daemon_port - Select a port to receive notifications. DCImanager will listen to this port for new notifications
  • enable_iso_upload - . (Optional parameter. To enable the option click "on".) Check the box to allow users to upload custom ISO-images
  • permissive_size - ISO-image size limit per user (Gb) . An ISO-image won't be uploaded if its size exceeds the limit
  • permissive_count - Number of ISO-images per user . When the limit is reached, a user won't be able to upload more images
  • lifetime - ISO-image lifetime for user . Set a period in hours that will pass before a custom image will be deleted
  • allowipmiautoconfig - . (Optional parameter. To enable the option click "on".) If the IPMI is found during the diagnostics, it will be automatically added to the server's connections and configured according to DCImanager settings.
  • IMIPAutoAllocIpType - Pool of IP addresses for IPMI . Pool of IP addresses to allocate Ips for IPMI
  • IMIPAutoAllocIpPool - Pool of IP addresses for IPMI. Provide a pool of IP addresses to allocate Ips for IPMI
  • ipmi_auto_dont_change_admin_pass - . (Optional parameter. To enable the option click "on".) Do not change admin password during diagnostics
  • ipmi_auto_create_user - . (Optional parameter. To enable the option click "on".) Create an operator in IPMI (user with limited permissions) automatically during server diagnostics and grant the server owner access with those credentials
  • autodetectipmiconnection - . (Optional parameter. To enable the option click "on".) If during diagnostics or server search the IPMI MAC address was identified, then server connection with this MAC address will be marked as service connection
  • diagonfree - . (Optional parameter. To enable the option click "on".) Automatically check servers after they become available
  • shutdownafterdiag - . (Optional parameter. To enable the option click "on".) Servers (with owners and free) will be automatically switched off upon check
  • precise_ram_detection - . (Optional parameter. To enable the option click "on".) With this option enabled, during the diagnostics the system will consider the RAM module found even if only it size matches the size that the sever provided during diagnostics. Selecting this check box will compare frequency of every module
  • servers_autoshutdown - . (Optional parameter. To enable the option click "on".) All servers without owners and active services will be deactivated automatically
  • vlanonfree - . (Optional parameter. To enable the option click "on".) When releasing a server, only IP addresses from the VPU-network will be deleted. If the configuration of IPMI address is required, the connection will be switched to the selected VLAN after diagnostics. If it's not required, the server port will be switched to the selected VLAN before performing the diagnostics.
  • vlanid - ID VLAN after release . Specify the VLAN ID for switching the server port before or after the diagnostics


OS installations

Function: operstat

Result: report

OS templates usage statistics

Access level: admin

Units of measure

Function: measure

Result: the list of elements

Measuring equipment

Access level: admin

  • name - Name
  • device - Device type
  • status - Status
  • rack - Rack
  • ip - IP-address
  • notes - Notes

Set filter.

measure.filter

Get the current status of the measuring device. Note: it may take up to some minutes to get the information depending on a measuring device type

Function: measure.refresh

Get the current status of the measuring device. Note: it may take up to some minutes to get the information depending on a measuring device type

Access level: admin

Parameters:

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

Result: successful operation or error message

Delete the measuring device

Function: measure.delete

Delete the measuring device

Access level: admin

Parameters:

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

Result: successful operation or error message

Add a new UPS

Function: measurecreatewiz

Add a new UPS

Access level: admin

Name

Function: measure.sensor

Result: the list of elements

Sensors of the measuring device

Access level: admin

  • name - Name
  • type - Sensor type
  • value - Value
  • target - Connected to

Discount the selected sensors. Information from from the disconnected sensors won't be processed

Function: measure.sensor.disconnect

Discount the selected sensors. Information from from the disconnected sensors won't be processed

Access level: admin

Parameters:

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

Result: successful operation or error message

Connect sensor

Function: measure.sensor.connect

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

Back to the previous list

Function: null

Back to the previous list

Access level: admin

Edit properties of the selected device

Function: measure.edit

Access level: admin

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

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

  • name - Name. Enter the device name that will be used in DCImanager
  • ip - IP-address. Enter the device IP address
  • rack - Rack. Rack where the device is installed
  • unit - Unit number. Unit number in the rack
  • eqsize - Size in rack . Space that this device occupies in the rack (in units)
  • notes - Notes. Enter additional information related to this device
  • snmpversion - Version. Select the SNMP version
  • snmpauthlevel - Security level. SNMPv3 security level
  • snmpuser - User. SNMPv3 user
  • snmppass - Password. Password for SNMPv3 authentication
  • snmppriv - Private key phrase.
  • snmpcommunity - Community. Community for SNMP v1/v2c
  • telnetuser - User. Enter the username to access the device via Telnet
  • telnetpass - Password. Enter the password to access the device via Telnet
  • sshuser - User. Enter the username to access the device via SSH
  • sshpass - Password. Enter the password to access the device via SSH
  • seller - Supplier. Select a supplier
  • newseller - New supplier. Enter the supplier name
  • purchasedate - Purchase date. Enter the purchase date
  • warranty - Warranty (months). Warranty period in months
  • price - Price. Device price
  • sellerserial - Serial number. Enter the serial number

Platforms

Function: chassistempl

Result: the list of elements

Platform types

Access level: admin

  • id - Id
  • name - Name
  • srvsize - Server size
  • blade_count - Platform size
  • cpu_socket - Type of CPU socket
  • cpu_socket_count - CPU sockets
  • ram_count - RAM slots
  • max_ram - Max. RAM (Gb)
  • hdd_count - HDD slots
  • pci_count - PCI slots
  • srv_count - Number of servers

Edit platform type

Function: chassistempl.edit

Access level: admin

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

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

  • name - Name. Internal name of platform type (eg. E3 Blade, 1Unit Server, Multix4DE5 - multi-node). Configuration name for a special column in Servers list section will be generated automatically depending on actual server characteristics (HDD volume and disks amount, RAM, etc.)
  • chassis_type - Type. Select platform type
  • srvsize - Server size . Server size in units
  • blade_count - Number of blades. Number of blades
  • cpu_socket - Type of CPU socket. Select a CPU socket type
  • cpu_socket_count - CPU sockets. Number of CPU sockets in this platform
  • ram_count - RAM slots. Enter the number of RAM slots in this platform
  • max_ram - Max. RAM (Gb) . Maximum RAM that can be added to this platform
  • hdd_count - HDD slots. Number of HDD slots in this platform
  • pci_count - PCI slots. Number of PCI slots in this platform

Delete

Function: chassistempl.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Set filter.

chassistempl.filter

Temperature

Function: new_temperature

Result: report

Temperature

Access level: admin

Operations

Function: operation

Result: the list of elements

Operations

Access level: admin

  • date - Start date
  • type - Operation
  • user - User
  • state - Status

Inventory module settings

Function: operation.cclear

Access level: admin

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

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

Log

Function: operation.log

Access level: admin

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

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

  • log - .

Cancel the selected operations

Function: operation.cancel

Cancel the selected operations

Access level: admin

Parameters:

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

Result: successful operation or error message

User settings

Function: usrparam

Access level: user

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • name - Username. The username that must be used to access the control panel. You can not change the username.
  • theme - Theme. Select the theme that will be used to display the control panel
  • lang - Language. Select a language that will be used in the control panel. ISPsystem company has translated the software products into English and other languages with the help of its partners, and the translation is not guaranteed to be 100% correct. The program may contain texts which are currently under translation. If you found a typo, select it press Ctrl+Enter to correct it
  • old_password - Old password. You need to enter the old password if you want to change the password
  • password - Password. Enter a password to access the control panel. If you you do not want to change the password, leave this field blank
  • confirm - Re-enter password. Re-enter the password to ensure it is correct.
  • atype - Access to control panel. Enter the IP addresses that can be used to access the control panel. Please note: if you make mistakes here, it could be possible that you are not able to log in into the control panel anymore.
  • addr - List of IP addresses. Enter the IP addresses that will be allowed to access the control panel. You can enter a single IP address (123.45.67.89), a mask (123.45.67.0/24) or a range of addresses (123.45.67.89-123.45.67.98).
  • secureip - . (Optional parameter. To enable the option click "on".) A user will be granted with the unique session identifier after registration. By default, it can be used from any IP address. Check the box to allow using the session only from the IP address that was used when the user obtained it
  • startpage - Start page. Select the page that will shown after you logged in into the control panel.
  • rows - Rows per page. Enter he number of rows that will be displayed on a page by default.
  • recordlimit - Number of records. Enter the maximum number of records that are shown in tables. Reducing the number of records will speed up the creation of the tables.
  • buttonview - Toolbar view. Select the way icons will be displayed on the toolbar: icons with text or icons only.
  • hintview - Hints. Active hints are shown when moving a mouse cursor over the input field. Passive hints are displayed only when moving the mouse cursor over the hint sign.
  • checkunsaved - . (Optional parameter. To enable the option click "on".) Check the box to get a warning when you close a page where you have made modifications to the settings of a module that are not saved.
  • email - E-mail for notifications. Enter the email address that will be used for system notifications
  • page_actions - Page.
  • vkontakte_status - . (Optional parameter. To enable the option click "on".) Link this account to your Vkontakte account. To untie it, you need to clear the check box and close the form
  • facebook_status - . (Optional parameter. To enable the option click "on".) Link this account to your Facebook account. To untie it, you need to clear the check box and close the form
  • google_status - . (Optional parameter. To enable the option click "on".) Link this account to your Google account. To untie it, you need to clear the check box and close the form


  • disable_totp - Disable two-factor authentication. To disable two-factor authentication, enter a six-digit code generated by Google Authenticator

Energy consumption

Function: new_energy_consumption

Result: report

Energy consumption

Access level: admin user

Inventory

Function: inventory

Result: the list of elements

Inventory

Access level: admin

  • id - Id
  • name - Name
  • date - Date

Edit inventory

Function: inventory.edit

Access level: admin

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

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

  • name - Name. Name
  • date - Date .

Delete

Function: inventory.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Name

Function: inventory.mismatch.report

Result: the list of elements

Dismatches in inventory

Access level: admin

  • type - Type
  • name - Name
  • serial - Serial number
  • fact_col - Fact
  • dbvalue_col - Base
  • notes - Note

Name

Function: inventory.object

Result: the list of elements

Inventory devices

Access level: admin

  • id - Id
  • type - Type
  • name - Name
  • status - Status

Name

Function: inventory.object.details

Result: the list of elements

Inventory details

Access level: admin

  • id - Id
  • serial - Serial number
  • fact_col - Fact
  • dbvalue_col - Base
  • notes - Note
Inventory details

Function: inventory.object.details.edit

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • notes - Note. Additional information about the object

Inventory

Function: inventory.object.inventorisation

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • serials - Serial numbers. Serial number of spare parts in the warehosue

RAM

Function: ramtype

Result: the list of elements

RAM

Access level: admin

  • id - Id
  • name - Name
  • size - RAM size, MiB
  • frequency - Frequency, MHz
  • notes - Notes

Delete

Function: ramtype.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Edit RAM

Function: ramtype.edit

Access level: admin 17

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

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

  • size - RAM size, MiB. Amount of RAM
  • frequency - Frequency, MHz. RAM frequency
  • notes - Notes . Additional information

Found servers

Function: serversearch

Result: the list of elements

Found servers

Access level: admin

  • name - Name
  • rack - Rack
  • status - Status
  • type - Type
  • mac - MAC-address

Bring the selected servers into operation

Function: serversearch.approve

Bring the selected servers into operation

Access level: admin

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

Delete the selected server

Function: server.delete

Delete the selected server

Access level: admin

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

Delete all the server connections to redefine new ones during the next search

Function: server.delete_all_connections

Delete all the server connections to redefine new ones during the next search

Access level: admin

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 server connection search

Function: startserversearch

Start server connection search

Access level: admin

Name

Function: server.connection

Result: the list of elements

Server devices

Access level: admin

  • type - Type
  • device - Device
  • state - Status

Edit the port corresponding to the selected connection

Function: server.connection.redirect

Edit the port corresponding to the selected connection

Access level: admin

Enable the selected ports

Function: server.connection.on

Enable the selected ports

Access level: admin

Parameters:

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

Result: successful operation or error message

Assign new device

Function: conncreatewiz

Assign new device

Access level: admin

Delete the selected device

Function: server.connection.delete

Delete the selected device

Access level: admin

Parameters:

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

Result: successful operation or error message

Edit properties of the selected device

Function: server.connection.edit

Access level: admin

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 serversearch function).
    • elid - unique identifier (id element of server.connection function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • devtype - Device type. Device type to which the server is connected
  • device - Device. Enter a device to which the server is connected
  • port - Port. Enter a port to which the server is connected
  • ipmi - IPMI version. Enter the protocol that is used for working with IPMI
  • ip - IP address. Enter the IP address
  • ipmiuser - User. Enter a username to access IPMI
  • ipmipass - Password. Enter a password to access IPMI
  • ipmiproxy - . (Optional parameter. To enable the option click "on".) If IPMI IP-address is behind NAT, you can allow proxying via ihttpd using the control panel
  • web_url - Web-interface URL. You will be redirected to this address when clicking the IPMI icon. If the URL is not provided, the IPMI IP address will be used
  • ipmi_connect_method - Connection type . Select how you want a server owner to connect to the IPMI web-interface, when he clicks the corresponding icon in the server list
  • ipmi_connect_method_noihttpd - Connection method . Select how you want a server owner to connect to the IPMI web-interface, when he clicks the corresponding icon in the server list
  • ipmi_type_hp - . (Optional parameter. To enable the option click "on".) With this option, an old browser version will be used for noVNC proxy. It enables support of Java-plug-in which allows to display server console (relevant for IPMI HP iLo)
  • is_ipmi_port - . (Optional parameter. To enable the option click "on".) Enable this checkbox if IPMI is located on this connection
  • ipmi_mac - IPMI MAC address. IPMI MAC address. It can be received during diagnostics or server search
  • intel_amt - Intel AMT version . Protocol that is used to working with Intel AMT
  • wsman_ip - IP address . IP address of the Intel AMT web-interface
  • wsman_user - User. Username to Intel AMT
  • wsman_pass - Password. Password to Intel AMT
  • wsman_port - Port. Enter the port of the Intel AMT web-interface. Leaving the field blank will use port 16992
  • service - . (Optional parameter. To enable the option click "on".) With this check box selected, the device will not perform the following operations: server reboot, power on/off. Traffic statistics won't be collected also.
  • vlan - IPMI Vlan. You can select the Vlan where IPMI is located. Vlan will be configured using ipmitool during server diagnostics.
  • mc_info - Information about IPMI.

Turn off the selected ports

Function: server.connection.off

Turn off the selected ports

Access level: admin

Parameters:

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

Result: successful operation or error message

IPMI username

Function: server.connection.ipmiuser

Result: the list of elements

IPMI users

Access level: admin

  • user_id - Id
  • id - Internal id
  • name - IPMI username
  • status - Status
  • level - Access level
Delete

Function: server.connection.ipmiuser.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Edit properties of the selected user

Function: server.connection.ipmiuser.edit

Access level: admin

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 server.connection function).
    • elid - unique identifier (id element of server.connection.ipmiuser function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • name - IPMI username. Enter the name for the IPMI user
  • level - User level. User role defines permissions for the newly created user
  • user_login - . (Optional parameter. To enable the option click "on".) Server owner will see username and password of the given user when navigating to IPMI icon
  • passwd - . Enter the user password. After changing the user password that IPMI uses to connect to the server in DCImanager, IPMI will stop responding for some time (1-2 minutes)
  • passwd_req - Password. Enter the user password. After changing the user password that IPMI uses to connect to the server in DCImanager, IPMI will stop responding for some time (1-2 minutes)
Updates user list according to IPMI users

Function: server.connection.ipmiuser.sync

Updates user list according to IPMI users

Access level: admin

Correct server connections

Function: serverconnstat

Result: the list of elements

Server connections mismatches

Access level: admin

  • server - Server
  • rack - Rack
  • hostname - Hostname
  • port - Switch port
  • error - Error

Go to the problem server

Function: serverconnstat.gotoserver

Go to the problem server

Access level: admin

Detailed information

Function: serverconnstat.more

Access level: admin

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 (srvconnid element of serverconnstat function)
  • Result: object parameters list

Create an object:

Change an object:

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

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

  • data - Information .

Set filter.

serverconnstat.filter

The server's port will be changed into the foreign one

Function: serverconnstat.correct

The server's port will be changed into the foreign one

Access level: admin

Parameters:

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

Result: successful operation or error message

This port will be added to the server

Function: serverconnstat.addport

This port will be added to the server

Access level: admin

Parameters:

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

Result: successful operation or error message

Locations

Function: location

Result: the list of elements

Locations

Access level: admin

  • id - Id
  • name - Location name
  • address - Address
  • stock - Inventory
  • owner - Owner
  • mainip - IP-address
  • ip_block - Block of IP addresses
  • status - Status
  • comment - Comment

Location edit

Function: location.edit

Access level: admin

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

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

  • name - Location name . Enter the meaningful name of the location
  • address - Address . Location actual address
  • owner - Owner. Select an administrator responsible for the location
  • comment - Comment. Description of a node, note etc.
  • stock - Inventory. Select a warehouse which is used for this location
  • mainip - IP-address. Location IP address. DCImanager will use to SSH connection and configuration (OS templates synchronization, DHCP and TFTP packages installation)
  • ip_block - Type of IP addresses. Type of IP-addresses that will be used for servers in this location
  • ssh_port - SSH port. Number of a port used for SSH service of the location
  • admusr - Superuser. User account with superuser permissions on the location server. DCImanager will manage servers on the locations with these permissions
  • auth_type - Server authorization. Authorization on a remote server can be performed by admin password or SSH key that was authorized on the remote server for superuser access
  • passwd - Superuser password. Location admin password. This password will be used only for locale creation. DCImanager will use it to connect to the server and add its public key to authorized_keys
  • masterkey - Public key. Specified public key of the panel should be put in a list of autorized key for this location
  • nameservers - Name servers . Enter IP addresses of name servers that will be set up on the server after the OS template is installed You can use IPv4 or IPv6. Leave the field blank to apply the name servers of the parent server.

Delete

Function: location.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Virtual networks (VLAN)

Function: vlan

Result: the list of elements

VLAN

Access level: admin

  • id - VLAN
  • name - Name
  • owner - Owner
  • status - Status
  • net - Network
  • notes - Notes

Name

Function: vlan.members

Result: the list of elements

VLAN members

Access level: admin

  • equipment - Device
  • port_identity - Port identifier
  • state - Port status

Disable the selected ports

Function: vlan.members.off

Disable the selected ports

Access level: admin

Parameters:

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

Result: successful operation or error message

Edit the selected port

Function: vlan.members.redirect

Edit the selected port

Access level: admin

Enable the selected ports

Function: vlan.members.on

Enable the selected ports

Access level: admin

Parameters:

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

Result: successful operation or error message

Delete the selected virtual networks

Function: vlan.delete

Delete the selected virtual networks

Access level: admin

Parameters:

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

Result: successful operation or error message

Edit properties of the selected VLAN

Function: vlan.edit

Access level: admin

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

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

  • id - VLAN Id. VLAN identifier
  • name - Name. Enter the name for the virtual network. It is used to configure network equipment
  • owner - Owner. Can use the VLAN on his servers
  • notes - Notes. Enter additional information about the virtual network
  • pvlan - . (Optional parameter. To enable the option click "on".) Check this box if VLAN needs to be set up as a Private VLAN
  • pvlan_type - PVLAN type. Select a type of the virtual network
  • is_service - . (Optional parameter. To enable the option click "on".) This VLAN cannot be created on the routers. Add or delete from the trunk port members

Name

Function: vlan.networks

Result: the list of elements

VLAN networks management

Access level: admin

  • net - Network
  • state - Status

Name

Function: vlan.networks.ipmi

Result: the list of elements

List of IPMI devices

Access level: admin

  • ipmi - IPMI
  • ips - IP address

Delete the network. This operation will also delete the IP addresses of this network assigned to servers

Function: vlan.networks.delete

Delete the network. This operation will also delete the IP addresses of this network assigned to servers

Access level: admin

Parameters:

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

Result: successful operation or error message

Add new network

Function: vlan.networks.edit

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • use_other_type - . (Optional parameter. To enable the option click "on".) Select a type/pool of IP addresses used to dedicate a VPU network
  • type_select - Group of IP addresses. Type/pool of IP addresses used to dedicate a VPU network
  • is_ipmi_net - . (Optional parameter. To enable the option click "on".) If checked, VPU network will be taken from the type/pool of IPMI addresses specified in VPU module settings (field "Type/Pool of IPMI IP addresses")
  • ip_prefix - Network prefix. It specifies the number of addresses that this network will have
  • net - . Enter a network in the format 10.10.10.0/24 that can be used for VPU

Name

Function: vlan.networks.server

Result: the list of elements

Server list

Access level: admin

  • server - Server
  • ips - IP address

PCI devices

Function: pcitype

Result: the list of elements

PCI devices

Access level: admin

  • id - Id
  • name - Name

Delete

Function: pcitype.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Editing PCI device

Function: pcitype.edit

Access level: admin 17

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

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

  • name - Name. Name
  • type - Type. Type of this equipment

OS templates

Function: osmgr

Result: the list of elements

OS templates management

Access level: admin

  • name - Template
  • tags - Tags
  • type - Type
  • state - Status
  • repo - Source
  • date - Date

Edit properties of the OS template

Function: osmgr.edit

Access level: admin

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

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

  • autoupdate - . (Optional parameter. To enable the option click "on".) Activate/disable autoupdate for the selected template. If the autoupdate is on, the system will check the template version once a day and update it, if needed
  • restrict - . (Optional parameter. To enable the option click "on".) If the restriction is on, only administrator can install this template


Update the list of templates

Function: osmgr.fetch

Update the list of templates

Access level: admin

Delete the selected templates

Function: osmgr.delete

Delete the selected templates

Access level: admin

Parameters:

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

Result: successful operation or error message

Repository

Function: osmgr.repo

Result: the list of elements

OS template repository

Access level: admin

  • name - Repository
  • location - Link

Delete repository

Function: osmgr.repo.delete

Delete repository

Access level: admin

Parameters:

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

Result: successful operation or error message

Edit OS templates repository

Function: osmgr.repo.edit

Access level: admin

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 osmgr function).
    • elid - unique identifier (name element of osmgr.repo function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Repository . Repository name
  • location - URL. Link to repository

Install/Update the selected templates

Function: osmgr.install

Install/Update the selected templates

Access level: admin

Parameters:

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

Result: successful operation or error message

Name

Function: osmgr.macros

Result: the list of elements

OS template parameters

Access level: admin

  • name - Name
  • value - Value

Template parameters

Function: osmgr.macros.edit

Access level: admin

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 osmgr function).
    • elid - unique identifier (name element of osmgr.macros function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • value - Value. The value, which is sent to the OS deployment script

Back to the previous list

Function: vm

Back to the previous list

Access level: admin

Set default value

Function: osmgr.macros.delete

Set default value

Access level: admin

Parameters:

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

Result: successful operation or error message

Update the list of templates

Function: osmgr.update

Update the list of templates

Access level: admin

Spares

Function: spare

Result: the list of elements

Spares

Access level: admin 17

  • category - Category
  • type - Type
  • serial - Serial number
  • purchasedate - Purchase date
  • now_in - Location
  • notes - Notes

Edit the selected spares

Function: spare.edit

Access level: admin 17

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

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

  • category - Category. Select a category for this spare
  • type - Type. Select a spare type
  • seller - Supplier. Select a supplier of this spare
  • newseller - New supplier . Enter the supplier name
  • purchasedate - Purchase date. Select the date when this spare was purchased
  • warranty - Warranty (months). Enter the warranty period in months
  • price - Price. Set the price for this spare
  • serial - Serial number. Enter the serial number for this spare
  • is_broken - . (Optional parameter. To enable the option click "on".) The selected spare is defective
  • notes - Notes. Enter additional information related to this spare

Set filter.

spare.filter

Written off spares

Function: spare.spare

Access level: admin 17

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

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

  • reason - Reason. Select a reason for decommission
  • notes - Notes. Additional information about this action

Plug out the spare and put in storage

Function: spare.plugout

Plug out the spare and put in storage

Access level: admin 17

Parameters:

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

Result: successful operation or error message

Add

Function: spareaddwiz

Add

Access level: admin 17

Delete information about the selected spares

Function: spare.delete

Delete information about the selected spares

Access level: admin 17

Parameters:

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

Result: successful operation or error message

Name

Function: spare.history

Result: the list of elements

Spare history

Access level: admin 17

  • date - Date
  • username - User
  • action_type - Action
  • info - Information
  • notes - Notes

Name

Function: spare.broken

Result: report

Defective spares

Access level: admin 17

Category

Function: spare.category

Result: the list of elements

Spare categories

Access level: admin 17

  • name - Category
  • subcount - Types in category

Delete

Function: spare.category.delete

Delete

Access level: admin 17

Parameters:

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

Result: successful operation or error message

Edit the spares category

Function: spare.category.edit

Access level: admin 17

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

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Name. Enter the name for the category
  • code - Category id. Id of the category that will be used when generating the serial number for the spare

Type

Function: spare.category.type

Result: the list of elements

Spares types

Access level: admin 17

  • name - Type
Delete

Function: spare.category.type.delete

Delete

Access level: admin 17

Parameters:

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

Result: successful operation or error message

Edit the spare type

Function: spare.category.type.edit

Access level: admin 17

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 spare.category function).
    • elid - unique identifier (id element of spare.category.type function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Name. Enter the name for the type
  • code - Barcode . Enter a barcode that will be used to define a type of the newly created spare part

Install plug-in

Function: spare.plugin

Access level: admin 17

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

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

  • concretserver - . (Optional parameter. To enable the option click "on".) Type in the server name
  • servername - Server. Enter the name for the server
  • notes - Notes. Additional information about this action

Name

Function: seller

Result: the list of elements

Suppliers

Access level: admin 17

  • name - Name

Delete the selected supplier

Function: seller.delete

Delete the selected supplier

Access level: admin 17

Parameters:

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

Result: successful operation or error message

Edit properties of the selected supplier

Function: seller.edit

Access level: admin 17

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

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Name. Enter the supplier name

Name

Function: spare.avaliable

Result: report

Available spare parts

Access level: admin 17

Users

Function: user

Result: the list of elements

Users

Access level: admin+

  • name - Username
  • level - User role
  • servers - Servers
  • status - Status

Edit properties of the selected user

Function: user.edit

Access level: admin+

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

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

  • name - Username. Enter a login that will be used to access DCImanager
  • level - User role . Select a user role that this user will have in DCImanager
  • passwd - Password. Enter a password to access DCImanager
  • confirm - Re-enter password.
  • custom_vlan_count - Number of VLAN. Number of user VLAN available to this user

Set filter.

user.filter

User permissions

Function: userrights

Result: the list of elements

Privileges

Access level: admin+

  • caption - Name
  • access - User role

Restrict access to list elements

Function: userrights.filter

Restrict access to list elements

Access level: admin+

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Function: userrights.delete

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Access level: admin+

Parameters:

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

Result: successful operation or error message

Name

Function: userrights.fields

Result: the list of elements

List of fields (columns)

Access level: admin+

  • caption - Name
  • access - User role
Resume

Function: userrights.fields.resume

Resume

Access level: admin+

Parameters:

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

Result: successful operation or error message

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Function: userrights.fields.delete

Default settings. Access permissions set for the selected user/group including permissions on columns and rows (if it is a list or form) will be deleted

Access level: admin+

Parameters:

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

Result: successful operation or error message

Suspend

Function: userrights.fields.suspend

Suspend

Access level: admin+

Parameters:

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

Result: successful operation or error message

Field privileges

Function: userrights.fields.edit

Access level: admin+

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 userrights function).
    • elid - unique identifier (name element of userrights.fields function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • inhereted - . (Optional parameter. To enable the option click "on".) Do not set field permissions. They will be taken from groups to which this user is assigned
  • read - . (Optional parameter. To enable the option click "on".) Allow reading the field
  • write - . (Optional parameter. To enable the option click "on".) Allow editing the field
  • new - . (Optional parameter. To enable the option click "on".) Allow editing the form while creating an object

Access to functions

Function: userrights.edit

Access level: admin+

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 user function).
    • elid - unique identifier (name element of userrights function)
  • Result: object parameters list

Create an object:

Parameters:

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

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

  • inhereted - . (Optional parameter. To enable the option click "on".) Do not set permissions. The will be based on other billing policies
  • access - User role . Set access permissions to this function
  • inherit - . (Optional parameter. To enable the option click "on".) Apply the access permissions to all of the group functions

Policy

Function: userrights.policy

Access level: admin+

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 user function).
    • elid - unique identifier (name element of userrights function)
  • Result: object parameters list

Create an object:

Parameters:

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

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

  • policy - Default policy settings. Set the user access permissions to the functions. Changing this value will reset the current access permissions. If the user is assigned into any group, the group settings will have higher priority

Resume

Function: userrights.resume

Resume

Access level: admin+

Parameters:

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

Result: successful operation or error message

Suspend

Function: userrights.suspend

Suspend

Access level: admin+

Parameters:

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

Result: successful operation or error message

Suspend the user account

Function: user.disable

Suspend the user account

Access level: admin+

Parameters:

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

Result: successful operation or error message

Delete the selected user

Function: user.delete

Delete the selected user

Access level: admin+

Parameters:

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

Result: successful operation or error message

Resume the selected user

Function: user.enable

Resume the selected user

Access level: admin+

Parameters:

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

Result: successful operation or error message

Drill down to User panel

Function: user.su

Drill down to User panel

Access level: admin+

DC map

Function: dcmap


Data center map

Access level: admin 17

Edit

Function: dcmap.editmap

Edit

Access level: admin

Edit the selected objects

Function: dcmap.edit

Edit the selected objects

Access level: 17+

Add a rack to the map

Function: dcmap.addrack

Access level: admin

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • rack - Rack. Select a rack

Add rack into the map

Function: dcmap.placeups

Access level: admin

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • ups - UPS. Select a UPS that you want to locate
  • width - Width. Enter the device width in mm
  • depth - Depth. Enter device depth in mm

Wall parameters

Function: dcmap.wall.edit

Access level: admin

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

View data:

  • Result: <a href="api#param">parameters list</a>

Change the data:

  • Parameters:
    • sok - the parameter must not be empty, generally "ok".
    • additional query parameters ...
  • Result: <a href="api#ok">successful operation</a> or <a href="api#error">error message</a>

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

  • length - Length (mm). Enter the wall length in mm
  • width - Width (mm). Enter the wall width in mm
  • delete - . (Optional parameter. To enable the option click "on".) Select the check box to delete the wall

Routers

Function: router

Result: the list of elements

Routers

Access level: admin

  • name - Name
  • device - Device type
  • rack - Rack
  • ip - IP-address
  • notes - Notes

Add a new router

Function: routercreatewiz

Add a new router

Access level: admin

Interface

Function: router.iface

Result: the list of elements

Device interfaces

Access level: admin

  • name - Interface
  • net - Network address

Edit properties of the selected router

Function: router.edit

Access level: admin

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

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

  • name - Name. Enter the device name that will be used in DCImanager
  • ip - IP-address. Enter the device IP address
  • rack - Rack. Select a rack where this device is installed
  • unit - Unit number. Unit number in the rack
  • eqsize - Size in rack . Space that this device occupies in the rack (in units)
  • notes - Notes. Enter additional information related to this device
  • snmpversion - Version. Select the SNMP version
  • snmpauthlevel - Security level. SNMPv3 security level
  • snmpuser - User. SNMPv3 user
  • snmppass - Password. Password for SNMPv3 authentication
  • snmppriv - Private key phrase.
  • snmpcommunity - Community. Community for SNMP v1/v2c
  • telnetuser - User. Enter the username to access the device via Telnet
  • telnetpass - Password. Enter the password to access the device via Telnet
  • sshuser - User. Enter the username to access the device via SSH
  • sshpass - Password. Enter the password to access the device via SSH
  • seller - Supplier. Select a supplier
  • newseller - New supplier. Enter the supplier name
  • purchasedate - Purchase date. Enter the purchase date
  • warranty - Warranty (months). Warranty period in months
  • price - Price. Device price
  • sellerserial - Serial number. Enter the serial number

Get network addresses. Please note: this process may take a long time (up to several minutes) depending on equipment that you use

Function: router.refresh

Get network addresses. Please note: this process may take a long time (up to several minutes) depending on equipment that you use

Access level: admin

Parameters:

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

Result: successful operation or error message

Delete the selected router

Function: router.delete

Delete the selected router

Access level: admin

Parameters:

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

Result: successful operation or error message

Recipes

Function: recipemgr

Result: the list of elements

Recipes management

Access level: admin user

  • name - Recipe
  • revision - Revision
  • state - Status
  • tags - Tags
  • repo - Repository
  • date - Date
  • filename - File

Start the update process

Function: recipemgr.update

Start the update process

Access level: admin user

Delete the selected recipes

Function: recipemgr.delete

Delete the selected recipes

Access level: admin user

Parameters:

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

Result: successful operation or error message

Edit recipe

Function: recipemgr.edit

Access level: admin user

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

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

  • filename - File name . File name where the recipe is kept
  • encoding - Encoding. Recipe character encoding. Changing encoding will REMOVE the changes made in the editor!
  • fdata - .
  • savetime - Saved in. In this field you can see the file save time. Server time is specified here

Repository

Function: recipemgr.repo

Result: the list of elements

Recipe repositories

Access level: admin user

  • name - Repository
  • location - Link

Delete repository

Function: recipemgr.repo.delete

Delete repository

Access level: admin user

Parameters:

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

Result: successful operation or error message

Edit recipe repository

Function: recipemgr.repo.edit

Access level: admin user

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 recipemgr function).
    • elid - unique identifier (name element of recipemgr.repo function)
  • Result: object parameters list

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Repository . Repository name
  • location - Link . Link to recipe archive

Recipe properties

Function: recipemgr.props

Access level: admin user

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

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

  • access - Who can use this recipe. Recipe access can be denied both for users ('available for administrators') and for all accounts including administrators ('unavailable')

Broken servers

Function: writeoff_server

Result: the list of elements

Written off and broken servers

Access level: admin 17

  • id - Id
  • name - Label
  • gen_chassis_name - Configuration
  • status - Status
  • price - Price
  • purchasedate - Purchase date
  • writeoffdate - Date
  • notes - Notes

Set filter.

writeoff_server.filter

View the history

Function: server.history

View the history

Access level: admin

PDU

Function: pdu

Result: the list of elements

Power Distribution Units (PDU)

Access level: admin

  • name - Name
  • device - Device type
  • status - Status
  • rack - Rack
  • ip - IP-address
  • power - Load (W)
  • portcnt - Number of ports
  • notes - Notes

Name

Function: pdu.port

Result: the list of elements

PDU ports

Access level: admin

  • identity - Identifier
  • servername - Server name
  • serverhname - Hostname
  • descr - Description
  • state - Status
  • power - Load (W)
  • notes - Notes

Switch off the selected ports

Function: pdu.port.off

Switch off the selected ports

Access level: admin

Parameters:

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

Result: successful operation or error message

Get the current status of the device ports

Function: pdu.port.refresh

Get the current status of the device ports

Access level: admin

Enable the selected ports

Function: pdu.port.on

Enable the selected ports

Access level: admin

Parameters:

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

Result: successful operation or error message

Edit properties of the selected PDU port

Function: pdu.port.edit

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • identity - Identifier . Port identifier (this information is collected from the device automatically)
  • descr - Description . Port description (this information is collected from the device automatically)
  • service - . (Optional parameter. To enable the option click "on".) This port is reserved for special needs. It is not displayed on the list of ports and is not used when searching for new servers
  • notes - Notes. Enter additional information related to the port

Register a new PDU

Function: pducreatewiz

Register a new PDU

Access level: admin

Set filter.

pdu.filter

=== Delete the selected PDU

===

Function: pdu.delete

Delete the selected PDU


Access level: admin

Parameters:

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

Result: successful operation or error message

Edit properties of the selected PDU

Function: pdu.edit

Access level: admin

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

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

  • name - Name. Enter the device name that will be used in DCImanager
  • ip - IP-address. Enter the device IP address
  • rack - Rack. Select a rack where the device is installed
  • unit - Unit number. Unit number in the rack
  • eqsize - Size in rack . Space that this device occupies in the rack (in units)
  • notes - Notes. Enter additional information related to this device
  • snmpversion - Version. Select an SNMP version
  • snmpauthlevel - Security level. SNMPv3 security level
  • snmpuser - User. SNMPv3 user
  • snmppass - Password. Password for SNMPv3 authentication
  • snmppriv - Private key phrase.
  • snmpcommunity - Community. Community for SNMP v1/v2c
  • telnetuser - User. Enter the username to access the device via Telnet
  • telnetpass - Password. Enter the password to access the device via Telnet
  • sshuser - User. Enter the username to access the device via SSH
  • sshpass - Password. Enter the password to access the device via SSH
  • seller - Supplier. Select a supplier
  • newseller - New supplier . Enter the supplier name
  • purchasedate - Purchase date. Enter the purchase date
  • warranty - Warranty (months). Warranty period in months
  • price - Price. Device price
  • sellerserial - Serial number. Enter the serial number

Get the current status of the selected pdu and its ports

Function: pdu.refresh

Get the current status of the selected pdu and its ports

Access level: admin

Parameters:

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

Result: successful operation or error message

Racks

Function: rack

Result: the list of elements

Racks management

Access level: admin

  • name - Name
  • racksize - Rack size
  • inetport - Switch ports
  • powerport - Power port
  • can_install_servers - Places for servers
  • power - Power consumption (W)
  • traff - Network load
  • temperature - Temperature
  • status - Status
  • notes - Notes
  • location - Location

Edit rack

Function: rack.edit

Access level: admin

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 "ok".
    • elid - unique identifier (id 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. Enter the name or id of the rack
  • location - Location. Data center in which the rack is located
  • notes - Notes. Enter any additional information related to the rack
  • srvsearch - . (Optional parameter. To enable the option click "on".) Selecting this check box will enable DCImanager to use equipment installed in this rack for server search. During this process DCImanager will enable available ports one after another on the PDU without marking them as "Services", and run server connection check. These operations will define PDU ports that servers are connected to.
  • height - Height (unit). Enter the rack height in mm

Delete

Function: rack.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Servers

Function: server

Result: the list of elements

Servers

Access level: admin user 17

  • id - Id
  • name - Label
  • rack - Rack
  • gen_chassis_name - Configuration
  • type - Server type
  • chassis_templ - Platform type
  • hostname - Hostname
  • owner - Owner
  • mac - MAC-address
  • status - Status
  • ip - IP-address
  • ipcount - Number of IP addresses
  • power - Power consumption (Watt)
  • traff - Channel load
  • os - OS
  • temperature - Temperature
  • notes - Notes

Deny access to the selected server. Switch port will be disabled

Function: server.disable

Deny access to the selected server. Switch port will be disabled

Access level: admin

Parameters:

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

Result: successful operation or error message

Cancel the current operation

Function: server.opercancel

Cancel the current operation

Access level: admin user

Parameters:

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

Result: successful operation or error message

Reboot the selected server

Function: server.reboot

Reboot the selected server

Access level: admin user

Parameters:

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

Result: successful operation or error message

You will be redirected to the "Operations with equipment" module

Function: writeoff

You will be redirected to the "Operations with equipment" module

Access level: admin

Server operations

Function: server.operations

Access level: admin user

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

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

  • operation - Operation type. Select an operation with the server
  • ostemplate - Install OS from template . Select an operating system you want to install on the server
  • isotemplate - Upload from ISO-image . Select an ISO-image for upload
  • diag - Run diagnostics . Select a diagnostics template you want to run on the server
  • ipaddr - IP address. Will be used for booting
  • rescue - Upload the recovery template. Select a recovery template that you want to run on the server


  • hostname - Hostname . Enter a hostname for the server
  • passwd - Password. Set a password of the server administrator
  • confirm - Re-enter password.
  • recipe - Recipe . Execute the selected recipe (script) after OS installation
  • clearhdd - . (Optional parameter. To enable the option click "on".) All your hard drives will be cleaned up while running diagnostics. Note: diagnostics templates must support this feature
  • fullhddclear - . (Optional parameter. To enable the option click "on".) All your hard drives will be cleaned up. This process may take several hours depending on your hard drive speed and size. The operation will zero out the entire disk opposed to a common clear procedure with only the first 512 bytes zeroed.
  • hddraid - Configure software RAID. Select a software RAID that will be configured during OS deployment. Disks that are not used for creating RAID, can be used for other purposes (for example, you can use them to store backup copies). A list of available RAIDs depend on OS templates and number of similar disks installed successively on the server.
  • notify_me - . (Optional parameter. To enable the option click "on".) Select the check box if you want to be informed when the operation is completed or the server becomes accessible via SSH

Drill down to User panel

Function: server.su

Drill down to User panel

Access level: admin user 17

Set filter.

server.filter

Power off the selected server

Function: server.poweroff

Power off the selected server

Access level: admin user

Parameters:

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

Result: successful operation or error message

Name

Function: iplist

Result: the list of elements

List of IP addresses

Access level: admin user 17

  • ip - IP address

Move IP address

Function: server.moveip

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

Edit properties of the selected server

Function: server.edit

Access level: admin 17 user

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

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

  • spare_id - Server from warehouse . In this list you can select a server from the warehouse, so the equipment from delivery will be associated with the newly created server
  • id - Id. Enter the server identifier
  • name - Label. Enter a unique name for this server
  • owner - Owner. The owner of this server. To select a user, start typing his name
  • forcelock - . (Optional parameter. To enable the option click "on".) With this check box selected, all users including the administrator won't be able to perform operations over this server
  • allow_netflow - Statistics collection . Select how you want to collect traffic usage statistics
  • ip_block - IP pool/type . Enter an IP pool/type that will be used for this server
  • notes - Notes. Enter additional information related to the server
  • user_notes - Notes. Enter additional information about the server
  • hwproblem - . (Optional parameter. To enable the option click "on".) Select the check box to indicate that this server is faulty and cannot be used.
  • hwproblem_info - Detailed information about issues . Here you can see the information about the issues that were found during the diagnostics procedure
  • type_templ_select - . (Optional parameter. To enable the option click "on".) With this option selected, data for old server types will be used for locating the server in the rack
  • chassistempl - Platform type. Common server, blade, or platform for blade servers. It defines how much CPU, HDD and PCI can be added to server
  • type - Server type. Choose a server type. Server types are used in DCImanager Essential to group servers (for example, by tariff plans). DCImanager Progressive and Enterprise keep information about hardware of servers of this type, and enable to determine problems with those servers
  • gen_chassis_name - Name. A platform name for the selected server will be automatically generated based on CPU, HDD, PCI and other fields
  • enable_vpu_net - . (Optional parameter. To enable the option click "on".) IP address for this server will be selected from the VPU network
  • vpu_net - VPU network. Select the VPU network for IP allocation
  • family - IP address. Select a desired IP address
  • ipsource - Allocate IP addresses from. Select a source of IP address
  • network - Network name. Enter the name of the NAT network to allocate an IP address
  • main_ip - "Primary" IP address. IP address that will be assigned during OS installation
  • specialip - IP address. Enter the IP address
  • netmask - Network mask. Enter the network mask
  • gateway - Gateway IP address. Gateway default IP
  • add_ipaliases - . (Optional parameter. To enable the option click "on".) Add alias IP addresses
  • ipaliases - Alias IP addresses in the format 192.168.0.1/24 192.168.0.254. Alias IP addresses in the format ip/mask gateway. Enter each IP address шт a new line
  • amount_ipv4 - Number of IPv4. Enter a required number of IPv4
  • ipv4_pool - Ipv4 pool. Obtain Ipv4 addresses from the selected pool
  • amount_ipv6 - Number of IPv6. Enter a required number of IPv6
  • ipv6_pool - Ipv6 pool. Obtain Ipv6 addresses from the selected pool
  • hostname - Hostname . Server domain name
  • mac - MAC-address. Enter a MAC-address of the server network adapter. It is used for installing OS on the server
  • os - Operating system . Operating system installed on the server
  • rack - Rack. Enter the rack where the server is installed
  • parent - Platform . Select the platform where the server is installed
  • parent_chassis - Parent chassis. It allows to define the platform, where this blade server is located (depend on chosen rack)
  • blade_slot - Blade-slot . The slot where the chassis are located
  • sizefromtype2 - . (Optional parameter. To enable the option click "on".) Obtain information about server size from the platform type
  • srvsize2 - Size . Server size in the rack (in units)
  • srvtypesize2 - Size . Server size in the rack (in units), according to its type
  • unit2 - Unit number . Enter the rack unit number. For multi-unit equipment enter the upper position.
  • cpuname - CPU. Type of CPU installed on the server
  • cpucnt - CPU number. Enter the number of CPU installed on the server
  • motherboard - Motherboard . Enter a motherboard installed on the server
  • pl_model_name - Platform model . Enter the platform model of the selected server
  • corecnt - Number of cores. The total number of cores installed on the server
  • ram - RAM. The amount of RAM (MiB)
  • localspeed - Local connection speed (Mib/s) . Measured connection speed
  • hddinfo - Hard drives. Information about the hard drives installed on the server
  • dmi_proc - Processors.
  • dmi_mem - RAM.
  • smartinfo - SMART. SMART from the server's hard drives
  • raid - . (Optional parameter. To enable the option click "on".) Hardware RAID is installed on this server
  • laninfo - Network adapters . Information about network adapters installed on the server
  • hwerror - Additional information about errors with equipment. This field contains additional information about issues with equipment that were detected during server diagnostics.
  • idelivery - Delivery . Delivery associated with this server
  • seller - Supplier. Select a supplier of this server
  • newseller - New supplier . Enter a supplier name
  • purchasedate - Purchase date. Select the date when the server was purchased
  • warranty - Warranty (months). Enter the warranty period in months
  • price - Price. Set the price for the server
  • sellerserial - Serial number. Enter the server's serial number
  • barcode - Barcode . Barcode

Download IPMI console (for jnlp files only)

Function: ipmi_console_download

Download IPMI console (for jnlp files only)

Access level: admin user

Enable the selected server

Function: server.poweron

Enable the selected server

Access level: admin user

Parameters:

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

Result: successful operation or error message

Name

Function: server.switchconnection

Result: the list of elements

Network connections

Access level: user

  • id - Id
  • descr - Port name
  • vlan -
  • state - State - province
  • usernote - Notes

Edit

Function: server.switchconnection.edit

Edit

Access level: user

Allow access to the selected server. Switch port and power supply will be enabled

Function: server.enable

Allow access to the selected server. Switch port and power supply will be enabled

Access level: admin

Parameters:

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

Result: successful operation or error message

Switches

Function: switch

Result: the list of elements

Switch management

Access level: admin

  • id - Id
  • name - Name
  • hostname - Hostname
  • device - Device type
  • status - Status
  • rack - Rack
  • ip - IP-address
  • portcnt - Number of ports
  • notes - Notes

Get the current status of the selected switch and its ports

Function: switch.refresh

Get the current status of the selected switch and its ports

Access level: admin

Parameters:

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

Result: successful operation or error message

Edit properties of the selected switch

Function: switch.edit

Access level: admin

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

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

  • name - Name. Enter the device name that will be used in DCImanager
  • ip - IP-address. Enter the device IP address
  • rack - Rack. Select a rack where the device is installed
  • unit - Unit number. Unit number in the rack
  • eqsize - Size in rack . Space that this device occupies in the rack (in units)
  • applyrack - . (Optional parameter. To enable the option click "on".) Change the rack for all the servers connected to this device
  • no_auto_uplink - . (Optional parameter. To enable the option click "on".) Disable auto-detection of UpLink, if DCImanager detects port connection type incorrectly
  • show_aggregate - . (Optional parameter. To enable the option click "on".) Display the aggregated channels if you want to manage them in DCImanager
  • conf_autosave - Save configuration automatically . Save the switch configuration automatically if switch ports configuration has been changed
  • is_service - . (Optional parameter. To enable the option click "on".) DCImanager won't handle this switch
  • couple_switch - Double switch . Select a switch that will be the pair for the selected one. When you create VLAN on one switch, it will be created automatically on the other
  • log_path - Log file. Full path to the file with switch log
  • notes - Notes. Enter additional information related to this device
  • stat_poll_type - Statistics. Select how DCImanager will collect statistics, e.g. through netconf or SNMP
  • status_poll_type - Status. Select how DCImanager will update the information on equipment statuses in the interface
  • snmpversion - Version. Select an SNMP version
  • snmpauthlevel - Security level. SNMPv3 security level
  • snmpuser - User. SNMPv3 user
  • snmppass - Password. Password for SNMPv3 authentication
  • snmppriv - Private key phrase.
  • snmpcommunity - Community. Community for SNMP v1/v2c
  • telnetuser - User. Enter the username to access the device via Telnet
  • telnetpass - Password. Enter the password to access the device via Telnet
  • sshuser - User. Enter the username to access the device via SSH
  • sshpass - Password. Enter the password to access the device via SSH
  • seller - Supplier. Select a supplier
  • newseller - New supplier . Enter the supplier name
  • purchasedate - Purchase date. Enter the purchase date
  • warranty - Warranty (months). Warranty period in months
  • price - Price. Device price
  • sellerserial - Serial number. Enter the serial number

Delete the selected switch

Function: switch.delete

Delete the selected switch

Access level: admin

Parameters:

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

Result: successful operation or error message

Register a new switch

Function: switchcreatewiz

Register a new switch

Access level: admin

Set filter.

switch.filter

Switch log

Function: switch.log

Access level: admin

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

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

  • data - .

Name

Function: switch.port

Result: the list of elements

Switch ports

Access level: admin

  • identity - Identifier
  • servername - Equipment name
  • serverhname - Hostname
  • descr - Description
  • vlan - VLAN
  • speed - Port speed
  • duplex - Mode
  • state - Status
  • bitsec - Load
  • packsec - Load (packet/sec)
  • notes - Notes

Edit properties of the the selected switch port

Function: switch.port.edit

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • identity - Identifier . Port identifier (this information is collected from the device automatically)
  • descr - Description . Port description (this information is collected from the device automatically)
  • speed - Port speed. Select the port speed
  • duplex - Mode. Select the port mode
  • istrunk - . (Optional parameter. To enable the option click "on".) This port is running in Trunk mode
  • mapped_vlan - Mapped PVLAN. Secondary PVLAN to which editable port mapping is done. Thus the editable port is a Promiscuous Port for this Secondary PVLAN.
  • vlan - VLAN. VLAN that is installed on the port
  • native_vlan - Native VLAN. VLAN that won't be tagged on this port
  • trunkmembers - Trunk members. VLANs that are included into Trunk
  • uplink - . (Optional parameter. To enable the option click "on".) Select the check box if this port is connected to a switch/router of a higher level, rather than to a server. This port won't display in the list of ports when connecting a new device. Server search won't be performed on this port. Any other operations cannot be performed on this port (change VLAN, speed, or mode)
  • service - . (Optional parameter. To enable the option click "on".) This port is reserved for special needs. It is not displayed on the list of ports and is not used when searching for new servers
  • maclist - List of MAC-addresses. List of active MAC-addresses on the switch port
  • notes - Notes. Enter additional information
  • switch - Switch. Switch to connect to
  • port - Port. Switch port used for connection

Set filter.

switch.port.filter

Removal of aggregation

Function: switch.port.removeagregate

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Name. Name of aggregation to be removed

Enable the selected ports

Function: switch.port.on

Enable the selected ports

Access level: admin

Parameters:

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

Result: successful operation or error message

Get the current status of the device ports

Function: switch.port.refresh

Get the current status of the device ports

Access level: admin

Turn off the selected ports

Function: switch.port.off

Turn off the selected ports

Access level: admin

Parameters:

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

Result: successful operation or error message

Creation of aggregation

Function: switch.port.createagregate

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Name. Name of aggregation to be created
  • port - Ports. Ports to be added to the aggregation being created
  • type - Type. Type of aggregation to be created

Save the configuration file on the switch to non-volatile memory. If this option is not supported by switch or changes are saved into memory directly, not actions will be performed

Function: switch.save

Save the configuration file on the switch to non-volatile memory. If this option is not supported by switch or changes are saved into memory directly, not actions will be performed

Access level: admin

Parameters:

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

Result: successful operation or error message

ISO-images

Function: iso

Result: the list of elements

ISO-images

Access level: admin user

  • id - Id
  • name - Image name
  • time_delete - Deletion time
  • size - Size
  • owner - Owner
  • status_col - Status

Delete

Function: iso.delete

Delete

Access level: admin user

Parameters:

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

Result: successful operation or error message

Upload ISO-image

Function: iso.upload

Access level: admin user

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

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

  • type - File type . Select an ISO-image for upload: from a local machine, or using a URL to file on a remote server
  • url_filename - File name . Enter the name for the ISO-image. Leaving the field blank will take a file name from the URL
  • shared - . (Optional parameter. To enable the option click "on".) This ISO-image will be available to all users
  • hours_to_delete - Period in hours. Set a period in hours that will pass before the template will be deleted automatically. When you enter a value into this field, deletion time will be automatically recalculated
  • description - Description. Provide any description of this image. Users will see this text in the list of ISO-images

Edit the selected ISO-image

Function: iso.edit

Access level: 17 admin+

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

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

  • name - ISO-image name . Enter a name for the image
  • shared - . (Optional parameter. To enable the option click "on".) This ISO-image will be available to all users
  • auto_delete - . (Optional parameter. To enable the option click "on".) Create a new cron job for automatic deletion of this ISO-image
  • hours_to_delete - Period in hours. Set a period in hours that will pass before the template will be deleted automatically. When you enter a value into this field, deletion time will be automatically recalculated
  • description - Description. Provide any description of this image. Users will see this text in the list of ISO-images

Processors

Function: cputype

Result: the list of elements

Processors

Access level: admin

  • id - Id
  • name - Name
  • alias_name - Alias name
  • cpu_socket - Type of CPU socket
  • scale - Scalability
  • notes - Note

Name

Function: cputype.socket

Result: the list of elements

CPU sockets

Access level: admin

  • id - Id
  • name - Name
  • notes - Notes

Editing CPU socket

Function: cputype.socket.edit

Access level: admin

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

Create an object:

Parameters:

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

Change an object:

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

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

  • name - Name. Socket name
  • notes - Notes . Additional information

Delete

Function: cputype.socket.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Delete

Function: cputype.delete

Delete

Access level: admin

Parameters:

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

Result: successful operation or error message

Editing processor

Function: cputype.edit

Access level: admin 17

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

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

  • name - Name. Name
  • alias_name - Alias name. Short name, which is used during platform name generation. If DCImanager creates processor during diagnostics, the alias will be generated automatically
  • cpu_socket - Type of CPU socket. Socket of the CPU installed in the platform
  • scale - Scalability . CPU modes in systems with several sockets
  • notes - Notes. Additional information

Set filter.

cputype.filter

UPS

Function: ups

Result: the list of elements

UPS management

Access level: admin

  • name - Name
  • device - Device type
  • status - Status
  • rack - Rack
  • ip - IP-address
  • battary_time_remains - Battery time remaining (min)
  • load - Load (%)
  • power - Output power (kW)
  • in_power - Power consumption (kW)
  • notes - Notes

Add a new Uninterrupted Power Supply

Function: upscreatewiz

Add a new Uninterrupted Power Supply

Access level: admin

Edit properties of the selected UPS

Function: ups.edit

Access level: admin

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

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

  • name - Name. Enter the device name that will be used in DCImanager
  • ip - IP-address. Enter the device IP address
  • rack - Rack. Select a rack where this device is installed
  • unit - Unit number. Unit number in the rack
  • eqsize - Size in rack . Space that this device occupies in the rack (in units)
  • notes - Notes. Enter additional information related to this device
  • snmpversion - Version. Select the SNMP version
  • snmpauthlevel - Security level. SNMPv3 security level
  • snmpuser - User. SNMPv3 user
  • snmppass - Password. Password for SNMPv3 authentication
  • snmppriv - Private key phrase.
  • snmpcommunity - Community. Community for SNMP v1/v2c
  • telnetuser - User. Enter the username to access the device via Telnet
  • telnetpass - Password. Enter the password to access the device via Telnet
  • sshuser - User. Enter the username to access the device via SSH
  • sshpass - Password. Enter the password to access the device via SSH
  • seller - Supplier. Select a supplier
  • newseller - New supplier . Enter the supplier name
  • purchasedate - Purchase date. Enter the purchase date
  • warranty - Warranty (months). Warranty period in months
  • price - Price. Device price
  • sellerserial - Serial number. Enter the serial number

Set filter.

ups.filter

Learn the current status of the UPS

Function: ups.refresh

Learn the current status of the UPS

Access level: admin

Parameters:

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

Result: successful operation or error message

Delete the selected UPS

Function: ups.delete

Delete the selected UPS

Access level: admin

Parameters:

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

Result: successful operation or error message