Examples of API use

domain.com — DCImanager 6 server public IP address or domain name;

function — function to be executed in DCImanager 6.

configuration — server configuration;

free_server_count — number of free servers with this configuration.

operation — operation running on server:

• id — operation ID;
• status — operation status;
• progress_info — progress info;

domain — server domain name;

id — server ID;

os_template — server operating system (OS) template info:

• id — template ID;
• name — template name;
• tags —

hardware_info — server hardware info;

configuration — server configuration;

state — server state. Possible values:

• suspending — server is entering suspended mode;
• suspended — server is suspended;
• suspend_error — server suspend error;
• resuming — server activity is resuming;
• ok — server available for operation;
• resume_error — server resume error;

state_info — server status info;

ip — server IP addresses info:

• domain — domain name;
• family — IP version. Possible values: ipv4, ipv6;
• gateway — gateway IP address;
• id — IP address ID;
• name — server IP address;
• network — network address;
• status — IP address status. Possible values:
• • allocating — IP address allocation task has been created;
  • in_progress — IP address change task has been created;
  • deleting — IP address deletion task has been created;
  • ok — IP address was allocated successfully;
  • fail — task completion failed;
  • allocation_fail — IP address allocation failed;
• status_info — IP address status info;

switch_connection — info on server connection switch ports:

• id — port ID;
• switch — switch ID;
• connection_id — connection ID;
• description — port description;
• admin_status — status of switch port managed by admin. Possible values:
  
• • up — port is active;
  • down — port is inactive;
  • testing — port is in test status;
  • unknown — port status unknown.
• oper_status — switch port connection status. Possible values:
• • up — connection is active;
  • down — connection is inactive;
  • testing — port is in test status;
  • unknown — connection status unknown;

  pdu_connection — PDU server connection port info:

  • port_id — port ID;
  • port_identity — PDU port ID;
  • pdu_id — PDU ID;
  • pdu_name — PDU name;
  • connection_id — connection ID;
  • power_status — port status. Possible values:
  • • up — port is active;
    • down — port is inactive;
    • unknown — port status unknown;

    ipmi — IPMI info:

    • address — IPMI IP address;
    • id — IPMI ID;
    • status — IPMI status. Possible values:
    • • on — active;
      • off — inactive;
      • unknown — unknown;
      • in_progress — in progress;
    • status_type — IPMI status type;
    • type — IPMI type. Possible values:
    • • IPMI v1.5/v2;
      • IPMI v2(lanplus);
    • web_url — IPMI web interface URL;

    location — location info:

    • geolocation — location position;
    • id — location ID;
    • name — location name;
    • userspace — location userspace ID in IPmanager;

    location_id — location ID;

    mac — server's MAC address;

    main_ipv4 — server's main IPv4 address. Used to install OS;

    platform — server platform info:

    • id — platform ID;
    • name — platform name;
    • size — platform size;
    • type — platform type;

    rack — server rack info:

    • id — rack ID;
    • name — rack name;
    • size — rack size;

    unit — unit number in rack.

operation — operation running on server:

• id — operation ID;
• status — operation status;
• progress_info — progress info;

domain — server domain name;

id — server ID;

os_template — server operating system (OS) template info:

• id — template ID;
• name — template name;

hardware_info — server hardware info;

configuration — server configuration;

state — server state. Possible values:

• suspending — server is entering suspended mode;
• suspended — server is suspended;
• suspend_error — server suspend error;
• resuming — server activity is resuming;
• ok — server available for operation;
• resume_error — server resume error;

state_info — server status info;

ip — server IP addresses info:

• domain — domain name;
• family — IP version. Possible values: ipv4, ipv6;
• gateway — gateway IP address;
• id — IP address ID;
• name — server IP address;
• network — network address;
• status — IP address status. Possible values:
• • allocating — IP address allocation task has been created;
  • in_progress — IP address change task has been created;
  • deleting — IP address deletion task has been created;
  • ok — IP address was allocated successfully;
  • fail — task completion failed;
  • allocation_fail — IP address allocation failed;
• status_info — IP address status info;

switch_connection — server connection switch ports info:

• id — port ID;
• switch — switch ID;
• connection_id — connection ID;
• description — port description;
• admin_status — status of switch port managed by admin. Possible values:
  
