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

Return to the regular view of this page.

Compute Instances

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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