This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

CLIs

1: Assign Baremetal Private NAT IP

1.1: 1.2
1.2: 1.1

2: Assign Baremetal Public NAT IP

2.1: 1.2
2.2: 1.1
2.3: 1.0

3: Attach Baremetal Local Subnet

3.1: 1.2
3.2: 1.1
3.3: 1.0

4: Create Baremetals

4.1: 1.2
4.2: 1.1
4.3: 1.0

5: Delete Baremetal Private NAT IP

5.1: 1.2
5.2: 1.1

6: Delete Baremetal Public NAT IP

6.1: 1.2
6.2: 1.1
6.3: 1.0

7: Delete Baremetals

7.1: 1.2
7.2: 1.1
7.3: 1.0

8: Detach Baremetal Local Subnet

8.1: 1.2
8.2: 1.1
8.3: 1.0

9: List Baremetal Images

9.1: 1.2
9.2: 1.1
9.3: 1.0

10: List Baremetal Products

10.1: 1.2
10.2: 1.1
10.3: 1.0

11: List Baremetals

11.1: 1.2
11.2: 1.1
11.3: 1.0

12: Lock Baremetal

12.1: 1.2
12.2: 1.1
12.3: 1.0

13: Show Baremetal

13.1: 1.2
13.2: 1.1
13.3: 1.0

14: Start Baremetals

14.1: 1.2
14.2: 1.1
14.3: 1.0

15: Stop Baremetals

15.1: 1.2
15.2: 1.1
15.3: 1.0

16: Unlock Baremetal

16.1: 1.2
16.2: 1.1
16.3: 1.0

1 - Assign Baremetal Private NAT IP

1.1 - 1.2

scp-cli baremetal private-nat-ip create
--baremetal_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Assign Private NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
private_nat_ip_id required	string	Private NAT IP ID	`03cd065d8acc4e47b11a11dc1411323e`
private_nat_id required	string	Private NAT ID	`a4fd0216cd32442a82733bbb8be0e82b`

Responses

Name	Description	Example
nat_id	NAT ID	a4fd0216cd32442a82733bbb8be0e82b
nat_ip_id	NAT IP ID	20c507a036c447cdb3b19468d8ea62ac
nat_ip	NAT IP	192.170.2.10
static_nat_id	Static NAT ID	a1b97ae4695b40b0866e86a19cb191d3
state	Static NAT state	ACTIVE

1.2 - 1.1

scp-cli baremetal private-nat-ip create
--baremetal_id <value>
--private_nat_ip_id <value>
--private_nat_id <value>

Description

Assign Private NAT IP at Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
private_nat_ip_id required	string	Private NAT IP ID	`03cd065d8acc4e47b11a11dc1411323e`
private_nat_id required	string	Private NAT ID	`a4fd0216cd32442a82733bbb8be0e82b`

Responses

Name	Description	Example
nat_id	NAT ID	a4fd0216cd32442a82733bbb8be0e82b
nat_ip_id	NAT IP ID	20c507a036c447cdb3b19468d8ea62ac
nat_ip	NAT IP	192.170.2.10
static_nat_id	Static NAT ID	a1b97ae4695b40b0866e86a19cb191d3
state	Static NAT state	ACTIVE

2 - Assign Baremetal Public NAT IP

2.1 - 1.2

scp-cli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>

Description

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
public_ip_address_id required	string	Public IP ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
baremetal_id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac

2.2 - 1.1

scp-cli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>

Description

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
public_ip_address_id required	string	Public IP ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
baremetal_id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac

2.3 - 1.0

scp-cli baremetal nat-ip create
--baremetal_id <value>
--public_ip_address_id <value>

Description

Assign Public NAT IP at Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
public_ip_address_id required	string	Public IP ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
baremetal_id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac

3 - Attach Baremetal Local Subnet

3.1 - 1.2

scp-cli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]

Description

Attach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
local_subnet_ip optional	string	Policy Local Subnet IP	`192.168.0.1`

3.2 - 1.1

scp-cli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]

Description

Attach Local Subnet for Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
local_subnet_ip optional	string	Policy Local Subnet IP	`192.168.0.1`

3.3 - 1.0

scp-cli baremetal local-subnet create
--baremetal_id <value>
--local_subnet_id <value>
[--local_subnet_ip <value>]

Description

Attach Local Subnet for Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
local_subnet_ip optional	string	Policy Local Subnet IP	`192.168.0.1`

4 - Create Baremetals

