IBM Cloud Docs
Adjusting throughput limit for a regional file share

Adjusting throughput limit for a regional file share

Customers with special access to preview the new regional file share offering can use the rfs profile to create file shares with regional data availability and adjustable throughput values. The rfs profile is available in the Dallas, Frankfurt, Madrid, and Washington, DC regions during the beta release.

For regional file shares that are provisioned with the rfs profile, you can increase or decrease the throughput limit to meet your performance needs. The maximum throughput for any file share with the rfs profile is 1024 MBps (8192 Mbps). The minimum throughput value is calculated as 1 MBps for every 20 GB of capacity.

With this feature, you can increase or decrease your share's throughput limit in the console, from the CLI, or with the API. To change this attribute, the share must be in an available state. Your user authorization is verified before the bandwidth limit is adjusted.

Billing for an updated file share is automatically updated. The prorated difference of the new price is added to the current billing cycle. The new full amount is then billed in the next billing cycle.

Adjusting throughput in the console

  1. Go to the list of all file shares. From the IBM Cloud console, click the Navigation menu icon menu icon > Infrastructure VPC icon > Storage > File storage shares.
  2. Click the name of a file share to see the details page.
  3. Locate the Profile section, and click the Edit icon Edit icon, or use the Actions menu Actions icon and select Edit throughput.
  4. In the side panel, you can specify a file share bandwidth limit between the file share's preset value and the maximum of 8192 Mbps.
  5. Review the estimated monthly order summary.
  6. If you're satisfied, click Save and continue.

Adjusting throughput from the CLI

To be able to create and manage a regional file share from the CLI, set the appropriate environmental variable with the following command.

export IBMCLOUD_IS_FEATURE_SHARE_DENALI_REGIONAL_AVAILABILITY=true

The CLI returns the properties for "Allowed Access Protocols", "Availability Mode", "Bandwidth", and "Storage Generation" only when this environmental variable is set to "true".

From the CLI, use the ibmcloud is share-update command with the --bandwidth option to indicate the new throughput value for a custom profile.

ibmcloud is share-update share_ID --bandwidth BANDWIDTH

This example shows an increase of the throughput limit to 3,000 Mbps. (The preset throughput value of a 1000 GB file share is 400 Mbps.)

   $ ibmcloud is share-update my-file-share --bandwidth 2000
   Updating file share my-file-share under account Test Account as user test.user@ibm.com...

   ID                                 r006-b696742a-92ee-4f6a-bfd7-921d6ddf8fa6
   Name                               my-file-share
   CRN                                crn:v1:bluemix:public:is:us-south-2:a/a1234567::share:r006-b696742a-92ee-4f6a-bfd7-921d6ddf8fa6
   Lifecycle state                    stable
   Access control mode                security_group
   Accessor binding role              none
   Allowed transit encryption modes   stunnel,none 
   Zone                               us-south-1
   Profile                            rfs
   Size(GB)                           1000
   IOPS                               35000
   Bandwidth                          2000
   User Tags                          docs:test
   Encryption                         provider_managed   
   Mount Targets                      ID                                          Name
                                      r006-dd497561-c7c9-4dfb-af0a-c84eeee78b61   my-cli-share-mount-target-1

   Resource group                     ID                                 Name
                                      db8e8d865a83e0aae03f25a492c5b39e   Default

   Created                            2025-07-22T22:15:15+00:00
   Replication role                   none
   Replication status                 none
   Replication status reasons         Status code   Status message
                                      -             -
   Snapshot count                     0
   Snapshot size                      0
   Source snapshot                    -  
   Allowed Access Protocols           nsf4   
   Availability Mode                  zonal   
   Storage Generation                 2    

File shares with regional availability serve data in every zone of the region. The command response shows the first zone of the region by default.

For more information about available command options, see ibmcloud is share-update.

Adjusting throughput with the API

You can adjust throughput for existing data shares by calling the beta VPC API. Make a PATCH /shares request and specify the bandwidth parameter to adjust the throughput limit.

You can't update the name of the share, increase the size, adjust IOPS, and adjust throughput limit in the same PATCH /shares request. Make separate PATCH /shares requests.

This example shows the bandwidth value increased to 3,000 Mbps. The preset throughput of a 1000 GB file share is 400 Mbps.

curl -X PATCH \
 "$vpc_api_endpoint/v1/shares/$share_id?version=2025-07-22&generation=2&maturity=beta" \
 -H "Authorization: $iam_token" \
 -d '{
      "bandwidth": 3000
    }'

The file share status shows updating while the throughput is being adjusted. The preset bandwidth is shown until after the update is complete.

{
	"bandwidth": 400,
	"created_at": "2025-06-24T09:46:43.000Z",
	"crn": "crn:v1:bluemix:public:is:us-east-1:a/<Acc id>::share:<file shareID>",
    .
    .
    .
	"status": "updating",
    .
    .
    .
}