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

Return to the regular view of this page.

List Volumes

1 - 1.4

scp-cli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of Volumes.

State ACTIVE (CURRENT)

VersionNot Before
1.4-

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group
zoneAvailability zonekr-west1-a

2 - 1.3

scp-cli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of Volumes.

State ACTIVE (SUPPORTED)

VersionNot Before
1.320270131

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group

3 - 1.2

scp-cli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of Volumes.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.220260531

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group

4 - 1.1

scp-cli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of Volumes.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.120260331

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group

5 - 1.0

scp-cli baremetal-blockstorage volume list
[--limit <value>]
[--offset <value>]
[--sort <value>]
[--name <value>]
[--object_name <value>]
[--volume_group_name <value>]

Description

Get a list of Volumes.

State ACTIVE (DEPRECATED)

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

VersionNot Before
1.020251231

Parameters

NameTypeDescriptionExample
limit
optional
integerNumber to be displayed on the page20
offset
optional
integerOffset0
sort
optional
stringSortcolumn1:asc,column2:desc
name
optional
stringVolume namebs-01
object_name
optional
stringAttached server namebaremetal-server-name
volume_group_name
optional
stringVolume group namevg-01

Responses

NameDescriptionExample
idid7239779c01e3405f82bb71c7f4b55fcd
attachmentsAttached server[{‘id’: ‘d7682135392e42489948c189e29011cc’, ’name’: ‘baremetal-01’, ‘srn’: ‘srn:dev2::8461b55d9088408b8f3cf1f8f9c8bea6:kr-west1::baremetal:baremetal/92cd16fe8ebc4f73832513a172bf0000’}]
created_atCreated at
created_byCreated byf019b1007d9c4763997997622958fa96
disk_typeDisk type
has_relationWhether relation existsFalse
is_in_volume_groupWhether to belong to the volume groupFalse
is_snapshot_activatedWhether to activate snapshotTrue
iscsi_target_ipsList of iscsi ips{‘description’: ‘List of iscsi ips’, ’example’: [‘172.30.4.3’, ‘172.30.4.4’]}
modified_atModified at
modified_byModified byf019b1007d9c4763997997622958fa96
nameVolume namebs-01
purposeVolume purpose
size_gbVolume capacity(GB)10
stateCurrent state
volume_groupVolume group