pcloud Reference

• 1: pcloud
• 2: pcloud completion
• 3: pcloud compute
• 4: pcloud docs
• 5: pcloud version
• 6: Auth
• 6.1: pcloud auth
• 6.2: pcloud auth login
• 6.3: pcloud auth print-access-token
• 6.4: pcloud auth print-identity-token
• 6.5: pcloud auth revoke
• 6.6: pcloud auth sa
• 6.7: pcloud auth sa create
• 6.8: pcloud auth sa delete
• 6.9: pcloud auth sa describe
• 6.10: pcloud auth sa list
• 6.11: pcloud auth sa load
• 6.12: pcloud auth sa update
• 7: Config
• 7.1: pcloud config
• 7.2: pcloud config list
• 7.3: pcloud config set
• 7.4: pcloud config set account
• 7.5: pcloud config set cloud
• 8: Tasks
• 8.1: pcloud tasks
• 8.2: pcloud tasks describe
• 8.3: pcloud tasks list
• 9: Compute Clouds
• 9.1: pcloud compute clouds
• 9.2: pcloud compute clouds describe
• 9.3: pcloud compute clouds list
• 9.4: pcloud compute clouds syspools
• 10: Compute Events
• 10.1: pcloud compute events
• 10.2: pcloud compute events describe
• 10.3: pcloud compute events list
• 11: Compute Images
• 11.1: pcloud compute images
• 11.2: pcloud compute images create
• 11.3: pcloud compute images delete
• 11.4: pcloud compute images describe
• 11.5: pcloud compute images export
• 11.6: pcloud compute images import
• 11.7: pcloud compute images list
• 12: Compute Instances
• 12.1: pcloud compute instances
• 12.2: pcloud compute instances attach-network
• 12.3: pcloud compute instances attach-volume
• 12.4: pcloud compute instances capture
• 12.5: pcloud compute instances clone
• 12.6: pcloud compute instances console
• 12.7: pcloud compute instances create
• 12.8: pcloud compute instances delete
• 12.9: pcloud compute instances describe
• 12.10: pcloud compute instances detach-network
• 12.11: pcloud compute instances detach-volume
• 12.12: pcloud compute instances dumprestart
• 12.13: pcloud compute instances list
• 12.14: pcloud compute instances reboot
• 12.15: pcloud compute instances reset
• 12.16: pcloud compute instances shutdown
• 12.17: pcloud compute instances start
• 12.18: pcloud compute instances stop
• 12.19: pcloud compute instances update
• 13: Compute Networks
• 13.1: pcloud compute networks
• 13.2: pcloud compute networks create
• 13.3: pcloud compute networks delete
• 13.4: pcloud compute networks describe
• 13.5: pcloud compute networks list
• 13.6: pcloud compute networks ports
• 13.7: pcloud compute networks ports attach
• 13.8: pcloud compute networks ports create
• 13.9: pcloud compute networks ports delete
• 13.10: pcloud compute networks ports describe
• 13.11: pcloud compute networks ports detach
• 13.12: pcloud compute networks ports list
• 13.13: pcloud compute networks ports update
• 13.14: pcloud compute networks update
• 14: Compute Pgroups
• 14.1: pcloud compute pgroups
• 14.2: pcloud compute pgroups add
• 14.3: pcloud compute pgroups create
• 14.4: pcloud compute pgroups delete
• 14.5: pcloud compute pgroups describe
• 14.6: pcloud compute pgroups list
• 14.7: pcloud compute pgroups remove
• 15: Compute Snapshots
• 15.1: pcloud compute snapshots
• 15.2: pcloud compute snapshots create
• 15.3: pcloud compute snapshots delete
• 15.4: pcloud compute snapshots describe
• 15.5: pcloud compute snapshots list
• 15.6: pcloud compute snapshots restore
• 15.7: pcloud compute snapshots update
• 16: Compute Sshkeys
• 16.1: pcloud compute sshkeys
• 16.2: pcloud compute sshkeys create
• 16.3: pcloud compute sshkeys delete
• 16.4: pcloud compute sshkeys describe
• 16.5: pcloud compute sshkeys list
• 16.6: pcloud compute sshkeys update
• 17: Compute Volume-Groups
• 17.1: pcloud compute volume-groups
• 17.2: pcloud compute volume-groups add-volumes
• 17.3: pcloud compute volume-groups create
• 17.4: pcloud compute volume-groups delete
• 17.5: pcloud compute volume-groups describe
• 17.6: pcloud compute volume-groups list
• 17.7: pcloud compute volume-groups relationship
• 17.8: pcloud compute volume-groups remove-volumes
• 17.9: pcloud compute volume-groups reset
• 17.10: pcloud compute volume-groups start
• 17.11: pcloud compute volume-groups stop
• 18: Compute Volumes
• 18.1: pcloud compute volumes
• 18.2: pcloud compute volumes clones
• 18.3: pcloud compute volumes clones cancel
• 18.4: pcloud compute volumes clones create
• 18.5: pcloud compute volumes clones delete
• 18.6: pcloud compute volumes clones describe
• 18.7: pcloud compute volumes clones execute
• 18.8: pcloud compute volumes clones list
• 18.9: pcloud compute volumes clones new
• 18.10: pcloud compute volumes clones start
• 18.11: pcloud compute volumes clones status
• 18.12: pcloud compute volumes create
• 18.13: pcloud compute volumes delete
• 18.14: pcloud compute volumes describe
• 18.15: pcloud compute volumes list-pools
• 18.16: pcloud compute volumes list
• 18.17: pcloud compute volumes replication
• 18.18: pcloud compute volumes replication disable
• 18.19: pcloud compute volumes replication enable
• 18.20: pcloud compute volumes replication onboard
• 18.21: pcloud compute volumes transfer
• 18.22: pcloud compute volumes transfer accept
• 18.23: pcloud compute volumes transfer create
• 18.24: pcloud compute volumes transfer delete
• 18.25: pcloud compute volumes transfer describe
• 18.26: pcloud compute volumes transfer list
• 18.27: pcloud compute volumes update

1 - pcloud

CLI for IBM® Power Systems™ for GCP

Synopsis

CLI for IBM® Power Systems™ for Google Cloud Platform.

The pcloud command line tool allows you to create and manage the lifecycle of VMs on your IBM Power Systems for Google Cloud instance.

You can use the pcloud command line tool to manage related resources such as VM images and data volumes.

The pcloud command line tool is a stand alone executable file that is available for use on Mac, Windows, and Linux operating systems.

You can use the –help option with all subcommands to get additional information and available options for each of the operations.

You can run the “pcloud docs” command to generate an up-to-date directory of documentation topics that are markdown (.md) files.

pcloud [flags]

Options

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

SEE ALSO

• pcloud auth - Authorization for pcloud
• pcloud completion - Generate completion script
• pcloud compute - pcloud compute
• pcloud config - Configuration for pcloud
• pcloud docs - Generate documentation for pcloud
• pcloud tasks - Get task details. Possibility to list, describe task(s)
• pcloud version - Get current server and pcloud version

