Documentation for `scw baremetal`

Elastic Metal - Private Networks API.

Baseboard Management Controller (BMC) management commands

A 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 Remote Access option. 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 access

Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect.

Usage:

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

Arguments:

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

Start BMC access

Start BMC (Baseboard Management Controller) access associated with the 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 add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use.

Usage:

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

Arguments:

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

Stop BMC access

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

Usage:

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

Arguments:

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

Server offer management commands

Server offers will answer with all different Elastic Metal server ranges available in a zone. Each of them will contain all the features of the server (CPUs, memory, disks) with their associated pricing.

Get offer

Get details of an offer identified by its offer ID.

Usage:

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

Arguments:

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

Examples:

Get a server offer with the ID

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

List offers

List all available Elastic Metal server configurations.

Usage:

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

Arguments:

Name	Description	Argument Specifications
subscription-period	Subscription period type to filter offers by	One of: `unknown_subscription_period`, `hourly`, `monthly`
name	Offer name to filter offers by
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`, `all`

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, such as Private Networks, to a specific server.

Usage:

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

Arguments:

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

Examples:

Add an option, such as Private Networks, 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 ...]

Arguments:

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

Examples:

Delete an 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 ID.

Usage:

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

Arguments:

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

Examples:

Get a server option with the 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 ...]

Arguments:

Name	Description	Argument Specifications
offer-id	Offer ID to filter options for
name	Name to filter options for
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`, `all`

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 OS with an ID

Return the specific OS for the ID.

Usage:

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

Arguments:

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

Examples:

Get a specific OS ID

scw baremetal os get

List available OSes

List all OSes that are available for installation on Elastic Metal servers.

Usage:

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

Arguments:

Name	Description	Argument Specifications
offer-id	Offer IDs to filter OSes for
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`, `all`

Partitioning-schemas management commands

Allows to customize the partitioning schemas of your servers (available on some offers and OSs).

Usage:

scw baremetal partitioning-schemas

Private network management command

A Private Network allows you to interconnect your resources in an isolated and private network. 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 etc.).

Note that a resource can be a part of multiple Private Networks.

Add a server to a Private Network

Add an Elastic Metal server to a Private Network.

Usage:

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

Arguments:

Name	Description	Argument Specifications
server-id	UUID of the server	Required
private-network-id	UUID of the Private Network	Required
ipam-ip-ids.{index}	IPAM IDs of an IPs to attach to the server
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

Delete a Private Network

Delete a Private Network.

Usage:

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

Arguments:

Name	Description	Argument Specifications
server-id	UUID of the server	Required
private-network-id	UUID of the Private Network	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

List the Private Networks of a server

List the Private Networks of an Elastic Metal server.

Usage:

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

Arguments:

Name	Description	Argument Specifications
order-by	Sort order for the returned Private Networks	One of: `created_at_asc`, `created_at_desc`, `updated_at_asc`, `updated_at_desc`
server-id	Filter Private Networks by server UUID
private-network-id	Filter Private Networks by Private Network UUID
project-id	Filter Private Networks by project UUID
ipam-ip-ids.{index}	Filter Private Networks by IPAM IP UUIDs
organization-id	Filter Private Networks by organization UUID
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`, `all`

Set multiple Private Networks on a server

Configure multiple Private Networks on an Elastic Metal server.

Usage:

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

Arguments:

Name	Description	Argument Specifications
server-id	UUID of the server	Required
per-private-network-ipam-ip-ids.{key}	Object where the keys are the UUIDs of Private Networks and the values are arrays of IPAM IDs representing the IPs to assign to this Elastic Metal server on the Private Network. If the array supplied for a Private Network is empty, the next available IP from the Private Network's CIDR block will automatically be used for attachment.	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

Server management commands

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

Attach a new flexible IP to a server

Create and attach a new flexible IP to a server

Usage:

