Run a Volume Set Command
run_volumeset_commandRun one command on one volume of a volume set, picked by location and volumeIndex. expandVolume: grow to newStorageCapacity, live, on any filesystem; at most 4 per volume per rolling 24 hours. shrinkVolume (ext4/xfs): data moves to a smaller volume and the replica restarts; the platform refuses a size below initialCapacity or below used bytes plus 5%. createVolumeSnapshot (ext4/xfs): snapshotName; take one before shrinkVolume, restoreVolume, or deleteVolume, and of the destination volume before copyVolume. restoreVolume (ext4/xfs): a new volume from snapshotName, losing writes since it. deleteVolumeSnapshot: removes that recovery point. deleteVolume (ext4/xfs): its data is lost for good. copyVolume (ext4/xfs): copies the volume to the same index in targetLocation, optionally of targetVolumeSet, deleting the device there. Before shrinkVolume, restoreVolume, deleteVolumeSnapshot, deleteVolume, or copyVolume, tell the user what it removes or replaces, and proceed only on their explicit approval. Runs asynchronously: follow the returned id with get_command. Other settings: update_volumeset.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| gvc | Yes | GVC name. | |
| org | No | Organization slug. | |
| name | Yes | Volume set name. | |
| zone | No | restoreVolume: availability zone for the new volume; default: the volume's own. | |
| command | Yes | ||
| location | Yes | Location of the volume, e.g. aws-us-east-2. | |
| volumeIndex | Yes | Index of the volume in that location; get_resource (kind volumeset) lists each location's volumes. | |
| snapshotName | No | createVolumeSnapshot: the new name (lowercase kebab-case). restoreVolume, deleteVolumeSnapshot: an existing snapshot. | |
| snapshotTags | No | createVolumeSnapshot: tags for the snapshot. | |
| expirationDate | No | createVolumeSnapshot: ISO 8601 expiry, e.g. 2026-04-18T00:00:00Z; default: the volume set's retentionDuration. | |
| targetLocation | No | copyVolume: the location the copy is written TO. | |
| timeoutSeconds | No | expandVolume, shrinkVolume: seconds to wait for the resize (default 600). | |
| targetVolumeSet | No | copyVolume: the volume set that receives the copy, same org: //volumeset/<name>, //gvc/<gvc>/volumeset/<name>, or /org/<org>/gvc/<gvc>/volumeset/<name>; default: this one. | |
| newStorageCapacity | No | GB. expandVolume: larger than now. shrinkVolume: smaller, at least 10 (200 for high-throughput-ssd). | |
| acknowledgeDestinationVolumeDeletion | No | copyVolume: must be true; the copy deletes and replaces the volume at volumeIndex in the destination. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | ||
| data | No | The full result. Read this, not only the summary. | |
| details | No | ||
| summary | Yes | ||
| nextSteps | No |