| copyright |
|
||
|---|---|---|---|
| lastupdated | 2026-06-24 | ||
| content-type | cli-docs |
{{site.data.keyword.attribute-definition-list}}
{: #power-iaas-cli-on-prem}
{{site.data.keyword.on-prem-fname}} in [{{site.data.keyword.on-prem}}]{: tag-red}
The following list of commands are available with command-line interface (CLI) for IBM {{site.data.keyword.powerSys_notm}} in {{site.data.keyword.on-prem}}.
{: #ibmcloud-pi}
Alias: pi
Description: Manage IBM Cloud Power Virtual Server service.
Usage: pi
Available Commands:
datacenter: IBM Cloud Power Virtual Server Datacenters.disaster-recovery: List disaster recovery locations for the current region or all regions.image: IBM Cloud Power Virtual Server Images.instance: IBM Cloud Power Virtual Server Instances.job: IBM Cloud Power Virtual Server Jobs.network-peer: IBM Cloud Power Virtual Server Network Peers.placement-group: IBM Cloud Power Virtual Server Placement Groups.route: IBM Cloud Power Virtual Server Network Routes.shared-processor-pool: IBM Cloud Power Virtual Server Shared Processor Pools.snapshot: [DEPRECATED] IBM Cloud Power Virtual Server Snapshots.ssh-key: IBM Cloud Power Virtual Server SSH-Keys.storage-pools: List all storage pools for the targeted region.storage-tiers: List all storage tiers for the targeted region.subnet: IBM Cloud Power Virtual Server Subnets.virtual-serial-number: IBM Cloud Power Virtual Server Virtual Serial Number.volume: IBM Cloud Power Virtual Server Volumes.volume-group: IBM Cloud Power Virtual Server Volume Groups.workspace: IBM Cloud Power Virtual Server Workspaces.
{: #ibmcloud-pi-datacenter}
Alias: datacenter, dat
Description: IBM Cloud Power Virtual Server Datacenters.
Usage: datacenter
Available Commands:
get: View details of a datacenter.list: List all datacenter details.
{: #ibmcloud-pi-datacenter-get}
Alias: get
Description: View details of a datacenter.
Usage:
get DATACENTER [--private=True|False]
DATACENTER: The name of the datacenter.Available Options:
-p, --private Retrieve additional details about a private datacenter that you own.
Required if getting information from a private/on-prem datacenter.{: #ibmcloud-pi-datacenter-list}
Alias: list, ls
Description: List all datacenter details.
Usage: list [--long=True|False] [--private=True|False]
Available Options:
-l, --long Retrieve additional details for datacenters.
-p, --private Retrieve additional details for private datacenters that you own.{: #ibmcloud-pi-disaster-recovery}
Alias: disaster-recovery, drl
Description: List disaster recovery locations for the current region or all regions.
Usage: disaster-recovery [--all-regions=True|False]
Available Options:
-a, --all-regions List disaster recovery locations for all regions.{: #ibmcloud-pi-image}
Alias: image, img
Description: IBM Cloud Power Virtual Server Images.
Usage: image
Available Commands:
create: Create a copy of an available stock image into this account; stock image names cannot be changed.delete: Delete an image.export: Export an image to IBM Cloud Object Storage.export-show: View details of the last image export job.get: View details of an image.import: Import an image from IBM Cloud Object Storage.import-show: View details of the last image import job.list: List all images in a workspace.list-catalog: List images available in the regional image catalog.
{: #ibmcloud-pi-image-create}
Alias: create, cr
Description: Create a copy of an available stock image into this account; stock image names cannot be changed.
Usage:
create IMAGE_ID [--user-tags USER_TAG1[,USER_TAGn]]
IMAGE_ID: The unique identifier or name of the image.Available Options:
-u, --user-tags strings Comma separated list of user tags to be attached to the created image.Examples:
ibmcloud pi image create 7100-05-05 --user-tags "project:customer-poc,env:dev,dataresidency:germany"{: #ibmcloud-pi-image-delete}
Alias: delete, del
Description: Delete an image.
Usage:
delete IMAGE_ID
IMAGE_ID: The unique identifier or name of the image.{: #ibmcloud-pi-image-export}
Alias: export, ex
Description: Export an image to IBM Cloud Object Storage.
Usage:
export IMAGE_ID --access-key KEY --bucket BUCKET_NAME --region REGION_NAME --secret-key KEY [--checksum=True|False]
IMAGE_ID: The unique identifier or name of the image.Available Options:
-a, --access-key string Cloud Object Storage HMAC access key.
-b, --bucket string Cloud Object Storage bucket name.
-c, --checksum Creates a checksum file. Default is "false".
-r, --region string Cloud Object Storage region au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
-s, --secret-key string Cloud Object Storage HMAC secret key.Examples:
ibmcloud pi image export 43064761-948f-469d-ac8e-b8e5f0d6056f --bucket "bucket/stock-images" --region us-east --access-key access-key-sample --secret-key secret-key-sample{: #ibmcloud-pi-image-export-show}
Alias: export-show, exs
Description: View details of the last image export job.
Usage:
export-show IMAGE_ID
IMAGE_ID: The unique identifier or name of the image.{: #ibmcloud-pi-image-get}
Alias: get
Description: View details of an image.
Usage:
get IMAGE_ID
IMAGE_ID: The unique identifier or name of the image.{: #ibmcloud-pi-image-import}
Alias: import, im
Description: Import an image from IBM Cloud Object Storage.
Usage:
import IMAGE_NAME [--bucket-access private] [--storage-tier STORAGE_TIER] [--os-type OSTYPE] [--import-details "LICENSE,PRODUCT,VENDOR"] [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] --access-key KEY --secret-key KEY --image-file-name IMAGE_FILE_NAME --bucket BUCKET_NAME --region REGION_NAME
pi image import IMAGE_NAME [--bucket-access private] [--storage-tier STORAGE_TIER] --storage-pool POOL [--os-type OSTYPE] [--import-details "LICENSE,PRODUCT,VENDOR"] [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] --access-key KEY --secret-key KEY --image-file-name IMAGE_FILE_NAME --bucket BUCKET_NAME --region REGION_NAME
pi image import IMAGE_NAME [--bucket-access private] [--storage-tier STORAGE_TIER] --affinity-policy affinity (--affinity-instance INSTANCE | --affinity-volume VOLUME) [--os-type OSTYPE] [--import-details "LICENSE,PRODUCT,VENDOR"] [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] --access-key KEY --secret-key KEY --image-file-name IMAGE_FILE_NAME --bucket BUCKET_NAME --region REGION_NAME
pi image import IMAGE_NAME [--bucket-access private] [--storage-tier STORAGE_TIER] --affinity-policy anti-affinity (--anti-affinity-instances "INSTANCE1 [INSTANCEn]" | --anti-affinity-volumes "VOLUME1 [VOLUMEn]") [--os-type OSTYPE] [--import-details "LICENSE,PRODUCT,VENDOR"] [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] --access-key KEY --secret-key KEY --image-file-name IMAGE_FILE_NAME --bucket BUCKET_NAME --region REGION_NAME
pi image import IMAGE_NAME --bucket-access public [--storage-tier STORAGE_TIER] [--os-type OSTYPE] [--import-details "LICENSE,PRODUCT,VENDOR"] [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] --image-file-name IMAGE_FILE_NAME --bucket BUCKET_NAME --region REGION_NAME
pi image import IMAGE_NAME --bucket-access public [--storage-tier STORAGE_TIER] --storage-pool POOL [--os-type OSTYPE] [--import-details "LICENSE,PRODUCT,VENDOR"] [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] --image-file-name IMAGE_FILE_NAME --bucket BUCKET_NAME --region REGION_NAME
pi image import IMAGE_NAME --bucket-access public [--storage-tier STORAGE_TIER] --affinity-policy affinity (--affinity-instance INSTANCE | --affinity-volume VOLUME) [--os-type OSTYPE] [--import-details "LICENSE,PRODUCT,VENDOR"] [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] --image-file-name IMAGE_FILE_NAME --bucket BUCKET_NAME --region REGION_NAME
pi image import IMAGE_NAME --bucket-access public [--storage-tier STORAGE_TIER] --affinity-policy anti-affinity (--anti-affinity-instances "INSTANCE1 [INSTANCEn]" | --anti-affinity-volumes "VOLUME1 [VOLUMEn]") [--os-type OSTYPE] [--import-details "LICENSE,PRODUCT,VENDOR"] [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] --image-file-name IMAGE_FILE_NAME --bucket BUCKET_NAME --region REGION_NAME
IMAGE_NAME: The desired name of the image.Available Options:
-k, --access-key string Cloud Object Storage HMAC access key.
-i, --affinity-instance string PVM instance identifier or name to base volume affinity policy against.
This is required if "--affinity-policy affinity" is specified and "--affinity-volume" is not provided.
-a, --affinity-policy string Affinity policy for data volume being created. Valid values are: "affinity" and "anti-affinity".
If "--storage-pool" is provided then this cannot be specified.
-v, --affinity-volume string Volume identifier or name to base volume affinity policy against.
This is required if "--affinity-policy affinity" is specified and "--affinity-instance" is not provided.
-j, --anti-affinity-instances strings Comma separated list of instance identifiers or names to base volume anti-affinity policy against.
This is required if "--affinity-policy anti-affinity" is specified and "--anti-affinity-volumes" is not provided.
-w, --anti-affinity-volumes strings Comma separated list of volume identifiers or names to base volume anti-affinity policy against.
This is required if "--affinity-policy anti-affinity" is specified and "--anti-affinity-instances" is not provided.
-b, --bucket string Cloud Object Storage bucket name.
-u, --bucket-access string Indicates the bucket access type. Valid values are: "public", "private". Private access requires access and secret keys.
Default is "private".
-c, --checksum Checks the checksum file from the COS bucket against the one computed on the downloaded image.
-n, --image-file-name string The image file name.
-d, --import-details strings Import details for SAP image. Must include a license, product and vendor.
Valid license values: byol.
Valid product values: Hana, Netweaver.
Valid vendor values: SAP.
-o, --os-type string Operating system contained in the image. Valid values are: "aix", "ibmi", "rhel", "sles". Required when importing a raw image.
-r, --region string Cloud Object Storage region au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
-s, --secret-key string Cloud Object Storage HMAC secret key.
-p, --storage-pool string Storage pool where the image will be imported to. Use "ibmcloud pi storage-pools" to see available storage pools.
If "--storage-pool" is provided then "--affinity-policy" cannot be specified.
-t, --storage-tier string Tier of the disk storage. Use "ibmcloud pi storage-tiers" to see available tiers in the targeted region.
Default to tier3 if not provided.
--user-tags strings Comma separated list of user tags to be attached to the imported image.Examples:
ibmcloud pi image import import-image-name --bucket-access public --image-file-name imageFileName.ova --bucket test-bucket --region us-east
ibmcloud pi image import import-image-name --bucket-access private --storage-tier tier1 --image-file-name imageFileName.ova --bucket test-bucket --region us-east --access-key access-key-sample --secret-key secret-key-sample{: #ibmcloud-pi-image-import-show}
Alias: import-show, ims
Description: View details of the last image import job.
Usage: import-show
{: #ibmcloud-pi-image-list}
Alias: list, ls
Description: List all images in a workspace.
Usage: list
{: #ibmcloud-pi-image-list-catalog}
Alias: list-catalog, lc
Description: List images available in the regional image catalog.
Usage: list-catalog [--sap=True|False]
Available Options:
-s, --sap Include SAP images.Examples:
ibmcloud pi image list-catalog --sap{: #ibmcloud-pi-instance}
Alias: instance, ins
Description: IBM Cloud Power Virtual Server Instances.
Usage: instance
Available Commands:
action: Perform an operation in a PVM server instance.capture: IBM Cloud Power Virtual Server Instance Capture.console: IBM Cloud Power Virtual Server Instance Console.create: Create a server instance.delete: Delete a server instance.get: View details of a server instance.list: List all server instances.operation: Perform an operation on an IBMi server instance.snapshot: IBM Cloud Power Virtual Server Instance Snapshots.subnet: IBM Cloud Power Virtual Server Instance Subnets.update: Update a server instance.virtual-serial-number: IBM Cloud Power Virtual Server Instance Virtual Serial Number.volume: IBM Cloud Power Virtual Server Instance Volumes.vpmem-volume: IBM Cloud Power Virtual Server Instance vPMEM Volumes.
{: #ibmcloud-pi-instance-action}
Alias: action, act
Description: Perform an operation in a PVM server instance.
Usage:
action INSTANCE_ID --operation OPERATION
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-o, --operation string Operation to be done in a PVM server instance.
Valid values are: dumprestart, hard-reboot, immediate-shutdown, reset-state, soft-reboot, start, stop.Examples:
ibmcloud pi instance action 43064761-948f-469d-ac8e-b8e5f0d6056f --operation immediate-shutdown{: #ibmcloud-pi-instance-capture}
Alias: capture, cap
Description: IBM Cloud Power Virtual Server Instance Capture.
Usage: capture
Available Commands:
create: Create a capture of a server instance.show: View the job details of the last server instance capture.
{: #ibmcloud-pi-instance-capture-create}
Alias: create, cr
Description: Create a capture of a server instance.
Usage:
create INSTANCE_ID --destination (cloud-storage | both) --name NAME --access-key KEY --image-path PATH --region REGION --secret-key KEY [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] [--volumes VOLUME1[,VOLUMEn]]
pi instance capture create INSTANCE_ID --destination image-catalog --name NAME [--checksum=True|False] [--user-tags USER_TAG1[,USER_TAGn]] [--volumes VOLUME1[,VOLUMEn]]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-a, --access-key string Cloud Object Storage HMAC access key. Required if destination is cloud-storage.
-c, --checksum Creates a checksum file. Default is "false".
-d, --destination string Destination for the deployable image. Valid values are: "cloud-storage", "image-catalog", "both".
-i, --image-path string Cloud Object Storage image path. Required if destination is cloud-storage. E.g. bucket-name[/optional/folder].
-n, --name string Name of the deployable image created for the captured instance.
-r, --region string Cloud Object Storage regions au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
Required if destination is cloud-storage.
-s, --secret-key string Cloud Object Storage HMAC secret key. Required if destination is cloud-storage.
-u, --user-tags strings Comma separated list of user tags to be attached to the instance capture.
-v, --volumes strings Comma separated list of volume identifiers or names to include in the captured instance.Examples:
ibmcloud pi instance capture create 43064761-948f-469d-ac8e-b8e5f0d6056f --destination both --name deployable-image-name --access-key access-key-sample --secret-key secret-key-sample --region us-south --image-path "imageBucket/imageLocation"{: #ibmcloud-pi-instance-capture-show}
Alias: show, sh
Description: View the job details of the last server instance capture.
Usage:
show INSTANCE_ID
INSTANCE_ID: The unique identifier or name of the instance.{: #ibmcloud-pi-instance-console}
Alias: console, con
Description: IBM Cloud Power Virtual Server Instance Console.
Usage: console
Available Commands:
get: Get the console of an instance.
{: #ibmcloud-pi-instance-console-get}
Alias: get
Description: Get the console of an instance.
Usage:
get INSTANCE_ID
INSTANCE_ID: The unique identifier or name of the instance.{: #ibmcloud-pi-instance-create}
Alias: create, cr
Description: Create a server instance.
Usage:
create INSTANCE_NAME --image IMAGE --subnets "SUBNET1 [IP1]"[,"SUBNETn [IPn]"]
[--boot-volume-replication-enabled=True|False]
[--default-trusted-profile (CRN | TRUSTED_PROFILE_ID | TRUSTED_PROFILE_NAME)
[--default-trusted-profile-autolink=True|False]]
[--IBMiCSS-license=True|False] [--IBMiPHA-license=True|False] [--IBMiRDS-users NUMBER_USERS]
[--key-name NAME] [--memory MEMORY] [--metadata-service=True|False] [--pin-policy POLICY] [--placement-group GROUP_ID]
[--preferred-processor-compatibility-mode MODE] [--processor-type PROC_TYPE] [--processors PROCESSORS]
[--replicant-affinity-policy AFFINITY_POLICY] [--replicant-scheme SCHEME] [--replicants NUMBER]
[--replication-sites SITE1[,SITEn]] [--shared-processor-pool SHARED_PROCESSOR_POOL]
[--storage-affinity STORAGE_AFFINITY_POLICY] [--storage-affinity-instance INSTANCE]
[--storage-affinity-volume VOLUME] [--storage-anti-affinity-instances INSTANCE1[,INSTANCEn]]
[--storage-anti-affinity-volumes VOLUME1[,VOLUMEn]] [--storage-connection STORAGE_CONNECTION]
[--storage-pool STORAGE_POOL] [--storage-pool-affinity=True|False] [--storage-tier STORAGE_TIER]
[--sys-type TYPE] [--user-data USER_DATA] [--user-tags USER_TAG1[,USER_TAGn]]
[--virtual-serial-number "(SERIAL | 'auto-assign')[,DESCRIPTION]" [--software-tier SOFTWARE_TIER]]
[--virtual-cores ASSIGNED_CORES] [--volumes VOLUME1[,VOLUMEn]] [--vpmem-volumes "NAME SIZE[,"NAMEn SIZEn"]]
INSTANCE_NAME: The name of the instance.Available Options:
--IBMiCSS-license IBMi CSS software license associated with the instance.
--IBMiPHA-license IBMi PHA IASP Management software license associated with the instance.
--IBMiRDS-users int Number of IBMi RDS user software licenses associated with the instance. Default is 0.
-b, --boot-volume-replication-enabled Enables storage replication on the boot volume. Default is "false".
--default-trusted-profile string Trusted profile CRN, ID or name of the default IAM trusted profile to use for this instance.
-a, --default-trusted-profile-autolink If set to true, the system will create a link to the specified trusted profile during server creation.
-i, --image string Operating system image identifier or name.
-k, --key-name string Name of SSH key.
-m, --memory float Amount of memory in GiB to allocate to the instance. Default is 2 GiB.
--metadata-service Indicates whether the metadata service endpoint will be available to the virtual server.
--pin-policy string Pin policy. Valid values are: "none", "soft", "hard". Default is "none".
--placement-group string The placement group ID of the group that the server will be added to.
-c, --preferred-processor-compatibility-mode string The preferred processor compatibility mode. Valid values are: default, POWER7, POWER8, POWER9, POWER9_Base, POWER10, POWER11
-r, --processor-type string Type of processors: "shared" or "dedicated" or "capped". Default is "dedicated".
-p, --processors float Amount of processors to allocate to the instance. Default is 1 core.
--replicant-affinity-policy string Affinity policy to use when multicreate is used. Valid values are: affinity, anti-affinity, none.
--replicant-scheme string Naming scheme to use for duplicate VMs. Valid values are: prefix, suffix.
--replicants int The number of replicant instances to be created with this request.
Values greater than 1 will result in the creation of multiple instances.
--replication-sites strings Indicates the replication sites of the boot volume. See "ibmcloud pi disaster-recovery" command to get a list of replication sites.
--shared-processor-pool string The shared processor pool ID of the pool that the server will be in.
--software-tier string IBMi licensing software tiers. Must be set with "--virtual-serial-number" option. Valid values are: P05, P10, P20, P30.
--storage-affinity string Affinity policy for storage pool selection. Valid values are: "affinity" and "anti-affinity".
If "--storage-pool" is provided, then this option cannot be specified.
--storage-affinity-instance string PVM instance identifier or name to base storage affinity policy against.
This is required if "--storage-affinity affinity" is specified and "--storage-affinity-volume" is not provided.
--storage-affinity-volume string Volume identifier or name to base storage affinity policy against.
This is required if "--storage-affinity affinity" is specified and "--storage-affinity-instance" is not provided.
--storage-anti-affinity-instances strings Comma separated list of PVM instance identifiers or names to base storage affinity policy against.
This is required if "--storage-affinity anti-affinity" is specified and "--storage-anti-affinity-volumes" is not provided.
--storage-anti-affinity-volumes strings Comma separated list of volume identifiers or names to base storage affinity policy against.
This is required if "--storage-affinity anti-affinity" is specified and "--storage-anti-affinity-instances" is not provided.
--storage-connection string The storage connection type. Valid values are: maxVolumeSupport.
--storage-pool string Storage pool for server deployment (use "ibmcloud pi storage-pools" to see available storage pools).
Only valid when you deploy one of the IBM supplied stock images.
Storage tier and pool for a custom image (an imported image or an image that is created from a PVMInstance capture)
defaults to the storage tier and pool the image was created in.
--storage-pool-affinity Indicates if all volumes attached to the server must reside in the same storage pool.
If set to false, then volumes from any storage tier and pool can be attached to the PVM instance.
This setting affects PVM instance snapshot, capture, and clone operations. For capture and clone operations,
only data volumes that are of the same storage tier and in the same storage pool of the boot volume of the PVM instance can be included.
For snapshot operations, all data volumes to be included in the snapshot must reside in the same storage tier and storage pool.
Once set to false, cannot be set back to true unless all volumes attached reside in the same storage tier and pool.
-t, --storage-tier string Storage tier for server deployment when deploying a stock or custom image
(use "ibmcloud pi storage-tiers" to see available storage tiers in the targeted region).
Default to tier3 if not provided.
-n, --subnets strings Comma separated list of subnet identifiers or names and optional IP address to associate with the instance.
Example: --subnets "subnet-name2 192.168.0.2,subnet-name3"
-s, --sys-type string System type used to host the instance. Valid values are: s1022, e1050, e1080, s1122, e1150, e1180.
-u, --user-data string The user data passed into the instance. Strings and file names are supported. File names must be prepended with "@".
--user-tags strings Comma separated list of user tags to be attached to the instance.
--virtual-cores int The number of virtual cores assigned.
--virtual-serial-number string IBMi virtual serial number information added with the instance.
Must include an existing virtual serial number or 'auto-assign' and optionally a description.
-v, --volumes strings Comma separated list of volume identifiers or names to associate with the instance.
--vpmem-volumes strings Comma separated list of vPMEM volume names and sizes to associate with the instance.
The maximum number of vPMEM volumes for SAP instances is 1 otherwise it is 4.Examples:
ibmcloud pi instance create test-instance --image 43064761-948f-469d-ac8e-b8e5f0d6056f --subnets 85716e61-948f-309d-de8b-c4e5f0d3126d
ibmcloud pi instance create test-instance --image 43064761-948f-469d-ac8e-b8e5f0d6056f --subnets 85716e61-948f-309d-de8b-c4e5f0d3126d --volumes 43064761-948f-469d-ac8e-b8e5f0d6056f --storage-tier tier1 --processors 1 --processor-type dedicated --deployment-type EPIC --sys-type e980
ibmcloud pi instance create test-instance --image 43064761-948f-469d-ac8e-b8e5f0d6056f --subnets 85716e61-948f-309d-de8b-c4e5f0d3126d --storage-tier tier1 --replicants 2 --replicant-scheme prefix --replicant-affinity-policy affinity
ibmcloud pi instance create test-instance --image 43064761-948f-469d-ac8e-b8e5f0d6056f --subnets 85716e61-948f-309d-de8b-c4e5f0d3126d --boot-volume-replication-enabled --replication-sites dal10{: #ibmcloud-pi-instance-delete}
Alias: delete, del
Description: Delete a server instance.
Usage:
delete INSTANCE_ID [--delete-data-volumes=True|False] [--retainVSN=True|False]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-d, --delete-data-volumes Indicates whether all data volumes attached to the instance must be deleted.
Shared data volumes will be deleted if no other instances are attached.
-r, --retainVSN Determines if the virtual serial number will be retained after being removed from the instance. Default is "false".{: #ibmcloud-pi-instance-get}
Alias: get
Description: View details of a server instance.
Usage:
get INSTANCE_ID
INSTANCE_ID: The unique identifier or name of the instance.{: #ibmcloud-pi-instance-list}
Alias: list, ls
Description: List all server instances.
Usage: list
{: #ibmcloud-pi-instance-operation}
Alias: operation, op
Description: Perform an operation on an IBMi server instance.
Usage:
operation INSTANCE_ID (--operation-type "boot" --boot-mode MODE --boot-operating-mode MODE | --operation-type "job" --job-task TASK)
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-b, --boot-mode string Name of the server boot mode. Valid values are: a, b, c, d.
-m, --boot-operating-mode string Name of the server operating mode. Valid values are: manual, normal.
-j, --job-task string Name of the job task to execute.
Valid values are: consoleservice, dston, dumprestart, iopdump, iopreset, remotedstoff, remotedston, retrydump.
-o, --operation-type string Name of the operation to execute. Valid values are: boot, job.Examples:
ibmcloud pi instance operation 43064761-948f-469d-ac8e-b8e5f0d6056f --operation-type boot --boot-mode c --boot-operating-mode normal{: #ibmcloud-pi-instance-snapshot}
Alias: snapshot, snap
Description: IBM Cloud Power Virtual Server Instance Snapshots.
Usage: snapshot
Available Commands:
create: Create a snapshot for an instance.delete: Delete a snapshot from an instance.get: Get a snapshot for an instancelist: List all snapshots for an instance or all snapshots in the workspace.restore: Restore a snapshot for an instance.update: Update a snapshot for an instance.
{: #ibmcloud-pi-instance-snapshot-create}
Alias: create, cr
Description: Create a snapshot for an instance.
Usage:
create INSTANCE_ID --name SNAPSHOT_NAME [--description DESCRIPTION] [--user-tags USER_TAG1[,USER_TAGn]] [--volumes VOLUME1[,VOLUMEn]]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-d, --description string Snapshot description.
-n, --name string Name of the snapshot.
-u, --user-tags strings Comma separated list of user tags to be attached to the snapshot.
-v, --volumes strings Comma separated list of volume identifiers or names to include in the snapshot.
If you do not specify this option or if the volumes list is empty,
all the volumes that are attached to the instance are included in the snapshot.Examples:
ibmcloud pi instance snapshot create 85716e61-948f-309d-de8b-c4e5f0d3126d --name test-snapshot-name{: #ibmcloud-pi-instance-snapshot-delete}
Alias: delete, del
Description: Delete a snapshot from an instance.
Usage:
delete SNAPSHOT_ID
SNAPSHOT_ID: The unique identifier of the snapshot.{: #ibmcloud-pi-instance-snapshot-get}
Alias: get
Description: Get a snapshot for an instance
Usage:
get SNAPSHOT_ID
SNAPSHOT_ID: The unique identifier of the snapshot.{: #ibmcloud-pi-instance-snapshot-list}
Alias: list, ls
Description: List all snapshots for an instance or all snapshots in the workspace.
Usage:
list [INSTANCE_ID]
INSTANCE_ID: The unique identifier or name of the instance.{: #ibmcloud-pi-instance-snapshot-restore}
Alias: restore, res
Description: Restore a snapshot for an instance.
Usage:
restore INSTANCE_ID --snapshot SNAPSHOT_ID [--force] [--restore VALUE]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-f, --force By default the VM must be shutoff during a snapshot restore, force set to true will relax the VM shutoff pre-condition.
-r, --restore string Action to take on a failed snapshot restore. Valid values for "--restore" are: retry, rollback.
-s, --snapshot string The unique identifier of the snapshot.Examples:
ibmcloud pi instance snapshot restore 85716e61-948f-309d-de8b-c4e5f0d3126d --snapshot 43064761-948f-469d-ac8e-b8e5f0d6056f --force --restore retry{: #ibmcloud-pi-instance-snapshot-update}
Alias: update, upd
Description: Update a snapshot for an instance.
Usage:
update SNAPSHOT_ID [--description DESCRIPTION] [--name NAME]
SNAPSHOT_ID: The unique identifier of the snapshot.Available Options:
-d, --description string New snapshot description.
-n, --name string New name of the snapshot.{: #ibmcloud-pi-instance-subnet}
Alias: subnet, snet
Description: IBM Cloud Power Virtual Server Instance Subnets.
Usage: subnet
Available Commands:
attach: Attach a subnet to a server instance.detach: Detach a specific subnet or mac address from a server instance.list: List all the attached subnets.
{: #ibmcloud-pi-instance-subnet-attach}
Alias: attach, att
Description: Attach a subnet to a server instance.
Usage:
attach INSTANCE_ID --subnet SUBNET_ID [--ip-address IP_ADDRESS]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-i, --ip-address string The requested ip address of this subnet interface (192.168.1.0).
-n, --subnet string The subnet ID.Examples:
ibmcloud pi instance subnet attach 85716e61-948f-309d-de8b-c4e5f0d3126d --subnet 43064761-948f-469d-ac8e-b8e5f0d6056f --ip-address 192.168.0.12{: #ibmcloud-pi-instance-subnet-detach}
Alias: detach, det
Description: Detach a specific subnet or mac address from a server instance.
Usage:
detach INSTANCE_ID --subnet SUBNET_ID [--mac-address MAC_ADDRESS]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-m, --mac-address string The mac address of the subnet interface to be removed. Default is all mac addresses.
-n, --subnet string The subnet ID.Examples:
ibmcloud pi instance subnet detach 85716e61-948f-309d-de8b-c4e5f0d3126d --subnet 43064761-948f-469d-ac8e-b8e5f0d6056f --mac-address eb:26:8f:ba:5f:62{: #ibmcloud-pi-instance-subnet-list}
Alias: list, ls
Description: List all the attached subnets.
Usage:
list INSTANCE_ID
INSTANCE_ID: The unique identifier or name of the instance.{: #ibmcloud-pi-instance-update}
Alias: update, upd
Description: Update a server instance.
Usage:
update INSTANCE_ID
[--default-trusted-profile (CRN | TRUSTED_PROFILE_ID | TRUSTED_PROFILE_NAME)
[--default-trusted-profile-autolink=True|False]]
[--IBMiCSS-license=True|False] [--IBMiPHA-license=True|False]
[--IBMiRDS-users NUMBER_USERS] [--memory AMOUNT]
[--metadata-service=True|False [--metadata-service-force=True|False]]
[--name NAME] [--pin-policy POLICY] [--preferred-processor-compatibility-mode MODE]
[--processor-type TYPE] [--processors NUMBER] [--storage-pool-affinity=True|False]
[--virtual-cores ASSIGNED_CORES] [--virtual-optional-device ("attach" | "detach")]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
--IBMiCSS-license New IBMi CSS software license associated with the instance.
--IBMiPHA-license New IBMi PHA IASP Management software license associated with the instance.
--IBMiRDS-users int New number of IBMi RDS user software licenses associated with the instance.
--default-trusted-profile string Trusted profile CRN, ID or name of the default IAM trusted profile to use for this instance.
-a, --default-trusted-profile-autolink If set to true, the system will create a link to the specified trusted profile during server update.
-m, --memory float New amount of memory for the server instance.
--metadata-service Indicates whether the metadata service endpoint will be available to the virtual server.
--metadata-service-force If set to true, this allows the metadata service to be disabled while the VM is active,
which may require manual interface cleanup by the OS administrator.
This option is only supported for disabling the metadata service.
-n, --name string New name of the server instance.
--pin-policy string New pin policy for the server instance. Valid values are: "none", "soft", "hard".
-c, --preferred-processor-compatibility-mode string The preferred processor compatibility mode. Valid values are: default, POWER7, POWER8, POWER9, POWER9_Base, POWER10, POWER11
-r, --processor-type string New processor type for the server instance.
-p, --processors float New amount of processors for the server instance.
-s, --storage-pool-affinity Indicates if all volumes attached to the server must reside in the same storage pool.
If set to false, then volumes from any storage tier and pool can be attached to the PVM instance.
This setting affects PVM instance snapshot, capture, and clone operations. For capture and clone operations,
only data volumes that are of the same storage tier and in the same storage pool of the boot volume of the PVM instance can be included.
For snapshot operations, all data volumes to be included in the snapshot must reside in the same storage tier and storage pool.
Once set to false, cannot be set back to true unless all volumes attached reside in the same storage tier and pool.
--virtual-cores int New number of virtual cores assigned.
-v, --virtual-optical-device string Attach or detach a virtual optical device to this instance. Valid values are: attach, detach.Examples:
ibmcloud pi instance update 43064761-948f-469d-ac8e-b8e5f0d6056f --memory 2 --name new-instance-name --pin-policy hard --processors 2 --processor-type shared --storage-pool-affinity{: #ibmcloud-pi-instance-virtual-serial-number}
Alias: virtual-serial-number, vsn
Description: IBM Cloud Power Virtual Server Instance Virtual Serial Number.
Usage: virtual-serial-number
Available Commands:
assign: Assign a virtual serial number to a virtual server instance.get: Get a virtual serial number assigned to a virtual server instance.unassign: Unassign a virtual serial number from a virtual server instance.update: Update a virtual serial number assigned to a virtual server instance.
{: #ibmcloud-pi-instance-virtual-serial-number-assign}
Alias: assign, asn
Description: Assign a virtual serial number to a virtual server instance.
Usage:
assign INSTANCE_ID [--description DESCRIPTION] [--serial SERIAL]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-d, --description string Description for the virtual serial number.
-s, --serial string Virtual serial number to attach. If no serial is specified or 'auto-assign' is set, a virtual serial number will be automatically generated.Examples:
ibmcloud pi instance virtual-serial-number assign 43064761-948f-469d-ac8e-b8e5f0d6056f --description "new-virtual-serial-number-description"{: #ibmcloud-pi-instance-virtual-serial-number-get}
Alias: get
Description: Get a virtual serial number assigned to a virtual server instance.
Usage:
get INSTANCE_ID
INSTANCE_ID: The unique identifier or name of the instance.{: #ibmcloud-pi-instance-virtual-serial-number-unassign}
Alias: unassign, uasn
Description: Unassign a virtual serial number from a virtual server instance.
Usage:
unassign INSTANCE_ID [--retainVSN=True|False]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-r, --retainVSN Determines if virtual serial number will be retained after being unassigned from the instance. Default is "false".Examples:
ibmcloud pi instance virtual-serial-number unassign 43064761-948f-469d-ac8e-b8e5f0d6056f --retainVSN{: #ibmcloud-pi-instance-virtual-serial-number-update}
Alias: update, upd
Description: Update a virtual serial number assigned to a virtual server instance.
Usage:
update INSTANCE_ID (--description DESCRIPTION | --software-tier SOFTWARE_TIER)
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-d, --description string New virtual serial number description.
--software-tier string IBMi licensing software tiers. Valid values are: P05, P10, P20, P30.{: #ibmcloud-pi-instance-volume}
Alias: volume, vol
Description: IBM Cloud Power Virtual Server Instance Volumes.
Usage: volume
Available Commands:
attach: Attach one or more volumes to an instance.bulk-detach: Detach multiple volumes from an instance.detach: Detach a volume from an instance.list: List all the attached volumes.
{: #ibmcloud-pi-instance-volume-attach}
Alias: attach, att
Description: Attach one or more volumes to an instance.
Usage:
attach INSTANCE_ID --volumes VOLUME1[,VOLUMEn] [--boot-volume BOOT_VOLUME]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-b, --boot-volume string Boot volume to be attached to an instance.
-v, --volumes strings Comma separated list of volume identifiers or names to associate with the instance.Examples:
ibmcloud pi instance volume attach 85716e61-948f-309d-de8b-c4e5f0d3126d --boot-volume e5d394ef-3156-21a3-8b12-de15c6d5e276 --volumes 43064761-948f-469d-ac8e-b8e5f0d6056f,32064761-298e-469a-bc6f-d8e5f0d6067a{: #ibmcloud-pi-instance-volume-bulk-detach}
Alias: bulk-detach, bdet
Description: Detach multiple volumes from an instance.
Usage:
bulk-detach INSTANCE_ID (--detach-all=True|False | --volumes VOLUME1[,VOLUMEn]) [--detach-primary=True|False]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-a, --detach-all Indicates if all volumes, except primary boot volume, attached to the instance should be detached. Required if "--volumes" is not provided.
-p, --detach-primary Indicates if primary boot volume attached to the instance should be detached.
-v, --volumes strings List of volumes to be detached from an instance. Required if "--detach-all" is not provided.Examples:
ibmcloud pi instance volume bulk-detach 85716e61-948f-309d-de8b-c4e5f0d3126d --detach-all --detach-primary{: #ibmcloud-pi-instance-volume-detach}
Alias: detach, det
Description: Detach a volume from an instance.
Usage:
detach INSTANCE_ID --volume VOLUME_ID
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-v, --volume string Volume to detach from the instance.Examples:
ibmcloud pi instance volume detach 85716e61-948f-309d-de8b-c4e5f0d3126d --volume 43064761-948f-469d-ac8e-b8e5f0d6056f{: #ibmcloud-pi-instance-volume-list}
Alias: list, ls
Description: List all the attached volumes.
Usage:
list INSTANCE_ID
INSTANCE_ID: The unique identifier or name of the instance.{: #ibmcloud-pi-instance-vpmem-volume}
Alias: vpmem-volume, vpmem, vpmemvol
Description: IBM Cloud Power Virtual Server Instance vPMEM Volumes.
Usage: vpmem-volume
Available Commands:
attach: Attach a vPMEM volume to an instance.detach: Detach a vPMEM volume from an instance.get: Get a vPMEM volume attached to an instance.list: List all vPMEM volumes attached to an instance.update: Update a server instance.
{: #ibmcloud-pi-instance-vpmem-volume-attach}
Alias: attach, att
Description: Attach a vPMEM volume to an instance.
Usage:
attach INSTANCE_ID --vpmem-volumes "NAME SIZE[,"NAMEn SIZEn"]" [--user-tags USER_TAG1[,USER_TAGn]]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-u, --user-tags strings User tags to add to the created vPMEM volume(s).
--vpmem-volumes strings Comma separated list of vPMEM volume names and sizes to associate with the instance.
The maximum number of vPMEM volumes for SAP instances is 1 otherwise it is 4.{: #ibmcloud-pi-instance-vpmem-volume-detach}
Alias: detach, det
Description: Detach a vPMEM volume from an instance.
Usage:
detach INSTANCE_ID --vpmem-volume VPMEM_VOLUME_ID
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-v, --vpmem-volume string vPMEM volume ID that is associated with the PVM instance.{: #ibmcloud-pi-instance-vpmem-volume-get}
Alias: get
Description: Get a vPMEM volume attached to an instance.
Usage:
get INSTANCE_ID --vpmem-volume VPMEM_VOLUME_ID
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-v, --vpmem-volume string vPMEM volume ID that is associated with the PVM instance.{: #ibmcloud-pi-instance-vpmem-volume-list}
Alias: list, ls
Description: List all vPMEM volumes attached to an instance.
Usage:
list INSTANCE_ID
INSTANCE_ID: The unique identifier or name of the instance.{: #ibmcloud-pi-instance-vpmem-volume-update}
Alias: update, upd
Description: Update a server instance.
Usage:
update INSTANCE_ID --vpmem-volume VPMEM_VOLUME_ID --name NAME
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-n, --name string New name of the vPMEM volume.
-v, --vpmem-volume string vPMEM volume ID that is associated with the PVM instance.{: #ibmcloud-pi-job}
Alias: job
Description: IBM Cloud Power Virtual Server Jobs.
Usage: job
Available Commands:
delete: Delete a job.get: View details of a job.list: List up to the last 5 jobs in a workspace.
{: #ibmcloud-pi-job-delete}
Alias: delete, del
Description: Delete a job.
Usage:
delete JOB_ID
JOB_ID: The unique identifier of the job.{: #ibmcloud-pi-job-get}
Alias: get
Description: View details of a job.
Usage:
get JOB_ID
JOB_ID: The unique identifier of the job.{: #ibmcloud-pi-job-list}
Alias: list, ls
Description: List up to the last 5 jobs in a workspace.
Usage: list [--operation-action ACTION] [--operation-id ID] [--operation-target TARGET]
Available Options:
-a, --operation-action string Operation action to filter returned jobs. Valid values are: epaImageImport, epaVMCapture, imageExport, imageImport, storage, vmCapture.
-i, --operation-id string Operation ID to filter returned jobs.
-t, --operation-target string Operation target to filter returned jobs. Valid values are: cloudConnection, image, pvmInstance.{: #ibmcloud-pi-network-peer}
Alias: network-peer, np
Description: IBM Cloud Power Virtual Server Network Peers.
Usage: network-peer
Available Commands:
create: Create a network peer.delete: Delete a network peer.get: View details of a network peer.interfaces: List all network peer interfaces.list: List all network peers.route-filter: IBM Cloud Power Virtual Server Route Filters.update: Update a network peer.
{: #ibmcloud-pi-network-peer-create}
Alias: create, cr
Description: Create a network peer.
Usage:
create NETWORK_PEER_NAME --customer-asn ASN --customer-cidr CIDR
--ibm-asn ASN --ibm-cidr CIDR --peer-interface-id PEER_INTERFACE_ID --type TYPE --vlan VLAN
[--default-export-route-filter ("allow" | "deny")] [--default-import-route-filter ("allow" | "deny")]
NETWORK_PEER_NAME: The desired name of the network peer.Available Options:
--customer-asn int The ASN number at customer network side.
--customer-cidr string The IP address used for configuring customer network interface with network subnet mask.
"--customer-cidr" and "--ibm-cidr" must have matching network and subnet mask values.
-e, --default-export-route-filter string Default action for export route filter. Valid values are: allow, deny. Default is "allow".
-i, --default-import-route-filter string Default action for import route filter. Valid values are: allow, deny. Default is "allow".
--ibm-asn int The ASN number at IBM PowerVS side.
--ibm-cidr string The IP address used for configuring IBM network interface with network subnet mask.
"--customer-cidr" and "--ibm-cidr" must have matching network and subnet mask values.
-p, --peer-interface-id string Peer interface ID.
-t, --type string Type of the peer network. Valid values are: dcnetwork_bgp.
-v, --vlan int The VLAN configured at the customer network.Examples:
ibmcloud pi network-peer create test-network-peer --customer-asn 64512 --customer-cidr 192.168.91.1/30 --ibm-asn 64513 --ibm-cidr 192.168.91.2/30 --peer-interface-id 85716e61-948f-309d-de8b-c4e5f0d3126d --type dcnetwork_bgp --vlan 10{: #ibmcloud-pi-network-peer-delete}
Alias: delete, del
Description: Delete a network peer.
Usage:
delete NETWORK_PEER_ID
NETWORK_PEER_ID: The unique identifier of the network peer.{: #ibmcloud-pi-network-peer-get}
Alias: get
Description: View details of a network peer.
Usage:
get NETWORK_PEER_ID
NETWORK_PEER_ID: The unique identifier of the network peer.{: #ibmcloud-pi-network-peer-interfaces}
Alias: interfaces, int
Description: List all network peer interfaces.
Usage: interfaces
{: #ibmcloud-pi-network-peer-list}
Alias: list, ls
Description: List all network peers.
Usage: list
{: #ibmcloud-pi-network-peer-route-filter}
Alias: route-filter, rf
Description: IBM Cloud Power Virtual Server Route Filters.
Usage: route-filter
Available Commands:
create: Create a network peer route-filter.delete: Delete a network peer route-filter.get: View details of a network peer route-filter.
{: #ibmcloud-pi-network-peer-route-filter-create}
Alias: create, cr
Description: Create a network peer route-filter.
Usage:
create NETWORK_PEER_ID --action ("allow" | "deny") --direction ("export" | "import")
--index INDEX --prefix PREFIX [--ge PREFIX-SET-MIN] [--le PREFIX-SET-MAX]
NETWORK_PEER_ID: The unique identifier of the network peer.Available Options:
-a, --action string Action of the filter. Valid values are: allow, deny.
-d, --direction string Direction of the filter. Valid values are: export, import.
-g, --ge int The minimum matching length of the prefix-set. Values range from 1 to 32 inclusive,
and must be less than or equal to the value of the "--le" option.
-i, --index int Priority or order of the filter.
-l, --le int The maximum matching length of the prefix-set. Values range from 1 to 32 inclusive,
and must be greater than or equal to the value of the "--ge" option.
-p, --prefix string IP prefix representing an address and mask length of the prefix-set.{: #ibmcloud-pi-network-peer-route-filter-delete}
Alias: delete, del
Description: Delete a network peer route-filter.
Usage:
delete ROUTE_FILTER_ID --network-peer-id NETWORK_PEER_ID
ROUTE_FILTER_ID: The unique identifier of the route filter.Available Options:
-n, --network-peer-id string Network peer ID that is associated with the route filter.{: #ibmcloud-pi-network-peer-route-filter-get}
Alias: get
Description: View details of a network peer route-filter.
Usage:
get ROUTE_FILTER_ID --network-peer-id NETWORK_PEER_ID
ROUTE_FILTER_ID: The unique identifier of the route filter.Available Options:
-n, --network-peer-id string Network peer ID that is associated with the route filter.{: #ibmcloud-pi-network-peer-update}
Alias: update, upd
Description: Update a network peer.
Usage:
update NETWORK_PEER_ID [--customer-asn ASN] [--customer-cidr CIDR]
[--default-export-route-filter ("allow" | "deny")] [--default-import-route-filter ("allow" | "deny")]
[--ibm-asn ASN] [--ibm-cidr CIDR] [--name NAME] [--type TYPE] [--vlan VLAN]
NETWORK_PEER_ID: The unique identifier of the network peer.Available Options:
--customer-asn int The ASN number at customer network side.
--customer-cidr string The IP address used for configuring customer network interface with network subnet mask.
"--customer-cidr" and "--ibm-cidr" must have matching network and subnet mask values.
-e, --default-export-route-filter string Default action for export route filter. Valid values are: allow, deny.
-i, --default-import-route-filter string Default action for import route filter. Valid values are: allow, deny.
--ibm-asn int The ASN number at IBM PowerVS side.
--ibm-cidr string The IP address used for configuring IBM network interface with network subnet mask.
"--customer-cidr" and "--ibm-cidr" must have matching network and subnet mask values.
-n, --name string New name of the network peer.
-t, --type string Type of the peer network. Valid values are: dcnetwork_bgp.
-v, --vlan int The VLAN configured at the customer network.{: #ibmcloud-pi-placement-group}
Alias: placement-group, pg
Description: IBM Cloud Power Virtual Server Placement Groups.
Usage: placement-group
Available Commands:
create: Create a server placement group.delete: Delete a server placement group.get: View details of a server placement group.list: List all server placement groups.server-add: Add a server to a server placement group.server-remove: Remove a server from a server placement group.
{: #ibmcloud-pi-placement-group-create}
Alias: create, cr
Description: Create a server placement group.
Usage:
create PLACEMENT_GROUP_NAME --policy POLICY [--user-tags USER_TAG1[,USER_TAGn]]
PLACEMENT_GROUP_NAME: A unique name of the placement group.Available Options:
-p, --policy string Affinity policy for placement group being created. Valid values are affinity and anti-affinity.
-u, --user-tags strings Comma separated list of user tags to be attached to the placement group.Examples:
ibmcloud pi placement-group test-placement-group --policy anti-affinity{: #ibmcloud-pi-placement-group-delete}
Alias: delete, del
Description: Delete a server placement group.
Usage:
delete PLACEMENT_GROUP_ID
PLACEMENT_GROUP_ID: The unique identifier of the placement group.{: #ibmcloud-pi-placement-group-get}
Alias: get
Description: View details of a server placement group.
Usage:
get PLACEMENT_GROUP_ID
PLACEMENT_GROUP_ID: The unique identifier of the placement group.{: #ibmcloud-pi-placement-group-list}
Alias: list, ls
Description: List all server placement groups.
Usage: list
{: #ibmcloud-pi-placement-group-server-add}
Alias: server-add, sa
Description: Add a server to a server placement group.
Usage:
server-add PLACEMENT_GROUP_ID --server INSTANCE_ID
PLACEMENT_GROUP_ID: The unique identifier of the placement group.Available Options:
-s, --server string The server instance ID of the server to add to the placement group.Examples:
ibmcloud pi placement-group server-add 43064761-948f-469d-ac8e-b8e5f0d6056f --server 85716e61-948f-309d-de8b-c4e5f0d3126d{: #ibmcloud-pi-placement-group-server-remove}
Alias: server-remove, sr
Description: Remove a server from a server placement group.
Usage:
server-remove PLACEMENT_GROUP_ID --server INSTANCE_ID
PLACEMENT_GROUP_ID: The unique identifier of the placement group.Available Options:
-s, --server string The server instance ID of the server to add to the placement group.Examples:
ibmcloud pi placement-group server-remove 43064761-948f-469d-ac8e-b8e5f0d6056f --server 85716e61-948f-309d-de8b-c4e5f0d3126d{: #ibmcloud-pi-route}
Alias: route, rt
Description: IBM Cloud Power Virtual Server Network Routes.
Usage: route
Available Commands:
create: Create a network custom route.delete: Delete a network custom route.get: View details of a network custom route.list: List all network custom routes.report: View details of network custom route report.update: Update a network custom route.
{: #ibmcloud-pi-route-create}
Alias: create, cr
Description: Create a network custom route.
Usage:
create ROUTE_NAME --destination DESTINATION --next-hop NEXT_HOP
[--action ACTION] [--advertise ("enable" | "disable")] [--destination-type DESTINATION_TYPE]
[--enabled=True|False] [--next-hop-type NEXT_HOP_TYPE] [--user-tags USER_TAG1[,USER_TAGn]]
ROUTE_NAME: A unique name of the network custom route.Available Options:
-a, --action string The action of the route to take. Valid values are: deliver. Default is "deliver".
--advertise string Enable the route to be advertised. Valid values are: enable, disable. Default is "enable".
-d, --destination string The route destination.
--destination-type string The route destination type. Valid values are: ipv4-address. Default is "ipv4-address".
-e, --enabled Indicates if the route should be enabled in the fabric.
--next-hop string The IP address to route the packet to.
--next-hop-type string The next hop type. Valid values are: ipv4-address. Default is "ipv4-address".
-u, --user-tags strings Comma separated list of user tags to be attached to the network security group.Examples:
ibmcloud pi route create test-route --advertise disable --destination 192.168.1.23 --next-hop 192.168.1.24{: #ibmcloud-pi-route-delete}
Alias: delete, del
Description: Delete a network custom route.
Usage:
delete ROUTE_ID
ROUTE_ID: The unique identifier of the network custom route.{: #ibmcloud-pi-route-get}
Alias: get
Description: View details of a network custom route.
Usage:
get ROUTE_ID
ROUTE_ID: The unique identifier of the network custom route.{: #ibmcloud-pi-route-list}
Alias: list, ls
Description: List all network custom routes.
Usage: list
{: #ibmcloud-pi-route-report}
Alias: report, rp
Description: View details of network custom route report.
Usage: report
{: #ibmcloud-pi-route-update}
Alias: update, upd
Description: Update a network custom route.
Usage:
update ROUTE_ID [--action ACTION] [--advertise ("enable" | "disable")]
[--destination DESTINATION] [--destination-type DESTINATION_TYPE] [--enabled=True|False]
[--name NAME] [--next-hop NEXT_HOP] [--next-hop-type NEXT_HOP_TYPE]
ROUTE_ID: The unique identifier of the network custom route.Available Options:
-a, --action string The action of the route to take. Valid values are: deliver.
--advertise string Enable the route to be advertised. Valid values are: enable, disable.
-d, --destination string The route destination.
--destination-type string The route destination type. Valid values are: ipv4-address.
-e, --enabled Indicates if the route should be enabled in the fabric.
-n, --name string New name of the route.
--next-hop string The IP address to route the packet to.
--next-hop-type string The next hop type. Valid values are: ipv4-address.{: #ibmcloud-pi-shared-processor-pool}
Alias: shared-processor-pool, spp
Description: IBM Cloud Power Virtual Server Shared Processor Pools.
Usage: shared-processor-pool
Available Commands:
create: Create a shared processor pool.delete: Delete a shared processor pool.get: View details of a shared processor pool.list: List all shared processor pools.placement-group: IBM Cloud Power Virtual Server Placement Groups.update: Update a shared processor pool.
{: #ibmcloud-pi-shared-processor-pool-create}
Alias: create, cr
Description: Create a shared processor pool.
Usage:
create SHARED_PROCESSOR_POOL_NAME --host-group HOST_GROUP --reserved-cores NUMBER_OF_CORES [--placement-group-id PLACEMENT_GROUP_ID] [--user-tags USER_TAG1[,USER_TAGn]]
SHARED_PROCESSOR_POOL_NAME: A unique name of the shared processor pool. A minimum of 2 characters and a maximum of 12 are allowed. The only special character allowed is the underscore '_'.Available Options:
-g, --host-group string The host group where the host will be chosen.
-p, --placement-group-id string The identifier of the shared processor pool placement group the pool will be added to.
-r, --reserved-cores int The integer amount of reserved processor cores for the shared processor pool.
-u, --user-tags strings Comma separated list of user tags to be attached to the placement-group.Examples:
ibmcloud pi shared-processor-pool create test-shared-processor-pool --host-group e980 --reserver-cores 2 --placement-group-id 43064761-948f-469d-ac8e-b8e5f0d6056f{: #ibmcloud-pi-shared-processor-pool-delete}
Alias: delete, del
Description: Delete a shared processor pool.
Usage:
delete SHARED_PROCESSOR_POOL_ID
SHARED_PROCESSOR_POOL_ID: The unique identifier or name of the shared processor pool.{: #ibmcloud-pi-shared-processor-pool-get}
Alias: get
Description: View details of a shared processor pool.
Usage:
get SHARED_PROCESSOR_POOL_ID
SHARED_PROCESSOR_POOL_ID: The unique identifier or name of the shared processor pool.{: #ibmcloud-pi-shared-processor-pool-list}
Alias: list, ls
Description: List all shared processor pools.
Usage: list
{: #ibmcloud-pi-shared-processor-pool-placement-group}
Alias: placement-group, pg
Description: IBM Cloud Power Virtual Server Placement Groups.
Usage: placement-group
Available Commands:
create: Create a shared processor pool placement group.delete: Delete a shared processor pool placement group.get: View details of a shared processor pool placement group.list: List all shared processor pool placement groups.member-add: Add a shared processor pool to a placement group.member-remove: Remove a shared processor pool from a placement group.
{: #ibmcloud-pi-shared-processor-pool-placement-group-create}
Alias: create, cr
Description: Create a shared processor pool placement group.
Usage:
create PLACEMENT_GROUP_NAME --policy POLICY [--user-tags USER_TAG1[,USER_TAGn]]
PLACEMENT_GROUP_NAME: A unique name of the placement group.Available Options:
-p, --policy string Affinity policy for placement group being created. Valid values are affinity and anti-affinity.
-u, --user-tags strings Comma separated list of user tags to be attached to the shared processor pool placement group.Examples:
ibmcloud pi shared-processor-pool placement-group create spp-pg-test --policy affinity{: #ibmcloud-pi-shared-processor-pool-placement-group-delete}
Alias: delete, del
Description: Delete a shared processor pool placement group.
Usage:
delete PLACEMENT_GROUP_ID
PLACEMENT_GROUP_ID: The unique identifier of the placement group.{: #ibmcloud-pi-shared-processor-pool-placement-group-get}
Alias: get
Description: View details of a shared processor pool placement group.
Usage:
get PLACEMENT_GROUP_ID
PLACEMENT_GROUP_ID: The unique identifier of the placement group.{: #ibmcloud-pi-shared-processor-pool-placement-group-list}
Alias: list, ls
Description: List all shared processor pool placement groups.
Usage: list
{: #ibmcloud-pi-shared-processor-pool-placement-group-member-add}
Alias: member-add, ma
Description: Add a shared processor pool to a placement group.
Usage:
member-add PLACEMENT_GROUP_ID --shared-processor-pool POOL_ID
PLACEMENT_GROUP_ID: The unique identifier of the placement group.Available Options:
-s, --shared-processor-pool string The shared processor pool ID of the pool to add to the placement group.Examples:
ibmcloud pi shared-processor-pool placement-group member-add 43064761-948f-469d-ac8e-b8e5f0d6056 --shared-processor-pool 32bec9b0-560a-4baa-8cc0-7c68e41e5843{: #ibmcloud-pi-shared-processor-pool-placement-group-member-remove}
Alias: member-remove, mr
Description: Remove a shared processor pool from a placement group.
Usage:
member-remove PLACEMENT_GROUP_ID --shared-processor-pool POOL_ID
PLACEMENT_GROUP_ID: The unique identifier of the placement group.Available Options:
-s, --shared-processor-pool string The shared processor pool ID of the pool to remove from the placement group.Examples:
ibmcloud pi shared-processor-pool placement-group member-remove 43064761-948f-469d-ac8e-b8e5f0d6056 --shared-processor-pool 32bec9b0-560a-4baa-8cc0-7c68e41e5843{: #ibmcloud-pi-shared-processor-pool-update}
Alias: update, upd
Description: Update a shared processor pool.
Usage:
update SHARED_PROCESSOR_POOL_ID [--name SHARED_PROCESSOR_POOL_NAME] [--reserved-cores NUMBER_OF_CORES]
SHARED_PROCESSOR_POOL_ID: The unique identifier or name of the shared processor pool.Available Options:
-n, --name string New name of the shared processor pool. A minimum of 2 characters and a maximum of 12 are allowed. The only special character allowed is the underscore '_'.
-r, --reserved-cores int The integer amount of reserved processor cores for the shared processor pool.{: #ibmcloud-pi-snapshot}
Alias: snapshot, snap
Description: [DEPRECATED] IBM Cloud Power Virtual Server Snapshots.
Usage: snapshot
Available Commands:
create: [DEPRECATED] Create a snapshot.delete: [DEPRECATED] Delete a snapshot.get: [DEPRECATED] View details of a snapshot.list: [DEPRECATED] List all snapshots.restore: [DEPRECATED] Restore a snapshot.update: [DEPRECATED] Update a snapshot.
{: #ibmcloud-pi-snapshot-create}
Alias: create, cr
Description: [DEPRECATED] Create a snapshot.
Usage:
create INSTANCE_ID --name SNAPSHOT_NAME [--description DESCRIPTION] [--user-tags USER_TAG1[,USER_TAGn]] [--volumes VOLUME1[,VOLUMEn]]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-d, --description string Snapshot description.
-n, --name string Name of the snapshot.
-u, --user-tags strings Comma separated list of user tags to be attached to the snapshot.
-v, --volumes strings Comma separated list of volume identifiers or names to include in the snapshot.
If you do not specify this option or if the volumes list is empty,
all the volumes that are attached to the instance are included in the snapshot.Examples:
ibmcloud pi snapshot create 85716e61-948f-309d-de8b-c4e5f0d3126d --name test-snapshot-name{: #ibmcloud-pi-snapshot-delete}
Alias: delete, del
Description: [DEPRECATED] Delete a snapshot.
Usage:
delete SNAPSHOT_ID
SNAPSHOT_ID: The unique identifier of the snapshot.{: #ibmcloud-pi-snapshot-get}
Alias: get
Description: [DEPRECATED] View details of a snapshot.
Usage:
get SNAPSHOT_ID
SNAPSHOT_ID: The unique identifier of the snapshot.{: #ibmcloud-pi-snapshot-list}
Alias: list, ls
Description: [DEPRECATED] List all snapshots.
Usage: list
{: #ibmcloud-pi-snapshot-restore}
Alias: restore, res
Description: [DEPRECATED] Restore a snapshot.
Usage:
restore INSTANCE_ID --snapshot SNAPSHOT_ID [--force] [--restore VALUE]
INSTANCE_ID: The unique identifier or name of the instance.Available Options:
-f, --force By default the VM must be shutoff during a snapshot restore, force set to true will relax the VM shutoff pre-condition.
-r, --restore string Action to take on a failed snapshot restore. Valid values are: "retry", "rollback".
-s, --snapshot string The unique identifier of the snapshot.Examples:
ibmcloud pi snapshot restore 85716e61-948f-309d-de8b-c4e5f0d3126d --snapshot 43064761-948f-469d-ac8e-b8e5f0d6056f --force --restore retry{: #ibmcloud-pi-snapshot-update}
Alias: update, upd
Description: [DEPRECATED] Update a snapshot.
Usage:
update SNAPSHOT_ID [--description DESCRIPTION] [--name NAME]
SNAPSHOT_ID: The unique identifier of the snapshot.Available Options:
-d, --description string New snapshot description.
-n, --name string New name of the snapshot.{: #ibmcloud-pi-ssh-key}
Alias: ssh-key, ssh
Description: IBM Cloud Power Virtual Server SSH-Keys.
Usage: ssh-key
Available Commands:
create: Create an SSH-Key with an imported RSA public key.delete: Delete an SSH-Key.get: View details of an SSH-Key.list: List all SSH-Keys.update: Update an SSH-Key.
{: #ibmcloud-pi-ssh-key-create}
Alias: create, cr
Description: Create an SSH-Key with an imported RSA public key.
Usage:
create KEY_NAME --key KEY [--description DESCRIPTION] [--visibility ("account" | "workspace")]
KEY_NAME: The name of the key.Available Options:
-d, --description string Description of the SSH-Key.
-k, --key string SSH RSA key string within a double quotation marks. For example, "ssh-rsa AAA... "
-v, --visibility string Visibility of the SSH-Key. Valid values are: account, workspace.
Value of "workspace" means SSH-Key is only accessible in a workspace.
Value of "account" means SSH-Key is accessible throughout an account.
Default is "workspace".Examples:
ibmcloud pi ssh-key create test-ssh-key --key ssh-key-sample{: #ibmcloud-pi-ssh-key-delete}
Alias: delete, del
Description: Delete an SSH-Key.
Usage:
delete KEY_NAME
KEY_NAME: The name of the key.{: #ibmcloud-pi-ssh-key-get}
Alias: get
Description: View details of an SSH-Key.
Usage:
get KEY_NAME
KEY_NAME: The name of the key.{: #ibmcloud-pi-ssh-key-list}
Alias: list, ls
Description: List all SSH-Keys.
Usage: list
{: #ibmcloud-pi-ssh-key-update}
Alias: update, upd
Description: Update an SSH-Key.
Usage:
update KEY_NAME [--description DESCRIPTION] [--key KEY] [--name NAME] [--visibility ("account" | "workspace")]
KEY_NAME: The name of the key.Available Options:
-d, --description string Description of the SSH-Key.
-k, --key string SSH RSA key string.
-n, --name string SSH-Key name.
-v, --visibility string Visibility of the SSH-Key. Valid values are: account, workspace.
Value of "workspace" means SSH-Key is only accessible in a workspace.
Value of "account" means SSH-Key is accessible throughout an account.{: #ibmcloud-pi-storage-pools}
Alias: storage-pools, spools
Description: List all storage pools for the targeted region.
Usage: storage-pools
{: #ibmcloud-pi-storage-tiers}
Alias: storage-tiers, stiers
Description: List all storage tiers for the targeted region.
Usage: storage-tiers
{: #ibmcloud-pi-subnet}
Alias: subnet, snet
Description: IBM Cloud Power Virtual Server Subnets.
Usage: subnet
Available Commands:
create: Create a subnet.delete: Delete a subnet.get: View details of a subnet.list: List all subnets in a workspace.update: Update a subnet.
{: #ibmcloud-pi-subnet-create}
Alias: create, cr
Description: Create a subnet.
Usage:
create SUBNET_NAME --cidr-block CIDR --net-type private [--advertise ("enable" | "disable")] [--arp-broadcast ("enable" | "disable")]
[--dns-servers "DNS1,[DNSn]]"] [--enable-dhcp=True|False] [--gateway GATEWAY] [--ip-range "startIP-endIP[,startIP-endIP]"]
[--mtu MTU] [--user-tags "USER_TAG1[,USER_TAGn]"]
SUBNET_NAME: The name of the subnet.Available Options:
--advertise string Enable the subnet to be advertised. Valid values are: enable, disable. Default is "enable" for private networks.
-b, --arp-broadcast string Enable ARP Broadcast. Valid values are: enable, disable. Default is "disable" for private networks.
-c, --cidr-block string Subnet in CIDR notation (192.168.1.0/22).
-d, --dns-servers strings Comma separated list of DNS Servers to use for this subnet.
161.26.0.10 and 161.26.0.11 by default if DNS server is not specified for
private subnet types in PER enabled workspaces else
127.0.0.1 by default if DNS server is not specified and workspace is not PER enabled.
9.9.9.9 by default for public subnet types.
--enable-dhcp Indicates if the network will support DHCP or not. Default is "true" for private networks.
-g, --gateway string Gateway to use for this subnet.
-i, --ip-range string IP Addresses range(s) for this subnet, format: "startIP-endIP[,startIP-endIP]".
-m, --mtu int Maximum Transmission Unit. MTU be between 1450 and 9000. Default is 1450.
-n, --net-type string Subnet type.
-u, --user-tags strings Comma separated list of user tags to be attached to the subnet.Examples:
ibmcloud pi subnet create test-private-subnet --net-type private --cidr-block "192.168.0.0/24" --ip-range "192.168.0.10-192.168.0.20" --dns-servers "8.8.8.8" --gateway "192.168.0.1"
ibmcloud pi subnet create test-public-subnet --net-type public --dns-servers "8.8.8.8" --mtu 2000{: #ibmcloud-pi-subnet-delete}
Alias: delete, del
Description: Delete a subnet.
Usage:
delete SUBNET_ID
SUBNET_ID: The unique identifier or name of the subnet.{: #ibmcloud-pi-subnet-get}
Alias: get
Description: View details of a subnet.
Usage:
get SUBNET_ID
SUBNET_ID: The unique identifier or name of the subnet.{: #ibmcloud-pi-subnet-list}
Alias: list, ls
Description: List all subnets in a workspace.
Usage: list
{: #ibmcloud-pi-subnet-update}
Alias: update, upd
Description: Update a subnet.
Usage:
update SUBNET_ID [--advertise ("enable" | "disable")] [--arp-broadcast ("enable" | "disable")]
[--dns-servers "DNS1,[DNSn]"] [--enable-dhcp=True|False] [--gateway GATEWAY]
[--ip-range "startIP-endIP[,startIP-endIP]"] [--name SUBNET_NAME]
SUBNET_ID: The unique identifier or name of the subnet.Available Options:
--advertise string Enable the subnet to be advertised. Valid values are: enable, disable.
-b, --arp-broadcast string Enable ARP Broadcast. Valid values are: enable, disable.
-d, --dns-servers strings Comma separated list of DNS Servers to use for this subnet.
--enable-dhcp Indicates if the network will support DHCP or not.
-g, --gateway string Gateway to use for this subnet.
-i, --ip-range string IP Addresses range(s) for this subnet, format: "startIP-endIP[,startIP-endIP]".
-n, --name string New name of the subnet.{: #ibmcloud-pi-virtual-serial-number}
Alias: virtual-serial-number, vsn
Description: IBM Cloud Power Virtual Server Virtual Serial Number.
Usage: virtual-serial-number
Available Commands:
delete: Delete a virtual serial number.get: View details of a virtual serial number.list: List all virtual serial number assigned to an instance or all virtual serial numbers in the workspace.software-tiers: List all supported software tiers.update: Update a retained virtual serial number.
{: #ibmcloud-pi-virtual-serial-number-delete}
Alias: delete, del
Description: Delete a virtual serial number.
Usage:
delete VIRTUAL_SERIAL_NUMBER
VIRTUAL_SERIAL_NUMBER: The virtual serial number.{: #ibmcloud-pi-virtual-serial-number-get}
Alias: get
Description: View details of a virtual serial number.
Usage:
get VIRTUAL_SERIAL_NUMBER
VIRTUAL_SERIAL_NUMBER: The virtual serial number.{: #ibmcloud-pi-virtual-serial-number-list}
Alias: list, ls
Description: List all virtual serial number assigned to an instance or all virtual serial numbers in the workspace.
Usage:
list ([PVM_INSTANCE_ID] | [--retainVSN=True|False])
PVM_INSTANCE_ID: The unique identifier or name of the PVM instance.Available Options:
-r, --retainVSN Lists only retained virtual serial numbers. Default is "false".{: #ibmcloud-pi-virtual-serial-number-software-tiers}
Alias: software-tiers, st
Description: List all supported software tiers.
Usage: software-tiers
{: #ibmcloud-pi-virtual-serial-number-update}
Alias: update, upd
Description: Update a retained virtual serial number.
Usage:
update VIRTUAL_SERIAL_NUMBER [--description DESCRIPTION]
VIRTUAL_SERIAL_NUMBER: The virtual serial number.Available Options:
-d, --description string New virtual serial number description.{: #ibmcloud-pi-volume}
Alias: volume, vol
Description: IBM Cloud Power Virtual Server Volumes.
Usage: volume
Available Commands:
action: Perform an action on a volume.bulk-delete: Delete multiple volumes.clone: IBM Cloud Power Virtual Server Volume Clone Requests. This command can be used to create clone requests whose lifecycle must be managed. It cannot be used to clone single volumes.clone-async: IBM Cloud Power Virtual Server Volume Clones. This command asynchronously creates clone tasks whose status can be queried. It can be used to clone one or more volumes.create: Create a volume.delete: Delete a volume.flash-copy-mapping: Get a list of flash copy mappings of a volume directly from primary storage host.get: View details of a volume.list: List all storage volumes in a workspace.onboarding: IBM Cloud Power Virtual Server Volume Onboarding.remote-copy-relationship: Get the remote copy relationship information of a volume.snapshot: IBM Cloud Power Virtual Server Volume Snapshot.update: Update a volume.
{: #ibmcloud-pi-volume-action}
Alias: action, act
Description: Perform an action on a volume.
Usage:
action VOLUME_ID [--replication-enabled=True|False] [--target-tier STORAGE_TIER]
VOLUME_ID: The unique identifier or name of the volume.Available Options:
-r, --replication-enabled Enables storage replication on the volume. Default is "false".
-t, --target-tier string Change the storage tier of the volume (use "ibmcloud pi storage-tiers" to see available storage tiers in the targeted region).
"Tier5k" volumes cannot exceed 200 GiB.Examples:
ibmcloud pi volume action test-volume --replication-enabled{: #ibmcloud-pi-volume-bulk-delete}
Alias: bulk-delete, bdel
Description: Delete multiple volumes.
Usage: bulk-delete --volumes VOLUME1[,VOLUMEn]
Available Options:
-v, --volumes strings List of volumes to be deleted.{: #ibmcloud-pi-volume-clone}
Alias: clone, cl
Description: IBM Cloud Power Virtual Server Volume Clone Requests. This command can be used to create clone requests whose lifecycle must be managed. It cannot be used to clone single volumes.
Usage: clone
Available Commands:
cancel: Cancel a volume clone request.create: Create a volume clone request using the specified volumes.delete: Delete a volume clone request.execute: Execute a volume clone request using the specified options.get: View details of a volume clone request.list: List all volume clone requests in a workspace.start: Starts a volume clone request.
{: #ibmcloud-pi-volume-clone-cancel}
Alias: cancel, ca
Description: Cancel a volume clone request.
Usage:
cancel VOLUME_CLONE_REQUEST_ID [--force=True|False]
VOLUME_CLONE_REQUEST_ID: The unique identifier of a volume clone request.Available Options:
-f, --force Force the cancellation of a volume clone request. If false, cancel will only be allowed if the status is 'prepared', or 'available'. If true, cancel will be allowed when the status is NOT completed, cancelling, cancelled, or failed. Default false.Examples:
ibmcloud pi volume clone cancel 43064761-948f-469d-ac8e-b8e5f0d6056f{: #ibmcloud-pi-volume-clone-create}
Alias: create, cr
Description: Create a volume clone request using the specified volumes.
Usage:
create --name VOLUME_CLONE_REQUEST_NAME --volumes VOLUME1[,VOLUMEn]
VOLUME_CLONE_REQUEST_NAME: The name of a volume clone request.Available Options:
-n, --name string Name to assign to volume clones request.
-v, --volumes strings Comma separated list of volume identifiers or names to be cloned.
A minimum of 2 Volume IDs are required and at least one of them must be in the in-use state.Examples:
ibmcloud pi volume clone create --name test-volume-clone --volumes "43064761-948f-469d-ac8e-b8e5f0d6056f,85716e61-948f-309d-de8b-c4e5f0d3126d"{: #ibmcloud-pi-volume-clone-delete}
Alias: delete, del
Description: Delete a volume clone request.
Usage:
delete VOLUME_CLONE_REQUEST_ID
VOLUME_CLONE_REQUEST_ID: The unique identifier of a volume clone request.Examples:
ibmcloud pi volume clone delete 43064761-948f-469d-ac8e-b8e5f0d6056f{: #ibmcloud-pi-volume-clone-execute}
Alias: execute, ex
Description: Execute a volume clone request using the specified options.
Usage:
execute VOLUME_CLONE_REQUEST_ID --name BASE_NAME [--replication-enabled=True|False] [--rollback-prepare=True|False] [--target-tier STORAGE_TIER] [--user-tags USER_TAG1[,USER_TAGn]]
VOLUME_CLONE_REQUEST_ID: The unique identifier of a volume clone request.Available Options:
-n, --name string Base name of the new cloned volume(s).
--replication-enabled Enables replication for the cloned volume. By default, the replication property of the source volume will be used to determine the replication property of the cloned target volume.
--rollback-prepare Determines rollback behavior. If false, execute failure rolls back clone activity but leaves prepared snapshot. If true, Execute failure rolls back clone activity and removes the prepared snapshot. Default false.
-t, --target-tier string Target storage tier for the cloned volumes. Use "ibmcloud pi storage-tiers" to see available tiers in the targeted region.
Default to the storage tier of the original volume(s) if not specified.
-u, --user-tags strings Comma separated list of user tags to be attached to the cloned volume.Examples:
ibmcloud pi volume clone execute 43064761-948f-469d-ac8e-b8e5f0d6056f --name test-volume-clone --rollback-prepare --target-tier tier3 --user-tags "project:customer-poc,env:dev,dataresidency:germany"{: #ibmcloud-pi-volume-clone-get}
Alias: get
Description: View details of a volume clone request.
Usage:
get VOLUME_CLONE_REQUEST_ID
VOLUME_CLONE_REQUEST_ID: The unique identifier of a volume clone request.{: #ibmcloud-pi-volume-clone-list}
Alias: list, ls
Description: List all volume clone requests in a workspace.
Usage: list [--filter FILTER]
Available Options:
-f, --filter string Volume clone filter to limit list items.
cancel - includes status values (cancelling)
cancelled - includes status values (cancelled)
completed - includes status values (completed)
execute - includes status values (executing, available-rollback)
failed - includes status values (failed)
finalized - included status values (completed, failed, cancelled)
prepare - includes status values (preparing, prepared)
start - includes status values (starting, available){: #ibmcloud-pi-volume-clone-start}
Alias: start, st
Description: Starts a volume clone request.
Usage:
start VOLUME_CLONE_REQUEST_ID
VOLUME_CLONE_REQUEST_ID: The unique identifier of a volume clone request.Examples:
ibmcloud pi volume clone start 43064761-948f-469d-ac8e-b8e5f0d6056f{: #ibmcloud-pi-volume-clone-async}
Alias: clone-async, cla
Description: IBM Cloud Power Virtual Server Volume Clones. This command asynchronously creates clone tasks whose status can be queried. It can be used to clone one or more volumes.
Usage: clone-async
Available Commands:
create: Create a volume clone for specific volumes.get: Get the status of a clone request for the specified clone task ID.
{: #ibmcloud-pi-volume-clone-async-create}
Alias: create, cr
Description: Create a volume clone for specific volumes.
Usage:
create CLONE_NAME --volumes VOLUME1[,VOLUMEn] [--replication-enabled=True|False] [--target-tier STORAGE_TIER] [--user-tags USER_TAG1[,USER_TAGn]]
CLONE_NAME:The name of a clone.Available Options:
-r, --replication-enabled Enables replication for the cloned volume.
If no value is provided, it will default to the replication status of the source volume.
-t, --target-tier string Target storage tier for the cloned volumes. Use "ibmcloud pi storage-tiers" to see available tiers in the targeted region.
Default to the storage tier of the original volume(s) if not specified.
-u, --user-tags strings Comma separated list of user tags to be attached to the cloned volume.
-v, --volumes strings Comma separated list of volume identifiers or names to be cloned.Examples:
ibmcloud pi volume clone-async create test-volume --volumes 43064761-948f-469d-ac8e-b8e5f0d6056f --target-tier tier1 --user-tags "project:customer-poc,env:dev,dataresidency:germany"{: #ibmcloud-pi-volume-clone-async-get}
Alias: get
Description: Get the status of a clone request for the specified clone task ID.
Usage:
get CLONE_TASK_ID
CLONE_TASK_ID:The unique identifier of a clone task.{: #ibmcloud-pi-volume-create}
Alias: create, cr
Description: Create a volume.
Usage:
create VOLUME_NAME --size SIZE [--count COUNT] [--replication-enabled=True|False] [--replication-sites SITE1[,SITEn]] [--shareable=True|False] [--storage-tier STORAGE_TIER] [--user-tags USER_TAG1[,USER_TAGn]]
pi volume create VOLUME_NAME --size SIZE --storage-pool POOL [--count COUNT] [--replication-enabled=True|False] [--replication-sites SITE1[,SITEn]] [--shareable=True|False] [--storage-tier STORAGE_TIER] [--user-tags USER_TAG1[,USER_TAGn]]
pi volume create VOLUME_NAME --affinity-policy affinity (--affinity-volume VOLUME | --affinity-instance INSTANCE) --size SIZE [--count COUNT] [--replication-enabled=True|False] [--replication-sites SITE1[,SITEn]] [--shareable=True|False] [--storage-tier STORAGE_TIER] [--user-tags USER_TAG1[,USER_TAGn]]
pi volume create VOLUME_NAME --affinity-policy anti-affinity (--anti-affinity-volumes "VOLUME1,[VOLUMEn]" | --anti-affinity-instances "INSTANCE1,[INSTANCEn]") --size SIZE [--count COUNT] [--replication-enabled=True|False] [--replication-sites SITE1[,SITEn]] [--shareable=True|False] [--storage-tier STORAGE_TIER] [--user-tags USER_TAG1[,USER_TAGn]]
VOLUME_NAME: The name of the volume.Available Options:
-i, --affinity-instance string PVM instance identifier or name to base volume affinity policy against.
This is required if "--affinity-policy affinity" is specified and "--affinity-volume" is not provided.
-a, --affinity-policy string Affinity policy for data volume being created. Valid values are "affinity" and "anti-affinity". If "--storage-pool" is provided then this cannot be specified.
-v, --affinity-volume string Volume identifier or name to base volume affinity policy against.
This is required if "--affinity-policy affinity" is specified and "--affinity-instance" is not provided.
-j, --anti-affinity-instances strings Comma separated list of instance identifiers or names to base volume anti-affinity policy against.
This is required if "--affinity-policy anti-affinity" is specified and "--anti-affinity-volumes" is not provided.
-w, --anti-affinity-volumes strings Comma separated list of volume identifiers or names to base volume anti-affinity policy against.
This is required if "--affinity-policy anti-affinity" is specified and "--anti-affinity-instances" is not provided.
-c, --count int Number of volumes to create. Default is 1.
-r, --replication-enabled Enables storage replication on the volume. Default is "false".
--replication-sites strings List of replication sites for volume replication. See "ibmcloud pi disaster-recovery" command to get a list of replication sites.
-e, --shareable Whether the volumes can be attached to multiple VMs. Default is "false".
-s, --size int Size of the volume in GiB. Size cannot exceed 200 GiB for storage tier "Tier5k".
-p, --storage-pool string Volume pool where the volume will be created. If the "--storage-pool" option is set then the "--affinity-policy" option cannot be specified.
-t, --storage-tier string Tier of the volume (use "ibmcloud pi storage-tiers" to see available storage tiers in the targeted region). Default to tier3 if not provided.
-u, --user-tags strings Comma separated list of user tags to be attached to the volume.Examples:
ibmcloud pi volume create test-volume --size 1
ibmcloud pi volume create test-volume --size 1 --storage-tier tier1 --affinity-policy anti-affinity --anti-affinity-volumes anti-affinity-volume
ibmcloud pi volume create test-volume --size 1 --storage-tier tier1 --count 2
ibmcloud pi volume create test-volume --size 1 --replication-enabled --replication-sites dal10{: #ibmcloud-pi-volume-delete}
Alias: delete, del
Description: Delete a volume.
Usage:
delete VOLUME_ID
VOLUME_ID: The unique identifier or name of the volume.{: #ibmcloud-pi-volume-flash-copy-mapping}
Alias: flash-copy-mapping, fcm
Description: Get a list of flash copy mappings of a volume directly from primary storage host.
Usage:
flash-copy-mapping VOLUME_ID
VOLUME_ID: The unique identifier or name of the volume.{: #ibmcloud-pi-volume-get}
Alias: get
Description: View details of a volume.
Usage:
get VOLUME_ID
VOLUME_ID: The unique identifier or name of the volume.{: #ibmcloud-pi-volume-list}
Alias: list, ls
Description: List all storage volumes in a workspace.
Usage: list [--auxiliary=True|False] [--long=True|False] [--replication-enabled=True|False]
Available Options:
-a, --auxiliary Filter auxiliary volumes if set to "true" or non-auxiliary volumes if set to "false". Default is "true".
-l, --long Retrieve all volume details.
-r, --replication-enabled Filter replication-enabled volumes if set to "true" or non-replication-enabled volumes if set to "false". Default is "true".{: #ibmcloud-pi-volume-onboarding}
Alias: onboarding, on
Description: IBM Cloud Power Virtual Server Volume Onboarding.
Usage: onboarding
Available Commands:
create: Create a volume onboarding operation.get: Get the information of volume onboarding operation.list: List all volume onboarding operations.
{: #ibmcloud-pi-volume-onboarding-create}
Alias: create, cr
Description: Create a volume onboarding operation.
Usage: create <--auxiliary-volumes "AUXVOLUMENAME1 [NAME1]"> --source-crn SOURCE_CRN [--description DESCRIPTION] [--user-tags USER_TAG1[,USER_TAGn]]
Available Options:
-a, --auxiliary-volumes strings Comma separated list of identifiers of the volume(s) at storage host level. Repeat this option to add more auxiliary volumes.
-d, --description string Volume onboarding description.
-s, --source-crn string The CRN of the workspace in which the primary volume is located.
-u, --user-tags strings Comma separated list of user tags to be attached to the volume onboarding.Examples:
ibmcloud pi volume onboarding create --auxiliary-volumes "test-auxiliary-volume-name" --source-crn "crn:v1:staging:public:power-iaas:dal13:a/mockcrn::"{: #ibmcloud-pi-volume-onboarding-get}
Alias: get
Description: Get the information of volume onboarding operation.
Usage:
get VOLUME_ONBOARDING_ID
VOLUME_ONBOARDING_ID: The unique identifier of the onboarding operation.{: #ibmcloud-pi-volume-onboarding-list}
Alias: list, ls
Description: List all volume onboarding operations.
Usage: list
{: #ibmcloud-pi-volume-remote-copy-relationship}
Alias: remote-copy-relationship, rcr
Description: Get the remote copy relationship information of a volume.
Usage:
remote-copy-relationship VOLUME_ID
VOLUME_ID: The unique identifier or name of the volume.{: #ibmcloud-pi-volume-snapshot}
Alias: snapshot, snap
Description: IBM Cloud Power Virtual Server Volume Snapshot.
Usage: snapshot
Available Commands:
get: Get a snapshot for a volume.list: List all snapshots in the workspace.
{: #ibmcloud-pi-volume-snapshot-get}
Alias: get
Description: Get a snapshot for a volume.
Usage:
get SNAPSHOT_ID
SNAPSHOT_ID: The unique identifier of the snapshot.{: #ibmcloud-pi-volume-snapshot-list}
Alias: list, ls
Description: List all snapshots in the workspace.
Usage: list
{: #ibmcloud-pi-volume-update}
Alias: update, upd
Description: Update a volume.
Usage:
update VOLUME_ID [--bootable=True|False] [--name NAME] [--size SIZE] [--shareable=True|False]
VOLUME_ID: The unique identifier or name of the volume.Available Options:
-b, --bootable New value for whether the volume can be booted.
-n, --name string New name of the volume.
-t, --shareable New value for whether the volume can be attached to multiple VMs.
-s, --size int New size of the volume. Size cannot exceed 200 GiB for storage tier "Tier5k".{: #ibmcloud-pi-volume-group}
Alias: volume-group, vg
Description: IBM Cloud Power Virtual Server Volume Groups.
Usage: volume-group
Available Commands:
action: Perform an action on a volume group.create: Create a volume group.delete: Delete a volume group.get: View details of a volume group.list: List all storage volume groups in a workspace.remote-copy-relationships: Get the remote copy relationship information of a volume group.storage-details: Get storage details for a volume group.update: Update a volume group.
{: #ibmcloud-pi-volume-group-action}
Alias: action, act
Description: Perform an action on a volume group.
Usage:
action VOLUME_GROUP_ID --operation reset [--status STATUS]
pi volume-group action VOLUME_GROUP_ID --operation start [--source SOURCE]
pi volume-group action VOLUME_GROUP_ID --operation stop [--allow-read-access=True|False]
VOLUME_GROUP_ID: The unique identifier or name of the volume group.Available Options:
-a, --allow-read-access Allow the auxiliary volume to be accessible after stopping the volume group. Default is "false".
-o, --operation string Operation to be done in a volume group. Valid values are: reset, start, stop.
--source string The copying volume source. Valid values are: auxiliary, master.Default is "master".
--status string New status to be set for a volume group. Default is "available".Examples:
ibmcloud pi volume-group action test-volume-group --operation reset
ibmcloud pi volume-group action test-volume-group --operation start --source master{: #ibmcloud-pi-volume-group-create}
Alias: create, cr
Description: Create a volume group.
Usage:
create (--volume-group-name VOLUME_GROUP_NAME | --consistency-group-name CONSISTENCY_GROUP_NAME) --member-volume-ids "VOLUME1[,VOLUMEn]"
VOLUME_GROUP_ID: The unique identifier or name of the volume group.Available Options:
-c, --consistency-group-name string Storage volume group name. This is required to onboard existing volume group on the target site for DR set up.
-m, --member-volume-ids strings Comma separated member volume identifiers.
-v, --volume-group-name string Storage volume group name. This is required for the creation of new volume group.Examples:
ibmcloud pi volume-group create --volume-group-name test-volume-group-name --member-volume-ids "43064761-948f-469d-ac8e-b8e5f0d6056f,85716e61-948f-309d-de8b-c4e5f0d3126d"{: #ibmcloud-pi-volume-group-delete}
Alias: delete, del
Description: Delete a volume group.
Usage:
delete VOLUME_GROUP_ID
VOLUME_GROUP_ID: The unique identifier or name of the volume group.{: #ibmcloud-pi-volume-group-get}
Alias: get
Description: View details of a volume group.
Usage:
get VOLUME_GROUP_ID [--long=True|False]
VOLUME_GROUP_ID: The unique identifier or name of the volume group.Available Options:
-l, --long Retrieve additional details for the volume group.{: #ibmcloud-pi-volume-group-list}
Alias: list, ls
Description: List all storage volume groups in a workspace.
Usage: list [--long=True|False]
Available Options:
-l, --long Retrieve additional details for the volume group.{: #ibmcloud-pi-volume-group-remote-copy-relationships}
Alias: remote-copy-relationships, rcr
Description: Get the remote copy relationship information of a volume group.
Usage:
remote-copy-relationships VOLUME_GROUP_ID
VOLUME_GROUP_ID: The unique identifier or name of the volume group.{: #ibmcloud-pi-volume-group-storage-details}
Alias: storage-details, sd
Description: Get storage details for a volume group.
Usage:
storage-details VOLUME_GROUP_ID
VOLUME_GROUP_ID: The unique identifier or name of the volume group.{: #ibmcloud-pi-volume-group-update}
Alias: update, upd
Description: Update a volume group.
Usage:
update VOLUME_GROUP_ID [--add-member-volume-ids "VOLUME1[,VOLUMEn]"] [--remove-member-volume-ids "VOLUME1[,VOLUMEn]"]
VOLUME_GROUP_ID: The unique identifier or name of the volume group.Available Options:
-a, --add-member-volume-ids strings Comma separated volume identifiers to add as members of the volume group.
-r, --remove-member-volume-ids strings Comma separated volume identifiers to remove as members of the volume group.{: #ibmcloud-pi-workspace}
Alias: workspace, ws
Description: IBM Cloud Power Virtual Server Workspaces.
Usage: workspace
Available Commands:
context: Display the CRN of the currently targeted workspace.create: Create a workspace.delete: Delete a workspace.list: List all workspaces for this account.target: Target a workspace.
{: #ibmcloud-pi-workspace-context}
Alias: context, con
Description: Display the CRN of the currently targeted workspace.
Usage: context
{: #ibmcloud-pi-workspace-create}
Alias: create, cr
Description: Create a workspace.
Usage:
create WORKSPACE_NAME --datacenter DATACENTER --group RESOURCE_GROUP --plan PLAN [--parameters "KEY1 VALUE1"[,"KEYn VALUEn"]] [--user-tags USER_TAG1[,USER_TAGn]]
WORKSPACE_NAME: The desired name of the workspace.Available Options:
-d, --datacenter string The datacenter location where the instance should be hosted.
Use the "ibmcloud pi datacenter list" command to see values for public datacenters,
and the "ibmcloud sat location ls" command to see values for private datacenters.
When using the "ibmcloud sat location ls" to get a private datacenter,
please prefix "satloc_<REGION>_" to the displayed id.
-g, --group string The ID of the resource group. Use the "ibmcloud resource groups" command to see possible values.
--parameters strings List of key-value parameter pairs. Each pair must be a quoted string in the format "KEY VALUE".
Example: --parameters "env dev" "version 1.0"
-p, --plan string Plan associated with the offering. Valid values are "public"/"off-prem" or "private"/"on-prem".
-u, --user-tags strings Comma separated list of user tags to be attached to the workspace.Examples:
ibmcloud pi workspace create test-workspace --datacenter dal12 --group 393843beabcdea9d803840a384093841 --plan public --user-tags "project:customer-poc,env:dev,dataresidency:germany"{: #ibmcloud-pi-workspace-delete}
Alias: delete, del
Description: Delete a workspace.
Usage:
delete (WORKSPACE_CRN | WORKSPACE_ID)
WORKSPACE_CRN: The cloud resource name that uniquely identifies IBM Cloud resources.
WORKSPACE_ID: The unique identifier of the workspace.{: #ibmcloud-pi-workspace-list}
Alias: list, ls
Description: List all workspaces for this account.
Usage: list ([--long=True|False | --private=True|False])
Available Options:
-l, --long Retrieve all workspace details.
-p, --private List private workspaces.{: #ibmcloud-pi-workspace-target}
Alias: target, tg
Description: Target a workspace.
Usage:
target WORKSPACE_CRN
WORKSPACE_CRN: The cloud resource name that uniquely identifies IBM Cloud resources.