baremetal.md

Documentation for scw baremetal

This API allows to manage your Bare metal server.

• Baseboard Management Controller (BMC) management commands
  • Get BMC (Baseboard Management Controller) access for a given elastic metal server
  • Start BMC (Baseboard Management Controller) access for a given elastic metal server
  • Stop BMC (Baseboard Management Controller) access for a given elastic metal server
• Server offer management commands
  • Get offer
  • List offers
• Server options management commands
  • Add server option
  • Delete server option
  • Get option
  • List options
• Operating System (OS) management commands
  • Get an OS with a given ID
  • List all available OS that can be install on an elastic metal server
• Private network management command
  • Add a server to a private network
  • Delete a private network
  • List the private networks of a server
  • Set multiple private networks on a server
• Server management commands
  • Create an elastic metal server
  • Delete an elastic metal server
  • Get a specific elastic metal server
  • Install an elastic metal server
  • List elastic metal servers for organization
  • Reboot an elastic metal server
  • Start an elastic metal server
  • Stop an elastic metal server
  • Update an elastic metal server
  • Wait for a server to reach a stable state (delivery and installation)
• Settings management commands
  • List all settings
  • Update setting

Baseboard Management Controller (BMC) management commands

Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server. For instance, your KVM-IP management console could be accessed with it. You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. Then you need to create Remote Access https://developers.scaleway.com/en/products/baremetal/api/#post-1af723. And finally Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.

Get BMC (Baseboard Management Controller) access for a given elastic metal server

Get the BMC (Baseboard Management Controller) access associated with the given ID.

Usage:

scw baremetal bmc get [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Start BMC (Baseboard Management Controller) access for a given elastic metal server

Start BMC (Baseboard Management Controller) access associated with the given ID. The BMC (Baseboard Management Controller) access is available one hour after the installation of the server. You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option. After start BMC, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.

Usage:

scw baremetal bmc start [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server
ip	Required	The IP authorized to connect to the given server
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Stop BMC (Baseboard Management Controller) access for a given elastic metal server

Stop BMC (Baseboard Management Controller) access associated with the given ID.

Usage:

scw baremetal bmc stop [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Server offer management commands

Server offers will answer with all different elastic metal server ranges available in a given zone. Each of them will contain all the features of the server (cpus, memories, disks) with their associated pricing.

Get offer

Return specific offer for the given ID.

Usage:

scw baremetal offer get [arg=value ...]

Args:

Name		Description
offer-id	Required	ID of the researched Offer
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Get a server offer with the given ID

scw baremetal offer get zone=fr-par-1 offer-id=11111111-1111-1111-1111-111111111111

List offers

List all available server offers.

Usage:

scw baremetal offer list [arg=value ...]

Args:

Name		Description
subscription-period	One of: unknown_subscription_period, hourly, monthly	Period of subscription to filter offers
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, all	Zone to target. If none is passed will use default zone from the config

Examples:

List all server offers in the default zone

scw baremetal offer list

List all server offers in fr-par-1 zone

scw baremetal offer list zone=fr-par-1

Server options management commands

A Server has additional options that let you personalize it to better fit your needs.

Add server option

Add an option to a specific server.

Usage:

scw baremetal options add [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server
option-id	Required	ID of the option to add
expires-at		Auto expire the option after this date
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Add a given option to a server

scw baremetal options add server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111

Delete server option

Delete an option from a specific server.

Usage:

scw baremetal options delete [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server
option-id	Required	ID of the option to delete
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Delete a given option from a server

scw baremetal options delete server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111

Get option

Return specific option for the given ID.

Usage:

scw baremetal options get [arg=value ...]

Args:

Name		Description
option-id	Required	ID of the option
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Get a server option with the given ID

scw baremetal options get zone=fr-par-1 option-id=11111111-1111-1111-1111-111111111111

List options

List all options matching with filters.

Usage:

scw baremetal options list [arg=value ...]

Args:

Name		Description
offer-id		Filter options by offer_id
name		Filter options by name
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, all	Zone to target. If none is passed will use default zone from the config

Examples:

List all server options in the default zone

scw baremetal options list

List all server options in fr-par-1 zone

scw baremetal options list zone=fr-par-1

Operating System (OS) management commands

An Operating System (OS) is the underlying software installed on your server

Get an OS with a given ID

Return specific OS for the given ID.

Usage:

scw baremetal os get <os-id ...> [arg=value ...]

Args:

Name		Description
os-id	Required	ID of the OS
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Get a specific OS ID

scw baremetal os get

List all available OS that can be install on an elastic metal server

List all available OS that can be install on an elastic metal server.

Usage:

scw baremetal os list [arg=value ...]

Args:

Name		Description
offer-id		Filter OS by offer ID
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, all	Zone to target. If none is passed will use default zone from the config

Private network management command

A private network allows interconnecting your resources (servers, instances, ...) in an isolated and private network. The network reachability is limited to the resources that are on the same private network. A VLAN interface is available on the server and can be freely managed (adding IP addresses, shutdown interface...).

Note that a resource can be a part of multiple private networks.

Add a server to a private network

Add a server to a private network.

Usage:

scw baremetal private-network add [arg=value ...]

Args:

Name		Description
server-id	Required	The ID of the server
private-network-id	Required	The ID of the private network
zone	Default: fr-par-1 One of: fr-par-2	Zone to target. If none is passed will use default zone from the config

Delete a private network

Delete a private network.

Usage:

scw baremetal private-network delete [arg=value ...]

Args:

Name		Description
server-id	Required	The ID of the server
private-network-id	Required	The ID of the private network
zone	Default: fr-par-1 One of: fr-par-2	Zone to target. If none is passed will use default zone from the config

List the private networks of a server

List the private networks of a server.

Usage:

scw baremetal private-network list [arg=value ...]

Args:

Name		Description
order-by	One of: created_at_asc, created_at_desc, updated_at_asc, updated_at_desc	The sort order for the returned private networks
server-id		Filter private networks by server ID
private-network-id		Filter private networks by private network ID
project-id		Filter private networks by project ID
organization-id		Filter private networks by organization ID
zone	Default: fr-par-1 One of: fr-par-2, all	Zone to target. If none is passed will use default zone from the config

Set multiple private networks on a server

Set multiple private networks on a server.

Usage:

scw baremetal private-network set [arg=value ...]

Args:

Name		Description
server-id	Required	The ID of the server
private-network-ids.{index}	Required	The IDs of the private networks
zone	Default: fr-par-1 One of: fr-par-2	Zone to target. If none is passed will use default zone from the config

Server management commands

A server is a denomination of a type of instances provided by Scaleway

Create an elastic metal server

Create a new elastic metal server. Once the server is created, you probably want to install an OS.

Usage:

scw baremetal server create [arg=value ...]

Args:

Name		Description
project-id		Project ID to use. If none is passed the default project ID will be used
name	Required Default: <generated>	Name of the server (≠hostname)
description		Description associated to the server, max 255 characters
type		Server commercial type
tags.{index}		Tags to associate to the server
install.os-id		ID of the OS to install on the server
install.hostname		Hostname of the server
install.ssh-key-ids.{index}		SSH key IDs authorized on the server
install.user		User used for the installation
install.password		Password used for the installation
install.service-user		User used for the service to install
install.service-password		Password used for the service to install
option-ids.{index}		IDs of options to enable on server
organization-id		Organization ID to use. If none is passed the default organization ID will be used
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Create instance

scw baremetal server create

Delete an elastic metal server

Delete the server associated with the given ID.

Usage:

scw baremetal server delete <server-id ...> [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server to delete
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Delete an elastic metal server

scw baremetal server delete 11111111-1111-1111-1111-111111111111

Get a specific elastic metal server

Get the server associated with the given ID.

Usage:

scw baremetal server get <server-id ...> [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Get a given server

scw baremetal server get 11111111-1111-1111-1111-111111111111

Install an elastic metal server

Install an OS on the server associated with the given ID.

Usage:

scw baremetal server install <server-id ...> [arg=value ...]

Args:

Name		Description
server-id	Required	Server ID to install
os-id	Required	ID of the OS to install on the server
hostname	Required	Hostname of the server
all-ssh-keys		Add all SSH keys on your baremetal instance (cannot be used with ssh-key-ids)
ssh-key-ids.{index}	Required	SSH key IDs authorized on the server (cannot be used with all-ssh-keys)
user		User used for the installation
password		Password used for the installation
service-user		User used for the service to install
service-password		Password used for the service to install
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Install an OS on a given server with a particular SSH key ID

scw baremetal server install 11111111-1111-1111-1111-111111111111 os-id=11111111-1111-1111-1111-111111111111 ssh-key-ids.0=11111111-1111-1111-1111-111111111111

List elastic metal servers for organization

List elastic metal servers for organization.

Usage:

scw baremetal server list [arg=value ...]

Args:

Name		Description
order-by	One of: created_at_asc, created_at_desc	Order of the servers
tags.{index}		Filter by tags
status.{index}		Filter by status
name		Filter by name
project-id		Filter by project ID
option-id		Filter by option ID
organization-id		Filter by organization ID
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, all	Zone to target. If none is passed will use default zone from the config

Examples:

List all servers on your default zone

scw baremetal server list

Reboot an elastic metal server

Reboot the server associated with the given ID, use boot param to reboot in rescue.

Usage:

scw baremetal server reboot <server-id ...> [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server to reboot
boot-type	Default: normal One of: unknown_boot_type, normal, rescue	The type of boot
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Reboot a server using the same os

scw baremetal server reboot 11111111-1111-1111-1111-111111111111

Reboot a server in rescue mode

scw baremetal server reboot 11111111-1111-1111-1111-111111111111 boot-type=rescue

Start an elastic metal server

Start the server associated with the given ID.

Usage:

scw baremetal server start <server-id ...> [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server to start
boot-type	One of: unknown_boot_type, normal, rescue	The type of boot
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Start an elastic metal server

scw baremetal server start 11111111-1111-1111-1111-111111111111

Start a server in rescue mode

scw baremetal server start 11111111-1111-1111-1111-111111111111 boot-type=rescue

Stop an elastic metal server

Stop the server associated with the given ID.

Usage:

scw baremetal server stop <server-id ...> [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server to stop
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Examples:

Stop an elastic metal server

scw baremetal server stop 11111111-1111-1111-1111-111111111111

Update an elastic metal server

Update the server associated with the given ID.

Usage:

scw baremetal server update <server-id ...> [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server to update
name		Name of the server (≠hostname), not updated if null
description		Description associated to the server, max 255 characters, not updated if null
tags.{index}		Tags associated to the server, not updated if null
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config

Wait for a server to reach a stable state (delivery and installation)

Wait for a server to reach a stable state. This is similar to using --wait flag on other action commands, but without requiring a new action on the server.

Usage:

scw baremetal server wait <server-id ...> [arg=value ...]

Args:

Name		Description
server-id	Required	ID of the server affected by the action.
zone	Default: fr-par-1	Zone to target. If none is passed will use default zone from the config

Examples:

Wait for a server to reach a stable state

scw baremetal server wait 11111111-1111-1111-1111-111111111111

Settings management commands

Allows to configure the general settings for your elastic metal server.

List all settings

Return all settings for a project ID.

Usage:

scw baremetal settings list [arg=value ...]

Args:

Name		Description
order-by	One of: created_at_asc, created_at_desc	Order the response
project-id	Required	ID of the project
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1, all	Zone to target. If none is passed will use default zone from the config

Update setting

Update a setting for a project ID (enable or disable).

Usage:

scw baremetal settings update [arg=value ...]

Args:

Name		Description
setting-id	Required	ID of the setting
enabled		Enable/Disable the setting
zone	Default: fr-par-1 One of: fr-par-1, fr-par-2, nl-ams-1	Zone to target. If none is passed will use default zone from the config