File Commands

file access-authorize

Authorizes hosts to access a given volume

file access-authorize [OPTIONS] VOLUME_ID

Options

-h, --hardware-id <hardware_id>

The id of one SoftLayer_Hardware to authorize

-v, --virtual-id <virtual_id>

The id of one SoftLayer_Virtual_Guest to authorize

-i, --ip-address-id <ip_address_id>

The id of one SoftLayer_Network_Subnet_IpAddress to authorize

--ip-address <ip_address>

An IP address to authorize

-s, --subnet-id <subnet_id>

The id of one SoftLayer_Network_Subnet to authorize

Arguments

VOLUME_ID

Required argument

file access-list

List ACLs.

file access-list [OPTIONS] VOLUME_ID

Options

--sortby <sortby>

Column to sort by

--columns <columns>

Columns to display. Options: id, name, type, private_ip_address, source_subnet, host_iqn, username, password, allowed_host_id

Arguments

VOLUME_ID

Required argument

file access-revoke

Revokes authorization for hosts accessing a given volume

file access-revoke [OPTIONS] VOLUME_ID

Options

-h, --hardware-id <hardware_id>

The id of one SoftLayer_Hardware to revoke authorization

-v, --virtual-id <virtual_id>

The id of one SoftLayer_Virtual_Guest 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

-s, --subnet-id <subnet_id>

The id of one SoftLayer_Network_Subnet to revoke authorization

Arguments

VOLUME_ID

Required argument

file replica-failback

Failback a file volume from the given replicant volume.

file replica-failback [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID

Required argument

file replica-failover

Failover a file volume to the given replicant volume.

file replica-failover [OPTIONS] VOLUME_ID

Options

--replicant-id <replicant_id>

ID of the replicant volume

Arguments

VOLUME_ID

Required argument

file replica-order

Order a file storage replica volume.

file replica-order [OPTIONS] VOLUME_ID

Options

-s, --snapshot-schedule <snapshot_schedule>

Required Snapshot schedule to use for replication, (INTERVAL | HOURLY | DAILY | WEEKLY)

Options:INTERVAL|HOURLY|DAILY|WEEKLY
-l, --location <location>

Required Short name of the data center for the replicant (e.g.: dal09)

--tier <tier>

Endurance Storage Tier (IOPS per GB) of the primary volume for which a replicant is ordered [optional]

Options:0.25|2|4|10

Arguments

VOLUME_ID

Required argument

file replica-partners

List existing replicant volumes for a file volume.

file replica-partners [OPTIONS] VOLUME_ID

Options

--sortby <sortby>

Column to sort by

--columns <columns>

Columns to display. Options: ID, Username, Account ID, Capacity (GB), Hardware ID, Guest ID, Host ID

Arguments

VOLUME_ID

Required argument

file replica-locations

List suitable replication datacenters for the given volume.

file replica-locations [OPTIONS] VOLUME_ID

Options

--sortby <sortby>

Column to sort by

--columns <columns>

Columns to display. Options: ID, Long Name, Short Name

Arguments

VOLUME_ID

Required argument

file snapshot-cancel

Cancel existing snapshot space for a given volume.

file 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

Arguments

VOLUME_ID

Required argument

file snapshot-create

Creates a snapshot on a given volume

file snapshot-create [OPTIONS] VOLUME_ID

Options

-n, --notes <notes>

Notes to set on the new snapshot

Arguments

VOLUME_ID

Required argument

file snapshot-delete

Deletes a snapshot on a given volume

file snapshot-delete [OPTIONS] SNAPSHOT_ID

Arguments

SNAPSHOT_ID

Required argument

file snapshot-disable

Disables snapshots on the specified schedule for a given volume

file snapshot-disable [OPTIONS] VOLUME_ID

Options

--schedule-type <schedule_type>

Required Snapshot schedule [INTERVAL|HOURLY|DAILY|WEEKLY]

Arguments

VOLUME_ID

Required argument

file snapshot-enable

Enables snapshots for a given volume on the specified schedule

file 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 day when snapshots should be taken

--hour <hour>

Hour of the day when snapshots should be taken

--day-of-week <day_of_week>

Day of the week when snapshots should be taken

Arguments

VOLUME_ID

Required argument

file snapshot-list

List file storage snapshots.

file 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

file snapshot-order

Order snapshot space for a file storage volume.

file snapshot-order [OPTIONS] VOLUME_ID

Options

--capacity <capacity>

Required Size of snapshot space to create in GB

--tier <tier>

Endurance Storage Tier (IOPS per GB) of the file 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

file snapshot-restore

Restore file volume using a given snapshot

file 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

file volume-cancel

Cancel an existing file storage volume.

file volume-cancel [OPTIONS] VOLUME_ID

Options

--reason <reason>

An optional reason for cancellation

--immediate

Cancels the file storage volume immediately instead of on the billing anniversary

Arguments

VOLUME_ID

Required argument

file volume-count

List number of file storage volumes per datacenter.

file volume-count [OPTIONS]

Options

-d, --datacenter <datacenter>

Datacenter shortname

--sortby <sortby>

Column to sort by

file volume-detail

Display details for a specified volume.

file volume-detail [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID

Required argument

file volume-duplicate

Order a duplicate file storage volume.

file 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 file volume in GB. *If no size is specified, the size of the origin volume will be used.* 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 file 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 duplicateof the origin volume.

Default:False

Arguments

ORIGIN_VOLUME_ID

Required argument

file volume-list

List file storage.

file volume-list [OPTIONS]

Options

-u, --username <username>

Volume username

-d, --datacenter <datacenter>

Datacenter shortname

--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, bytes_used, ip_addr, active_transactions, mount_addr, rep_partner_count, created_by

file volume-modify

Modify an existing file storage volume.

file volume-modify [OPTIONS] VOLUME_ID

Options

-c, --new-size <new_size>

New Size of file 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.* Requirements: [If original IOPS/GB for the volume is less than 0.3, new IOPS/GB must also be less than 0.3. If original IOPS/GB for the volume is greater than or equal to 0.3, new IOPS/GB for the volume must also be greater than or equal to 0.3.]

-t, --new-tier <new_tier>

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

Options:0.25|2|4|10

Arguments

VOLUME_ID

Required argument

file volume-order

Order a file storage volume.

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

file volume-order [OPTIONS]

Options

--storage-type <storage_type>

Required Type of file storage volume

Options:performance|endurance
--size <size>

Required Size of file 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
--location <location>

Required Datacenter short name (e.g.: dal09)

--snapshot-size <snapshot_size>

Optional parameter for ordering snapshot space along with endurance file 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

file volume-limits

List number of block storage volumes limit per datacenter.

file volume-limits [OPTIONS]

Options

--sortby <sortby>

Column to sort by

file snapshot-schedule-list

Lists snapshot schedules for a given volume

file snapshot-schedule-list [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID

Required argument

file volume-refresh

“Refresh a dependent duplicate volume with a snapshot from its parent.

file volume-refresh [OPTIONS] VOLUME_ID SNAPSHOT_ID

Arguments

VOLUME_ID

Required argument

SNAPSHOT_ID

Required argument

file volume-convert

Convert a dependent duplicate volume to an independent volume.

file volume-convert [OPTIONS] VOLUME_ID

Arguments

VOLUME_ID

Required argument