(Created page with "The view command will return basic server information along with it's current hardware configuration. ==Path== */server/list ==Method== *GET ==Required Data Parameters== *No...") |
|||
(9 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
− | The view command will return basic server information along with it's current hardware configuration. | + | The [[Server|server]] view command will return basic server information along with it's current hardware configuration. |
==Path== | ==Path== | ||
− | */server/ | + | */server/view/{$serverid} |
==Method== | ==Method== | ||
− | *GET | + | *[[glossary#get|GET]] |
+ | |||
+ | ==Availability== | ||
+ | *[[servers#Dedicated Server|Dedicated Server]] | ||
+ | *[[servers#Dynamic Server|Dynamic Server]] | ||
+ | *[[servers#Private Cloud|Private Cloud]] | ||
+ | *[[servers#Public Cloud|Public Cloud]] | ||
==Required Data Parameters== | ==Required Data Parameters== | ||
+ | *{$serverid}: The server ID that is returned when using the [[Server List|list]] command. | ||
+ | |||
+ | ==Optional Data Parameters== | ||
*None | *None | ||
− | ==Returned Data | + | ==Returned Data== |
<pre> | <pre> | ||
stdClass Object( | stdClass Object( | ||
Line 20: | Line 29: | ||
[password] => Root username password. | [password] => Root username password. | ||
[location] => Server rack and slot number. | [location] => Server rack and slot number. | ||
− | [datacenter] => Server datacenter (dupont,cimco) | + | [datacenter] => Server datacenter (dupont,cimco). |
[primaryip] => Primary public IP Address. | [primaryip] => Primary public IP Address. | ||
[privateip] => Private IP Address. | [privateip] => Private IP Address. | ||
Line 32: | Line 41: | ||
[firewall] => TRUE/FALSE | [firewall] => TRUE/FALSE | ||
[privatenetwork] => TRUE/FALSE | [privatenetwork] => TRUE/FALSE | ||
− | [network] => Current speed of the servers public uplink port(100Mbit,1Gbit). | + | [network] => Current speed of the servers public uplink port (100Mbit,1Gbit). |
[hardware] => stdClass Object( | [hardware] => stdClass Object( | ||
[ramslots] => Number of RAM slots on the motherboard. | [ramslots] => Number of RAM slots on the motherboard. | ||
[ram] => Amount of RAM in GB. | [ram] => Amount of RAM in GB. | ||
[diskslots] => Number of hard drives the server can hold | [diskslots] => Number of hard drives the server can hold | ||
− | [disks] => | + | [disks] => An array of all the hard drives installed and their size (GB,TB). |
[cpuslots] => Number of CPU sockets on the motherboard. | [cpuslots] => Number of CPU sockets on the motherboard. | ||
[cpucount] => Number of installed CPUs on the motherboard. | [cpucount] => Number of installed CPUs on the motherboard. |
The server view command will return basic server information along with it's current hardware configuration.
Contents |
stdClass Object( [success] => TRUE/FALSE [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] => An array of all the hard drives installed and their size (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. ) ) )