4.1 - 1.2

scp-cli baremetal baremetal create
--server_details <value>
--subnet_id <value>
--vpc_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
--region_id <value>
[--lock_enabled <value>]
[--init_script <value>]
[--use_placement_group <value>]
[--placement_group_name <value>]
[--tags <value>]

Description

Create Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
server_details required	array	Detailed settings for each server	'{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "server_type_id": "f90e8ef54cc2451b825608e9f95f7bcb", "ip_address": "192.168.0.1", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "zone": "kr-west1-a"}'
subnet_id required	string	Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
vpc_id required	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`
os_user_password required	string	OS user password	`password`
os_user_id required	string	OS user ID	`user001`
image_id required	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`
region_id required	string	Region ID	`kr-west1`
lock_enabled optional	boolean	Use Lock	`True`
init_script optional	string	Init script	`init script`
use_placement_group optional	boolean	Use Placement Group	`False`
placement_group_name optional	string	Placement Group Name	`pgtest`
tags optional	array	Tag	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

4.2 - 1.1

scp-cli baremetal baremetal create
--server_details <value>
--subnet_id <value>
--vpc_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
--region_id <value>
[--lock_enabled <value>]
[--init_script <value>]
[--use_placement_group <value>]
[--placement_group_name <value>]
[--tags <value>]

Description

Create Bare Metal Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
server_details required	array	Detailed settings for each server	'{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "server_type_id": "f90e8ef54cc2451b825608e9f95f7bcb", "ip_address": "192.168.0.1", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "use_hyper_threading": true}'
subnet_id required	string	Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
vpc_id required	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`
os_user_password required	string	OS user password	`password`
os_user_id required	string	OS user ID	`user001`
image_id required	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`
region_id required	string	Region ID	`kr-west1`
lock_enabled optional	boolean	Use Lock	`True`
init_script optional	string	Init script	`init script`
use_placement_group optional	boolean	Use Placement Group	`False`
placement_group_name optional	string	Placement Group Name	`pgtest`
tags optional	array	Tag	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

4.3 - 1.0

scp-cli baremetal baremetal create
--server_details <value>
--subnet_id <value>
--vpc_id <value>
--os_user_password <value>
--os_user_id <value>
--image_id <value>
--region_id <value>
[--lock_enabled <value>]
[--init_script <value>]
[--use_placement_group <value>]
[--placement_group_name <value>]
[--tags <value>]

Description

Create Bare Metal Servers.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
server_details required	array	Detailed settings for each server	'{"bare_metal_local_subnet_id": "ab313c43291e4b678f4bacffe10768ae", "bare_metal_local_subnet_ip_address": "192.168.0.1", "bare_metal_server_name": "bmserver-001", "server_type_id": "f90e8ef54cc2451b825608e9f95f7bcb", "ip_address": "192.168.0.1", "nat_enabled": true, "public_ip_address_id": "20c507a036c447cdb3b19468d8ea62ac", "local_disk_partitions": [{"mount_point": "/mountpoint", "partition_name": "partitionname", "partition_size": 20, "partition_type": "ext4"}], "local_disk_type": "flat", "use_hyper_threading": true}'
subnet_id required	string	Subnet ID	`ab313c43291e4b678f4bacffe10768ae`
vpc_id required	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`
os_user_password required	string	OS user password	`password`
os_user_id required	string	OS user ID	`user001`
image_id required	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`
region_id required	string	Region ID	`kr-west1`
lock_enabled optional	boolean	Use Lock	`True`
init_script optional	string	Init script	`init script`
use_placement_group optional	boolean	Use Placement Group	`False`
placement_group_name optional	string	Placement Group Name	`pgtest`
tags optional	array	Tag	`'{"key": "key", "value": "value"}'`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

5 - Delete Baremetal Private NAT IP

5.1 - 1.2

scp-cli baremetal private-nat-ip delete
--baremetal_id <value>

Description

Delete Private NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

5.2 - 1.1

scp-cli baremetal private-nat-ip delete
--baremetal_id <value>

Description

Delete Private NAT IP Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

6 - Delete Baremetal Public NAT IP

6.1 - 1.2

scp-cli baremetal nat-ip delete
--baremetal_id <value>

Description

Delete Public NAT IP Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

6.2 - 1.1

scp-cli baremetal nat-ip delete
--baremetal_id <value>

Description

Delete Public NAT IP Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

6.3 - 1.0

scp-cli baremetal nat-ip delete
--baremetal_id <value>