scw baremetal server add-flexible-ip <server-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server to which the newly created flexible IP will be attached.	Required
description	Flexible IP description (max. of 255 characters)
ip-type	Define whether the flexible IP is an IPv4 or IPv6	One of: `IPv4`, `IPv6`
tags.{index}	Tags to associate to the flexible IP
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`

Create multiple Elastic Metal servers

Create multiple new Elastic Metal servers. Once the servers are created, proceed with the installation of an OS.

Usage:

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

Arguments:

Name	Description	Argument Specifications
common-configuration.offer-id	Offer ID of the new server
common-configuration.project-id	Project ID with which the server will be created
common-configuration.name	Name of the server (≠hostname)
common-configuration.description	Description associated with the server, max 255 characters
common-configuration.tags.{index}	Tags to associate to the server
common-configuration.install.os-id	ID of the OS to installation on the server
common-configuration.install.hostname	Hostname of the server
common-configuration.install.ssh-key-ids.{index}	SSH key IDs authorized on the server
common-configuration.install.user	User for the installation
common-configuration.install.password	Password for the installation
common-configuration.install.service-user	Regular user that runs the service to be installed on the server
common-configuration.install.service-password	Password used for the service to install
common-configuration.install.partitioning-schema.disks.{index}.device
common-configuration.install.partitioning-schema.disks.{index}.partitions.{index}.label		One of: `unknown_partition_label`, `uefi`, `legacy`, `root`, `boot`, `swap`, `data`, `home`, `raid`, `zfs`
common-configuration.install.partitioning-schema.disks.{index}.partitions.{index}.number
common-configuration.install.partitioning-schema.disks.{index}.partitions.{index}.size
common-configuration.install.partitioning-schema.disks.{index}.partitions.{index}.use-all-available-space
common-configuration.install.partitioning-schema.raids.{index}.name
common-configuration.install.partitioning-schema.raids.{index}.level		One of: `unknown_raid_level`, `raid_level_0`, `raid_level_1`, `raid_level_5`, `raid_level_6`, `raid_level_10`
common-configuration.install.partitioning-schema.raids.{index}.devices.{index}
common-configuration.install.partitioning-schema.filesystems.{index}.device
common-configuration.install.partitioning-schema.filesystems.{index}.format		One of: `unknown_format`, `fat32`, `ext4`, `swap`, `zfs`, `xfs`
common-configuration.install.partitioning-schema.filesystems.{index}.mountpoint
common-configuration.install.partitioning-schema.zfs.pools.{index}.name
common-configuration.install.partitioning-schema.zfs.pools.{index}.type		One of: `unknown_type`, `no_raid`, `mirror`, `raidz1`, `raidz2`
common-configuration.install.partitioning-schema.zfs.pools.{index}.devices.{index}
common-configuration.install.partitioning-schema.zfs.pools.{index}.options.{index}
common-configuration.install.partitioning-schema.zfs.pools.{index}.filesystem-options.{index}
common-configuration.option-ids.{index}	IDs of options to enable on server
common-configuration.protected	If enabled, the server can not be deleted
common-configuration.user-data	Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script
~~common-configuration.organization-id~~	Organization ID with which the server will be created	Deprecated
common-configuration.zone
servers.{index}.hostname
servers.{index}.description
servers.{index}.tags.{index}
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

Create an Elastic Metal server

Create a new Elastic Metal server. Once the server is created, proceed with the installation of an OS.

Usage:

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

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to use. If none is passed the default project ID will be used
name	Name of the server (≠hostname)	Required Default: `<generated>`
description	Description associated with 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 installation on the server
install.hostname	Hostname of the server
install.ssh-key-ids.{index}	SSH key IDs authorized on the server
install.user	User for the installation
install.password	Password for the installation
install.service-user	Regular user that runs the service to be installed on the server
install.service-password	Password used for the service to install
install.partitioning-schema.disks.{index}.device
install.partitioning-schema.disks.{index}.partitions.{index}.label		One of: `unknown_partition_label`, `uefi`, `legacy`, `root`, `boot`, `swap`, `data`, `home`, `raid`, `zfs`
install.partitioning-schema.disks.{index}.partitions.{index}.number
install.partitioning-schema.disks.{index}.partitions.{index}.size
install.partitioning-schema.disks.{index}.partitions.{index}.use-all-available-space
install.partitioning-schema.raids.{index}.name
install.partitioning-schema.raids.{index}.level		One of: `unknown_raid_level`, `raid_level_0`, `raid_level_1`, `raid_level_5`, `raid_level_6`, `raid_level_10`
install.partitioning-schema.raids.{index}.devices.{index}
install.partitioning-schema.filesystems.{index}.device
install.partitioning-schema.filesystems.{index}.format		One of: `unknown_format`, `fat32`, `ext4`, `swap`, `zfs`, `xfs`
install.partitioning-schema.filesystems.{index}.mountpoint
install.partitioning-schema.zfs.pools.{index}.name
install.partitioning-schema.zfs.pools.{index}.type		One of: `unknown_type`, `no_raid`, `mirror`, `raidz1`, `raidz2`
install.partitioning-schema.zfs.pools.{index}.devices.{index}
install.partitioning-schema.zfs.pools.{index}.options.{index}
install.partitioning-schema.zfs.pools.{index}.filesystem-options.{index}
option-ids.{index}	IDs of options to enable on server
protected	If enabled, the server can not be deleted
user-data	Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script
organization-id	Organization ID to use. If none is passed the default organization ID will be used
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

Examples:

Create instance

scw baremetal server create

Delete an Elastic Metal server

Delete the server associated with the ID.

Usage:

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

Arguments:

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

Examples:

Delete an Elastic Metal server

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

Get a specific Elastic Metal server

Get full details of an existing Elastic Metal server associated with the ID.

Usage:

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

Arguments:

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

Examples:

Get a specific server

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

Return server metrics

Get the ping status of the server associated with the ID.

Usage:

scw baremetal server get-metrics [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	Server ID to get the metrics	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

Install an Elastic Metal server

Install an Operating System (OS) on the Elastic Metal server with a specific ID.

Usage:

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

Arguments:

Name	Description	Argument Specifications
server-id	Server ID to install	Required
os-id	ID of the OS to installation on the server	Required
hostname	Hostname of the server	Required
all-ssh-keys	Add all SSH keys on your baremetal instance (cannot be used with ssh-key-ids)
ssh-key-ids.{index}	SSH key IDs authorized on the server (cannot be used with all-ssh-keys)	Required
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
partitioning-schema.disks.{index}.device
partitioning-schema.disks.{index}.partitions.{index}.label		One of: `unknown_partition_label`, `uefi`, `legacy`, `root`, `boot`, `swap`, `data`, `home`, `raid`, `zfs`
partitioning-schema.disks.{index}.partitions.{index}.number
partitioning-schema.disks.{index}.partitions.{index}.size
partitioning-schema.disks.{index}.partitions.{index}.use-all-available-space
partitioning-schema.raids.{index}.name
partitioning-schema.raids.{index}.level		One of: `unknown_raid_level`, `raid_level_0`, `raid_level_1`, `raid_level_5`, `raid_level_6`, `raid_level_10`
partitioning-schema.raids.{index}.devices.{index}
partitioning-schema.filesystems.{index}.device
partitioning-schema.filesystems.{index}.format		One of: `unknown_format`, `fat32`, `ext4`, `swap`, `zfs`, `xfs`
partitioning-schema.filesystems.{index}.mountpoint
partitioning-schema.zfs.pools.{index}.name
partitioning-schema.zfs.pools.{index}.type		One of: `unknown_type`, `no_raid`, `mirror`, `raidz1`, `raidz2`
partitioning-schema.zfs.pools.{index}.devices.{index}
partitioning-schema.zfs.pools.{index}.options.{index}
partitioning-schema.zfs.pools.{index}.filesystem-options.{index}
~~user-data.name~~		Deprecated
~~user-data.content-type~~		Deprecated
~~user-data.content~~		Deprecated
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

Examples:

Install an OS on a 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 an Organization

List Elastic Metal servers for a specific Organization.

Usage:

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

Arguments:

Name	Description	Argument Specifications
order-by	Order of the servers	One of: `created_at_asc`, `created_at_desc`
tags.{index}	Tags to filter for
status.{index}	Status to filter for
name	Names to filter for
project-id	Project ID to filter for
option-id	Option ID to filter for
organization-id	Organization ID to filter for
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`, `all`