2 - pcloud completion

pcloud completion

Generate completion script

Synopsis

To load command line completions for your shell, fine your shell in the list below and follow the process outlined.

Bash

To load completions for your current session, run:

$ source <(pcloud completion bash)

To load completions for each session going forward, execute once:

On Linux:

$ pcloud completion bash > /etc/bash_completion.d/pcloud

On MacOS:

$ pcloud completion bash > /usr/local/etc/bash_completion.d/pcloud

ZSH

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions for each session going forward, execute once:

$ pcloud completion zsh > "${fpath[1]}/_pcloud"

You will need to start a new shell for this setup to take effect.

Fish

To load completions for your current session, run:

$ pcloud completion fish | source

To load completions for each session going forward, execute once:

$ pcloud completion fish > ~/.config/fish/completions/pcloud.fish

You will need to start a new shell for this setup to take effect.

pcloud completion [bash|zsh|fish|powershell]

Options

  -h, --help   help for completion

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

• pcloud - CLI for IBM® Power Systems™ for GCP

3 - pcloud compute

pcloud compute

Synopsis

pcloud compute CLI gives access to “clouds”, “images”, “instances”, “networks”, “sshkeys”, “volumes” subcommands

pcloud compute [flags]

Options

  -h, --help   help for compute

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

• pcloud - CLI for IBM® Power Systems™ for GCP
• pcloud compute clouds - Cloud commands
• pcloud compute events - Event management commands
• pcloud compute images - Image management commands
• pcloud compute instances - VM Instances management commands
• pcloud compute networks - Network management commands
• pcloud compute pgroups - Placement Groups management commands
• pcloud compute snapshots - Snapshot management comamnds
• pcloud compute sshkeys - SSH Keys management commands
• pcloud compute volume-groups - Volume group commands
• pcloud compute volumes - Volume management commands

4 - pcloud docs

Generate documentation for pcloud

Synopsis

Generate documentation for pcloud command (Markdown format), from the current directory into “pcloud-doc” default directory. Output documentation directory can be set with –dir option

pcloud docs [flags]

Options

  -d, --dir string   Directory for pcloud documentation
  -h, --help         help for docs

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

• pcloud - CLI for IBM® Power Systems™ for GCP

5 - pcloud version

Get current server and pcloud version

Synopsis

Get current server and pcloud version.

pcloud version [flags]

Options

  -h, --help   help for version

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

• pcloud - CLI for IBM® Power Systems™ for GCP

6 - Auth

6.1 - pcloud auth

Authorization for pcloud

Synopsis

Commands to authorize pcloud.

Possibility to login, print-access-token, print-identity-token, revoke.

Before you can start using the pcloud tool, you must have an available Power Cloud instance that is provisioned and attached to a selected GCP project within your organization. This process occurs when you subscribe to the offering in the GCP Marketplace. Next, run the “pcloud auth login” command to authenticate to your cloud instance. When you authenticate, you must use the registered Google identity that is associated with the organization and the billing account that is used in the subscription. Running the “pcloud auth login” command provides ou with a unique code to register your pcloud instance.

pcloud auth [flags]

Options

  -h, --help   help for auth

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

• pcloud - CLI for IBM® Power Systems™ for GCP
• pcloud auth login - Login for pcloud
• pcloud auth print-access-token - Print access token
• pcloud auth print-identity-token - Print identity token
• pcloud auth revoke - Revoke credentials for pcloud
• pcloud auth sa - System Account Commands

6.2 - pcloud auth login

Login for pcloud

Synopsis

Login for pcloud. To prompt the user to login to pcloud with instructions.

pcloud auth login [flags]

Options

  -h, --help   help for login

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

• pcloud auth - Authorization for pcloud

6.3 - pcloud auth print-access-token

Print access token

Synopsis

Print access token characteristics.

pcloud auth print-access-token [flags]

Options

  -b, --bare   print bare access token only
  -h, --help   help for print-access-token

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

• pcloud auth - Authorization for pcloud

6.4 - pcloud auth print-identity-token

Print identity token

Synopsis

Print identity token characteristics.

pcloud auth print-identity-token [flags]

Options

  -h, --help   help for print-identity-token

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

• pcloud auth - Authorization for pcloud

6.5 - pcloud auth revoke

Revoke credentials for pcloud

Synopsis

Revoke credentials for pcloud: effectively logout.

pcloud auth revoke [flags]

Options

  -h, --help   help for revoke

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

• pcloud auth - Authorization for pcloud

6.6 - pcloud auth sa

System Account Commands

Synopsis

System Account Commands

pcloud auth sa [flags]

Options

  -h, --help   help for sa

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

• pcloud auth - Authorization for pcloud
• pcloud auth sa create - add a system account user
• pcloud auth sa delete - description
• pcloud auth sa describe - description
• pcloud auth sa list - description
• pcloud auth sa load - create a service account from json keyfile
• pcloud auth sa update - update an existing sa account

6.7 - pcloud auth sa create

add a system account user

Synopsis

add a system account user

pcloud auth sa create <sa-name> <sa-client-id> [--tenant=<tenant-id>] [--cloud=<cloud-id>] [flags]

Options

  -c, --cloud stringArray    Cloud ID
  -h, --help                 help for create
  -t, --tenant stringArray   Tenant ID

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

• pcloud auth sa - System Account Commands

6.8 - pcloud auth sa delete

description

Synopsis

description

