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

Return to the regular view of this page.

Compute Volumes

1 - pcloud compute volumes

Volume management commands

Synopsis

Volume management commands.

You can create more data volumes to hold application data or support multi-disk use cases with your VMs by using the “pcloud compute volumes” subcommand.

Possibility to create, describe, list, update, delete Volume(s). Possibility to list, describe Volume(s) of a VM instance. Possibility to set a Volume as the boot Volume of a VM instance.

pcloud compute volumes [flags]

Options

  -h, --help   help for volumes

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

2 - pcloud compute volumes clones

Clone Management Commands

Synopsis

Clone Management Commands

pcloud compute volumes clones [flags]

Options

  -h, --help   help for clones

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

3 - pcloud compute volumes clones cancel

Cancel a Volume Clone

Synopsis

Cancel a Volume Clone

pcloud compute volumes clones cancel <VolumeCloneID> [flags]

Options

  -f, --force   force cancellation
  -h, --help    help for cancel

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

4 - pcloud compute volumes clones create

Create Clone

Synopsis

Create Clone

pcloud compute volumes clones create <CloneName> -v <VolumeName> [-v <VolumeName> ...] [flags]

Options

  -h, --help                 help for create
  -v, --volume stringArray   Volume clone source(s).

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

5 - pcloud compute volumes clones delete

Delete Clone

Synopsis

Delete Clone

