Block Commands

block access-authorize

Authorize hosts to access a given volume.

EXAMPLE:

slcli block access-authorize 12345678 --virtual-id 87654321
This command authorizes virtual server with ID 87654321 to access volume with ID 12345678.

block access-authorize [OPTIONS] VOLUME_ID

Options

-d, --hardware-id <hardware_id>: The ID of one hardware server to authorize. (Multiple allowed)

-i, --ip-address-id <ip_address_id>: The ID of one SoftLayer_Network_Subnet_IpAddress to authorize. (Multiple allowed)

--ip-address <ip_address>: An IP address to authorize. (Multiple allowed)

-v, --virtual-id <virtual_id>: The ID of one virtual server to authorize. (Multiple allowed)

Arguments

VOLUME_ID: Required argument

block access-list

List hosts that are authorized to access the volume.

EXAMPLE:

slcli block access-list 12345678 --sortby id
This command lists all hosts that are authorized to access volume with ID 12345678 and sorts them by ID.

block access-list [OPTIONS] VOLUME_ID

Options

--columns <columns>: Columns to display. Options are: id, name, type, private_ip_address, source_subnet, host_iqn, username, password, allowed_host_id.

--sortby <sortby>: Column to sort by. Options are: id, name, type, private_ip_address, source_subnet, host_iqn, username, password, allowed_host_id.

Arguments

VOLUME_ID: Required argument

block access-revoke

Revoke authorization for hosts that are accessing a specific volume.

EXAMPLE:

slcli block access-revoke 12345678 --virtual-id 87654321
This command revokes access of virtual server with ID 87654321 to volume with ID 12345678.

block access-revoke [OPTIONS] VOLUME_ID

Options

-d, --hardware-id <hardware_id>: The ID of one SoftLayer_Hardware to revoke authorization.

-i, --ip-address-id <ip_address_id>: The ID of one SoftLayer_Network_Subnet_IpAddress to revoke authorization.

--ip-address <ip_address>: An IP address to revoke authorization.

-v, --virtual-id <virtual_id>: The ID of one SoftLayer_Virtual_Guest to revoke authorization.

Arguments

VOLUME_ID: Required argument

block access-password

Changes a password for a volume’s access.

access id is the allowed_host_id from slcli block access-list

block access-password [OPTIONS] ACCESS_ID

Options

-p, --password <password>: Password you want to set, this command will fail if the password is not strong.

Arguments

ACCESS_ID: Required argument

block replica-failback

Failback a block volume from the given replica volume.

