Hardware Commands

hardware 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
hardware bandwidth [OPTIONS] IDENTIFIER

Options

-s, --start_date <start_date>

Required Start Date YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss,

-e, --end_date <end_date>

Required End Date YYYY-MM-DD, YYYY-MM-DDTHH:mm:ss

-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

hardware cancel-reasons

Display a list of cancellation reasons.

hardware cancel-reasons [OPTIONS]

hardware cancel

Cancel a dedicated server.

hardware 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

--force

Force modify

Arguments

IDENTIFIER

Required argument

hardware create-options

Server order options for a given chassis.

hardware create-options [OPTIONS] [LOCATION]

Options

-p, --prices

Use –prices to list the server item prices, and to list the Item Prices by location,add it to the –prices option using location short name, e.g. –prices dal13

Arguments

LOCATION

Optional argument

hardware create

Order/create a dedicated server.

hardware create [OPTIONS]

Options

-H, --hostname <hostname>

Required Host portion of the FQDN

-D, --domain <domain>

Required Domain portion of the FQDN

-s, --size <size>

Required Hardware size

-o, --os <os>

Required OS Key value

-d, --datacenter <datacenter>

Required Datacenter shortname

--port-speed <port_speed>

Port speeds. DEPRECATED, use –network

--no-public

Private network only. DEPRECATED, use –network.

--network <network>

Network Option Key. Use instead of port-speed option

--billing <billing>

Billing rate

Default:

'hourly'

Options:

hourly | monthly

-i, --postinstall <postinstall>

Post-install script. Should be a HTTPS URL.

--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

--router-public <router_public>

The ID of the public ROUTER on which you want the virtual server placed

--router-private <router_private>

The ID of the private ROUTER on which you want the virtual server placed

-k, --key <key>

SSH keys to add to the root user (multiple occurrence permitted)

-e, --extra <extra>

Extra option Key Names (multiple occurrence permitted)

--force

Force modify

See ‘slcli server create-options’ for valid options.

hardware monitoring

Get details for a hardware monitors device.

hardware monitoring [OPTIONS] IDENTIFIER

Arguments

IDENTIFIER

Required argument

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.

As of v5.9.0 please use the –network option for specifying port speed, as that allows a bit more granularity for choosing your networking type.

hardware credentials

List server credentials.

hardware credentials [OPTIONS] IDENTIFIER

Arguments

IDENTIFIER

Required argument

hardware detail

Get details for a hardware device.

hardware detail [OPTIONS] IDENTIFIER

Options

--passwords

Show passwords (check over your shoulder!)

--price

Show associated prices

--components

Show associated hardware components

Arguments

IDENTIFIER

Required argument

hardware billing

Get billing for a hardware device.

hardware billing [OPTIONS] IDENTIFIER

Arguments

IDENTIFIER

Required argument

hardware edit

Edit hardware details.

hardware 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

--redundant

The desired state of redundancy for the interface(s)

--degraded

The desired state of degraded for the interface(s)

Arguments

IDENTIFIER

Required argument

Note : Using multiple ‘ : ‘ can cause an error.

$ slcli hw edit 123456 –tag “cloud:service:db2whoc, cloud:svcplan:flex, cloud:svcenv:prod, cloud:bmixenv:fra”

TransportError(0): (‘Connection aborted.’,

RemoteDisconnected(‘Remote end closed connection without response’,))

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.

hardware list

List hardware servers.

hardware 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

Use the more flexible Search API to list instances. See slcli search –types for list of searchable fields.

--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

hardware power-cycle

Power cycle a server.

hardware power-cycle [OPTIONS] IDENTIFIER

Arguments

IDENTIFIER

Required argument

hardware power-off

Power off an active server.

hardware power-off [OPTIONS] IDENTIFIER

Options

--force

Force modify

Arguments

IDENTIFIER

Required argument

hardware power-on

Power on a server.

hardware power-on [OPTIONS] IDENTIFIER

Options

--force

Force modify

Arguments

IDENTIFIER

Required argument

hardware reboot

Reboot an active server.

hardware reboot [OPTIONS] IDENTIFIER

Options

--hard, --soft

Perform a hard or soft reboot

Arguments

IDENTIFIER

Required argument

hardware reload

Reload operating system on a server.

hardware 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)

-l, --lvm

A flag indicating that the provision should use LVM for all logical drives.

Default:

False

Arguments

IDENTIFIER

Required argument

hardware rescue

Reboot server into a rescue image.

hardware rescue [OPTIONS] IDENTIFIER

Arguments

IDENTIFIER

Required argument

hardware reflash-firmware

Reflash server firmware.

hardware 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.

hardware update-firmware

Update server firmware. By default will update all available server components.

hardware update-firmware [OPTIONS] IDENTIFIER

Options

-i, --ipmi

Update IPMI firmware

-r, --raid

Update RAID firmware