Examples:

List all servers in your default zone

scw baremetal server list

List server events

List event (i.e. start/stop/reboot) associated to the server ID.

Usage:

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

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server events searched	Required
order-by	Order of the server events	One of: `created_at_asc`, `created_at_desc`
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`, `all`

Reboot an Elastic Metal server

Reboot the Elastic Metal server associated with the ID, use the boot_type rescue to reboot the server in rescue mode.

Usage:

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

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server to reboot	Required
boot-type	The type of boot	Default: `normal` One of: `unknown_boot_type`, `normal`, `rescue`
ssh-key-ids.{index}	Additional SSH public key IDs to configure on rescue image
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

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

Usage:

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

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server to start	Required
boot-type	The type of boot	One of: `unknown_boot_type`, `normal`, `rescue`
ssh-key-ids.{index}	Additional SSH public key IDs to configure on rescue image
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

Examples:

Start an Elastic Metalx 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 ID. The server remains allocated to your account and all data remains on the local storage of the server.

Usage:

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

Arguments:

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

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 ID. You can update parameters such as the server's name, tags, description and protection flag. Any parameters left null in the request body are not updated.

Usage:

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

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server to update	Required
name	Name of the server (≠hostname), not updated if null
description	Description associated with the server, max 255 characters, not updated if null
tags.{index}	Tags associated with the server, not updated if null
protected	If enabled, the server can not be deleted
user-data	Configuration data to pass to cloud-init such as a YAML cloud config data or a user-data script
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

Update IP

Configure the IP address associated with the server ID and IP ID. You can use this method to set a reverse DNS for an IP address.

Usage:

scw baremetal server update-ip [arg=value ...]

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server	Required
ip-id	ID of the IP to update	Required
reverse	New reverse IP to update, not updated if null
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

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

Arguments:

Name	Description	Argument Specifications
server-id	ID of the server affected by the action.	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1`
timeout	Timeout of the wait	Default: `20m0s`

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