pcloud auth sa delete <sa-client-id> [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

• pcloud auth sa - System Account Commands

6.9 - pcloud auth sa describe

description

Synopsis

description

pcloud auth sa describe <sa-client-id> [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

• pcloud auth sa - System Account Commands

6.10 - pcloud auth sa list

description

Synopsis

description

pcloud auth sa list usage [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

• pcloud auth sa - System Account Commands

6.11 - pcloud auth sa load

create a service account from json keyfile

Synopsis

create a service account from json keyfile

pcloud auth sa load <key.json> [flags]

Options

  -h, --help   help for load

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

• pcloud auth sa - System Account Commands

6.12 - pcloud auth sa update

update an existing sa account

Synopsis

update an existing sa account

pcloud auth sa update <sa-client-id> [-name=<name>] [-tenant=<tenant-id>] [-cloud=<cloud-id>] [flags]

Options

  -c, --cloud stringArray    Cloud ID
  -h, --help                 help for update
  -n, --name string          SA Account Name
  -t, --tenant stringArray   Tenant ID

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

• pcloud auth sa - System Account Commands

7 - Config

7.1 - pcloud config

Configuration for pcloud

Synopsis

Commands configuration to manage pcloud config. Possibility to set, list properties.

pcloud config [flags]

Options

  -h, --help   help for config

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

• pcloud - CLI for IBM® Power Systems™ for GCP
• pcloud config list - List Cloud properties
• pcloud config set - Set pcloud configurations

7.2 - pcloud config list

List Cloud properties

Synopsis

List Cloud properties: AccountID, CloudID

pcloud config 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

• pcloud config - Configuration for pcloud

7.3 - pcloud config set

Set pcloud configurations

Synopsis

Set Configuration Parameters

Options

  -h, --help   help for set

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

• pcloud config - Configuration for pcloud
• pcloud config set account - Set Account
• pcloud config set cloud - Set Cloud

7.4 - pcloud config set account

Set Account

Synopsis

Set Account property

pcloud config set account <AccountID> [flags]

Options

  -h, --help   help for account

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

• pcloud config set - Set pcloud configurations

7.5 - pcloud config set cloud

Set Cloud

Synopsis

Set Cloud property

pcloud config set cloud <CloudID> [flags]

Options

  -h, --help   help for cloud

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

• pcloud config set - Set pcloud configurations

8 - Tasks

8.1 - pcloud tasks

Get task details. Possibility to list, describe task(s)

Synopsis

Get task details. Possibility to list, describe task(s). Tasks are used to obtain progress details of long running operations. TaskIDs are returned when launching long operations like: ‘image import’, ‘capture pvm-instance’.

pcloud tasks [flags]

Options

  -h, --help   help for tasks

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

• pcloud - CLI for IBM® Power Systems™ for GCP
• pcloud tasks describe - Describe Task
• pcloud tasks list - List Tasks from log files generated locally

8.2 - pcloud tasks describe

Describe Task

Synopsis

Describe Task with details. Output format depends on –format option.

pcloud tasks describe <TaskID> [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

• pcloud tasks - Get task details. Possibility to list, describe task(s)

8.3 - pcloud tasks list

List Tasks from log files generated locally

Synopsis

List Tasks from log files generated locally. Output format depends on –format option.

pcloud tasks 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

• pcloud tasks - Get task details. Possibility to list, describe task(s)

9 - Compute Clouds

9.1 - pcloud compute clouds

Cloud commands

Synopsis

Commands to manage Cloud Instance(s). Possibility to list, describe Cloud Instance(s)

pcloud compute clouds [flags]

Options

  -h, --help   help for clouds

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

• pcloud compute - pcloud compute
• pcloud compute clouds describe - Describe Cloud Instance
• pcloud compute clouds list - List Clouds
• pcloud compute clouds syspools - List System Pools

9.2 - pcloud compute clouds describe

Describe Cloud Instance

Synopsis

Describe Cloud Instance with details. Output format depends on –format option.

pcloud compute clouds describe <cloudID> [flags]

Options

  -h, --help            help for describe
  -r, --report string   Specify the extent of the output.
                        Options are brief (default), full, limits, instances, capabilities, or usage. (default "brief")

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

• pcloud compute clouds - Cloud commands

9.3 - pcloud compute clouds list

List Clouds

Synopsis

List Clouds. Clouds details are displayed with –long option. Output format depends on –format option.

pcloud compute clouds list [flags]

Options

  -h, --help   help for list
  -l, --long   Print detailed info of each Cloud

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

• pcloud compute clouds - Cloud commands

9.4 - pcloud compute clouds syspools

List System Pools

Synopsis

List System Pools

pcloud compute clouds syspools [flags]

Options

  -h, --help   help for syspools

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

• pcloud compute clouds - Cloud commands

10 - Compute Events

10.1 - pcloud compute events

Event management commands

Synopsis

Event management commands. Possibility to list or describe Event(s).

pcloud compute events [flags]

Options

  -h, --help   help for events

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

• pcloud compute - pcloud compute
• pcloud compute events describe - Describe Event
• pcloud compute events list - List Events

10.2 - pcloud compute events describe

Describe Event

Synopsis

Describe Event with details. Output format depends on –format option.

pcloud compute events describe <EventId> [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

• pcloud compute events - Event management commands

10.3 - pcloud compute events list

List Events

Synopsis

List Events since one date, to another date, in the Cloud Instance. Events details are displayed with –long option. Events can be filtered out with –filter option. Output format depends on –format option.

Dates can be in any of the following formats, note the use of quotes around formats with spaces:

2024-05-20 “2024-05-20 13:00” 1716163200 2024-05-19T19:00:00-05:00

pcloud compute events list --since <Time> --to <Time>  [flags]

Options

  -f, --filter string   Set search filter.
                        Filters can be any boolean expression built on Event attributes from this list:
                        "Action EventID Level Message Resource Time Timestamp Email Name UserID"
  -h, --help            help for list
  -l, --long            Print detailed info of each Event
  -s, --since string    Timestamp since which events must be displayed 
  -t, --to string       Timestamp to which events must be displayed

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

• pcloud compute events - Event management commands

11 - Compute Images

11.1 - pcloud compute images

Image management commands

Synopsis

Image management commands.

Before you can create your first VM on your Power cloud instance, you must have a VM image in your cloud instance catalog. IBM provides a few stock images. These stock images are ideal for creating your first VM. The service also supports options to bring your own images.

To view available stock images, run the “pcloud compute images list –available” command.

Possibility to create, list, describe, import, export, delete Image(s).

pcloud compute images [flags]

Options

  -h, --help   help for images

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

• pcloud compute - pcloud compute
• pcloud compute images create - Create an Image
• pcloud compute images delete - Delete Images
• pcloud compute images describe - Describe Image
• pcloud compute images export - Export a deployable Image
• pcloud compute images import - Import a new Image for a Cloud Instance
• pcloud compute images list - List Images

11.2 - pcloud compute images create

Create an Image

Synopsis

Create an Image for a Cloud Instance from available Images. Note that ImageID can be used as parameter instead of ImageName.

pcloud compute images create <ImageName> [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

• pcloud compute images - Image management commands

11.3 - pcloud compute images delete

Delete Images

Synopsis

Delete Images from a Cloud. Several Images can be deleted at the same time. Note that ImageID can be used as parameter instead of ImageName.

pcloud compute images delete <ImageName> [<ImageName> ...] [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

• pcloud compute images - Image management commands

11.4 - pcloud compute images describe

Describe Image

Synopsis

Describe with details, either one Image available for all Clouds, or one Image of a particular Cloud. Note that ImageID can be used as parameter instead of ImageName. Output format depends on –format option.

pcloud compute images describe <ImageName> [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

• pcloud compute images - Image management commands

11.5 - pcloud compute images export

Export a deployable Image

Synopsis

Export a deployable Image. Note that ImageID can be used as parameter instead of ImageName.

pcloud compute images export <ImageName> --bucketname <Bucket> --accesskey <AccessKey> --secretkey <SecretKey> [flags]

Options

  -a, --accesskey string    Cloud Storage Access Key (required)
  -b, --bucketname string   Cloud Storage Bucket (bucket name plus optional folders): bucket-name[/folder/../..] (required)
  -h, --help                help for export
  -s, --secretkey string    Cloud Storage Secret Key (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

• pcloud compute images - Image management commands

11.6 - pcloud compute images import

Import a new Image for a Cloud Instance

Synopsis

Import a new Image for a Cloud Instance.

pcloud compute images import <ImageName> --bucketname <Bucket> --filename <ImageFileName> --accesskey <AccessKey> --secretkey <SecretKey> [flags]

Options

  -a, --accesskey string     Cloud Storage Access Key (required)
  -b, --bucketname string    Cloud Storage Bucket (bucket name plus optional folders): bucket-name[/folder/../] (required)
  -f, --filename string      Cloud Storage Image File Name, should end with .ova, .ova.gz, .tar, .tar.gz or .tgz (required)
  -h, --help                 help for import
  -s, --secretkey string     Cloud Storage Secret Key (required)
  -T, --storagetype string   Storage type for imported image (default value set).
                             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 and the default storage type for your cloud by running the "running the "pcloud compute clouds describe <cloudID>" command.
  -k, --taskID               Display the taskID of the command to follow the progression

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

• pcloud compute images - Image management commands

11.7 - pcloud compute images list

List Images

Synopsis

List Images in the Cloud Instance. With –available, list available Images in the Power Cloud Public Repository. Images details are displayed with –long option. Images can be filtered out with –filter option. Output format depends on –format option.

pcloud compute images list [flags]

Options

  -a, --available       List available images to copy into Cloud Instance
  -f, --filter string   Set search filter.
                        Filters can be any boolean expression built on Image attributes from this list:
                        "CreationDate ImageID LastUpdateDate Name Servers Size State StoragePool StorageType Volumes Architecture ContainerFormat DiskFormat Endianness ImageType OperatingSystem"
  -h, --help            help for list
  -l, --long            Print detailed info of each Image

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

• pcloud compute images - Image management commands

12 - Compute Instances

12.1 - pcloud compute instances

VM Instances management commands

Synopsis

VM Instances management commands. Possibility to create, list, describe, update, delete a VM Instance. Possibility to attach, detach a Volume to/from a VM Instance. Possibility to attach, detach a Network to/from a VM Instance. Possibility to start, stop, reboot, shutdown, reset VM Instance(s). Possibility to capture a VM Instance.

pcloud compute instances [flags]

Options

  -h, --help   help for instances

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

• pcloud compute - pcloud compute
• pcloud compute instances attach-network - Attach a Network to a VM Instance
• pcloud compute instances attach-volume - Attach volumes to a VM Instance
• pcloud compute instances capture - Capture a VM Instance and create a deployable Image
• pcloud compute instances clone - Clone a VM Instance
• pcloud compute instances console - Get Console URL of VM Instance
• pcloud compute instances create - Create a VM Instance
• pcloud compute instances delete - Delete VM Instances
• pcloud compute instances describe - Describe VM Instance
• pcloud compute instances detach-network - Detach a Network from a VM Instance
• pcloud compute instances detach-volume - Detach Volumes from a VM Instance
• pcloud compute instances dumprestart - Dump Restart VM Instances (dumprestart)
• pcloud compute instances list - List VM Instances
• pcloud compute instances reboot - Reboot VM Instances (soft-reboot by default)
• pcloud compute instances reset - Reset the state of VM Instances (reset-state)
• pcloud compute instances shutdown - Shutdown VM Instances (immediate-shutdown)
• pcloud compute instances start - Start VM Instances
• pcloud compute instances stop - Stop VM Instances
• pcloud compute instances update - Update a VM Instance

12.2 - pcloud compute instances attach-network

Attach a Network to a VM Instance

Synopsis

Attach a Network to a VM Instance in IBM Power Cloud. Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances attach-network <InstanceName> --network <NetworkName[:IPAddress]> [flags]

Options

  -h, --help             help for attach-network
  -n, --network string   Network to attach to the VM Instance (value must follow the <NetworkName[:IPAddress]> form, note that 'NetworkID' can be provided instead of 'NetworkName', 'IPAddress' is optional) (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

• pcloud compute instances - VM Instances management commands

12.3 - pcloud compute instances attach-volume

Attach volumes to a VM Instance

Synopsis

Attach volumes to a VM Instance in IBM Power Cloud. Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances attach-volume <InstanceName> --volume <VolumeID> (several --volume allowed) [flags]

Options

  -h, --help             help for attach-volume
  -v, --volume strings   Volume to attach to the VM Instance (note that 'VolumeName' or 'VolumeID' can be used. Several --volume allowed) (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

• pcloud compute instances - VM Instances management commands

12.4 - pcloud compute instances capture

Capture a VM Instance and create a deployable Image

Synopsis

Capture a VM Instance and create a deployable Image. Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances capture <InstanceName> --destination image-catalog --name <ImageName>
  pcloud compute instances capture <InstanceName> --destination [cloud-storage|both] --name <ImageName> --bucketname <Bucket> --accesskey <AccessKey> --secretkey <SecretKey> [flags]

Options

  -a, --accesskey string     Cloud Storage Access Key
  -b, --bucketname string    Cloud Storage Bucket (bucket name plus optional folders): bucket-name[/folder/../..]
  -d, --destination string   Destination for the Deployable Image (must be one of {'image-catalog', 'cloud-storage', 'both'}) (required)
  -h, --help                 help for capture
  -n, --name string          Name for the Deployable Image created from the Captured Instance (required)
  -s, --secretkey string     Cloud Storage Secret Key
  -k, --taskID               Display the taskID of the command to follow the progression
  -v, --volume strings       Data volumes you want to include in the capture (several --volume allowed, note that 'VolumeID' or 'VolumeName' can be used, optional).

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

• pcloud compute instances - VM Instances management commands

12.5 - pcloud compute instances clone

Clone a VM Instance

Synopsis

Clone a VM Instance

pcloud compute instances clone <InstanceID> <CloneName> [options] [flags]

Options

  -c, --cores float       Number of cores to allocate to the VM Instance (default 2)
  -h, --help              help for clone
  -k, --keypair string    SSHKeyPair Name
  -l, --license strings   Software Licenses (several --license allowed, must be one of "IbmiCSS", "IbmiDBQ", "IbmiPHA", "IbmiRDS")
  -m, --memory float      Memory size (in GB) to allocate to the VM Instance (default 4)
  -n, --network strings   Networks to assign to the VM Instance, (values must follow the <NetworkName[:IPAddress]> form, note that 'NetworkID' can be provided instead of 'NetworkName', 'IPAddress' is optional, several --network allowed) (required)
  -t, --proctype string   Dedicated, Shared or Capped Processing Type (must be one of {"dedicated", "shared", "capped"}) (default "dedicated")
  -d, --rdsUsers int      Number of IbmiRDS license users (Required if "IbmiRDS" license is specified)
  -v, --volume strings    Volumes to assign to the VM Instance (several --volume allowed, note that 'VolumeID' or 'VolumeName' can be used)

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

• pcloud compute instances - VM Instances management commands

12.6 - pcloud compute instances console

Get Console URL of VM Instance

Synopsis

Get Console URL of VM Instance in IBM Power Cloud.

To initially access a VM Instance, you can use the “pcloud compute instances console ” subcommand. This subcommand generates a url that can be used in your web browser to access the console of the VM.

Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances console <InstanceName> [flags]

Options

  -h, --help   help for console

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

• pcloud compute instances - VM Instances management commands

12.7 - pcloud compute instances create

Create a VM Instance

Synopsis

Create a VM Instance

Most of the flags have default values, but you must enter the VM name to be created, and mandatory image and network names.

You can list the images of your Cloud by running:

pcloud compute images list

You can list the available networks by running

pcloud compute  networks list

You can list the system types available to your cloud by running

pcloud compute clouds syspools

Creating a new VM instance can take a few minutes to fully complete. You can look at the state of the VM by running

 pcloud compute instances describe

pcloud compute instances create <InstanceName> --image <ImageName> --network <NetworkName[:IPAddress]> [flags]

Options

  -a, --affinityPolicy string   Affinity policy for replicants being created (must be one of {"affinity", "anti-affinity", "none"}) (default "none")
  -c, --cores float             Number of cores to allocate to the VM Instance (default 2)
  -h, --help                    help for create
  -i, --image string            Image to allocate to the VM Instance (note that 'ImageID' or 'ImageName' can be used) (required)
  -k, --keypair string          SSHKeyPair Name
  -l, --license strings         Software Licenses (several --license allowed, must be one of "IbmiCSS", "IbmiDBQ", "IbmiPHA", "IbmiRDS")
  -m, --memory float            Memory size (in GB) to allocate to the VM Instance (default 4)
  -s, --namingScheme string     Replicants naming scheme (must be one of {"prefix", "suffix"}) (default "suffix")
  -n, --network strings         Networks to assign to the VM Instance, (values must follow the <NetworkName[:IPAddress]> form, note that 'NetworkID' can be provided instead of 'NetworkName', 'IPAddress' is optional, several --network allowed) (required)
  -P, --pinPolicy string        VM pinning policy (must be one of {"none", "soft", "hard"}) (default "none")
  -g, --placementGroup string   Placement group for VM.
  -t, --proctype string         Dedicated, Shared or Capped Processing Type (must be one of {"dedicated", "shared", "capped"}) (default "dedicated")
  -d, --rdsUsers int            Number of IbmiRDS license users (Required if "IbmiRDS" license is specified)
  -r, --replicants float        Number of replicants (default 1)
  -T, --storagetype string      Storage type for VMInstance deployment (required only if image is a "stock" image - default value set).
                                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 and the default storage type for your cloud by running the "pcloud compute clouds describe" command.
  -S, --systype string          System type. See note above. (default "s922")
  -u, --userdata string         Cloud-init user defined data file (optional, if necessary data are uuencoded before being sent)
  -v, --volume strings          Volumes to assign to the VM Instance (several --volume allowed, note that 'VolumeID' or 'VolumeName' can be used)

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

• pcloud compute instances - VM Instances management commands

12.8 - pcloud compute instances delete

Delete VM Instances

Synopsis

Delete VM Instances from a Cloud. Several VM Instances can be deleted at the same time. Attached volumes can be deleted along with the VM instances by using withvolumes flag. Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances delete <InstanceName> [<InstanceName> ...] [flags]

Options

  -f, --force         Skip pre-deletion instance checks, implies -q
  -h, --help          help for delete
  -q, --quiet         Quiet deletion (no confirmation is required)
  -v, --withvolumes   Delete attached volumes when deleting the VM Instances

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

• pcloud compute instances - VM Instances management commands

12.9 - pcloud compute instances describe

Describe VM Instance

Synopsis

Describe VM Instance with details. Output format depends on –format option. Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances describe <InstanceName> [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

• pcloud compute instances - VM Instances management commands

12.10 - pcloud compute instances detach-network

Detach a Network from a VM Instance

Synopsis

Detach a Network from a VM Instance in IBM Power Cloud. If “macAddress” is not specified, then a confirmation is asked to the user to verify that all attachments for that given network can be detached. If “macAddress” is specified, only that single attachment is detached from the given network (no confirmation is required). Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances detach-network <InstanceName> --network <NetworkName> [flags]

Options

  -h, --help                help for detach-network
  -m, --macAddress string   MAC address to detach (optional). If no MAC address is provided, all attachments of the Network are detached after user confirmation
  -n, --network string      Network to detach from the VM Instance (note that 'NetworkName' or 'NetworkID' can be used) (required)
  -q, --quiet               Quiet detach (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

• pcloud compute instances - VM Instances management commands

12.11 - pcloud compute instances detach-volume

Detach Volumes from a VM Instance

Synopsis

Detach Volumes from a VM Instance in IBM Power Cloud. Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances detach-volume <InstanceName> --volume <VolumeName> (several --volume allowed) [flags]

Options

  -h, --help             help for detach-volume
  -v, --volume strings   Volume to detach from the VM Instance (note that 'VolumeName' or 'VolumeID' can be used. Several --volume allowed) (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

• pcloud compute instances - VM Instances management commands

12.12 - pcloud compute instances dumprestart

Dump Restart VM Instances (dumprestart)

Synopsis

Dump restart VM Instances in the IBM Power Cloud (dumprestart). Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances dumprestart <InstanceName> [<InstanceName> ...] [flags]

Options

  -h, --help    help for dumprestart
  -q, --quiet   Quiet shutdown (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

• pcloud compute instances - VM Instances management commands

12.13 - pcloud compute instances list

List VM Instances

Synopsis

List VM Instances of Cloud Instance. VM Instances details are displayed with –long option. VM Instances can be filtered out with –filter option. Output format depends on –format option.

pcloud compute instances list [flags]

Options

  -f, --filter string    Set search filter.
                         Filters can be any boolean expression built on VM Instance attributes from this list:
                         "ConsoleLanguage HostID ImageID LicenseRepositoryCapacity Memory Migratable NetworkIDs OperatingSystem OsType PinPolicy PlacementGroup ProcType Processors PvmInstanceID SapProfile ServerName SoftwareLicenses Srcs Status StoragePool StoragePoolAffinity StorageType TaskState VirtualCores VolumeIDs"
  -h, --help             help for list
  -l, --long             Print detailed info of each VM Instance
  -r, --resource-usage   Display core and memory information

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

• pcloud compute instances - VM Instances management commands

12.14 - pcloud compute instances reboot

Reboot VM Instances (soft-reboot by default)

Synopsis

Reboot VM Instances in the IBM Power Cloud (soft-reboot by default). Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances reboot <InstanceName> [<InstanceName> ...] [flags]

Options

  -r, --hard    Reboot VM Instances with hard-reboot
  -h, --help    help for reboot
  -q, --quiet   Quiet reboot (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

• pcloud compute instances - VM Instances management commands

12.15 - pcloud compute instances reset

Reset the state of VM Instances (reset-state)

Synopsis

Reset the state of VM Instances in the IBM Power Cloud (reset-state). Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances reset <InstanceName> [<InstanceName> ...] [flags]

Options

  -h, --help    help for reset
  -q, --quiet   Quiet reset (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

• pcloud compute instances - VM Instances management commands

12.16 - pcloud compute instances shutdown

Shutdown VM Instances (immediate-shutdown)

Synopsis

Shutdown VM Instances in the IBM Power Cloud (immediate-shutdown). Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances shutdown <InstanceName> [<InstanceName> ...] [flags]

Options

  -h, --help    help for shutdown
  -q, --quiet   Quiet shutdown (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

• pcloud compute instances - VM Instances management commands

12.17 - pcloud compute instances start

Start VM Instances

Synopsis

Start VM Instances in the IBM Power Cloud. Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances start <InstanceName> [<InstanceName> ...] [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

• pcloud compute instances - VM Instances management commands

12.18 - pcloud compute instances stop

Stop VM Instances

Synopsis

Stop VM Instances in the IBM Power Cloud. Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances stop <InstanceName> [<InstanceName> ...] [flags]

Options

  -h, --help    help for stop
  -q, --quiet   Quiet stop (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

• pcloud compute instances - VM Instances management commands

12.19 - pcloud compute instances update

Update a VM Instance

Synopsis

Update a VM Instance in IBM Power Cloud. Note that InstanceID can be used as parameter instead of InstanceName.

pcloud compute instances update <InstanceName> [flags]

Options

  -c, --cores float        New number of cores to allocate to the VM instance
  -h, --help               help for update
  -l, --license strings    Software Licenses (several --license allowed, must be one of "IbmiCSS", "IbmiDBQ", "IbmiPHA", "IbmiRDS")
  -m, --memory float       New memory size (in GB) to allocate to the VM instance
  -n, --name string        New name of the VM Instance
  -P, --pinPolicy string   New VM pinning policy (must be one of {"none", "soft", "hard"})
  -t, --proctype string    New Processing Type (must be one of {"dedicated", "shared", "capped"})
  -d, --rdsUsers int       Number of IbmiRDS license users (Required if "IbmiRDS" license is specified)

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

• pcloud compute instances - VM Instances management commands

13 - Compute Networks

13.1 - pcloud compute networks

Network management commands

Synopsis

Network management commands. Possibility to create, describe, list, update, delete Network(s).

pcloud compute networks [flags]

Options

  -h, --help   help for networks

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

• pcloud compute - pcloud compute
• pcloud compute networks create - Create a Network
• pcloud compute networks delete - Delete Networks
• pcloud compute networks describe - Describe Network
• pcloud compute networks list - List Networks
• pcloud compute networks ports - Network port commands
• pcloud compute networks update - Update a Network

13.2 - pcloud compute networks create

Create a Network

Synopsis

Create a Network for a Cloud.

pcloud compute networks create <NetworkName> --cidr <CIDR> --range <startIP-endIP[,startIP-endIP]> [flags]

Options

  -c, --cidr string      Network in CIDR notation (192.168.0.0/24) (required)
  -d, --dns strings      DNS Server (several --dns allowed)
  -g, --gateway string   Gateway
  -h, --help             help for create
  -r, --range string     IP address ranges, format: startIP-endIP[,startIP-endIP] (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

• pcloud compute networks - Network management commands

13.3 - pcloud compute networks delete

Delete Networks

Synopsis

Delete Networks from a Cloud. Several Networks can be deleted at the same time. Note that NetworkID can be used as parameter instead of NetworkName.

pcloud compute networks delete <NetworkName> [<NetworkName> ...] [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

• pcloud compute networks - Network management commands

13.4 - pcloud compute networks describe

Describe Network

Synopsis

Describe Network with details. Output format depends on –format option. Note that NetworkID can be used as parameter instead of NetworkName.

pcloud compute networks describe <NetworkName> [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

• pcloud compute networks - Network management commands

13.5 - pcloud compute networks list

List Networks

Synopsis

List Networks of Cloud Instance. Networks details are displayed with –long option. Networks can be filtered out with –filter option. Output format depends on –format option.

pcloud compute networks list [flags]

Options

  -f, --filter string   Set search filter.
                        Filters can be any boolean expression built on Network attributes from this list:
                        "Cidr CloudConnections DhcpManaged DNSServers Gateway IPAddressMetrics IPAddressRanges Jumbo Name NetworkID PublicIPAddressRanges Type VlanID"
  -h, --help            help for list
  -l, --long            Print detailed info of each Network

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

• pcloud compute networks - Network management commands

13.6 - pcloud compute networks ports

Network port commands

Synopsis

Network port commands. Actions include creating, describing, listing, updating, and deleting ports.

pcloud compute networks ports [flags]

Options

  -h, --help    help for ports
  -q, --quiet   Delete without confirmation

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

• pcloud compute networks - Network management commands
• pcloud compute networks ports attach - Attach network port
• pcloud compute networks ports create - Create network port
• pcloud compute networks ports delete - Delete network port
• pcloud compute networks ports describe - Describe network ports
• pcloud compute networks ports detach - Detach network port
• pcloud compute networks ports list - List network ports
• pcloud compute networks ports update - Update network port

13.7 - pcloud compute networks ports attach

Attach network port

Synopsis

Attach network port.

pcloud compute networks ports attach <net-name> <port-id> --instance <instance-id> [flags]

Options

  -h, --help              help for attach
  -i, --instance string   Instance ID

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

• pcloud compute networks ports - Network port commands

13.8 - pcloud compute networks ports create

Create network port

Synopsis

Create network port.

pcloud compute networks ports create <net-id> [-d <description>] [-i <ip address>] [flags]

Options

  -d, --description string   Port Description
  -h, --help                 help for create
  -i, --ipAddress string     IP Address

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

• pcloud compute networks ports - Network port commands

13.9 - pcloud compute networks ports delete

Delete network port

Synopsis

Delete network port

pcloud compute networks ports delete [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

• pcloud compute networks ports - Network port commands

13.10 - pcloud compute networks ports describe

Describe network ports

Synopsis

Describe network ports.

pcloud compute networks ports describe <net-id> <port-id> [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

• pcloud compute networks ports - Network port commands

13.11 - pcloud compute networks ports detach

Detach network port

Synopsis

Detach network port.

pcloud compute networks ports detach <net-id> <port-id> [flags]

Options

  -h, --help   help for detach

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

• pcloud compute networks ports - Network port commands

13.12 - pcloud compute networks ports list

List network ports

Synopsis

List network ports.

pcloud compute networks ports list <net-id> [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

• pcloud compute networks ports - Network port commands

13.13 - pcloud compute networks ports update

Update network port

Synopsis

Update network port.

pcloud compute networks ports update <net-id> <port-id> -d <description> [flags]

Options

  -d, --description string   Port Description
  -h, --help                 help for update

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

• pcloud compute networks ports - Network port commands

13.14 - pcloud compute networks update

Update a Network

Synopsis

Update a Network for a Cloud. Note that NetworkID can be used as parameter instead of NetworkName.

pcloud compute networks update <NetworkName> [flags]

Options

  -d, --dns strings      DNS Server (several --dns allowed)
  -g, --gateway string   Gateway
  -h, --help             help for update
  -n, --name string      New name of network
  -r, --range string     IP address ranges, format: startIP-endIP[,startIP-endIP]

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

• pcloud compute networks - Network management commands

14 - Compute Pgroups

14.1 - pcloud compute pgroups

Placement Groups management commands

Synopsis

Placement Group management commands.

PGroups may be created, deleted, listed, and described. PVM Instances may be added to or removed from PGroups.

pcloud compute pgroups [flags]

Options

  -h, --help   help for pgroups

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

• pcloud compute - pcloud compute
• pcloud compute pgroups add - Add Instance to Placement Group
• pcloud compute pgroups create - Create Placement Group
• pcloud compute pgroups delete - Delete Placement Group
• pcloud compute pgroups describe - Describe Placement Group
• pcloud compute pgroups list - List Placement Groups
• pcloud compute pgroups remove - Remove Instance from Placement Group

14.2 - pcloud compute pgroups add

Add Instance to Placement Group

Synopsis

Add a PVM Instance to a Placement Group.

pcloud compute pgroups add <PGroup> <Instance> [flags]

Options

  -h, --help   help for add

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

• pcloud compute pgroups - Placement Groups management commands

14.3 - pcloud compute pgroups create

Create Placement Group

Synopsis

Create a new Placement Group.

Must specify the PGroup name and one of ‘affinity’ or ‘anti-affinity’.

pcloud compute pgroups create <PGroup> <affinity|anti-affinity> [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

• pcloud compute pgroups - Placement Groups management commands

14.4 - pcloud compute pgroups delete

Delete Placement Group

Synopsis

Delete a Placement Group.

pcloud compute pgroups delete <PGroup> [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

• pcloud compute pgroups - Placement Groups management commands

14.5 - pcloud compute pgroups describe

Describe Placement Group

Synopsis

Describe a Placement Group.

pcloud compute pgroups describe <PGroup> [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

• pcloud compute pgroups - Placement Groups management commands

14.6 - pcloud compute pgroups list

List Placement Groups

Synopsis

List Placement Groups int he Cloud Instance.

Output format depends on –format option.

pcloud compute pgroups 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

• pcloud compute pgroups - Placement Groups management commands

14.7 - pcloud compute pgroups remove

Remove Instance from Placement Group

Synopsis

Remove a PVM Instance from a Placement Group.

pcloud compute pgroups remove <PGroup> <Instance> [flags]

Options

  -h, --help   help for remove

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

• pcloud compute pgroups - Placement Groups management commands

15 - Compute Snapshots

15.1 - pcloud compute snapshots

Snapshot management comamnds

Synopsis

Snapshot management commands

pcloud compute snapshots [flags]

Options

  -h, --help   help for snapshots

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

• pcloud compute - pcloud compute
• pcloud compute snapshots create - Create Snapshot
• pcloud compute snapshots delete - Delete Snapshot
• pcloud compute snapshots describe - Describe Snapshot
• pcloud compute snapshots list - List Snapshots
• pcloud compute snapshots restore - Restore Snapshot
• pcloud compute snapshots update - Update Snapshot

15.2 - pcloud compute snapshots create

Create Snapshot

Synopsis

Create Snapshot

pcloud compute snapshots create <SnapshotName> <InstanceID> [--description] [--volume] [flags]

Options

  -d, --description string   description
  -h, --help                 help for create
  -v, --volume stringArray   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

• pcloud compute snapshots - Snapshot management comamnds

15.3 - pcloud compute snapshots delete

Delete Snapshot

Synopsis

Delete Snapshot

pcloud compute snapshots delete <SnapshotID> [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

• pcloud compute snapshots - Snapshot management comamnds

15.4 - pcloud compute snapshots describe

Describe Snapshot

Synopsis

Describe Snapshot

pcloud compute snapshots describe <SnapshotID> [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

• pcloud compute snapshots - Snapshot management comamnds

15.5 - pcloud compute snapshots list

List Snapshots

Synopsis

List Snapshots

pcloud compute snapshots list [--long] [--instance=<InstanceID>] [flags]

Options

  -h, --help              help for list
  -i, --instance string   only instance snapshots
  -l, --long              show detailed report

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

• pcloud compute snapshots - Snapshot management comamnds

15.6 - pcloud compute snapshots restore

Restore Snapshot

Synopsis

Restore Snapshot

pcloud compute snapshots restore SnapshotID InstanceID [--force] [flags]

Options

  -f, --force   force restore
  -h, --help    help for restore

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

• pcloud compute snapshots - Snapshot management comamnds

15.7 - pcloud compute snapshots update

Update Snapshot

Synopsis

Update Snapshot

pcloud compute snapshots update [flags]

Options

  -d, --description string   new snapshot description
  -h, --help                 help for update
  -n, --name string          new snapshot name

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

• pcloud compute snapshots - Snapshot management comamnds

16 - Compute Sshkeys

16.1 - pcloud compute sshkeys

SSH Keys management commands

Synopsis

SSH Keys management commands. Possibility to create, list, describe, update, delete SSH Key(s). One SSH Key can be associated to a VM Instance at VM instance creation time.

Options

  -h, --help   help for sshkeys

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

• pcloud compute - pcloud compute
• pcloud compute sshkeys create - Create a SSH Key
• pcloud compute sshkeys delete - Delete SSH Keys
• pcloud compute sshkeys describe - Describe SSH Key
• pcloud compute sshkeys list - List SSH Keys
• pcloud compute sshkeys update - Update a SSH Key

16.2 - pcloud compute sshkeys create

Create a SSH Key

Synopsis

Create a SSH Key. SSH Key can be created without SSH public key, which can be added later on.

pcloud compute sshkeys create <SSHKeyName> [flags]

Options

  -h, --help               help for create
  -p, --publickey string   SSH public key

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

• pcloud compute sshkeys - SSH Keys management commands

16.3 - pcloud compute sshkeys delete

Delete SSH Keys

Synopsis

Delete SSH Keys. Several SSH Keys can be deleted at the same time.

pcloud compute sshkeys delete <SSHKeyName> [<SSHKeyName> ...] [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

• pcloud compute sshkeys - SSH Keys management commands

16.4 - pcloud compute sshkeys describe

Describe SSH Key

Synopsis

Describe SSH Key with details. Output format depends on –format option.

pcloud compute sshkeys describe <SSHKeyName> [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

• pcloud compute sshkeys - SSH Keys management commands

16.5 - pcloud compute sshkeys list

List SSH Keys

Synopsis

List SSH Keys with details. Output format depends on –format option.

pcloud compute sshkeys list [flags]

Options

  -h, --help   help for list
  -l, --long   Print detailed info of each SSHKey

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

• pcloud compute sshkeys - SSH Keys management commands

16.6 - pcloud compute sshkeys update

Update a SSH Key

Synopsis

Update a SSH Key’s name or public key.

pcloud compute sshkeys update <SSHKeyName> [flags]

Options

  -h, --help               help for update
  -k, --keyname string     new SSH Key Name
  -p, --publickey string   New SSH public key

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

• pcloud compute sshkeys - SSH Keys management commands

17 - Compute Volume-Groups

17.1 - pcloud compute volume-groups

Volume group commands

Synopsis

Volume group commands

pcloud compute volume-groups [flags]

Options

  -h, --help   help for volume-groups

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

• pcloud compute - pcloud compute
• pcloud compute volume-groups add-volumes - add volume(s) to group
• pcloud compute volume-groups create - create volume group
• pcloud compute volume-groups delete - delete volume group
• pcloud compute volume-groups describe - show the volume groups
• pcloud compute volume-groups list - List volume groups
• pcloud compute volume-groups relationship - show remote copy relationship
• pcloud compute volume-groups remove-volumes - remove volume(s) from group
• pcloud compute volume-groups reset - reset replication in the group
• pcloud compute volume-groups start - start replication in the group
• pcloud compute volume-groups stop - stop replication in the group

17.2 - pcloud compute volume-groups add-volumes

add volume(s) to group

Synopsis

add volume(s) to group

pcloud compute volume-groups add-volumes <volume-group> --volume=<volume> [--volume=<volume>] [flags]

Options

  -h, --help                 help for add-volumes
  -v, --volume stringArray   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

• pcloud compute volume-groups - Volume group commands

17.3 - pcloud compute volume-groups create

create volume group

Synopsis

create volume group

pcloud compute volume-groups create --name <name> --description <description> --volume <volume-id> [flags]

Options

  -d, --description string   Description
  -h, --help                 help for create
  -n, --name string          Name
  -v, --volume stringArray   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

• pcloud compute volume-groups - Volume group commands

17.4 - pcloud compute volume-groups delete

delete volume group

Synopsis

delete volume group

pcloud compute volume-groups delete <volume group> [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

• pcloud compute volume-groups - Volume group commands

17.5 - pcloud compute volume-groups describe

show the volume groups

Synopsis

show the volume groups

pcloud compute volume-groups describe usage [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

• pcloud compute volume-groups - Volume group commands

17.6 - pcloud compute volume-groups list

List volume groups

Synopsis

List volume groups

pcloud compute volume-groups 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

• pcloud compute volume-groups - Volume group commands

17.7 - pcloud compute volume-groups relationship

show remote copy relationship

Synopsis

show remote copy relationship

pcloud compute volume-groups relationship <group-id> [--secondary] [flags]

Options

  -h, --help        help for relationship
  -s, --secondary   show secondary 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

• pcloud compute volume-groups - Volume group commands

17.8 - pcloud compute volume-groups remove-volumes

remove volume(s) from group

Synopsis

remove volume(s) from group

pcloud compute volume-groups remove-volumes <volume-group> --volume-<volume> [--volume=<volume>] [flags]

Options

  -h, --help                 help for remove-volumes
  -v, --volume stringArray   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

• pcloud compute volume-groups - Volume group commands

17.9 - pcloud compute volume-groups reset

reset replication in the group

Synopsis

reset replication in the group

pcloud compute volume-groups reset <group-id> [--quiet] [flags]

Options

  -h, --help    help for reset
  -q, --quiet   do not prompt for confirmation

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

• pcloud compute volume-groups - Volume group commands

17.10 - pcloud compute volume-groups start

start replication in the group

Synopsis

start replication in the group

pcloud compute volume-groups start <group-id> <master|aux> [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

• pcloud compute volume-groups - Volume group commands

17.11 - pcloud compute volume-groups stop

stop replication in the group

Synopsis

stop replication in the group

pcloud compute volume-groups stop <group-id> [--allow-read-access] [flags]

Options

  -a, --allow-read-access   allow read access
  -h, --help                help for stop

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

• pcloud compute volume-groups - Volume group commands

18 - Compute Volumes

18.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

• pcloud compute - pcloud compute
• pcloud compute volumes clones - Clone Management Commands
• pcloud compute volumes create - Create Volumes
• pcloud compute volumes delete - Delete Volumes
• pcloud compute volumes describe - Describe Volume
• pcloud compute volumes list - List Volumes
• pcloud compute volumes list-pools - List Volume Pools
• pcloud compute volumes replication - volume replication commands
• pcloud compute volumes transfer - Volume Transfer Commands
• pcloud compute volumes update - Update a Volume

18.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

• pcloud compute volumes - Volume management commands
• pcloud compute volumes clones cancel - Cancel a Volume Clone
• pcloud compute volumes clones create - Create Clone
• pcloud compute volumes clones delete - Delete Clone
• pcloud compute volumes clones describe - Describe a Volume Clone Request
• pcloud compute volumes clones execute - Initiate Volume Clone Execute
• pcloud compute volumes clones list - List Clone Requests
• pcloud compute volumes clones new - Prepare Clone Request
• pcloud compute volumes clones start - Initiate The Volume Clone Start
• pcloud compute volumes clones status - Get Clone Task Status

18.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

• pcloud compute volumes clones - Clone Management Commands

18.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

• pcloud compute volumes clones - Clone Management Commands

18.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

• pcloud compute volumes clones - Clone Management Commands

18.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

• pcloud compute volumes clones - Clone Management Commands

18.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

• pcloud compute volumes clones - Clone Management Commands

18.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

• pcloud compute volumes clones - Clone Management Commands

18.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

• pcloud compute volumes clones - Clone Management Commands

18.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

• pcloud compute volumes clones - Clone Management Commands

18.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

• pcloud compute volumes clones - Clone Management Commands

18.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

• pcloud compute volumes - Volume management commands

18.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

• pcloud compute volumes - Volume management commands

18.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

• pcloud compute volumes - Volume management commands

18.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

• pcloud compute volumes - Volume management commands

18.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

• pcloud compute volumes - Volume management commands

18.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

• pcloud compute volumes - Volume management commands
• pcloud compute volumes replication disable - disable replication on a volume
• pcloud compute volumes replication enable - enable replication on a volume
• pcloud compute volumes replication onboard - onboard aux volumes

18.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

• pcloud compute volumes replication - volume replication commands

18.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

• pcloud compute volumes replication - volume replication commands

18.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

• pcloud compute volumes replication - volume replication commands

18.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

• pcloud compute volumes - Volume management commands
• pcloud compute volumes transfer accept - Accept a volume transfer
• pcloud compute volumes transfer create - Volume Transfer Create
• pcloud compute volumes transfer delete - Delete a volume transfer
• pcloud compute volumes transfer describe - Describe volume transfer
• pcloud compute volumes transfer list - Volume transfer list

18.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

• pcloud compute volumes transfer - Volume Transfer Commands

18.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

• pcloud compute volumes transfer - Volume Transfer Commands

18.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

• pcloud compute volumes transfer - Volume Transfer Commands

18.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

• pcloud compute volumes transfer - Volume Transfer Commands

18.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

• pcloud compute volumes transfer - Volume Transfer Commands

18.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

• pcloud compute volumes - Volume management commands