Interacting with Hardware¶
hw bandwidth¶
Bandwidth data over date range. Bandwidth is listed in GB
Using just a date might get you times off by 1 hour, use T00:01 to get just the specific days data Timezones can also be included with the YYYY-MM-DDTHH:mm:ss.00000-HH:mm format.
Due to some rounding and date alignment details, results here might be slightly different than results in the control portal.
Example:
slcli hw bandwidth 1234 -s 2019-05-01T00:01 -e 2019-05-02T00:00:01.00000-12:00
hw bandwidth [OPTIONS] IDENTIFIER
Options
-
-s
,
--start_date
<start_date>
¶ Start Date YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss, [required]
-
-e
,
--end_date
<end_date>
¶ End Date YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss [required]
-
-p
,
--summary_period
<summary_period>
¶ 300, 600, 1800, 3600, 43200 or 86400 seconds [default: 3600]
-
-q
,
--quite_summary
¶
Only show the summary table [default: False]
Arguments
-
IDENTIFIER
¶
Required argument
hw cancel¶
Cancel a dedicated server.
hw cancel [OPTIONS] IDENTIFIER
Options
-
--immediate
¶
Cancels the server immediately (instead of on the billing anniversary)
-
--comment
<comment>
¶ An optional comment to add to the cancellation ticket
-
--reason
<reason>
¶ An optional cancellation reason. See cancel-reasons for a list of available options
Arguments
-
IDENTIFIER
¶
Required argument
hw create¶
Order/create a dedicated server.
hw create [OPTIONS]
Options
-
-H
,
--hostname
<hostname>
¶ Host portion of the FQDN [required]
-
-D
,
--domain
<domain>
¶ Domain portion of the FQDN [required]
-
-s
,
--size
<size>
¶ Hardware size [required]
-
-o
,
--os
<os>
¶ OS install code [required]
-
-d
,
--datacenter
<datacenter>
¶ Datacenter shortname [required]
-
--port-speed
<port_speed>
¶ Port speeds [required]
-
--billing
<billing>
¶ Billing rate [default: hourly]
Options: hourly|monthly
-
-i
,
--postinstall
<postinstall>
¶ Post-install script to download
-
-k
,
--key
<key>
¶ SSH keys to add to the root user (multiple occurrence permitted)
-
--no-public
¶
Private network only
-
-e
,
--extra
<extra>
¶ Extra options (multiple occurrence permitted)
-
--test
¶
Do not actually create the server
-
-t
,
--template
<template>
¶ A template file that defaults the command-line options
-
--export
<export>
¶ Exports options to a template file
-
--wait
<wait>
¶ Wait until the server is finished provisioning for up to X seconds before returning
Provides some basic functionality to order a server. slcli order has a more full featured method of ordering servers. This command only supports the FAST_PROVISION type.
hw credentials¶
List server credentials.
hw credentials [OPTIONS] IDENTIFIER
Arguments
-
IDENTIFIER
¶
Required argument
hw detail¶
Get details for a hardware device.
hw detail [OPTIONS] IDENTIFIER
Options
-
--passwords
¶
Show passwords (check over your shoulder!)
-
--price
¶
Show associated prices
Arguments
-
IDENTIFIER
¶
Required argument
hw edit¶
Edit hardware details.
hw edit [OPTIONS] IDENTIFIER
Options
-
-D
,
--domain
<domain>
¶ Domain portion of the FQDN
-
-F
,
--userfile
<userfile>
¶ Read userdata from file
-
-g
,
--tag
<tag>
¶ Tags to set or empty string to remove all
-
-H
,
--hostname
<hostname>
¶ Host portion of the FQDN
-
-u
,
--userdata
<userdata>
¶ User defined metadata string
-
--public-speed
<public_speed>
¶ Public port speed. -1 is best speed available
Options: 0|10|100|1000|10000|-1
-
--private-speed
<private_speed>
¶ Private port speed. -1 is best speed available
Options: 0|10|100|1000|10000|-1
Arguments
-
IDENTIFIER
¶
Required argument
When setting port speed, use “-1” to indicate best possible configuration. Using 10/100/1000/10000 on a server with a redundant interface may result the interface entering a degraded state. See setPublicNetworkInterfaceSpeed for more information.
hw list¶
List hardware servers.
hw list [OPTIONS]
Options
-
-c
,
--cpu
<cpu>
¶ Filter by number of CPU cores
-
-D
,
--domain
<domain>
¶ Filter by domain
-
-d
,
--datacenter
<datacenter>
¶ Filter by datacenter
-
-H
,
--hostname
<hostname>
¶ Filter by hostname
-
-m
,
--memory
<memory>
¶ Filter by memory in gigabytes
-
-n
,
--network
<network>
¶ Filter by network port speed in Mbps
-
--tag
<tag>
¶ Filter by tags (multiple occurrence permitted)
-
--sortby
<sortby>
¶ Column to sort by [default: hostname]
-
--columns
<columns>
¶ Columns to display. [options: guid, primary_ip, backend_ip, datacenter, action, created_by, tags] [default: id,hostname,primary_ip,backend_ip,datacenter,action]
-
-l
,
--limit
<limit>
¶ How many results to get in one api call, default is 100 [default: 100]
hw power-cycle¶
Power cycle a server.
hw power-cycle [OPTIONS] IDENTIFIER
Arguments
-
IDENTIFIER
¶
Required argument
hw power-off¶
Power off an active server.
hw power-off [OPTIONS] IDENTIFIER
Arguments
-
IDENTIFIER
¶
Required argument
hw power-on¶
Power on a server.
hw power-on [OPTIONS] IDENTIFIER
Arguments
-
IDENTIFIER
¶
Required argument
hw reboot¶
Reboot an active server.
hw reboot [OPTIONS] IDENTIFIER
Options
-
--hard
,
--soft
¶
Perform a hard or soft reboot
Arguments
-
IDENTIFIER
¶
Required argument
hw reload¶
Reload operating system on a server.
hw reload [OPTIONS] IDENTIFIER
Options
-
-i
,
--postinstall
<postinstall>
¶ Post-install script to download (Only HTTPS executes, HTTP leaves file in /root
-
-k
,
--key
<key>
¶ SSH keys to add to the root user (multiple occurrence permitted)
Arguments
-
IDENTIFIER
¶
Required argument
hw rescue¶
Reboot server into a rescue image.
hw rescue [OPTIONS] IDENTIFIER
Arguments
-
IDENTIFIER
¶
Required argument
hw reflash-firmware¶
Reflash server firmware.
hw reflash-firmware [OPTIONS] IDENTIFIER
Arguments
-
IDENTIFIER
¶
Required argument
Reflash here means the current version of the firmware running on your server will be re-flashed onto the selected hardware. This does require a reboot. See slcli hw update-firmware if you want the newest version.
hw update-firmware¶
Update server firmware.
hw update-firmware [OPTIONS] IDENTIFIER
Arguments
-
IDENTIFIER
¶
Required argument
This function updates the firmware of a server. If already at the latest version, no software is installed.