Description

Delete Public NAT IP Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

7 - Delete Baremetals

7.1 - 1.2

scp-cli baremetal baremetal delete
--baremetal_id_list <value>

Description

Delete Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id_list required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

7.2 - 1.1

scp-cli baremetal baremetal delete
--baremetal_id_list <value>

Description

Delete Bare Metal Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id_list required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

7.3 - 1.0

scp-cli baremetal baremetal delete
--baremetal_id_list <value>

Description

Delete Bare Metal Servers.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id_list required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

8 - Detach Baremetal Local Subnet

8.1 - 1.2

scp-cli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>

Description

Detach Local Subnet for Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_ip required	string	Policy Local Subnet IP	`192.168.0.1`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`

8.2 - 1.1

scp-cli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>

Description

Detach Local Subnet for Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_ip required	string	Policy Local Subnet IP	`192.168.0.1`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`

8.3 - 1.0

scp-cli baremetal local-subnet delete
--baremetal_id <value>
--local_subnet_ip <value>
--local_subnet_id <value>

Description

Detach Local Subnet for Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`
local_subnet_ip required	string	Policy Local Subnet IP	`192.168.0.1`
local_subnet_id required	string	Local Subnet ID	`ab313c43291e4b678f4bacffe10768ae`

9 - List Baremetal Images

9.1 - 1.2

scp-cli baremetal image list

Description

List Bare Metal Server Images.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Responses

Name	Description	Example
id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
created_at	Created at	2024-07-11 08:56:59
name	Image name	RHEL 8.8 for BM
os_distro	OS type	RHEL
scp_os_version	OS version	8.7
scp_image_type	Image Type	STANDARD

9.2 - 1.1

scp-cli baremetal image list
--region_id <value>

Description

List Bare Metal Server Images.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
region_id required	string	Region ID	`kr-west1`

Responses

Name	Description	Example
id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
created_at	Created at	2024-07-11 08:56:59
name	Image name	RHEL 8.8 for BM
os_distro	OS type	RHEL
scp_os_version	OS version	8.7
scp_image_type	Image Type	STANDARD

9.3 - 1.0

scp-cli baremetal image list
--region_id <value>

Description

List Bare Metal Server Images.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
region_id required	string	Region ID	`kr-west1`

Responses

Name	Description	Example
id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
created_at	Created at	2024-07-11 08:56:59
name	Image name	RHEL 8.8 for BM
os_distro	OS type	RHEL
scp_os_version	OS version	8.7
scp_image_type	Image Type	STANDARD

10 - List Baremetal Products

10.1 - 1.2

scp-cli baremetal product list
[--image_id <value>]

Description

List Bare Metal Server products.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
image_id optional	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`

Responses

Name	Description	Example
id	ID	f90e8ef54cc2451b825608e9f95f7bcb
cpu_name	CPU name	cpu 16 vCore
cpu_unit	CPU unit	vCPU
cpu_value	CPU value	64
description	Description	vCPU 16 │ Memory 128G │ Disk 480G
disk_unit	Disk unit	GB
disk_value	Disk value	480
memory_name	Memory name	server memory 128GB
memory_unit	Memory unit	GB
memory_value	Memory value	128
name	Name	s2v16m128_metal
state	State	AVAILABLE
type	Type	SCALE
compute_class_type_name	Compute class type name	StandardMetal-2
compute_class_type_value	Compute class type value	s2_metal
name_with_generation	Name with generation	s2v16m128_metal
created_at	Created At	2024-05-17T00:23:17Z
modified_at	Modified At	2024-05-17T00:23:17Z
os_disk_gb	OS disk value	480

10.2 - 1.1

scp-cli baremetal product list
[--image_id <value>]

Description

