Skip to content

Add disk(s) to a pool to grow it (operator-only).

POST
/v1/storage-pools/{poolId}/actions/extend
Code sample: Shell / cURL
curl --request POST \
--url https://stratum.example.com/v1/storage-pools/example/actions/extend \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "disks": [ "example" ], "forceWipe": false }'

. Adds whole disks to the pool’s LVM volume group (pvcreate + vgextend) and grows the thin pool to absorb the new space (lvextend), executed in-container on the owning node. The added disks must be empty (no mountpoint, filesystem, LVM signature, or partition table) unless forceWipe is set. Synchronous: the lvm metadata ops are sub-second; returns the updated pool.

Cedar action storage:ExtendStoragePool. A pool on the local node runs synchronously (200); a pool on another node is recorded as an intent and returns 202.

poolId
required
string

The stable pool id (pool-…). pools are addressed by a surrogate id, since the same pool name can exist on multiple nodes. The id is in GET /v1/storage-pools.

Media typeapplication/json
object
disks
required

Device paths to add to the pool — a whole disk (e.g. /dev/sdb) OR a partition meant to be a PV (e.g. /dev/sdb1, GPT type 8e00). The device must be empty (no filesystem/LVM signature, no partition table on a whole disk) unless forceWipe..

Array<string>
>= 1 items
forceWipe

Wipe a disk that holds data (partitions, signatures, an old volume group) instead of refusing it. A mounted disk is refused either way. Destroys everything on the disk.

boolean

The grown pool (synchronous, local node).

Media typeapplication/json

A storage pool. For lvm-thin this is the install’s VG + thin pool on one node; capacity is refreshed by the 60s poller.

object
id
required

Stable surrogate id (pool-…)..

string
name
required
string
driver
required
string
Allowed values: lvm-thin ceph-rbd
nodeId
string
totalBytes
required
integer format: int64
usedBytes
required
integer format: int64
availableBytes
required
integer format: int64
state
required

missing: the backend no longer has the pool; see stateReason. Volumes cannot be placed in it. The next successful poll restores the real state.

string
Allowed values: healthy degraded full missing
stateReason

Why the pool is missing. Absent otherwise.

string
lastPolledAt
string format: date-time
devicePaths
required

Physical devices (PVs) backing the pool’s VG.

Array<string>
volumeGroup

The LVM volume group the pool lives in (lvm-thin only). The install’s default pool is named after its thin LV but lives in the configured VG, so read the VG from here, never from name. Absent for Ceph and until the pool’s node has polled it..

string

Example

{
"driver": "lvm-thin",
"state": "healthy"
}

Cross-node op accepted and recorded as an intent. Poll the intent at the Location header until state is done or error.

Media typeapplication/json

A cross-node disk/pool operation recorded by the CP leader for the owning node’s reconciler to execute against its local /dev. Poll until state is done or error.

object
id
required

Intent id (nsi-…).

string
nodeId
required

The node that executes the op (owns the physical disks).

string
op
required
string
Allowed values: create-pool extend-pool shrink-pool delete-pool wipe-disk
args

Op-specific arguments (name, disks, poolId,…).

object
key
additional properties
any
state
required
string
Allowed values: pending running done error
result

Op output on done. For create/extend/shrink: poolId, name, totalBytes, devicePaths. For delete: poolId.

object
key
additional properties
any
error

Failure detail when state is error.

string
claimedAt
string format: date-time
actor
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

Example

{
"op": "create-pool",
"state": "pending"
}
Location
string

The intent poll URL.

Bad request.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}

Resource not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}

DISK_NOT_EMPTY — a disk is mounted, or carries a filesystem, an LVM signature or a partition table, and forceWipe is not set. No disk is added.

CONFLICT — another refusal by the volume manager, such as a disk that is already a physical volume.

UNSUPPORTED — no live driver can extend pools.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}