block replica-failback [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID: Required argument

block replica-failover

Failover a block volume to the given replica volume.

block replica-failover [OPTIONS] VOLUME_ID

Options

--replicant-id <replicant_id>: ID of the replicant volume.

Arguments

VOLUME_ID: Required argument

block replica-order

Order a block storage replica volume.

block replica-order [OPTIONS] VOLUME_ID

Options

-d, --datacenter <datacenter>: Required Short name of the datacenter for the replica (e.g.: dal09)

-i, --iops <iops>: Performance Storage IOPs, between 100 and 6000 in multiples of 100. If no IOPS value is specified, the IOPS value of the original volume will be used.

-o, --os-type <os_type>

Operating System Type (eg. LINUX) of the primary volume for which a replica is ordered [optional].

Options:: HYPER_V | LINUX | VMWARE | WINDOWS_2008 | WINDOWS_GPT | WINDOWS | XEN

-s, --snapshot-schedule <snapshot_schedule>

Required Snapshot schedule to use for replication. Options are: HOURLY, DAILY, WEEKLY

Options:: HOURLY | DAILY | WEEKLY

-t, --tier <tier>

Endurance Storage Tier (IOPS per GB) of the primary volume for which a replica is ordered [optional]. If no tier is specified, the tier of the original volume will be used

Options:: 0.25 | 2 | 4 | 10

Arguments

VOLUME_ID: Required argument

block replica-partners

List existing replica volumes for a block volume.

block replica-partners [OPTIONS] VOLUME_ID

Options

--columns <columns>: Columns to display. Options: ID, Username, Account ID, Capacity (GB), Hardware ID, Guest ID, Host ID

--sortby <sortby>: Column to sort by

Arguments

VOLUME_ID: Required argument

block replica-locations

List suitable replication datacenters for the given volume.

block replica-locations [OPTIONS] VOLUME_ID

Options

--columns <columns>: Columns to display. Options: ID, Long Name, Short Name

--sortby <sortby>: Column to sort by

Arguments

VOLUME_ID: Required argument

block snapshot-cancel

Cancel existing snapshot space for a given volume.

block snapshot-cancel [OPTIONS] VOLUME_ID

Options

--reason <reason>: An optional reason for cancellation.

--immediate: Cancels the snapshot space immediately instead of on the billing anniversary.

--force: Force modify

Arguments

VOLUME_ID: Required argument

block snapshot-create

Creates a snapshot on a given volume.

block snapshot-create [OPTIONS] VOLUME_ID

Options

-n, --notes <notes>: Notes to set on the new snapshot.

Arguments

VOLUME_ID: Required argument

block snapshot-delete

Deletes a snapshot on a given volume.

block snapshot-delete [OPTIONS] SNAPSHOT_ID

Arguments

SNAPSHOT_ID: Required argument

block snapshot-disable

Disables snapshots on the specified schedule for a given volume.

block snapshot-disable [OPTIONS] VOLUME_ID

Options

--schedule-type <schedule_type>: Required Snapshot schedule [INTERVAL|HOURLY|DAILY|WEEKLY].

Arguments

VOLUME_ID: Required argument

block snapshot-enable

Enables snapshots for a given volume on the specified schedule.

block snapshot-enable [OPTIONS] VOLUME_ID

Options

--schedule-type <schedule_type>: Required Snapshot schedule [INTERVAL|HOURLY|DAILY|WEEKLY].

--retention-count <retention_count>: Required Number of snapshots to retain.

--minute <minute>: Minute of the hour when snapshots should be taken, integer between 0 to 59.

--hour <hour>: Hour of the day when snapshots should be taken, integer between 0 to 23.

--day-of-week <day_of_week>: Day of the week when snapshots should be taken, integer between 0 to 6

Arguments

VOLUME_ID: Required argument

block snapshot-schedule-list

Lists snapshot schedules for a given volume.

block snapshot-schedule-list [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID: Required argument

block snapshot-list

List block storage snapshots.

block snapshot-list [OPTIONS] VOLUME_ID

Options

--sortby <sortby>: Column to sort by.

--columns <columns>: Columns to display. Options: id, name, created, size_bytes

Arguments

VOLUME_ID: Required argument

block snapshot-order

Order snapshot space for a block storage volume.

block snapshot-order [OPTIONS] VOLUME_ID

Options

--iops <iops>: Performance Storage IOPs, between 100 and 6000 in multiples of 100.

--size <size>: Required Size of snapshot space to create in GB.

--tier <tier>

Endurance Storage Tier (IOPS per GB) of the block volume for which space is ordered [optional, and only valid for endurance storage volumes].

Options:: 0.25 | 2 | 4 | 10

--upgrade: Flag to indicate that the order is an upgrade.

Arguments

VOLUME_ID: Required argument

block snapshot-restore

Restore block volume using a given snapshot.

block snapshot-restore [OPTIONS] VOLUME_ID

Options

-s, --snapshot-id <snapshot_id>: The id of the snapshot which will be used to restore the block volume.

Arguments

VOLUME_ID: Required argument

block volume-cancel

Cancel an existing block storage volume.

Example::: slcli block volume-cancel 12345678 –immediate -f This command cancels volume with ID 12345678 immediately and without asking for confirmation.

block volume-cancel [OPTIONS] VOLUME_ID

Options

--reason <reason>: An optional reason for cancellation

--immediate: Cancels the block storage volume immediately instead of on the billing anniversary

--force: Force cancel block volume without confirmation

Arguments

VOLUME_ID: Required argument

block volume-count

List number of block storage volumes per datacenter.

block volume-count [OPTIONS]

Options

-d, --datacenter <datacenter>: Datacenter shortname

--sortby <sortby>: Column to sort by

block volume-options

List all options for ordering a block storage

Example::

slcli block volume-options This command lists all options for creating a block storage volume, including storage type, volume size, OS type, IOPS, tier level, datacenter, and snapshot size.

slcli block volume-options –prices This command lists all options for creating a block storage volume, including storage type, volume size, OS type, IOPS, tier level, datacenter, and snapshot size along with prices.

slcli block volume-options –prices dal03 This command lists all options for creating a block storage volume, including storage type, volume size, OS type, IOPS, tier level, datacenter, and snapshot size along with prices for a given location.

block volume-options [OPTIONS] [LOCATION]

Options

-p, --prices: Use –prices to list the server item prices, and to list the Item Prices by location,add it to the –prices option using location short name, e.g. –prices dal13

Arguments

LOCATION: Optional argument

block volume-detail

Display details for a specified volume.

block volume-detail [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID: Required argument

block volume-duplicate

Order a duplicate block storage volume.

Example::: slcli block volume-duplicate 12345678 This command shows order a new volume by duplicating the volume with ID 12345678.

block volume-duplicate [OPTIONS] ORIGIN_VOLUME_ID

Options

-o, --origin-snapshot-id <origin_snapshot_id>: ID of an origin volume snapshot to use for duplcation.

-c, --duplicate-size <duplicate_size>: Size of duplicate block volume in GB. *If no size is specified, the size of the origin volume will be used.* Potential Sizes: [20, 40, 80, 100, 250, 500, 1000, 2000, 4000, 8000, 12000] Minimum: [the size of the origin volume]

-i, --duplicate-iops <duplicate_iops>: Performance Storage IOPS, between 100 and 6000 in multiples of 100 [only used for performance volumes] *If no IOPS value is specified, the IOPS value of the origin volume will be used.* Requirements: [If IOPS/GB for the origin volume is less than 0.3, IOPS/GB for the duplicate must also be less than 0.3. If IOPS/GB for the origin volume is greater than or equal to 0.3, IOPS/GB for the duplicate must also be greater than or equal to 0.3.]

-t, --duplicate-tier <duplicate_tier>

Endurance Storage Tier (IOPS per GB) [only used for endurance volumes] *If no tier is specified, the tier of the origin volume will be used.* Requirements: [If IOPS/GB for the origin volume is 0.25, IOPS/GB for the duplicate must also be 0.25. If IOPS/GB for the origin volume is greater than 0.25, IOPS/GB for the duplicate must also be greater than 0.25.]

Options:: 0.25 | 2 | 4 | 10

-s, --duplicate-snapshot-size <duplicate_snapshot_size>: The size of snapshot space to order for the duplicate. *If no snapshot space size is specified, the snapshot space size of the origin block volume will be used.* Input “0” for this parameter to order a duplicate volume with no snapshot space.

--billing <billing>

Optional parameter for Billing rate (default to monthly)

Options:: hourly | monthly

--dependent-duplicate <dependent_duplicate>

Whether or not this duplicate will be a dependent duplicate of the origin volume.

Default:: False

Arguments

ORIGIN_VOLUME_ID: Required argument

block volume-list

List block storage.

Example::: slcli block volume-list -d dal09 -t endurance –sortby capacity_gb This command lists all endurance volumes on current account that are located at dal09, and sorts them by capacity.

block volume-list [OPTIONS]

Options

-u, --username <username>: Volume username

-d, --datacenter <datacenter>: Datacenter shortname

-o, --order <order>: Filter by ID of the order that purchased the block storage

--storage-type <storage_type>

Type of storage volume

Options:: performance | endurance

--sortby <sortby>: Column to sort by

--columns <columns>: Columns to display. Options: id, username, datacenter, storage_type, capacity_gb, IOPs, ip_addr, lunId, active_transactions, rep_partner_count, created_by, notes

block volume-modify

Modify an existing block storage volume. Choices.

Valid size and iops options can be found here:: https://cloud.ibm.com/docs/BlockStorage/index.html#provisioning-considerations https://cloud.ibm.com/docs/BlockStorage?topic=BlockStorage-orderingBlockStorage&interface=cli

Example:

slcli block volume-modify 12345678 --new-size 1000 --new-iops 4000
This command modify a volume 12345678 with size is 1000GB, IOPS is 4000.

slcli block volume-modify 12345678 --new-size 500 --new-tier 4
This command modify a volume 12345678 with size is 500GB, tier level is 4 IOPS per GB.

block volume-modify [OPTIONS] VOLUME_ID

Options

-c, --new-size <new_size>: New Size of block volume in GB. *If no size is given, the original size of volume is used.* Potential Sizes: [20, 40, 80, 100, 250, 500, 1000, 2000, 4000, 8000, 12000] Minimum: [the original size of the volume]

-i, --new-iops <new_iops>: Performance Storage IOPS, between 100 and 6000 in multiples of 100 [only for performance volumes] *If no IOPS value is specified, the original IOPS value of the volume will be used.*

-t, --new-tier <new_tier>

Endurance Storage Tier (IOPS per GB) [only for endurance volumes] Classic Choices: *If no tier is specified, the original tier of the volume will be used.*

Options:: 0.25 | 2 | 4 | 10

Arguments

VOLUME_ID: Required argument

block volume-order

Order a block storage volume.

Valid size and iops options can be found here: https://cloud.ibm.com/docs/BlockStorage/index.html#provisioning-considerations

block volume-order [OPTIONS]

Options

--storage-type <storage_type>

Required Type of block storage volume

Options:: performance | endurance

--size <size>: Required Size of block storage volume in GB.

--iops <iops>: Performance Storage IOPs. Options vary based on storage size. [required for storage-type performance]

--tier <tier>

Endurance Storage Tier (IOP per GB) [required for storage-type endurance]

Options:: 0.25 | 2 | 4 | 10

--os-type <os_type>

Required Operating System

Options:: HYPER_V | LINUX | VMWARE | WINDOWS_2008 | WINDOWS_GPT | WINDOWS | XEN

--location <location>: Required Datacenter short name (e.g.: dal09)

--snapshot-size <snapshot_size>: Optional parameter for ordering snapshot space along with endurance block storage; specifies the size (in GB) of snapshot space to order

--service-offering <service_offering>

The service offering package to use for placing the order. [optional, default is ‘storage_as_a_service’]. enterprise and performance are depreciated

Options:: storage_as_a_service | enterprise | performance

--billing <billing>

Optional parameter for Billing rate (default to monthly)

Options:: hourly | monthly

block volume-set-lun-id

Set the LUN ID on an existing block storage volume.

The LUN ID only takes effect during the Host Authorization process. It is recommended (but not necessary) to de-authorize all hosts before using this method. See block access-revoke.

VOLUME_ID - the volume ID on which to set the LUN ID.

LUN_ID - recommended range is an integer between 0 and 255. Advanced users can use an integer between 0 and 4095.

block volume-set-lun-id [OPTIONS] VOLUME_ID LUN_ID

Arguments

VOLUME_ID: Required argument

LUN_ID: Required argument

block volume-limits

List number of block storage volumes limit per datacenter.

Example::: slcli block volume-limits This command lists the storage limits per datacenter for this account.

block volume-limits [OPTIONS]

Options

--sortby <sortby>: Column to sort by

-d, --datacenter <datacenter>: Filter by datacenter

block volume-refresh

Refresh a duplicate volume with a snapshot from its parent.

EXAMPLE:

slcli block volume-refresh VOLUME_ID SNAPSHOT_ID
Refresh a duplicate VOLUME_ID with a snapshot from its parent SNAPSHOT_ID.

block volume-refresh [OPTIONS] VOLUME_ID SNAPSHOT_ID

Options

-f, --force-refresh

Cancel current refresh process and initiates the new refresh.

Default:: False

Arguments

VOLUME_ID: Required argument

SNAPSHOT_ID: Required argument

block volume-convert

Convert a dependent duplicate volume to an independent volume.

block volume-convert [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID: Required argument

block subnets-list

List block storage assigned subnets for the given host id.

Example:

slcli block subnets-list 12345678
ACCESS_ID is the host_id obtained by: softlayer slcli block access-list <volume_id>

access_id is the host_id obtained by: slcli block access-list <volume_id>

block subnets-list [OPTIONS] ACCESS_ID

Arguments

ACCESS_ID: Required argument

block subnets-assign

Assign block storage subnets to the given host id.

EXAMPLE:

slcli block subnets-assign 111111 --subnet-id 222222
slcli block subnets-assign 111111 --subnet-id 222222 --subnet-id 333333
ACCESS_ID is the host_id obtained by: softlayer slcli block access-list <volume_id>

access_id is the host_id obtained by: slcli block access-list <volume_id>

SoftLayer_Account::iscsiisolationdisabled must be False to use this command

block subnets-assign [OPTIONS] ACCESS_ID

Options

--subnet-id <subnet_id>: ID of the subnets to assign; e.g.: –subnet-id 1234

Arguments

ACCESS_ID: Required argument

block subnets-remove

Remove block storage subnets for the given host id.

Example:

slcli block subnets-remove 111111 --subnet-id 222222
slcli block subnets-remove 111111 --subnet-id 222222 --subnet-id 333333
ACCESS_ID is the host_id obtained by: slcli block access-list <volume_id>

access_id is the host_id obtained by: slcli block access-list <volume_id>

SoftLayer_Account::iscsiisolationdisabled must be False to use this command

block subnets-remove [OPTIONS] ACCESS_ID

Options

--subnet-id <subnet_id>: ID of the subnets to remove; e.g.: –subnet-id 1234

Arguments

ACCESS_ID: Required argument

block volume-refresh

Refresh a duplicate volume with a snapshot from its parent.

EXAMPLE:

slcli block volume-refresh VOLUME_ID SNAPSHOT_ID
Refresh a duplicate VOLUME_ID with a snapshot from its parent SNAPSHOT_ID.

block volume-refresh [OPTIONS] VOLUME_ID SNAPSHOT_ID

Options

-f, --force-refresh

Cancel current refresh process and initiates the new refresh.

Default:: False

Arguments

VOLUME_ID: Required argument

SNAPSHOT_ID: Required argument

block volume-convert

Convert a dependent duplicate volume to an independent volume.

block volume-convert [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID: Required argument

block volume-set-note

Set note for an existing block storage volume.

EXAMPLE:

slcli block volume-set-note 12345678 --note 'this is my note'

block volume-set-note [OPTIONS] VOLUME_ID

Options

-n, --note <note>: Required Public notes related to a Storage volume

Arguments

VOLUME_ID: Required argument

block disaster-recovery-failover

Failover an inaccessible block volume to its available replicant volume.

EXAMPLE:

slcli block disaster-recovery-failover 12345678 87654321
This command performs failover operation for volume with ID 12345678 to replica volume with ID 87654321.

block disaster-recovery-failover [OPTIONS] VOLUME_ID

Options

--replicant-id <replicant_id>: ID of the replicant volume.

Arguments

VOLUME_ID: Required argument

If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for failback via API. After using this method, to failback to the original volume, please open a support ticket. If you wish to test failover, please use replica-failover.

block snapshot-set-notification

Enables/Disables snapshot space usage threshold warning for a given volume.

block snapshot-set-notification [OPTIONS] VOLUME_ID

Options

--enable, --disable: Required Enable/Disable snapshot notification. Use slcli block snapshot-set-notification volumeId –enable to enable.

Arguments

VOLUME_ID: Required argument

block snapshot-get-notification-status

Get snapshots space usage threshold warning flag setting for a given volume.

block snapshot-get-notification-status [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID: Required argument

block object-list

List cloud block storage.

block object-list [OPTIONS]

block object-storage-detail

Display details for a cloud object storage.

block object-storage-detail [OPTIONS] OBJECT_ID

Arguments

OBJECT_ID: Required argument

block duplicate-convert-status

Get status for split or move completed percentage of a given block storage duplicate volume.

block duplicate-convert-status [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID: Required argument

block object-storage-permission

Display permission details for a cloud object storage.

block object-storage-permission [OPTIONS] OBJECT_ID

Arguments

OBJECT_ID: Required argument