Server

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(→View)
(→Commands)
 
(45 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
==Dedicated Server & Cloud Commands==
+
The Server module allows you to manipulate [[Servers]] and [[glossary#Virtual Machine|Virtual Machines]] on the [[glossary#SingleHop|SingleHop]] network. You may do things like list details, reboot, bailout, reinstall, etc...
−
===List===
+
−
The list command will return a list of all the servers that are associated with your account, those being dedicated, dynamic and cloud servers.
+
  
−
'''Path'''
+
Please be aware that certain functions are only for [[servers#Private Cloud|Private]] and [[servers#Public Cloud|Public]] cloud servers. Also many functions are not allowed to be run on the core cascade nodes themselves.
−
*/server/list
+
−
'''Method'''
+
−
*GET
+
−
'''Required Data Parameters'''
+
−
*None
+
−
'''Returned Data Parameters'''
+
−
<pre>
+
−
stdClass Object(
+
−
  [success] => TRUE/FALSE
+
−
  [data] => Array(
+
−
    [0] => stdClass Object(
+
−
      [status] => Server status (online,offline,provisioning).
+
−
      [serverid] => Server ID number.
+
−
      [os] => Currently installed operating system.
+
−
      [hostname] => Server host name, as in "leap.singlehop.com".
+
−
      [ram] => Amount of RAM and type installed.
+
−
      [type] => Type of server (server,vmnode,vm).
+
−
      [cputype] => Type of CPU that is currently installed.
+
−
      [cpuspeed] => Speed of the installed CPU in GHz.
+
−
    )
+
−
  )
+
−
)
+
−
</pre>
+
  
−
===View===
+
==All Servers==
−
The view command will return basic server information along with it's current hardware configuration.
+
===Commands===
 +
*[[Server List]]: Lists all active servers in your Leap account.
 +
*[[Server View]]: Lists details about a specific server.
 +
*[[Server Network]]: Lists network details about a specific server.
 +
*[[Server IP Justification]]: Lists the IP Justification status for all ip addresses assigned to the server.
 +
*[[Server IP Justification Update]]: Updates Ip Justification information on justification items.
 +
*[[Server IP Justification Request]]: Creates a new IP Justification Request for adding additional ip address to the server.
 +
*[[Server Check Install]]: Check the install status of a server.
 +
*[[Server Bandwidth]]: View bandwidth usage for a server.
 +
*[[Server Cancel]]: Create a cancellation request
 +
*[[Server View RDNS]]: View all current [[glossary#RDNS|RDNS]] records.
 +
*[[Server Update RDNS]]: Update [[glossary#RDNS|RDNS]] records.
 +
*[[Server Management]]: View the management details for a managed server.
 +
*[[Server List Snapshots]]: List all operating systems that are available from [[glossary#SingleHop|SingleHop]].
  
−
'''Path'''
+
==Dedicated Servers Only==
−
*/server/view
+
===Commands===
−
'''Method'''
+
*[[Server/Cloud Reinstall|Server Reinstall]]: Reinstall the operating system.
−
*GET
+
*[[Server Bailout]]: Starts or stops the bailout recovery mode.
−
'''Required Data Parameters'''
+
*[[Server/Cloud Reboot|Server Reboot]]: Reboots the server.
−
*None
+
*[[Server Service]]: Used for viewing the available services that can be purchased from [[glossary#SingleHop|SingleHop]] for use with a server.
−
'''Returned Data Parameters'''
+
*[[Server Hardware]]: Used for viewing details about the hardware installed on the server.
−
<pre>
+
*[[Server/Cloud Password|Server Password]]: Used for changing the root users password.
−
stdClass Object(
+
*[[Server Service]]: Used for viewing the available services that can be purchased from [[glossary#SingleHop|SingleHop]] for use with a server.
−
  [success] => TRUE/FALSE
+
*[[Server IPMI]]: Used for viewing the IPMI service.
−
  [data] => Array(
+
−
    [serverid] => Server ID number.
+
−
    [type] => Type of server (server,vmnode,vm).
+
−
    [status] => Server status (online,offline,provisioning).
+
−
    [hostname] => Server host name, as in "leap.singlehop.com".
+
−
    [password] => Root username password.
+
−
    [location] => Server rack and slot number.
+
−
    [datacenter] => Server datacenter (dupont,cimco)
+
−
    [primaryip] => Primary public IP Address.
+
−
    [privateip] => Private IP Address.
+
−
    [os] => Currently installed operating system.
+
−
    [osdetails] => stdClass Object(
+
−
      [id] => Currently installed operating system id.
+
−
      [name] => Currently installed operating system name.
+
−
      [arch] => Currently installed operating system architecture.
+
−
      [controlpanel] => Currently installed control panel (cpanel,plesk).
+
−
    )
+
−
    [firewall] => TRUE/FALSE
+
−
    [privatenetwork] => TRUE/FALSE
+
−
    [network] => Current speed of the servers public uplink port(100Mbit,1Gbit).
+
−
    [hardware] => stdClass Object(
+
−
      [ramslots] => Number of RAM slots on the motherboard.
+
−
      [ram] => Amount of RAM in GB.
+
−
      [diskslots] => Number of hard drives the server can hold
+
−
      [disks] => Array() Size of each hard drive installed (GB,TB).
+
−
      [cpuslots] => Number of CPU sockets on the motherboard.
+
−
      [cpucount] => Number of installed CPUs on the motherboard.
+
−
      [cputype] => Type of CPU that is currently installed.
+
−
      [cpuspeed] => Speed of the installed CPU in GHz.
+
−
      [disktotal] => Total hard drive space installed in GB.
+
−
    )
+
−
    [bandwidth] => Maximum allowed outbound bandwidth in GB.
+
−
    [backup] => stdClass Object(
+
−
      [type] => Backup server type (r1soft).
+
−
      [user] => Backup server username.
+
−
      [host] => Backup server hostname.
+
−
      [pass] => Backup server password.
+
−
    )
+
−
  )
+
−
)
+
−
</pre>
+
  
−
==Dedicated Server Only Commands==
+
==Dynamic / Private Cloud (vmnode) Servers Only==
 +
===Commands===
 +
*[[Server Create VM]]: Create a new [[glossary#Virtual Machine|virtual machine]].
 +
*[[Server Move VM]]: Move the [[glossary#Virtual Machine|virtual machine]] to a new [[servers#Dynamic Server|dynamic server]].
 +
*[[Server Edit VM]]: Edit ram/storage/cpu/hostname and password for a existing [[glossary#Virtual Machine|virtual machine]].
  
 +
===FAQ and Extended Documentation===
 +
*[[vCPUs and CPU Allocation]]
  
−
==Dynamic Server Only Commands==
+
==Cloud Instances/VMs Only==
−
===/server/list/SERVERID===
+
===Commands===
−
 
+
*[[Cloud Delete VM]]: Delete a [[glossary#Virtual Machine|virtual machine]].
−
 
+
*[[Cloud Edit VM]]: Edits the information of a [[glossary#Virtual Machine|virtual machine]].
−
==Private/Public Cloud Only Commands==
+
*[[Server/Cloud Bailout|Cloud Bailout]]: Starts or stops the bailout recovery mode.
 +
*[[Server/Cloud Reinstall|Cloud Reinstall]]: Reinstall the operating system on a [[glossary#Virtual Machine|virtual machine]].
 +
*[[Cloud Snapshot VM]]: Create a snapshot of a [[glossary#Virtual Machine|virtual machine]] that can be used to reinstall.
 +
*[[Cloud Start VM]]: Starts the [[glossary#Virtual Machine|virtual machine]].
 +
*[[Cloud Stop VM]]: Stops the [[glossary#Virtual Machine|virtual machine]].
 +
*[[Server/Cloud Reboot|Cloud Reboot]]: Reboots the [[glossary#Virtual Machine|virtual machine]].
 +
*[[Server/Cloud Password|Cloud Password]]: Used for changing the root users password.
 +
*[[Cloud Stats]]: Returns performance statistics over a given time period.

Latest revision as of 15:58, 27 March 2014

The Server module allows you to manipulate Servers and Virtual Machines on the SingleHop network. You may do things like list details, reboot, bailout, reinstall, etc...

Please be aware that certain functions are only for Private and Public cloud servers. Also many functions are not allowed to be run on the core cascade nodes themselves.

Contents

All Servers

Commands

Dedicated Servers Only

Commands

Dynamic / Private Cloud (vmnode) Servers Only

Commands

FAQ and Extended Documentation

Cloud Instances/VMs Only

Commands

Retrieved from "http://dropzonewiki.singlehop.com/index.php?title=Server&oldid=559"
Personal tools