List Bare Metal Server products.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
image_id optional	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`

Responses

Name	Description	Example
id	ID	f90e8ef54cc2451b825608e9f95f7bcb
cpu_name	CPU name	cpu 16 vCore
cpu_unit	CPU unit	vCPU
cpu_value	CPU value	64
description	Description	vCPU 16 │ Memory 128G │ Disk 480G
disk_unit	Disk unit	GB
disk_value	Disk value	480
memory_name	Memory name	server memory 128GB
memory_unit	Memory unit	GB
memory_value	Memory value	128
name	Name	s2v16m128_metal
state	State	AVAILABLE
type	Type	SCALE
compute_class_type_name	Compute class type name	StandardMetal-2
compute_class_type_value	Compute class type value	s2_metal
name_with_generation	Name with generation	s2v16m128_metal
created_at	Created At	2024-05-17T00:23:17Z
modified_at	Modified At	2024-05-17T00:23:17Z
os_disk_gb	OS disk value	480

10.3 - 1.0

scp-cli baremetal product list
[--image_id <value>]

Description

List Bare Metal Server products.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
image_id optional	string	Image ID	`IMAGE-7XFMaJpLsapKvskFMjCtmm`

Responses

Name	Description	Example
id	ID	f90e8ef54cc2451b825608e9f95f7bcb
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
attri_name	Attribute name	attri name
attri_value	Attribute value	attri value
cpu_generation	CPU generation	cpu generation
cpu_name	CPU name	cpu 16 vCore
cpu_unit	CPU unit	vCPU
cpu_value	CPU value	64
description	Description	vCPU 16 │ Memory 128G │ Disk 480G
disk_name	Disk name	disk_name
disk_unit	Disk unit	GB
disk_value	Disk value	480
infiniband_name	InfiniBand name	infiniband_name
infiniband_unit	InfiniBand unit	infiniband_unit
infiniband_value	Infiniband value	infiniband_value
memory_name	Memory name	server memory 128GB
memory_unit	Memory unit	GB
memory_value	Memory value	128
name	Name	s2v16m128_metal
socket_name	Socket name	socket_name
socket_unit	Socket unit	socket_unit
socket_value	Socket value	socket_value
state	State	AVAILABLE
type	Type	SCALE
compute_class_type_name	Compute class type name	StandardMetal-2
compute_class_type_unit	Compute class type unit	compute_class_type_unit
compute_class_type_value	Compute class type value	s2_metal
name_with_generation	Name with generation	s2v16m128_metal

11 - List Baremetals

11.1 - 1.2

scp-cli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]

Description

Get Bare Metal Servers list.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
server_name optional	string	Bare Metal Server name	`bmserver-001`
state optional	string	Bare Metal Server state	`RUNNING`
ip optional	string	Bare Metal Server IP address	`192.168.0.1`
vpc_id optional	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
server_name	Bare Metal Server name	bmserver-001
lock_enabled	Use Lock	True
policy_ip	Policy IP	192.168.0.1
product_type_id	Bare Metal Server scale ID	f90e8ef54cc2451b825608e9f95f7bcb
server_type	Bare Metal Server scale type	s1v8m32_metal
image_id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
image_version	Image version	RHEL 8.7 for BM
state	Bare Metal Server state	RUNNING
os_type	OS type	WINDOWS
vpc_id	VPC ID	e58348b1bc9148e5af86500fd4ef99ca
network_id	Subnet ID	ab313c43291e4b678f4bacffe10768ae
region_id	Region ID	kr-west1
placement_group_name	Placement Group Name	pgtest
zone	Availability Zone	kr-west1-a

11.2 - 1.1

scp-cli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]

Description

Get Bare Metal Servers list.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
server_name optional	string	Bare Metal Server name	`bmserver-001`
state optional	string	Bare Metal Server state	`RUNNING`
ip optional	string	Bare Metal Server IP address	`192.168.0.1`
vpc_id optional	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`

Responses

Name	Description	Example
id	ID	0fdd87aab8cb46f59b7c1f81ed03fb3e
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created By	90dddfc2b1e04edba54ba2b41539a9ac
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified By	90dddfc2b1e04edba54ba2b41539a9ac
server_name	Bare Metal Server name	bmserver-001
lock_enabled	Use Lock	True
policy_ip	Policy IP	192.168.0.1
product_type_id	Bare Metal Server scale ID	f90e8ef54cc2451b825608e9f95f7bcb
server_type	Bare Metal Server scale type	s1v8m32_metal
image_id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
image_version	Image version	RHEL 8.7 for BM
state	Bare Metal Server state	RUNNING
os_type	OS type	WINDOWS
vpc_id	VPC ID	e58348b1bc9148e5af86500fd4ef99ca
network_id	Subnet ID	ab313c43291e4b678f4bacffe10768ae
region_id	Region ID	kr-west1
placement_group_name	Placement Group Name	pgtest

11.3 - 1.0

scp-cli baremetal baremetal list
[--size <value>]
[--page <value>]
[--sort <value>]
[--server_name <value>]
[--state <value>]
[--ip <value>]
[--vpc_id <value>]

Description