Arguments:

Name	Description	Argument Specifications
order-by	Sort order for items in the response	One of: `created_at_asc`, `created_at_desc`
project-id	ID of the Project	Required
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`, `all`

Update setting

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

Usage:

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

Arguments:

Name	Description	Argument Specifications
setting-id	ID of the setting	Required
enabled	Defines whether the setting is enabled
zone	Zone to target. If none is passed will use default zone from the config	Default: `fr-par-1` One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-2`, `pl-waw-3`

Uh oh!

FilesExpand file tree

baremetal.md

Latest commit

History

baremetal.md

File metadata and controls

Documentation for scw baremetal

Baseboard Management Controller (BMC) management commands

Get BMC access

Start BMC access

Stop BMC access

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 OS with an ID

List available OSes

Partitioning-schemas management commands

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

Attach a new flexible IP to a server

Create multiple Elastic Metal servers

Create an Elastic Metal server

Delete an Elastic Metal server

Get a specific Elastic Metal server

Return server metrics

Install an Elastic Metal server

List Elastic Metal servers for an Organization

List server events

Reboot an Elastic Metal server

Start an Elastic Metal server

Stop an Elastic Metal server

Update an Elastic Metal server

Update IP

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

Settings management commands

List all settings

Update setting

Documentation for `scw baremetal`