• • up — port is active;
  • down — port is inactive;
  • testing — port is in test status;
  • unknown — port status unknown.
• oper_status — switch port connection status. Possible values:
• • up — connection is active;
  • down — connection is inactive;
  • testing — port is in test status;
  • unknown — connection status unknown;

  pdu_connection — PDU server connection port info:

  • port_id — port ID;
  • port_identity — PDU port ID;
  • pdu_id — PDU ID;
  • pdu_name — PDU name;
  • connection_id — connection ID;
  • power_status — port status. Possible values:
  • • up — port is active;
    • down — port is inactive;
    • unknown — port status unknown;

    ipmi — IPMI info:

    • address — IPMI IP address;
    • id — IPMI ID;
    • status — IPMI status. Possible values:
    • • on — active;
      • off — inactive;
      • unknown — unknown;
      • in_progress — in progress;
    • type — IPMI type. Possible values:
      
    • • IPMI v1.5/v2;
      • IPMI v2(lanplus);
    • web_url — IPMI web interface URL;

    location — location info:

    • geolocation — location position;
    • id — location ID;
    • name — location name;
    • userspace — location userspace ID in IPmanager;

    location_id — location ID;

    mac — server's MAC address;

    main_ipv4 — server's main IPv4 address. Used to install OS;

    platform — server platform info:

    • id — platform ID;
    • name — platform name;
    • size — platform size;
    • type — platform type;

    rack — server rack info:

    • id — rack ID;
    • name — rack name;
    • size — rack size;

    unit — unit number in rack.

id — user ID;

email — user email for authorization;

server_count — number of user owned servers;

roles — list of user roles. Possible value of list elements: @admin — administrator, @user — user;

vlans_per_user — the number of VLANs available to the user

admin@example.com — authorization email;

name — user full name;

pass — user password;

phone — user phone;

level — user role. Possible values: @admin — administrator, @user — user.

server_id — server ID;

user_id — user ID.

domain — domain name of the server allocated with the IP address;

family — IP version. Possible values: ipv4, ipv6;

gateway — gateway IP address;

id — IP address ID;

name — IP address;

network — IP address network;

server — server allocated with the IP address;

status — IP address status. Possible values:

• allocating — IP address allocation task has been created;
• in_progress — IP address change task has been created;
• deleting — IP address deletion task has been created;
• ok — IP address was allocated successfully;
• fail — task completion failed;
• allocation_fail — IP address allocation failed;

status_info — IP address status info.

domain — server domain name;

family — IP version. Possible values: ipv4, ipv6;

gateway — gateway IP address;

id — IP address ID;

name — IP address;

network — IP address network;

server — server allocated with the IP address;

status — IP address status. Possible values:

• allocating — IP address allocation task has been created;
• in_progress — IP address change task has been created;
• deleting — IP address deletion task has been created;
• ok — IP address was allocated successfully;
• fail — task completion failed;
• allocation_fail — IP address allocation failed;

status_info — IP address status info.

id — network ID;

userspace — userspace ID in IPmanager.

id — pool ID;

userspace — userspace ID in IPmanager.

server_id — server ID;

domain_name — server domain name;

version — IP version. Possible values: ipv4, ipv6;

address — IP address;

net — IP address network ID;

pool — IP address pool ID;

main_ipv4 — set at the main IPv4 address. Possible values: true, false;

userspace_id — userspace ID in IPmanager.

server_id — server ID;

ip_id — IP address ID.

server_id — server ID;

setup_ipmi — whether you need to configure IPMI. Optional parameter. Possible values:

• true - yes;
• false - no;

ipmi_pool — id of the pool from which you want to allocate an IP address for IPMI. Optional parameter;

os_template_id — diagnostics template ID;

clear_hdd — HDD clear type. Possible values:

• none — no HDD clearing;
• simple — quick HDD clearing;
• full — full HDD clearing.

server_id — server ID;

clear_hdd — HDD clear type. Possible values:

• none — no HDD clearing;
• simple — quick HDD clearing;
• full — full HDD clearing.

server_id — server ID;

raid — RAID. Possible values: no_raid, raid_0, raid_1, raid_5, raid_10;

template_id — OS template ID;

pass — server admin password;

ssh_keys — list of public SSH keys.