Get Bare Metal Servers list.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
size optional	integer	size	`20`
page optional	integer	page	`0`
sort optional	string	sort	`created_at:desc`
server_name optional	string	Bare Metal Server name	`bmserver-001`
state optional	string	Bare Metal Server state	`RUNNING`
ip optional	string	Bare Metal Server IP address	`192.168.0.1`
vpc_id optional	string	VPC ID	`e58348b1bc9148e5af86500fd4ef99ca`

Responses

Name	Description	Example
id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created by	ef716e80-1fac-4faa-892d-0132fc7f5583
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified by	ef716e80-1fac-4faa-892d-0132fc7f5583
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
region_id	Region ID	kr-west1
server_name	Bare Metal Server name	bmserver-001
lock_enabled	Use Lock	True
root_account	Root Account	rootaccount
time_zone	Time Zone	Asia/Seoul
vpc_id	VPC ID	e58348b1bc9148e5af86500fd4ef99ca
network_id	Subnet ID	ab313c43291e4b678f4bacffe10768ae
policy_ip	Policy IP	192.168.0.1
use_local_subnet	Use Local Subnet	True
local_subnet_info	Local Subnet info
policy_use_nat	Use Public NAT	True
policy_nat	Public NAT IP	192.168.0.1
public_nat_status	Public NAT status	ACTIVE
product_type_id	Bare Metal Server scale ID	f90e8ef54cc2451b825608e9f95f7bcb
server_type	Bare Metal Server scale type	s1v8m32_metal
image_id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
image_version	Image version	RHEL 8.7 for BM
state	Bare Metal Server state	RUNNING
init_script	Init script	init script
hyper_threading_use	Use Hyper Threading	True
os_type	OS type	WINDOWS
placement_group_name	Placement Group Name	pgtest

12 - Lock Baremetal

12.1 - 1.2

scp-cli baremetal baremetal lock
--baremetal_id <value>

Description

Lock Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

12.2 - 1.1

scp-cli baremetal baremetal lock
--baremetal_id <value>

Description

Lock Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

12.3 - 1.0

scp-cli baremetal baremetal lock
--baremetal_id <value>

Description

Lock Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

13 - Show Baremetal

13.1 - 1.2

scp-cli baremetal baremetal show
--baremetal_id <value>

Description

Show Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created by	ef716e80-1fac-4faa-892d-0132fc7f5583
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified by	ef716e80-1fac-4faa-892d-0132fc7f5583
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
region_id	Region ID	kr-west1
server_name	Bare Metal Server name	bmserver-001
lock_enabled	Use Lock	True
root_account	Root Account	rootaccount
time_zone	Time Zone	Asia/Seoul
vpc_id	VPC ID	e58348b1bc9148e5af86500fd4ef99ca
network_id	Subnet ID	ab313c43291e4b678f4bacffe10768ae
policy_ip	Policy IP	192.168.0.1
use_local_subnet	Use Local Subnet	True
local_subnet_info	Local Subnet info	[]
product_type_id	Bare Metal Server scale ID	f90e8ef54cc2451b825608e9f95f7bcb
server_type	Bare Metal Server scale type	s1v8m32_metal
image_id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
image_version	Image version	RHEL 8.7 for BM
state	Bare Metal Server state	RUNNING
init_script	Init script	init script
hyper_threading_use	Use Hyper Threading	True
os_type	OS type	WINDOWS
placement_group_name	Placement Group Name	pgtest
private_nat_info	Private NAT info	{}
public_nat_info	Public NAT info	{}
zone	Availability Zone	kr-west1-a
cpu_socket	CPU 소켓 수	1
total_cpu_vcore	전체 CPU vCore 수	64
cpu_core_use	CPU 코어 비활성화 기능 사용 여부	True
cpu_core_active	활성화된 CPU 코어 수	32
cpu_core_state	CPU 코어 상태	SUCCESS
server_model	서버 모델	ThinkSystem SR650 V2
cpu_unit	CPU Unit	vCPU

13.2 - 1.1

scp-cli baremetal baremetal show
--baremetal_id <value>

Description