-b, --bios

Update BIOS firmware

-d, --harddrive

Update Hard Drives firmware

-n, --network

Update Network Card firmware

Arguments

IDENTIFIER

Required argument

This function updates the firmware of a server. If already at the latest version, no software is installed.

hardware toggle-ipmi

Toggle the IPMI interface on and off

hardware toggle-ipmi [OPTIONS] IDENTIFIER

Options

--enable, --disable

Whether enable (DEFAULT) or disable the interface.

Arguments

IDENTIFIER

Required argument

hardware ready

Check if a server is ready.

hardware ready [OPTIONS] IDENTIFIER

Options

--wait <wait>

Seconds to wait

Default:

0

Arguments

IDENTIFIER

Required argument

hardware dns-sync

Sync DNS records.

hardware dns-sync [OPTIONS] IDENTIFIER

Options

-a, --a-record

Sync the A record for the host

--aaaa-record

Sync the AAAA record for the host

--ptr

Sync the PTR record for the host

--ttl <ttl>

Sets the TTL for the A and/or PTR records

Default:

7200

Arguments

IDENTIFIER

Required argument

If you don’t specify any arguments, it will attempt to update both the A and PTR records. If you don’t want to update both records, you may use the -a or –ptr arguments to limit the records updated.

hardware storage

Get storage details for a hardware server.

hardware storage [OPTIONS] IDENTIFIER

Arguments

IDENTIFIER

Required argument

hardware authorize-storage

Authorize File or Block Storage to a Hardware Server.

hardware authorize-storage [OPTIONS] IDENTIFIER

Options

-u, --username-storage <username_storage>

The storage username to be added to the hardware server

Arguments

IDENTIFIER

Required argument

hardware upgrade

Upgrade a Hardware Server.

hardware upgrade [OPTIONS] IDENTIFIER

Options

--memory <memory>

Memory Size in GB

--network <network>

Network port speed in Mbps

Options:

100 | 100 Redundant | 100 Dual | 1000 | 1000 Redundant | 1000 Dual | 10000 | 10000 Redundant | 10000 Dual

--drive-controller <drive_controller>

Drive Controller

Options:

Non-RAID | RAID

--public-bandwidth <public_bandwidth>

Public Bandwidth in GB

--add-disk <add_disk>

Add a Hard disk in GB to a specific channel, e.g 1000 GB in disk2, it will be –add-disk 1000 2

--resize-disk <resize_disk>

Upgrade a specific disk size in GB, e.g –resize-disk 2000 2

--test

Do not actually upgrade the hardware server

Arguments

IDENTIFIER

Required argument

hardware sensor

Retrieve a server’s hardware state via its internal sensors.

hardware sensor [OPTIONS] IDENTIFIER

Options

--discrete

Show discrete units associated hardware sensor

Arguments

IDENTIFIER

Required argument

hardware notifications

Get all hardware notifications.

hardware notifications [OPTIONS] IDENTIFIER

Arguments

IDENTIFIER

Required argument

hardware notification-add

Create a user hardware notification entry.

hardware notification-add [OPTIONS] IDENTIFIER

Options

--users <users>

Required UserId to be notified on monitoring failure.

Arguments

IDENTIFIER

Required argument

hardware notification-delete

Remove a user hardware notification entry.

hardware notification-delete [OPTIONS] IDENTIFIER

Arguments

IDENTIFIER

Required argument

hardware create-credential

Create a password for a software component.

hardware create-credential [OPTIONS] IDENTIFIER

Options

-U, --username <username>

Required The username part of the username/password pair

-P, --password <password>

Required The password part of the username/password pair.

-n, --notes <notes>

A note string stored for this username/password pair.

--software <software>

Required The name of this specific piece of software.

Arguments

IDENTIFIER

Required argument

hardware vlan-add

Trunk a VLAN to this server.

HARDWARE is the id of the server VLANS is the ID, name, or number of the VLANs you want to add. Multiple vlans can be added at the same time. It is recommended to use the vlan ID, especially if you have multiple vlans with the same name/number.

hardware vlan-add [OPTIONS] HARDWARE [VLANS]...

Arguments

HARDWARE

Required argument

VLANS

Optional argument(s)

hardware vlan-remove

Remove VLANs trunked to this server.

HARDWARE is the id of the server VLANS is the ID, name, or number of the VLANs you want to remove. Multiple vlans can be removed at the same time. It is recommended to use the vlan ID, especially if you have multiple vlans with the same name/number.

hardware vlan-remove [OPTIONS] HARDWARE [VLANS]...

Options

--all

Remove ALL trunked vlans from this server.

Arguments

HARDWARE

Required argument

VLANS

Optional argument(s)

hardware vlan-trunkable

List VLANs this server can be attached to.

hardware vlan-trunkable [OPTIONS] HARDWARE

Arguments

HARDWARE

Required argument