pcloud compute volumes clones delete <VolumeCloneID> [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

6 - pcloud compute volumes clones describe

Describe a Volume Clone Request

Synopsis

Describe a Volume Clone Request

pcloud compute volumes clones describe <VolumeCloneID> [flags]

Options

  -h, --help   help for describe

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

7 - pcloud compute volumes clones execute

Initiate Volume Clone Execute

Synopsis

Initiate Volume Clone Execute

pcloud compute volumes clones execute <VolumesCloneID> <CloneName> [flags]

Options

  -h, --help               help for execute
  -r, --rollback-prepare   rollback prepared snapshot on failure

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

8 - pcloud compute volumes clones list

List Clone Requests

Synopsis

List Clone Requests

The –long option will provide extended clone detail.

The may be one of: - prepare - start - exeecute - cancel - completed - failed - cancelled - finalized

pcloud compute volumes clones list [--long] [--filter=<FilterSpec>] [flags]

Options

  -f, --filter string   filter
  -h, --help            help for list
  -l, --long            long output format

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

9 - pcloud compute volumes clones new

Prepare Clone Request

Synopsis

Prepare Clone Request

pcloud compute volumes clones new <CloneName> -v <VolumeName> [-v <VolumeName> ...] [flags]

Options

  -h, --help                 help for new
  -v, --volume stringArray   Volume clone source(s).

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

10 - pcloud compute volumes clones start

Initiate The Volume Clone Start

Synopsis

Initiate The Volume Clone Start

pcloud compute volumes clones start <VolumesCloneID> [flags]

Options

  -h, --help   help for start

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

11 - pcloud compute volumes clones status

Get Clone Task Status

Synopsis

Get Clone Task Status

pcloud compute volumes clones status <CloneTaskID> [flags]

Options

  -h, --help   help for status

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

12 - pcloud compute volumes create

Create Volumes

Synopsis

Create Volumes for a Cloud

pcloud compute volumes create <VolumeName> --type <Type> [flags]

Options

  -a, --affinityPolicy string   Affinity policy for data volume being created (must be one of {"affinity", "anti-affinity"}, requires --affinityVolume to be specified)
                                 - "affinity": uses the same storage provider that the specified affinityVolume was created in.
                                 - "anti-affinity": uses any storage provider that is not the same as the storage provider the affinityVolume is in.
  -v, --affinityVolume string   Volume (ID or Name) to base volume affinity policy against (required if --affinityPolicy is provided)
  -r, --enableReplication       Indicates replication should be enabled
  -h, --help                    help for create
  -n, --number int              Number of volumes to create (default 1)
  -S, --shareable               Indicates if the volume is shareable between VMs
  -s, --size int                Volume Size (GB) (default 10)
  -T, --type string             Storage type (required except when affinity is specified)
                                Storage type depends on the region of your cloud and can only be set from a short list of available values.
                                You can list the available storage types of your cloud by running the "pcloud compute clouds describe <cloudID>" command.
  -p, --volumePool string       Volume pool for new volume(s)

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

13 - pcloud compute volumes delete

Delete Volumes

Synopsis

Delete Volume(s) from a Cloud. Several volumes can be deleted at the same time. Note that VolumeID can be used as parameter instead of VolumeName

pcloud compute volumes delete <VolumeName> [<VolumeName> ] [flags]

Options

  -h, --help    help for delete
  -q, --quiet   Quiet deletion (no confirmation is required)

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

14 - pcloud compute volumes describe

Describe Volume

Synopsis

Describe Volume with details. Output format depends on –format option., Note that VolumeID can be used as parameter instead of VolumeName.

pcloud compute volumes describe <VolumeName> [flags]

Options

  -h, --help   help for describe

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

15 - pcloud compute volumes list-pools

List Volume Pools

Synopsis

List volume pools

pcloud compute volumes list-pools [flags]

Options

  -h, --help   help for list-pools

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

16 - pcloud compute volumes list

List Volumes

Synopsis

List Volumes with details. If no –instance parameter is provided, list Volume(s) of Cloud Instance. If –instance parameter is provided, and if –affinity is not provided, list volumes attached to a VM Instance. If –instance parameter is provided, and if –affinity is provided, list volumes in affinity with a VM Instance. Volumes details are displayed with –long option. Volumes can be filtered out with –filter option. Output format depends on –format option.

pcloud compute volumes list [flags]

Options

  -a, --affinity          List volumes in affinity with a VM Instance (note that --instance must be set)
  -f, --filter string     Set search filter.
                          Filters can be any boolean expression built on Volume attributes from this list:
                          "AuxVolumeName BootVolume Bootable ConsistencyGroupName CreationDate DeleteOnTermination DiskType GroupID IoThrottleRate LastUpdateDate MasterVolumeName MirroringState Name PvmInstanceIDs ReplicationStatus Shareable Size State VolumeID VolumePool VolumeType Wwn"
  -h, --help              help for list
  -i, --instance string   Without -a option, VM Instance to see its attached volumes.
                           With -a option, VM Instance to see its affinity volumes.
                           (note that 'InstanceID' or 'InstanceName' can be used)
  -l, --long              Print detailed info of each Volume

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

17 - pcloud compute volumes replication

volume replication commands

Synopsis

volume replication commands

pcloud compute volumes replication [flags]

Options

  -h, --help   help for replication

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

18 - pcloud compute volumes replication disable

disable replication on a volume

Synopsis

disable replication on a volume

pcloud compute volumes replication disable <volume-id> [flags]

Options

  -h, --help   help for disable

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

19 - pcloud compute volumes replication enable

enable replication on a volume

Synopsis

enable replication on a volume

pcloud compute volumes replication enable volume <volume-id> [flags]

Options

  -h, --help   help for enable

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

20 - pcloud compute volumes replication onboard

onboard aux volumes

Synopsis

onboard aux volumes

pcloud compute volumes replication onboard --name <name> --source <cloud-id> --volume <aux-volume-name:local-volume-name> [flags]

Options

  -h, --help                 help for onboard
  -n, --name string          Replication Name
  -s, --source string        Source Cloud ID
  -v, --volume stringArray   AuxVolume:LocalName

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

21 - pcloud compute volumes transfer

Volume Transfer Commands

Synopsis

Volume Transfer Commands

pcloud compute volumes transfer [flags]

Options

  -h, --help   help for transfer

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

22 - pcloud compute volumes transfer accept

Accept a volume transfer

Synopsis

Accept a volume transfer

pcloud compute volumes transfer accept <transferID> <authCode> [flags]

Options

  -h, --help   help for accept

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

23 - pcloud compute volumes transfer create

Volume Transfer Create

Synopsis

Volume Transfer Create

pcloud compute volumes transfer create <name> <volumeID> [flags]

Options

  -h, --help   help for create

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

24 - pcloud compute volumes transfer delete

Delete a volume transfer

Synopsis

Delete a volume transfer

pcloud compute volumes transfer delete <transferID> [flags]

Options

  -h, --help   help for delete

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

25 - pcloud compute volumes transfer describe

Describe volume transfer

Synopsis

Describe volume transfer

pcloud compute volumes transfer describe <transferID> [flags]

Options

  -h, --help   help for describe

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

26 - pcloud compute volumes transfer list

Volume transfer list

Synopsis

Volume transfer list

pcloud compute volumes transfer list [flags]

Options

  -h, --help   help for list

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO

27 - pcloud compute volumes update

Update a Volume

Synopsis

Update a Volume for a Cloud Instance. Note that VolumeID can be used as parameter instead of VolumeName.

pcloud compute volumes update <VolumeName> [flags]

Options

  -B, --bootable string    Indicates if the volume is boot capable [yes/no]
  -h, --help               help for update
  -n, --name string        New Volume name
  -S, --shareable string   Indicates if the volume is shareable between VMs [yes/no]
  -s, --size float         New Volume size (GB)

Options inherited from parent commands

  -F, --format string      Available formats: 'table', 'yaml', 'json', 'csv'.
                            Default is command specific.
                            Can be used with describe and list subcommands.
  -D, --log.dir string     Override Log file directory
  -L, --log.file string    Override Log file name
  -V, --verbosity string   Override Log verbosity

SEE ALSO