Show Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created by	ef716e80-1fac-4faa-892d-0132fc7f5583
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified by	ef716e80-1fac-4faa-892d-0132fc7f5583
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
region_id	Region ID	kr-west1
server_name	Bare Metal Server name	bmserver-001
lock_enabled	Use Lock	True
root_account	Root Account	rootaccount
time_zone	Time Zone	Asia/Seoul
vpc_id	VPC ID	e58348b1bc9148e5af86500fd4ef99ca
network_id	Subnet ID	ab313c43291e4b678f4bacffe10768ae
policy_ip	Policy IP	192.168.0.1
use_local_subnet	Use Local Subnet	True
local_subnet_info	Local Subnet info	[]
product_type_id	Bare Metal Server scale ID	f90e8ef54cc2451b825608e9f95f7bcb
server_type	Bare Metal Server scale type	s1v8m32_metal
image_id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
image_version	Image version	RHEL 8.7 for BM
state	Bare Metal Server state	RUNNING
init_script	Init script	init script
hyper_threading_use	Use Hyper Threading	True
os_type	OS type	WINDOWS
placement_group_name	Placement Group Name	pgtest
private_nat_info	Private NAT info	{}
public_nat_info	Public NAT info	{}

13.3 - 1.0

scp-cli baremetal baremetal show
--baremetal_id <value>

Description

Show Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
id	Bare Metal Server ID	20c507a036c447cdb3b19468d8ea62ac
created_at	Created At	2024-05-17T00:23:17Z
created_by	Created by	ef716e80-1fac-4faa-892d-0132fc7f5583
modified_at	Modified At	2024-05-17T00:23:17Z
modified_by	Modified by	ef716e80-1fac-4faa-892d-0132fc7f5583
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
region_id	Region ID	kr-west1
server_name	Bare Metal Server name	bmserver-001
lock_enabled	Use Lock	True
root_account	Root Account	rootaccount
time_zone	Time Zone	Asia/Seoul
vpc_id	VPC ID	e58348b1bc9148e5af86500fd4ef99ca
network_id	Subnet ID	ab313c43291e4b678f4bacffe10768ae
policy_ip	Policy IP	192.168.0.1
use_local_subnet	Use Local Subnet	True
local_subnet_info	Local Subnet info	[]
policy_use_nat	Use Public NAT	True
policy_nat	Public NAT IP	192.168.0.1
public_nat_status	Public NAT status	ACTIVE
product_type_id	Bare Metal Server scale ID	f90e8ef54cc2451b825608e9f95f7bcb
server_type	Bare Metal Server scale type	s1v8m32_metal
image_id	Image ID	IMAGE-7XFMaJpLsapKvskFMjCtmm
image_version	Image version	RHEL 8.7 for BM
state	Bare Metal Server state	RUNNING
init_script	Init script	init script
hyper_threading_use	Use Hyper Threading	True
os_type	OS type	WINDOWS
placement_group_name	Placement Group Name	pgtest

14 - Start Baremetals

14.1 - 1.2

scp-cli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Start Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

14.2 - 1.1

scp-cli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Start Bare Metal Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

14.3 - 1.0

scp-cli baremetal baremetal start
--bare_metal_server_ids <value>

Description

Start Bare Metal Servers.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

15 - Stop Baremetals

15.1 - 1.2

scp-cli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Stop Bare Metal Servers.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

15.2 - 1.1

scp-cli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Stop Bare Metal Servers.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

15.3 - 1.0

scp-cli baremetal baremetal stop
--bare_metal_server_ids <value>

Description

Stop Bare Metal Servers.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
bare_metal_server_ids required	array	Bare Metal Server IDs	`20c507a036c447cdb3b19468d8ea62ac`

Responses

Name	Description	Example
account_id	Account ID	f5c8e56a4d9b49a8bd89e14758a32d53
request_id	Request ID	req-002daa83-52d9-41e8-9b0f-d31d35610f65
resource_id	Resource ID	20c507a036c447cdb3b19468d8ea62ac

16 - Unlock Baremetal

16.1 - 1.2

scp-cli baremetal baremetal unlock
--baremetal_id <value>

Description

Unlock Bare Metal Server.

State ACTIVE (CURRENT)

Version	Not Before
1.2	-

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

16.2 - 1.1

scp-cli baremetal baremetal unlock
--baremetal_id <value>

Description

Unlock Bare Metal Server.

State ACTIVE (SUPPORTED)

Version	Not Before
1.1	20270131

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`

16.3 - 1.0

scp-cli baremetal baremetal unlock
--baremetal_id <value>

Description

Unlock Bare Metal Server.

State ACTIVE (DEPRECATED)

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

Version	Not Before
1.0	20251231

Parameters

Name	Type	Description	Example
baremetal_id required	string	Bare Metal Server ID	`20c507a036c447cdb3b19468d8ea62ac`