CLICommand referenceprojectvolume

project volume

Commands, arguments, and options for openship project volume.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship project volume

Manage replicated project volumes and recoverable backups

openship project volume [options] [command]
SubcommandPurpose
list <project>List volumes, resource versions and replica health
backups <project>List volume backups available for recovery
create [options] <id> [file]Create a volume, optionally restored from a named backup
resize [options] <id> [file]Grow a volume using its exact resource version
backup [options] <project> <volume>Create a volume backup with an idempotent request ID
schedule [options] <id> [file]Set backup frequency and retention at a volume's current resource version
remove-backup [options] <id> [file]Delete a volume backup with explicit name confirmation
remove [options] <id> [file]Delete an unused volume and its data, checking its name and resource version
events [options] <project>Stream health and operation progress

openship project volume backup

Create a volume backup with an idempotent request ID

openship project volume backup [options] <project> <volume>
ArgumentMeaning
projectProject ID
volumeVolume name
OptionMeaning
--request-id <id>Stable request ID for this backup (16–64 characters)

openship project volume backups

List volume backups available for recovery

openship project volume backups [options] <project>
ArgumentMeaning
projectProject ID

openship project volume create

Create a volume, optionally restored from a named backup

openship project volume create [options] <id> [file]
ArgumentMeaning
idResource ID
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request

openship project volume events

Stream health and operation progress

openship project volume events [options] <project>
ArgumentMeaning
projectProject ID
OptionMeaning
--timeout <ms>Stop after this deadline

openship project volume list

List volumes, resource versions and replica health

openship project volume list [options] <project>
ArgumentMeaning
projectProject ID

openship project volume remove

Delete an unused volume and its data, checking its name and resource version

openship project volume remove [options] <id> [file]
ArgumentMeaning
idResource ID
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request
-y, --yesConfirm this operation

openship project volume remove-backup

Delete a volume backup with explicit name confirmation

openship project volume remove-backup [options] <id> [file]
ArgumentMeaning
idResource ID
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request
-y, --yesConfirm this operation

openship project volume resize

Grow a volume using its exact resource version

openship project volume resize [options] <id> [file]
ArgumentMeaning
idResource ID
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request

openship project volume schedule

Set backup frequency and retention at a volume's current resource version

openship project volume schedule [options] <id> [file]
ArgumentMeaning
idResource ID
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request

On this page